import {z} from 'zod' export type GetApiShipmentIdIdArgs = {id: string}; export type GetApiShipmentIdIdOptions = {baseUrl: string, APIToken?: string | undefined, fetch?: typeof fetch | undefined}; export const entityReference = z.object({entityId: z.string().optional(), entityName: z.string().optional()}); export const onlyId = z.object({id: z.string().optional()}); export const customAttribute = z.object({attributeDefinitionId: z.string().optional(), booleanValue: z.boolean().optional(), dateValue: z.number().int().optional(), entityId: z.string().optional(), entityReferences: z.array(entityReference).optional(), numberValue: z.string().optional(), selectedValueId: z.string().optional(), selectedValues: z.array(onlyId).optional(), stringValue: z.string().optional()}); export const recordAddress = z.object({city: z.string().optional(), company: z.string().optional(), company2: z.string().optional(), countryCode: z.enum(["AC", "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", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "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", "IC", "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", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "UNKNOWN", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XK", "YE", "YT", "ZA", "ZM", "ZW"]).optional(), firstName: z.string().optional(), globalLocationNumber: z.string().optional(), lastName: z.string().optional(), middleName: z.string().optional(), phoneNumber: z.string().optional(), postOfficeBoxCity: z.string().optional(), postOfficeBoxNumber: z.string().optional(), postOfficeBoxZipCode: z.string().optional(), salutation: z.enum(["COMPANY", "FAMILY", "MR", "MRS", "NO_SALUTATION"]).optional(), state: z.string().optional(), street1: z.string().optional(), street2: z.string().optional(), titleId: z.string().optional(), zipcode: z.string().optional()}); export const parcel = z.object({id: z.string().optional(), version: z.string().optional(), cashOnDeliveryBankAccountId: z.string().optional(), cashOnDeliveryCurrencyId: z.string().optional(), createdDate: z.number().int().optional(), customAttributes: z.array(customAttribute).optional(), declaredValueAmount: z.string().optional(), declaredValueCurrencyId: z.string().optional(), dhlGoGreenPlusService: z.boolean().optional(), dhlPostalDeliveredDutyPaidService: z.boolean().optional(), dhlPremiumInternationalService: z.boolean().optional(), height: z.number().int().optional(), lastModifiedDate: z.number().int().optional(), length: z.number().int().optional(), packagingWeight: z.string().optional(), positionNumber: z.number().int(), reference: z.string().optional(), saturdayDelivery: z.boolean().optional(), shippingCarrierAddition: z.string().optional(), shippingCarrierId: z.string().optional(), shippingLabelsCount: z.number().int().optional(), trackingId: z.string().optional(), trackingUrl: z.string().optional(), useDeliveryDateAsPreferredDeliveryDate: z.boolean().optional(), weight: z.string().optional(), width: z.number().int().optional()}); export const emailAddresses = z.object({bccAddresses: z.string().optional(), ccAddresses: z.string().optional(), toAddresses: z.string().optional()}); export const itemPick = z.object({id: z.string().optional(), version: z.string().optional(), batchNumber: z.string().optional(), bookedDate: z.number().int().optional(), confirmedByUserId: z.string().optional(), confirmedDate: z.number().int().optional(), createdDate: z.number().int().optional(), customAttributes: z.array(customAttribute).optional(), internalTransportReferenceId: z.string().optional(), lastModifiedDate: z.number().int().optional(), orderItemId: z.string().optional(), quantity: z.string(), serialNumbers: z.array(z.string()), sourceInternalTransportReferenceId: z.string().optional(), sourceStoragePlaceId: z.string().optional(), storagePlaceId: z.string(), transportationOrderId: z.string().optional()}); export const shipmentItem = z.object({id: z.string().optional(), version: z.string().optional(), addPageBreakBefore: z.boolean().optional(), articleId: z.string().optional(), createdDate: z.number().int().optional(), customAttributes: z.array(customAttribute).optional(), description: z.string().optional(), descriptionFixed: z.boolean().optional(), groupName: z.string().optional(), itemType: z.enum(["DEFAULT", "FREE_TEXT", "SAMPLE", "SERVICE", "SERVICE_QUOTA"]).optional(), lastModifiedDate: z.number().int().optional(), manualQuantity: z.boolean().optional(), note: z.string().optional(), parentItemId: z.string().optional(), picks: z.array(itemPick).optional(), positionNumber: z.number().int().optional(), purchaseOrderItemId: z.string().optional(), quantity: z.string().optional(), returnAssessmentId: z.string().optional(), returnAssessments: z.array(onlyId).optional(), returnDescription: z.string().optional(), returnErrorId: z.string().optional(), returnErrors: z.array(onlyId).optional(), returnReasonId: z.string().optional(), returnReasons: z.array(onlyId).optional(), returnRectificationId: z.string().optional(), returnRectifications: z.array(onlyId).optional(), salesOrderItemId: z.string().optional(), title: z.string().optional(), unitId: z.string().optional()}); export const shipmentStatus = z.object({status: z.enum(["CANCELLED", "DELIVERED", "DELIVERY_NOTE_PRINTED", "INCOMING_CANCELLED", "INCOMING_MOVED_INTO_STORE", "INCOMING_SHIPPED", "IN_ROUTE", "NEW", "SHIPPED"]).optional(), statusDate: z.number().int().optional(), userId: z.string().optional()}); export const shipment = z.object({id: z.string().optional(), version: z.string().optional(), additionalDeliveryInformation: z.string().optional(), commercialLanguage: z.string().optional(), consolidationStoragePlaceId: z.string().optional(), createdDate: z.number().int().optional(), creatorId: z.string().optional(), customAttributes: z.array(customAttribute).optional(), customerPurchaseOrderNumber: z.string().optional(), declaredValueAmount: z.string().optional(), declaredValueAmountCurrencyId: z.string().optional(), deliveryDate: z.number().int().optional(), description: z.string().optional(), destinationStoragePlaceId: z.string().optional(), destinationWarehouseId: z.string().optional(), dhlReceiverId: z.string().optional(), disableRecordEmailingRule: z.boolean().optional(), invoiceAddress: recordAddress.optional(), invoiceRecipientId: z.string().optional(), lastModifiedDate: z.number().int().optional(), lastStatusChangeUserId: z.string().optional(), mainSalesOrderId: z.string().optional(), packageHeight: z.number().int().optional(), packageLength: z.number().int().optional(), packageReferenceNumber: z.string().optional(), packageReturnTrackingNumber: z.string().optional(), packageReturnTrackingUrl: z.string().optional(), packageTrackingNumber: z.string().optional(), packageTrackingUrl: z.string().optional(), packageWeight: z.string().optional(), packageWidth: z.number().int().optional(), parcels: z.array(parcel).optional(), pickingInstructions: z.string().optional(), picksComplete: z.boolean().optional(), purchaseOrders: z.array(onlyId).optional(), recipientAddress: recordAddress.optional(), recipientCustomerNumber: z.string().optional(), recipientPartyId: z.string().optional(), recipientSupplierNumber: z.string().optional(), recordComment: z.string().optional(), recordEmailAddresses: emailAddresses.optional(), recordFreeText: z.string().optional(), recordOpening: z.string().optional(), responsibleUserId: z.string().optional(), salesInvoiceEmailAddresses: emailAddresses.optional(), salesOrders: z.array(onlyId).optional(), sentToRecipient: z.boolean().optional(), shipmentItems: z.array(shipmentItem).optional(), shipmentMethodId: z.string().optional(), shipmentNumber: z.string().optional(), shipmentType: z.enum(["CONSIGNMENT", "CONSIGNMENT_RETURN", "CUSTOMER_COMPENSATION", "INTERNAL", "STANDARD", "SUPPLIER_RETURN"]).optional(), shippedFromAddress: recordAddress.optional(), shippingCarrierId: z.string().optional(), shippingDate: z.number().int().optional(), shippingLabelsCount: z.number().int().optional(), shippingReturnCarrierId: z.string().optional(), shippingReturnLabelsCount: z.number().int().optional(), status: z.enum(["CANCELLED", "DELIVERED", "DELIVERY_NOTE_PRINTED", "INCOMING_CANCELLED", "INCOMING_MOVED_INTO_STORE", "INCOMING_SHIPPED", "IN_ROUTE", "NEW", "SHIPPED"]), statusHistory: z.array(shipmentStatus).optional(), tags: z.array(z.string()).optional(), totalWeight: z.string().optional(), warehouseId: z.string().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 }; /** * query shipment * * GET /shipment/id/{id} */ export const getApiShipmentIdId = async (args: GetApiShipmentIdIdArgs, options: GetApiShipmentIdIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, APIToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (APIToken !== undefined) headers.set("AuthenticationToken", APIToken) const url = `${baseUrl.replace(/\/+$/, '')}/shipment/id/${encodeURIComponent(String(args.id))}${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(shipment, await res.json()) };