@whiplashmerch/whiplash-api-client 3.2.0 → 3.2.1

package/dist/generated/Orders.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
+import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdShippingDocumentsParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Retrieves a list of orders
@@ -396,6 +396,15 @@ export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: num
  * @request GET:/api/v2/orders/{id}/shipment_rates
  */
 export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesShippingRate[]>;
+/**
+ * @description List all shipping documents for a order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdShippingDocuments
+ * @summary List shipping documents for a order
+ * @request GET:/api/v2/orders/{id}/shipping_documents
+ */
+export declare const getApiV2OrdersIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV2EntitiesShippingDocument[]>;
 /**
  * @description List shipping rates for an order
  *
@@ -837,6 +846,15 @@ export declare const getApiV21OrdersIdSerialNumbers: (client: HttpClient, id: nu
  * @request GET:/api/v2.1/orders/{id}/shipment_rates
  */
 export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesShippingRate[]>;
+/**
+ * @description List all shipping documents for a order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdShippingDocuments
+ * @summary List shipping documents for a order
+ * @request GET:/api/v2.1/orders/{id}/shipping_documents
+ */
+export declare const getApiV21OrdersIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV21EntitiesShippingDocument[]>;
 /**
  * @description List shipping rates for an order
  *

package/dist/generated/Packages.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiV21EntitiesCount, ApiV21EntitiesPackage, ApiV21EntitiesResult, ApiV2EntitiesCount, ApiV2EntitiesPackage, ApiV2EntitiesResult, GetApiV21PackagesAggregateParams, GetApiV21PackagesIdCallTraitParams, GetApiV21PackagesIdTraitsParams, GetApiV21PackagesParams, GetApiV2PackagesAggregateParams, GetApiV2PackagesIdCallTraitParams, GetApiV2PackagesIdTraitsParams, GetApiV2PackagesParams, PutApiV21PackagesIdCallActionRequest, PutApiV21PackagesIdRequest, PutApiV2PackagesIdCallActionRequest, PutApiV2PackagesIdRequest } from "./data-contracts";
+import { ApiSharedEntitiesAudits, ApiV21EntitiesCount, ApiV21EntitiesPackage, ApiV21EntitiesResult, ApiV21EntitiesShippingDocument, ApiV2EntitiesCount, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesShippingDocument, GetApiV21PackagesAggregateParams, GetApiV21PackagesIdCallTraitParams, GetApiV21PackagesIdShippingDocumentsParams, GetApiV21PackagesIdTraitsParams, GetApiV21PackagesParams, GetApiV2PackagesAggregateParams, GetApiV2PackagesIdCallTraitParams, GetApiV2PackagesIdShippingDocumentsParams, GetApiV2PackagesIdTraitsParams, GetApiV2PackagesParams, PutApiV21PackagesIdCallActionRequest, PutApiV21PackagesIdRequest, PutApiV2PackagesIdCallActionRequest, PutApiV2PackagesIdRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description get packages
@@ -99,6 +99,15 @@ export declare const getApiV2PackagesIdCallTrait: (client: HttpClient, { trait,
  * @request GET:/api/v2/packages/{id}/shipment
  */
 export declare const getApiV2PackagesIdShipment: (client: HttpClient, id: number, params?: RequestParams) => Promise<any>;
+/**
+ * @description List all shipping documents for a package
+ *
+ * @tags packages
+ * @name GetApiV2PackagesIdShippingDocuments
+ * @summary List shipping documents for a package
+ * @request GET:/api/v2/packages/{id}/shipping_documents
+ */
+export declare const getApiV2PackagesIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV2PackagesIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV2EntitiesShippingDocument[]>;
 /**
  * @description Get the specified packages traits
  *
@@ -207,6 +216,15 @@ export declare const getApiV21PackagesIdCallTrait: (client: HttpClient, { trait,
  * @request GET:/api/v2.1/packages/{id}/shipment
  */
 export declare const getApiV21PackagesIdShipment: (client: HttpClient, id: number, params?: RequestParams) => Promise<any>;
