@whiplashmerch/whiplash-api-client 3.2.31 → 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 -41
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/Orders.d.ts +37 -19
- package/dist/generated/data-contracts.d.ts +124 -14
- 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 -12
- 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
|
/**
|
|
@@ -7106,7 +7141,12 @@ export interface ApiV21EntitiesItem {
|
|
|
7106
7141
|
full_description?: string;
|
|
7107
7142
|
/** Garment on hanger? */
|
|
7108
7143
|
goh?: boolean | null;
|
|
7109
|
-
/**
|
|
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
|
+
*/
|
|
7110
7150
|
hazmat?: boolean;
|
|
7111
7151
|
/** hazmat class */
|
|
7112
7152
|
hazmat_type?: ApiV21EntitiesItemHazmatType;
|
|
@@ -8965,10 +9005,15 @@ export interface ApiV21EntitiesPackingRule {
|
|
|
8965
9005
|
/** title/description of rule */
|
|
8966
9006
|
description?: string | null;
|
|
8967
9007
|
/**
|
|
8968
|
-
* the rule id
|
|
9008
|
+
* the packing rule id
|
|
8969
9009
|
* @format int32
|
|
8970
9010
|
*/
|
|
8971
9011
|
id?: number;
|
|
9012
|
+
/**
|
|
9013
|
+
* the suggested item id
|
|
9014
|
+
* @format int32
|
|
9015
|
+
*/
|
|
9016
|
+
item_id?: number;
|
|
8972
9017
|
/** method to apply to object */
|
|
8973
9018
|
method?: string | null;
|
|
8974
9019
|
/**
|
|
@@ -8976,6 +9021,31 @@ export interface ApiV21EntitiesPackingRule {
|
|
|
8976
9021
|
* @format int32
|
|
8977
9022
|
*/
|
|
8978
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
|
+
};
|
|
8979
9049
|
/** the type of rule */
|
|
8980
9050
|
type?: string | null;
|
|
8981
9051
|
/**
|
|
@@ -12613,7 +12683,12 @@ export interface GetApiV21OrdersIdPackagesParams {
|
|
|
12613
12683
|
page_links?: boolean;
|
|
12614
12684
|
id: number;
|
|
12615
12685
|
}
|
|
12616
|
-
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 {
|
|
12617
12692
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
12618
12693
|
search?: string;
|
|
12619
12694
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -12636,7 +12711,7 @@ export interface GetApiV21OrdersIdShippingDocumentsParams {
|
|
|
12636
12711
|
page_links?: boolean;
|
|
12637
12712
|
id: number;
|
|
12638
12713
|
}
|
|
12639
|
-
export interface
|
|
12714
|
+
export interface GetApiV21OrdersIdShippingDocumentsParams {
|
|
12640
12715
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
12641
12716
|
search?: string;
|
|
12642
12717
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -15508,7 +15583,12 @@ export interface GetApiV2OrdersIdPackagesParams {
|
|
|
15508
15583
|
page_links?: boolean;
|
|
15509
15584
|
id: number;
|
|
15510
15585
|
}
|
|
15511
|
-
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 {
|
|
15512
15592
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
15513
15593
|
search?: string;
|
|
15514
15594
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -15531,7 +15611,7 @@ export interface GetApiV2OrdersIdShippingDocumentsParams {
|
|
|
15531
15611
|
page_links?: boolean;
|
|
15532
15612
|
id: number;
|
|
15533
15613
|
}
|
|
15534
|
-
export interface
|
|
15614
|
+
export interface GetApiV2OrdersIdShippingDocumentsParams {
|
|
15535
15615
|
/** JSON search string like {"attribute_eq": "Term"} */
|
|
15536
15616
|
search?: string;
|
|
15537
15617
|
/** Comma-separated list of fields to include in the response */
|
|
@@ -17738,7 +17818,12 @@ export interface PostApiV21ItemsRequest {
|
|
|
17738
17818
|
expiration_period?: number;
|
|
17739
17819
|
/** Garment on hanger? */
|
|
17740
17820
|
goh?: boolean;
|
|
17741
|
-
/**
|
|
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
|
+
*/
|
|
17742
17827
|
hazmat?: boolean;
|
|
17743
17828
|
/** hazmat class */
|
|
17744
17829
|
hazmat_type?: PostApiV21ItemsRequestHazmatType;
|
|
@@ -21235,7 +21320,12 @@ export interface PostApiV2ItemsRequest {
|
|
|
21235
21320
|
expiration_period?: number;
|
|
21236
21321
|
/** Garment on hanger? */
|
|
21237
21322
|
goh?: boolean;
|
|
21238
|
-
/**
|
|
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
|
+
*/
|
|
21239
21329
|
hazmat?: boolean;
|
|
21240
21330
|
/** hazmat class */
|
|
21241
21331
|
hazmat_type?: PostApiV2ItemsRequestHazmatType;
|
|
@@ -24366,7 +24456,12 @@ export interface PutApiV21IncidentsIdRequest {
|
|
|
24366
24456
|
full_description?: string;
|
|
24367
24457
|
/** Garment on hanger? */
|
|
24368
24458
|
goh?: boolean;
|
|
24369
|
-
/**
|
|
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
|
+
*/
|
|
24370
24465
|
hazmat?: boolean;
|
|
24371
24466
|
/** hazmat class */
|
|
24372
24467
|
hazmat_type?: PutApiV21IncidentsIdRequestHazmatType;
|
|
@@ -24527,7 +24622,12 @@ export interface PutApiV21ItemsIdRequest {
|
|
|
24527
24622
|
expiration_period?: number;
|
|
24528
24623
|
/** Garment on hanger? */
|
|
24529
24624
|
goh?: boolean;
|
|
24530
|
-
/**
|
|
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
|
+
*/
|
|
24531
24631
|
hazmat?: boolean;
|
|
24532
24632
|
/** hazmat class */
|
|
24533
24633
|
hazmat_type?: PutApiV21ItemsIdRequestHazmatType;
|
|
@@ -27224,7 +27324,12 @@ export interface PutApiV2IncidentsIdRequest {
|
|
|
27224
27324
|
full_description?: string;
|
|
27225
27325
|
/** Garment on hanger? */
|
|
27226
27326
|
goh?: boolean;
|
|
27227
|
-
/**
|
|
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
|
+
*/
|
|
27228
27333
|
hazmat?: boolean;
|
|
27229
27334
|
/** hazmat class */
|
|
27230
27335
|
hazmat_type?: PutApiV2IncidentsIdRequestHazmatType;
|
|
@@ -27385,7 +27490,12 @@ export interface PutApiV2ItemsIdRequest {
|
|
|
27385
27490
|
expiration_period?: number;
|
|
27386
27491
|
/** Garment on hanger? */
|
|
27387
27492
|
goh?: boolean;
|
|
27388
|
-
/**
|
|
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
|
+
*/
|
|
27389
27499
|
hazmat?: boolean;
|
|
27390
27500
|
/** hazmat class */
|
|
27391
27501
|
hazmat_type?: PutApiV2ItemsIdRequestHazmatType;
|
|
@@ -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
|
*
|