@unified-api/typescript-sdk 2.82.14 → 2.82.16

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

@@ -0,0 +1,121 @@
+/*
+ * 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";
+
+export const ShippingCustomsItemWeightUnit = {
+  G: "g",
+  Kg: "kg",
+  Oz: "oz",
+  Lb: "lb",
+} as const;
+export type ShippingCustomsItemWeightUnit = OpenEnum<
+  typeof ShippingCustomsItemWeightUnit
+>;
+
+export type ShippingCustomsItem = {
+  amount?: number | undefined;
+  countryOfOrigin?: string | undefined;
+  currency?: string | undefined;
+  description?: string | undefined;
+  harmonizedTariffCode?: string | undefined;
+  quantity?: number | undefined;
+  sku?: string | undefined;
+  weight?: number | undefined;
+  weightUnit?: ShippingCustomsItemWeightUnit | undefined;
+};
+
+/** @internal */
+export const ShippingCustomsItemWeightUnit$inboundSchema: z.ZodType<
+  ShippingCustomsItemWeightUnit,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingCustomsItemWeightUnit);
+/** @internal */
+export const ShippingCustomsItemWeightUnit$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingCustomsItemWeightUnit
+> = openEnums.outboundSchema(ShippingCustomsItemWeightUnit);
+
+/** @internal */
+export const ShippingCustomsItem$inboundSchema: z.ZodType<
+  ShippingCustomsItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number().optional(),
+  country_of_origin: z.string().optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  harmonized_tariff_code: z.string().optional(),
+  quantity: z.number().optional(),
+  sku: z.string().optional(),
+  weight: z.number().optional(),
+  weight_unit: ShippingCustomsItemWeightUnit$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "country_of_origin": "countryOfOrigin",
+    "harmonized_tariff_code": "harmonizedTariffCode",
+    "weight_unit": "weightUnit",
+  });
+});
+/** @internal */
+export type ShippingCustomsItem$Outbound = {
+  amount?: number | undefined;
+  country_of_origin?: string | undefined;
+  currency?: string | undefined;
+  description?: string | undefined;
+  harmonized_tariff_code?: string | undefined;
+  quantity?: number | undefined;
+  sku?: string | undefined;
+  weight?: number | undefined;
+  weight_unit?: string | undefined;
+};
+
+/** @internal */
+export const ShippingCustomsItem$outboundSchema: z.ZodType<
+  ShippingCustomsItem$Outbound,
+  z.ZodTypeDef,
+  ShippingCustomsItem
+> = z.object({
+  amount: z.number().optional(),
+  countryOfOrigin: z.string().optional(),
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  harmonizedTariffCode: z.string().optional(),
+  quantity: z.number().optional(),
+  sku: z.string().optional(),
+  weight: z.number().optional(),
+  weightUnit: ShippingCustomsItemWeightUnit$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    countryOfOrigin: "country_of_origin",
+    harmonizedTariffCode: "harmonized_tariff_code",
+    weightUnit: "weight_unit",
+  });
+});
+
+export function shippingCustomsItemToJSON(
+  shippingCustomsItem: ShippingCustomsItem,
+): string {
+  return JSON.stringify(
+    ShippingCustomsItem$outboundSchema.parse(shippingCustomsItem),
+  );
+}
+export function shippingCustomsItemFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingCustomsItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingCustomsItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingCustomsItem' from JSON`,
+  );
+}

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

