@whiplashmerch/whiplash-api-client 3.2.22 → 3.2.24

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, 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";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Retrieves a list of orders
@@ -423,6 +423,15 @@ export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: num
423
423
  * @request GET:/api/v2/orders/{id}/shipping_weight
424
424
  */
425
425
  export declare const getApiV2OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOrder>;
426
+ /**
427
+ * @description Get suggested items for an order
428
+ *
429
+ * @tags orders
430
+ * @name GetApiV2OrdersIdSuggestedItems
431
+ * @summary Retrieve suggested items for an order
432
+ * @request GET:/api/v2/orders/{id}/suggested_items
433
+ */
434
+ export declare const getApiV2OrdersIdSuggestedItems: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdSuggestedItemsParams, params?: RequestParams) => Promise<ApiV2EntitiesPackingRule[]>;
426
435
  /**
427
436
  * @description Get the specified orders traits
428
437
  *
@@ -873,6 +882,15 @@ export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: nu
873
882
  * @request GET:/api/v2.1/orders/{id}/shipping_weight
874
883
  */
875
884
  export declare const getApiV21OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOrder>;
885
+ /**
886
+ * @description Get suggested items for an order
887
+ *
888
+ * @tags orders
889
+ * @name GetApiV21OrdersIdSuggestedItems
890
+ * @summary Retrieve suggested items for an order
891
+ * @request GET:/api/v2.1/orders/{id}/suggested_items
892
+ */
893
+ export declare const getApiV21OrdersIdSuggestedItems: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdSuggestedItemsParams, params?: RequestParams) => Promise<ApiV21EntitiesPackingRule[]>;
876
894
  /**
877
895
  * @description Get the specified orders traits
878
896
  *
@@ -3753,6 +3753,52 @@ export interface ApiV2EntitiesPackage {
3753
3753
  updated_at?: string | null;
3754
3754
  }
3755
3755
  /** V2 */
3756
+ export interface ApiV2EntitiesPackingRule {
3757
+ /** is the rule currently active? */
3758
+ active?: boolean | null;
3759
+ /** arguments, as JSON hash */
3760
+ args?: string | null;
3761
+ /**
3762
+ * rule creation date
3763
+ * @format date-time
3764
+ */
3765
+ created_at?: string;
3766
+ /**
3767
+ * the customer_id of the rule
3768
+ * @format int32
3769
+ */
3770
+ customer_id?: number | null;
3771
+ /** title/description of rule */
3772
+ description?: string | null;
3773
+ filter_set?: ApiV2EntitiesFilterSet;
3774
+ /**
3775
+ * the rule id
3776
+ * @format int32
3777
+ */
3778
+ id?: number;
3779
+ /** method to apply to object */
3780
+ method?: string | null;
3781
+ /**
3782
+ * the priority of the rule
3783
+ * @format int32
3784
+ */
3785
+ priority?: number | null;
3786
+ /** the type of rule */
3787
+ type?: string | null;
3788
+ /**
3789
+ * rule last updated date
3790
+ * @format date-time
3791
+ */
3792
+ updated_at?: string;
3793
+ /**
3794
+ * the rule warehouse id
3795
+ * @format int32
3796
+ */
3797
+ warehouse_id?: number | null;
3798
+ /** apply rule while Item to be added has inventory? */
3799
+ while_supplies_last?: boolean | null;
3800
+ }
3801
+ /** V2 */
3756
3802
  export interface ApiV2EntitiesPackingslipsArray {
3757
3803
  packingslips_array?: object;
3758
3804
  }
@@ -8808,6 +8854,51 @@ export interface ApiV21EntitiesPackage {
8808
8854
  updated_at?: string | null;
8809
8855
  }
8810
8856
  /** V3 */
