@whiplashmerch/whiplash-api-client 0.3.3 → 0.4.1
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 +335 -19
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/ConsumerReturns.d.ts +4 -4
- package/dist/generated/Customers.d.ts +4 -4
- package/dist/generated/Documents.d.ts +4 -4
- package/dist/generated/Items.d.ts +7 -7
- package/dist/generated/NotificationSubscriptions.d.ts +8 -8
- package/dist/generated/OrderDocuments.d.ts +2 -3
- package/dist/generated/OrderItems.d.ts +4 -4
- package/dist/generated/Orders.d.ts +6 -6
- package/dist/generated/ShipnoticeItems.d.ts +5 -5
- package/dist/generated/Shipnotices.d.ts +10 -10
- package/dist/generated/Simulate.d.ts +7 -7
- package/dist/generated/Templates.d.ts +5 -5
- package/dist/generated/data-contracts.d.ts +3609 -2260
- package/generated/ConsumerReturns.ts +4 -3
- package/generated/Customers.ts +4 -4
- package/generated/Documents.ts +4 -5
- package/generated/Items.ts +8 -6
- package/generated/NotificationSubscriptions.ts +9 -10
- package/generated/OrderDocuments.ts +3 -5
- package/generated/OrderItems.ts +4 -3
- package/generated/Orders.ts +7 -5
- package/generated/ShipnoticeItems.ts +5 -7
- package/generated/Shipnotices.ts +11 -13
- package/generated/Simulate.ts +7 -8
- package/generated/Templates.ts +6 -5
- package/generated/data-contracts.ts +3617 -2256
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV2EntitiesConsumerReturn, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdMetaFieldsParams, GetApiV21ConsumerReturnsParams, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdMetaFieldsParams, GetApiV2ConsumerReturnsParams, PostApiV21ConsumerReturns, PostApiV2ConsumerReturns, PutApiV21ConsumerReturns, PutApiV21ConsumerReturnsIdMetaFields, PutApiV21ConsumerReturnsOriginator, PutApiV2ConsumerReturns, PutApiV2ConsumerReturnsIdMetaFields, PutApiV2ConsumerReturnsOriginator } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesConsumerReturn, APIV21EntitiesPostResponse, APIV2EntitiesConsumerReturn, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, GetApiV21ConsumerReturnsCountParams, GetApiV21ConsumerReturnsIdMetaFieldsParams, GetApiV21ConsumerReturnsParams, GetApiV2ConsumerReturnsCountParams, GetApiV2ConsumerReturnsIdMetaFieldsParams, GetApiV2ConsumerReturnsParams, PostApiV21ConsumerReturns, PostApiV2ConsumerReturns, PutApiV21ConsumerReturns, PutApiV21ConsumerReturnsIdMetaFields, PutApiV21ConsumerReturnsOriginator, PutApiV2ConsumerReturns, PutApiV2ConsumerReturnsIdMetaFields, PutApiV2ConsumerReturnsOriginator } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -134,7 +134,7 @@ export declare const putApiV21ConsumerReturnsOriginatorOriginatorId: (client: Ht
|
|
|
134
134
|
* @summary Retrieve a consumer return
|
|
135
135
|
* @request GET:/api/v2.1/consumer_returns/originator/{originator_id}
|
|
136
136
|
*/
|
|
137
|
-
export declare const getApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
137
|
+
export declare const getApiV21ConsumerReturnsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
|
|
138
138
|
/**
|
|
139
139
|
* @description Update ConsumerReturn meta fields
|
|
140
140
|
*
|
|
@@ -179,7 +179,7 @@ export declare const putApiV21ConsumerReturnsId: (client: HttpClient, id: number
|
|
|
179
179
|
* @summary Retrieve a consumer return
|
|
180
180
|
* @request GET:/api/v2.1/consumer_returns/{id}
|
|
181
181
|
*/
|
|
182
|
-
export declare const getApiV21ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
182
|
+
export declare const getApiV21ConsumerReturnsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn>;
|
|
183
183
|
/**
|
|
184
184
|
* No description
|
|
185
185
|
*
|
|
@@ -197,7 +197,7 @@ export declare const postApiV21ConsumerReturns: (client: HttpClient, ApiV21Consu
|
|
|
197
197
|
* @summary List all consumer returns
|
|
198
198
|
* @request GET:/api/v2.1/consumer_returns
|
|
199
199
|
*/
|
|
200
|
-
export declare const getApiV21ConsumerReturns: (client: HttpClient, query: GetApiV21ConsumerReturnsParams, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const getApiV21ConsumerReturns: (client: HttpClient, query: GetApiV21ConsumerReturnsParams, params?: RequestParams) => Promise<APIV21EntitiesConsumerReturn[]>;
|
|
201
201
|
/**
|
|
202
202
|
* No description
|
|
203
203
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesCount, APIV2EntitiesCustomer, GetApiV21CustomersCountParams, GetApiV21CustomersParams, GetApiV2CustomersCountParams, GetApiV2CustomersParams, PutApiV21Customers, PutApiV2Customers } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesCustomer, APIV2EntitiesCount, APIV2EntitiesCustomer, GetApiV21CustomersCountParams, GetApiV21CustomersParams, GetApiV2CustomersCountParams, GetApiV2CustomersParams, PutApiV21Customers, PutApiV2Customers } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -62,7 +62,7 @@ export declare const getApiV21CustomersCount: (client: HttpClient, query: GetApi
|
|
|
62
62
|
* @summary List all customers
|
|
63
63
|
* @request GET:/api/v2.1/customers
|
|
64
64
|
*/
|
|
65
|
-
export declare const getApiV21Customers: (client: HttpClient, query: GetApiV21CustomersParams, params?: RequestParams) => Promise<
|
|
65
|
+
export declare const getApiV21Customers: (client: HttpClient, query: GetApiV21CustomersParams, params?: RequestParams) => Promise<APIV21EntitiesCustomer[]>;
|
|
66
66
|
/**
|
|
67
67
|
* @description Get resource actions
|
|
68
68
|
*
|
|
@@ -80,7 +80,7 @@ export declare const getApiV21CustomersActions: (client: HttpClient, params?: Re
|
|
|
80
80
|
* @summary Update a customer
|
|
81
81
|
* @request PUT:/api/v2.1/customers/{id}
|
|
82
82
|
*/
|
|
83
|
-
export declare const putApiV21CustomersId: (client: HttpClient, id: number, ApiV21Customers: PutApiV21Customers, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const putApiV21CustomersId: (client: HttpClient, id: number, ApiV21Customers: PutApiV21Customers, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -89,4 +89,4 @@ export declare const putApiV21CustomersId: (client: HttpClient, id: number, ApiV
|
|
|
89
89
|
* @summary Retrieve a customer
|
|
90
90
|
* @request GET:/api/v2.1/customers/{id}
|
|
91
91
|
*/
|
|
92
|
-
export declare const getApiV21CustomersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
92
|
+
export declare const getApiV21CustomersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCustomer>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesDocument, GetApiV21DocumentsParams, GetApiV2DocumentsParams, PostApiV21Documents, PostApiV2Documents } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV2EntitiesDocument, GetApiV21DocumentsParams, GetApiV2DocumentsParams, PostApiV21Documents, PostApiV2Documents } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -35,7 +35,7 @@ export declare const getApiV2DocumentsActions: (client: HttpClient, params?: Req
|
|
|
35
35
|
* @summary Destroy an document
|
|
36
36
|
* @request DELETE:/api/v2/documents/{id}
|
|
37
37
|
*/
|
|
38
|
-
export declare const deleteApiV2DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
38
|
+
export declare const deleteApiV2DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
39
39
|
/**
|
|
40
40
|
* No description
|
|
41
41
|
*
|
|
@@ -53,7 +53,7 @@ export declare const getApiV2DocumentsId: (client: HttpClient, id: number, param
|
|
|
53
53
|
* @summary Create a document
|
|
54
54
|
* @request POST:/api/v2.1/documents
|
|
55
55
|
*/
|
|
56
|
-
export declare const postApiV21Documents: (client: HttpClient, ApiV21Documents: PostApiV21Documents, params?: RequestParams) => Promise<
|
|
56
|
+
export declare const postApiV21Documents: (client: HttpClient, ApiV21Documents: PostApiV21Documents, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
57
57
|
/**
|
|
58
58
|
* No description
|
|
59
59
|
*
|
|
@@ -80,7 +80,7 @@ export declare const getApiV21DocumentsActions: (client: HttpClient, params?: Re
|
|
|
80
80
|
* @summary Destroy an document
|
|
81
81
|
* @request DELETE:/api/v2.1/documents/{id}
|
|
82
82
|
*/
|
|
83
|
-
export declare const deleteApiV21DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const deleteApiV21DocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV2EntitiesBundleItem, APIV2EntitiesCount, APIV2EntitiesItem, APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesScancode, APIV2EntitiesShipnoticeItem, APIV2EntitiesTransaction, GetApiV21ItemsCountParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdScancodesParams, GetApiV21ItemsParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdScancodesParams, GetApiV2ItemsParams, PostApiV21Items, PostApiV21ItemsIdBundleItems, PostApiV2Items, PostApiV2ItemsIdBundleItems, PutApiV21Items, PutApiV21ItemsIdCall, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginator, PutApiV2Items, PutApiV2ItemsIdCall, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginator } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesItem, APIV21EntitiesPostResponse, APIV21EntitiesShipnoticeItem, APIV2EntitiesBundleItem, APIV2EntitiesCount, APIV2EntitiesItem, APIV2EntitiesItemWarehouseQuantity, APIV2EntitiesMetaFields, APIV2EntitiesOriginator, APIV2EntitiesScancode, APIV2EntitiesShipnoticeItem, APIV2EntitiesTransaction, GetApiV21ItemsCountParams, GetApiV21ItemsIdMetaFieldsParams, GetApiV21ItemsIdOriginatorsParams, GetApiV21ItemsIdScancodesParams, GetApiV21ItemsIdShipnoticeItemsCountParams, GetApiV21ItemsIdShipnoticeItemsParams, GetApiV21ItemsIdTransactionsCountParams, GetApiV21ItemsIdTransactionsParams, GetApiV21ItemsOriginatorOriginatorIdScancodesParams, GetApiV21ItemsParams, GetApiV2ItemsCountParams, GetApiV2ItemsIdMetaFieldsParams, GetApiV2ItemsIdOriginatorsParams, GetApiV2ItemsIdScancodesParams, GetApiV2ItemsIdShipnoticeItemsCountParams, GetApiV2ItemsIdShipnoticeItemsParams, GetApiV2ItemsIdTransactionsCountParams, GetApiV2ItemsIdTransactionsParams, GetApiV2ItemsOriginatorOriginatorIdScancodesParams, GetApiV2ItemsParams, PostApiV21Items, PostApiV21ItemsIdBundleItems, PostApiV2Items, PostApiV2ItemsIdBundleItems, PutApiV21Items, PutApiV21ItemsIdCall, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginator, PutApiV2Items, PutApiV2ItemsIdCall, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginator } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -260,7 +260,7 @@ export declare const postApiV21Items: (client: HttpClient, ApiV21Items: PostApiV
|
|
|
260
260
|
* @summary List all items
|
|
261
261
|
* @request GET:/api/v2.1/items
|
|
262
262
|
*/
|
|
263
|
-
export declare const getApiV21Items: (client: HttpClient, query: GetApiV21ItemsParams, params?: RequestParams) => Promise<
|
|
263
|
+
export declare const getApiV21Items: (client: HttpClient, query: GetApiV21ItemsParams, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
|
|
264
264
|
/**
|
|
265
265
|
* @description Get resource actions
|
|
266
266
|
*
|
|
@@ -305,7 +305,7 @@ export declare const getApiV21ItemsOriginatorOriginatorIdBundleItems: (client: H
|
|
|
305
305
|
* @summary List all instances of this item in bundles
|
|
306
306
|
* @request GET:/api/v2.1/items/originator/{originator_id}/in_bundles
|
|
307
307
|
*/
|
|
308
|
-
export declare const getApiV21ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
308
|
+
export declare const getApiV21ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
|
|
309
309
|
/**
|
|
310
310
|
* @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
|
|
311
311
|
*
|
|
@@ -332,7 +332,7 @@ export declare const putApiV21ItemsOriginatorOriginatorId: (client: HttpClient,
|
|
|
332
332
|
* @summary Retrieve an item
|
|
333
333
|
* @request GET:/api/v2.1/items/originator/{originator_id}
|
|
334
334
|
*/
|
|
335
|
-
export declare const getApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
335
|
+
export declare const getApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
|
|
336
336
|
/**
|
|
337
337
|
* @description Update Item meta fields
|
|
338
338
|
*
|
|
@@ -395,7 +395,7 @@ export declare const postApiV21ItemsIdBundleItems: (client: HttpClient, id: numb
|
|
|
395
395
|
* @summary List all instances of this item in bundles
|
|
396
396
|
* @request GET:/api/v2.1/items/{id}/in_bundles
|
|
397
397
|
*/
|
|
398
|
-
export declare const getApiV21ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
398
|
+
export declare const getApiV21ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
|
|
399
399
|
/**
|
|
400
400
|
* @description Archived items are not typically returned in lists and searches, and cannot be added to orders. You may search for them directly, and may un-archive them at any time.
|
|
401
401
|
*
|
|
@@ -422,7 +422,7 @@ export declare const putApiV21ItemsId: (client: HttpClient, id: number, ApiV21It
|
|
|
422
422
|
* @summary Retrieve an item
|
|
423
423
|
* @request GET:/api/v2.1/items/{id}
|
|
424
424
|
*/
|
|
425
|
-
export declare const getApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
425
|
+
export declare const getApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
|
|
426
426
|
/**
|
|
427
427
|
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
428
428
|
*
|
|
@@ -467,7 +467,7 @@ export declare const getApiV21ItemsIdShipnoticeItemsCount: (client: HttpClient,
|
|
|
467
467
|
* @summary List associated ship notice items
|
|
468
468
|
* @request GET:/api/v2.1/items/{id}/shipnotice_items
|
|
469
469
|
*/
|
|
470
|
-
export declare const getApiV21ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<
|
|
470
|
+
export declare const getApiV21ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
|
|
471
471
|
/**
|
|
472
472
|
* @description Returns count of item transactions
|
|
473
473
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesCount, APIV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptions, PostApiV2NotificationSubscriptions, PutApiV21NotificationSubscriptions, PutApiV2NotificationSubscriptions } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesNotificationSubscription, APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesNotificationSubscription, GetApiV21NotificationSubscriptionsCountParams, GetApiV21NotificationSubscriptionsParams, GetApiV2NotificationSubscriptionsCountParams, GetApiV2NotificationSubscriptionsParams, PostApiV21NotificationSubscriptions, PostApiV2NotificationSubscriptions, PutApiV21NotificationSubscriptions, PutApiV2NotificationSubscriptions } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Subscribe to an e-mail, web hook, or sms notification for a specified event
|
|
@@ -44,7 +44,7 @@ export declare const getApiV2NotificationSubscriptionsIdTest: (client: HttpClien
|
|
|
44
44
|
* @summary Delete a notification subscription
|
|
45
45
|
* @request DELETE:/api/v2/notification_subscriptions/{id}
|
|
46
46
|
*/
|
|
47
|
-
export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
47
|
+
export declare const deleteApiV2NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
48
48
|
/**
|
|
49
49
|
* No description
|
|
50
50
|
*
|
|
@@ -71,7 +71,7 @@ export declare const getApiV2NotificationSubscriptionsId: (client: HttpClient, i
|
|
|
71
71
|
* @summary Create a notification subscription
|
|
72
72
|
* @request POST:/api/v2.1/notification_subscriptions
|
|
73
73
|
*/
|
|
74
|
-
export declare const postApiV21NotificationSubscriptions: (client: HttpClient, ApiV21NotificationSubscriptions: PostApiV21NotificationSubscriptions, params?: RequestParams) => Promise<
|
|
74
|
+
export declare const postApiV21NotificationSubscriptions: (client: HttpClient, ApiV21NotificationSubscriptions: PostApiV21NotificationSubscriptions, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
75
75
|
/**
|
|
76
76
|
* @description E-mail, web hook, and sms notifications you have subscribed to
|
|
77
77
|
*
|
|
@@ -80,7 +80,7 @@ export declare const postApiV21NotificationSubscriptions: (client: HttpClient, A
|
|
|
80
80
|
* @summary List all notification subscriptions
|
|
81
81
|
* @request GET:/api/v2.1/notification_subscriptions
|
|
82
82
|
*/
|
|
83
|
-
export declare const getApiV21NotificationSubscriptions: (client: HttpClient, query: GetApiV21NotificationSubscriptionsParams, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const getApiV21NotificationSubscriptions: (client: HttpClient, query: GetApiV21NotificationSubscriptionsParams, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription[]>;
|
|
84
84
|
/**
|
|
85
85
|
* @description Get a count of notification subscriptions
|
|
86
86
|
*
|
|
@@ -98,7 +98,7 @@ export declare const getApiV21NotificationSubscriptionsCount: (client: HttpClien
|
|
|
98
98
|
* @summary Test a notification subscription
|
|
99
99
|
* @request GET:/api/v2.1/notification_subscriptions/{id}/test
|
|
100
100
|
*/
|
|
101
|
-
export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
|
|
102
102
|
/**
|
|
103
103
|
* No description
|
|
104
104
|
*
|
|
@@ -107,7 +107,7 @@ export declare const getApiV21NotificationSubscriptionsIdTest: (client: HttpClie
|
|
|
107
107
|
* @summary Delete a notification subscription
|
|
108
108
|
* @request DELETE:/api/v2.1/notification_subscriptions/{id}
|
|
109
109
|
*/
|
|
110
|
-
export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
110
|
+
export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
111
111
|
/**
|
|
112
112
|
* No description
|
|
113
113
|
*
|
|
@@ -116,7 +116,7 @@ export declare const deleteApiV21NotificationSubscriptionsId: (client: HttpClien
|
|
|
116
116
|
* @summary Update a notification subscription
|
|
117
117
|
* @request PUT:/api/v2.1/notification_subscriptions/{id}
|
|
118
118
|
*/
|
|
119
|
-
export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, ApiV21NotificationSubscriptions: PutApiV21NotificationSubscriptions, params?: RequestParams) => Promise<
|
|
119
|
+
export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, ApiV21NotificationSubscriptions: PutApiV21NotificationSubscriptions, params?: RequestParams) => Promise<void>;
|
|
120
120
|
/**
|
|
121
121
|
* No description
|
|
122
122
|
*
|
|
@@ -125,4 +125,4 @@ export declare const putApiV21NotificationSubscriptionsId: (client: HttpClient,
|
|
|
125
125
|
* @summary Retrieve a notification subscription
|
|
126
126
|
* @request GET:/api/v2.1/notification_subscriptions/{id}
|
|
127
127
|
*/
|
|
128
|
-
export declare const getApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
128
|
+
export declare const getApiV21NotificationSubscriptionsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesNotificationSubscription>;
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { APIV2EntitiesOrderDocument } from "./data-contracts";
|
|
2
1
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
2
|
/**
|
|
4
3
|
* @description Remove an order document from an order
|
|
@@ -8,7 +7,7 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
8
7
|
* @summary Delete an order document
|
|
9
8
|
* @request DELETE:/api/v2/order_documents/{id}
|
|
10
9
|
*/
|
|
11
|
-
export declare const deleteApiV2OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
10
|
+
export declare const deleteApiV2OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
12
11
|
/**
|
|
13
12
|
* @description Remove an order document from an order
|
|
14
13
|
*
|
|
@@ -17,4 +16,4 @@ export declare const deleteApiV2OrderDocumentsId: (client: HttpClient, id: numbe
|
|
|
17
16
|
* @summary Delete an order document
|
|
18
17
|
* @request DELETE:/api/v2.1/order_documents/{id}
|
|
19
18
|
*/
|
|
20
|
-
export declare const deleteApiV21OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
19
|
+
export declare const deleteApiV21OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, PutApiV21OrderItems, PutApiV21OrderItemsIdCall, PutApiV21OrderItemsIdMetaFields, PutApiV2OrderItems, PutApiV2OrderItemsIdCall, PutApiV2OrderItemsIdMetaFields } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesOrderItem, APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, PutApiV21OrderItems, PutApiV21OrderItemsIdCall, PutApiV21OrderItemsIdMetaFields, PutApiV2OrderItems, PutApiV2OrderItemsIdCall, PutApiV2OrderItemsIdMetaFields } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get resource actions
|
|
@@ -116,7 +116,7 @@ export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, Api
|
|
|
116
116
|
* @summary Retrieve an order item
|
|
117
117
|
* @request GET:/api/v2.1/order_items/{id}
|
|
118
118
|
*/
|
|
119
|
-
export declare const getApiV21OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdParams, params?: RequestParams) => Promise<
|
|
119
|
+
export declare const getApiV21OrderItemsId: (client: HttpClient, { id, ...query }: GetApiV21OrderItemsIdParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
|
|
120
120
|
/**
|
|
121
121
|
* @description Update OrderItem meta fields
|
|
122
122
|
*
|
|
@@ -143,7 +143,7 @@ export declare const getApiV21OrderItemsIdMetaFields: (client: HttpClient, { id,
|
|
|
143
143
|
* @summary Separate an order item
|
|
144
144
|
* @request PUT:/api/v2.1/order_items/{id}/separate
|
|
145
145
|
*/
|
|
146
|
-
export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
146
|
+
export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
|
|
147
147
|
/**
|
|
148
148
|
* @description Perform an action on an order_item
|
|
149
149
|
*
|
|
@@ -152,7 +152,7 @@ export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: num
|
|
|
152
152
|
* @summary Perform an action on an order_item
|
|
153
153
|
* @request PUT:/api/v2.1/order_items/{id}/call/{action}
|
|
154
154
|
*/
|
|
155
|
-
export declare const putApiV21OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV21OrderItemsIdCall: PutApiV21OrderItemsIdCall, params?: RequestParams) => Promise<
|
|
155
|
+
export declare const putApiV21OrderItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV21OrderItemsIdCall: PutApiV21OrderItemsIdCall, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
|
|
156
156
|
/**
|
|
157
157
|
* @description Serial numbers are scanned and saved during the packing process.
|
|
158
158
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesResult, APIV2EntitiesSerialNumber, GetApiV21OrdersCountParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersParams, PostApiV21Orders, PostApiV21OrdersIdOrderDocuments, PostApiV21OrdersIdOrderItems, PostApiV2Orders, PostApiV2OrdersIdOrderDocuments, PostApiV2OrdersIdOrderItems, PutApiV21Orders, PutApiV21OrdersIdCall, PutApiV21OrdersIdMetaFields, PutApiV21OrdersOriginator, PutApiV2Orders, PutApiV2OrdersIdCall, PutApiV2OrdersIdMetaFields, PutApiV2OrdersOriginator } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesOrder, APIV21EntitiesOrderItem, APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesResult, APIV2EntitiesSerialNumber, GetApiV21OrdersCountParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersParams, PostApiV21Orders, PostApiV21OrdersIdOrderDocuments, PostApiV21OrdersIdOrderItems, PostApiV2Orders, PostApiV2OrdersIdOrderDocuments, PostApiV2OrdersIdOrderItems, PutApiV21Orders, PutApiV21OrdersIdCall, PutApiV21OrdersIdMetaFields, PutApiV21OrdersOriginator, PutApiV2Orders, PutApiV2OrdersIdCall, PutApiV2OrdersIdMetaFields, PutApiV2OrdersOriginator } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Create an order
|
|
@@ -197,7 +197,7 @@ export declare const postApiV21Orders: (client: HttpClient, ApiV21Orders: PostAp
|
|
|
197
197
|
* @summary List all orders
|
|
198
198
|
* @request GET:/api/v2.1/orders
|
|
199
199
|
*/
|
|
200
|
-
export declare const getApiV21Orders: (client: HttpClient, query: GetApiV21OrdersParams, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const getApiV21Orders: (client: HttpClient, query: GetApiV21OrdersParams, params?: RequestParams) => Promise<APIV21EntitiesOrder[]>;
|
|
201
201
|
/**
|
|
202
202
|
* @description Returns count of orders
|
|
203
203
|
*
|
|
@@ -242,7 +242,7 @@ export declare const putApiV21OrdersOriginatorOriginatorId: (client: HttpClient,
|
|
|
242
242
|
* @summary Retrieve an order
|
|
243
243
|
* @request GET:/api/v2.1/orders/originator/{originator_id}
|
|
244
244
|
*/
|
|
245
|
-
export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
245
|
+
export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
|
|
246
246
|
/**
|
|
247
247
|
* @description Returns count of order's events
|
|
248
248
|
*
|
|
@@ -278,7 +278,7 @@ export declare const putApiV21OrdersId: (client: HttpClient, id: number, ApiV21O
|
|
|
278
278
|
* @summary Retrieve an order
|
|
279
279
|
* @request GET:/api/v2.1/orders/{id}
|
|
280
280
|
*/
|
|
281
|
-
export declare const getApiV21OrdersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
281
|
+
export declare const getApiV21OrdersId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
|
|
282
282
|
/**
|
|
283
283
|
* @description Update Order meta fields
|
|
284
284
|
*
|
|
@@ -305,7 +305,7 @@ export declare const getApiV21OrdersIdMetaFields: (client: HttpClient, { id, ...
|
|
|
305
305
|
* @summary Create an order document for an order
|
|
306
306
|
* @request POST:/api/v2.1/orders/{id}/order_documents
|
|
307
307
|
*/
|
|
308
|
-
export declare const postApiV21OrdersIdOrderDocuments: (client: HttpClient, id: number, ApiV21OrdersIdOrderDocuments: PostApiV21OrdersIdOrderDocuments, params?: RequestParams) => Promise<
|
|
308
|
+
export declare const postApiV21OrdersIdOrderDocuments: (client: HttpClient, id: number, ApiV21OrdersIdOrderDocuments: PostApiV21OrdersIdOrderDocuments, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
309
309
|
/**
|
|
310
310
|
* @description Retrieve all order documents for an order
|
|
311
311
|
*
|
|
@@ -332,7 +332,7 @@ export declare const postApiV21OrdersIdOrderItems: (client: HttpClient, id: numb
|
|
|
332
332
|
* @summary List all order items for an order
|
|
333
333
|
* @request GET:/api/v2.1/orders/{id}/order_items
|
|
334
334
|
*/
|
|
335
|
-
export declare const getApiV21OrdersIdOrderItems: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsParams, params?: RequestParams) => Promise<
|
|
335
|
+
export declare const getApiV21OrdersIdOrderItems: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdOrderItemsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem[]>;
|
|
336
336
|
/**
|
|
337
337
|
* No description
|
|
338
338
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticeItemsCountParams, GetApiV21ShipnoticeItemsIdMetaFieldsParams, GetApiV2ShipnoticeItemsCountParams, GetApiV2ShipnoticeItemsIdMetaFieldsParams, PutApiV21ShipnoticeItems, PutApiV21ShipnoticeItemsIdMetaFields, PutApiV2ShipnoticeItems, PutApiV2ShipnoticeItemsIdMetaFields } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesShipnoticeItem, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticeItemsCountParams, GetApiV21ShipnoticeItemsIdMetaFieldsParams, GetApiV2ShipnoticeItemsCountParams, GetApiV2ShipnoticeItemsIdMetaFieldsParams, PutApiV21ShipnoticeItems, PutApiV21ShipnoticeItemsIdMetaFields, PutApiV2ShipnoticeItems, PutApiV2ShipnoticeItemsIdMetaFields } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get resource actions
|
|
@@ -17,7 +17,7 @@ export declare const getApiV2ShipnoticeItemsActions: (client: HttpClient, params
|
|
|
17
17
|
* @summary Destroy a shipnotice item
|
|
18
18
|
* @request DELETE:/api/v2/shipnotice_items/{id}
|
|
19
19
|
*/
|
|
20
|
-
export declare const deleteApiV2ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
20
|
+
export declare const deleteApiV2ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
21
21
|
/**
|
|
22
22
|
* No description
|
|
23
23
|
*
|
|
@@ -80,7 +80,7 @@ export declare const getApiV21ShipnoticeItemsActions: (client: HttpClient, param
|
|
|
80
80
|
* @summary Destroy a shipnotice item
|
|
81
81
|
* @request DELETE:/api/v2.1/shipnotice_items/{id}
|
|
82
82
|
*/
|
|
83
|
-
export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -89,7 +89,7 @@ export declare const deleteApiV21ShipnoticeItemsId: (client: HttpClient, id: num
|
|
|
89
89
|
* @summary Update a ship notice item
|
|
90
90
|
* @request PUT:/api/v2.1/shipnotice_items/{id}
|
|
91
91
|
*/
|
|
92
|
-
export declare const putApiV21ShipnoticeItemsId: (client: HttpClient, id: number, ApiV21ShipnoticeItems: PutApiV21ShipnoticeItems, params?: RequestParams) => Promise<
|
|
92
|
+
export declare const putApiV21ShipnoticeItemsId: (client: HttpClient, id: number, ApiV21ShipnoticeItems: PutApiV21ShipnoticeItems, params?: RequestParams) => Promise<void>;
|
|
93
93
|
/**
|
|
94
94
|
* No description
|
|
95
95
|
*
|
|
@@ -98,7 +98,7 @@ export declare const putApiV21ShipnoticeItemsId: (client: HttpClient, id: number
|
|
|
98
98
|
* @summary Retrieve a ship notice item
|
|
99
99
|
* @request GET:/api/v2.1/shipnotice_items/{id}
|
|
100
100
|
*/
|
|
101
|
-
export declare const getApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const getApiV21ShipnoticeItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem>;
|
|
102
102
|
/**
|
|
103
103
|
* @description Update ShipnoticeItem meta fields
|
|
104
104
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShipnotice, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticesCountParams, GetApiV21ShipnoticesIdMetaFieldsParams, GetApiV21ShipnoticesIdShipnoticeItemsCountParams, GetApiV21ShipnoticesIdShipnoticeItemsParams, GetApiV21ShipnoticesParams, GetApiV2ShipnoticesCountParams, GetApiV2ShipnoticesIdMetaFieldsParams, GetApiV2ShipnoticesIdShipnoticeItemsCountParams, GetApiV2ShipnoticesIdShipnoticeItemsParams, GetApiV2ShipnoticesParams, PostApiV21Shipnotices, PostApiV21ShipnoticesIdShipnoticeItems, PostApiV2Shipnotices, PostApiV2ShipnoticesIdShipnoticeItems, PutApiV21Shipnotices, PutApiV21ShipnoticesIdMetaFields, PutApiV21ShipnoticesOriginator, PutApiV2Shipnotices, PutApiV2ShipnoticesIdMetaFields, PutApiV2ShipnoticesOriginator } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV21EntitiesShipnotice, APIV21EntitiesShipnoticeItem, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShipnotice, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticesCountParams, GetApiV21ShipnoticesIdMetaFieldsParams, GetApiV21ShipnoticesIdShipnoticeItemsCountParams, GetApiV21ShipnoticesIdShipnoticeItemsParams, GetApiV21ShipnoticesParams, GetApiV2ShipnoticesCountParams, GetApiV2ShipnoticesIdMetaFieldsParams, GetApiV2ShipnoticesIdShipnoticeItemsCountParams, GetApiV2ShipnoticesIdShipnoticeItemsParams, GetApiV2ShipnoticesParams, PostApiV21Shipnotices, PostApiV21ShipnoticesIdShipnoticeItems, PostApiV2Shipnotices, PostApiV2ShipnoticesIdShipnoticeItems, PutApiV21Shipnotices, PutApiV21ShipnoticesIdMetaFields, PutApiV21ShipnoticesOriginator, PutApiV2Shipnotices, PutApiV2ShipnoticesIdMetaFields, PutApiV2ShipnoticesOriginator } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -44,7 +44,7 @@ export declare const getApiV2ShipnoticesActions: (client: HttpClient, params?: R
|
|
|
44
44
|
* @summary Destroy a ship notice
|
|
45
45
|
* @request DELETE:/api/v2/shipnotices/originator/{originator_id}
|
|
46
46
|
*/
|
|
47
|
-
export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
47
|
+
export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
48
48
|
/**
|
|
49
49
|
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
50
50
|
*
|
|
@@ -80,7 +80,7 @@ export declare const getApiV2ShipnoticesIdOrdersWaiting: (client: HttpClient, id
|
|
|
80
80
|
* @summary Destroy a ship notice
|
|
81
81
|
* @request DELETE:/api/v2/shipnotices/{id}
|
|
82
82
|
*/
|
|
83
|
-
export declare const deleteApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const deleteApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
86
86
|
*
|
|
@@ -170,7 +170,7 @@ export declare const postApiV21Shipnotices: (client: HttpClient, ApiV21Shipnotic
|
|
|
170
170
|
* @summary List all ship notices
|
|
171
171
|
* @request GET:/api/v2.1/shipnotices
|
|
172
172
|
*/
|
|
173
|
-
export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<
|
|
173
|
+
export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<APIV21EntitiesShipnotice[]>;
|
|
174
174
|
/**
|
|
175
175
|
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created shipnotices.
|
|
176
176
|
*
|
|
@@ -197,7 +197,7 @@ export declare const getApiV21ShipnoticesActions: (client: HttpClient, params?:
|
|
|
197
197
|
* @summary Destroy a ship notice
|
|
198
198
|
* @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
|
|
199
199
|
*/
|
|
200
|
-
export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
200
|
+
export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
201
201
|
/**
|
|
202
202
|
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
203
203
|
*
|
|
@@ -215,7 +215,7 @@ export declare const putApiV21ShipnoticesOriginatorOriginatorId: (client: HttpCl
|
|
|
215
215
|
* @summary Retrieve a ship notice
|
|
216
216
|
* @request GET:/api/v2.1/shipnotices/originator/{originator_id}
|
|
217
217
|
*/
|
|
218
|
-
export declare const getApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<
|
|
218
|
+
export declare const getApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
|
|
219
219
|
/**
|
|
220
220
|
* No description
|
|
221
221
|
*
|
|
@@ -233,7 +233,7 @@ export declare const getApiV21ShipnoticesIdOrdersWaiting: (client: HttpClient, i
|
|
|
233
233
|
* @summary Destroy a ship notice
|
|
234
234
|
* @request DELETE:/api/v2.1/shipnotices/{id}
|
|
235
235
|
*/
|
|
236
|
-
export declare const deleteApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
236
|
+
export declare const deleteApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
237
237
|
/**
|
|
238
238
|
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
239
239
|
*
|
|
@@ -251,7 +251,7 @@ export declare const putApiV21ShipnoticesId: (client: HttpClient, id: number, Ap
|
|
|
251
251
|
* @summary Retrieve a ship notice
|
|
252
252
|
* @request GET:/api/v2.1/shipnotices/{id}
|
|
253
253
|
*/
|
|
254
|
-
export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
254
|
+
export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
|
|
255
255
|
/**
|
|
256
256
|
* No description
|
|
257
257
|
*
|
|
@@ -260,7 +260,7 @@ export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, pa
|
|
|
260
260
|
* @summary Create a ship notice item
|
|
261
261
|
* @request POST:/api/v2.1/shipnotices/{id}/shipnotice_items
|
|
262
262
|
*/
|
|
263
|
-
export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, ApiV21ShipnoticesIdShipnoticeItems: PostApiV21ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<
|
|
263
|
+
export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, ApiV21ShipnoticesIdShipnoticeItems: PostApiV21ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
264
264
|
/**
|
|
265
265
|
* No description
|
|
266
266
|
*
|
|
@@ -269,7 +269,7 @@ export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient
|
|
|
269
269
|
* @summary List associated ship notice items
|
|
270
270
|
* @request GET:/api/v2.1/shipnotices/{id}/shipnotice_items
|
|
271
271
|
*/
|
|
272
|
-
export declare const getApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<
|
|
272
|
+
export declare const getApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
|
|
273
273
|
/**
|
|
274
274
|
* @description Update Shipnotice meta fields
|
|
275
275
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesConsumerReturn, APIV2EntitiesOrder, APIV2EntitiesShipnotice, PostApiV21SimulateConsumerReturnsCreate, PostApiV21SimulateOrdersCreate, PostApiV21SimulateShipnoticesCreate, PostApiV2SimulateConsumerReturnsCreate, PostApiV2SimulateOrdersCreate, PostApiV2SimulateShipnoticesCreate, PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, PutApiV21SimulateOrdersOrderIdProcessing, PutApiV21SimulateShipnoticesShipnoticeIdProcessing, PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing, PutApiV2SimulateOrdersOrderIdProcessing, PutApiV2SimulateShipnoticesShipnoticeIdProcessing } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV2EntitiesConsumerReturn, APIV2EntitiesOrder, APIV2EntitiesShipnotice, PostApiV21SimulateConsumerReturnsCreate, PostApiV21SimulateOrdersCreate, PostApiV21SimulateShipnoticesCreate, PostApiV2SimulateConsumerReturnsCreate, PostApiV2SimulateOrdersCreate, PostApiV2SimulateShipnoticesCreate, PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, PutApiV21SimulateOrdersOrderIdProcessing, PutApiV21SimulateShipnoticesShipnoticeIdProcessing, PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing, PutApiV2SimulateOrdersOrderIdProcessing, PutApiV2SimulateShipnoticesShipnoticeIdProcessing } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Customer users don't have access to staff actions, so this simulates a consumer return's workflow, allowing you to process a consumer return and, optionally, finalize it.
|
|
@@ -62,7 +62,7 @@ export declare const postApiV2SimulateOrdersCreate: (client: HttpClient, ApiV2Si
|
|
|
62
62
|
* @summary Simulate processing for an consumer return
|
|
63
63
|
* @request PUT:/api/v2.1/simulate/consumer_returns/{consumer_return_id}/processing
|
|
64
64
|
*/
|
|
65
|
-
export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, ApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<
|
|
65
|
+
export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, ApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<void>;
|
|
66
66
|
/**
|
|
67
67
|
* No description
|
|
68
68
|
*
|
|
@@ -71,7 +71,7 @@ export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing:
|
|
|
71
71
|
* @summary Create a consumer return with simulated data
|
|
72
72
|
* @request POST:/api/v2.1/simulate/consumer_returns/create
|
|
73
73
|
*/
|
|
74
|
-
export declare const postApiV21SimulateConsumerReturnsCreate: (client: HttpClient, ApiV21SimulateConsumerReturnsCreate: PostApiV21SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<
|
|
74
|
+
export declare const postApiV21SimulateConsumerReturnsCreate: (client: HttpClient, ApiV21SimulateConsumerReturnsCreate: PostApiV21SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
75
75
|
/**
|
|
76
76
|
* @description Customer users don't have access to staff actions, so this simulates a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
|
|
77
77
|
*
|
|
@@ -80,7 +80,7 @@ export declare const postApiV21SimulateConsumerReturnsCreate: (client: HttpClien
|
|
|
80
80
|
* @summary Simulate processing for an ship notice
|
|
81
81
|
* @request PUT:/api/v2.1/simulate/shipnotices/{shipnotice_id}/processing
|
|
82
82
|
*/
|
|
83
|
-
export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, ApiV21SimulateShipnoticesShipnoticeIdProcessing: PutApiV21SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, ApiV21SimulateShipnoticesShipnoticeIdProcessing: PutApiV21SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -89,7 +89,7 @@ export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client
|
|
|
89
89
|
* @summary Create a shipnotice with simulated data
|
|
90
90
|
* @request POST:/api/v2.1/simulate/shipnotices/create
|
|
91
91
|
*/
|
|
92
|
-
export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient, ApiV21SimulateShipnoticesCreate: PostApiV21SimulateShipnoticesCreate, params?: RequestParams) => Promise<
|
|
92
|
+
export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient, ApiV21SimulateShipnoticesCreate: PostApiV21SimulateShipnoticesCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
93
93
|
/**
|
|
94
94
|
* @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
|
|
95
95
|
*
|
|
@@ -98,7 +98,7 @@ export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient, A
|
|
|
98
98
|
* @summary Simulate processing for an order
|
|
99
99
|
* @request PUT:/api/v2.1/simulate/orders/{order_id}/processing
|
|
100
100
|
*/
|
|
101
|
-
export declare const putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, ApiV21SimulateOrdersOrderIdProcessing: PutApiV21SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<
|
|
101
|
+
export declare const putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, ApiV21SimulateOrdersOrderIdProcessing: PutApiV21SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
102
102
|
/**
|
|
103
103
|
* No description
|
|
104
104
|
*
|
|
@@ -107,4 +107,4 @@ export declare const putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClie
|
|
|
107
107
|
* @summary Create an order with simulated data
|
|
108
108
|
* @request POST:/api/v2.1/simulate/orders/create
|
|
109
109
|
*/
|
|
110
|
-
export declare const postApiV21SimulateOrdersCreate: (client: HttpClient, ApiV21SimulateOrdersCreate: PostApiV21SimulateOrdersCreate, params?: RequestParams) => Promise<
|
|
110
|
+
export declare const postApiV21SimulateOrdersCreate: (client: HttpClient, ApiV21SimulateOrdersCreate: PostApiV21SimulateOrdersCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV2EntitiesTemplate, GetApiV21TemplatesParams, GetApiV2TemplatesParams, PostApiV21Templates, PostApiV2Templates, PutApiV21Templates, PutApiV2Templates } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV21EntitiesTemplate, APIV2EntitiesTemplate, GetApiV21TemplatesParams, GetApiV2TemplatesParams, PostApiV21Templates, PostApiV2Templates, PutApiV21Templates, PutApiV2Templates } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* No description
|
|
@@ -53,7 +53,7 @@ export declare const getApiV2Templates: (client: HttpClient, query: GetApiV2Temp
|
|
|
53
53
|
* @summary Create a template
|
|
54
54
|
* @request POST:/api/v2.1/templates
|
|
55
55
|
*/
|
|
56
|
-
export declare const postApiV21Templates: (client: HttpClient, ApiV21Templates: PostApiV21Templates, params?: RequestParams) => Promise<
|
|
56
|
+
export declare const postApiV21Templates: (client: HttpClient, ApiV21Templates: PostApiV21Templates, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
57
57
|
/**
|
|
58
58
|
* No description
|
|
59
59
|
*
|
|
@@ -62,7 +62,7 @@ export declare const postApiV21Templates: (client: HttpClient, ApiV21Templates:
|
|
|
62
62
|
* @summary List all templates
|
|
63
63
|
* @request GET:/api/v2.1/templates
|
|
64
64
|
*/
|
|
65
|
-
export declare const getApiV21Templates: (client: HttpClient, query: GetApiV21TemplatesParams, params?: RequestParams) => Promise<
|
|
65
|
+
export declare const getApiV21Templates: (client: HttpClient, query: GetApiV21TemplatesParams, params?: RequestParams) => Promise<APIV21EntitiesTemplate[]>;
|
|
66
66
|
/**
|
|
67
67
|
* No description
|
|
68
68
|
*
|
|
@@ -80,7 +80,7 @@ export declare const deleteApiV21TemplatesId: (client: HttpClient, id: number, p
|
|
|
80
80
|
* @summary Update a template
|
|
81
81
|
* @request PUT:/api/v2.1/templates/{id}
|
|
82
82
|
*/
|
|
83
|
-
export declare const putApiV21TemplatesId: (client: HttpClient, id: number, ApiV21Templates: PutApiV21Templates, params?: RequestParams) => Promise<
|
|
83
|
+
export declare const putApiV21TemplatesId: (client: HttpClient, id: number, ApiV21Templates: PutApiV21Templates, params?: RequestParams) => Promise<void>;
|
|
84
84
|
/**
|
|
85
85
|
* No description
|
|
86
86
|
*
|
|
@@ -89,4 +89,4 @@ export declare const putApiV21TemplatesId: (client: HttpClient, id: number, ApiV
|
|
|
89
89
|
* @summary Retrieve a template
|
|
90
90
|
* @request GET:/api/v2.1/templates/{id}
|
|
91
91
|
*/
|
|
92
|
-
export declare const getApiV21TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<
|
|
92
|
+
export declare const getApiV21TemplatesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesTemplate>;
|