@whiplashmerch/whiplash-api-client 3.2.0 → 3.2.2

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';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whiplashmerch/whiplash-api-client",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "",
   "devDependencies": {},
   "scripts": {