@whiplashmerch/whiplash-api-client 0.4.69 → 0.4.71
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 +2689 -2689
- package/dist/client.esm.js.map +1 -1
- package/dist/generated/BundleItems.d.ts +23 -23
- package/dist/generated/ConsumerReturns.d.ts +87 -87
- package/dist/generated/Customers.d.ts +39 -39
- package/dist/generated/Documents.d.ts +35 -35
- package/dist/generated/Items.d.ts +211 -211
- package/dist/generated/NotificationSubscriptions.d.ts +51 -51
- package/dist/generated/OrderItems.d.ts +43 -43
- package/dist/generated/Orders.d.ts +145 -145
- package/dist/generated/ShipnoticeItems.d.ts +41 -41
- package/dist/generated/Shipnotices.d.ts +131 -131
- package/dist/generated/Simulate.d.ts +50 -50
- package/dist/generated/Templates.d.ts +31 -31
- package/dist/generated/data-contracts.d.ts +267 -271
- package/generated/BundleItems.ts +36 -36
- package/generated/ConsumerReturns.ts +183 -183
- package/generated/Customers.ts +70 -70
- package/generated/Documents.ts +68 -68
- package/generated/Items.ts +401 -401
- package/generated/NotificationSubscriptions.ts +96 -96
- package/generated/OrderItems.ts +87 -87
- package/generated/Orders.ts +291 -287
- package/generated/ShipnoticeItems.ts +81 -81
- package/generated/Shipnotices.ts +239 -239
- package/generated/Simulate.ts +104 -104
- package/generated/Templates.ts +53 -53
- package/generated/data-contracts.ts +273 -277
- package/package.json +1 -1
|
@@ -1,23 +1,14 @@
|
|
|
1
|
-
import { APIV21EntitiesPostResponse, APIV21EntitiesShipnotice, APIV21EntitiesShipnoticeItem, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShipnotice, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticesCountParams, GetApiV21ShipnoticesIdMetaFieldsParams, GetApiV21ShipnoticesIdShipnoticeItemsCountParams, GetApiV21ShipnoticesIdShipnoticeItemsParams, GetApiV21ShipnoticesParams, GetApiV2ShipnoticesCountParams, GetApiV2ShipnoticesIdMetaFieldsParams, GetApiV2ShipnoticesIdShipnoticeItemsCountParams, GetApiV2ShipnoticesIdShipnoticeItemsParams, GetApiV2ShipnoticesParams, PostApiV21Shipnotices, PostApiV21ShipnoticesBulk, PostApiV21ShipnoticesIdShipnoticeItems, PostApiV2Shipnotices, PostApiV2ShipnoticesBulk, PostApiV2ShipnoticesIdShipnoticeItems,
|
|
1
|
+
import { APIV21EntitiesPostResponse, APIV21EntitiesShipnotice, APIV21EntitiesShipnoticeItem, APIV2EntitiesCount, APIV2EntitiesMetaFields, APIV2EntitiesResult, APIV2EntitiesShipnotice, APIV2EntitiesShipnoticeItem, GetApiV21ShipnoticesCountParams, GetApiV21ShipnoticesIdMetaFieldsParams, GetApiV21ShipnoticesIdShipnoticeItemsCountParams, GetApiV21ShipnoticesIdShipnoticeItemsParams, GetApiV21ShipnoticesParams, GetApiV2ShipnoticesCountParams, GetApiV2ShipnoticesIdMetaFieldsParams, GetApiV2ShipnoticesIdShipnoticeItemsCountParams, GetApiV2ShipnoticesIdShipnoticeItemsParams, GetApiV2ShipnoticesParams, PostApiV21Shipnotices, PostApiV21ShipnoticesBulk, PostApiV21ShipnoticesIdShipnoticeItems, PostApiV2Shipnotices, PostApiV2ShipnoticesBulk, PostApiV2ShipnoticesIdShipnoticeItems, PutApiV21ShipnoticesId, PutApiV21ShipnoticesIdMetaFields, PutApiV21ShipnoticesOriginatorOriginatorId, PutApiV2ShipnoticesId, PutApiV2ShipnoticesIdMetaFields, PutApiV2ShipnoticesOriginatorOriginatorId } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* @tags shipnotices
|
|
7
|
-
* @name PostApiV2Shipnotices
|
|
8
|
-
* @summary Create a ship notice
|
|
9
|
-
* @request POST:/api/v2/shipnotices
|
|
10
|
-
*/
|
|
11
|
-
export declare const postApiV2Shipnotices: (client: HttpClient, ApiV2Shipnotices: PostApiV2Shipnotices, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
12
|
-
/**
|
|
13
|
-
* No description
|
|
4
|
+
* @description Get resource actions
|
|
14
5
|
*
|
|
15
6
|
* @tags shipnotices
|
|
16
|
-
* @name
|
|
17
|
-
* @summary List
|
|
18
|
-
* @request GET:/api/v2/shipnotices
|
|
7
|
+
* @name GetApiV2ShipnoticesActions
|
|
8
|
+
* @summary List actions you can perform
|
|
9
|
+
* @request GET:/api/v2/shipnotices/actions
|
|
19
10
|
*/
|
|
20
|
-
export declare const
|
|
11
|
+
export declare const getApiV2ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
21
12
|
/**
|
|
22
13
|
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created shipnotices.
|
|
23
14
|
*
|
|
@@ -26,34 +17,25 @@ export declare const getApiV2Shipnotices: (client: HttpClient, query: GetApiV2Sh
|
|
|
26
17
|
* @summary Create shipnotices in bulk
|
|
27
18
|
* @request POST:/api/v2/shipnotices/bulk
|
|
28
19
|
*/
|
|
29
|
-
export declare const postApiV2ShipnoticesBulk: (client: HttpClient,
|
|
20
|
+
export declare const postApiV2ShipnoticesBulk: (client: HttpClient, postApiV2ShipnoticesBulk: PostApiV2ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
30
21
|
/**
|
|
31
|
-
*
|
|
22
|
+
* No description
|
|
32
23
|
*
|
|
33
24
|
* @tags shipnotices
|
|
34
|
-
* @name
|
|
35
|
-
* @summary List
|
|
36
|
-
* @request GET:/api/v2/shipnotices
|
|
25
|
+
* @name GetApiV2Shipnotices
|
|
26
|
+
* @summary List all ship notices
|
|
27
|
+
* @request GET:/api/v2/shipnotices
|
|
37
28
|
*/
|
|
38
|
-
export declare const
|
|
29
|
+
export declare const getApiV2Shipnotices: (client: HttpClient, query: GetApiV2ShipnoticesParams, params?: RequestParams) => Promise<APIV2EntitiesShipnotice[]>;
|
|
39
30
|
/**
|
|
40
31
|
* No description
|
|
41
32
|
*
|
|
42
|
-
* @tags
|
|
43
|
-
* @name
|
|
44
|
-
* @summary
|
|
45
|
-
* @request
|
|
46
|
-
*/
|
|
47
|
-
export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
48
|
-
/**
|
|
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
|
-
*
|
|
51
|
-
* @tags originators
|
|
52
|
-
* @name PutApiV2ShipnoticesOriginatorOriginatorId
|
|
53
|
-
* @summary Update a ship notice
|
|
54
|
-
* @request PUT:/api/v2/shipnotices/originator/{originator_id}
|
|
33
|
+
* @tags shipnotices
|
|
34
|
+
* @name PostApiV2Shipnotices
|
|
35
|
+
* @summary Create a ship notice
|
|
36
|
+
* @request POST:/api/v2/shipnotices
|
|
55
37
|
*/
|
|
56
|
-
export declare const
|
|
38
|
+
export declare const postApiV2Shipnotices: (client: HttpClient, postApiV2Shipnotices: PostApiV2Shipnotices, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
57
39
|
/**
|
|
58
40
|
* No description
|
|
59
41
|
*
|
|
@@ -64,41 +46,41 @@ export declare const putApiV2ShipnoticesOriginatorOriginatorId: (client: HttpCli
|
|
|
64
46
|
*/
|
|
65
47
|
export declare const getApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
66
48
|
/**
|
|
67
|
-
*
|
|
49
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
68
50
|
*
|
|
69
|
-
* @tags
|
|
70
|
-
* @name
|
|
71
|
-
* @summary
|
|
72
|
-
* @request
|
|
51
|
+
* @tags originators
|
|
52
|
+
* @name PutApiV2ShipnoticesOriginatorOriginatorId
|
|
53
|
+
* @summary Update a ship notice
|
|
54
|
+
* @request PUT:/api/v2/shipnotices/originator/{originator_id}
|
|
73
55
|
*/
|
|
74
|
-
export declare const
|
|
56
|
+
export declare const putApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV2ShipnoticesOriginatorOriginatorId: PutApiV2ShipnoticesOriginatorOriginatorId, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
75
57
|
/**
|
|
76
58
|
* No description
|
|
77
59
|
*
|
|
78
|
-
* @tags
|
|
79
|
-
* @name
|
|
60
|
+
* @tags originators
|
|
61
|
+
* @name DeleteApiV2ShipnoticesOriginatorOriginatorId
|
|
80
62
|
* @summary Destroy a ship notice
|
|
81
|
-
* @request DELETE:/api/v2/shipnotices/{
|
|
63
|
+
* @request DELETE:/api/v2/shipnotices/originator/{originator_id}
|
|
82
64
|
*/
|
|
83
|
-
export declare const
|
|
65
|
+
export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
84
66
|
/**
|
|
85
|
-
* @description
|
|
67
|
+
* @description Get the meta fields for a(n) Shipnotice
|
|
86
68
|
*
|
|
87
69
|
* @tags shipnotices
|
|
88
|
-
* @name
|
|
89
|
-
* @summary
|
|
90
|
-
* @request
|
|
70
|
+
* @name GetApiV2ShipnoticesIdMetaFields
|
|
71
|
+
* @summary List meta fields
|
|
72
|
+
* @request GET:/api/v2/shipnotices/{id}/meta_fields
|
|
91
73
|
*/
|
|
92
|
-
export declare const
|
|
74
|
+
export declare const getApiV2ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
93
75
|
/**
|
|
94
|
-
*
|
|
76
|
+
* @description Update Shipnotice meta fields
|
|
95
77
|
*
|
|
96
78
|
* @tags shipnotices
|
|
97
|
-
* @name
|
|
98
|
-
* @summary
|
|
99
|
-
* @request
|
|
79
|
+
* @name PutApiV2ShipnoticesIdMetaFields
|
|
80
|
+
* @summary Set meta fields
|
|
81
|
+
* @request PUT:/api/v2/shipnotices/{id}/meta_fields
|
|
100
82
|
*/
|
|
101
|
-
export declare const
|
|
83
|
+
export declare const putApiV2ShipnoticesIdMetaFields: (client: HttpClient, id: number, putApiV2ShipnoticesIdMetaFields: PutApiV2ShipnoticesIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
102
84
|
/**
|
|
103
85
|
* No description
|
|
104
86
|
*
|
|
@@ -107,7 +89,7 @@ export declare const getApiV2ShipnoticesId: (client: HttpClient, id: number, par
|
|
|
107
89
|
* @summary Create a ship notice item
|
|
108
90
|
* @request POST:/api/v2/shipnotices/{id}/shipnotice_items
|
|
109
91
|
*/
|
|
110
|
-
export declare const postApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number,
|
|
92
|
+
export declare const postApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, postApiV2ShipnoticesIdShipnoticeItems: PostApiV2ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
|
|
111
93
|
/**
|
|
112
94
|
* No description
|
|
113
95
|
*
|
|
@@ -118,23 +100,41 @@ export declare const postApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient,
|
|
|
118
100
|
*/
|
|
119
101
|
export declare const getApiV2ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem[]>;
|
|
120
102
|
/**
|
|
121
|
-
*
|
|
103
|
+
* No description
|
|
122
104
|
*
|
|
123
105
|
* @tags shipnotices
|
|
124
|
-
* @name
|
|
125
|
-
* @summary
|
|
126
|
-
* @request
|
|
106
|
+
* @name GetApiV2ShipnoticesId
|
|
107
|
+
* @summary Retrieve a ship notice
|
|
108
|
+
* @request GET:/api/v2/shipnotices/{id}
|
|
127
109
|
*/
|
|
128
|
-
export declare const
|
|
110
|
+
export declare const getApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
129
111
|
/**
|
|
130
|
-
* @description
|
|
112
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
131
113
|
*
|
|
132
114
|
* @tags shipnotices
|
|
133
|
-
* @name
|
|
134
|
-
* @summary
|
|
135
|
-
* @request
|
|
115
|
+
* @name PutApiV2ShipnoticesId
|
|
116
|
+
* @summary Update a ship notice
|
|
117
|
+
* @request PUT:/api/v2/shipnotices/{id}
|
|
136
118
|
*/
|
|
137
|
-
export declare const
|
|
119
|
+
export declare const putApiV2ShipnoticesId: (client: HttpClient, id: number, putApiV2ShipnoticesId: PutApiV2ShipnoticesId, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
120
|
+
/**
|
|
121
|
+
* No description
|
|
122
|
+
*
|
|
123
|
+
* @tags shipnotices
|
|
124
|
+
* @name DeleteApiV2ShipnoticesId
|
|
125
|
+
* @summary Destroy a ship notice
|
|
126
|
+
* @request DELETE:/api/v2/shipnotices/{id}
|
|
127
|
+
*/
|
|
128
|
+
export declare const deleteApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
129
|
+
/**
|
|
130
|
+
* No description
|
|
131
|
+
*
|
|
132
|
+
* @tags shipnotices
|
|
133
|
+
* @name GetApiV2ShipnoticesIdOrdersWaiting
|
|
134
|
+
* @summary Count orders waiting for stock in a ship notice
|
|
135
|
+
* @request GET:/api/v2/shipnotices/{id}/orders_waiting
|
|
136
|
+
*/
|
|
137
|
+
export declare const getApiV2ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
138
138
|
/**
|
|
139
139
|
* No description
|
|
140
140
|
*
|
|
@@ -154,23 +154,14 @@ export declare const getApiV2ShipnoticesIdShipnoticeItemsCount: (client: HttpCli
|
|
|
154
154
|
*/
|
|
155
155
|
export declare const getApiV2ShipnoticesCount: (client: HttpClient, query: GetApiV2ShipnoticesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
156
156
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* @tags shipnotices
|
|
160
|
-
* @name PostApiV21Shipnotices
|
|
161
|
-
* @summary Create a ship notice
|
|
162
|
-
* @request POST:/api/v2.1/shipnotices
|
|
163
|
-
*/
|
|
164
|
-
export declare const postApiV21Shipnotices: (client: HttpClient, ApiV21Shipnotices: PostApiV21Shipnotices, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
165
|
-
/**
|
|
166
|
-
* No description
|
|
157
|
+
* @description Get resource actions
|
|
167
158
|
*
|
|
168
159
|
* @tags shipnotices
|
|
169
|
-
* @name
|
|
170
|
-
* @summary List
|
|
171
|
-
* @request GET:/api/v2.1/shipnotices
|
|
160
|
+
* @name GetApiV21ShipnoticesActions
|
|
161
|
+
* @summary List actions you can perform
|
|
162
|
+
* @request GET:/api/v2.1/shipnotices/actions
|
|
172
163
|
*/
|
|
173
|
-
export declare const
|
|
164
|
+
export declare const getApiV21ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
174
165
|
/**
|
|
175
166
|
* @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created shipnotices.
|
|
176
167
|
*
|
|
@@ -179,34 +170,25 @@ export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21
|
|
|
179
170
|
* @summary Create shipnotices in bulk
|
|
180
171
|
* @request POST:/api/v2.1/shipnotices/bulk
|
|
181
172
|
*/
|
|
182
|
-
export declare const postApiV21ShipnoticesBulk: (client: HttpClient,
|
|
173
|
+
export declare const postApiV21ShipnoticesBulk: (client: HttpClient, postApiV21ShipnoticesBulk: PostApiV21ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
183
174
|
/**
|
|
184
|
-
*
|
|
175
|
+
* No description
|
|
185
176
|
*
|
|
186
177
|
* @tags shipnotices
|
|
187
|
-
* @name
|
|
188
|
-
* @summary List
|
|
189
|
-
* @request GET:/api/v2.1/shipnotices
|
|
178
|
+
* @name GetApiV21Shipnotices
|
|
179
|
+
* @summary List all ship notices
|
|
180
|
+
* @request GET:/api/v2.1/shipnotices
|
|
190
181
|
*/
|
|
191
|
-
export declare const
|
|
182
|
+
export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<APIV21EntitiesShipnotice[]>;
|
|
192
183
|
/**
|
|
193
184
|
* No description
|
|
194
185
|
*
|
|
195
|
-
* @tags
|
|
196
|
-
* @name
|
|
197
|
-
* @summary
|
|
198
|
-
* @request
|
|
199
|
-
*/
|
|
200
|
-
export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
201
|
-
/**
|
|
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
|
-
*
|
|
204
|
-
* @tags originators
|
|
205
|
-
* @name PutApiV21ShipnoticesOriginatorOriginatorId
|
|
206
|
-
* @summary Update a ship notice
|
|
207
|
-
* @request PUT:/api/v2.1/shipnotices/originator/{originator_id}
|
|
186
|
+
* @tags shipnotices
|
|
187
|
+
* @name PostApiV21Shipnotices
|
|
188
|
+
* @summary Create a ship notice
|
|
189
|
+
* @request POST:/api/v2.1/shipnotices
|
|
208
190
|
*/
|
|
209
|
-
export declare const
|
|
191
|
+
export declare const postApiV21Shipnotices: (client: HttpClient, postApiV21Shipnotices: PostApiV21Shipnotices, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
210
192
|
/**
|
|
211
193
|
* No description
|
|
212
194
|
*
|
|
@@ -217,41 +199,41 @@ export declare const putApiV21ShipnoticesOriginatorOriginatorId: (client: HttpCl
|
|
|
217
199
|
*/
|
|
218
200
|
export declare const getApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
|
|
219
201
|
/**
|
|
220
|
-
*
|
|
202
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
221
203
|
*
|
|
222
|
-
* @tags
|
|
223
|
-
* @name
|
|
224
|
-
* @summary
|
|
225
|
-
* @request
|
|
204
|
+
* @tags originators
|
|
205
|
+
* @name PutApiV21ShipnoticesOriginatorOriginatorId
|
|
206
|
+
* @summary Update a ship notice
|
|
207
|
+
* @request PUT:/api/v2.1/shipnotices/originator/{originator_id}
|
|
226
208
|
*/
|
|
227
|
-
export declare const
|
|
209
|
+
export declare const putApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV21ShipnoticesOriginatorOriginatorId: PutApiV21ShipnoticesOriginatorOriginatorId, params?: RequestParams) => Promise<void>;
|
|
228
210
|
/**
|
|
229
211
|
* No description
|
|
230
212
|
*
|
|
231
|
-
* @tags
|
|
232
|
-
* @name
|
|
213
|
+
* @tags originators
|
|
214
|
+
* @name DeleteApiV21ShipnoticesOriginatorOriginatorId
|
|
233
215
|
* @summary Destroy a ship notice
|
|
234
|
-
* @request DELETE:/api/v2.1/shipnotices/{
|
|
216
|
+
* @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
|
|
235
217
|
*/
|
|
236
|
-
export declare const
|
|
218
|
+
export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
|
|
237
219
|
/**
|
|
238
|
-
* @description
|
|
220
|
+
* @description Get the meta fields for a(n) Shipnotice
|
|
239
221
|
*
|
|
240
222
|
* @tags shipnotices
|
|
241
|
-
* @name
|
|
242
|
-
* @summary
|
|
243
|
-
* @request
|
|
223
|
+
* @name GetApiV21ShipnoticesIdMetaFields
|
|
224
|
+
* @summary List meta fields
|
|
225
|
+
* @request GET:/api/v2.1/shipnotices/{id}/meta_fields
|
|
244
226
|
*/
|
|
245
|
-
export declare const
|
|
227
|
+
export declare const getApiV21ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
246
228
|
/**
|
|
247
|
-
*
|
|
229
|
+
* @description Update Shipnotice meta fields
|
|
248
230
|
*
|
|
249
231
|
* @tags shipnotices
|
|
250
|
-
* @name
|
|
251
|
-
* @summary
|
|
252
|
-
* @request
|
|
232
|
+
* @name PutApiV21ShipnoticesIdMetaFields
|
|
233
|
+
* @summary Set meta fields
|
|
234
|
+
* @request PUT:/api/v2.1/shipnotices/{id}/meta_fields
|
|
253
235
|
*/
|
|
254
|
-
export declare const
|
|
236
|
+
export declare const putApiV21ShipnoticesIdMetaFields: (client: HttpClient, id: number, putApiV21ShipnoticesIdMetaFields: PutApiV21ShipnoticesIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
255
237
|
/**
|
|
256
238
|
* No description
|
|
257
239
|
*
|
|
@@ -260,7 +242,7 @@ export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, pa
|
|
|
260
242
|
* @summary Create a ship notice item
|
|
261
243
|
* @request POST:/api/v2.1/shipnotices/{id}/shipnotice_items
|
|
262
244
|
*/
|
|
263
|
-
export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number,
|
|
245
|
+
export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, id: number, postApiV21ShipnoticesIdShipnoticeItems: PostApiV21ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
264
246
|
/**
|
|
265
247
|
* No description
|
|
266
248
|
*
|
|
@@ -271,23 +253,41 @@ export declare const postApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient
|
|
|
271
253
|
*/
|
|
272
254
|
export declare const getApiV21ShipnoticesIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
|
|
273
255
|
/**
|
|
274
|
-
*
|
|
256
|
+
* No description
|
|
275
257
|
*
|
|
276
258
|
* @tags shipnotices
|
|
277
|
-
* @name
|
|
278
|
-
* @summary
|
|
279
|
-
* @request
|
|
259
|
+
* @name GetApiV21ShipnoticesId
|
|
260
|
+
* @summary Retrieve a ship notice
|
|
261
|
+
* @request GET:/api/v2.1/shipnotices/{id}
|
|
280
262
|
*/
|
|
281
|
-
export declare const
|
|
263
|
+
export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
|
|
282
264
|
/**
|
|
283
|
-
* @description
|
|
265
|
+
* @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
|
|
284
266
|
*
|
|
285
267
|
* @tags shipnotices
|
|
286
|
-
* @name
|
|
287
|
-
* @summary
|
|
288
|
-
* @request
|
|
268
|
+
* @name PutApiV21ShipnoticesId
|
|
269
|
+
* @summary Update a ship notice
|
|
270
|
+
* @request PUT:/api/v2.1/shipnotices/{id}
|
|
289
271
|
*/
|
|
290
|
-
export declare const
|
|
272
|
+
export declare const putApiV21ShipnoticesId: (client: HttpClient, id: number, putApiV21ShipnoticesId: PutApiV21ShipnoticesId, params?: RequestParams) => Promise<void>;
|
|
273
|
+
/**
|
|
274
|
+
* No description
|
|
275
|
+
*
|
|
276
|
+
* @tags shipnotices
|
|
277
|
+
* @name DeleteApiV21ShipnoticesId
|
|
278
|
+
* @summary Destroy a ship notice
|
|
279
|
+
* @request DELETE:/api/v2.1/shipnotices/{id}
|
|
280
|
+
*/
|
|
281
|
+
export declare const deleteApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
282
|
+
/**
|
|
283
|
+
* No description
|
|
284
|
+
*
|
|
285
|
+
* @tags shipnotices
|
|
286
|
+
* @name GetApiV21ShipnoticesIdOrdersWaiting
|
|
287
|
+
* @summary Count orders waiting for stock in a ship notice
|
|
288
|
+
* @request GET:/api/v2.1/shipnotices/{id}/orders_waiting
|
|
289
|
+
*/
|
|
290
|
+
export declare const getApiV21ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
291
291
|
/**
|
|
292
292
|
* No description
|
|
293
293
|
*
|
|
@@ -1,32 +1,23 @@
|
|
|
1
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
|
-
/**
|
|
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.
|
|
5
|
-
*
|
|
6
|
-
* @tags simulate
|
|
7
|
-
* @name PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
|
|
8
|
-
* @summary Simulate processing for an consumer return
|
|
9
|
-
* @request PUT:/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
|
|
10
|
-
*/
|
|
11
|
-
export declare const putApiV2SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, ApiV2SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
12
3
|
/**
|
|
13
4
|
* No description
|
|
14
5
|
*
|
|
15
6
|
* @tags simulate
|
|
16
|
-
* @name
|
|
17
|
-
* @summary Create
|
|
18
|
-
* @request POST:/api/v2/simulate/
|
|
7
|
+
* @name PostApiV2SimulateOrdersCreate
|
|
8
|
+
* @summary Create an order with simulated data
|
|
9
|
+
* @request POST:/api/v2/simulate/orders/create
|
|
19
10
|
*/
|
|
20
|
-
export declare const
|
|
11
|
+
export declare const postApiV2SimulateOrdersCreate: (client: HttpClient, postApiV2SimulateOrdersCreate: PostApiV2SimulateOrdersCreate, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
21
12
|
/**
|
|
22
|
-
* @description Customer users don't have access to staff actions, so this simulates
|
|
13
|
+
* @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
|
|
23
14
|
*
|
|
24
15
|
* @tags simulate
|
|
25
|
-
* @name
|
|
26
|
-
* @summary Simulate processing for an
|
|
27
|
-
* @request PUT:/api/v2/simulate/
|
|
16
|
+
* @name PutApiV2SimulateOrdersOrderIdProcessing
|
|
17
|
+
* @summary Simulate processing for an order
|
|
18
|
+
* @request PUT:/api/v2/simulate/orders/{order_id}/processing
|
|
28
19
|
*/
|
|
29
|
-
export declare const
|
|
20
|
+
export declare const putApiV2SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, putApiV2SimulateOrdersOrderIdProcessing: PutApiV2SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
|
|
30
21
|
/**
|
|
31
22
|
* No description
|
|
32
23
|
*
|
|
@@ -35,52 +26,52 @@ export declare const putApiV2SimulateShipnoticesShipnoticeIdProcessing: (client:
|
|
|
35
26
|
* @summary Create a shipnotice with simulated data
|
|
36
27
|
* @request POST:/api/v2/simulate/shipnotices/create
|
|
37
28
|
*/
|
|
38
|
-
export declare const postApiV2SimulateShipnoticesCreate: (client: HttpClient,
|
|
29
|
+
export declare const postApiV2SimulateShipnoticesCreate: (client: HttpClient, postApiV2SimulateShipnoticesCreate: PostApiV2SimulateShipnoticesCreate, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
39
30
|
/**
|
|
40
|
-
* @description Customer users don't have access to staff actions, so this simulates
|
|
31
|
+
* @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.
|
|
41
32
|
*
|
|
42
33
|
* @tags simulate
|
|
43
|
-
* @name
|
|
44
|
-
* @summary Simulate processing for an
|
|
45
|
-
* @request PUT:/api/v2/simulate/
|
|
34
|
+
* @name PutApiV2SimulateShipnoticesShipnoticeIdProcessing
|
|
35
|
+
* @summary Simulate processing for an ship notice
|
|
36
|
+
* @request PUT:/api/v2/simulate/shipnotices/{shipnotice_id}/processing
|
|
46
37
|
*/
|
|
47
|
-
export declare const
|
|
38
|
+
export declare const putApiV2SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, putApiV2SimulateShipnoticesShipnoticeIdProcessing: PutApiV2SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
|
|
48
39
|
/**
|
|
49
40
|
* No description
|
|
50
41
|
*
|
|
51
42
|
* @tags simulate
|
|
52
|
-
* @name
|
|
53
|
-
* @summary Create
|
|
54
|
-
* @request POST:/api/v2/simulate/
|
|
43
|
+
* @name PostApiV2SimulateConsumerReturnsCreate
|
|
44
|
+
* @summary Create a consumer return with simulated data
|
|
45
|
+
* @request POST:/api/v2/simulate/consumer_returns/create
|
|
55
46
|
*/
|
|
56
|
-
export declare const
|
|
47
|
+
export declare const postApiV2SimulateConsumerReturnsCreate: (client: HttpClient, postApiV2SimulateConsumerReturnsCreate: PostApiV2SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
57
48
|
/**
|
|
58
49
|
* @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.
|
|
59
50
|
*
|
|
60
51
|
* @tags simulate
|
|
61
|
-
* @name
|
|
52
|
+
* @name PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
|
|
62
53
|
* @summary Simulate processing for an consumer return
|
|
63
|
-
* @request PUT:/api/v2
|
|
54
|
+
* @request PUT:/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
|
|
64
55
|
*/
|
|
65
|
-
export declare const
|
|
56
|
+
export declare const putApiV2SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, putApiV2SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
|
|
66
57
|
/**
|
|
67
58
|
* No description
|
|
68
59
|
*
|
|
69
60
|
* @tags simulate
|
|
70
|
-
* @name
|
|
71
|
-
* @summary Create
|
|
72
|
-
* @request POST:/api/v2.1/simulate/
|
|
61
|
+
* @name PostApiV21SimulateOrdersCreate
|
|
62
|
+
* @summary Create an order with simulated data
|
|
63
|
+
* @request POST:/api/v2.1/simulate/orders/create
|
|
73
64
|
*/
|
|
74
|
-
export declare const
|
|
65
|
+
export declare const postApiV21SimulateOrdersCreate: (client: HttpClient, postApiV21SimulateOrdersCreate: PostApiV21SimulateOrdersCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
75
66
|
/**
|
|
76
|
-
* @description Customer users don't have access to staff actions, so this simulates
|
|
67
|
+
* @description Customer users don't have access to staff actions, so this simulates an order's workflow, from batched to packed to shipped
|
|
77
68
|
*
|
|
78
69
|
* @tags simulate
|
|
79
|
-
* @name
|
|
80
|
-
* @summary Simulate processing for an
|
|
81
|
-
* @request PUT:/api/v2.1/simulate/
|
|
70
|
+
* @name PutApiV21SimulateOrdersOrderIdProcessing
|
|
71
|
+
* @summary Simulate processing for an order
|
|
72
|
+
* @request PUT:/api/v2.1/simulate/orders/{order_id}/processing
|
|
82
73
|
*/
|
|
83
|
-
export declare const
|
|
74
|
+
export declare const putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, putApiV21SimulateOrdersOrderIdProcessing: PutApiV21SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
84
75
|
/**
|
|
85
76
|
* No description
|
|
86
77
|
*
|
|
@@ -89,22 +80,31 @@ export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client
|
|
|
89
80
|
* @summary Create a shipnotice with simulated data
|
|
90
81
|
* @request POST:/api/v2.1/simulate/shipnotices/create
|
|
91
82
|
*/
|
|
92
|
-
export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient,
|
|
83
|
+
export declare const postApiV21SimulateShipnoticesCreate: (client: HttpClient, postApiV21SimulateShipnoticesCreate: PostApiV21SimulateShipnoticesCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
93
84
|
/**
|
|
94
|
-
* @description Customer users don't have access to staff actions, so this simulates
|
|
85
|
+
* @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.
|
|
95
86
|
*
|
|
96
87
|
* @tags simulate
|
|
97
|
-
* @name
|
|
98
|
-
* @summary Simulate processing for an
|
|
99
|
-
* @request PUT:/api/v2.1/simulate/
|
|
88
|
+
* @name PutApiV21SimulateShipnoticesShipnoticeIdProcessing
|
|
89
|
+
* @summary Simulate processing for an ship notice
|
|
90
|
+
* @request PUT:/api/v2.1/simulate/shipnotices/{shipnotice_id}/processing
|
|
100
91
|
*/
|
|
101
|
-
export declare const
|
|
92
|
+
export declare const putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, putApiV21SimulateShipnoticesShipnoticeIdProcessing: PutApiV21SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<void>;
|
|
102
93
|
/**
|
|
103
94
|
* No description
|
|
104
95
|
*
|
|
105
96
|
* @tags simulate
|
|
106
|
-
* @name
|
|
107
|
-
* @summary Create
|
|
108
|
-
* @request POST:/api/v2.1/simulate/
|
|
97
|
+
* @name PostApiV21SimulateConsumerReturnsCreate
|
|
98
|
+
* @summary Create a consumer return with simulated data
|
|
99
|
+
* @request POST:/api/v2.1/simulate/consumer_returns/create
|
|
100
|
+
*/
|
|
101
|
+
export declare const postApiV21SimulateConsumerReturnsCreate: (client: HttpClient, postApiV21SimulateConsumerReturnsCreate: PostApiV21SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
102
|
+
/**
|
|
103
|
+
* @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.
|
|
104
|
+
*
|
|
105
|
+
* @tags simulate
|
|
106
|
+
* @name PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing
|
|
107
|
+
* @summary Simulate processing for an consumer return
|
|
108
|
+
* @request PUT:/api/v2.1/simulate/consumer_returns/{consumer_return_id}/processing
|
|
109
109
|
*/
|
|
110
|
-
export declare const
|
|
110
|
+
export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<void>;
|