@whiplashmerch/whiplash-api-client 3.2.3 → 3.2.4

package/dist/generated/PalletLocations.d.ts

@@ -0,0 +1,128 @@
+import { ApiV21EntitiesCount, ApiV21EntitiesPallet, ApiV21EntitiesPalletLocation, ApiV21EntitiesPostResponse, ApiV2EntitiesCount, ApiV2EntitiesPallet, ApiV2EntitiesPalletLocation, GetApiV21PalletLocationsCountParams, GetApiV21PalletLocationsIdPalletsParams, GetApiV21PalletLocationsParams, GetApiV2PalletLocationsCountParams, GetApiV2PalletLocationsIdPalletsParams, GetApiV2PalletLocationsParams, PostApiV21PalletLocationsRequest, PostApiV2PalletLocationsRequest, PutApiV21PalletLocationsIdRequest, PutApiV2PalletLocationsIdRequest } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Get all pallet locations
+ *
+ * @tags pallet_locations
+ * @name GetApiV2PalletLocations
+ * @summary List all pallet locations
+ * @request GET:/api/v2/pallet_locations
+ */
+export declare const getApiV2PalletLocations: (client: HttpClient, query: GetApiV2PalletLocationsParams, params?: RequestParams) => Promise<ApiV2EntitiesPalletLocation[]>;
+/**
+ * @description Create a pallet location
+ *
+ * @tags pallet_locations
+ * @name PostApiV2PalletLocations
+ * @summary Create a pallet location
+ * @request POST:/api/v2/pallet_locations
+ */
+export declare const postApiV2PalletLocations: (client: HttpClient, data: PostApiV2PalletLocationsRequest, params?: RequestParams) => Promise<ApiV2EntitiesPalletLocation>;
+/**
+ * @description Returns count of pallet locations
+ *
+ * @tags pallet_locations
+ * @name GetApiV2PalletLocationsCount
+ * @summary Count pallet locations
+ * @request GET:/api/v2/pallet_locations/count
+ */
+export declare const getApiV2PalletLocationsCount: (client: HttpClient, query: GetApiV2PalletLocationsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Get a pallet location
+ *
+ * @tags pallet_locations
+ * @name GetApiV2PalletLocationsId
+ * @summary Get a pallet location by ID
+ * @request GET:/api/v2/pallet_locations/{id}
+ */
+export declare const getApiV2PalletLocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesPalletLocation>;
+/**
+ * @description Update a pallet location
+ *
+ * @tags pallet_locations
+ * @name PutApiV2PalletLocationsId
+ * @summary Update a pallet location
+ * @request PUT:/api/v2/pallet_locations/{id}
+ */
+export declare const putApiV2PalletLocationsId: (client: HttpClient, id: number, data: PutApiV2PalletLocationsIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesPalletLocation>;
+/**
+ * @description Destroy a pallet location
+ *
+ * @tags pallet_locations
+ * @name DeleteApiV2PalletLocationsId
+ * @summary Destroy a pallet location
+ * @request DELETE:/api/v2/pallet_locations/{id}
+ */
+export declare const deleteApiV2PalletLocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all pallets for a Pallet location
+ *
+ * @tags pallet_locations
+ * @name GetApiV2PalletLocationsIdPallets
+ * @summary List all pallets for a pallet location
+ * @request GET:/api/v2/pallet_locations/{id}/pallets
+ */
+export declare const getApiV2PalletLocationsIdPallets: (client: HttpClient, { id, ...query }: GetApiV2PalletLocationsIdPalletsParams, params?: RequestParams) => Promise<ApiV2EntitiesPallet[]>;
+/**
+ * @description Get all pallet locations
+ *
+ * @tags pallet_locations
+ * @name GetApiV21PalletLocations
+ * @summary List all pallet locations
+ * @request GET:/api/v2.1/pallet_locations
+ */
+export declare const getApiV21PalletLocations: (client: HttpClient, query: GetApiV21PalletLocationsParams, params?: RequestParams) => Promise<ApiV21EntitiesPalletLocation[]>;
+/**
+ * @description Create a pallet location
+ *
+ * @tags pallet_locations
+ * @name PostApiV21PalletLocations
+ * @summary Create a pallet location
+ * @request POST:/api/v2.1/pallet_locations
+ */
+export declare const postApiV21PalletLocations: (client: HttpClient, data: PostApiV21PalletLocationsRequest, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
+/**
+ * @description Returns count of pallet locations
+ *
+ * @tags pallet_locations
+ * @name GetApiV21PalletLocationsCount
+ * @summary Count pallet locations
+ * @request GET:/api/v2.1/pallet_locations/count
+ */
+export declare const getApiV21PalletLocationsCount: (client: HttpClient, query: GetApiV21PalletLocationsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
+/**
+ * @description Get a pallet location
+ *
+ * @tags pallet_locations
+ * @name GetApiV21PalletLocationsId
+ * @summary Get a pallet location by ID
+ * @request GET:/api/v2.1/pallet_locations/{id}
+ */
+export declare const getApiV21PalletLocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesPalletLocation>;
+/**
+ * @description Update a pallet location
+ *
+ * @tags pallet_locations
+ * @name PutApiV21PalletLocationsId
+ * @summary Update a pallet location
+ * @request PUT:/api/v2.1/pallet_locations/{id}
+ */
+export declare const putApiV21PalletLocationsId: (client: HttpClient, id: number, data: PutApiV21PalletLocationsIdRequest, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a pallet location
+ *
+ * @tags pallet_locations
+ * @name DeleteApiV21PalletLocationsId
+ * @summary Destroy a pallet location
+ * @request DELETE:/api/v2.1/pallet_locations/{id}
+ */
+export declare const deleteApiV21PalletLocationsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Get all pallets for a Pallet location
+ *
+ * @tags pallet_locations
+ * @name GetApiV21PalletLocationsIdPallets
+ * @summary List all pallets for a pallet location
+ * @request GET:/api/v2.1/pallet_locations/{id}/pallets
+ */
+export declare const getApiV21PalletLocationsIdPallets: (client: HttpClient, { id, ...query }: GetApiV21PalletLocationsIdPalletsParams, params?: RequestParams) => Promise<ApiV21EntitiesPallet[]>;

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

@@ -3775,10 +3775,10 @@ export interface ApiV2EntitiesPallet {
      */
     number?: number | null;
     /**
-     * the order batch id associated with the pallet
+     * the pallet location id where the pallet is stored
      * @format int32
      */
-    order_batch_id?: number | null;
+    pallet_location_id?: number | null;
     /** the total dimensional weight of the pallet */
     total_dimensional_weight?: string | null;
     /**
@@ -3803,6 +3803,33 @@ export interface ApiV2EntitiesPallet {
     warehouse_id?: number | null;
 }
 /** V2 */
+export interface ApiV2EntitiesPalletLocation {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
+/** V2 */
 export interface ApiV2EntitiesPartner {
     /** Partner billing address line 1. */
     billing_address1?: string | null;
@@ -8816,10 +8843,10 @@ export interface ApiV21EntitiesPallet {
      */
     number?: number | null;
     /**
-     * the order batch id associated with the pallet
+     * the pallet location id where the pallet is stored
      * @format int32
      */
-    order_batch_id?: number | null;
+    pallet_location_id?: number | null;
     /** the total dimensional weight of the pallet */
     total_dimensional_weight?: string | null;
     /**
@@ -8844,6 +8871,33 @@ export interface ApiV21EntitiesPallet {
     warehouse_id?: number | null;
 }
 /** V3 */
+export interface ApiV21EntitiesPalletLocation {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
+/** V3 */
 export interface ApiV21EntitiesPartner {
     /** Partner billing address line 1. */
     billing_address1?: string | null;
@@ -12505,6 +12559,55 @@ export interface GetApiV21PackagesParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV21PalletLocationsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+}
+export interface GetApiV21PalletLocationsIdPalletsParams {
+    /** 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 GetApiV21PalletLocationsParams {
+    /** 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 GetApiV21PalletsCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -15305,6 +15408,55 @@ export interface GetApiV2PackagesParams {
     /** Include prev/next links in response headers */
     page_links?: boolean;
 }
+export interface GetApiV2PalletLocationsCountParams {
+    /** JSON search string like {"attribute_eq": "Term"} */
+    search?: string;
+}
+export interface GetApiV2PalletLocationsIdPalletsParams {
+    /** 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 GetApiV2PalletLocationsParams {
+    /** 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 GetApiV2PalletsCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -18685,6 +18837,32 @@ export interface PostApiV21OrdersRequest {
         };
     };
 }
+export interface PostApiV21PalletLocationsRequest {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
 export interface PostApiV21PartnersRequest {
     /** Partner billing address line 1. */
     billing_address1?: string;
@@ -22131,6 +22309,32 @@ export interface PostApiV2OrdersRequest {
         };
     };
 }
+export interface PostApiV2PalletLocationsRequest {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
 export interface PostApiV2PartnersRequest {
     /** Partner billing address line 1. */
     billing_address1?: string;
@@ -25049,6 +25253,32 @@ export interface PutApiV21PackagesIdRequest {
     /** the package tracking number */
     tracking?: string;
 }
+export interface PutApiV21PalletLocationsIdRequest {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
 export interface PutApiV21PalletsIdCallActionRequest {
     action?: string;
     /** Method params */
@@ -25060,6 +25290,11 @@ export interface PutApiV21PalletsIdRequest {
      * @format date-time
      */
     lpn_label_printed_at?: string;
+    /**
+     * the pallet location id where the pallet is stored
+     * @format int32
+     */
+    pallet_location_id?: number;
 }
 export interface PutApiV21PartnersIdRequest {
     /** Partner billing address line 1. */
@@ -27876,6 +28111,32 @@ export interface PutApiV2PackagesIdRequest {
     /** the package tracking number */
     tracking?: string;
 }
+export interface PutApiV2PalletLocationsIdRequest {
+    /** the pallet location active status */
+    active?: boolean;
+    /**
+     * the pallet location creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the package id
+     * @format int32
+     */
+    id?: number;
+    /** the pallet location lane */
+    lane?: string;
+    /**
+     * the pallet location last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet location warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
 export interface PutApiV2PalletsIdCallActionRequest {
     action?: string;
     /** Method params */
@@ -27887,6 +28148,11 @@ export interface PutApiV2PalletsIdRequest {
      * @format date-time
      */
     lpn_label_printed_at?: string;
+    /**
+     * the pallet location id where the pallet is stored
+     * @format int32
+     */
+    pallet_location_id?: number;
 }
 export interface PutApiV2PartnersIdRequest {
     /** Partner billing address line 1. */

package/dist/generated/index.d.ts

@@ -46,6 +46,7 @@ export * from './OrderTotes';
 export * from './Orders';
 export * from './Originators';
 export * from './Packages';
+export * from './PalletLocations';
 export * from './Pallets';
 export * from './Partners';
 export * from './Prepacks';

package/dist/mock-data/index.d.ts

@@ -86,6 +86,7 @@ export * from './v2_1/order/processing';
 export * from './v2_1/shipnotice/processing';
 export * from './v2_1/originator/created';
 export * from './v2_1/package/created';
+export * from './v2_1/pallet-location/created';
 export * from './v2_1/pallet/created';
 export * from './v2_1/partner/created';
 export * from './v2_1/prepack/created';

package/dist/mock-data/v2_1/pallet-location/created.d.ts

@@ -0,0 +1 @@
+export declare const ApiV21PalletLocationCreatedExample = "{\"id\":123}";

package/package.json

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