@@ -0,0 +1,188 @@
+/*
+ * 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";
+
+export const LabelFormat = {
+  Pdf: "PDF",
+  Png: "PNG",
+  Zpl: "ZPL",
+  Epl2: "EPL2",
+  Pdf4X6: "PDF_4X6",
+  Pdf4X8: "PDF_4X8",
+  Png4X6: "PNG_4X6",
+  Png4X8: "PNG_4X8",
+} as const;
+export type LabelFormat = OpenEnum<typeof LabelFormat>;
+
+export const ShippingLabelStatus = {
+  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 ShippingLabelStatus = OpenEnum<typeof ShippingLabelStatus>;
+
+export type ShippingLabel = {
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  isVoided?: boolean | undefined;
+  labelCost?: number | undefined;
+  labelCostCurrency?: string | undefined;
+  labelFormat?: LabelFormat | undefined;
+  labelUrl?: string | undefined;
+  rateId?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  serviceCode?: string | undefined;
+  shipmentId?: string | undefined;
+  status?: ShippingLabelStatus | undefined;
+  trackingNumber?: string | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const LabelFormat$inboundSchema: z.ZodType<
+  LabelFormat,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(LabelFormat);
+/** @internal */
+export const LabelFormat$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  LabelFormat
+> = openEnums.outboundSchema(LabelFormat);
+
+/** @internal */
+export const ShippingLabelStatus$inboundSchema: z.ZodType<
+  ShippingLabelStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingLabelStatus);
+/** @internal */
+export const ShippingLabelStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingLabelStatus
+> = openEnums.outboundSchema(ShippingLabelStatus);
+
+/** @internal */
+export const ShippingLabel$inboundSchema: z.ZodType<
+  ShippingLabel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  is_voided: z.boolean().optional(),
+  label_cost: z.number().optional(),
+  label_cost_currency: z.string().optional(),
+  label_format: LabelFormat$inboundSchema.optional(),
+  label_url: z.string().optional(),
+  rate_id: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  service_code: z.string().optional(),
+  shipment_id: z.string().optional(),
+  status: ShippingLabelStatus$inboundSchema.optional(),
+  tracking_number: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "is_voided": "isVoided",
+    "label_cost": "labelCost",
+    "label_cost_currency": "labelCostCurrency",
+    "label_format": "labelFormat",
+    "label_url": "labelUrl",
+    "rate_id": "rateId",
+    "service_code": "serviceCode",
+    "shipment_id": "shipmentId",
+    "tracking_number": "trackingNumber",
+    "updated_at": "updatedAt",
+  });
+});
+/** @internal */
+export type ShippingLabel$Outbound = {
+  created_at?: string | undefined;
+  id?: string | undefined;
+  is_voided?: boolean | undefined;
+  label_cost?: number | undefined;
+  label_cost_currency?: string | undefined;
+  label_format?: string | undefined;
+  label_url?: string | undefined;
+  rate_id?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  service_code?: string | undefined;
+  shipment_id?: string | undefined;
+  status?: string | undefined;
+  tracking_number?: string | undefined;
+  updated_at?: string | undefined;
+};
+
+/** @internal */
+export const ShippingLabel$outboundSchema: z.ZodType<
+  ShippingLabel$Outbound,
+  z.ZodTypeDef,
+  ShippingLabel
+> = z.object({
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  isVoided: z.boolean().optional(),
+  labelCost: z.number().optional(),
+  labelCostCurrency: z.string().optional(),
+  labelFormat: LabelFormat$outboundSchema.optional(),
+  labelUrl: z.string().optional(),
+  rateId: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  serviceCode: z.string().optional(),
+  shipmentId: z.string().optional(),
+  status: ShippingLabelStatus$outboundSchema.optional(),
+  trackingNumber: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    isVoided: "is_voided",
+    labelCost: "label_cost",
+    labelCostCurrency: "label_cost_currency",
+    labelFormat: "label_format",
+    labelUrl: "label_url",
+    rateId: "rate_id",
+    serviceCode: "service_code",
+    shipmentId: "shipment_id",
+    trackingNumber: "tracking_number",
+    updatedAt: "updated_at",
+  });
+});
+
+export function shippingLabelToJSON(shippingLabel: ShippingLabel): string {
+  return JSON.stringify(ShippingLabel$outboundSchema.parse(shippingLabel));
+}
+export function shippingLabelFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingLabel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingLabel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingLabel' from JSON`,
+  );
+}

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

