@whiplashmerch/whiplash-api-client 0.2.20 → 0.3.1

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

@@ -1,3 +1,211 @@
+export interface APIV21EntitiesCustomer {
+    /** 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;
+    /** 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;
+    /**
+     * IDs of warehouses this customer may ship from
+     * @format int32
+     */
+    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;
+    /** 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;
+    /**
+     * 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.
+     * @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;
+    /**
+     * 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 APIV21EntitiesPostResponse {
     /**
      * The Whiplash ID of the newly created resource
@@ -5,6 +213,138 @@ export interface APIV21EntitiesPostResponse {
      */
     id?: number;
 }
+export interface APIV21EntitiesWarehouse {
+    /** 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 APIV2EntitiesApiError {
     /** error message */
     message?: string;
@@ -74,7 +414,7 @@ export interface APIV2EntitiesConsumerReturn {
      * @format date-time
      */
     created_at?: string;
-    customer?: APIV2EntitiesCustomer;
+    customer?: APIV21EntitiesCustomer;
     /**
      * the consumer return customer id
      * @format int32
@@ -163,7 +503,7 @@ export interface APIV2EntitiesConsumerReturn {
      * @format date-time
      */
     updated_at?: string;
-    warehouse?: APIV2EntitiesWarehouse;
+    warehouse?: APIV21EntitiesWarehouse;
     /**
      * the consumer return warehouse id
      * @format int32
@@ -688,7 +1028,7 @@ export interface APIV2EntitiesItemWarehouseQuantity {
     created_at?: string;
     /** Warehouse currency (partners only) */
     currency?: string;
-    /** Paper, Mobile, or Robot scanning by default when batching? (staff only) */
+    /** 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;
@@ -1018,6 +1358,8 @@ export interface APIV2EntitiesOrder {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /**
@@ -1129,6 +1471,7 @@ export interface APIV2EntitiesOrder {
      * @format date-time
      */
     shipped_on?: string;
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
@@ -1137,6 +1480,8 @@ export interface APIV2EntitiesOrder {
     shipping_confirmation_sent?: boolean;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     shipping_method?: APIV2EntitiesShippingMethod;
     /**
      * the order shipping method id
@@ -2115,7 +2460,7 @@ export interface APIV2EntitiesWarehouse {
     created_at?: string;
     /** Warehouse currency (partners only) */
     currency?: string;
-    /** Paper, Mobile, or Robot scanning by default when batching? (staff only) */
+    /** 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;
@@ -3140,7 +3485,9 @@ export interface GetApiV2TemplatesParams {
 /** hazmat class */
 export declare enum ApiV2EntitiesItemHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** The country of origin for this item (as an iso2 country code) */
 export declare enum ApiV2EntitiesItemOriginCountry {
@@ -3829,7 +4176,9 @@ export interface PostApiV21Items {
 /** hazmat class */
 export declare enum PostApiV21ItemsHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** Add an item to an bundle */
 export interface PostApiV21ItemsIdBundleItems {
@@ -4178,6 +4527,7 @@ export interface PostApiV21NotificationSubscriptions {
 }
 /** Create an order */
 export interface PostApiV21Orders {
+    ""?: string;
     /** the order billing street address 1 */
     billing_address_1?: string;
     /** the order billing street address 2 */
@@ -4281,6 +4631,8 @@ export interface PostApiV21Orders {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -4458,12 +4810,16 @@ export interface PostApiV21Orders {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32
@@ -4749,7 +5105,6 @@ export interface PostApiV21Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
-    shipnotice_items?: string;
     shipnotice_items_attributes?: {
         /**
          * the number of this shipnotice item in the shipnotice
@@ -5254,7 +5609,9 @@ export interface PostApiV2Items {
 /** hazmat class */
 export declare enum PostApiV2ItemsHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** Add an item to an bundle */
 export interface PostApiV2ItemsIdBundleItems {
@@ -5603,6 +5960,7 @@ export interface PostApiV2NotificationSubscriptions {
 }
 /** Create an order */
 export interface PostApiV2Orders {
+    ""?: string;
     /** the order billing street address 1 */
     billing_address_1?: string;
     /** the order billing street address 2 */
@@ -5706,6 +6064,8 @@ export interface PostApiV2Orders {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -5883,12 +6243,16 @@ export interface PostApiV2Orders {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32
@@ -6174,7 +6538,6 @@ export interface PostApiV2Shipnotices {
      * @format int32
      */
     shipnotice_item_sku_count?: number;
-    shipnotice_items?: string;
     shipnotice_items_attributes?: {
         /**
          * the number of this shipnotice item in the shipnotice
@@ -6796,7 +7159,9 @@ export interface PutApiV21Items {
 /** hazmat class */
 export declare enum PutApiV21ItemsHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** Perform an action on an item */
 export interface PutApiV21ItemsIdCall {
@@ -7225,7 +7590,9 @@ export interface PutApiV21ItemsOriginator {
 /** hazmat class */
 export declare enum PutApiV21ItemsOriginatorHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** The country of origin for this item (as an iso2 country code) */
 export declare enum PutApiV21ItemsOriginatorOriginCountry {
@@ -7804,6 +8171,8 @@ export interface PutApiV21Orders {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -7870,12 +8239,16 @@ export interface PutApiV21Orders {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32
@@ -8052,6 +8425,8 @@ export interface PutApiV21OrdersOriginator {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -8118,12 +8493,16 @@ export interface PutApiV21OrdersOriginator {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32
@@ -8957,7 +9336,9 @@ export interface PutApiV2Items {
 /** hazmat class */
 export declare enum PutApiV2ItemsHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** Perform an action on an item */
 export interface PutApiV2ItemsIdCall {
@@ -9386,7 +9767,9 @@ export interface PutApiV2ItemsOriginator {
 /** hazmat class */
 export declare enum PutApiV2ItemsOriginatorHazmatType {
     Ormd = "ormd",
-    Lithium = "lithium"
+    Lithium = "lithium",
+    ORMD = "ORMD",
+    LITHIUM = "LITHIUM"
 }
 /** The country of origin for this item (as an iso2 country code) */
 export declare enum PutApiV2ItemsOriginatorOriginCountry {
@@ -9965,6 +10348,8 @@ export interface PutApiV2Orders {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -10031,12 +10416,16 @@ export interface PutApiV2Orders {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32
@@ -10211,6 +10600,8 @@ export interface PutApiV2OrdersOriginator {
     full_name?: string;
     /** is the order a gift? */
     gift?: boolean;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
     /** the order humanized id */
     humanize_id?: string;
     /** desired incoterm for the order */
@@ -10277,12 +10668,16 @@ export interface PutApiV2OrdersOriginator {
     saturday_delivery?: boolean;
     /** the order ship notes */
     ship_notes?: string;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
     /** the order shipping city */
     shipping_city?: string;
     /** the order shipping company */
     shipping_company?: string;
     /** the order shipping country */
     shipping_country?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
     /**
      * the order shipping method id
      * @format int32