@whiplashmerch/whiplash-api-client 2.0.35 → 3.0.0

package/generated/data-contracts.ts

@@ -9,12 +9,20 @@
  * ---------------------------------------------------------------
  */
 
-/** V2 */
-export interface ApiV2EntitiesApiError {
+/** Shared */
+export interface ApiSharedEntitiesApiError {
   /** error message */
   message?: string;
 }
 
+/** Shared */
+export interface ApiSharedEntitiesMetaFields {
+  /** Included meta fields for associations */
+  association_fields?: object;
+  /** Hash of key/value pairs */
+  fields?: object;
+}
+
 /** V2 */
 export interface ApiV2EntitiesBundleItem {
   /**
@@ -759,8 +767,6 @@ export interface ApiV2EntitiesDocument {
   customer_id?: number | null;
   /** associated customer name */
   customer_name?: string;
-  /** the document name */
-  file_name?: string;
   /**
    * the document id
    * @format int32
@@ -1206,14 +1212,6 @@ export interface ApiV2EntitiesLot {
   updated_at?: string;
 }
 
-/** V2 */
-export interface ApiV2EntitiesMetaFields {
-  /** Included meta fields for associations */
-  association_fields?: object;
-  /** Hash of key/value pairs */
-  fields?: object;
-}
-
 /** V2 */
 export interface ApiV2EntitiesNotificationEvent {
   /**
@@ -3062,7 +3060,53 @@ export interface ApiV2EntitiesWholesaleItem {
   vendor_part_number?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesBundleItem {
+  /**
+   * the bundle item bundle id (admins only)
+   * @format int32
+   */
+  bundle_id?: number | null;
+  /**
+   * the bundle item creation date and time
+   * @format date-time
+   */
+  created_at?: string | null;
+  /**
+   * the bundle item id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the bundle item item id
+   * @format int32
+   */
+  item_id?: number | null;
+  item_name?: string;
+  item_quantity?: string;
+  /**
+   * the bundle item max per package (admins only)
+   * @format int32
+   */
+  max_per_package?: number | null;
+  /**
+   * the bundle item parent item id (admins only)
+   * @format int32
+   */
+  parent_item_id?: number | null;
+  /**
+   * the bundle item quantity
+   * @format int32
+   */
+  quantity?: number | null;
+  /**
+   * the bundle item last update date and time
+   * @format date-time
+   */
+  updated_at?: string | null;
+}
+
+/** V3 */
 export interface ApiV21EntitiesCarrierAlias {
   /** carrier alias slug */
   context?: string | null;
@@ -3079,7 +3123,7 @@ export interface ApiV21EntitiesCarrierAlias {
   scac?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesConsumerReturn {
   /**
    * 3rd party cost for the consumer return
@@ -3143,7 +3187,7 @@ export interface ApiV21EntitiesConsumerReturn {
    * @format int32
    */
   order_id?: number | null;
-  originator?: ApiV2EntitiesOriginator;
+  originator?: ApiV21EntitiesOriginator;
   /** was postage billed? */
   postage_billed?: boolean | null;
   /** the name of the person who received the consumer return */
@@ -3197,7 +3241,16 @@ export interface ApiV21EntitiesConsumerReturn {
   warehouse_name?: string;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesCount {
+  /**
+   * the resource count
+   * @format int32
+   */
+  count?: number;
+}
+
+/** V3 */
 export interface ApiV21EntitiesCustomer {
   /** Customer billing address line 1. */
   billing_address1?: string | null;
@@ -3417,7 +3470,7 @@ export interface ApiV21EntitiesCustomer {
   workday_uuid?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesCustomsInfo {
   /** AU VAT number */
   au_vat_number?: string | null;
@@ -3469,7 +3522,7 @@ export interface ApiV21EntitiesCustomsInfo {
   updated_at?: string;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesDocument {
   context_list?: string[];
   /**
@@ -3484,8 +3537,6 @@ export interface ApiV21EntitiesDocument {
   customer_id?: number | null;
   /** associated customer name */
   customer_name?: string;
-  /** the document name */
-  file_name?: string;
   /**
    * the document id
    * @format int32
@@ -3513,7 +3564,7 @@ export interface ApiV21EntitiesDocument {
   user_name?: string;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesItem {
   /** is the item active? */
   active?: boolean | null;
@@ -3629,6 +3680,26 @@ export interface ApiV21EntitiesItem {
    * @format int32
    */
   quantity?: number;
+  /**
+   * the item quantity in backstock
+   * @format int32
+   */
+  quantity_backstock?: number;
+  /**
+   * the item quantity inbound
+   * @format int32
+   */
+  quantity_inbound?: number;
+  /**
+   * the item quantity pickable
+   * @format int32
+   */
+  quantity_pickable?: number;
+  /**
+   * the item quantity assigned to locations
+   * @format int32
+   */
+  quantity_published?: number;
   /**
    * Minimum number of days worth of stock to keep in forward pick locations
    * @format float
@@ -3696,7 +3767,96 @@ export interface ApiV21EntitiesItem {
   width?: number | null;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesItemLocation {
+  /** Human readable version of the location name */
+  humanize_shelf_name?: string;
+  /**
+   * the location id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the number of in progress transfers
+   * @format int32
+   */
+  in_progress_transfers?: number;
+  /**
+   * the lot expiration date
+   * @format date-time
+   */
+  lot_expires_on?: string;
+  /** the lot number associated to the location */
+  lot_number?: string;
+  /** the location name */
+  name?: string;
+  /**
+   * the quantity of the location
+   * @format int32
+   */
+  quantity?: number;
+  /** pickable, backstock, etc */
+  role?: ApiV21EntitiesItemLocationRole;
+  /**
+   * the uncommitted quantity of the location
+   * @format int32
+   */
+  uncommitted?: number;
+  /** the warehouse name for the location */
+  warehouse_name?: string;
+}
+
+/** V3 */
+export interface ApiV21EntitiesItemWarehouseQuantity {
+  /**
+   * item quantity at speficied warehouse, taking incoming orders into account
+   * @format int32
+   */
+  projected_quantity?: number;
+  /**
+   * item shelf quantity at speficied warehouse
+   * @format int32
+   */
+  quantity?: number;
+  /**
+   * item quantity at speficied warehouse, taking incoming orders, ship notices, and returns into account
+   * @format int32
+   */
+  sellable_quantity?: number;
+}
+
+/** V3 */
+export interface ApiV21EntitiesNotificationEvent {
+  /**
+   * the notification event creation date and time
+   * @format date-time
+   */
+  created_at?: string;
+  /** what the event is, and when it fires */
+  description?: string;
+  /** a more readable name of the event */
+  humanized_name?: string;
+  /**
+   * the notification event id
+   * @format int32
+   */
+  id?: number;
+  /** the name of the event */
+  name?: string | null;
+  /** Whether or not this event requires customer subscription */
+  requires_subscription?: boolean | null;
+  /** the verb for this event */
+  resource_message?: string | null;
+  /** the type of resource this event is attached to */
+  resource_type?: string | null;
+  /**
+   * the notification event last update date and time
+   * @format date-time
+   */
+  updated_at?: string;
+}
+
+/** V3 */
 export interface ApiV21EntitiesNotificationSubscription {
   /** is the notification subscription active? */
   active?: boolean | null;
@@ -3746,7 +3906,7 @@ export interface ApiV21EntitiesNotificationSubscription {
   version?: number | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesOrder {
   /** the order billing street address 1 */
   billing_address_1?: string | null;
@@ -3911,7 +4071,7 @@ export interface ApiV21EntitiesOrder {
   order_orig?: string | null;
   /** the order type */
   order_type?: ApiV21EntitiesOrderOrderType;
-  originator?: ApiV2EntitiesOriginator;
+  originator?: ApiV21EntitiesOriginator;
   /**
    * User-defined reference for shipping labels on packages.
    *           Note: this field has a limit of 35 chars.
@@ -4047,6 +4207,11 @@ export interface ApiV21EntitiesOrder {
    * @format date-time
    */
   shop_updated_at?: string | null;
+  /**
+   * the order shop warehouse id
+   * @format int32
+   */
+  shop_warehouse_id?: number | null;
   shop_warehouse_ids?: number[];
   /** skip order shipping address verification? (staff only) */
   skip_address_verification?: boolean | null;
@@ -4059,9 +4224,9 @@ export interface ApiV21EntitiesOrder {
   status?: ApiV21EntitiesOrderStatus;
   /** the order status name */
   status_name?: string;
-  /** the order tms id */
+  /** The Transport Management System ID for the order, if applicable */
   tms_id?: string | null;
-  /** Whether tms is required */
+  /** Does the order require a Transport Management System ID */
   tms_required?: boolean | null;
   tracking?: string[];
   tracking_links?: string[];
@@ -4085,7 +4250,62 @@ export interface ApiV21EntitiesOrder {
   workable_at?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesOrderDocument {
+  /**
+   * the order document creation date and time
+   * @format date-time
+   */
+  created_at?: string | null;
+  /**
+   * the order document customer id
+   * @format int32
+   */
+  customer_id?: number | null;
+  /** the order document type */
+  document_type?: string | null;
+  /**
+   * the order document id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the order document order id
+   * @format int32
+   */
+  order_id?: number | null;
+  /**
+   * the order document last update date and time
+   * @format date-time
+   */
+  updated_at?: string | null;
+  /** the order document file url */
+  url?: string;
+}
+
+/** V3 */
+export interface ApiV21EntitiesOrderEvent {
+  /**
+   * the event date and time
+   * @format date-time
+   */
+  date?: string;
+  /** event description. */
+  description?: string;
+  /** the event type */
+  event_type?: string;
+  /** saved by name (staff only) */
+  saved_by?: string;
+  /**
+   * saved by id (staff only)
+   * @format int32
+   */
+  saved_by_id?: number;
+  /** saved by provider (staff only) */
+  saved_via?: string;
+}
+
+/** V3 */
 export interface ApiV21EntitiesOrderItem {
   /** is this item available? */
   available?: boolean | null;
@@ -4124,7 +4344,7 @@ export interface ApiV21EntitiesOrderItem {
    * @format int32
    */
   order_id?: number;
-  originator?: ApiV2EntitiesOriginator;
+  originator?: ApiV21EntitiesOriginator;
   /**
    * the order item package id
    * @format int32
@@ -4182,10 +4402,70 @@ export interface ApiV21EntitiesOrderItem {
    * @format float
    */
   wholesale_fee?: number | null;
-  wholesale_item?: ApiV2EntitiesWholesaleItem;
+  wholesale_item?: ApiV21EntitiesWholesaleItem;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesOriginator {
+  /** is the originator active? */
+  active?: boolean | null;
+  /**
+   * the id of the oauth application
+   * @format int32
+   */
+  application_id?: number | null;
+  /**
+   * the originator creation date and time
+   * @format date-time
+   */
+  created_at?: string;
+  /** the originator distinct key */
+  distinct_originator_key?: string | null;
+  /** the originator group id */
+  group_id?: string | null;
+  /**
+   * the originator id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the originator integration id
+   * @format int32
+   */
+  integration_id?: number | null;
+  /** the originator last notification status */
+  last_notification_status?: string | null;
+  /**
+   * the originator last notified date and time
+   * @format date-time
+   */
+  last_notified_at?: string | null;
+  /** miscellaneous info for the originator */
+  misc?: string | null;
+  /** the originator original id (from the provider) */
+  original_id?: string | null;
+  /**
+   * the id of the object created by the originator
+   * @format int32
+   */
+  originated_id?: number | null;
+  /** the type of object created by the originator */
+  originated_type?: string | null;
+  /** the originator provider (shopify, magento, bandcamp, etc) */
+  provider?: string | null;
+  /**
+   * the originator shop id
+   * @format int32
+   */
+  shop_id?: number | null;
+  /**
+   * the originator last update date and time
+   * @format date-time
+   */
+  updated_at?: string;
+}
+
+/** V3 */
 export interface ApiV21EntitiesPostResponse {
   /**
    * The Whiplash ID of the newly created resource
@@ -4194,7 +4474,123 @@ export interface ApiV21EntitiesPostResponse {
   id?: number;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesProjectTask {
+  /**
+   * cost per unit, if task has custom label
+   * @format float
+   */
+  cost_per_unit?: number | null;
+  /**
+   * project_task created_at
+   * @format date-time
+   */
+  created_at?: string;
+  /**
+   * the customer that owns the project and task
+   * @format int32
+   */
+  customer_id?: number;
+  /** the description of the project task */
+  description?: string | null;
+  /** @format int32 */
+  id?: number;
+  /** the type of task, used to determine rates */
+  label?: string;
+  /**
+   * the project id
+   * @format int32
+   */
+  project_id?: number;
+  /**
+   * quantity of units
+   * @format float
+   */
+  quantity?: number;
+  /**
+   * project_task updated_at
+   * @format date-time
+   */
+  updated_at?: string;
+  /**
+   * the warehouse that owns the project and task
+   * @format int32
+   */
+  warehouse_id?: number;
+}
+
+/** V3 */
+export interface ApiV21EntitiesResult {
+  /** the request result */
+  result?: string;
+}
+
+/** V3 */
+export interface ApiV21EntitiesScancode {
+  /** is this scancode active? */
+  active?: boolean | null;
+  /**
+   * scancode creation date
+   * @format date-time
+   */
+  created_at?: string;
+  /**
+   * the customer_id
+   * @format int32
+   */
+  customer_id?: number | null;
+  /**
+   * the scancode id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the item_id
+   * @format int32
+   */
+  item_id?: number | null;
+  /** label format for the scancode */
+  label_format?: string | null;
+  /** the name for the scancode */
+  name?: string | null;
+  /** is this the primary scancode? */
+  primary?: boolean | null;
+  /** the name for the scancode (legacy) */
+  scancode?: string;
+  /**
+   * scancode last updated date
+   * @format date-time
+   */
+  updated_at?: string;
+}
+
+/** V3 */
+export interface ApiV21EntitiesSerialNumber {
+  /**
+   * if not null, the DateTime when the serial was deleted
+   * @format date-time
+   */
+  deleted_at?: string | null;
+  /**
+   * the serial number id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the order_item_id for the serial number
+   * @format int32
+   */
+  order_item_id?: number | null;
+  /**
+   * the shipnotice_item_id for the serial number (returns only)
+   * @format int32
+   */
+  shipnotice_item_id?: number | null;
+  /** the serial number itself */
+  text?: string | null;
+}
+
+/** V3 */
 export interface ApiV21EntitiesShipnotice {
   /**
    * 3rd party cost for the shipnotice
@@ -4271,7 +4667,7 @@ export interface ApiV21EntitiesShipnotice {
    * @format int32
    */
   order_id?: number | null;
-  originator?: ApiV2EntitiesOriginator;
+  originator?: ApiV21EntitiesOriginator;
   /** was postage billed? */
   postage_billed?: boolean | null;
   /**
@@ -4354,7 +4750,7 @@ export interface ApiV21EntitiesShipnotice {
   zone_status?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesShipnoticeItem {
   /**
    * the shipnotice item creation date and time
@@ -4365,6 +4761,8 @@ export interface ApiV21EntitiesShipnoticeItem {
   description?: string | null;
   /** an extended description of the item */
   extended_description?: string | null;
+  /** Garment on hanger? */
+  goh?: boolean;
   /**
    * the shipnotice item id
    * @format int32
@@ -4429,7 +4827,7 @@ export interface ApiV21EntitiesShipnoticeItem {
   updated_at?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesTemplate {
   /** Content of the template */
   content?: string | null;
@@ -4470,7 +4868,68 @@ export interface ApiV21EntitiesTemplate {
   url?: string;
 }
 
-/** V2_1 */
+/** V3 */
+export interface ApiV21EntitiesTransaction {
+  /**
+   * the transaction change
+   * @format int32
+   */
+  change?: number | null;
+  /**
+   * the transaction creation date and time
+   * @format date-time
+   */
+  created_at?: string | null;
+  /** the transaction description */
+  description?: string;
+  /**
+   * the transaction id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the transaction item id
+   * @format int32
+   */
+  item_id?: number;
+  /**
+   * the transaction order id
+   * @format int32
+   */
+  order_id?: number | null;
+  /**
+   * the transaction balance - calculated
+   * @format int32
+   */
+  quantity?: number;
+  /**
+   * the transaction rule id
+   * @format int32
+   */
+  rule_id?: number | null;
+  /**
+   * the transaction shipnotice id
+   * @format int32
+   */
+  shipnotice_id?: number | null;
+  /**
+   * associated shipnotice_item_id if transaction is created from a shipnotice
+   * @format int32
+   */
+  shipnotice_item_id?: number;
+  /**
+   * the transaction last update date and time
+   * @format date-time
+   */
+  updated_at?: string | null;
+  /**
+   * the transaction user id
+   * @format int32
+   */
+  user_id?: number | null;
+}
+
+/** V3 */
 export interface ApiV21EntitiesWholesale {
   /**
    * the latest possible arrival time for the shipment
@@ -4552,7 +5011,7 @@ export interface ApiV21EntitiesWholesale {
   vendor_number?: string | null;
 }
 
-/** V2_1 */
+/** V3 */
 export interface ApiV21EntitiesWholesaleItem {
   /** the alternate barcode */
   alternate_barcode?: string | null;
@@ -6150,7 +6609,6 @@ export interface PostApiV21DocumentsRequest {
   context_list?: string;
   /** associated customer name */
   customer_name?: string;
-  /** the document name */
   file_name?: string;
   /** Comma separated list of keyword tags */
   keyword_list?: string;
@@ -6935,11 +7393,6 @@ export interface PostApiV21OrdersRequest {
   shipping_address_2?: string;
   /** the order shipping country iso2 (US, GB, CA, etc) */
   shipping_country_iso2?: string;
-  /**
-   * the order approxiamte delivery date
-   * @format date
-   */
-  approximate_delivery_date?: string;
   /** the order batch priority */
   batch_priority?: boolean;
   /** the order billing city */
@@ -6967,6 +7420,31 @@ export interface PostApiV21OrdersRequest {
   customer_provided_label_carrier?: string;
   /** Economic Operators Registration and Identification number for the sender of the order */
   customs_eori_number?: string;
+  customs_info_attributes?: {
+    /**
+     * the associated importer of record id
+     * @format int32
+     */
+    importer_of_record_id?: number;
+    /** send ETD to carrier */
+    send_electonic_trade_docs?: boolean;
+    /** e-signature for customs */
+    signer?: string;
+    /** AU VAT number */
+    au_vat_number?: string;
+    /** EU VAT number */
+    eu_vat_number?: string;
+    /** non-EU/AU/UK VAT number */
+    misc_vat_number?: string;
+    /** UK VAT number */
+    uk_vat_number?: string;
+    /** IOSS number */
+    ioss_number?: string;
+    /** EORI number */
+    eori_number?: string;
+    /** Tax id */
+    receiver_tax_id?: string;
+  };
   /** Import One-Stop Shop number for the sender of the order */
   customs_ioss_number?: string;
   /** RFC Tax id */
@@ -8110,7 +8588,6 @@ export interface PostApiV2DocumentsRequest {
   context_list?: string;
   /** associated customer name */
   customer_name?: string;
-  /** the document name */
   file_name?: string;
   /** Comma separated list of keyword tags */
   keyword_list?: string;
@@ -8895,11 +9372,6 @@ export interface PostApiV2OrdersRequest {
   shipping_address_2?: string;
   /** the order shipping country iso2 (US, GB, CA, etc) */
   shipping_country_iso2?: string;
-  /**
-   * the order approxiamte delivery date
-   * @format date
-   */
-  approximate_delivery_date?: string;
   /** the order batch priority */
   batch_priority?: boolean;
   /** the order billing city */
@@ -8927,6 +9399,31 @@ export interface PostApiV2OrdersRequest {
   customer_provided_label_carrier?: string;
   /** Economic Operators Registration and Identification number for the sender of the order */
   customs_eori_number?: string;
+  customs_info_attributes?: {
+    /**
+     * the associated importer of record id
+     * @format int32
+     */
+    importer_of_record_id?: number;
+    /** send ETD to carrier */
+    send_electonic_trade_docs?: boolean;
+    /** e-signature for customs */
+    signer?: string;
+    /** AU VAT number */
+    au_vat_number?: string;
+    /** EU VAT number */
+    eu_vat_number?: string;
+    /** non-EU/AU/UK VAT number */
+    misc_vat_number?: string;
+    /** UK VAT number */
+    uk_vat_number?: string;
+    /** IOSS number */
+    ioss_number?: string;
+    /** EORI number */
+    eori_number?: string;
+    /** Tax id */
+    receiver_tax_id?: string;
+  };
   /** Import One-Stop Shop number for the sender of the order */
   customs_ioss_number?: string;
   /** RFC Tax id */
@@ -12272,6 +12769,19 @@ export enum ApiV21EntitiesItemLabelFormat {
   WhiplashMini = "whiplash_mini",
 }
 
+/** pickable, backstock, etc */
+export enum ApiV21EntitiesItemLocationRole {
+  Pickable = "pickable",
+  Backstock = "backstock",
+  Damaged = "damaged",
+  Expired = "expired",
+  Reserved = "reserved",
+  Pending = "pending",
+  External = "external",
+  Dropoff = "dropoff",
+  BStock = "b_stock",
+}
+
 /** The country of origin for this item (as an iso2 country code) */
 export enum ApiV21EntitiesItemOriginCountry {
   AF = "AF",