@whiplashmerch/whiplash-api-client 3.2.63 → 3.2.65

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

@@ -849,7 +849,7 @@ export interface ApiV21EntitiesCustomer {
     replenishment_target?: string | null;
     /** request serial numbers? */
     request_serial_numbers?: boolean | null;
-    /** Block customer cancellation of batched orders (admins only) */
+    /** Block customer cancellation of batched orders */
     restrict_batched_orders_cancellation?: boolean | null;
     /** Customer return city. */
     return_city?: string | null;
@@ -3707,6 +3707,8 @@ export interface ApiV21EntitiesPackingslipsArray {
 }
 /** V3 */
 export interface ApiV21EntitiesPallet {
+    /** the pallet active status */
+    active?: boolean;
     /**
      * the pallet creation date and time
      * @format date-time
@@ -3786,8 +3788,8 @@ export interface ApiV21EntitiesPalletInfo {
 }
 /** V3 */
 export interface ApiV21EntitiesPalletLocation {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time
@@ -6608,7 +6610,7 @@ export interface ApiV2EntitiesCustomer {
     replenishment_target?: string | null;
     /** request serial numbers? */
     request_serial_numbers?: boolean | null;
-    /** Block customer cancellation of batched orders (admins only) */
+    /** Block customer cancellation of batched orders */
     restrict_batched_orders_cancellation?: boolean | null;
     /** Customer return city. */
     return_city?: string | null;
@@ -6830,7 +6832,7 @@ export interface ApiV2EntitiesCustomerShallow {
     replenishment_target?: string;
     /** request serial numbers? */
     request_serial_numbers?: boolean;
-    /** Block customer cancellation of batched orders (admins only) */
+    /** Block customer cancellation of batched orders */
     restrict_batched_orders_cancellation?: boolean;
     /** Customer return city. */
     return_city?: string;
@@ -10044,6 +10046,8 @@ export interface ApiV2EntitiesPackingslipsArray {
 }
 /** V2 */
 export interface ApiV2EntitiesPallet {
+    /** the pallet active status */
+    active?: boolean;
     /**
      * the pallet creation date and time
      * @format date-time
@@ -10123,8 +10127,8 @@ export interface ApiV2EntitiesPalletInfo {
 }
 /** V2 */
 export interface ApiV2EntitiesPalletLocation {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time
@@ -20008,13 +20012,13 @@ export interface PostApiV21CustomersRequest {
     /** Customer return address line 2. */
     return_address_2?: string;
     /**
-     * Account level
+     * Account level (admins only)
      * @format int32
      */
     account_level?: number;
-    /** Customer active? */
+    /** Customer active? (admins only) */
     active?: boolean;
-    /** Allow "b stock" role for receiving */
+    /** Allow "b stock" role for receiving (admins only) */
     allow_b_stock_receiving?: boolean;
     /** Allow International returns? */
     allow_international_returns?: boolean;
@@ -20035,7 +20039,7 @@ export interface PostApiV21CustomersRequest {
     billing_company?: string;
     /** Customer billing contact name. */
     billing_contact_name: string;
-    /** if false, disables hardcoded billing logic (staff only) */
+    /** if false, disables hardcoded billing logic (admins only) */
     billing_core?: boolean;
     /** Customer billing country. */
     billing_country?: string;
@@ -20047,14 +20051,14 @@ export interface PostApiV21CustomersRequest {
     billing_state?: string;
     /** Customer billing zip. */
     billing_zip?: string;
-    /** Enable Domo dashboard for this customer */
+    /** Enable Domo dashboard for this customer (admins only) */
     dashboard_enable_domo?: string;
-    /** Enable Parcel Insights for this customer */
+    /** Enable Parcel Insights for this customer (admins only) */
     dashboard_enable_parcel_insights?: string;
     /** Data mapping string for this customer. (admins only) */
     data_mapping_string?: string;
     /**
-     * Customer default warehouse id.
+     * Customer default warehouse id. (admins only)
      * @format int32
      */
     default_warehouse_id?: number;
@@ -20096,9 +20100,9 @@ export interface PostApiV21CustomersRequest {
     global_e_guid?: string;
     /** Customer incoterm. */
     incoterm?: string;
-    /** Customer instructions. */
+    /** Customer instructions. (admins only) */
     instructions?: string;
-    /** Customer has item scanning preference? */
+    /** Customer has item scanning preference? (admins only) */
     item_scanning_preference?: boolean;
     /** items exchangeable by default? */
     items_exchangeable?: boolean;
@@ -20109,13 +20113,13 @@ export interface PostApiV21CustomersRequest {
      * @format int32
      */
     items_unavailable_on_sellout?: number;
-    /** Customer label format. */
+    /** Customer label format. (admins only) */
     label_format?: string;
-    /** Default role (i.e. Pickable, Damaged) for returned items */
+    /** Default role (i.e. Pickable, Damaged) for returned items (admins only) */
     location_default_return_role?: string;
-    /** Allow "pending" role for returned items */
+    /** Allow "pending" role for returned items (admins only) */
     location_enable_pending_returns?: boolean;
-    /** Allow "reserved" role for receiving items */
+    /** Allow "reserved" role for receiving items (admins only) */
     location_enable_receiving_into_reserved?: boolean;
     /** Customer logo content type. */
     logo_content_type?: string;
@@ -20154,7 +20158,7 @@ export interface PostApiV21CustomersRequest {
      * @format int32
      */
     notify_originator_inventory?: number;
-    /** originator permissions? */
+    /** originator permissions? (admins only) */
     originator_permissions?: boolean;
     /** Customer packing slip message. */
     packing_slip_msg?: string;
@@ -20167,13 +20171,13 @@ export interface PostApiV21CustomersRequest {
     partner_id?: number;
     /** The Customers designated primary contact. */
     primary_contact?: string;
-    /** JSON array of allowed labels for customer's project tasks */
+    /** JSON array of allowed labels for customer's project tasks (admins only) */
     project_task_labels?: string[];
-    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
+    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} (admins only) */
     receiving_fields?: object[];
-    /** Minimum number of days worth of stock to keep in forward pick locations */
+    /** Minimum number of days worth of stock to keep in forward pick locations (admins only) */
     replenishment_min?: string;
-    /** Target number of days stock to replenish forward pick locations */
+    /** Target number of days stock to replenish forward pick locations (admins only) */
     replenishment_target?: string;
     /** request serial numbers? */
     request_serial_numbers?: boolean;
@@ -22420,8 +22424,8 @@ export declare enum PostApiV21OrdersRequestStatus {
     Value35 = 35
 }
 export interface PostApiV21PalletLocationsRequest {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time
@@ -24436,13 +24440,13 @@ export interface PostApiV2CustomersRequest {
     /** Customer return address line 2. */
     return_address_2?: string;
     /**
-     * Account level
+     * Account level (admins only)
      * @format int32
      */
     account_level?: number;
-    /** Customer active? */
+    /** Customer active? (admins only) */
     active?: boolean;
-    /** Allow "b stock" role for receiving */
+    /** Allow "b stock" role for receiving (admins only) */
     allow_b_stock_receiving?: boolean;
     /** Allow International returns? */
     allow_international_returns?: boolean;
@@ -24463,7 +24467,7 @@ export interface PostApiV2CustomersRequest {
     billing_company?: string;
     /** Customer billing contact name. */
     billing_contact_name: string;
-    /** if false, disables hardcoded billing logic (staff only) */
+    /** if false, disables hardcoded billing logic (admins only) */
     billing_core?: boolean;
     /** Customer billing country. */
     billing_country?: string;
@@ -24475,14 +24479,14 @@ export interface PostApiV2CustomersRequest {
     billing_state?: string;
     /** Customer billing zip. */
     billing_zip?: string;
-    /** Enable Domo dashboard for this customer */
+    /** Enable Domo dashboard for this customer (admins only) */
     dashboard_enable_domo?: string;
-    /** Enable Parcel Insights for this customer */
+    /** Enable Parcel Insights for this customer (admins only) */
     dashboard_enable_parcel_insights?: string;
     /** Data mapping string for this customer. (admins only) */
     data_mapping_string?: string;
     /**
-     * Customer default warehouse id.
+     * Customer default warehouse id. (admins only)
      * @format int32
      */
     default_warehouse_id?: number;
@@ -24524,9 +24528,9 @@ export interface PostApiV2CustomersRequest {
     global_e_guid?: string;
     /** Customer incoterm. */
     incoterm?: string;
-    /** Customer instructions. */
+    /** Customer instructions. (admins only) */
     instructions?: string;
-    /** Customer has item scanning preference? */
+    /** Customer has item scanning preference? (admins only) */
     item_scanning_preference?: boolean;
     /** items exchangeable by default? */
     items_exchangeable?: boolean;
@@ -24537,13 +24541,13 @@ export interface PostApiV2CustomersRequest {
      * @format int32
      */
     items_unavailable_on_sellout?: number;
-    /** Customer label format. */
+    /** Customer label format. (admins only) */
     label_format?: string;
-    /** Default role (i.e. Pickable, Damaged) for returned items */
+    /** Default role (i.e. Pickable, Damaged) for returned items (admins only) */
     location_default_return_role?: string;
-    /** Allow "pending" role for returned items */
+    /** Allow "pending" role for returned items (admins only) */
     location_enable_pending_returns?: boolean;
-    /** Allow "reserved" role for receiving items */
+    /** Allow "reserved" role for receiving items (admins only) */
     location_enable_receiving_into_reserved?: boolean;
     /** Customer logo content type. */
     logo_content_type?: string;
@@ -24582,7 +24586,7 @@ export interface PostApiV2CustomersRequest {
      * @format int32
      */
     notify_originator_inventory?: number;
-    /** originator permissions? */
+    /** originator permissions? (admins only) */
     originator_permissions?: boolean;
     /** Customer packing slip message. */
     packing_slip_msg?: string;
@@ -24595,13 +24599,13 @@ export interface PostApiV2CustomersRequest {
     partner_id?: number;
     /** The Customers designated primary contact. */
     primary_contact?: string;
-    /** JSON array of allowed labels for customer's project tasks */
+    /** JSON array of allowed labels for customer's project tasks (admins only) */
     project_task_labels?: string[];
-    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
+    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} (admins only) */
     receiving_fields?: object[];
-    /** Minimum number of days worth of stock to keep in forward pick locations */
+    /** Minimum number of days worth of stock to keep in forward pick locations (admins only) */
     replenishment_min?: string;
-    /** Target number of days stock to replenish forward pick locations */
+    /** Target number of days stock to replenish forward pick locations (admins only) */
     replenishment_target?: string;
     /** request serial numbers? */
     request_serial_numbers?: boolean;
@@ -26848,8 +26852,8 @@ export declare enum PostApiV2OrdersRequestStatus {
     Value35 = 35
 }
 export interface PostApiV2PalletLocationsRequest {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time
@@ -28562,13 +28566,13 @@ export interface PutApiV21CustomersIdRequest {
     /** Customer return address line 2. */
     return_address_2?: string;
     /**
-     * Account level
+     * Account level (admins only)
      * @format int32
      */
     account_level?: number;
-    /** Customer active? */
+    /** Customer active? (admins only) */
     active?: boolean;
-    /** Allow "b stock" role for receiving */
+    /** Allow "b stock" role for receiving (admins only) */
     allow_b_stock_receiving?: boolean;
     /** Allow International returns? */
     allow_international_returns?: boolean;
@@ -28589,7 +28593,7 @@ export interface PutApiV21CustomersIdRequest {
     billing_company?: string;
     /** Customer billing contact name. */
     billing_contact_name?: string;
-    /** if false, disables hardcoded billing logic (staff only) */
+    /** if false, disables hardcoded billing logic (admins only) */
     billing_core?: boolean;
     /** Customer billing country. */
     billing_country?: string;
@@ -28601,14 +28605,14 @@ export interface PutApiV21CustomersIdRequest {
     billing_state?: string;
     /** Customer billing zip. */
     billing_zip?: string;
-    /** Enable Domo dashboard for this customer */
+    /** Enable Domo dashboard for this customer (admins only) */
     dashboard_enable_domo?: string;
-    /** Enable Parcel Insights for this customer */
+    /** Enable Parcel Insights for this customer (admins only) */
     dashboard_enable_parcel_insights?: string;
     /** Data mapping string for this customer. (admins only) */
     data_mapping_string?: string;
     /**
-     * Customer default warehouse id.
+     * Customer default warehouse id. (admins only)
      * @format int32
      */
     default_warehouse_id?: number;
@@ -28650,9 +28654,9 @@ export interface PutApiV21CustomersIdRequest {
     global_e_guid?: string;
     /** Customer incoterm. */
     incoterm?: string;
-    /** Customer instructions. */
+    /** Customer instructions. (admins only) */
     instructions?: string;
-    /** Customer has item scanning preference? */
+    /** Customer has item scanning preference? (admins only) */
     item_scanning_preference?: boolean;
     /** items exchangeable by default? */
     items_exchangeable?: boolean;
@@ -28663,13 +28667,13 @@ export interface PutApiV21CustomersIdRequest {
      * @format int32
      */
     items_unavailable_on_sellout?: number;
-    /** Customer label format. */
+    /** Customer label format. (admins only) */
     label_format?: string;
-    /** Default role (i.e. Pickable, Damaged) for returned items */
+    /** Default role (i.e. Pickable, Damaged) for returned items (admins only) */
     location_default_return_role?: string;
-    /** Allow "pending" role for returned items */
+    /** Allow "pending" role for returned items (admins only) */
     location_enable_pending_returns?: boolean;
-    /** Allow "reserved" role for receiving items */
+    /** Allow "reserved" role for receiving items (admins only) */
     location_enable_receiving_into_reserved?: boolean;
     /** Customer logo content type. */
     logo_content_type?: string;
@@ -28692,7 +28696,7 @@ export interface PutApiV21CustomersIdRequest {
      * @format int32
      */
     low_inventory_threshold?: number;
-    /** Customer name. */
+    /** Customer name. (admins only) */
     name?: string;
     /** Customer notes. */
     notes?: string;
@@ -28703,7 +28707,7 @@ export interface PutApiV21CustomersIdRequest {
      * @format int32
      */
     notify_originator_inventory?: number;
-    /** originator permissions? */
+    /** originator permissions? (admins only) */
     originator_permissions?: boolean;
     /** Customer packing slip message. */
     packing_slip_msg?: string;
@@ -28714,17 +28718,17 @@ export interface PutApiV21CustomersIdRequest {
      * @format int32
      */
     partner_id?: number;
-    /** is this account on hold pending a valid payment method? */
+    /** is this account on hold pending a valid payment method? (admins only) */
     payment_hold?: boolean;
     /** The Customers designated primary contact. */
     primary_contact?: string;
-    /** JSON array of allowed labels for customer's project tasks */
+    /** JSON array of allowed labels for customer's project tasks (admins only) */
     project_task_labels?: string[];
-    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
+    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} (admins only) */
     receiving_fields?: object[];
-    /** Minimum number of days worth of stock to keep in forward pick locations */
+    /** Minimum number of days worth of stock to keep in forward pick locations (admins only) */
     replenishment_min?: string;
-    /** Target number of days stock to replenish forward pick locations */
+    /** Target number of days stock to replenish forward pick locations (admins only) */
     replenishment_target?: string;
     /** request serial numbers? */
     request_serial_numbers?: boolean;
@@ -31209,8 +31213,8 @@ export interface PutApiV21PalletLocationsIdParams {
     id: number;
 }
 export interface PutApiV21PalletLocationsIdRequest {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time
@@ -32901,13 +32905,13 @@ export interface PutApiV2CustomersIdRequest {
     /** Customer return address line 2. */
     return_address_2?: string;
     /**
-     * Account level
+     * Account level (admins only)
      * @format int32
      */
     account_level?: number;
-    /** Customer active? */
+    /** Customer active? (admins only) */
     active?: boolean;
-    /** Allow "b stock" role for receiving */
+    /** Allow "b stock" role for receiving (admins only) */
     allow_b_stock_receiving?: boolean;
     /** Allow International returns? */
     allow_international_returns?: boolean;
@@ -32928,7 +32932,7 @@ export interface PutApiV2CustomersIdRequest {
     billing_company?: string;
     /** Customer billing contact name. */
     billing_contact_name?: string;
-    /** if false, disables hardcoded billing logic (staff only) */
+    /** if false, disables hardcoded billing logic (admins only) */
     billing_core?: boolean;
     /** Customer billing country. */
     billing_country?: string;
@@ -32940,14 +32944,14 @@ export interface PutApiV2CustomersIdRequest {
     billing_state?: string;
     /** Customer billing zip. */
     billing_zip?: string;
-    /** Enable Domo dashboard for this customer */
+    /** Enable Domo dashboard for this customer (admins only) */
     dashboard_enable_domo?: string;
-    /** Enable Parcel Insights for this customer */
+    /** Enable Parcel Insights for this customer (admins only) */
     dashboard_enable_parcel_insights?: string;
     /** Data mapping string for this customer. (admins only) */
     data_mapping_string?: string;
     /**
-     * Customer default warehouse id.
+     * Customer default warehouse id. (admins only)
      * @format int32
      */
     default_warehouse_id?: number;
@@ -32989,9 +32993,9 @@ export interface PutApiV2CustomersIdRequest {
     global_e_guid?: string;
     /** Customer incoterm. */
     incoterm?: string;
-    /** Customer instructions. */
+    /** Customer instructions. (admins only) */
     instructions?: string;
-    /** Customer has item scanning preference? */
+    /** Customer has item scanning preference? (admins only) */
     item_scanning_preference?: boolean;
     /** items exchangeable by default? */
     items_exchangeable?: boolean;
@@ -33002,13 +33006,13 @@ export interface PutApiV2CustomersIdRequest {
      * @format int32
      */
     items_unavailable_on_sellout?: number;
-    /** Customer label format. */
+    /** Customer label format. (admins only) */
     label_format?: string;
-    /** Default role (i.e. Pickable, Damaged) for returned items */
+    /** Default role (i.e. Pickable, Damaged) for returned items (admins only) */
     location_default_return_role?: string;
-    /** Allow "pending" role for returned items */
+    /** Allow "pending" role for returned items (admins only) */
     location_enable_pending_returns?: boolean;
-    /** Allow "reserved" role for receiving items */
+    /** Allow "reserved" role for receiving items (admins only) */
     location_enable_receiving_into_reserved?: boolean;
     /** Customer logo content type. */
     logo_content_type?: string;
@@ -33031,7 +33035,7 @@ export interface PutApiV2CustomersIdRequest {
      * @format int32
      */
     low_inventory_threshold?: number;
-    /** Customer name. */
+    /** Customer name. (admins only) */
     name?: string;
     /** Customer notes. */
     notes?: string;
@@ -33042,7 +33046,7 @@ export interface PutApiV2CustomersIdRequest {
      * @format int32
      */
     notify_originator_inventory?: number;
-    /** originator permissions? */
+    /** originator permissions? (admins only) */
     originator_permissions?: boolean;
     /** Customer packing slip message. */
     packing_slip_msg?: string;
@@ -33053,17 +33057,17 @@ export interface PutApiV2CustomersIdRequest {
      * @format int32
      */
     partner_id?: number;
-    /** is this account on hold pending a valid payment method? */
+    /** is this account on hold pending a valid payment method? (admins only) */
     payment_hold?: boolean;
     /** The Customers designated primary contact. */
     primary_contact?: string;
-    /** JSON array of allowed labels for customer's project tasks */
+    /** JSON array of allowed labels for customer's project tasks (admins only) */
     project_task_labels?: string[];
-    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} */
+    /** JSON array of required and optional receiving fields in the form: {"label": "cases", "required": true} (admins only) */
     receiving_fields?: object[];
-    /** Minimum number of days worth of stock to keep in forward pick locations */
+    /** Minimum number of days worth of stock to keep in forward pick locations (admins only) */
     replenishment_min?: string;
-    /** Target number of days stock to replenish forward pick locations */
+    /** Target number of days stock to replenish forward pick locations (admins only) */
     replenishment_target?: string;
     /** request serial numbers? */
     request_serial_numbers?: boolean;
@@ -35548,8 +35552,8 @@ export interface PutApiV2PalletLocationsIdParams {
     id: number;
 }
 export interface PutApiV2PalletLocationsIdRequest {
-    /** the pallet location active status */
-    active?: boolean;
+    /** does the pallet location have pallets assigned? */
+    assigned_pallets?: boolean;
     /**
      * the pallet location creation date and time
      * @format date-time