import {z} from 'zod' export type GetApi202409ShipmentsArgs = {page?: number | undefined, per_page?: number | undefined, easyship_shipment_id?: Array | undefined, platform_order_number?: string | undefined, created_at_from?: string | undefined, created_at_to?: string | undefined, updated_at_from?: string | undefined, updated_at_to?: string | undefined, label_paid_at_from?: string | undefined, label_paid_at_to?: string | undefined, label_generated_at_from?: string | undefined, label_generated_at_to?: string | undefined, shipment_state?: ('created' | 'cancelled') | undefined, label_state?: (Array<'not_created' | 'pending' | 'generating' | 'generated' | 'printed' | 'failed' | 'technical_failed' | 'reported'>) | undefined, pickup_state?: (Array<'not_requested' | 'pending_confirmation' | 'pending_drop_off' | 'request_failed' | 'requested' | 'completed' | 'cancelled'>) | undefined, delivery_state?: (Array<'not_created' | 'pending' | 'info_received' | 'in_transit_to_customer' | 'out_for_delivery' | 'delivered' | 'failed_attempt' | 'exception' | 'expired' | 'lost_by_courier' | 'returned_to_shipper'>) | undefined, warehouse_state?: (Array<'pending' | 'created' | 'packed' | 'shipped'>) | undefined, origin_country_alpha2?: Array | undefined, destination_country_alpha2?: Array | undefined, return?: string | undefined}; export type GetApi202409ShipmentsOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const countryAlpha2 = z.enum(["AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"]); export const destinationAddress = z.object({line_1: z.string().optional(), line_2: z.string().nullable().optional(), line_3: z.string().nullable().optional(), state: z.string().nullable().optional(), city: z.string().optional(), postal_code: z.string().optional(), country_alpha2: countryAlpha2.optional(), company_name: z.string().nullable().optional(), contact_name: z.string().optional(), contact_phone: z.string().optional(), contact_email: z.string().optional(), delivery_instructions: z.string().nullable().optional()}); export const box = z.object({id: z.string().nullable().optional(), courier: z.object({umbrella_name: z.string().optional(), country_alpha2: countryAlpha2.optional()}).nullable().optional(), name: z.string().nullable().optional(), slug: z.string().nullable().optional(), outer_dimensions: z.object({length: z.number().optional(), width: z.number().optional(), height: z.number().optional()}).optional(), weight: z.number().optional(), type: z.string().optional()}); export const countryAlpha2Nullable = z.enum(["AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW", "null"]).nullable(); export const cpscCompliance = z.object({id: z.string().optional(), coc_type: z.enum(["registered", "unregistered", "exempted"]).nullable().optional(), certifier_identifier: z.string().nullable().optional(), version_identifier: z.string().nullable().optional(), citation_code: z.string().nullable().optional(), certifier_identity: z.string().nullable().optional(), manufacturing_detail: z.string().nullable().optional(), manufacturing_date: z.string().nullable().optional(), testing_detail: z.string().nullable().optional(), laboratory: z.string().nullable().optional(), records_custodian: z.string().nullable().optional(), product_identifier_type: z.enum(["sku", "gtin"]).nullable().optional(), product_identifier: z.string().nullable().optional(), disclaim_code: z.string().nullable().optional()}).nullable(); export const parcelItem = z.object({id: z.string().optional(), description: z.string().optional(), category: z.string().nullable().optional(), sku: z.string().nullable().optional(), platform_product_id: z.string().nullable().optional(), manufacturer_part_number: z.string().nullable().optional(), global_trade_item_number: z.string().nullable().optional(), hs_code: z.string().nullable().optional(), origin_country_alpha2: countryAlpha2Nullable.optional(), contains_battery_pi966: z.boolean().nullable().optional(), contains_battery_pi967: z.boolean().nullable().optional(), contains_liquids: z.boolean().nullable().optional(), quantity: z.number().int().optional(), dimensions: z.object({length: z.number().optional(), width: z.number().optional(), height: z.number().optional()}).optional(), actual_weight: z.number().optional(), origin_currency: z.enum(["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "BTC", "JEP", "EEK", "GHC", "MTL", "TMM", "YEN", "ZWD", "ZWL", "ZWN", "ZWR"]).optional(), origin_customs_value: z.number().optional(), declared_currency: z.enum(["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "BTC", "JEP", "EEK", "GHC", "MTL", "TMM", "YEN", "ZWD", "ZWL", "ZWN", "ZWR"]).optional(), declared_customs_value: z.number().optional(), coc_status: z.enum(["not_provided", "provided", "exempted"]).optional(), cpsc_eligible: z.boolean().optional(), cpsc_compliance: cpscCompliance.optional()}); export const parcel = z.object({id: z.string().nullable().optional(), total_actual_weight: z.number().optional(), box: box.optional(), items: z.array(parcelItem).optional(), tracking_number: z.string().nullable().optional()}); export const shipmentTracking = z.object({tracking_number: z.string().optional(), local_tracking_number: z.string().nullable().optional(), alternate_tracking_number: z.string().nullable().optional(), leg_number: z.number().int().gte(1).optional(), handler: z.string().optional(), tracking_state: z.enum(["created", "active", "pending", "completed", "overwritten_by_admin"]).optional()}); export const shipmentDocument = z.object({category: z.string().optional(), required: z.boolean().optional(), format: z.string().nullable().optional(), page_size: z.string().nullable().optional(), base64_encoded_strings: z.array(z.string()).optional(), url: z.string().nullable().optional(), message: z.string().optional()}); export const currency = z.enum(["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "BTC", "JEP", "EEK", "GHC", "MTL", "TMM", "YEN", "ZWD", "ZWL", "ZWN", "ZWR"]); export const rateCourierService = z.object({id: z.string().optional(), name: z.string().optional(), courier_id: z.string().optional(), umbrella_name: z.string().optional(), logo: z.unknown().optional(), easyship_courier_service: z.boolean().nullable().optional(), icon: z.unknown().optional()}); export const importDutyAdditionalRate = z.object({description: z.string().nullable().optional(), rate: z.number().nullable().optional(), amount: z.number().nullable().optional()}); export const importDutyDetails = z.object({hs_code_provided: z.string().nullable().optional(), hs_code_applied: z.string().nullable().optional(), subheading: z.boolean().nullable().optional(), duty_origin_country_id_provided: z.number().int().nullable().optional(), duty_origin_country_id_applied: z.number().int().nullable().optional(), duty_calculation_method: z.enum(["CIF", "FOB"]).nullable().optional(), line_item_shipment_value: z.number().nullable().optional(), applied_rate_type: z.enum(["fta", "general"]).nullable().optional(), additional_rates: z.array(importDutyAdditionalRate).nullable().optional(), base_duty_rate: z.number().nullable().optional(), base_duty_amount: z.number().nullable().optional(), line_item_total_duty: z.number().nullable().optional()}); export const rateDiscount = z.object({amount: z.number().optional(), origin_amount: z.number().optional()}).nullable(); export const rate = z.object({courier_service: rateCourierService.optional(), min_delivery_time: z.number().int().optional(), max_delivery_time: z.number().int().optional(), value_for_money_rank: z.number().optional(), delivery_time_rank: z.number().optional(), cost_rank: z.number().optional(), currency: currency.optional(), shipment_charge: z.number().optional(), fuel_surcharge: z.number().optional(), remote_area_surcharge: z.number().optional(), remote_area_surcharges: z.object({origin: z.object({name: z.string().optional(), base: z.number().optional()}).optional(), destination: z.object({name: z.string().optional(), base: z.number().optional()}).optional()}).nullable().optional(), other_surcharges: z.object({total_fee: z.number().optional(), details: z.array(z.object({name: z.string().optional(), fee: z.number().optional(), origin_fee: z.number().optional()})).optional()}).nullable().optional(), oversized_surcharge: z.number().optional(), additional_services_surcharge: z.number().optional(), residential_full_fee: z.number().optional(), residential_discounted_fee: z.number().optional(), shipment_charge_total: z.number().optional(), warehouse_handling_fee: z.number().optional(), insurance_fee: z.number().optional(), sales_tax: z.number().optional(), provincial_sales_tax: z.number().optional(), ddp_handling_fee: z.number().nullable().optional(), import_tax_charge: z.number().nullable().optional(), import_tax_non_chargeable: z.number().nullable().optional(), import_duty_charge: z.number().nullable().optional(), total_charge: z.number().optional(), is_above_threshold: z.boolean().nullable().optional(), is_above_duty_threshold: z.boolean().nullable().optional(), import_duty_details: z.array(importDutyDetails).nullable().optional(), incoterms: z.unknown().optional(), estimated_import_tax: z.number().nullable().optional(), estimated_import_duty: z.number().nullable().optional(), minimum_pickup_fee: z.number().gte(0).optional(), available_handover_options: z.array(z.string()).optional(), tracking_rating: z.number().gte(-1).lte(3).optional(), easyship_rating: z.number().gte(0).lte(5).optional(), courier_remarks: z.string().nullable().optional(), payment_recipient: z.enum(["Easyship", "EasyshipPayOnScan", "Courier"]).optional(), discount: rateDiscount.optional(), rates_in_origin_currency: z.object({currency: currency.optional(), shipment_charge: z.unknown().optional(), fuel_surcharge: z.unknown().optional(), remote_area_surcharge: z.unknown().optional(), additional_services_surcharge: z.unknown().optional(), oversized_surcharge: z.unknown().optional(), shipment_charge_total: z.unknown().optional(), warehouse_handling_fee: z.unknown().optional(), insurance_fee: z.unknown().optional(), ddp_handling_fee: z.unknown().optional(), import_tax_charge: z.unknown().optional(), import_tax_non_chargeable: z.unknown().optional(), import_duty_charge: z.unknown().optional(), residential_discounted_fee: z.unknown().optional(), residential_full_fee: z.unknown().optional(), total_charge: z.unknown().optional(), estimated_import_tax: z.unknown().optional(), estimated_import_duty: z.unknown().optional(), sales_tax: z.unknown().optional(), provincial_sales_tax: z.unknown().optional(), minimum_pickup_fee: z.unknown().optional()}).optional(), description: z.string().optional(), full_description: z.string().optional()}); export const shipment = z.object({easyship_shipment_id: z.string().optional(), created_at: z.string().optional(), updated_at: z.string().optional(), label_paid_at: z.string().nullable().optional(), label_generated_at: z.string().nullable().optional(), origin_address: z.object({line_1: z.string().optional(), line_2: z.string().nullable().optional(), line_3: z.string().nullable().optional(), state: z.string().optional(), city: z.string().optional(), postal_code: z.string().nullable().optional(), country_alpha2: countryAlpha2.optional(), company_name: z.string().nullable().optional(), contact_name: z.string().optional(), contact_phone: z.string().nullable().optional(), contact_email: z.string().optional()}).optional(), sender_address: z.object({line_1: z.string().optional(), line_2: z.string().nullable().optional(), line_3: z.string().nullable().optional(), state: z.string().optional(), city: z.string().optional(), postal_code: z.string().nullable().optional(), country_alpha2: countryAlpha2.optional(), company_name: z.string().nullable().optional(), contact_name: z.string().optional(), contact_phone: z.string().nullable().optional(), contact_email: z.string().optional()}).optional(), return_address: z.object({line_1: z.string().optional(), line_2: z.string().nullable().optional(), line_3: z.string().nullable().optional(), state: z.string().optional(), city: z.string().optional(), postal_code: z.string().nullable().optional(), country_alpha2: countryAlpha2.optional(), company_name: z.string().nullable().optional(), contact_name: z.string().optional(), contact_phone: z.string().nullable().optional(), contact_email: z.string().optional()}).optional(), destination_address: destinationAddress.optional(), order_data: z.object({platform_name: z.string().nullable().optional(), platform_order_number: z.string().nullable().optional(), order_created_at: z.string().nullable().optional(), order_tag_list: z.array(z.string()).optional(), seller_notes: z.string().nullable().optional(), buyer_notes: z.string().nullable().optional(), buyer_selected_courier_name: z.string().nullable().optional()}).optional(), last_failure_http_response_messages: z.array(z.object({code: z.string().nullable().optional(), content: z.string().nullable().optional()})).optional(), metadata: z.object({}).optional(), set_as_residential: z.boolean().optional(), consignee_tax_id: z.string().nullable().optional(), eei_reference: z.string().nullable().optional(), regulatory_identifiers: z.object({eori: z.string().nullable().optional(), ioss: z.string().nullable().optional(), vat_number: z.string().nullable().optional()}).optional(), buyer_regulatory_identifiers: z.object({ein: z.string().nullable().optional(), vat_number: z.string().nullable().optional(), ssn: z.string().nullable().optional()}).optional(), return: z.boolean().optional(), incoterms: z.enum(["DDU", "DDP", "null"]).nullable().optional(), insurance: z.object({is_insured: z.boolean().optional(), insured_amount: z.number().optional(), insured_currency: z.enum(["AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "BTC", "JEP", "EEK", "GHC", "MTL", "TMM", "YEN", "ZWD", "ZWL", "ZWN", "ZWR"]).optional()}).nullable().optional(), parcels: z.array(parcel).optional(), total_customs_value: z.number().gte(0).optional(), total_actual_weight: z.number().optional(), shipment_state: z.enum(["created", "draft", "calculating", "cancelling", "cancelled", "discarded", "deleted"]).optional(), pickup_state: z.string().optional(), delivery_state: z.enum(["not_created", "pending", "info_received", "in_transit_to_customer", "out_for_delivery", "delivered", "failed_attempt", "exception", "expired", "lost_by_courier", "returned_to_shipper"]).optional(), label_state: z.enum(["not_created", "pending", "generating", "generated", "printed", "failed", "technical_failed", "reported", "voided", "void_failed"]).optional(), warehouse_state: z.enum(["none", "pending", "created", "failed", "packed", "cancelled", "cancelled_no_stock", "backorder_no_stock", "shipped", "returned", "awaiting_dispatch"]).optional(), warehouse_code: z.string().optional(), original_easyship_shipment_id: z.unknown().optional(), trackings: z.array(shipmentTracking).optional(), tracking_page_url: z.string().optional(), shipping_documents: z.array(shipmentDocument).optional(), currency: currency.optional(), courier_service: z.object({id: z.string().optional(), name: z.string().optional(), courier_id: z.string().optional(), umbrella_name: z.string().optional(), easyship_courier_service: z.unknown().optional()}).nullable().optional(), rates: z.array(rate).optional(), shipping_settings: z.object({b13a_filing: z.object({option: z.enum(["not_required", "fedex_to_stamp", "filed_electronically", "manually_attached", "summary_reporting"]).optional(), option_export_compliance_statement: z.string().nullable().optional(), permit_number: z.string().nullable().optional()}).nullable().optional(), label_customization_fields: z.unknown().optional(), scheduled_ship_date: z.unknown().optional()}).optional()}); export const pagination = z.object({next: z.number().int().nullable().optional(), count: z.number().int().nullable().optional(), page: z.number().int().optional()}); export const metaWithPagination = z.object({pagination: pagination.optional(), request_id: z.string().optional()}); export const shipmentList = z.object({shipments: z.array(shipment).optional(), meta: metaWithPagination.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List all Shipments * * GET /2024-09/shipments */ export const getApi202409Shipments = async (args: GetApi202409ShipmentsArgs, options?: GetApi202409ShipmentsOptions) => { const {baseUrl = "https://public-api.easyship.com", fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.per_page != null) query.append("per_page", String(args.per_page)) if (args.easyship_shipment_id != null) query.append("easyship_shipment_id", args.easyship_shipment_id.join(',')) if (args.platform_order_number != null) query.append("platform_order_number", String(args.platform_order_number)) if (args.created_at_from != null) query.append("created_at_from", String(args.created_at_from)) if (args.created_at_to != null) query.append("created_at_to", String(args.created_at_to)) if (args.updated_at_from != null) query.append("updated_at_from", String(args.updated_at_from)) if (args.updated_at_to != null) query.append("updated_at_to", String(args.updated_at_to)) if (args.label_paid_at_from != null) query.append("label_paid_at_from", String(args.label_paid_at_from)) if (args.label_paid_at_to != null) query.append("label_paid_at_to", String(args.label_paid_at_to)) if (args.label_generated_at_from != null) query.append("label_generated_at_from", String(args.label_generated_at_from)) if (args.label_generated_at_to != null) query.append("label_generated_at_to", String(args.label_generated_at_to)) if (args.shipment_state != null) query.append("shipment_state", String(args.shipment_state)) if (args.label_state != null) query.append("label_state", args.label_state.join(',')) if (args.pickup_state != null) query.append("pickup_state", args.pickup_state.join(',')) if (args.delivery_state != null) query.append("delivery_state", args.delivery_state.join(',')) if (args.warehouse_state != null) query.append("warehouse_state", args.warehouse_state.join(',')) if (args.origin_country_alpha2 != null) query.append("origin_country_alpha2", args.origin_country_alpha2.join(',')) if (args.destination_country_alpha2 != null) query.append("destination_country_alpha2", args.destination_country_alpha2.join(',')) if (args.return != null) query.append("return", String(args.return)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/2024-09/shipments${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(shipmentList, await res.json()) };