@whiplashmerch/whiplash-api-client 3.2.30 → 3.2.34
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.
- package/dist/client.esm.js +79 -42
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/Orders.d.ts +37 -19
- package/dist/generated/data-contracts.d.ts +124 -26
- package/dist/mock-data/v2/order/all.d.ts +1 -0
- package/dist/mock-data/v2_1/order/all.d.ts +1 -0
- package/dist/utils/shipnotices.d.ts +2 -1
- package/generated/Orders.ts +88 -44
- package/generated/data-contracts.ts +114 -14
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
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,
|
|
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, GetApiV21OrdersIdPackingRulesCountParams, GetApiV21OrdersIdPackingRulesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsInventoryInfoParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdPackingRulesCountParams, GetApiV2OrdersIdPackingRulesParams, 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";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Retrieves a list of orders
|
|
@@ -360,6 +360,24 @@ export declare const postApiV2OrdersIdPackages: (client: HttpClient, id: number,
|
|
|
360
360
|
* @request GET:/api/v2/orders/{id}/packages/count
|
|
361
361
|
*/
|
|
362
362
|
export declare const getApiV2OrdersIdPackagesCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdPackagesCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
|
|
363
|
+
/**
|
|
364
|
+
* @description Get packing rules with suggested items
|
|
365
|
+
*
|
|
366
|
+
* @tags orders
|
|
367
|
+
* @name GetApiV2OrdersIdPackingRules
|
|
368
|
+
* @summary Retrieve suggested items for an order
|
|
369
|
+
* @request GET:/api/v2/orders/{id}/packing_rules
|
|
370
|
+
*/
|
|
371
|
+
export declare const getApiV2OrdersIdPackingRules: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdPackingRulesParams, params?: RequestParams) => Promise<ApiV2EntitiesPackingRule[]>;
|
|
372
|
+
/**
|
|
373
|
+
* @description Get count of suggested items for an order
|
|
374
|
+
*
|
|
375
|
+
* @tags orders
|
|
376
|
+
* @name GetApiV2OrdersIdPackingRulesCount
|
|
377
|
+
* @summary Count the suggested items for an order
|
|
378
|
+
* @request GET:/api/v2/orders/{id}/packing_rules/count
|
|
379
|
+
*/
|
|
380
|
+
export declare const getApiV2OrdersIdPackingRulesCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdPackingRulesCountParams, params?: RequestParams) => Promise<ApiV2EntitiesCount>;
|
|
363
381
|
/**
|
|
364
382
|
* @description returns the binary form of an order packingslip pdf
|
|
365
383
|
*
|
|
@@ -432,15 +450,6 @@ export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: num
|
|
|
432
450
|
* @request GET:/api/v2/orders/{id}/shipping_weight
|
|
433
451
|
*/
|
|
434
452
|
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[]>;
|
|
444
453
|
/**
|
|
445
454
|
* @description Get the specified orders traits
|
|
446
455
|
*
|
|
@@ -828,6 +837,24 @@ export declare const postApiV21OrdersIdPackages: (client: HttpClient, id: number
|
|
|
828
837
|
* @request GET:/api/v2.1/orders/{id}/packages/count
|
|
829
838
|
*/
|
|
830
839
|
export declare const getApiV21OrdersIdPackagesCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdPackagesCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
840
|
+
/**
|
|
841
|
+
* @description Get packing rules with suggested items
|
|
842
|
+
*
|
|
843
|
+
* @tags orders
|
|
844
|
+
* @name GetApiV21OrdersIdPackingRules
|
|
845
|
+
* @summary Retrieve suggested items for an order
|
|
846
|
+
* @request GET:/api/v2.1/orders/{id}/packing_rules
|
|
847
|
+
*/
|
|
848
|
+
export declare const getApiV21OrdersIdPackingRules: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdPackingRulesParams, params?: RequestParams) => Promise<ApiV21EntitiesPackingRule[]>;
|
|
849
|
+
/**
|
|
850
|
+
* @description Get count of suggested items for an order
|
|
851
|
+
*
|
|
852
|
+
* @tags orders
|
|
853
|
+
* @name GetApiV21OrdersIdPackingRulesCount
|
|
854
|
+
* @summary Count the suggested items for an order
|
|
855
|
+
* @request GET:/api/v2.1/orders/{id}/packing_rules/count
|
|
856
|
+
*/
|
|
857
|
+
export declare const getApiV21OrdersIdPackingRulesCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdPackingRulesCountParams, params?: RequestParams) => Promise<ApiV21EntitiesCount>;
|
|
831
858
|
/**
|
|
832
859
|
* @description returns the binary form of an order packingslip pdf
|
|
833
860
|
*
|
|
@@ -900,15 +927,6 @@ export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: nu
|
|
|
900
927
|
* @request GET:/api/v2.1/orders/{id}/shipping_weight
|
|
901
928
|
*/
|
|
902
929
|
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[]>;
|
|
912
930
|
/**
|
|
913
931
|
* @description Get the specified orders traits
|
|
914
932
|
*
|
|
@@ -1795,7 +1795,12 @@ export interface ApiV2EntitiesItem {
|
|
|
1795
1795
|
full_description?: string;
|
|
1796
1796
|
/** Garment on hanger? */
|
|
1797
1797
|
goh?: boolean | null;
|
|
1798
|
-
/**
|
|
1798
|
+
/**
|
|
1799
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
1800
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
1801
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
1802
|
+
* (deprecated) is the item hazmat?
|
|
1803
|
+
*/
|
|
1799
1804
|
hazmat?: boolean;
|
|
1800
1805
|
/** hazmat class */
|
|
1801
1806
|
hazmat_type?: ApiV2EntitiesItemHazmatType;
|
|
@@ -3793,10 +3798,15 @@ export interface ApiV2EntitiesPackingRule {
|
|
|
3793
3798
|
description?: string | null;
|
|
3794
3799
|
filter_set?: ApiV2EntitiesFilterSet;
|
|
3795
3800
|
/**
|
|
3796
|
-
* the rule id
|
|
3801
|
+
* the packing rule id
|
|
3797
3802
|
* @format int32
|
|
3798
3803
|
*/
|
|
3799
3804
|
id?: number;
|
|
3805
|
+
/**
|
|
3806
|
+
* the suggested item id
|
|
3807
|
+
* @format int32
|
|
3808
|
+
*/
|
|
3809
|
+
item_id?: number;
|
|
3800
3810
|
/** method to apply to object */
|
|
3801
3811
|
method?: string | null;
|
|
3802
3812
|
/**
|
|
@@ -3804,6 +3814,31 @@ export interface ApiV2EntitiesPackingRule {
|
|
|
3804
3814
|
* @format int32
|
|
3805
3815
|
*/
|
|
3806
3816
|
priority?: number | null;
|
|
3817
|
+
/**
|
|
3818
|
+
* the quantity of the suggested item to add
|
|
3819
|
+
* @format int32
|
|
3820
|
+
*/
|
|
3821
|
+
quantity?: number;
|
|
3822
|
+
/**
|
|
3823
|
+
* the rule dismissal id if the rule has been dismissed
|
|
3824
|
+
* @format int32
|
|
3825
|
+
*/
|
|
3826
|
+
rule_dismissal_id?: number;
|
|
3827
|
+
/** the state of the packing rule (e.g. dismissed) */
|
|
3828
|
+
state?: string;
|
|
3829
|
+
suggested_item?: {
|
|
3830
|
+
/**
|
|
3831
|
+
* the item id
|
|
3832
|
+
* @format int32
|
|
3833
|
+
*/
|
|
3834
|
+
id?: number;
|
|
3835
|
+
/** the item SKU */
|
|
3836
|
+
sku?: string;
|
|
3837
|
+
/** the item title */
|
|
3838
|
+
title?: string;
|
|
3839
|
+
/** the item name */
|
|
3840
|
+
name?: string;
|
|
3841
|
+
};
|
|
3807
3842
|
/** the type of rule */
|
|
3808
3843
|
type?: string | null;
|
|
3809
3844
|
/**
|
|
@@ -5371,8 +5406,6 @@ export interface ApiV2EntitiesTransportationMarkup {
|
|
|
5371
5406
|
export interface ApiV2EntitiesUser {
|
|
5372
5407
|
/** is the user active? */
|
|
5373
5408
|
active?: boolean | null;
|
|
5374
|
-
/** operator auth token (staff only) */
|
|
5375
|
-
auth_token?: string | null;
|
|
5376
5409
|
/** auto create a whiplash email for this user? (staff only) */
|
|
5377
5410
|
create_email?: boolean;
|
|
5378
5411
|
/**
|
|
@@ -7108,7 +7141,12 @@ export interface ApiV21EntitiesItem {
|
|
|
7108
7141
|
full_description?: string;
|
|
7109
7142
|
/** Garment on hanger? */
|
|
7110
7143
|
goh?: boolean | null;
|
|
7111
|
-
/**
|
|
7144
|
+
/**
|
|
7145
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
7146
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
7147
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
7148
|
+
* (deprecated) is the item hazmat?
|
|
7149
|
+
*/
|
|
7112
7150
|
hazmat?: boolean;
|
|
7113
7151
|
/** hazmat class */
|
|
7114
7152
|
hazmat_type?: ApiV21EntitiesItemHazmatType;
|
|
@@ -8967,10 +9005,15 @@ export interface ApiV21EntitiesPackingRule {
|
|
|
8967
9005
|
/** title/description of rule */
|
|
8968
9006
|
description?: string | null;
|
|
8969
9007
|
/**
|
|
8970
|
-
* the rule id
|
|
9008
|
+
* the packing rule id
|
|
8971
9009
|
* @format int32
|
|
8972
9010
|
*/
|
|
8973
9011
|
id?: number;
|
|
9012
|
+
/**
|
|
9013
|
+
* the suggested item id
|
|
9014
|
+
* @format int32
|
|
9015
|
+
*/
|
|
9016
|
+
item_id?: number;
|
|
8974
9017
|
/** method to apply to object */
|
|
8975
9018
|
method?: string | null;
|
|
8976
9019
|
/**
|
|
@@ -8978,6 +9021,31 @@ export interface ApiV21EntitiesPackingRule {
|
|
|
8978
9021
|
* @format int32
|
|
8979
9022
|
*/
|
|
8980
9023
|
priority?: number | null;
|
|
9024
|
+
/**
|
|
9025
|
+
* the quantity of the suggested item to add
|
|
9026
|
+
* @format int32
|
|
9027
|
+
*/
|
|
9028
|
+
quantity?: number;
|
|
9029
|
+
/**
|
|
9030
|
+
* the rule dismissal id if the rule has been dismissed
|
|
9031
|
+
* @format int32
|
|
9032
|
+
*/
|
|
9033
|
+
rule_dismissal_id?: number;
|
|
9034
|
+
/** the state of the packing rule (e.g. dismissed) */
|
|
9035
|
+
state?: string;
|
|
9036
|
+
suggested_item?: {
|
|
9037
|
+
/**
|
|
9038
|
+
* the item id
|
|
9039
|
+
* @format int32
|
|
9040
|
+
*/
|
|
9041
|
+
id?: number;
|
|
9042
|
+
/** the item SKU */
|
|
9043
|
+
sku?: string;
|
|
9044
|
+
/** the item title */
|
|
9045
|
+
title?: string;
|
|
9046
|
+
/** the item name */
|
|
9047
|
+
name?: string;
|
|
9048
|
+
};
|
|
8981
9049
|
/** the type of rule */
|
|
8982
9050
|
type?: string | null;
|
|
8983
9051
|
/**
|
|
@@ -10435,8 +10503,6 @@ export interface ApiV21EntitiesTransportationMarkup {
|
|
|
10435
10503
|
export interface ApiV21EntitiesUser {
|
|
10436
10504
|
/** is the user active? */
|
|
10437
10505
|
active?: boolean | null;
|
|
10438
|
-
/** operator auth token (staff only) */
|
|
10439
|
-
auth_token?: string | null;
|
|
10440
10506
|
/** auto create a whiplash email for this user? (staff only) */
|
|
10441
10507
|
create_email?: boolean;
|
|
10442
10508
|
/**
|
|
@@ -12617,7 +12683,12 @@ export interface GetApiV21OrdersIdPackagesParams {
|
|
|
12617
12683
|
page_links?: boolean;
|
|
12618
12684
|
id: number;
|
|
12619
12685
|
}
|
|
12620
|
-
export interface
|
|
12686
|
+
export interface GetApiV21OrdersIdPackingRulesCountParams {
|
|
12687
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
12688
|
+
search?: string;
|
|
12689
|
+
id: number;
|
|
12690
|
+
}
|
|
12691
|
+
export interface GetApiV21OrdersIdPackingRulesParams {
|
|
12621
12692
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
12622
12693
|
search?: string;
|
|
12623
12694
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -12640,7 +12711,7 @@ export interface GetApiV21OrdersIdShippingDocumentsParams {
|
|
|
12640
12711
|
page_links?: boolean;
|
|
12641
12712
|
id: number;
|
|
12642
12713
|
}
|
|
12643
|
-
export interface
|
|
12714
|
+
export interface GetApiV21OrdersIdShippingDocumentsParams {
|
|
12644
12715
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
12645
12716
|
search?: string;
|
|
12646
12717
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -15512,7 +15583,12 @@ export interface GetApiV2OrdersIdPackagesParams {
|
|
|
15512
15583
|
page_links?: boolean;
|
|
15513
15584
|
id: number;
|
|
15514
15585
|
}
|
|
15515
|
-
export interface
|
|
15586
|
+
export interface GetApiV2OrdersIdPackingRulesCountParams {
|
|
15587
|
+
/** JSON search string like {"attribute_eq": "Term"} */
|
|
15588
|
+
search?: string;
|
|
15589
|
+
id: number;
|
|
15590
|
+
}
|
|
15591
|
+
export interface GetApiV2OrdersIdPackingRulesParams {
|
|
15516
15592
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
15517
15593
|
search?: string;
|
|
15518
15594
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -15535,7 +15611,7 @@ export interface GetApiV2OrdersIdShippingDocumentsParams {
|
|
|
15535
15611
|
page_links?: boolean;
|
|
15536
15612
|
id: number;
|
|
15537
15613
|
}
|
|
15538
|
-
export interface
|
|
15614
|
+
export interface GetApiV2OrdersIdShippingDocumentsParams {
|
|
15539
15615
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
15540
15616
|
search?: string;
|
|
15541
15617
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -17742,7 +17818,12 @@ export interface PostApiV21ItemsRequest {
|
|
|
17742
17818
|
expiration_period?: number;
|
|
17743
17819
|
/** Garment on hanger? */
|
|
17744
17820
|
goh?: boolean;
|
|
17745
|
-
/**
|
|
17821
|
+
/**
|
|
17822
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
17823
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
17824
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
17825
|
+
* (deprecated) is the item hazmat?
|
|
17826
|
+
*/
|
|
17746
17827
|
hazmat?: boolean;
|
|
17747
17828
|
/** hazmat class */
|
|
17748
17829
|
hazmat_type?: PostApiV21ItemsRequestHazmatType;
|
|
@@ -19979,8 +20060,6 @@ export interface PostApiV21UsersAuthorizeRequest {
|
|
|
19979
20060
|
provider: string;
|
|
19980
20061
|
}
|
|
19981
20062
|
export interface PostApiV21UsersRequest {
|
|
19982
|
-
/** operator auth token (staff only) */
|
|
19983
|
-
auth_token?: string;
|
|
19984
20063
|
/** auto create a whiplash email for this user? (staff only) */
|
|
19985
20064
|
create_email?: boolean;
|
|
19986
20065
|
/**
|
|
@@ -21241,7 +21320,12 @@ export interface PostApiV2ItemsRequest {
|
|
|
21241
21320
|
expiration_period?: number;
|
|
21242
21321
|
/** Garment on hanger? */
|
|
21243
21322
|
goh?: boolean;
|
|
21244
|
-
/**
|
|
21323
|
+
/**
|
|
21324
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
21325
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
21326
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
21327
|
+
* (deprecated) is the item hazmat?
|
|
21328
|
+
*/
|
|
21245
21329
|
hazmat?: boolean;
|
|
21246
21330
|
/** hazmat class */
|
|
21247
21331
|
hazmat_type?: PostApiV2ItemsRequestHazmatType;
|
|
@@ -23478,8 +23562,6 @@ export interface PostApiV2UsersAuthorizeRequest {
|
|
|
23478
23562
|
provider: string;
|
|
23479
23563
|
}
|
|
23480
23564
|
export interface PostApiV2UsersRequest {
|
|
23481
|
-
/** operator auth token (staff only) */
|
|
23482
|
-
auth_token?: string;
|
|
23483
23565
|
/** auto create a whiplash email for this user? (staff only) */
|
|
23484
23566
|
create_email?: boolean;
|
|
23485
23567
|
/**
|
|
@@ -24374,7 +24456,12 @@ export interface PutApiV21IncidentsIdRequest {
|
|
|
24374
24456
|
full_description?: string;
|
|
24375
24457
|
/** Garment on hanger? */
|
|
24376
24458
|
goh?: boolean;
|
|
24377
|
-
/**
|
|
24459
|
+
/**
|
|
24460
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
24461
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
24462
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
24463
|
+
* (deprecated) is the item hazmat?
|
|
24464
|
+
*/
|
|
24378
24465
|
hazmat?: boolean;
|
|
24379
24466
|
/** hazmat class */
|
|
24380
24467
|
hazmat_type?: PutApiV21IncidentsIdRequestHazmatType;
|
|
@@ -24535,7 +24622,12 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
24535
24622
|
expiration_period?: number;
|
|
24536
24623
|
/** Garment on hanger? */
|
|
24537
24624
|
goh?: boolean;
|
|
24538
|
-
/**
|
|
24625
|
+
/**
|
|
24626
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
24627
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
24628
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
24629
|
+
* (deprecated) is the item hazmat?
|
|
24630
|
+
*/
|
|
24539
24631
|
hazmat?: boolean;
|
|
24540
24632
|
/** hazmat class */
|
|
24541
24633
|
hazmat_type?: PutApiV21ItemsIdRequestHazmatType;
|
|
@@ -26202,8 +26294,6 @@ export interface PutApiV21UsersIdCallActionRequest {
|
|
|
26202
26294
|
args?: string;
|
|
26203
26295
|
}
|
|
26204
26296
|
export interface PutApiV21UsersIdRequest {
|
|
26205
|
-
/** operator auth token (staff only) */
|
|
26206
|
-
auth_token?: string;
|
|
26207
26297
|
/**
|
|
26208
26298
|
* when the user logged in
|
|
26209
26299
|
* @format date-time
|
|
@@ -27234,7 +27324,12 @@ export interface PutApiV2IncidentsIdRequest {
|
|
|
27234
27324
|
full_description?: string;
|
|
27235
27325
|
/** Garment on hanger? */
|
|
27236
27326
|
goh?: boolean;
|
|
27237
|
-
/**
|
|
27327
|
+
/**
|
|
27328
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
27329
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
27330
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
27331
|
+
* (deprecated) is the item hazmat?
|
|
27332
|
+
*/
|
|
27238
27333
|
hazmat?: boolean;
|
|
27239
27334
|
/** hazmat class */
|
|
27240
27335
|
hazmat_type?: PutApiV2IncidentsIdRequestHazmatType;
|
|
@@ -27395,7 +27490,12 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
27395
27490
|
expiration_period?: number;
|
|
27396
27491
|
/** Garment on hanger? */
|
|
27397
27492
|
goh?: boolean;
|
|
27398
|
-
/**
|
|
27493
|
+
/**
|
|
27494
|
+
* hazmat true/false flag in the UI is derived from the hazmat_type when only the type is provided\
|
|
27495
|
+
* error results when the hazmat flag set to false with a hazmat_type\
|
|
27496
|
+
* error results when the hazmat flag set to true without a hazmat_type\
|
|
27497
|
+
* (deprecated) is the item hazmat?
|
|
27498
|
+
*/
|
|
27399
27499
|
hazmat?: boolean;
|
|
27400
27500
|
/** hazmat class */
|
|
27401
27501
|
hazmat_type?: PutApiV2ItemsIdRequestHazmatType;
|
|
@@ -29062,8 +29162,6 @@ export interface PutApiV2UsersIdCallActionRequest {
|
|
|
29062
29162
|
args?: string;
|
|
29063
29163
|
}
|
|
29064
29164
|
export interface PutApiV2UsersIdRequest {
|
|
29065
|
-
/** operator auth token (staff only) */
|
|
29066
|
-
auth_token?: string;
|
|
29067
29165
|
/**
|
|
29068
29166
|
* when the user logged in
|
|
29069
29167
|
* @format date-time
|
|
@@ -30,7 +30,8 @@ export declare const putApiV21ShipnoticesIdBulkReceive: (client: HttpClient, { s
|
|
|
30
30
|
export interface PutApiV21ShipnoticesIdBulkReceiveAsyncArgs extends PutApiV21ShipnoticesIdBulkReceiveArgs {
|
|
31
31
|
pusherInstance: Pusher;
|
|
32
32
|
defectiveReasonCodeId: string | null;
|
|
33
|
+
flow: BulkReceiveAndAllocateFlows;
|
|
33
34
|
}
|
|
34
|
-
export declare const putApiV21ShipnoticesIdBulkReceiveAsync: (client: HttpClient, { shipnoticeId, locationRole, locationName, pusherInstance, defectiveReasonCodeId }: PutApiV21ShipnoticesIdBulkReceiveAsyncArgs) => Promise<void>;
|
|
35
|
+
export declare const putApiV21ShipnoticesIdBulkReceiveAsync: (client: HttpClient, { shipnoticeId, locationRole, locationName, pusherInstance, defectiveReasonCodeId, flow }: PutApiV21ShipnoticesIdBulkReceiveAsyncArgs) => Promise<void>;
|
|
35
36
|
export declare const ApiV21ShipNoticesIdSbrBulkReceiveAndAllocateAsync: (client: HttpClient, argsObj: ApiV21ShipNoticesIdSbrBulkReceiveAndAllocateArgs) => Promise<void>;
|
|
36
37
|
export {};
|
package/generated/Orders.ts
CHANGED
|
@@ -43,8 +43,9 @@ import {
|
|
|
43
43
|
GetApiV21OrdersIdOrderDocumentsParams,
|
|
44
44
|
GetApiV21OrdersIdOrderItemsCountParams,
|
|
45
45
|
GetApiV21OrdersIdOrderItemsParams,
|
|
46
|
+
GetApiV21OrdersIdPackingRulesCountParams,
|
|
47
|
+
GetApiV21OrdersIdPackingRulesParams,
|
|
46
48
|
GetApiV21OrdersIdShippingDocumentsParams,
|
|
47
|
-
GetApiV21OrdersIdSuggestedItemsParams,
|
|
48
49
|
GetApiV21OrdersParams,
|
|
49
50
|
GetApiV2OrdersCountParams,
|
|
50
51
|
GetApiV2OrdersIdEventsCountParams,
|
|
@@ -54,8 +55,9 @@ import {
|
|
|
54
55
|
GetApiV2OrdersIdOrderDocumentsParams,
|
|
55
56
|
GetApiV2OrdersIdOrderItemsCountParams,
|
|
56
57
|
GetApiV2OrdersIdOrderItemsParams,
|
|
58
|
+
GetApiV2OrdersIdPackingRulesCountParams,
|
|
59
|
+
GetApiV2OrdersIdPackingRulesParams,
|
|
57
60
|
GetApiV2OrdersIdShippingDocumentsParams,
|
|
58
|
-
GetApiV2OrdersIdSuggestedItemsParams,
|
|
59
61
|
GetApiV2OrdersParams,
|
|
60
62
|
PostApiV21OrdersBulkRequest,
|
|
61
63
|
PostApiV21OrdersIdOrderDocumentsRequest,
|
|
@@ -461,6 +463,48 @@ export const getApiV2OrdersIdOrderItemsCount = (
|
|
|
461
463
|
...params,
|
|
462
464
|
});
|
|
463
465
|
};
|
|
466
|
+
/**
|
|
467
|
+
* @description Get packing rules with suggested items
|
|
468
|
+
*
|
|
469
|
+
* @tags orders
|
|
470
|
+
* @name GetApiV2OrdersIdPackingRules
|
|
471
|
+
* @summary Retrieve suggested items for an order
|
|
472
|
+
* @request GET:/api/v2/orders/{id}/packing_rules
|
|
473
|
+
*/
|
|
474
|
+
export const getApiV2OrdersIdPackingRules = (
|
|
475
|
+
client: HttpClient,
|
|
476
|
+
{ id, ...query }: GetApiV2OrdersIdPackingRulesParams,
|
|
477
|
+
params: RequestParams = {},
|
|
478
|
+
) => {
|
|
479
|
+
return client.request<ApiV2EntitiesPackingRule[], ApiSharedEntitiesApiError>({
|
|
480
|
+
path: `/api/v2/orders/${id}/packing_rules`,
|
|
481
|
+
method: "GET",
|
|
482
|
+
query: query,
|
|
483
|
+
format: "json",
|
|
484
|
+
...params,
|
|
485
|
+
});
|
|
486
|
+
};
|
|
487
|
+
/**
|
|
488
|
+
* @description Get count of suggested items for an order
|
|
489
|
+
*
|
|
490
|
+
* @tags orders
|
|
491
|
+
* @name GetApiV2OrdersIdPackingRulesCount
|
|
492
|
+
* @summary Count the suggested items for an order
|
|
493
|
+
* @request GET:/api/v2/orders/{id}/packing_rules/count
|
|
494
|
+
*/
|
|
495
|
+
export const getApiV2OrdersIdPackingRulesCount = (
|
|
496
|
+
client: HttpClient,
|
|
497
|
+
{ id, ...query }: GetApiV2OrdersIdPackingRulesCountParams,
|
|
498
|
+
params: RequestParams = {},
|
|
499
|
+
) => {
|
|
500
|
+
return client.request<ApiV2EntitiesCount, ApiSharedEntitiesApiError>({
|
|
501
|
+
path: `/api/v2/orders/${id}/packing_rules/count`,
|
|
502
|
+
method: "GET",
|
|
503
|
+
query: query,
|
|
504
|
+
format: "json",
|
|
505
|
+
...params,
|
|
506
|
+
});
|
|
507
|
+
};
|
|
464
508
|
/**
|
|
465
509
|
* @description Get the serial numbers for an order
|
|
466
510
|
*
|
|
@@ -498,27 +542,6 @@ export const getApiV2OrdersIdShippingDocuments = (
|
|
|
498
542
|
...params,
|
|
499
543
|
});
|
|
500
544
|
};
|
|
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
|
-
};
|
|
522
545
|
/**
|
|
523
546
|
* @description get the Wholesale object for an order
|
|
524
547
|
*
|
|
@@ -920,6 +943,48 @@ export const getApiV21OrdersIdOrderItemsCount = (
|
|
|
920
943
|
...params,
|
|
921
944
|
});
|
|
922
945
|
};
|
|
946
|
+
/**
|
|
947
|
+
* @description Get packing rules with suggested items
|
|
948
|
+
*
|
|
949
|
+
* @tags orders
|
|
950
|
+
* @name GetApiV21OrdersIdPackingRules
|
|
951
|
+
* @summary Retrieve suggested items for an order
|
|
952
|
+
* @request GET:/api/v2.1/orders/{id}/packing_rules
|
|
953
|
+
*/
|
|
954
|
+
export const getApiV21OrdersIdPackingRules = (
|
|
955
|
+
client: HttpClient,
|
|
956
|
+
{ id, ...query }: GetApiV21OrdersIdPackingRulesParams,
|
|
957
|
+
params: RequestParams = {},
|
|
958
|
+
) => {
|
|
959
|
+
return client.request<ApiV21EntitiesPackingRule[], ApiSharedEntitiesApiError>({
|
|
960
|
+
path: `/api/v2.1/orders/${id}/packing_rules`,
|
|
961
|
+
method: "GET",
|
|
962
|
+
query: query,
|
|
963
|
+
format: "json",
|
|
964
|
+
...params,
|
|
965
|
+
});
|
|
966
|
+
};
|
|
967
|
+
/**
|
|
968
|
+
* @description Get count of suggested items for an order
|
|
969
|
+
*
|
|
970
|
+
* @tags orders
|
|
971
|
+
* @name GetApiV21OrdersIdPackingRulesCount
|
|
972
|
+
* @summary Count the suggested items for an order
|
|
973
|
+
* @request GET:/api/v2.1/orders/{id}/packing_rules/count
|
|
974
|
+
*/
|
|
975
|
+
export const getApiV21OrdersIdPackingRulesCount = (
|
|
976
|
+
client: HttpClient,
|
|
977
|
+
{ id, ...query }: GetApiV21OrdersIdPackingRulesCountParams,
|
|
978
|
+
params: RequestParams = {},
|
|
979
|
+
) => {
|
|
980
|
+
return client.request<ApiV21EntitiesCount, ApiSharedEntitiesApiError>({
|
|
981
|
+
path: `/api/v2.1/orders/${id}/packing_rules/count`,
|
|
982
|
+
method: "GET",
|
|
983
|
+
query: query,
|
|
984
|
+
format: "json",
|
|
985
|
+
...params,
|
|
986
|
+
});
|
|
987
|
+
};
|
|
923
988
|
/**
|
|
924
989
|
* @description Get the serial numbers for an order
|
|
925
990
|
*
|
|
@@ -957,27 +1022,6 @@ export const getApiV21OrdersIdShippingDocuments = (
|
|
|
957
1022
|
...params,
|
|
958
1023
|
});
|
|
959
1024
|
};
|
|
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
|
-
};
|
|
981
1025
|
/**
|
|
982
1026
|
* @description get the Wholesale object for an order
|
|
983
1027
|
*
|