@whiplashmerch/whiplash-api-client 3.2.23 → 3.2.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,4 @@
1
- import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdShippingDocumentsParams, 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";
1
+ 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";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Retrieves a list of orders
@@ -315,6 +315,15 @@ export declare const postApiV2OrdersIdOrderItems: (client: HttpClient, id: numbe
315
315
  * @request GET:/api/v2/orders/{id}/order_items/count
316
316
  */
317
317
  export declare const getApiV2OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
318
+ /**
319
+ * @description Get inventory info for a list of order items
320
+ *
321
+ * @tags orders
322
+ * @name GetApiV2OrdersIdOrderItemsInventoryInfo
323
+ * @summary List inventory info for order items
324
+ * @request GET:/api/v2/orders/{id}/order_items_inventory_info
325
+ */
326
+ export declare const getApiV2OrdersIdOrderItemsInventoryInfo: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdOrderItemsInventoryInfoParams, params?: RequestParams) => Promise<ApiV2EntitiesOrderItemInventoryInfo[]>;
318
327
  /**
319
328
  * @description Get the originator for a(n) Item
320
329
  *
@@ -423,6 +432,15 @@ export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: num
423
432
  * @request GET:/api/v2/orders/{id}/shipping_weight
424
433
  */
425
434
  export declare const getApiV2OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOrder>;
435
+ /**
436
+ * @description Get suggested items for an order
437
+ *
438
+ * @tags orders
439
+ * @name GetApiV2OrdersIdSuggestedItems
440
+ * @summary Retrieve suggested items for an order
441
+ * @request GET:/api/v2/orders/{id}/suggested_items
442
+ */
443
+ export declare const getApiV2OrdersIdSuggestedItems: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdSuggestedItemsParams, params?: RequestParams) => Promise<ApiV2EntitiesPackingRule[]>;
426
444
  /**
427
445
  * @description Get the specified orders traits
428
446
  *
@@ -765,6 +783,15 @@ export declare const postApiV21OrdersIdOrderItems: (client: HttpClient, id: numb
765
783
  * @request GET:/api/v2.1/orders/{id}/order_items/count
766
784
  */
767
785
  export declare const getApiV21OrdersIdOrderItemsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
786
+ /**
787
+ * @description Get inventory info for a list of order items
788
+ *
789
+ * @tags orders
790
+ * @name GetApiV21OrdersIdOrderItemsInventoryInfo
791
+ * @summary List inventory info for order items
792
+ * @request GET:/api/v2.1/orders/{id}/order_items_inventory_info
793
+ */
794
+ export declare const getApiV21OrdersIdOrderItemsInventoryInfo: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsInventoryInfoParams, params?: RequestParams) => Promise<ApiV21EntitiesOrderItemInventoryInfo[]>;
768
795
  /**
769
796
  * @description Get the originator for a(n) Item
770
797
  *
@@ -873,6 +900,15 @@ export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: nu
873
900
  * @request GET:/api/v2.1/orders/{id}/shipping_weight
874
901
  */
875
902
  export declare const getApiV21OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOrder>;
903
+ /**
904
+ * @description Get suggested items for an order
905
+ *
906
+ * @tags orders
907
+ * @name GetApiV21OrdersIdSuggestedItems
908
+ * @summary Retrieve suggested items for an order
909
+ * @request GET:/api/v2.1/orders/{id}/suggested_items
910
+ */
911
+ export declare const getApiV21OrdersIdSuggestedItems: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdSuggestedItemsParams, params?: RequestParams) => Promise<ApiV21EntitiesPackingRule[]>;
876
912
  /**
877
913
  * @description Get the specified orders traits
878
914
  *
@@ -3439,6 +3439,27 @@ export interface ApiV2EntitiesOrderItem {
3439
3439
  wholesale_item?: ApiV2EntitiesWholesaleItem;
3440
3440
  }
3441
3441
  /** V2 */
3442
+ export interface ApiV2EntitiesOrderItemInventoryInfo {
3443
+ /** does backstock quantity exceeds the order item quantity */
3444
+ backstock_available?: boolean;
3445
+ /** does the order_item belong to a multi-warehouse customer and have inventory in another warehouse */
3446
+ has_inventory_in_other_warehouses?: boolean;
3447
+ /**
3448
+ * The order item ID
3449
+ * @format int32
3450
+ */
3451
+ id?: number;
3452
+ /** is pickable quantity less than the order item quantity */
3453
+ insufficient_inventory?: boolean;
3454
+ /**
3455
+ * The item ID
3456
+ * @format int32
3457
+ */
3458
+ item_id?: number;
3459
+ /** does the item have negative total inventory */
3460
+ negative_inventory?: boolean;
3461
+ }
3462
+ /** V2 */
3442
3463
  export interface ApiV2EntitiesOrderItemLotMap {
3443
3464
  /** is this item available? */
3444
3465
  available?: boolean;
@@ -3753,6 +3774,52 @@ export interface ApiV2EntitiesPackage {
3753
3774
  updated_at?: string | null;
3754
3775
  }
3755
3776
  /** V2 */
3777
+ export interface ApiV2EntitiesPackingRule {
3778
+ /** is the rule currently active? */
3779
+ active?: boolean | null;
3780
+ /** arguments, as JSON hash */
3781
+ args?: string | null;
3782
+ /**
3783
+ * rule creation date
3784
+ * @format date-time
3785
+ */
3786
+ created_at?: string;
3787
+ /**
3788
+ * the customer_id of the rule
3789
+ * @format int32
3790
+ */
3791
+ customer_id?: number | null;
3792
+ /** title/description of rule */
3793
+ description?: string | null;
3794
+ filter_set?: ApiV2EntitiesFilterSet;
3795
+ /**
3796
+ * the rule id
3797
+ * @format int32
3798
+ */
3799
+ id?: number;
3800
+ /** method to apply to object */
3801
+ method?: string | null;
3802
+ /**
3803
+ * the priority of the rule
3804
+ * @format int32
3805
+ */
3806
+ priority?: number | null;
3807
+ /** the type of rule */
3808
+ type?: string | null;
3809
+ /**
3810
+ * rule last updated date
3811
+ * @format date-time
3812
+ */
3813
+ updated_at?: string;
3814
+ /**
3815
+ * the rule warehouse id
3816
+ * @format int32
3817
+ */
3818
+ warehouse_id?: number | null;
3819
+ /** apply rule while Item to be added has inventory? */
3820
+ while_supplies_last?: boolean | null;
3821
+ }
3822
+ /** V2 */
3756
3823
  export interface ApiV2EntitiesPackingslipsArray {
3757
3824
  packingslips_array?: object;
3758
3825
  }
@@ -8513,6 +8580,27 @@ export interface ApiV21EntitiesOrderItem {
8513
8580
  wholesale_item?: ApiV21EntitiesWholesaleItem;
8514
8581
  }
8515
8582
  /** V3 */
8583
+ export interface ApiV21EntitiesOrderItemInventoryInfo {
8584
+ /** does backstock quantity exceeds the order item quantity */
8585
+ backstock_available?: boolean;
8586
+ /** does the order_item belong to a multi-warehouse customer and have inventory in another warehouse */
8587
+ has_inventory_in_other_warehouses?: boolean;
8588
+ /**
8589
+ * The order item ID
8590
+ * @format int32
8591
+ */
8592
+ id?: number;
8593
+ /** is pickable quantity less than the order item quantity */
8594
+ insufficient_inventory?: boolean;
8595
+ /**
8596
+ * The item ID
8597
+ * @format int32
8598
+ */
8599
+ item_id?: number;
8600
+ /** does the item have negative total inventory */
8601
+ negative_inventory?: boolean;
8602
+ }
8603
+ /** V3 */
8516
8604
  export interface ApiV21EntitiesOrderItemLotMap {
8517
8605
  /** is this item available? */
8518
8606
  available?: boolean;
@@ -8808,6 +8896,51 @@ export interface ApiV21EntitiesPackage {
8808
8896
  updated_at?: string | null;
8809
8897
  }
8810
8898
  /** V3 */
8899
+ export interface ApiV21EntitiesPackingRule {
8900
+ /** is the rule currently active? */
8901
+ active?: boolean | null;
8902
+ /** arguments, as JSON hash */
8903
+ args?: string | null;
8904
+ /**
8905
+ * rule creation date
8906
+ * @format date-time
8907
+ */
8908
+ created_at?: string;
8909
+ /**
8910
+ * the customer_id of the rule
8911
+ * @format int32
8912
+ */
8913
+ customer_id?: number | null;
8914
+ /** title/description of rule */
8915
+ description?: string | null;
8916
+ /**
8917
+ * the rule id
8918
+ * @format int32
8919
+ */
8920
+ id?: number;
8921
+ /** method to apply to object */
8922
+ method?: string | null;
8923
+ /**
8924
+ * the priority of the rule
8925
+ * @format int32
8926
+ */
8927
+ priority?: number | null;
8928
+ /** the type of rule */
8929
+ type?: string | null;
8930
+ /**
8931
+ * rule last updated date
8932
+ * @format date-time
8933
+ */
8934
+ updated_at?: string;
8935
+ /**
8936
+ * the rule warehouse id
8937
+ * @format int32
8938
+ */
8939
+ warehouse_id?: number | null;
8940
+ /** apply rule while Item to be added has inventory? */
8941
+ while_supplies_last?: boolean | null;
8942
+ }
8943
+ /** V3 */
8811
8944
  export interface ApiV21EntitiesPackingslipsArray {
8812
8945
  packingslips_array?: object;
8813
8946
  }
@@ -12334,6 +12467,25 @@ export interface GetApiV21OrdersIdOrderItemsCountParams {
12334
12467
  search?: string;
12335
12468
  id: number;
12336
12469
  }
12470
+ export interface GetApiV21OrdersIdOrderItemsInventoryInfoParams {
12471
+ /** List of order item IDs */
12472
+ order_item_ids?: number[];
12473
+ /**
12474
+ * Page of results to fetch
12475
+ * @format int32
12476
+ */
12477
+ page?: number;
12478
+ /**
12479
+ * Number of results to return per page
12480
+ * @format int32
12481
+ */
12482
+ per_page?: number;
12483
+ /** Include total count of results */
12484
+ page_total?: boolean;
12485
+ /** Include prev/next links in response headers */
12486
+ page_links?: boolean;
12487
+ id: number;
12488
+ }
12337
12489
  export interface GetApiV21OrdersIdOrderItemsParams {
12338
12490
  /** JSON search string like {"attribute_eq": "Term"} */
12339
12491
  search?: string;
@@ -12408,6 +12560,29 @@ export interface GetApiV21OrdersIdShippingDocumentsParams {
12408
12560
  page_links?: boolean;
12409
12561
  id: number;
12410
12562
  }
12563
+ export interface GetApiV21OrdersIdSuggestedItemsParams {
12564
+ /** JSON search string like {"attribute_eq": "Term"} */
12565
+ search?: string;
12566
+ /** Comma-separated list of fields to include in the response */
12567
+ fields?: string;
12568
+ /** A list of sort options (ex: name asc,created_at desc) */
12569
+ sort?: string;
12570
+ /**
12571
+ * Page of results to fetch
12572
+ * @format int32
12573
+ */
12574
+ page?: number;
12575
+ /**
12576
+ * Number of results to return per page
12577
+ * @format int32
12578
+ */
12579
+ per_page?: number;
12580
+ /** Include total count of results */
12581
+ page_total?: boolean;
12582
+ /** Include prev/next links in response headers */
12583
+ page_links?: boolean;
12584
+ id: number;
12585
+ }
12411
12586
  export interface GetApiV21OrdersIdTraitsParams {
12412
12587
  /** List of traits to return */
12413
12588
  traits: string;
@@ -15159,6 +15334,25 @@ export interface GetApiV2OrdersIdOrderItemsCountParams {
15159
15334
  search?: string;
15160
15335
  id: number;
15161
15336
  }
15337
+ export interface GetApiV2OrdersIdOrderItemsInventoryInfoParams {
15338
+ /** List of order item IDs */
15339
+ order_item_ids?: number[];
15340
+ /**
15341
+ * Page of results to fetch
15342
+ * @format int32
15343
+ */
15344
+ page?: number;
15345
+ /**
15346
+ * Number of results to return per page
15347
+ * @format int32
15348
+ */
15349
+ per_page?: number;
15350
+ /** Include total count of results */
15351
+ page_total?: boolean;
15352
+ /** Include prev/next links in response headers */
15353
+ page_links?: boolean;
15354
+ id: number;
15355
+ }
15162
15356
  export interface GetApiV2OrdersIdOrderItemsParams {
15163
15357
  /** JSON search string like {"attribute_eq": "Term"} */
15164
15358
  search?: string;
@@ -15233,6 +15427,29 @@ export interface GetApiV2OrdersIdShippingDocumentsParams {
15233
15427
  page_links?: boolean;
15234
15428
  id: number;
15235
15429
  }
15430
+ export interface GetApiV2OrdersIdSuggestedItemsParams {
15431
+ /** JSON search string like {"attribute_eq": "Term"} */
15432
+ search?: string;
15433
+ /** Comma-separated list of fields to include in the response */
15434
+ fields?: string;
15435
+ /** A list of sort options (ex: name asc,created_at desc) */
15436
+ sort?: string;
15437
+ /**
15438
+ * Page of results to fetch
15439
+ * @format int32
15440
+ */
15441
+ page?: number;
15442
+ /**
15443
+ * Number of results to return per page
15444
+ * @format int32
15445
+ */
15446
+ per_page?: number;
15447
+ /** Include total count of results */
15448
+ page_total?: boolean;
15449
+ /** Include prev/next links in response headers */
15450
+ page_links?: boolean;
15451
+ id: number;
15452
+ }
15236
15453
  export interface GetApiV2OrdersIdTraitsParams {
15237
15454
  /** List of traits to return */
15238
15455
  traits: string;
@@ -18,6 +18,7 @@ import {
18
18
  ApiV21EntitiesOrderDocument,
19
19
  ApiV21EntitiesOrderEvent,
20
20
  ApiV21EntitiesOrderItem,
21
+ ApiV21EntitiesPackingRule,
21
22
  ApiV21EntitiesPostResponse,
22
23
  ApiV21EntitiesResult,
23
24
  ApiV21EntitiesSerialNumber,
@@ -29,6 +30,7 @@ import {
29
30
  ApiV2EntitiesOrderDocument,
30
31
  ApiV2EntitiesOrderEvent,
31
32
  ApiV2EntitiesOrderItem,
33
+ ApiV2EntitiesPackingRule,
32
34
  ApiV2EntitiesResult,
33
35
  ApiV2EntitiesSerialNumber,
34
36
  ApiV2EntitiesShippingDocument,
@@ -42,6 +44,7 @@ import {
42
44
  GetApiV21OrdersIdOrderItemsCountParams,
43
45
  GetApiV21OrdersIdOrderItemsParams,
44
46
  GetApiV21OrdersIdShippingDocumentsParams,
47
+ GetApiV21OrdersIdSuggestedItemsParams,
45
48
  GetApiV21OrdersParams,
46
49
  GetApiV2OrdersCountParams,
47
50
  GetApiV2OrdersIdEventsCountParams,
@@ -52,6 +55,7 @@ import {
52
55
  GetApiV2OrdersIdOrderItemsCountParams,
53
56
  GetApiV2OrdersIdOrderItemsParams,
54
57
  GetApiV2OrdersIdShippingDocumentsParams,
58
+ GetApiV2OrdersIdSuggestedItemsParams,
55
59
  GetApiV2OrdersParams,
56
60
  PostApiV21OrdersBulkRequest,
57
61
  PostApiV21OrdersIdOrderDocumentsRequest,
@@ -494,6 +498,27 @@ export const getApiV2OrdersIdShippingDocuments = (
494
498
  ...params,
495
499
  });
496
500
  };
501
+ /**
502
+ * @description Get suggested items for an order
503
+ *
504
+ * @tags orders
505
+ * @name GetApiV2OrdersIdSuggestedItems
506
+ * @summary Retrieve suggested items for an order
507
+ * @request GET:/api/v2/orders/{id}/suggested_items
508
+ */
509
+ export const getApiV2OrdersIdSuggestedItems = (
510
+ client: HttpClient,
511
+ { id, ...query }: GetApiV2OrdersIdSuggestedItemsParams,
512
+ params: RequestParams = {},
513
+ ) => {
514
+ return client.request<ApiV2EntitiesPackingRule[], ApiSharedEntitiesApiError>({
515
+ path: `/api/v2/orders/${id}/suggested_items`,
516
+ method: "GET",
517
+ query: query,
518
+ format: "json",
519
+ ...params,
520
+ });
521
+ };
497
522
  /**
498
523
  * @description get the Wholesale object for an order
499
524
  *
@@ -932,6 +957,27 @@ export const getApiV21OrdersIdShippingDocuments = (
932
957
  ...params,
933
958
  });
934
959
  };
960
+ /**
961
+ * @description Get suggested items for an order
962
+ *
963
+ * @tags orders
964
+ * @name GetApiV21OrdersIdSuggestedItems
965
+ * @summary Retrieve suggested items for an order
966
+ * @request GET:/api/v2.1/orders/{id}/suggested_items
967
+ */
968
+ export const getApiV21OrdersIdSuggestedItems = (
969
+ client: HttpClient,
970
+ { id, ...query }: GetApiV21OrdersIdSuggestedItemsParams,
971
+ params: RequestParams = {},
972
+ ) => {
973
+ return client.request<ApiV21EntitiesPackingRule[], ApiSharedEntitiesApiError>({
974
+ path: `/api/v2.1/orders/${id}/suggested_items`,
975
+ method: "GET",
976
+ query: query,
977
+ format: "json",
978
+ ...params,
979
+ });
980
+ };
935
981
  /**
936
982
  * @description get the Wholesale object for an order
937
983
  *
@@ -785,6 +785,63 @@ export interface ApiV2EntitiesDocument {
785
785
  user_name?: string;
786
786
  }
787
787
 
788
+ /** V2 */
789
+ export interface ApiV2EntitiesFilterSet {
790
+ /** filter set access_token */
791
+ access_token?: string | null;
792
+ /**
793
+ * the filter set ancestor (Document, Rule, FilterSet) user or customer id
794
+ * @format int32
795
+ */
796
+ ancestor_saved_by_id?: number;
797
+ /** the filter set ancestor type (Customer, User) */
798
+ ancestor_saved_by_type?: string;
799
+ /**
800
+ * the filter set creation date and time
801
+ * @format date-time
802
+ */
803
+ created_at?: string;
804
+ /** Default filter set? */
805
+ default?: boolean | null;
806
+ /** filter set description. */
807
+ description?: string | null;
808
+ /** filter set favorited? */
809
+ favorite?: boolean | null;
810
+ /** filter set filters as stringified JSON (ex: "[{\"search_id\":\"destination\",\"search_name\":\"State|CO\",\"shipping_state_eq\":\"CO\"}]"). */
811
+ filters?: string | null;
812
+ /**
813
+ * the filter set id
814
+ * @format int32
815
+ */
816
+ id?: number;
817
+ /** filter set name. */
818
+ name?: string | null;
819
+ /**
820
+ * ID of parent filter set
821
+ * @format int32
822
+ */
823
+ parent_id?: number;
824
+ /**
825
+ * the id of the resource that saved the filter set
826
+ * @format int32
827
+ */
828
+ saved_by_id?: number | null;
829
+ /** the type of resource that saved the filter set */
830
+ saved_by_type?: string | null;
831
+ /** Snapshot of a filter set? */
832
+ snapshot?: boolean | null;
833
+ snapshots?: ApiV2EntitiesFilterSet;
834
+ /** the filter set type */
835
+ type?: string | null;
836
+ /**
837
+ * the filter set last update date and time
838
+ * @format date-time
839
+ */
840
+ updated_at?: string;
841
+ /** filter set visible?. */
842
+ visible?: boolean | null;
843
+ }
844
+
788
845
  /** V2 */
789
846
  export interface ApiV2EntitiesItem {
790
847
  /** is the item active? */
@@ -1897,6 +1954,53 @@ export interface ApiV2EntitiesPackage {
1897
1954
  updated_at?: string | null;
1898
1955
  }
1899
1956
 
1957
+ /** V2 */
1958
+ export interface ApiV2EntitiesPackingRule {
1959
+ /** is the rule currently active? */
1960
+ active?: boolean | null;
1961
+ /** arguments, as JSON hash */
1962
+ args?: string | null;
1963
+ /**
1964
+ * rule creation date
1965
+ * @format date-time
1966
+ */
1967
+ created_at?: string;
1968
+ /**
1969
+ * the customer_id of the rule
1970
+ * @format int32
1971
+ */
1972
+ customer_id?: number | null;
1973
+ /** title/description of rule */
1974
+ description?: string | null;
1975
+ filter_set?: ApiV2EntitiesFilterSet;
1976
+ /**
1977
+ * the rule id
1978
+ * @format int32
1979
+ */
1980
+ id?: number;
1981
+ /** method to apply to object */
1982
+ method?: string | null;
1983
+ /**
1984
+ * the priority of the rule
1985
+ * @format int32
1986
+ */
1987
+ priority?: number | null;
1988
+ /** the type of rule */
1989
+ type?: string | null;
1990
+ /**
1991
+ * rule last updated date
1992
+ * @format date-time
1993
+ */
1994
+ updated_at?: string;
1995
+ /**
1996
+ * the rule warehouse id
1997
+ * @format int32
1998
+ */
1999
+ warehouse_id?: number | null;
2000
+ /** apply rule while Item to be added has inventory? */
2001
+ while_supplies_last?: boolean | null;
2002
+ }
2003
+
1900
2004
  /** V2 */
1901
2005
  export interface ApiV2EntitiesProjectTask {
1902
2006
  /** cost per unit, if task has custom label */
@@ -4384,6 +4488,52 @@ export interface ApiV21EntitiesOriginator {
4384
4488
  updated_at?: string;
4385
4489
  }
4386
4490
 
4491
+ /** V3 */
4492
+ export interface ApiV21EntitiesPackingRule {
4493
+ /** is the rule currently active? */
4494
+ active?: boolean | null;
4495
+ /** arguments, as JSON hash */
4496
+ args?: string | null;
4497
+ /**
4498
+ * rule creation date
4499
+ * @format date-time
4500
+ */
4501
+ created_at?: string;
4502
+ /**
4503
+ * the customer_id of the rule
4504
+ * @format int32
4505
+ */
4506
+ customer_id?: number | null;
4507
+ /** title/description of rule */
4508
+ description?: string | null;
4509
+ /**
4510
+ * the rule id
4511
+ * @format int32
4512
+ */
4513
+ id?: number;
4514
+ /** method to apply to object */
4515
+ method?: string | null;
4516
+ /**
4517
+ * the priority of the rule
4518
+ * @format int32
4519
+ */
4520
+ priority?: number | null;
4521
+ /** the type of rule */
4522
+ type?: string | null;
4523
+ /**
4524
+ * rule last updated date
4525
+ * @format date-time
4526
+ */
4527
+ updated_at?: string;
4528
+ /**
4529
+ * the rule warehouse id
4530
+ * @format int32
4531
+ */
4532
+ warehouse_id?: number | null;
4533
+ /** apply rule while Item to be added has inventory? */
4534
+ while_supplies_last?: boolean | null;
4535
+ }
4536
+
4387
4537
  /** V3 */
4388
4538
  export interface ApiV21EntitiesPostResponse {
4389
4539
  /**
@@ -5515,6 +5665,30 @@ export interface GetApiV21OrdersIdShippingDocumentsParams {
5515
5665
  id: number;
5516
5666
  }
5517
5667
 
5668
+ export interface GetApiV21OrdersIdSuggestedItemsParams {
5669
+ /** JSON search string like {"attribute_eq": "Term"} */
5670
+ search?: string;
5671
+ /** Comma-separated list of fields to include in the response */
5672
+ fields?: string;
5673
+ /** A list of sort options (ex: name asc,created_at desc) */
5674
+ sort?: string;
5675
+ /**
5676
+ * Page of results to fetch
5677
+ * @format int32
5678
+ */
5679
+ page?: number;
5680
+ /**
5681
+ * Number of results to return per page
5682
+ * @format int32
5683
+ */
5684
+ per_page?: number;
5685
+ /** Include total count of results */
5686
+ page_total?: boolean;
5687
+ /** Include prev/next links in response headers */
5688
+ page_links?: boolean;
5689
+ id: number;
5690
+ }
5691
+
5518
5692
  export interface GetApiV21OrdersParams {
5519
5693
  /** JSON search string like {"attribute_eq": "Term"} */
5520
5694
  search?: string;
@@ -6207,6 +6381,30 @@ export interface GetApiV2OrdersIdShippingDocumentsParams {
6207
6381
  id: number;
6208
6382
  }
6209
6383
 
6384
+ export interface GetApiV2OrdersIdSuggestedItemsParams {
6385
+ /** JSON search string like {"attribute_eq": "Term"} */
6386
+ search?: string;
6387
+ /** Comma-separated list of fields to include in the response */
6388
+ fields?: string;
6389
+ /** A list of sort options (ex: name asc,created_at desc) */
6390
+ sort?: string;
6391
+ /**
6392
+ * Page of results to fetch
6393
+ * @format int32
6394
+ */
6395
+ page?: number;
6396
+ /**
6397
+ * Number of results to return per page
6398
+ * @format int32
6399
+ */
6400
+ per_page?: number;
6401
+ /** Include total count of results */
6402
+ page_total?: boolean;
6403
+ /** Include prev/next links in response headers */
6404
+ page_links?: boolean;
6405
+ id: number;
6406
+ }
6407
+
6210
6408
  export interface GetApiV2OrdersParams {
6211
6409
  /** JSON search string like {"attribute_eq": "Term"} */
6212
6410
  search?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "3.2.23",
3
+ "version": "3.2.25",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {