@whiplashmerch/whiplash-api-client 2.0.6 → 2.0.8

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

@@ -538,7 +538,7 @@ export interface ApiV2EntitiesConsumerReturn {
      * @format date-time
      */
     created_at?: string;
-    customer?: ApiV21EntitiesCustomer;
+    customer?: ApiV2EntitiesCustomerShallow;
     /**
      * the consumer return customer id
      * @format int32
@@ -627,7 +627,7 @@ export interface ApiV2EntitiesConsumerReturn {
      * @format date-time
      */
     updated_at?: string;
-    warehouse?: ApiV21EntitiesWarehouse;
+    warehouse?: ApiV2EntitiesWarehouseShallow;
     /**
      * the consumer return warehouse id
      * @format int32
@@ -926,6 +926,222 @@ export interface ApiV2EntitiesCustomer {
     warehouse_fallback?: number;
     whitelisted_warehouses?: ApiV2EntitiesWarehouse;
 }
+export interface ApiV2EntitiesCustomerShallow {
+    /** Customer billing address line 1. */
+    billing_address1?: string;
+    /** Customer billing address line 2. */
+    billing_address2?: string;
+    /** Customer billing address line 3. */
+    billing_address3?: string;
+    /** Customer phone 1. */
+    billing_phone1?: string;
+    /** Customer phone 2. */
+    billing_phone2?: string;
+    /** GS1 company prefix for barcodes */
+    gs1_company_prefix?: string;
+    /** Customer return address line 1. */
+    return_address_1?: string;
+    /** Customer return address line 2. */
+    return_address_2?: string;
+    /**
+     * Account level
+     * @format int32
+     */
+    account_level?: number;
+    /** Quote, Direct, Enterprise, or Managed */
+    account_level_name?: string;
+    /**
+     * the customer activation date and time
+     * @format date-time
+     */
+    activated_at?: string;
+    /** Customer active? */
+    active?: boolean;
+    /** Allow "b stock" role for receiving */
+    allow_b_stock_receiving?: boolean;
+    allowed_warehouse_ids?: number[];
+    /**
+     * Customer auto merge gestation.
+     * @format int32
+     */
+    auto_merge_gestation?: number;
+    /** auto merge SKUs? */
+    auto_merge_skus?: boolean;
+    /** Customer billing city. */
+    billing_city?: string;
+    /** Customer billing company. */
+    billing_company?: string;
+    /** Customer billing contact name. */
+    billing_contact_name?: string;
+    /** if false, disables hardcoded billing logic (staff only) */
+    billing_core?: boolean;
+    /** Customer billing country. */
+    billing_country?: string;
+    /** Customer billing email. */
+    billing_email?: string;
+    /** Customer billing residential? */
+    billing_residential?: boolean;
+    /** Customer billing state. */
+    billing_state?: string;
+    /** Customer billing zip. */
+    billing_zip?: string;
+    /**
+     * the customer creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /** Data mapping string for this customer. (admins only) */
+    data_mapping_string?: string;
+    /**
+     * the customer deactivation date and time
+     * @format date-time
+     */
+    deactivated_at?: string;
+    /**
+     * Customer default warehouse id.
+     * @format int32
+     */
+    default_warehouse_id?: number;
+    /** Customer EIN / Tax ID */
+    ein?: string;
+    /** Customer email confirmation from. */
+    email_confirmation_from?: string;
+    /** Customer email confirmation name. */
+    email_confirmation_name?: string;
+    /** Customer EORI number. */
+    eori_number?: string;
+    /** Customer estimated monthly volume. */
+    estimated_monthly_volume?: string;
+    /** is this account flagged for exit notice? (admins only) */
+    exit_notice?: boolean;
+    /**
+     * items that are this many days from expiration will not be allowed to ship
+     * @format int32
+     */
+    expiration_period?: number;
+    /** Customer from email. */
+    from_email?: string;
+    /** Customer full logo url. */
+    full_logo_url?: string;
+    /**
+     * the customer id
+     * @format int32
+     */
+    id?: number;
+    /** Customer instructions. */
+    instructions?: string;
+    /** Customer has item scanning preference? */
+    item_scanning_preference?: boolean;
+    /** items exchangeable by default? */
+    items_exchangeable?: boolean;
+    /** items returnable by default? */
+    items_returnable?: boolean;
+    /**
+     * Process Orders setting: Whiplash will automatically turn on Process Orders when an item is received, and turn it off when an item sells. Whiplash will not manage Process Orders. Whiplash will automatically turn on Process Orders only the first time an Item is received. Whiplash will automatically turn on Process Orders when an item is received or adjusted in, and turn it off when an Item sells out.
+     * @format int32
+     */
+    items_unavailable_on_sellout?: number;
+    /** do items for this customer require lot control? */
+    lot_control?: boolean;
+    /**
+     * Quantity where an item in inventory would be considered having low inventory
+     * @format int32
+     */
+    low_inventory_threshold?: number;
+    /** Customer name. */
+    name?: string;
+    /** Customer notes. */
+    notes?: string;
+    /** notify originator? */
+    notify_originator?: boolean;
+    /**
+     * Customer notify originator inventory.
+     * @format int32
+     */
+    notify_originator_inventory?: number;
+    /** originator permissions? */
+    originator_permissions?: boolean;
+    /**
+     * Customer partner id. (admins only)
+     * @format int32
+     */
+    partner_id?: number;
+    /** is this account on hold pending a valid payment method? */
+    payment_hold?: boolean;
+    /** The Customers designated primary contact. */
+    primary_contact?: string;
+    project_task_labels?: string[];
+    receiving_fields?: object[];
+    /**
+     * Minimum number of days worth of stock to keep in forward pick locations
+     * @format float
+     */
+    replenishment_min?: number;
+    /**
+     * Target number of days stock to replenish forward pick locations
+     * @format float
+     */
+    replenishment_target?: number;
+    /** request serial numbers? */
+    request_serial_numbers?: boolean;
+    /** Customer return city. */
+    return_city?: string;
+    /** Customer return company. */
+    return_company?: string;
+    /** Customer return country. */
+    return_country?: string;
+    /** Customer return email. */
+    return_email?: string;
+    /**
+     * Return label expiration time limit.
+     * @format int32
+     */
+    return_label_expires_in?: number;
+    /** Customer return name. */
+    return_name?: string;
+    /** Customer return phone. */
+    return_phone?: string;
+    /** limit exchange to same value or less? */
+    return_price_restricted?: boolean;
+    /** Exchange SKU match policy. */
+    return_sku_match?: string;
+    /** Customer return state. */
+    return_state?: string;
+    /**
+     * Return time limit.
+     * @format int32
+     */
+    return_time_limit?: number;
+    /** Customer return zip. */
+    return_zip?: string;
+    /** display customer logo on returns page? */
+    rma_display_logo?: boolean;
+    /** Return page footer content. */
+    rma_footer_content?: string;
+    /**
+     * Customer shipping method preference.
+     * @format int32
+     */
+    ship_method_preference?: number;
+    /**
+     * which locations to pick first: Default, FIFO, FEFO
+     * @format int32
+     */
+    ship_strategy?: number;
+    /** Customer shipping name. */
+    shipping_name?: string;
+    /** does the customer support return labels? */
+    supports_return_labels?: boolean;
+    /** Customer VAT number. */
+    vat_number?: string;
+    /**
+     * Customer warehouse fallback.
+     * @format int32
+     */
+    warehouse_fallback?: number;
+    /** Workday UUID */
+    workday_uuid?: string;
+}
 export interface ApiV2EntitiesCustomsInfo {
     /** AU VAT number */
     au_vat_number?: string;
@@ -3510,8 +3726,18 @@ export interface ApiV2EntitiesPackage {
      */
     order_id?: number;
     order_item_ids?: number[];
+    /**
+     * the pallet id this package is on (staff only)
+     * @format int32
+     */
+    pallet_id?: number;
     /** the package scan form url (staff only) */
     scan_form_url?: string;
+    /**
+     * when the package was scanned to a pallet (staff only)
+     * @format date-time
+     */
+    scanned_to_pallet_at?: string;
     /**
      * the package shipping cost
      * @format float
@@ -3556,6 +3782,58 @@ export interface ApiV2EntitiesPackage {
 export interface ApiV2EntitiesPackingslipsArray {
     packingslips_array?: object;
 }
+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;
+    /**
+     * the pallet number (LPN)
+     * @format int32
+     */
+    number?: number;
+    /**
+     * the order batch id associated with the pallet
+     * @format int32
+     */
+    order_batch_id?: number;
+    /**
+     * the total dimensional weight of the pallet
+     * @format float
+     */
+    total_dimensional_weight?: number;
+    /**
+     * the total number of items in the pallet
+     * @format int32
+     */
+    total_item_count?: number;
+    /**
+     * the total number of packages in the pallet
+     * @format int32
+     */
+    total_package_count?: number;
+    /**
+     * the pallet last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /**
+     * the pallet warehouse id
+     * @format int32
+     */
+    warehouse_id?: number;
+}
 export interface ApiV2EntitiesPartner {
     /** Partner billing address line 1. */
     billing_address1?: string;
@@ -5209,6 +5487,138 @@ export interface ApiV2EntitiesWarehouseFeature {
     updated_at?: string;
     warehouses?: string;
 }
+export interface ApiV2EntitiesWarehouseShallow {
+    /** Warehouse address line 1 */
+    shipping_address_1?: string;
+    /** Warehouse address line 2 */
+    shipping_address_2?: string;
+    /** Warehouse country code */
+    shipping_country_iso2?: string;
+    /** Is this Warehouse accepting new customers? (partners only) */
+    accepting_new_customers?: boolean;
+    /** Is the Warehouse active?  (partners only) */
+    active?: boolean;
+    /**
+     * Maximum cubic volume per bin (staff only)
+     * @format float
+     */
+    bin_cubic_volume_max?: number;
+    /**
+     * Maximum total items per bin (staff only)
+     * @format int32
+     */
+    bin_total_count_max?: number;
+    /** Warehouse contact name (partners only) */
+    contact_name?: string;
+    /** Warehouse contact phone (partners only) */
+    contact_phone?: string;
+    /**
+     * the warehouse creation date and time (partners only)
+     * @format date-time
+     */
+    created_at?: string;
+    /** Warehouse currency (partners only) */
+    currency?: string;
+    /** Paper or Robot scanning by default when batching? (staff only) */
+    default_pick_strategy?: string;
+    /** Does this Warehouse have delivery appointment reminders?  (partners only) */
+    delivery_appointment_required?: boolean;
+    /** Warehouse does domestic return labels?  (partners only) */
+    domestic_return_labels?: boolean;
+    /** the warehouse email address (partners only) */
+    email?: string;
+    /** Fulfillment cost center */
+    fulfillment_cost_center?: string;
+    /**
+     * the warehouse id
+     * @format int32
+     */
+    id?: number;
+    /** Warehouse does intl return labels? (partners only) */
+    international_return_labels?: boolean;
+    /** Warehouse label format (partners only) */
+    label_format?: string;
+    /**
+     * Warehouse latitude
+     * @format float
+     */
+    latitude?: number;
+    /**
+     * Loading Dock Quantity (partners only)
+     * @format int32
+     */
+    loading_dock_quantity?: number;
+    /**
+     * Warehouse longitude
+     * @format float
+     */
+    longitude?: number;
+    /** the warehouse name */
+    name?: string;
+    /** Miscellaneous notes/info (partners only) */
+    notes?: string;
+    /**
+     * Number of slots/bins in carts--default maximum number of orders in a batch (staff only)
+     * @format int32
+     */
+    number_of_groups?: number;
+    /**
+     * Packaging Customer ID (partners only)
+     * @format int32
+     */
+    packaging_customer_id?: number;
+    /** Parcel cost center */
+    parcel_cost_center?: string;
+    /**
+     * Warehouse partner id
+     * @format int32
+     */
+    partner_id?: number;
+    /** Warehouse pickup hours (partners only) */
+    pickup_hours?: string;
+    /** Warehouse receiving hours (partners only) */
+    receiving_hours?: string;
+    /** Receiving special instructions (partners only) */
+    receiving_special_instructions?: string;
+    /** Warehouse city */
+    shipping_city?: string;
+    /** Warehouse country */
+    shipping_country?: string;
+    /** Warehouse shipping label format - EPL2 or ZPL (partners only) */
+    shipping_label_format?: string;
+    /**  Warehouse state or province */
+    shipping_state?: string;
+    /** Warehouse postal code */
+    shipping_zip?: string;
+    /** Single Item Batch Size (partners only) */
+    single_item_batch_size?: string;
+    /** Warehouse slug */
+    slug?: string;
+    /**
+     * Warehouse square footage  (partners only)
+     * @format int32
+     */
+    square_footage?: number;
+    /** Warehouse timezone in friendly/legacy format (eg. "Eastern Time (US & Canada)") */
+    timezone?: string;
+    /** Warehouse timezone in standard format (eg. "America/New_York") */
+    timezone_raw?: string;
+    /**
+     * the warehouse last update date and time (partners only)
+     * @format date-time
+     */
+    updated_at?: string;
+    /** Warehouse carrier facility (partners only) */
+    ups_carrier_facility?: string;
+    /** Warehouse UPS shipping number (partners only) */
+    ups_shipper_number?: string;
+    /**
+     * Warehouse VAT number (partners only)
+     * @format float
+     */
+    vat?: number;
+    warehouse_features?: string;
+}
 export interface ApiV2EntitiesWholesale {
     /**
      * the latest possible arrival time for the shipment
@@ -10050,6 +10460,51 @@ export interface GetApiV21PackagesParams {
     /** Include total count of items */
     page_total?: 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 items */
+    page_total?: 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 items */
+    page_total?: boolean;
+}
 export interface GetApiV21PartnersCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -12429,6 +12884,51 @@ export interface GetApiV2PackagesParams {
     /** Include total count of items */
     page_total?: 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 items */
+    page_total?: 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 items */
+    page_total?: boolean;
+}
 export interface GetApiV2PartnersCountParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -25814,6 +26314,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;
@@ -29782,6 +30294,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;

package/dist/generated/index.d.ts

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

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

@@ -42,6 +42,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/created';
 export * from './v2_1/partner/created';
 export * from './v2_1/project-task/created';
 export * from './v2_1/project/created';

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

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