@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.
@@ -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, 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, 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
- * No description
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 GetApiV2Shipnotices
17
- * @summary List all ship notices
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 getApiV2Shipnotices: (client: HttpClient, query: GetApiV2ShipnoticesParams, params?: RequestParams) => Promise<APIV2EntitiesShipnotice[]>;
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, ApiV2ShipnoticesBulk: PostApiV2ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
20
+ export declare const postApiV2ShipnoticesBulk: (client: HttpClient, postApiV2ShipnoticesBulk: PostApiV2ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
30
21
  /**
31
- * @description Get resource actions
22
+ * No description
32
23
  *
33
24
  * @tags shipnotices
34
- * @name GetApiV2ShipnoticesActions
35
- * @summary List actions you can perform
36
- * @request GET:/api/v2/shipnotices/actions
25
+ * @name GetApiV2Shipnotices
26
+ * @summary List all ship notices
27
+ * @request GET:/api/v2/shipnotices
37
28
  */
38
- export declare const getApiV2ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
29
+ export declare const getApiV2Shipnotices: (client: HttpClient, query: GetApiV2ShipnoticesParams, params?: RequestParams) => Promise<APIV2EntitiesShipnotice[]>;
39
30
  /**
40
31
  * No description
41
32
  *
42
- * @tags originators
43
- * @name DeleteApiV2ShipnoticesOriginatorOriginatorId
44
- * @summary Destroy a ship notice
45
- * @request DELETE:/api/v2/shipnotices/originator/{originator_id}
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 putApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV2ShipnoticesOriginator: PutApiV2ShipnoticesOriginator, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
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
- * No description
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 shipnotices
70
- * @name GetApiV2ShipnoticesIdOrdersWaiting
71
- * @summary Count orders waiting for stock in a ship notice
72
- * @request GET:/api/v2/shipnotices/{id}/orders_waiting
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 getApiV2ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCount>;
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 shipnotices
79
- * @name DeleteApiV2ShipnoticesId
60
+ * @tags originators
61
+ * @name DeleteApiV2ShipnoticesOriginatorOriginatorId
80
62
  * @summary Destroy a ship notice
81
- * @request DELETE:/api/v2/shipnotices/{id}
63
+ * @request DELETE:/api/v2/shipnotices/originator/{originator_id}
82
64
  */
83
- export declare const deleteApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
65
+ export declare const deleteApiV2ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
84
66
  /**
85
- * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
67
+ * @description Get the meta fields for a(n) Shipnotice
86
68
  *
87
69
  * @tags shipnotices
88
- * @name PutApiV2ShipnoticesId
89
- * @summary Update a ship notice
90
- * @request PUT:/api/v2/shipnotices/{id}
70
+ * @name GetApiV2ShipnoticesIdMetaFields
71
+ * @summary List meta fields
72
+ * @request GET:/api/v2/shipnotices/{id}/meta_fields
91
73
  */
92
- export declare const putApiV2ShipnoticesId: (client: HttpClient, id: number, ApiV2Shipnotices: PutApiV2Shipnotices, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
74
+ export declare const getApiV2ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
93
75
  /**
94
- * No description
76
+ * @description Update Shipnotice meta fields
95
77
  *
96
78
  * @tags shipnotices
97
- * @name GetApiV2ShipnoticesId
98
- * @summary Retrieve a ship notice
99
- * @request GET:/api/v2/shipnotices/{id}
79
+ * @name PutApiV2ShipnoticesIdMetaFields
80
+ * @summary Set meta fields
81
+ * @request PUT:/api/v2/shipnotices/{id}/meta_fields
100
82
  */
101
- export declare const getApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
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, ApiV2ShipnoticesIdShipnoticeItems: PostApiV2ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem>;
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
- * @description Update Shipnotice meta fields
103
+ * No description
122
104
  *
123
105
  * @tags shipnotices
124
- * @name PutApiV2ShipnoticesIdMetaFields
125
- * @summary Set meta fields
126
- * @request PUT:/api/v2/shipnotices/{id}/meta_fields
106
+ * @name GetApiV2ShipnoticesId
107
+ * @summary Retrieve a ship notice
108
+ * @request GET:/api/v2/shipnotices/{id}
127
109
  */
128
- export declare const putApiV2ShipnoticesIdMetaFields: (client: HttpClient, id: number, ApiV2ShipnoticesIdMetaFields: PutApiV2ShipnoticesIdMetaFields, params?: RequestParams) => Promise<void>;
110
+ export declare const getApiV2ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
129
111
  /**
130
- * @description Get the meta fields for a(n) Shipnotice
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 GetApiV2ShipnoticesIdMetaFields
134
- * @summary List meta fields
135
- * @request GET:/api/v2/shipnotices/{id}/meta_fields
115
+ * @name PutApiV2ShipnoticesId
116
+ * @summary Update a ship notice
117
+ * @request PUT:/api/v2/shipnotices/{id}
136
118
  */
137
- export declare const getApiV2ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
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
- * No description
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 GetApiV21Shipnotices
170
- * @summary List all ship notices
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 getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<APIV21EntitiesShipnotice[]>;
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, ApiV21ShipnoticesBulk: PostApiV21ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
173
+ export declare const postApiV21ShipnoticesBulk: (client: HttpClient, postApiV21ShipnoticesBulk: PostApiV21ShipnoticesBulk, params?: RequestParams) => Promise<APIV2EntitiesResult>;
183
174
  /**
184
- * @description Get resource actions
175
+ * No description
185
176
  *
186
177
  * @tags shipnotices
187
- * @name GetApiV21ShipnoticesActions
188
- * @summary List actions you can perform
189
- * @request GET:/api/v2.1/shipnotices/actions
178
+ * @name GetApiV21Shipnotices
179
+ * @summary List all ship notices
180
+ * @request GET:/api/v2.1/shipnotices
190
181
  */
191
- export declare const getApiV21ShipnoticesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
182
+ export declare const getApiV21Shipnotices: (client: HttpClient, query: GetApiV21ShipnoticesParams, params?: RequestParams) => Promise<APIV21EntitiesShipnotice[]>;
192
183
  /**
193
184
  * No description
194
185
  *
195
- * @tags originators
196
- * @name DeleteApiV21ShipnoticesOriginatorOriginatorId
197
- * @summary Destroy a ship notice
198
- * @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
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 putApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV21ShipnoticesOriginator: PutApiV21ShipnoticesOriginator, params?: RequestParams) => Promise<void>;
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
- * No description
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 shipnotices
223
- * @name GetApiV21ShipnoticesIdOrdersWaiting
224
- * @summary Count orders waiting for stock in a ship notice
225
- * @request GET:/api/v2.1/shipnotices/{id}/orders_waiting
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 getApiV21ShipnoticesIdOrdersWaiting: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCount>;
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 shipnotices
232
- * @name DeleteApiV21ShipnoticesId
213
+ * @tags originators
214
+ * @name DeleteApiV21ShipnoticesOriginatorOriginatorId
233
215
  * @summary Destroy a ship notice
234
- * @request DELETE:/api/v2.1/shipnotices/{id}
216
+ * @request DELETE:/api/v2.1/shipnotices/originator/{originator_id}
235
217
  */
236
- export declare const deleteApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
218
+ export declare const deleteApiV21ShipnoticesOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
237
219
  /**
238
- * @description NOTE: You may not update a ship notice's items en masse. You must edit them individually after they've been created.
220
+ * @description Get the meta fields for a(n) Shipnotice
239
221
  *
240
222
  * @tags shipnotices
241
- * @name PutApiV21ShipnoticesId
242
- * @summary Update a ship notice
243
- * @request PUT:/api/v2.1/shipnotices/{id}
223
+ * @name GetApiV21ShipnoticesIdMetaFields
224
+ * @summary List meta fields
225
+ * @request GET:/api/v2.1/shipnotices/{id}/meta_fields
244
226
  */
245
- export declare const putApiV21ShipnoticesId: (client: HttpClient, id: number, ApiV21Shipnotices: PutApiV21Shipnotices, params?: RequestParams) => Promise<void>;
227
+ export declare const getApiV21ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
246
228
  /**
247
- * No description
229
+ * @description Update Shipnotice meta fields
248
230
  *
249
231
  * @tags shipnotices
250
- * @name GetApiV21ShipnoticesId
251
- * @summary Retrieve a ship notice
252
- * @request GET:/api/v2.1/shipnotices/{id}
232
+ * @name PutApiV21ShipnoticesIdMetaFields
233
+ * @summary Set meta fields
234
+ * @request PUT:/api/v2.1/shipnotices/{id}/meta_fields
253
235
  */
254
- export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
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, ApiV21ShipnoticesIdShipnoticeItems: PostApiV21ShipnoticesIdShipnoticeItems, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
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
- * @description Update Shipnotice meta fields
256
+ * No description
275
257
  *
276
258
  * @tags shipnotices
277
- * @name PutApiV21ShipnoticesIdMetaFields
278
- * @summary Set meta fields
279
- * @request PUT:/api/v2.1/shipnotices/{id}/meta_fields
259
+ * @name GetApiV21ShipnoticesId
260
+ * @summary Retrieve a ship notice
261
+ * @request GET:/api/v2.1/shipnotices/{id}
280
262
  */
281
- export declare const putApiV21ShipnoticesIdMetaFields: (client: HttpClient, id: number, ApiV21ShipnoticesIdMetaFields: PutApiV21ShipnoticesIdMetaFields, params?: RequestParams) => Promise<void>;
263
+ export declare const getApiV21ShipnoticesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesShipnotice>;
282
264
  /**
283
- * @description Get the meta fields for a(n) Shipnotice
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 GetApiV21ShipnoticesIdMetaFields
287
- * @summary List meta fields
288
- * @request GET:/api/v2.1/shipnotices/{id}/meta_fields
268
+ * @name PutApiV21ShipnoticesId
269
+ * @summary Update a ship notice
270
+ * @request PUT:/api/v2.1/shipnotices/{id}
289
271
  */
290
- export declare const getApiV21ShipnoticesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ShipnoticesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
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 PostApiV2SimulateConsumerReturnsCreate
17
- * @summary Create a consumer return with simulated data
18
- * @request POST:/api/v2/simulate/consumer_returns/create
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 postApiV2SimulateConsumerReturnsCreate: (client: HttpClient, ApiV2SimulateConsumerReturnsCreate: PostApiV2SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<APIV2EntitiesConsumerReturn>;
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 a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
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 PutApiV2SimulateShipnoticesShipnoticeIdProcessing
26
- * @summary Simulate processing for an ship notice
27
- * @request PUT:/api/v2/simulate/shipnotices/{shipnotice_id}/processing
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 putApiV2SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, ApiV2SimulateShipnoticesShipnoticeIdProcessing: PutApiV2SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
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, ApiV2SimulateShipnoticesCreate: PostApiV2SimulateShipnoticesCreate, params?: RequestParams) => Promise<APIV2EntitiesShipnotice>;
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 an order's workflow, from batched to packed to shipped
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 PutApiV2SimulateOrdersOrderIdProcessing
44
- * @summary Simulate processing for an order
45
- * @request PUT:/api/v2/simulate/orders/{order_id}/processing
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 putApiV2SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, ApiV2SimulateOrdersOrderIdProcessing: PutApiV2SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
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 PostApiV2SimulateOrdersCreate
53
- * @summary Create an order with simulated data
54
- * @request POST:/api/v2/simulate/orders/create
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 postApiV2SimulateOrdersCreate: (client: HttpClient, ApiV2SimulateOrdersCreate: PostApiV2SimulateOrdersCreate, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
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 PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing
52
+ * @name PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing
62
53
  * @summary Simulate processing for an consumer return
63
- * @request PUT:/api/v2.1/simulate/consumer_returns/{consumer_return_id}/processing
54
+ * @request PUT:/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
64
55
  */
65
- export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, ApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<void>;
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 PostApiV21SimulateConsumerReturnsCreate
71
- * @summary Create a consumer return with simulated data
72
- * @request POST:/api/v2.1/simulate/consumer_returns/create
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 postApiV21SimulateConsumerReturnsCreate: (client: HttpClient, ApiV21SimulateConsumerReturnsCreate: PostApiV21SimulateConsumerReturnsCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
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 a ship notice's workflow, allowing you to process a ship notice and, optionally, finalize it.
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 PutApiV21SimulateShipnoticesShipnoticeIdProcessing
80
- * @summary Simulate processing for an ship notice
81
- * @request PUT:/api/v2.1/simulate/shipnotices/{shipnotice_id}/processing
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 putApiV21SimulateShipnoticesShipnoticeIdProcessing: (client: HttpClient, shipnoticeId: number, ApiV21SimulateShipnoticesShipnoticeIdProcessing: PutApiV21SimulateShipnoticesShipnoticeIdProcessing, params?: RequestParams) => Promise<void>;
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, ApiV21SimulateShipnoticesCreate: PostApiV21SimulateShipnoticesCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
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 an order's workflow, from batched to packed to shipped
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 PutApiV21SimulateOrdersOrderIdProcessing
98
- * @summary Simulate processing for an order
99
- * @request PUT:/api/v2.1/simulate/orders/{order_id}/processing
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 putApiV21SimulateOrdersOrderIdProcessing: (client: HttpClient, orderId: number, ApiV21SimulateOrdersOrderIdProcessing: PutApiV21SimulateOrdersOrderIdProcessing, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
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 PostApiV21SimulateOrdersCreate
107
- * @summary Create an order with simulated data
108
- * @request POST:/api/v2.1/simulate/orders/create
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 postApiV21SimulateOrdersCreate: (client: HttpClient, ApiV21SimulateOrdersCreate: PostApiV21SimulateOrdersCreate, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
110
+ export declare const putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: (client: HttpClient, consumerReturnId: number, putApiV21SimulateConsumerReturnsConsumerReturnIdProcessing: PutApiV21SimulateConsumerReturnsConsumerReturnIdProcessing, params?: RequestParams) => Promise<void>;