@unified-api/typescript-sdk 2.82.13 → 2.82.15

package/src/sdk/models/shared/shippingshipment.ts

@@ -0,0 +1,377 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertyShippingShipmentCustoms,
+  PropertyShippingShipmentCustoms$inboundSchema,
+  PropertyShippingShipmentCustoms$Outbound,
+  PropertyShippingShipmentCustoms$outboundSchema,
+} from "./propertyshippingshipmentcustoms.js";
+import {
+  PropertyShippingShipmentFromAddress,
+  PropertyShippingShipmentFromAddress$inboundSchema,
+  PropertyShippingShipmentFromAddress$Outbound,
+  PropertyShippingShipmentFromAddress$outboundSchema,
+} from "./propertyshippingshipmentfromaddress.js";
+import {
+  PropertyShippingShipmentInsurance,
+  PropertyShippingShipmentInsurance$inboundSchema,
+  PropertyShippingShipmentInsurance$Outbound,
+  PropertyShippingShipmentInsurance$outboundSchema,
+} from "./propertyshippingshipmentinsurance.js";
+import {
+  PropertyShippingShipmentReturnAddress,
+  PropertyShippingShipmentReturnAddress$inboundSchema,
+  PropertyShippingShipmentReturnAddress$Outbound,
+  PropertyShippingShipmentReturnAddress$outboundSchema,
+} from "./propertyshippingshipmentreturnaddress.js";
+import {
+  PropertyShippingShipmentToAddress,
+  PropertyShippingShipmentToAddress$inboundSchema,
+  PropertyShippingShipmentToAddress$Outbound,
+  PropertyShippingShipmentToAddress$outboundSchema,
+} from "./propertyshippingshipmenttoaddress.js";
+import {
+  ShippingPackage,
+  ShippingPackage$inboundSchema,
+  ShippingPackage$Outbound,
+  ShippingPackage$outboundSchema,
+} from "./shippingpackage.js";
+
+export const ReturnTypeT = {
+  Customer: "CUSTOMER",
+  Vendor: "VENDOR",
+  Warranty: "WARRANTY",
+  Defective: "DEFECTIVE",
+  Other: "OTHER",
+} as const;
+export type ReturnTypeT = OpenEnum<typeof ReturnTypeT>;
+
+export const ShippingShipmentStatus = {
+  Pending: "PENDING",
+  Processing: "PROCESSING",
+  InTransit: "IN_TRANSIT",
+  Delivered: "DELIVERED",
+  Exception: "EXCEPTION",
+  Cancelled: "CANCELLED",
+  LabelCreated: "LABEL_CREATED",
+  PickedUp: "PICKED_UP",
+  OutForDelivery: "OUT_FOR_DELIVERY",
+  DeliveryAttempted: "DELIVERY_ATTEMPTED",
+  ReturnedToSender: "RETURNED_TO_SENDER",
+  HeldAtLocation: "HELD_AT_LOCATION",
+  CustomsClearance: "CUSTOMS_CLEARANCE",
+  ExceptionResolved: "EXCEPTION_RESOLVED",
+} as const;
+export type ShippingShipmentStatus = OpenEnum<typeof ShippingShipmentStatus>;
+
+export type ShippingShipment = {
+  carrierId?: string | undefined;
+  createdAt?: Date | undefined;
+  /**
+   * Customs information
+   */
+  customs?: PropertyShippingShipmentCustoms | undefined;
+  /**
+   * Origin address
+   */
+  fromAddress?: PropertyShippingShipmentFromAddress | undefined;
+  id?: string | undefined;
+  /**
+   * Insurance details
+   */
+  insurance?: PropertyShippingShipmentInsurance | undefined;
+  isAdultSignatureRequired?: boolean | undefined;
+  isInternational?: boolean | undefined;
+  isRateGuaranteed?: boolean | undefined;
+  isReturn?: boolean | undefined;
+  isSignatureRequired?: boolean | undefined;
+  labelId?: string | undefined;
+  orderId?: string | undefined;
+  originalShipmentId?: string | undefined;
+  /**
+   * Array of packages in this shipment
+   */
+  packages?: Array<ShippingPackage> | undefined;
+  rateAmount?: number | undefined;
+  rateCurrency?: string | undefined;
+  rateEstimatedDays?: number | undefined;
+  rateEstimatedDeliveryAt?: Date | undefined;
+  rateId?: string | undefined;
+  rateServiceName?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  referenceNumber?: string | undefined;
+  /**
+   * Return address (may differ from from_address)
+   */
+  returnAddress?: PropertyShippingShipmentReturnAddress | undefined;
+  returnAuthorizationNumber?: string | undefined;
+  returnReason?: string | undefined;
+  returnType?: ReturnTypeT | undefined;
+  serviceCode?: string | undefined;
+  shippedAt?: Date | undefined;
+  /**
+   * Array of special instructions
+   */
+  specialInstructions?: Array<string> | undefined;
+  status?: ShippingShipmentStatus | undefined;
+  /**
+   * Destination address
+   */
+  toAddress?: PropertyShippingShipmentToAddress | undefined;
+  trackingId?: string | undefined;
+  updatedAt?: Date | undefined;
+  warehouseLocationId?: string | undefined;
+  warehouseLocationName?: string | undefined;
+};
+
+/** @internal */
+export const ReturnTypeT$inboundSchema: z.ZodType<
+  ReturnTypeT,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ReturnTypeT);
+/** @internal */
+export const ReturnTypeT$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ReturnTypeT
+> = openEnums.outboundSchema(ReturnTypeT);
+
+/** @internal */
+export const ShippingShipmentStatus$inboundSchema: z.ZodType<
+  ShippingShipmentStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingShipmentStatus);
+/** @internal */
+export const ShippingShipmentStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingShipmentStatus
+> = openEnums.outboundSchema(ShippingShipmentStatus);
+
+/** @internal */
+export const ShippingShipment$inboundSchema: z.ZodType<
+  ShippingShipment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  carrier_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  customs: PropertyShippingShipmentCustoms$inboundSchema.optional(),
+  from_address: PropertyShippingShipmentFromAddress$inboundSchema.optional(),
+  id: z.string().optional(),
+  insurance: PropertyShippingShipmentInsurance$inboundSchema.optional(),
+  is_adult_signature_required: z.boolean().optional(),
+  is_international: z.boolean().optional(),
+  is_rate_guaranteed: z.boolean().optional(),
+  is_return: z.boolean().optional(),
+  is_signature_required: z.boolean().optional(),
+  label_id: z.string().optional(),
+  order_id: z.string().optional(),
+  original_shipment_id: z.string().optional(),
+  packages: z.array(ShippingPackage$inboundSchema).optional(),
+  rate_amount: z.number().optional(),
+  rate_currency: z.string().optional(),
+  rate_estimated_days: z.number().optional(),
+  rate_estimated_delivery_at: z.string().datetime({ offset: true }).transform(
+    v => new Date(v)
+  ).optional(),
+  rate_id: z.string().optional(),
+  rate_service_name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  reference_number: z.string().optional(),
+  return_address: PropertyShippingShipmentReturnAddress$inboundSchema
+    .optional(),
+  return_authorization_number: z.string().optional(),
+  return_reason: z.string().optional(),
+  return_type: ReturnTypeT$inboundSchema.optional(),
+  service_code: z.string().optional(),
+  shipped_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  special_instructions: z.array(z.string()).optional(),
+  status: ShippingShipmentStatus$inboundSchema.optional(),
+  to_address: PropertyShippingShipmentToAddress$inboundSchema.optional(),
+  tracking_id: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  warehouse_location_id: z.string().optional(),
+  warehouse_location_name: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "carrier_id": "carrierId",
+    "created_at": "createdAt",
+    "from_address": "fromAddress",
+    "is_adult_signature_required": "isAdultSignatureRequired",
+    "is_international": "isInternational",
+    "is_rate_guaranteed": "isRateGuaranteed",
+    "is_return": "isReturn",
+    "is_signature_required": "isSignatureRequired",
+    "label_id": "labelId",
+    "order_id": "orderId",
+    "original_shipment_id": "originalShipmentId",
+    "rate_amount": "rateAmount",
+    "rate_currency": "rateCurrency",
+    "rate_estimated_days": "rateEstimatedDays",
+    "rate_estimated_delivery_at": "rateEstimatedDeliveryAt",
+    "rate_id": "rateId",
+    "rate_service_name": "rateServiceName",
+    "reference_number": "referenceNumber",
+    "return_address": "returnAddress",
+    "return_authorization_number": "returnAuthorizationNumber",
+    "return_reason": "returnReason",
+    "return_type": "returnType",
+    "service_code": "serviceCode",
+    "shipped_at": "shippedAt",
+    "special_instructions": "specialInstructions",
+    "to_address": "toAddress",
+    "tracking_id": "trackingId",
+    "updated_at": "updatedAt",
+    "warehouse_location_id": "warehouseLocationId",
+    "warehouse_location_name": "warehouseLocationName",
+  });
+});
+/** @internal */
+export type ShippingShipment$Outbound = {
+  carrier_id?: string | undefined;
+  created_at?: string | undefined;
+  customs?: PropertyShippingShipmentCustoms$Outbound | undefined;
+  from_address?: PropertyShippingShipmentFromAddress$Outbound | undefined;
+  id?: string | undefined;
+  insurance?: PropertyShippingShipmentInsurance$Outbound | undefined;
+  is_adult_signature_required?: boolean | undefined;
+  is_international?: boolean | undefined;
+  is_rate_guaranteed?: boolean | undefined;
+  is_return?: boolean | undefined;
+  is_signature_required?: boolean | undefined;
+  label_id?: string | undefined;
+  order_id?: string | undefined;
+  original_shipment_id?: string | undefined;
+  packages?: Array<ShippingPackage$Outbound> | undefined;
+  rate_amount?: number | undefined;
+  rate_currency?: string | undefined;
+  rate_estimated_days?: number | undefined;
+  rate_estimated_delivery_at?: string | undefined;
+  rate_id?: string | undefined;
+  rate_service_name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  reference_number?: string | undefined;
+  return_address?: PropertyShippingShipmentReturnAddress$Outbound | undefined;
+  return_authorization_number?: string | undefined;
+  return_reason?: string | undefined;
+  return_type?: string | undefined;
+  service_code?: string | undefined;
+  shipped_at?: string | undefined;
+  special_instructions?: Array<string> | undefined;
+  status?: string | undefined;
+  to_address?: PropertyShippingShipmentToAddress$Outbound | undefined;
+  tracking_id?: string | undefined;
+  updated_at?: string | undefined;
+  warehouse_location_id?: string | undefined;
+  warehouse_location_name?: string | undefined;
+};
+
+/** @internal */
+export const ShippingShipment$outboundSchema: z.ZodType<
+  ShippingShipment$Outbound,
+  z.ZodTypeDef,
+  ShippingShipment
+> = z.object({
+  carrierId: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  customs: PropertyShippingShipmentCustoms$outboundSchema.optional(),
+  fromAddress: PropertyShippingShipmentFromAddress$outboundSchema.optional(),
+  id: z.string().optional(),
+  insurance: PropertyShippingShipmentInsurance$outboundSchema.optional(),
+  isAdultSignatureRequired: z.boolean().optional(),
+  isInternational: z.boolean().optional(),
+  isRateGuaranteed: z.boolean().optional(),
+  isReturn: z.boolean().optional(),
+  isSignatureRequired: z.boolean().optional(),
+  labelId: z.string().optional(),
+  orderId: z.string().optional(),
+  originalShipmentId: z.string().optional(),
+  packages: z.array(ShippingPackage$outboundSchema).optional(),
+  rateAmount: z.number().optional(),
+  rateCurrency: z.string().optional(),
+  rateEstimatedDays: z.number().optional(),
+  rateEstimatedDeliveryAt: z.date().transform(v => v.toISOString()).optional(),
+  rateId: z.string().optional(),
+  rateServiceName: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  referenceNumber: z.string().optional(),
+  returnAddress: PropertyShippingShipmentReturnAddress$outboundSchema
+    .optional(),
+  returnAuthorizationNumber: z.string().optional(),
+  returnReason: z.string().optional(),
+  returnType: ReturnTypeT$outboundSchema.optional(),
+  serviceCode: z.string().optional(),
+  shippedAt: z.date().transform(v => v.toISOString()).optional(),
+  specialInstructions: z.array(z.string()).optional(),
+  status: ShippingShipmentStatus$outboundSchema.optional(),
+  toAddress: PropertyShippingShipmentToAddress$outboundSchema.optional(),
+  trackingId: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  warehouseLocationId: z.string().optional(),
+  warehouseLocationName: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    carrierId: "carrier_id",
+    createdAt: "created_at",
+    fromAddress: "from_address",
+    isAdultSignatureRequired: "is_adult_signature_required",
+    isInternational: "is_international",
+    isRateGuaranteed: "is_rate_guaranteed",
+    isReturn: "is_return",
+    isSignatureRequired: "is_signature_required",
+    labelId: "label_id",
+    orderId: "order_id",
+    originalShipmentId: "original_shipment_id",
+    rateAmount: "rate_amount",
+    rateCurrency: "rate_currency",
+    rateEstimatedDays: "rate_estimated_days",
+    rateEstimatedDeliveryAt: "rate_estimated_delivery_at",
+    rateId: "rate_id",
+    rateServiceName: "rate_service_name",
+    referenceNumber: "reference_number",
+    returnAddress: "return_address",
+    returnAuthorizationNumber: "return_authorization_number",
+    returnReason: "return_reason",
+    returnType: "return_type",
+    serviceCode: "service_code",
+    shippedAt: "shipped_at",
+    specialInstructions: "special_instructions",
+    toAddress: "to_address",
+    trackingId: "tracking_id",
+    updatedAt: "updated_at",
+    warehouseLocationId: "warehouse_location_id",
+    warehouseLocationName: "warehouse_location_name",
+  });
+});
+
+export function shippingShipmentToJSON(
+  shippingShipment: ShippingShipment,
+): string {
+  return JSON.stringify(
+    ShippingShipment$outboundSchema.parse(shippingShipment),
+  );
+}
+export function shippingShipmentFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingShipment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingShipment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingShipment' from JSON`,
+  );
+}

