import {z} from 'zod' export type LinearDimensions = {linearUnit?: ('in' | 'cm') | undefined, length?: number | undefined, width?: number | undefined, height?: number | undefined}; export type Weight = {weightUnit?: ('g' | 'kg' | 'oz' | 'lb') | undefined, weight?: number | undefined}; export type PackagingTypeParameters = {packagingMaterial?: ('box' | 'envelope' | 'flat_pack' | 'fedex_one_rate_envelope' | 'fedex_one_rate_pak' | 'fedex_one_rate_extra_small_box' | 'fedex_one_rate_small_box' | 'fedex_one_rate_medium_box' | 'fedex_one_rate_large_box' | 'fedex_one_rate_extra_large_box' | 'fedex_one_rate_tube' | 'fedex_ten_kg_box' | 'fedex_twenty_five_kg_box' | 'mailing_tube' | 'parcel_pallet' | 'small_tire' | 'large_tire' | 'usps_large_box' | 'usps_large_box_to_apo_fpo_dpo' | 'usps_medium_box' | 'usps_small_box' | 'usps_legal_envelope' | 'usps_envelope' | 'usps_padded_envelope' | 'ups_express_envelope') | undefined, packagingSizeName?: string | undefined, packagingTypeId?: string | undefined, linearDimensions?: LinearDimensions | undefined, packagingWeight?: Weight | undefined}; export type InjectionParameter = {injectionProfileId?: string | undefined, injectionSiteId?: string | undefined}; export type CarrierSelectionCreate = {currencyCode: string, shippedDateTime?: string | undefined, packagingType?: PackagingTypeParameters | undefined, asOfDate?: string | undefined, carrierServiceMethodAllowList?: Array | undefined, ignoreRuleSets?: boolean | undefined, includeEvaluatedServiceMethodsInResponse?: boolean | undefined, includeLineItemsInEvaluatedServiceMethods?: boolean | undefined, includeInjectionProfiles?: boolean | undefined, injectionParameters?: Array | undefined, ignoreCarrierMinimumDimensions?: boolean | undefined, serviceMethodPoBoxAllowList?: Array | undefined}; export type CreateApiApiV1DeliveryexperienceShipmentShipiumShipmentIdCarrierSelectionArgs = {shipiumShipmentId: string, body: CarrierSelectionCreate}; export type CreateApiApiV1DeliveryexperienceShipmentShipiumShipmentIdCarrierSelectionOptions = {baseUrl?: string | undefined, oauth2Scheme?: string | undefined, fetch?: typeof fetch | undefined}; export const carrierSelectionPrice = z.object({currencyCode: z.string().optional(), shippingCost: z.number().optional(), insuranceCost: z.number().optional(), accessorials: z.number().optional(), duty: z.number().optional(), taxes: z.number().optional(), totalCost: z.number().optional(), adjustedLabelCost: z.number().optional(), carrierCompareCost: z.number().optional(), carrierInvoiceCost: z.number().optional(), operationalCost: z.number().optional()}); export const ruleIdentification = z.object({ruleId: z.string().optional(), ruleUrn: z.string().optional(), name: z.string().optional(), serviceMethodIdsAfterExecutingRule: z.array(z.string()).optional(), sequence: z.number().int().optional(), inactive: z.boolean().optional()}); export const ruleSetProcessingResultSummary = z.object({result: z.enum(["selection_made", "no_selection"]).optional(), selectedCarrierServiceMethodIdentifiers: z.array(z.string()).optional(), ruleMakingSelection: ruleIdentification.optional(), rulesApplied: z.array(ruleIdentification).optional(), ruleSetUrn: z.string().optional(), processingTimestamp: z.string().optional()}); export const injectionRateModifier = z.object({modifierType: z.enum(["flat", "percentage"]).optional(), modifierValue: z.number().optional()}); export const injectionCostDetails = z.object({injectionLineItemRate: z.number().optional(), injectionLineItemCurrencyCode: z.string().optional(), injectionRateModifier: injectionRateModifier.optional()}); export const injectionDetails = z.object({requestInjectionProfileId: z.string().optional(), partnerInjectionProfileId: z.string().optional(), shipiumInjectionProfileId: z.string().optional(), requestInjectionSiteId: z.string().optional(), partnerInjectionSiteId: z.string().optional(), shipiumInjectionSiteId: z.string().optional(), injectionCostDetails: injectionCostDetails.optional()}); export const carrierSelectionDecision = z.object({status: z.enum(["success", "uncosted", "no_decision"]).optional(), statusDetails: z.string().optional(), partnerId: z.string().optional(), carrierAccountId: z.string().optional(), serviceMethodUrn: z.string().optional(), serviceMethodIdentifier: z.string().optional(), carrier: z.string().optional(), carrierServiceName: z.string().optional(), thirdPartyBilling: z.boolean().optional(), includeEvaluatedServiceMethodsInResponse: z.boolean().optional(), includeLineItemsInEvaluatedServiceMethods: z.boolean().optional(), carrierEstimatedPriceDetails: carrierSelectionPrice.optional(), serviceMethodName: z.string().optional(), carrierServiceMethodId: z.string().optional(), ruleSetProcessingResultSummary: ruleSetProcessingResultSummary.optional(), effectiveShipDateTime: z.string().optional(), estimatedDeliveryDate: z.string().optional(), estimatedInjectionDateTime: z.string().optional(), carrierZoneId: z.string().optional(), injectionDetails: injectionDetails.optional(), effectiveDesiredDeliveryDate: z.string().optional(), currencyCode: z.string().optional(), exddCompatibleFlag: z.boolean().optional()}); export const laneMatch = z.object({laneId: z.string().optional(), partnerLaneId: z.string().optional()}); export const carrierSelection = z.object({carrierSelectionId: z.string().optional(), shipiumShipmentId: z.string().optional(), partnerShipmentId: z.string().optional(), shipiumTenantId: z.string().optional(), partnerTenantId: z.string().optional(), costAdjustConfigId: z.string().optional(), carrierDecision: carrierSelectionDecision.optional(), carrierSelectionDateTime: z.string().optional(), carrierSelectionExpiration: z.string().optional(), laneMatch: laneMatch.optional(), cancellationDateTime: z.string().optional(), currencyCode: 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 }; /** * Run the carrier selection process on a existing partner shipment. * * POST /api/v1/deliveryexperience/shipment/{shipiumShipmentId}/carrierSelection */ export const createApiApiV1DeliveryexperienceShipmentShipiumShipmentIdCarrierSelection = async (args: CreateApiApiV1DeliveryexperienceShipmentShipiumShipmentIdCarrierSelectionArgs, options?: CreateApiApiV1DeliveryexperienceShipmentShipiumShipmentIdCarrierSelectionOptions) => { const {baseUrl = "https://api.shipium.com", fetch: fetchFn = fetch, oauth2Scheme} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (oauth2Scheme !== undefined) headers.set('authorization', `Bearer ${oauth2Scheme}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/deliveryexperience/shipment/${encodeURIComponent(String(args.shipiumShipmentId))}/carrierSelection${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(carrierSelection, await res.json()) };