@whiplashmerch/whiplash-api-client 2.0.12 → 2.0.14

package/dist/generated/Pallets.d.ts

@@ -0,0 +1,146 @@
+import { ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesPackage, ApiV2EntitiesPallet, GetApiV21PalletsCountParams, GetApiV21PalletsIdPackagesParams, GetApiV21PalletsParams, GetApiV2PalletsCountParams, GetApiV2PalletsIdPackagesParams, GetApiV2PalletsParams, PutApiV21PalletsIdCallActionRequest, PutApiV21PalletsIdRequest, PutApiV2PalletsIdCallActionRequest, PutApiV2PalletsIdRequest } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get all pallets
+ *
+ * @tags pallets
+ * @name GetApiV2Pallets
+ * @summary List all pallets
+ * @request GET:/api/v2/pallets
+ */
+export declare const getApiV2Pallets: (client: HttpClient, query: GetApiV2PalletsParams, params?: RequestParams) => Promise<ApiV2EntitiesPallet[]>;
+/**
+ * @description Create a pallet
+ *
+ * @tags pallets
+ * @name PostApiV2Pallets
+ * @summary Create a pallet
+ * @request POST:/api/v2/pallets
+ */
+export declare const postApiV2Pallets: (client: HttpClient, params?: RequestParams) => Promise<ApiV2EntitiesPallet>;
+/**
+ * @description Returns count of pallets
+ *
+ * @tags pallets
+ * @name GetApiV2PalletsCount
+ * @summary Count pallets
+ * @request GET:/api/v2/pallets/count
+ */
+export declare const getApiV2PalletsCount: (client: HttpClient, query: GetApiV2PalletsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Get a pallet
+ *
+ * @tags pallets
+ * @name GetApiV2PalletsId
+ * @summary Get a pallet by ID
+ * @request GET:/api/v2/pallets/{id}
+ */
+export declare const getApiV2PalletsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesPallet>;
+/**
+ * @description Update a pallet
+ *
+ * @tags pallets
+ * @name PutApiV2PalletsId
+ * @summary Update a pallet
+ * @request PUT:/api/v2/pallets/{id}
+ */
+export declare const putApiV2PalletsId: (client: HttpClient, id: number, data: PutApiV2PalletsIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesPallet>;
+/**
+ * @description Destroy a pallet
+ *
+ * @tags pallets
+ * @name DeleteApiV2PalletsId
+ * @summary Destroy a pallet
+ * @request DELETE:/api/v2/pallets/{id}
+ */
+export declare const deleteApiV2PalletsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Perform an action on a pallet
+ *
+ * @tags pallets
+ * @name PutApiV2PalletsIdCallAction
+ * @summary Perform an action on a pallet
+ * @request PUT:/api/v2/pallets/{id}/call/{action}
+ */
+export declare const putApiV2PalletsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV2PalletsIdCallActionRequest, params?: RequestParams) => Promise<ApiV2EntitiesPallet>;
+/**
+ * @description Get all packages for a Pallet
+ *
+ * @tags pallets
+ * @name GetApiV2PalletsIdPackages
+ * @summary List all packages for a pallet
+ * @request GET:/api/v2/pallets/{id}/packages
+ */
+export declare const getApiV2PalletsIdPackages: (client: HttpClient, { id, ...query }: GetApiV2PalletsIdPackagesParams, params?: RequestParams) => Promise<ApiV2EntitiesPackage[]>;
+/**
+ * @description Get all pallets
+ *
+ * @tags pallets
+ * @name GetApiV21Pallets
+ * @summary List all pallets
+ * @request GET:/api/v2.1/pallets
+ */
+export declare const getApiV21Pallets: (client: HttpClient, query: GetApiV21PalletsParams, params?: RequestParams) => Promise<ApiV2EntitiesPallet[]>;
+/**
+ * @description Create a pallet
+ *
+ * @tags pallets
+ * @name PostApiV21Pallets
+ * @summary Create a pallet
+ * @request POST:/api/v2.1/pallets
+ */
+export declare const postApiV21Pallets: (client: HttpClient, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
+/**
+ * @description Returns count of pallets
+ *
+ * @tags pallets
+ * @name GetApiV21PalletsCount
+ * @summary Count pallets
+ * @request GET:/api/v2.1/pallets/count
+ */
+export declare const getApiV21PalletsCount: (client: HttpClient, query: GetApiV21PalletsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Get a pallet
+ *
+ * @tags pallets
+ * @name GetApiV21PalletsId
+ * @summary Get a pallet by ID
+ * @request GET:/api/v2.1/pallets/{id}
+ */
+export declare const getApiV21PalletsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesPallet>;
+/**
+ * @description Update a pallet
+ *
+ * @tags pallets
+ * @name PutApiV21PalletsId
+ * @summary Update a pallet
+ * @request PUT:/api/v2.1/pallets/{id}
+ */
+export declare const putApiV21PalletsId: (client: HttpClient, id: number, data: PutApiV21PalletsIdRequest, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a pallet
+ *
+ * @tags pallets
+ * @name DeleteApiV21PalletsId
+ * @summary Destroy a pallet
+ * @request DELETE:/api/v2.1/pallets/{id}
+ */
+export declare const deleteApiV21PalletsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Perform an action on a pallet
+ *
+ * @tags pallets
+ * @name PutApiV21PalletsIdCallAction
+ * @summary Perform an action on a pallet
+ * @request PUT:/api/v2.1/pallets/{id}/call/{action}
+ */
+export declare const putApiV21PalletsIdCallAction: (client: HttpClient, action: string, id: number, data: PutApiV21PalletsIdCallActionRequest, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all packages for a Pallet
+ *
+ * @tags pallets
+ * @name GetApiV21PalletsIdPackages
+ * @summary List all packages for a pallet
+ * @request GET:/api/v2.1/pallets/{id}/packages
+ */
+export declare const getApiV21PalletsIdPackages: (client: HttpClient, { id, ...query }: GetApiV21PalletsIdPackagesParams, params?: RequestParams) => Promise<ApiV2EntitiesPackage[]>;

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

@@ -3790,8 +3790,18 @@ export interface ApiV2EntitiesPackage {
      */
     order_id?: number | null;
     order_item_ids?: number[];
+    /**
+     * the pallet id this package is on (staff only)
+     * @format int32
+     */
+    pallet_id?: number | null;
     /** the package scan form url (staff only) */
     scan_form_url?: string | null;
+    /**
+     * when the package was scanned to a pallet (staff only)
+     * @format date-time
+     */
+    scanned_to_pallet_at?: string | null;
     /**
      * the package shipping cost
      * @format float
@@ -3838,6 +3848,59 @@ export interface ApiV2EntitiesPackingslipsArray {
     packingslips_array?: object;
 }
 /** V2 */
+export interface ApiV2EntitiesPallet {
+    /**
+     * the pallet creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /**
+     * the date and time when the LPN label was printed
+     * @format date-time
+     */
+    lpn_label_printed_at?: string | null;
+    /**
+     * the pallet number (LPN)
+     * @format int32
+     */
+    number?: number | null;
+    /**
+     * the order batch id associated with the pallet
+     * @format int32
+     */
+    order_batch_id?: number | null;
+    /**
+     * the total dimensional weight of the pallet
+     * @format float
+     */
+    total_dimensional_weight?: number | null;
+    /**
+     * the total number of items in the pallet
+     * @format int32
+     */
+    total_item_count?: number | null;
+    /**
+     * the total number of packages in the pallet
+     * @format int32
+     */
+    total_package_count?: number | null;
+    /**
+     * the pallet last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet warehouse id
+     * @format int32
+     */
+    warehouse_id?: number | null;
+}
+/** V2 */
 export interface ApiV2EntitiesPartner {
     /** Partner billing address line 1. */
     billing_address1?: string | null;
@@ -4607,10 +4670,7 @@ export interface ApiV2EntitiesShipnotice {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string | null;
     /** shipping carrier */
     carrier?: string;
@@ -4665,10 +4725,7 @@ export interface ApiV2EntitiesShipnotice {
     inspection_required?: boolean;
     /** meta data for this shipnotice as stringified JSON */
     meta_data?: string | null;
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string | null;
     /** notes by customer */
     notes_by_customer?: string | null;
@@ -4760,10 +4817,7 @@ export interface ApiV2EntitiesShipnotice {
      * @format int32
      */
     warehouse_id?: number;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string | null;
 }
 /** V2 */
@@ -4847,10 +4901,10 @@ export interface ApiV2EntitiesShipnoticeItem {
      */
     unallocated?: number;
     /**
-     * unit price for this shipnotice item
+     * unit cost for this shipnotice item
      * @format float
      */
-    unit_price?: number | null;
+    unit_cost?: number | null;
     /**
      * the shipnotice item last update date and time
      * @format date-time
@@ -8244,10 +8298,7 @@ export interface ApiV21EntitiesShipnotice {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string | null;
     /**
      * the shipnotice must be completed by date and time
@@ -8301,10 +8352,7 @@ export interface ApiV21EntitiesShipnotice {
     inspection_required?: boolean;
     /** meta data for this shipnotice as stringified JSON */
     meta_data?: string | null;
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string | null;
     /** notes by customer */
     notes_by_customer?: string | null;
@@ -8394,10 +8442,7 @@ export interface ApiV21EntitiesShipnotice {
     warehouse_id?: number;
     /** The name of the associated warehouse */
     warehouse_name?: string;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string | null;
 }
 /** V2_1 */
@@ -8464,10 +8509,10 @@ export interface ApiV21EntitiesShipnoticeItem {
      */
     shipnotice_id?: number | null;
     /**
-     * unit price for this shipnotice item
+     * unit cost for this shipnotice item
      * @format float
      */
-    unit_price?: number | null;
+    unit_cost?: number | null;
     /**
      * the shipnotice item last update date and time
      * @format date-time
@@ -10773,6 +10818,55 @@ export interface GetApiV21PackagesParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV21PalletsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+}
+export interface GetApiV21PalletsIdPackagesParams {
+    /** 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 GetApiV21PalletsParams {
+    /** 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;
+}
 export interface GetApiV21PartnersCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -13415,6 +13509,55 @@ export interface GetApiV2PackagesParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV2PalletsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+}
+export interface GetApiV2PalletsIdPackagesParams {
+    /** 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 GetApiV2PalletsParams {
+    /** 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;
+}
 export interface GetApiV2PartnersCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -17224,20 +17367,11 @@ export interface PostApiV21ShipnoticesBulkRequest {
         reference?: string;
         /** JSON object of required and optional receiving quantities verified by staff */
         quantities_verified?: object;
-        /**
-         * BOL proxy for this shipnotice.
-         *           Note: this field has a limit of 30 chars.
-         */
+        /** BOL proxy for this shipnotice. */
         bol_proxy?: string;
-        /**
-         * MID code for this shipnotice.
-         *           Note: this field has a limit of 15 chars.
-         */
+        /** MID code for this shipnotice. */
         mid_code?: string;
-        /**
-         * zone status of this shipnotice.
-         *           Note: this field has a limit of 3 chars.
-         */
+        /** zone status of this shipnotice. */
         zone_status?: string;
         /** is inspection required? (default: false) */
         inspection_required?: boolean;
@@ -17392,6 +17526,11 @@ export interface PostApiV21ShipnoticesIdShipnoticeItemsRequest {
     quantity?: number;
     /** action to perform on item return  */
     return_action?: string;
+    /**
+     * Unit cost per item
+     * @format float
+     */
+    unit_cost?: number;
 }
 export interface PostApiV21ShipnoticesRequest {
     /**
@@ -17404,10 +17543,7 @@ export interface PostApiV21ShipnoticesRequest {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string;
     carrier?: string;
     /**
@@ -17447,10 +17583,7 @@ export interface PostApiV21ShipnoticesRequest {
         /** Included meta fields for associations */
         association_fields?: object;
     };
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string;
     /** notes by customer */
     notes_by_customer?: string;
@@ -17556,10 +17689,7 @@ export interface PostApiV21ShipnoticesRequest {
      * @format int32
      */
     warehouse_id?: number;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string;
 }
 export interface PostApiV21ShippingAliasesRequest {
@@ -20858,20 +20988,11 @@ export interface PostApiV2ShipnoticesBulkRequest {
         reference?: string;
         /** JSON object of required and optional receiving quantities verified by staff */
         quantities_verified?: object;
-        /**
-         * BOL proxy for this shipnotice.
-         *           Note: this field has a limit of 30 chars.
-         */
+        /** BOL proxy for this shipnotice. */
         bol_proxy?: string;
-        /**
-         * MID code for this shipnotice.
-         *           Note: this field has a limit of 15 chars.
-         */
+        /** MID code for this shipnotice. */
         mid_code?: string;
-        /**
-         * zone status of this shipnotice.
-         *           Note: this field has a limit of 3 chars.
-         */
+        /** zone status of this shipnotice. */
         zone_status?: string;
         /** is inspection required? (default: false) */
         inspection_required?: boolean;
@@ -21026,6 +21147,11 @@ export interface PostApiV2ShipnoticesIdShipnoticeItemsRequest {
     quantity?: number;
     /** action to perform on item return  */
     return_action?: string;
+    /**
+     * Unit cost per item
+     * @format float
+     */
+    unit_cost?: number;
 }
 export interface PostApiV2ShipnoticesRequest {
     /**
@@ -21038,10 +21164,7 @@ export interface PostApiV2ShipnoticesRequest {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string;
     carrier?: string;
     /**
@@ -21081,10 +21204,7 @@ export interface PostApiV2ShipnoticesRequest {
         /** Included meta fields for associations */
         association_fields?: object;
     };
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string;
     /** notes by customer */
     notes_by_customer?: string;
@@ -21190,10 +21310,7 @@ export interface PostApiV2ShipnoticesRequest {
      * @format int32
      */
     warehouse_id?: number;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string;
 }
 export interface PostApiV2ShippingAliasesRequest {
@@ -23556,6 +23673,18 @@ export interface PutApiV21PackagesIdRequest {
     /** the package tracking number */
     tracking?: string;
 }
+export interface PutApiV21PalletsIdCallActionRequest {
+    action?: string;
+    /** Method params */
+    args?: object;
+}
+export interface PutApiV21PalletsIdRequest {
+    /**
+     * the date and time when the LPN label was printed
+     * @format date-time
+     */
+    lpn_label_printed_at?: string;
+}
 export interface PutApiV21PartnersIdRequest {
     /** Partner billing address line 1. */
     billing_address1?: string;
@@ -23942,6 +24071,11 @@ export interface PutApiV21ShipnoticeItemsIdRequest {
      * @format int32
      */
     quantity?: number;
+    /**
+     * Unit cost per item
+     * @format float
+     */
+    unit_cost?: number;
 }
 export interface PutApiV21ShipnoticesIdCallActionRequest {
     action?: string;
@@ -23970,10 +24104,7 @@ export interface PutApiV21ShipnoticesIdRequest {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string;
     carrier?: string;
     /**
@@ -24004,10 +24135,7 @@ export interface PutApiV21ShipnoticesIdRequest {
     handling_billed?: boolean;
     /** meta data for this shipnotice as stringified JSON */
     meta_data?: string;
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string;
     /** notes by customer */
     notes_by_customer?: string;
@@ -24063,10 +24191,7 @@ export interface PutApiV21ShipnoticesIdRequest {
     tracking?: string;
     /** shipnotice type (Shipnotice, ConsumerReturn) */
     type?: string;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string;
 }
 export interface PutApiV21ShippingAliasesIdRequest {
@@ -26533,6 +26658,18 @@ export interface PutApiV2PackagesIdRequest {
     /** the package tracking number */
     tracking?: string;
 }
+export interface PutApiV2PalletsIdCallActionRequest {
+    action?: string;
+    /** Method params */
+    args?: object;
+}
+export interface PutApiV2PalletsIdRequest {
+    /**
+     * the date and time when the LPN label was printed
+     * @format date-time
+     */
+    lpn_label_printed_at?: string;
+}
 export interface PutApiV2PartnersIdRequest {
     /** Partner billing address line 1. */
     billing_address1?: string;
@@ -26919,6 +27056,11 @@ export interface PutApiV2ShipnoticeItemsIdRequest {
      * @format int32
      */
     quantity?: number;
+    /**
+     * Unit cost per item
+     * @format float
+     */
+    unit_cost?: number;
 }
 export interface PutApiV2ShipnoticesIdCallActionRequest {
     action?: string;
@@ -26947,10 +27089,7 @@ export interface PutApiV2ShipnoticesIdRequest {
      * @format date-time
      */
     arrived_at?: string;
-    /**
-     * BOL proxy for this shipnotice.
-     *           Note: this field has a limit of 30 chars.
-     */
+    /** BOL proxy for this shipnotice. */
     bol_proxy?: string;
     carrier?: string;
     /**
@@ -26981,10 +27120,7 @@ export interface PutApiV2ShipnoticesIdRequest {
     handling_billed?: boolean;
     /** meta data for this shipnotice as stringified JSON */
     meta_data?: string;
-    /**
-     * MID code for this shipnotice.
-     *           Note: this field has a limit of 15 chars.
-     */
+    /** MID code for this shipnotice. */
     mid_code?: string;
     /** notes by customer */
     notes_by_customer?: string;
@@ -27040,10 +27176,7 @@ export interface PutApiV2ShipnoticesIdRequest {
     tracking?: string;
     /** shipnotice type (Shipnotice, ConsumerReturn) */
     type?: string;
-    /**
-     * zone status of this shipnotice.
-     *           Note: this field has a limit of 3 chars.
-     */
+    /** zone status of this shipnotice. */
     zone_status?: string;
 }
 export interface PutApiV2ShippingAliasesIdRequest {