@@ -0,0 +1,148 @@
+/*
+ * 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";
+
+export const ShippingPackageSizeUnit = {
+  Cm: "cm",
+  Inch: "inch",
+} as const;
+export type ShippingPackageSizeUnit = OpenEnum<typeof ShippingPackageSizeUnit>;
+
+export const ShippingPackageWeightUnit = {
+  G: "g",
+  Kg: "kg",
+  Oz: "oz",
+  Lb: "lb",
+} as const;
+export type ShippingPackageWeightUnit = OpenEnum<
+  typeof ShippingPackageWeightUnit
+>;
+
+export type ShippingPackage = {
+  currency?: string | undefined;
+  description?: string | undefined;
+  height?: number | undefined;
+  insuredAmount?: number | undefined;
+  length?: number | undefined;
+  sizeUnit?: ShippingPackageSizeUnit | undefined;
+  trackingNumber?: string | undefined;
+  value?: number | undefined;
+  weight?: number | undefined;
+  weightUnit?: ShippingPackageWeightUnit | undefined;
+  width?: number | undefined;
+};
+
+/** @internal */
+export const ShippingPackageSizeUnit$inboundSchema: z.ZodType<
+  ShippingPackageSizeUnit,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingPackageSizeUnit);
+/** @internal */
+export const ShippingPackageSizeUnit$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingPackageSizeUnit
+> = openEnums.outboundSchema(ShippingPackageSizeUnit);
+
+/** @internal */
+export const ShippingPackageWeightUnit$inboundSchema: z.ZodType<
+  ShippingPackageWeightUnit,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingPackageWeightUnit);
+/** @internal */
+export const ShippingPackageWeightUnit$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingPackageWeightUnit
+> = openEnums.outboundSchema(ShippingPackageWeightUnit);
+
+/** @internal */
+export const ShippingPackage$inboundSchema: z.ZodType<
+  ShippingPackage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  height: z.number().optional(),
+  insured_amount: z.number().optional(),
+  length: z.number().optional(),
+  size_unit: ShippingPackageSizeUnit$inboundSchema.optional(),
+  tracking_number: z.string().optional(),
+  value: z.number().optional(),
+  weight: z.number().optional(),
+  weight_unit: ShippingPackageWeightUnit$inboundSchema.optional(),
+  width: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "insured_amount": "insuredAmount",
+    "size_unit": "sizeUnit",
+    "tracking_number": "trackingNumber",
+    "weight_unit": "weightUnit",
+  });
+});
+/** @internal */
+export type ShippingPackage$Outbound = {
+  currency?: string | undefined;
+  description?: string | undefined;
+  height?: number | undefined;
+  insured_amount?: number | undefined;
+  length?: number | undefined;
+  size_unit?: string | undefined;
+  tracking_number?: string | undefined;
+  value?: number | undefined;
+  weight?: number | undefined;
+  weight_unit?: string | undefined;
+  width?: number | undefined;
+};
+
+/** @internal */
+export const ShippingPackage$outboundSchema: z.ZodType<
+  ShippingPackage$Outbound,
+  z.ZodTypeDef,
+  ShippingPackage
+> = z.object({
+  currency: z.string().optional(),
+  description: z.string().optional(),
+  height: z.number().optional(),
+  insuredAmount: z.number().optional(),
+  length: z.number().optional(),
+  sizeUnit: ShippingPackageSizeUnit$outboundSchema.optional(),
+  trackingNumber: z.string().optional(),
+  value: z.number().optional(),
+  weight: z.number().optional(),
+  weightUnit: ShippingPackageWeightUnit$outboundSchema.optional(),
+  width: z.number().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    insuredAmount: "insured_amount",
+    sizeUnit: "size_unit",
+    trackingNumber: "tracking_number",
+    weightUnit: "weight_unit",
+  });
+});
+
+export function shippingPackageToJSON(
+  shippingPackage: ShippingPackage,
+): string {
+  return JSON.stringify(ShippingPackage$outboundSchema.parse(shippingPackage));
+}
+export function shippingPackageFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingPackage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingPackage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingPackage' from JSON`,
+  );
+}

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

