@whiplashmerch/whiplash-api-client 3.0.0 → 3.0.2

package/dist/generated/Orders.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
+import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Retrieves a list of orders
@@ -54,6 +54,15 @@ export declare const postApiV2OrdersBulk: (client: HttpClient, data: PostApiV2Or
  * @request GET:/api/v2/orders/count
  */
 export declare const getApiV2OrdersCount: (client: HttpClient, query: GetApiV2OrdersCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Returns all order types
+ *
+ * @tags orders
+ * @name GetApiV2OrdersOrderTypes
+ * @summary Order Types
+ * @request GET:/api/v2/orders/order_types
+ */
+export declare const getApiV2OrdersOrderTypes: (client: HttpClient, params?: RequestParams) => Promise<ApiV2EntitiesListValue>;
 /**
  * @description Get orders traits
  *
@@ -477,6 +486,15 @@ export declare const postApiV21OrdersBulk: (client: HttpClient, data: PostApiV21
  * @request GET:/api/v2.1/orders/count
  */
 export declare const getApiV21OrdersCount: (client: HttpClient, query: GetApiV21OrdersCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
+/**
+ * @description Returns all order types
+ *
+ * @tags orders
+ * @name GetApiV21OrdersOrderTypes
+ * @summary Order Types
+ * @request GET:/api/v2.1/orders/order_types
+ */
+export declare const getApiV21OrdersOrderTypes: (client: HttpClient, params?: RequestParams) => Promise<ApiV21EntitiesListValue>;
 /**
  * @description Get orders traits
  *

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

@@ -1394,131 +1394,131 @@ export interface ApiV2EntitiesFilterSet {
 /** V2 */
 export interface ApiV2EntitiesFilterSetOptions {
     bulk_actions?: {
-        location_transfer?: object;
-        order_batch?: object;
-        meta_key?: object;
+        location?: object;
+        account_transaction?: object;
         shipping_method?: object;
-        order?: object;
-        project?: object;
+        location_audit?: object;
+        consumer_return?: object;
+        order_batch?: object;
         incident?: object;
         item?: object;
-        manifest?: object;
         warehouse?: object;
-        account_transaction?: object;
-        user?: object;
-        consumer_return?: object;
-        shipnotice?: object;
-        location?: object;
         carrier_account?: object;
-        location_audit?: object;
+        order?: object;
+        location_transfer?: object;
+        shipnotice?: object;
+        project?: object;
+        manifest?: object;
+        user?: object;
+        meta_key?: object;
     };
     exporters?: {
-        location_transfer?: object;
+        location?: object;
+        account_transaction?: object;
         shipping_method?: object;
-        order?: object;
+        location_audit?: object;
         document?: object;
+        consumer_return?: object;
+        customer?: object;
         incident?: object;
         item?: object;
-        account_transaction?: object;
-        consumer_return?: object;
+        order?: object;
+        location_transfer?: object;
         shipnotice?: object;
-        location?: object;
-        customer?: object;
-        location_audit?: object;
     };
     filters?: {
-        location_transfer?: any[];
-        order_batch?: any[];
-        meta_key?: any[];
+        location?: any[];
+        account_transaction?: any[];
         shipping_method?: any[];
-        order?: any[];
-        project?: any[];
+        location_audit?: any[];
         document?: any[];
+        transaction?: any[];
+        consumer_return?: any[];
+        order_batch?: any[];
+        customer?: any[];
         incident?: any[];
         item?: any[];
-        manifest?: any[];
         warehouse?: any[];
-        account_transaction?: any[];
-        user?: any[];
-        consumer_return?: any[];
-        partner?: any[];
-        shipnotice?: any[];
-        location?: any[];
-        transaction?: any[];
         carrier_account?: any[];
-        customer?: any[];
-        location_audit?: any[];
+        order?: any[];
+        location_transfer?: any[];
+        shipnotice?: any[];
+        project?: any[];
+        partner?: any[];
+        manifest?: any[];
+        user?: any[];
+        meta_key?: any[];
     };
     importers?: {
-        location_transfer?: any[];
-        order?: any[];
         document?: any[];
-        item?: any[];
         consumer_return?: any[];
+        item?: any[];
+        order?: any[];
+        location_transfer?: any[];
         shipnotice?: any[];
     };
     required_scopes?: {
-        location_transfer?: any[];
-        order_batch?: any[];
-        meta_key?: any[];
+        location?: any[];
+        account_transaction?: any[];
         shipping_method?: any[];
-        order?: any[];
-        project?: any[];
+        location_audit?: any[];
         document?: any[];
+        transaction?: any[];
+        consumer_return?: any[];
+        order_batch?: any[];
+        customer?: any[];
         incident?: any[];
         item?: any[];
-        manifest?: any[];
         warehouse?: any[];
-        account_transaction?: any[];
-        user?: any[];
-        consumer_return?: any[];
-        partner?: any[];
-        shipnotice?: any[];
-        location?: any[];
-        transaction?: any[];
         carrier_account?: any[];
-        customer?: any[];
-        location_audit?: any[];
+        order?: any[];
+        location_transfer?: any[];
+        shipnotice?: any[];
+        project?: any[];
+        partner?: any[];
+        manifest?: any[];
+        user?: any[];
+        meta_key?: any[];
     };
     resource_actions?: {
-        location_transfer?: object;
-        order_batch?: object;
-        meta_key?: object;
+        location?: object;
+        account_transaction?: object;
         shipping_method?: object;
-        order?: object;
-        project?: object;
+        location_audit?: object;
         document?: object;
+        consumer_return?: object;
+        order_batch?: object;
+        customer?: object;
         incident?: object;
         item?: object;
-        manifest?: object;
         warehouse?: object;
-        account_transaction?: object;
-        user?: object;
-        consumer_return?: object;
-        shipnotice?: object;
-        location?: object;
         carrier_account?: object;
-        customer?: object;
-        location_audit?: object;
+        order?: object;
+        location_transfer?: object;
+        shipnotice?: object;
+        project?: object;
+        manifest?: object;
+        user?: object;
+        meta_key?: object;
     };
     rule_actions?: {
         batching?: object;
-        replenishment?: object;
+        routing?: object;
         packing?: object;
         backstock?: object;
-        shipping_method?: object;
         carrier_account?: object;
-        routing?: object;
+        replenishment?: object;
+        shipping_method?: object;
     };
     traits?: {
+        consumer_return?: any[];
         order_batch?: any[];
-        order?: any[];
+        customer?: any[];
         item?: any[];
         warehouse?: any[];
-        user?: any[];
-        consumer_return?: any[];
+        order?: any[];
         shipnotice?: any[];
-        customer?: any[];
+        user?: any[];
     };
 }
 /** V2 */
@@ -1546,6 +1546,8 @@ export interface ApiV2EntitiesImporterOfRecord {
     customer_id?: number;
     /** the email of the importer of record */
     email?: string | null;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string | null;
     /**
      * the importer of record id
      * @format int32
@@ -1557,6 +1559,8 @@ export interface ApiV2EntitiesImporterOfRecord {
     phone?: string | null;
     /** the state of the importer of record */
     state?: string | null;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string | null;
     /** the street name of the importer of record */
     street?: string | null;
     /** the address number of the importer of record */
@@ -2207,6 +2211,10 @@ export interface ApiV2EntitiesItemWarehouseQuantity {
     warehouse_features?: string;
 }
 /** V2 */
+export interface ApiV2EntitiesListValue {
+    list?: string[];
+}
+/** V2 */
 export interface ApiV2EntitiesLoad {
     /**
      * the date/time of the appointment
@@ -6957,6 +6965,8 @@ export interface ApiV21EntitiesImporterOfRecord {
     customer_id?: number;
     /** the email of the importer of record */
     email?: string | null;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string | null;
     /**
      * the importer of record id
      * @format int32
@@ -6968,6 +6978,8 @@ export interface ApiV21EntitiesImporterOfRecord {
     phone?: string | null;
     /** the state of the importer of record */
     state?: string | null;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string | null;
     /** the street name of the importer of record */
     street?: string | null;
     /** the address number of the importer of record */
@@ -7424,6 +7436,10 @@ export interface ApiV21EntitiesItemWarehouseQuantity {
     sellable_quantity?: number;
 }
 /** V3 */
+export interface ApiV21EntitiesListValue {
+    list?: string[];
+}
+/** V3 */
 export interface ApiV21EntitiesLoad {
     /**
      * the date/time of the appointment
@@ -17353,12 +17369,16 @@ export interface PostApiV21ImporterOfRecordsRequest {
     country?: string;
     /** the email of the importer of record */
     email?: string;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string;
     /** the first and last name of the importer of record */
     name?: string;
     /** the phone number of the importer of record */
     phone?: string;
     /** the state of the importer of record */
     state?: string;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string;
     /** the street name of the importer of record */
     street?: string;
     /** the address number of the importer of record */
@@ -21019,12 +21039,16 @@ export interface PostApiV2ImporterOfRecordsRequest {
     country?: string;
     /** the email of the importer of record */
     email?: string;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string;
     /** the first and last name of the importer of record */
     name?: string;
     /** the phone number of the importer of record */
     phone?: string;
     /** the state of the importer of record */
     state?: string;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string;
     /** the street name of the importer of record */
     street?: string;
     /** the address number of the importer of record */
@@ -24404,12 +24428,16 @@ export interface PutApiV21ImporterOfRecordsIdRequest {
     country?: string;
     /** the email of the importer of record */
     email?: string;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string;
     /** the first and last name of the importer of record */
     name?: string;
     /** the phone number of the importer of record */
     phone?: string;
     /** the state of the importer of record */
     state?: string;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string;
     /** the street name of the importer of record */
     street?: string;
     /** the address number of the importer of record */
@@ -27410,12 +27438,16 @@ export interface PutApiV2ImporterOfRecordsIdRequest {
     country?: string;
     /** the email of the importer of record */
     email?: string;
+    /** the federal tax id of the importer of record */
+    federal_tax_id?: string;
     /** the first and last name of the importer of record */
     name?: string;
     /** the phone number of the importer of record */
     phone?: string;
     /** the state of the importer of record */
     state?: string;
+    /** the state tax id of the importer of record */
+    state_tax_id?: string;
     /** the street name of the importer of record */
     street?: string;
     /** the address number of the importer of record */
@@ -31929,12 +31961,12 @@ export declare enum PostApiV21RulesRequestState {
 /** Which type of rule this is */
 export declare enum PostApiV21RulesRequestType {
     BatchingRule = "BatchingRule",
-    ReplenishmentRule = "ReplenishmentRule",
+    RoutingRule = "RoutingRule",
     PackingRule = "PackingRule",
     BackstockRule = "BackstockRule",
-    ShippingMethodRule = "ShippingMethodRule",
     CarrierAccountRule = "CarrierAccountRule",
-    RoutingRule = "RoutingRule"
+    ReplenishmentRule = "ReplenishmentRule",
+    ShippingMethodRule = "ShippingMethodRule"
 }
 /** locale for language settings */
 export declare enum PostApiV21UsersRequestLocale {
@@ -32737,12 +32769,12 @@ export declare enum PostApiV2RulesRequestState {
 /** Which type of rule this is */
 export declare enum PostApiV2RulesRequestType {
     BatchingRule = "BatchingRule",
-    ReplenishmentRule = "ReplenishmentRule",
+    RoutingRule = "RoutingRule",
     PackingRule = "PackingRule",
     BackstockRule = "BackstockRule",
-    ShippingMethodRule = "ShippingMethodRule",
     CarrierAccountRule = "CarrierAccountRule",
-    RoutingRule = "RoutingRule"
+    ReplenishmentRule = "ReplenishmentRule",
+    ShippingMethodRule = "ShippingMethodRule"
 }
 /** locale for language settings */
 export declare enum PostApiV2UsersRequestLocale {