package/src/sdk/models/shared/shippingtracking.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ShippingTrackingEvent,
+  ShippingTrackingEvent$inboundSchema,
+  ShippingTrackingEvent$Outbound,
+  ShippingTrackingEvent$outboundSchema,
+} from "./shippingtrackingevent.js";
+
+export const ShippingTrackingStatus = {
+  Pending: "PENDING",
+  Processing: "PROCESSING",
+  InTransit: "IN_TRANSIT",
+  Delivered: "DELIVERED",
+  Exception: "EXCEPTION",
+  Cancelled: "CANCELLED",
+  LabelCreated: "LABEL_CREATED",
+  PickedUp: "PICKED_UP",
+  OutForDelivery: "OUT_FOR_DELIVERY",
+  DeliveryAttempted: "DELIVERY_ATTEMPTED",
+  ReturnedToSender: "RETURNED_TO_SENDER",
+  HeldAtLocation: "HELD_AT_LOCATION",
+  CustomsClearance: "CUSTOMS_CLEARANCE",
+  ExceptionResolved: "EXCEPTION_RESOLVED",
+} as const;
+export type ShippingTrackingStatus = OpenEnum<typeof ShippingTrackingStatus>;
+
+export type ShippingTracking = {
+  actualDeliveryAt?: Date | undefined;
+  carrierId?: string | undefined;
+  carrierStatusCode?: string | undefined;
+  carrierStatusDescription?: string | undefined;
+  createdAt?: Date | undefined;
+  estimatedDelivery?: Date | undefined;
+  /**
+   * Array of tracking events
+   */
+  events?: Array<ShippingTrackingEvent> | undefined;
+  id?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  shipmentId?: string | undefined;
+  status?: ShippingTrackingStatus | undefined;
+  statusDescription?: string | undefined;
+  trackingNumber?: string | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const ShippingTrackingStatus$inboundSchema: z.ZodType<
+  ShippingTrackingStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingTrackingStatus);
+/** @internal */
+export const ShippingTrackingStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingTrackingStatus
+> = openEnums.outboundSchema(ShippingTrackingStatus);
+
+/** @internal */
+export const ShippingTracking$inboundSchema: z.ZodType<
+  ShippingTracking,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  actual_delivery_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  carrier_id: z.string().optional(),
+  carrier_status_code: z.string().optional(),
+  carrier_status_description: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  estimated_delivery: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  events: z.array(ShippingTrackingEvent$inboundSchema).optional(),
+  id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  shipment_id: z.string().optional(),
+  status: ShippingTrackingStatus$inboundSchema.optional(),
+  status_description: z.string().optional(),
+  tracking_number: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "actual_delivery_at": "actualDeliveryAt",
+    "carrier_id": "carrierId",
+    "carrier_status_code": "carrierStatusCode",
+    "carrier_status_description": "carrierStatusDescription",
+    "created_at": "createdAt",
+    "estimated_delivery": "estimatedDelivery",
+    "shipment_id": "shipmentId",
+    "status_description": "statusDescription",
+    "tracking_number": "trackingNumber",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type ShippingTracking$Outbound = {
+  actual_delivery_at?: string | undefined;
+  carrier_id?: string | undefined;
+  carrier_status_code?: string | undefined;
+  carrier_status_description?: string | undefined;
+  created_at?: string | undefined;
+  estimated_delivery?: string | undefined;
+  events?: Array<ShippingTrackingEvent$Outbound> | undefined;
+  id?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  shipment_id?: string | undefined;
+  status?: string | undefined;
+  status_description?: string | undefined;
+  tracking_number?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const ShippingTracking$outboundSchema: z.ZodType<
+  ShippingTracking$Outbound,
+  z.ZodTypeDef,
+  ShippingTracking
+> = z.object({
+  actualDeliveryAt: z.date().transform(v => v.toISOString()).optional(),
+  carrierId: z.string().optional(),
+  carrierStatusCode: z.string().optional(),
+  carrierStatusDescription: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  estimatedDelivery: z.date().transform(v => v.toISOString()).optional(),
+  events: z.array(ShippingTrackingEvent$outboundSchema).optional(),
+  id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  shipmentId: z.string().optional(),
+  status: ShippingTrackingStatus$outboundSchema.optional(),
+  statusDescription: z.string().optional(),
+  trackingNumber: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actualDeliveryAt: "actual_delivery_at",
+    carrierId: "carrier_id",
+    carrierStatusCode: "carrier_status_code",
+    carrierStatusDescription: "carrier_status_description",
+    createdAt: "created_at",
+    estimatedDelivery: "estimated_delivery",
+    shipmentId: "shipment_id",
+    statusDescription: "status_description",
+    trackingNumber: "tracking_number",
+    updatedAt: "updated_at",
+  });
+});
+
+export function shippingTrackingToJSON(
+  shippingTracking: ShippingTracking,
+): string {
+  return JSON.stringify(
+    ShippingTracking$outboundSchema.parse(shippingTracking),
+  );
+}
+export function shippingTrackingFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingTracking, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingTracking$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingTracking' from JSON`,
+  );
+}