+/**
+ * @description List all shipping documents for a package
+ *
+ * @tags packages
+ * @name GetApiV21PackagesIdShippingDocuments
+ * @summary List shipping documents for a package
+ * @request GET:/api/v2.1/packages/{id}/shipping_documents
+ */
+export declare const getApiV21PackagesIdShippingDocuments: (client: HttpClient, { id, ...query }: GetApiV21PackagesIdShippingDocumentsParams, params?: RequestParams) => Promise<ApiV21EntitiesShippingDocument[]>;
 /**
  * @description Get the specified packages traits
  *

package/dist/generated/data-contracts.d.ts

@@ -4826,6 +4826,50 @@ export interface ApiV2EntitiesShippingBlacklistedMethod {
     updated_at?: string;
 }
 /** V2 */
+export interface ApiV2EntitiesShippingDocument {
+    /**
+     * the document creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /** document format (e.g. PDF, PNG) */
+    document_format?: string;
+    /** whether the document was electronically submitted to customs */
+    electronically_submitted?: boolean;
+    /**
+     * the shipping document id
+     * @format int32
+     */
+    id?: number;
+    /** label provider name (e.g. easypost, shipium) */
+    label_provider?: string | null;
+    /**
+     * the associated order id
+     * @format int32
+     */
+    order_id?: number;
+    /**
+     * the owner id (Package or Order id)
+     * @format int32
+     */
+    owner_id?: number;
+    /** the owner type (Package or Order) */
+    owner_type?: string;
+    /** type of document from provider (e.g. commercial_invoice, label) */
+    provider_document_type?: string | null;
+    /** the raw carrier-provided document url (staff only) */
+    provider_url?: string | null;
+    /** the pre-signed or resolved document url */
+    resolved_url?: string;
+    /**
+     * the document last updated date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /** the internal document file url (S3 or CDN path) (staff only) */
+    url?: string;
+}
+/** V2 */
 export interface ApiV2EntitiesShippingMethod {
     /** is the shipping method active? */
     active?: boolean | null;
@@ -9709,6 +9753,50 @@ export interface ApiV21EntitiesShippingBlacklistedMethod {
     updated_at?: string;
 }
 /** V3 */
+export interface ApiV21EntitiesShippingDocument {
+    /**
+     * the document creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /** document format (e.g. PDF, PNG) */
+    document_format?: string;
+    /** whether the document was electronically submitted to customs */
+    electronically_submitted?: boolean;
+    /**
+     * the shipping document id
+     * @format int32
+     */
+    id?: number;
+    /** label provider name (e.g. easypost, shipium) */
+    label_provider?: string | null;
+    /**
+     * the associated order id
+     * @format int32
+     */
+    order_id?: number;
+    /**
+     * the owner id (Package or Order id)
+     * @format int32
+     */
+    owner_id?: number;
+    /** the owner type (Package or Order) */
+    owner_type?: string;
+    /** type of document from provider (e.g. commercial_invoice, label) */
+    provider_document_type?: string | null;
+    /** the raw carrier-provided document url (staff only) */
+    provider_url?: string | null;
+    /** the pre-signed or resolved document url */
+    resolved_url?: string;
+    /**
+     * the document last updated date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /** the internal document file url (S3 or CDN path) (staff only) */
+    url?: string;
+}
+/** V3 */
 export interface ApiV21EntitiesShippingMethod {
     /** is the shipping method active? */
     active?: boolean | null;
@@ -12279,6 +12367,29 @@ export interface GetApiV21OrdersIdPackagesParams {
     page_links?: boolean;
     id: number;
 }
+export interface GetApiV21OrdersIdShippingDocumentsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV21OrdersIdTraitsParams {
     /** List of traits to return */
     traits: string;
@@ -12344,6 +12455,29 @@ export interface GetApiV21PackagesIdCallTraitParams {
     trait: string;
     id: number;
 }
+export interface GetApiV21PackagesIdShippingDocumentsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV21PackagesIdTraitsParams {
     /** List of traits to return */
     traits: string;
@@ -15033,6 +15167,29 @@ export interface GetApiV2OrdersIdPackagesParams {
     page_links?: boolean;
     id: number;
 }
+export interface GetApiV2OrdersIdShippingDocumentsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV2OrdersIdTraitsParams {
     /** List of traits to return */
     traits: string;
@@ -15098,6 +15255,29 @@ export interface GetApiV2PackagesIdCallTraitParams {
     trait: string;
     id: number;
 }
+export interface GetApiV2PackagesIdShippingDocumentsParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+    /** Comma-separated list of fields to include in the response */
+    fields?: string;
+    /** A list of sort options (ex: name asc,created_at desc) */
+    sort?: string;
+    /**
+     * Page of results to fetch
+     * @format int32
+     */
+    page?: number;
+    /**
+     * Number of results to return per page
+     * @format int32
+     */
+    per_page?: number;
+    /** Include total count of results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV2PackagesIdTraitsParams {
     /** List of traits to return */
     traits: string;

package/generated/Orders.ts

@@ -21,6 +21,7 @@ import {
   ApiV21EntitiesPostResponse,
   ApiV21EntitiesResult,
   ApiV21EntitiesSerialNumber,
+  ApiV21EntitiesShippingDocument,
   ApiV21EntitiesWholesale,
   ApiV2EntitiesCount,
   ApiV2EntitiesCustomsInfo,
@@ -30,6 +31,7 @@ import {
   ApiV2EntitiesOrderItem,
   ApiV2EntitiesResult,
   ApiV2EntitiesSerialNumber,
+  ApiV2EntitiesShippingDocument,
   ApiV2EntitiesWholesale,
   GetApiV21OrdersCountParams,
   GetApiV21OrdersIdEventsCountParams,
@@ -39,6 +41,7 @@ import {
   GetApiV21OrdersIdOrderDocumentsParams,
   GetApiV21OrdersIdOrderItemsCountParams,
   GetApiV21OrdersIdOrderItemsParams,
+  GetApiV21OrdersIdShippingDocumentsParams,
   GetApiV21OrdersParams,
   GetApiV2OrdersCountParams,
   GetApiV2OrdersIdEventsCountParams,
@@ -48,6 +51,7 @@ import {
   GetApiV2OrdersIdOrderDocumentsParams,
   GetApiV2OrdersIdOrderItemsCountParams,
   GetApiV2OrdersIdOrderItemsParams,
+  GetApiV2OrdersIdShippingDocumentsParams,
   GetApiV2OrdersParams,
   PostApiV21OrdersBulkRequest,
   PostApiV21OrdersIdOrderDocumentsRequest,
@@ -469,6 +473,27 @@ export const getApiV2OrdersIdSerialNumbers = (client: HttpClient, id: number, pa
     ...params,
   });
 };
+/**
+ * @description List all shipping documents for a order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdShippingDocuments
+ * @summary List shipping documents for a order
+ * @request GET:/api/v2/orders/{id}/shipping_documents
+ */
+export const getApiV2OrdersIdShippingDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2OrdersIdShippingDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV2EntitiesShippingDocument[], ApiSharedEntitiesApiError>({
+    path: `/api/v2/orders/${id}/shipping_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
 /**
  * @description get the Wholesale object for an order
  *
@@ -886,6 +911,27 @@ export const getApiV21OrdersIdSerialNumbers = (client: HttpClient, id: number, p
     ...params,
   });
 };
+/**
+ * @description List all shipping documents for a order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdShippingDocuments
+ * @summary List shipping documents for a order
+ * @request GET:/api/v2.1/orders/{id}/shipping_documents
+ */
+export const getApiV21OrdersIdShippingDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21OrdersIdShippingDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV21EntitiesShippingDocument[], ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/shipping_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
 /**
  * @description get the Wholesale object for an order
  *

package/generated/Packages.ts

@@ -0,0 +1,62 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  ApiSharedEntitiesApiError,
+  ApiV21EntitiesShippingDocument,
+  ApiV2EntitiesShippingDocument,
+  GetApiV21PackagesIdShippingDocumentsParams,
+  GetApiV2PackagesIdShippingDocumentsParams,
+} from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+
+/**
+ * @description List all shipping documents for a package
+ *
+ * @tags packages
+ * @name GetApiV2PackagesIdShippingDocuments
+ * @summary List shipping documents for a package
+ * @request GET:/api/v2/packages/{id}/shipping_documents
+ */
+export const getApiV2PackagesIdShippingDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV2PackagesIdShippingDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV2EntitiesShippingDocument[], ApiSharedEntitiesApiError>({
+    path: `/api/v2/packages/${id}/shipping_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description List all shipping documents for a package
+ *
+ * @tags packages
+ * @name GetApiV21PackagesIdShippingDocuments
+ * @summary List shipping documents for a package
+ * @request GET:/api/v2.1/packages/{id}/shipping_documents
+ */
+export const getApiV21PackagesIdShippingDocuments = (
+  client: HttpClient,
+  { id, ...query }: GetApiV21PackagesIdShippingDocumentsParams,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV21EntitiesShippingDocument[], ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/packages/${id}/shipping_documents`,
+    method: "GET",
+    query: query,
+    format: "json",
+    ...params,
+  });
+};

package/generated/data-contracts.ts

@@ -2312,6 +2312,51 @@ export interface ApiV2EntitiesShipnoticeItem {
   warehouse_id?: number;
 }
 
+/** V2 */
+export interface ApiV2EntitiesShippingDocument {
+  /**
+   * the document creation date and time
+   * @format date-time
+   */
+  created_at?: string;
+  /** document format (e.g. PDF, PNG) */
+  document_format?: string;
+  /** whether the document was electronically submitted to customs */
+  electronically_submitted?: boolean;
+  /**
+   * the shipping document id
+   * @format int32
+   */
+  id?: number;
+  /** label provider name (e.g. easypost, shipium) */
+  label_provider?: string | null;
+  /**
+   * the associated order id
+   * @format int32
+   */
+  order_id?: number;
+  /**
+   * the owner id (Package or Order id)
+   * @format int32
+   */
+  owner_id?: number;
+  /** the owner type (Package or Order) */
+  owner_type?: string;
+  /** type of document from provider (e.g. commercial_invoice, label) */
+  provider_document_type?: string | null;
+  /** the raw carrier-provided document url (staff only) */
+  provider_url?: string | null;
+  /** the pre-signed or resolved document url */
+  resolved_url?: string;
+  /**
+   * the document last updated date and time
+   * @format date-time
+   */
+  updated_at?: string;
+  /** the internal document file url (S3 or CDN path) (staff only) */
+  url?: string;
+}
+
 /** V2 */
 export interface ApiV2EntitiesShippingMethod {
   /** is the shipping method active? */
@@ -4673,6 +4718,51 @@ export interface ApiV21EntitiesShipnoticeItem {
   updated_at?: string | null;
 }
 
+/** V3 */
+export interface ApiV21EntitiesShippingDocument {
+  /**
+   * the document creation date and time
+   * @format date-time
+   */
+  created_at?: string;
+  /** document format (e.g. PDF, PNG) */
+  document_format?: string;
+  /** whether the document was electronically submitted to customs */
+  electronically_submitted?: boolean;
+  /**
+   * the shipping document id
+   * @format int32
+   */
+  id?: number;
+  /** label provider name (e.g. easypost, shipium) */
+  label_provider?: string | null;
+  /**
+   * the associated order id
+   * @format int32
+   */
+  order_id?: number;
+  /**
+   * the owner id (Package or Order id)
+   * @format int32
+   */
+  owner_id?: number;
+  /** the owner type (Package or Order) */
+  owner_type?: string;
+  /** type of document from provider (e.g. commercial_invoice, label) */
+  provider_document_type?: string | null;
+  /** the raw carrier-provided document url (staff only) */
+  provider_url?: string | null;
+  /** the pre-signed or resolved document url */
+  resolved_url?: string;
+  /**
+   * the document last updated date and time
+   * @format date-time
+   */
+  updated_at?: string;
+  /** the internal document file url (S3 or CDN path) (staff only) */
+  url?: string;
+}
+
 /** V3 */
 export interface ApiV21EntitiesTemplate {
   /** Content of the template */
@@ -5381,6 +5471,30 @@ export interface GetApiV21OrdersIdOrderItemsParams {
   id: number;
 }
 
+export interface GetApiV21OrdersIdShippingDocumentsParams {
+  /** JSON search string like {"attribute_eq": "Term"} */
+  search?: string;
+  /** Comma-separated list of fields to include in the response */
+  fields?: string;
+  /** A list of sort options (ex: name asc,created_at desc) */
+  sort?: string;
+  /**
+   * Page of results to fetch
+   * @format int32
+   */
+  page?: number;
+  /**
+   * Number of results to return per page
+   * @format int32
+   */
+  per_page?: number;
+  /** Include total count of results */
+  page_total?: boolean;
+  /** Include prev/next links in response headers */
+  page_links?: boolean;
+  id: number;
+}
+
 export interface GetApiV21OrdersParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -5427,6 +5541,30 @@ export interface GetApiV21OriginatorsParams {
   page_links?: boolean;
 }
 
+export interface GetApiV21PackagesIdShippingDocumentsParams {
+  /** JSON search string like {"attribute_eq": "Term"} */
+  search?: string;
+  /** Comma-separated list of fields to include in the response */
+  fields?: string;
+  /** A list of sort options (ex: name asc,created_at desc) */
+  sort?: string;
+  /**
+   * Page of results to fetch
+   * @format int32
+   */
+  page?: number;
+  /**
+   * Number of results to return per page
+   * @format int32
+   */
+  per_page?: number;
+  /** Include total count of results */
+  page_total?: boolean;
+  /** Include prev/next links in response headers */
+  page_links?: boolean;
+  id: number;
+}
+
 export interface GetApiV21ProjectsIdProjectTasksParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -6025,6 +6163,30 @@ export interface GetApiV2OrdersIdOrderItemsParams {
   id: number;
 }
 
+export interface GetApiV2OrdersIdShippingDocumentsParams {
+  /** JSON search string like {"attribute_eq": "Term"} */
+  search?: string;
+  /** Comma-separated list of fields to include in the response */
+  fields?: string;
+  /** A list of sort options (ex: name asc,created_at desc) */
+  sort?: string;
+  /**
+   * Page of results to fetch
+   * @format int32
+   */
+  page?: number;
+  /**
+   * Number of results to return per page
+   * @format int32
+   */
+  per_page?: number;
+  /** Include total count of results */
+  page_total?: boolean;
+  /** Include prev/next links in response headers */
+  page_links?: boolean;
+  id: number;
+}
+
 export interface GetApiV2OrdersParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;
@@ -6071,6 +6233,30 @@ export interface GetApiV2OriginatorsParams {
   page_links?: boolean;
 }
 
+export interface GetApiV2PackagesIdShippingDocumentsParams {
+  /** JSON search string like {"attribute_eq": "Term"} */
+  search?: string;
+  /** Comma-separated list of fields to include in the response */
+  fields?: string;
+  /** A list of sort options (ex: name asc,created_at desc) */
+  sort?: string;
+  /**
+   * Page of results to fetch
+   * @format int32
+   */
+  page?: number;
+  /**
+   * Number of results to return per page
+   * @format int32
+   */
+  per_page?: number;
+  /** Include total count of results */
+  page_total?: boolean;
+  /** Include prev/next links in response headers */
+  page_links?: boolean;
+  id: number;
+}
+
 export interface GetApiV2ProjectsIdProjectTasksParams {
   /** JSON search string like {"attribute_eq": "Term"} */
   search?: string;

package/generated/index.ts

@@ -11,6 +11,7 @@ export * from './OrderItems';
 export * from './OrderTotes';
 export * from './Orders';
 export * from './Originators';
+export * from './Packages';
 export * from './Projects';
 export * from './ShipnoticeItems';
 export * from './Shipnotices';