8857
+ export interface ApiV21EntitiesPackingRule {
8858
+ /** is the rule currently active? */
8859
+ active?: boolean | null;
8860
+ /** arguments, as JSON hash */
8861
+ args?: string | null;
8862
+ /**
8863
+ * rule creation date
8864
+ * @format date-time
8865
+ */
8866
+ created_at?: string;
8867
+ /**
8868
+ * the customer_id of the rule
8869
+ * @format int32
8870
+ */
8871
+ customer_id?: number | null;
8872
+ /** title/description of rule */
8873
+ description?: string | null;
8874
+ /**
8875
+ * the rule id
8876
+ * @format int32
8877
+ */
8878
+ id?: number;
8879
+ /** method to apply to object */
8880
+ method?: string | null;
8881
+ /**
8882
+ * the priority of the rule
8883
+ * @format int32
8884
+ */
8885
+ priority?: number | null;
8886
+ /** the type of rule */
8887
+ type?: string | null;
8888
+ /**
8889
+ * rule last updated date
8890
+ * @format date-time
8891
+ */
8892
+ updated_at?: string;
8893
+ /**
8894
+ * the rule warehouse id
8895
+ * @format int32
8896
+ */
8897
+ warehouse_id?: number | null;
8898
+ /** apply rule while Item to be added has inventory? */
8899
+ while_supplies_last?: boolean | null;
8900
+ }
8901
+ /** V3 */
8811
8902
  export interface ApiV21EntitiesPackingslipsArray {
8812
8903
  packingslips_array?: object;
8813
8904
  }
@@ -12408,6 +12499,29 @@ export interface GetApiV21OrdersIdShippingDocumentsParams {
12408
12499
  page_links?: boolean;
12409
12500
  id: number;
12410
12501
  }
12502
+ export interface GetApiV21OrdersIdSuggestedItemsParams {
12503
+ /** JSON search string like {"attribute_eq": "Term"} */
12504
+ search?: string;
12505
+ /** Comma-separated list of fields to include in the response */
12506
+ fields?: string;
12507
+ /** A list of sort options (ex: name asc,created_at desc) */
12508
+ sort?: string;
12509
+ /**
12510
+ * Page of results to fetch
12511
+ * @format int32
12512
+ */
12513
+ page?: number;
12514
+ /**
12515
+ * Number of results to return per page
12516
+ * @format int32
12517
+ */
12518
+ per_page?: number;
12519
+ /** Include total count of results */
12520
+ page_total?: boolean;
12521
+ /** Include prev/next links in response headers */
12522
+ page_links?: boolean;
12523
+ id: number;
12524
+ }
12411
12525
  export interface GetApiV21OrdersIdTraitsParams {
12412
12526
  /** List of traits to return */
12413
12527
  traits: string;
@@ -15233,6 +15347,29 @@ export interface GetApiV2OrdersIdShippingDocumentsParams {
15233
15347
  page_links?: boolean;
15234
15348
  id: number;
15235
15349
  }
15350
+ export interface GetApiV2OrdersIdSuggestedItemsParams {
15351
+ /** JSON search string like {"attribute_eq": "Term"} */
15352
+ search?: string;
15353
+ /** Comma-separated list of fields to include in the response */
15354
+ fields?: string;
15355
+ /** A list of sort options (ex: name asc,created_at desc) */
15356
+ sort?: string;
15357
+ /**
15358
+ * Page of results to fetch
15359
+ * @format int32
15360
+ */
15361
+ page?: number;
15362
+ /**
15363
+ * Number of results to return per page
15364
+ * @format int32
15365
+ */
15366
+ per_page?: number;
15367
+ /** Include total count of results */
15368
+ page_total?: boolean;
15369
+ /** Include prev/next links in response headers */
15370
+ page_links?: boolean;
15371
+ id: number;
15372
+ }
15236
15373
  export interface GetApiV2OrdersIdTraitsParams {
15237
15374
  /** List of traits to return */
15238
15375
  traits: string;
@@ -55,6 +55,11 @@ export interface RelatedObjectConfiguration {
55
55
  * When loading indirect related objects whether to set the `entityKey` as an array or single entity, defaults to false.
56
56
  */
57
57
  single?: boolean;
58
+ /**
59
+ * Optional additional Ransack-style search criteria merged into the query used to fetch the related
60
+ * objects. Useful for scoping polymorphic relations. @example `{ owner_type_eq: 'ShipnoticeItem' }`
61
+ */
62
+ searchCriteria?: object;
58
63
  }
59
64
  /**
60
65
  * Function used to load `RelationType.Direct` related objects
@@ -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.22",
3
+ "version": "3.2.24",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {