@whiplashmerch/whiplash-api-client 3.0.8 → 3.0.9

package/dist/generated/Orders.d.ts

@@ -1,4 +1,4 @@
-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 { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingRate, 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
@@ -386,7 +386,7 @@ export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: num
  * @summary Retrieve shipment rates for an order, excluding fees
  * @request GET:/api/v2/orders/{id}/shipment_rates
  */
-export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOrder[]>;
+export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesShippingRate[]>;
 /**
  * @description List shipping rates for an order
  *
@@ -395,7 +395,7 @@ export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: num
  * @summary Retrieve shipping rates for an order
  * @request GET:/api/v2/orders/{id}/shipping_rates
  */
-export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOrder[]>;
+export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesShippingRate[]>;
 /**
  * @description Get the shipping weight for an order
  *
@@ -818,7 +818,7 @@ export declare const getApiV21OrdersIdSerialNumbers: (client: HttpClient, id: nu
  * @summary Retrieve shipment rates for an order, excluding fees
  * @request GET:/api/v2.1/orders/{id}/shipment_rates
  */
-export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOrder[]>;
+export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesShippingRate[]>;
 /**
  * @description List shipping rates for an order
  *
@@ -827,7 +827,7 @@ export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: nu
  * @summary Retrieve shipping rates for an order
  * @request GET:/api/v2.1/orders/{id}/shipping_rates
  */
-export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOrder[]>;
+export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesShippingRate[]>;
 /**
  * @description Get the shipping weight for an order
  *

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

@@ -1394,131 +1394,131 @@ export interface ApiV2EntitiesFilterSet {
 /** V2 */
 export interface ApiV2EntitiesFilterSetOptions {
     bulk_actions?: {
-        location?: object;
-        account_transaction?: object;
-        shipping_method?: object;
         location_audit?: object;
-        consumer_return?: object;
-        order_batch?: object;
-        incident?: object;
-        item?: object;
-        warehouse?: object;
-        carrier_account?: object;
+        account_transaction?: object;
         order?: object;
-        location_transfer?: object;
+        user?: object;
+        item?: object;
         shipnotice?: object;
+        location?: object;
         project?: object;
-        manifest?: object;
-        user?: object;
+        warehouse?: object;
+        shipping_method?: object;
         meta_key?: object;
+        order_batch?: object;
+        location_transfer?: object;
+        carrier_account?: object;
+        incident?: object;
+        manifest?: object;
+        consumer_return?: object;
     };
     exporters?: {
-        location?: object;
+        location_audit?: object;
         account_transaction?: object;
+        order?: object;
+        item?: object;
+        shipnotice?: object;
+        location?: object;
         shipping_method?: object;
-        location_audit?: object;
-        document?: object;
-        consumer_return?: object;
+        location_transfer?: object;
         customer?: object;
         incident?: object;
-        item?: object;
-        order?: object;
-        location_transfer?: object;
-        shipnotice?: object;
+        document?: object;
+        consumer_return?: object;
     };
     filters?: {
-        location?: any[];
+        location_audit?: any[];
         account_transaction?: any[];
+        order?: any[];
+        user?: any[];
+        item?: any[];
+        shipnotice?: any[];
+        location?: any[];
+        partner?: any[];
+        project?: any[];
+        warehouse?: any[];
         shipping_method?: any[];
-        location_audit?: any[];
-        document?: any[];
-        transaction?: any[];
-        consumer_return?: any[];
+        meta_key?: any[];
         order_batch?: any[];
+        location_transfer?: any[];
         customer?: any[];
-        incident?: any[];
-        item?: any[];
-        warehouse?: any[];
         carrier_account?: any[];
-        order?: any[];
-        location_transfer?: any[];
-        shipnotice?: any[];
-        project?: any[];
-        partner?: any[];
+        incident?: any[];
+        document?: any[];
         manifest?: any[];
-        user?: any[];
-        meta_key?: any[];
+        consumer_return?: any[];
+        transaction?: any[];
     };
     importers?: {
-        document?: any[];
-        consumer_return?: any[];
-        item?: any[];
         order?: any[];
-        location_transfer?: any[];
+        item?: any[];
         shipnotice?: any[];
+        location_transfer?: any[];
+        document?: any[];
+        consumer_return?: any[];
     };
     required_scopes?: {
-        location?: any[];
+        location_audit?: any[];
         account_transaction?: any[];
+        order?: any[];
+        user?: any[];
+        item?: any[];
+        shipnotice?: any[];
+        location?: any[];
+        partner?: any[];
+        project?: any[];
+        warehouse?: any[];
         shipping_method?: any[];
-        location_audit?: any[];
-        document?: any[];
-        transaction?: any[];
-        consumer_return?: any[];
+        meta_key?: any[];
         order_batch?: any[];
+        location_transfer?: any[];
         customer?: any[];
-        incident?: any[];
-        item?: any[];
-        warehouse?: any[];
         carrier_account?: any[];
-        order?: any[];
-        location_transfer?: any[];
-        shipnotice?: any[];
-        project?: any[];
-        partner?: any[];
+        incident?: any[];
+        document?: any[];
         manifest?: any[];
-        user?: any[];
-        meta_key?: any[];
+        consumer_return?: any[];
+        transaction?: any[];
     };
     resource_actions?: {
-        location?: object;
+        location_audit?: object;
         account_transaction?: object;
+        order?: object;
+        user?: object;
+        item?: object;
+        shipnotice?: object;
+        location?: object;
+        project?: object;
+        warehouse?: object;
         shipping_method?: object;
-        location_audit?: object;
-        document?: object;
-        consumer_return?: object;
+        meta_key?: object;
         order_batch?: object;
+        location_transfer?: object;
         customer?: object;
-        incident?: object;
-        item?: object;
-        warehouse?: object;
         carrier_account?: object;
-        order?: object;
-        location_transfer?: object;
-        shipnotice?: object;
-        project?: object;
+        incident?: object;
+        document?: object;
         manifest?: object;
-        user?: object;
-        meta_key?: object;
+        consumer_return?: object;
     };
     rule_actions?: {
         batching?: object;
-        routing?: object;
         packing?: object;
+        replenishment?: object;
         backstock?: object;
         carrier_account?: object;
-        replenishment?: object;
+        routing?: object;
         shipping_method?: object;
     };
     traits?: {
-        consumer_return?: any[];
-        order_batch?: any[];
-        customer?: any[];
-        item?: any[];
-        warehouse?: any[];
         order?: any[];
-        shipnotice?: any[];
         user?: any[];
+        item?: any[];
+        shipnotice?: any[];
+        warehouse?: any[];
+        order_batch?: any[];
+        customer?: any[];
+        consumer_return?: any[];
     };
 }
 /** V2 */
@@ -5087,6 +5087,50 @@ export interface ApiV2EntitiesShippingMethod {
     updated_at?: string;
 }
 /** V2 */
+export interface ApiV2EntitiesShippingRate {
+    /** is the shipping method avoided? */
+    avoided?: boolean;
+    /** the shipping method carrier (FedEx, UPS, etc) */
+    carrier?: string;
+    /**
+     * the shipping rate cost
+     * @format float
+     */
+    cost?: number;
+    /**
+     * estimated delivery days
+     * @format int32
+     */
+    delivery_days?: number;
+    /** the shipping method service description (Next Day Air, Ground, etc) */
+    description?: string;
+    /** for Whiplash Cheapest methods, this is the current method we would ship */
+    determined?: boolean;
+    /** is the shipping method expedited? */
+    expedited?: boolean;
+    /** the shipping method extended description */
+    extended_description?: string;
+    /** is the shipping method flat rate? */
+    flat_rate?: boolean;
+    /**
+     * the shipping method id
+     * @format int32
+     */
+    id?: number;
+    /** is the shipping method international? */
+    international?: boolean;
+    /** does the shipping method support multi-parcel shipments? */
+    multi_parcel?: boolean;
+    /** nicely formatted carrier and service */
+    name?: string;
+    /** Standard Carrier Alpha Code */
+    scac?: string;
+    /** the shipping method service (NextDayAir, Ground, etc) */
+    service?: string;
+    /** is the shipping method trackable? */
+    trackable?: boolean;
+}
+/** V2 */
 export interface ApiV2EntitiesShop {
     /** accepts payment statuses */
     accepts_payment_statuses?: string | null;
@@ -10163,6 +10207,50 @@ export interface ApiV21EntitiesShippingMethod {
     updated_at?: string;
 }
 /** V3 */
+export interface ApiV21EntitiesShippingRate {
+    /** is the shipping method avoided? */
+    avoided?: boolean;
+    /** the shipping method carrier (FedEx, UPS, etc) */
+    carrier?: string;
+    /**
+     * the shipping rate cost
+     * @format float
+     */
+    cost?: number;
+    /**
+     * estimated delivery days
+     * @format int32
+     */
+    delivery_days?: number;
+    /** the shipping method service description (Next Day Air, Ground, etc) */
+    description?: string;
+    /** for Whiplash Cheapest methods, this is the current method we would ship */
+    determined?: boolean;
+    /** is the shipping method expedited? */
+    expedited?: boolean;
+    /** the shipping method extended description */
+    extended_description?: string;
+    /** is the shipping method flat rate? */
+    flat_rate?: boolean;
+    /**
+     * the shipping method id
+     * @format int32
+     */
+    id?: number;
+    /** is the shipping method international? */
+    international?: boolean;
+    /** does the shipping method support multi-parcel shipments? */
+    multi_parcel?: boolean;
+    /** nicely formatted carrier and service */
+    name?: string;
+    /** Standard Carrier Alpha Code */
+    scac?: string;
+    /** the shipping method service (NextDayAir, Ground, etc) */
+    service?: string;
+    /** is the shipping method trackable? */
+    trackable?: boolean;
+}
+/** V3 */
 export interface ApiV21EntitiesShop {
     /** accepts payment statuses */
     accepts_payment_statuses?: string | null;
@@ -31964,11 +32052,11 @@ export declare enum PostApiV21RulesRequestState {
 /** Which type of rule this is */
 export declare enum PostApiV21RulesRequestType {
     BatchingRule = "BatchingRule",
-    RoutingRule = "RoutingRule",
     PackingRule = "PackingRule",
+    ReplenishmentRule = "ReplenishmentRule",
     BackstockRule = "BackstockRule",
     CarrierAccountRule = "CarrierAccountRule",
-    ReplenishmentRule = "ReplenishmentRule",
+    RoutingRule = "RoutingRule",
     ShippingMethodRule = "ShippingMethodRule"
 }
 /** locale for language settings */
@@ -32769,11 +32857,11 @@ export declare enum PostApiV2RulesRequestState {
 /** Which type of rule this is */
 export declare enum PostApiV2RulesRequestType {
     BatchingRule = "BatchingRule",
-    RoutingRule = "RoutingRule",
     PackingRule = "PackingRule",
+    ReplenishmentRule = "ReplenishmentRule",
     BackstockRule = "BackstockRule",
     CarrierAccountRule = "CarrierAccountRule",
-    ReplenishmentRule = "ReplenishmentRule",
+    RoutingRule = "RoutingRule",
     ShippingMethodRule = "ShippingMethodRule"
 }
 /** locale for language settings */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whiplashmerch/whiplash-api-client",
-  "version": "3.0.8",
+  "version": "3.0.9",
   "description": "",
   "devDependencies": {},
   "scripts": {