@whiplashmerch/whiplash-api-client 3.2.24 → 3.2.25

package/dist/generated/Orders.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPackingRule, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesPackingRule, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdSuggestedItemsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdShippingDocumentsParams, GetApiV2OrdersIdSuggestedItemsParams, 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, ApiV21EntitiesOrderItemInventoryInfo, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPackingRule, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemInventoryInfo, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesPackingRule, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsInventoryInfoParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdSuggestedItemsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsInventoryInfoParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdShippingDocumentsParams, GetApiV2OrdersIdSuggestedItemsParams, 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
@@ -315,6 +315,15 @@ export declare const postApiV2OrdersIdOrderItems: (client: HttpClient, id: numbe
  * @request GET:/api/v2/orders/{id}/order_items/count
  */
 export declare const getApiV2OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
+/**
+ * @description Get inventory info for a list of order items
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdOrderItemsInventoryInfo
+ * @summary List inventory info for order items
+ * @request GET:/api/v2/orders/{id}/order_items_inventory_info
+ */
+export declare const getApiV2OrdersIdOrderItemsInventoryInfo: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsInventoryInfoParams, params?: RequestParams) => Promise<ApiV2EntitiesOrderItemInventoryInfo[]>;
 /**
  * @description Get the originator for a(n) Item
  *
@@ -774,6 +783,15 @@ export declare const postApiV21OrdersIdOrderItems: (client: HttpClient, id: numb
  * @request GET:/api/v2.1/orders/{id}/order_items/count
  */
 export declare const getApiV21OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
+/**
+ * @description Get inventory info for a list of order items
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdOrderItemsInventoryInfo
+ * @summary List inventory info for order items
+ * @request GET:/api/v2.1/orders/{id}/order_items_inventory_info
+ */
+export declare const getApiV21OrdersIdOrderItemsInventoryInfo: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsInventoryInfoParams, params?: RequestParams) => Promise<ApiV21EntitiesOrderItemInventoryInfo[]>;
 /**
  * @description Get the originator for a(n) Item
  *

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

@@ -3439,6 +3439,27 @@ export interface ApiV2EntitiesOrderItem {
     wholesale_item?: ApiV2EntitiesWholesaleItem;
 }
 /** V2 */
+export interface ApiV2EntitiesOrderItemInventoryInfo {
+    /** does backstock quantity exceeds the order item quantity */
+    backstock_available?: boolean;
+    /** does the order_item belong to a multi-warehouse customer and have inventory in another warehouse */
+    has_inventory_in_other_warehouses?: boolean;
+    /**
+     * The order item ID
+     * @format int32
+     */
+    id?: number;
+    /** is pickable quantity less than the order item quantity */
+    insufficient_inventory?: boolean;
+    /**
+     * The item ID
+     * @format int32
+     */
+    item_id?: number;
+    /** does the item have negative total inventory */
+    negative_inventory?: boolean;
+}
+/** V2 */
 export interface ApiV2EntitiesOrderItemLotMap {
     /** is this item available? */
     available?: boolean;
@@ -8559,6 +8580,27 @@ export interface ApiV21EntitiesOrderItem {
     wholesale_item?: ApiV21EntitiesWholesaleItem;
 }
 /** V3 */
+export interface ApiV21EntitiesOrderItemInventoryInfo {
+    /** does backstock quantity exceeds the order item quantity */
+    backstock_available?: boolean;
+    /** does the order_item belong to a multi-warehouse customer and have inventory in another warehouse */
+    has_inventory_in_other_warehouses?: boolean;
+    /**
+     * The order item ID
+     * @format int32
+     */
+    id?: number;
+    /** is pickable quantity less than the order item quantity */
+    insufficient_inventory?: boolean;
+    /**
+     * The item ID
+     * @format int32
+     */
+    item_id?: number;
+    /** does the item have negative total inventory */
+    negative_inventory?: boolean;
+}
+/** V3 */
 export interface ApiV21EntitiesOrderItemLotMap {
     /** is this item available? */
     available?: boolean;
@@ -12425,6 +12467,25 @@ export interface GetApiV21OrdersIdOrderItemsCountParams {
     search?: string;
     id: number;
 }
+export interface GetApiV21OrdersIdOrderItemsInventoryInfoParams {
+    /** List of order item IDs */
+    order_item_ids?: number[];
+    /**
+     * 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 results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV21OrdersIdOrderItemsParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;
@@ -15273,6 +15334,25 @@ export interface GetApiV2OrdersIdOrderItemsCountParams {
     search?: string;
     id: number;
 }
+export interface GetApiV2OrdersIdOrderItemsInventoryInfoParams {
+    /** List of order item IDs */
+    order_item_ids?: number[];
+    /**
+     * 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 results */
+    page_total?: boolean;
+    /** Include prev/next links in response headers */
+    page_links?: boolean;
+    id: number;
+}
 export interface GetApiV2OrdersIdOrderItemsParams {
     /** JSON search string like {"attribute_eq": "Term"} */
     search?: string;

package/package.json

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