@unified-api/typescript-sdk 2.82.14 → 2.82.16

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`,
+  );
+}

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

@@ -0,0 +1,154 @@
+/*
+ * 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 {
+  PropertyShippingTrackingEventLocationAddress,
+  PropertyShippingTrackingEventLocationAddress$inboundSchema,
+  PropertyShippingTrackingEventLocationAddress$Outbound,
+  PropertyShippingTrackingEventLocationAddress$outboundSchema,
+} from "./propertyshippingtrackingeventlocationaddress.js";
+
+export const ShippingTrackingEventStatus = {
+  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 ShippingTrackingEventStatus = OpenEnum<
+  typeof ShippingTrackingEventStatus
+>;
+
+export type ShippingTrackingEvent = {
+  carrierStatusCode?: string | undefined;
+  createdAt?: Date | undefined;
+  description?: string | undefined;
+  eventCode?: string | undefined;
+  locationAddress?: PropertyShippingTrackingEventLocationAddress | undefined;
+  locationId?: string | undefined;
+  locationName?: string | undefined;
+  notes?: string | undefined;
+  signedBy?: string | undefined;
+  status?: ShippingTrackingEventStatus | undefined;
+};
+
+/** @internal */
+export const ShippingTrackingEventStatus$inboundSchema: z.ZodType<
+  ShippingTrackingEventStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ShippingTrackingEventStatus);
+/** @internal */
+export const ShippingTrackingEventStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ShippingTrackingEventStatus
+> = openEnums.outboundSchema(ShippingTrackingEventStatus);
+
+/** @internal */
+export const ShippingTrackingEvent$inboundSchema: z.ZodType<
+  ShippingTrackingEvent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  carrier_status_code: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  description: z.string().optional(),
+  event_code: z.string().optional(),
+  location_address: PropertyShippingTrackingEventLocationAddress$inboundSchema
+    .optional(),
+  location_id: z.string().optional(),
+  location_name: z.string().optional(),
+  notes: z.string().optional(),
+  signed_by: z.string().optional(),
+  status: ShippingTrackingEventStatus$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "carrier_status_code": "carrierStatusCode",
+    "created_at": "createdAt",
+    "event_code": "eventCode",
+    "location_address": "locationAddress",
+    "location_id": "locationId",
+    "location_name": "locationName",
+    "signed_by": "signedBy",
+  });
+});
+/** @internal */
+export type ShippingTrackingEvent$Outbound = {
+  carrier_status_code?: string | undefined;
+  created_at?: string | undefined;
+  description?: string | undefined;
+  event_code?: string | undefined;
+  location_address?:
+    | PropertyShippingTrackingEventLocationAddress$Outbound
+    | undefined;
+  location_id?: string | undefined;
+  location_name?: string | undefined;
+  notes?: string | undefined;
+  signed_by?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const ShippingTrackingEvent$outboundSchema: z.ZodType<
+  ShippingTrackingEvent$Outbound,
+  z.ZodTypeDef,
+  ShippingTrackingEvent
+> = z.object({
+  carrierStatusCode: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  description: z.string().optional(),
+  eventCode: z.string().optional(),
+  locationAddress: PropertyShippingTrackingEventLocationAddress$outboundSchema
+    .optional(),
+  locationId: z.string().optional(),
+  locationName: z.string().optional(),
+  notes: z.string().optional(),
+  signedBy: z.string().optional(),
+  status: ShippingTrackingEventStatus$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    carrierStatusCode: "carrier_status_code",
+    createdAt: "created_at",
+    eventCode: "event_code",
+    locationAddress: "location_address",
+    locationId: "location_id",
+    locationName: "location_name",
+    signedBy: "signed_by",
+  });
+});
+
+export function shippingTrackingEventToJSON(
+  shippingTrackingEvent: ShippingTrackingEvent,
+): string {
+  return JSON.stringify(
+    ShippingTrackingEvent$outboundSchema.parse(shippingTrackingEvent),
+  );
+}
+export function shippingTrackingEventFromJSON(
+  jsonString: string,
+): SafeParseResult<ShippingTrackingEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShippingTrackingEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShippingTrackingEvent' from JSON`,
+  );
+}

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

@@ -53,12 +53,12 @@ export const ObjectType = {
   PaymentRefund: "payment_refund",
   PaymentSubscription: "payment_subscription",
   CommerceItem: "commerce_item",
-  CommerceItemvariant: "commerce_itemvariant",
   CommerceCollection: "commerce_collection",
   CommerceInventory: "commerce_inventory",
   CommerceLocation: "commerce_location",
   CommerceReview: "commerce_review",
   CommerceSaleschannel: "commerce_saleschannel",
+  CommerceItemvariant: "commerce_itemvariant",
   VerificationPackage: "verification_package",
   VerificationRequest: "verification_request",
   AtsActivity: "ats_activity",
@@ -137,6 +137,11 @@ export const ObjectType = {
   AdsGroup: "ads_group",
   FormsForm: "forms_form",
   FormsSubmission: "forms_submission",
+  ShippingCarrier: "shipping_carrier",
+  ShippingRate: "shipping_rate",
+  ShippingShipment: "shipping_shipment",
+  ShippingLabel: "shipping_label",
+  ShippingTracking: "shipping_tracking",
 } as const;
 export type ObjectType = OpenEnum<typeof ObjectType>;
 

package/src/sdk/rate.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { shippingCreateShippingRate } from "../funcs/shippingCreateShippingRate.js";
+import { shippingGetShippingRate } from "../funcs/shippingGetShippingRate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Rate extends ClientSDK {
+  /**
+   * Create a rate
+   */
+  async createShippingRate(
+    request: operations.CreateShippingRateRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingRate> {
+    return unwrapAsync(shippingCreateShippingRate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a rate
+   */
+  async getShippingRate(
+    request: operations.GetShippingRateRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingRate> {
+    return unwrapAsync(shippingGetShippingRate(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -22,6 +22,7 @@ import { Calendar } from "./calendar.js";
 import { Call } from "./call.js";
 import { Campaign } from "./campaign.js";
 import { Candidate } from "./candidate.js";
+import { Carrier } from "./carrier.js";
 import { Cashflow } from "./cashflow.js";
 import { Category } from "./category.js";
 import { Change } from "./change.js";
@@ -65,6 +66,7 @@ import { Itemvariant } from "./itemvariant.js";
 import { Job } from "./job.js";
 import { Journal } from "./journal.js";
 import { Kms } from "./kms.js";
+import { Label } from "./label.js";
 import { Lead } from "./lead.js";
 import { Link } from "./link.js";
 import { List } from "./list.js";
@@ -93,6 +95,7 @@ import { Project } from "./project.js";
 import { Prompt } from "./prompt.js";
 import { Pullrequest } from "./pullrequest.js";
 import { Purchaseorder } from "./purchaseorder.js";
+import { Rate } from "./rate.js";
 import { Recording } from "./recording.js";
 import { Refund } from "./refund.js";
 import { Repo } from "./repo.js";
@@ -104,6 +107,8 @@ import { Saleschannel } from "./saleschannel.js";
 import { Salesorder } from "./salesorder.js";
 import { Scim } from "./scim.js";
 import { Scorecard } from "./scorecard.js";
+import { Shipment } from "./shipment.js";
+import { Shipping } from "./shipping.js";
 import { Space } from "./space.js";
 import { Storage } from "./storage.js";
 import { Student } from "./student.js";
@@ -115,6 +120,7 @@ import { Ticket } from "./ticket.js";
 import { Ticketing } from "./ticketing.js";
 import { Timeoff } from "./timeoff.js";
 import { Timeshift } from "./timeshift.js";
+import { Tracking } from "./tracking.js";
 import { Transaction } from "./transaction.js";
 import { Trialbalance } from "./trialbalance.js";
 import { Uc } from "./uc.js";
@@ -604,6 +610,36 @@ export class UnifiedTo extends ClientSDK {
     return (this._user ??= new User(this._options));
   }
 
+  private _shipping?: Shipping;
+  get shipping(): Shipping {
+    return (this._shipping ??= new Shipping(this._options));
+  }
+
+  private _carrier?: Carrier;
+  get carrier(): Carrier {
+    return (this._carrier ??= new Carrier(this._options));
+  }
+
+  private _label?: Label;
+  get label(): Label {
+    return (this._label ??= new Label(this._options));
+  }
+
+  private _rate?: Rate;
+  get rate(): Rate {
+    return (this._rate ??= new Rate(this._options));
+  }
+
+  private _shipment?: Shipment;
+  get shipment(): Shipment {
+    return (this._shipment ??= new Shipment(this._options));
+  }
+
+  private _tracking?: Tracking;
+  get tracking(): Tracking {
+    return (this._tracking ??= new Tracking(this._options));
+  }
+
   private _storage?: Storage;
   get storage(): Storage {
     return (this._storage ??= new Storage(this._options));

package/src/sdk/shipment.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { shippingCreateShippingShipment } from "../funcs/shippingCreateShippingShipment.js";
+import { shippingGetShippingShipment } from "../funcs/shippingGetShippingShipment.js";
+import { shippingListShippingShipments } from "../funcs/shippingListShippingShipments.js";
+import { shippingPatchShippingShipment } from "../funcs/shippingPatchShippingShipment.js";
+import { shippingRemoveShippingShipment } from "../funcs/shippingRemoveShippingShipment.js";
+import { shippingUpdateShippingShipment } from "../funcs/shippingUpdateShippingShipment.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import * as shared from "./models/shared/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Shipment extends ClientSDK {
+  /**
+   * Create a shipment
+   */
+  async createShippingShipment(
+    request: operations.CreateShippingShipmentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingShipment> {
+    return unwrapAsync(shippingCreateShippingShipment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve a shipment
+   */
+  async getShippingShipment(
+    request: operations.GetShippingShipmentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingShipment> {
+    return unwrapAsync(shippingGetShippingShipment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List all shipments
+   */
+  async listShippingShipments(
+    request: operations.ListShippingShipmentsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<shared.ShippingShipment>> {
+    return unwrapAsync(shippingListShippingShipments(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a shipment
+   */
+  async patchShippingShipment(
+    request: operations.PatchShippingShipmentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingShipment> {
+    return unwrapAsync(shippingPatchShippingShipment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a shipment
+   */
+  async removeShippingShipment(
+    request: operations.RemoveShippingShipmentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.RemoveShippingShipmentResponse | undefined> {
+    return unwrapAsync(shippingRemoveShippingShipment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a shipment
+   */
+  async updateShippingShipment(
+    request: operations.UpdateShippingShipmentRequest,
+    options?: RequestOptions,
+  ): Promise<shared.ShippingShipment> {
+    return unwrapAsync(shippingUpdateShippingShipment(
+      this,
+      request,
+      options,
+    ));
+  }
+}