@@ -0,0 +1,134 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  PropertyShippingRateFromAddress,
+  PropertyShippingRateFromAddress$inboundSchema,
+  PropertyShippingRateFromAddress$Outbound,
+  PropertyShippingRateFromAddress$outboundSchema,
+} from "./propertyshippingratefromaddress.js";
+import {
+  PropertyShippingRateToAddress,
+  PropertyShippingRateToAddress$inboundSchema,
+  PropertyShippingRateToAddress$Outbound,
+  PropertyShippingRateToAddress$outboundSchema,
+} from "./propertyshippingratetoaddress.js";
+import {
+  ShippingPackage,
+  ShippingPackage$inboundSchema,
+  ShippingPackage$Outbound,
+  ShippingPackage$outboundSchema,
+} from "./shippingpackage.js";
+import {
+  ShippingRateRate,
+  ShippingRateRate$inboundSchema,
+  ShippingRateRate$Outbound,
+  ShippingRateRate$outboundSchema,
+} from "./shippingraterate.js";
+
+export type ShippingRate = {
+  carrierId?: string | undefined;
+  currency?: string | undefined;
+  /**
+   * Origin address
+   */
+  fromAddress?: PropertyShippingRateFromAddress | undefined;
+  id?: string | undefined;
+  /**
+   * Multiple packages (alternative to package)
+   */
+  packages?: Array<ShippingPackage> | undefined;
+  rates?: Array<ShippingRateRate> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  shipByAt?: Date | undefined;
+  shipmentId?: string | undefined;
+  /**
+   * Destination address
+   */
+  toAddress?: PropertyShippingRateToAddress | undefined;
+};
+
+/** @internal */
+export const ShippingRate$inboundSchema: z.ZodType<
+  ShippingRate,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  carrier_id: z.string().optional(),
+  currency: z.string().optional(),
+  from_address: PropertyShippingRateFromAddress$inboundSchema.optional(),
+  id: z.string().optional(),
+  packages: z.array(ShippingPackage$inboundSchema).optional(),
+  rates: z.array(ShippingRateRate$inboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  ship_by_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  shipment_id: z.string().optional(),
+  to_address: PropertyShippingRateToAddress$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "carrier_id": "carrierId",
+    "from_address": "fromAddress",
+    "ship_by_at": "shipByAt",
+    "shipment_id": "shipmentId",
+    "to_address": "toAddress",
+  });
+});
+/** @internal */
+export type ShippingRate$Outbound = {
+  carrier_id?: string | undefined;
+  currency?: string | undefined;
+  from_address?: PropertyShippingRateFromAddress$Outbound | undefined;
+  id?: string | undefined;
+  packages?: Array<ShippingPackage$Outbound> | undefined;
+  rates?: Array<ShippingRateRate$Outbound> | undefined;
+  raw?: { [k: string]: any } | undefined;
+  ship_by_at?: string | undefined;
+  shipment_id?: string | undefined;
+  to_address?: PropertyShippingRateToAddress$Outbound | undefined;
+};
+
+/** @internal */
+export const ShippingRate$outboundSchema: z.ZodType<
+  ShippingRate$Outbound,
+  z.ZodTypeDef,
+  ShippingRate
+> = z.object({
+  carrierId: z.string().optional(),
+  currency: z.string().optional(),
+  fromAddress: PropertyShippingRateFromAddress$outboundSchema.optional(),
+  id: z.string().optional(),
+  packages: z.array(ShippingPackage$outboundSchema).optional(),
+  rates: z.array(ShippingRateRate$outboundSchema).optional(),
+  raw: z.record(z.any()).optional(),
+  shipByAt: z.date().transform(v => v.toISOString()).optional(),
+  shipmentId: z.string().optional(),
+  toAddress: PropertyShippingRateToAddress$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    carrierId: "carrier_id",
+    fromAddress: "from_address",
+    shipByAt: "ship_by_at",
+    shipmentId: "shipment_id",
+    toAddress: "to_address",
+  });
+});
+
+export function shippingRateToJSON(shippingRate: ShippingRate): string {
+  return JSON.stringify(ShippingRate$outboundSchema.parse(shippingRate));
+}
+export function shippingRateFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingRate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingRate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingRate' from JSON`,
+  );
+}