@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,14 +1,14 @@
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";
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, PutApiV21ItemsId, PutApiV21ItemsIdCallAction, PutApiV21ItemsIdMetaFields, PutApiV21ItemsOriginatorOriginatorId, PutApiV2ItemsId, PutApiV2ItemsIdCallAction, PutApiV2ItemsIdMetaFields, PutApiV2ItemsOriginatorOriginatorId } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
- * No description
4
+ * @description Get resource actions
5
5
  *
6
6
  * @tags items
7
- * @name PostApiV2Items
8
- * @summary Create an item
9
- * @request POST:/api/v2/items
7
+ * @name GetApiV2ItemsActions
8
+ * @summary List actions you can perform
9
+ * @request GET:/api/v2/items/actions
10
10
  */
11
- export declare const postApiV2Items: (client: HttpClient, ApiV2Items: PostApiV2Items, params?: RequestParams) => Promise<APIV2EntitiesItem>;
11
+ export declare const getApiV2ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
12
  /**
13
13
  * No description
14
14
  *
@@ -19,41 +19,41 @@ export declare const postApiV2Items: (client: HttpClient, ApiV2Items: PostApiV2I
19
19
  */
20
20
  export declare const getApiV2Items: (client: HttpClient, query: GetApiV2ItemsParams, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
21
21
  /**
22
- * @description Get resource actions
22
+ * No description
23
23
  *
24
24
  * @tags items
25
- * @name GetApiV2ItemsActions
26
- * @summary List actions you can perform
27
- * @request GET:/api/v2/items/actions
25
+ * @name PostApiV2Items
26
+ * @summary Create an item
27
+ * @request POST:/api/v2/items
28
28
  */
29
- export declare const getApiV2ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
29
+ export declare const postApiV2Items: (client: HttpClient, postApiV2Items: PostApiV2Items, params?: RequestParams) => Promise<APIV2EntitiesItem>;
30
30
  /**
31
- * @description An item may have many alternate scancodes
31
+ * No description
32
32
  *
33
33
  * @tags originators
34
- * @name GetApiV2ItemsOriginatorOriginatorIdScancodes
35
- * @summary List all scancodes associated with this item
36
- * @request GET:/api/v2/items/originator/{originator_id}/scancodes
34
+ * @name GetApiV2ItemsOriginatorOriginatorId
35
+ * @summary Retrieve an item
36
+ * @request GET:/api/v2/items/originator/{originator_id}
37
37
  */
38
- export declare const getApiV2ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
38
+ export declare const getApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
39
39
  /**
40
- * @description Retrieve the quantity of this item in each warehouse in which it has stock
40
+ * No description
41
41
  *
42
42
  * @tags originators
43
- * @name GetApiV2ItemsOriginatorOriginatorIdWarehouseQuantities
44
- * @summary Item stock by warehouse
45
- * @request GET:/api/v2/items/originator/{originator_id}/warehouse_quantities
43
+ * @name PutApiV2ItemsOriginatorOriginatorId
44
+ * @summary Update an item
45
+ * @request PUT:/api/v2/items/originator/{originator_id}
46
46
  */
47
- export declare const getApiV2ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
47
+ export declare const putApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV2ItemsOriginatorOriginatorId: PutApiV2ItemsOriginatorOriginatorId, params?: RequestParams) => Promise<APIV2EntitiesItem>;
48
48
  /**
49
- * No description
49
+ * @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.
50
50
  *
51
51
  * @tags originators
52
- * @name GetApiV2ItemsOriginatorOriginatorIdBundleItems
53
- * @summary List all bundle items containing this item
54
- * @request GET:/api/v2/items/originator/{originator_id}/bundle_items
52
+ * @name DeleteApiV2ItemsOriginatorOriginatorId
53
+ * @summary Archive an item
54
+ * @request DELETE:/api/v2/items/originator/{originator_id}
55
55
  */
56
- export declare const getApiV2ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
56
+ export declare const deleteApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
57
57
  /**
58
58
  * No description
59
59
  *
@@ -64,68 +64,77 @@ export declare const getApiV2ItemsOriginatorOriginatorIdBundleItems: (client: Ht
64
64
  */
65
65
  export declare const getApiV2ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
66
66
  /**
67
- * @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.
67
+ * No description
68
68
  *
69
69
  * @tags originators
70
- * @name DeleteApiV2ItemsOriginatorOriginatorId
71
- * @summary Archive an item
72
- * @request DELETE:/api/v2/items/originator/{originator_id}
70
+ * @name GetApiV2ItemsOriginatorOriginatorIdBundleItems
71
+ * @summary List all bundle items containing this item
72
+ * @request GET:/api/v2/items/originator/{originator_id}/bundle_items
73
73
  */
74
- export declare const deleteApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
74
+ export declare const getApiV2ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
75
75
  /**
76
- * No description
76
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
77
77
  *
78
78
  * @tags originators
79
- * @name PutApiV2ItemsOriginatorOriginatorId
80
- * @summary Update an item
81
- * @request PUT:/api/v2/items/originator/{originator_id}
79
+ * @name GetApiV2ItemsOriginatorOriginatorIdWarehouseQuantities
80
+ * @summary Item stock by warehouse
81
+ * @request GET:/api/v2/items/originator/{originator_id}/warehouse_quantities
82
82
  */
83
- export declare const putApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV2ItemsOriginator: PutApiV2ItemsOriginator, params?: RequestParams) => Promise<APIV2EntitiesItem>;
83
+ export declare const getApiV2ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
84
84
  /**
85
- * No description
85
+ * @description An item may have many alternate scancodes
86
86
  *
87
87
  * @tags originators
88
- * @name GetApiV2ItemsOriginatorOriginatorId
89
- * @summary Retrieve an item
90
- * @request GET:/api/v2/items/originator/{originator_id}
88
+ * @name GetApiV2ItemsOriginatorOriginatorIdScancodes
89
+ * @summary List all scancodes associated with this item
90
+ * @request GET:/api/v2/items/originator/{originator_id}/scancodes
91
91
  */
92
- export declare const getApiV2ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
92
+ export declare const getApiV2ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV2ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
93
93
  /**
94
- * @description Update Item meta fields
94
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
95
95
  *
96
96
  * @tags items
97
- * @name PutApiV2ItemsIdMetaFields
98
- * @summary Set meta fields
99
- * @request PUT:/api/v2/items/{id}/meta_fields
97
+ * @name GetApiV2ItemsIdOriginators
98
+ * @summary List associated originators
99
+ * @request GET:/api/v2/items/{id}/originators
100
100
  */
101
- export declare const putApiV2ItemsIdMetaFields: (client: HttpClient, id: number, ApiV2ItemsIdMetaFields: PutApiV2ItemsIdMetaFields, params?: RequestParams) => Promise<void>;
101
+ export declare const getApiV2ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
102
102
  /**
103
- * @description Get the meta fields for a(n) Item
103
+ * No description
104
104
  *
105
105
  * @tags items
106
- * @name GetApiV2ItemsIdMetaFields
107
- * @summary List meta fields
108
- * @request GET:/api/v2/items/{id}/meta_fields
106
+ * @name GetApiV2ItemsId
107
+ * @summary Retrieve an item
108
+ * @request GET:/api/v2/items/{id}
109
109
  */
110
- export declare const getApiV2ItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
110
+ export declare const getApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
111
111
  /**
112
- * @description An item may have many alternate scancodes
112
+ * No description
113
113
  *
114
114
  * @tags items
115
- * @name GetApiV2ItemsIdScancodes
116
- * @summary List all scancodes associated with this item
117
- * @request GET:/api/v2/items/{id}/scancodes
115
+ * @name PutApiV2ItemsId
116
+ * @summary Update an item
117
+ * @request PUT:/api/v2/items/{id}
118
118
  */
119
- export declare const getApiV2ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
119
+ export declare const putApiV2ItemsId: (client: HttpClient, id: number, putApiV2ItemsId: PutApiV2ItemsId, params?: RequestParams) => Promise<APIV2EntitiesItem>;
120
120
  /**
121
- * @description Retrieve the quantity of this item in each warehouse in which it has stock
121
+ * @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.
122
122
  *
123
123
  * @tags items
124
- * @name GetApiV2ItemsIdWarehouseQuantities
125
- * @summary Item stock by warehouse
126
- * @request GET:/api/v2/items/{id}/warehouse_quantities
124
+ * @name DeleteApiV2ItemsId
125
+ * @summary Archive an item
126
+ * @request DELETE:/api/v2/items/{id}
127
127
  */
128
- export declare const getApiV2ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
128
+ export declare const deleteApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
129
+ /**
130
+ * No description
131
+ *
132
+ * @tags items
133
+ * @name GetApiV2ItemsIdInBundles
134
+ * @summary List all instances of this item in bundles
135
+ * @request GET:/api/v2/items/{id}/in_bundles
136
+ */
137
+ export declare const getApiV2ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
129
138
  /**
130
139
  * No description
131
140
  *
@@ -143,52 +152,43 @@ export declare const getApiV2ItemsIdBundleItems: (client: HttpClient, id: number
143
152
  * @summary Add an item to an bundle
144
153
  * @request POST:/api/v2/items/{id}/bundle_items
145
154
  */
146
- export declare const postApiV2ItemsIdBundleItems: (client: HttpClient, id: number, ApiV2ItemsIdBundleItems: PostApiV2ItemsIdBundleItems, params?: RequestParams) => Promise<APIV2EntitiesBundleItem>;
147
- /**
148
- * No description
149
- *
150
- * @tags items
151
- * @name GetApiV2ItemsIdInBundles
152
- * @summary List all instances of this item in bundles
153
- * @request GET:/api/v2/items/{id}/in_bundles
154
- */
155
- export declare const getApiV2ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem[]>;
155
+ export declare const postApiV2ItemsIdBundleItems: (client: HttpClient, id: number, postApiV2ItemsIdBundleItems: PostApiV2ItemsIdBundleItems, params?: RequestParams) => Promise<APIV2EntitiesBundleItem>;
156
156
  /**
157
- * @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.
157
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
158
158
  *
159
159
  * @tags items
160
- * @name DeleteApiV2ItemsId
161
- * @summary Archive an item
162
- * @request DELETE:/api/v2/items/{id}
160
+ * @name GetApiV2ItemsIdWarehouseQuantities
161
+ * @summary Item stock by warehouse
162
+ * @request GET:/api/v2/items/{id}/warehouse_quantities
163
163
  */
164
- export declare const deleteApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
164
+ export declare const getApiV2ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
165
165
  /**
166
- * No description
166
+ * @description An item may have many alternate scancodes
167
167
  *
168
168
  * @tags items
169
- * @name PutApiV2ItemsId
170
- * @summary Update an item
171
- * @request PUT:/api/v2/items/{id}
169
+ * @name GetApiV2ItemsIdScancodes
170
+ * @summary List all scancodes associated with this item
171
+ * @request GET:/api/v2/items/{id}/scancodes
172
172
  */
173
- export declare const putApiV2ItemsId: (client: HttpClient, id: number, ApiV2Items: PutApiV2Items, params?: RequestParams) => Promise<APIV2EntitiesItem>;
173
+ export declare const getApiV2ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
174
174
  /**
175
- * No description
175
+ * @description Get the meta fields for a(n) Item
176
176
  *
177
177
  * @tags items
178
- * @name GetApiV2ItemsId
179
- * @summary Retrieve an item
180
- * @request GET:/api/v2/items/{id}
178
+ * @name GetApiV2ItemsIdMetaFields
179
+ * @summary List meta fields
180
+ * @request GET:/api/v2/items/{id}/meta_fields
181
181
  */
182
- export declare const getApiV2ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItem>;
182
+ export declare const getApiV2ItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
183
183
  /**
184
- * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
184
+ * @description Update Item meta fields
185
185
  *
186
186
  * @tags items
187
- * @name GetApiV2ItemsIdOriginators
188
- * @summary List associated originators
189
- * @request GET:/api/v2/items/{id}/originators
187
+ * @name PutApiV2ItemsIdMetaFields
188
+ * @summary Set meta fields
189
+ * @request PUT:/api/v2/items/{id}/meta_fields
190
190
  */
191
- export declare const getApiV2ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
191
+ export declare const putApiV2ItemsIdMetaFields: (client: HttpClient, id: number, putApiV2ItemsIdMetaFields: PutApiV2ItemsIdMetaFields, params?: RequestParams) => Promise<void>;
192
192
  /**
193
193
  * No description
194
194
  *
@@ -206,16 +206,7 @@ export declare const getApiV2ItemsCount: (client: HttpClient, query: GetApiV2Ite
206
206
  * @summary Perform an action on an item
207
207
  * @request PUT:/api/v2/items/{id}/call/{action}
208
208
  */
209
- export declare const putApiV2ItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV2ItemsIdCall: PutApiV2ItemsIdCall, params?: RequestParams) => Promise<APIV2EntitiesItem>;
210
- /**
211
- * No description
212
- *
213
- * @tags items
214
- * @name GetApiV2ItemsIdShipnoticeItemsCount
215
- * @summary Count associated ship notice items
216
- * @request GET:/api/v2/items/{id}/shipnotice_items/count
217
- */
218
- export declare const getApiV2ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
209
+ export declare const putApiV2ItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV2ItemsIdCallAction: PutApiV2ItemsIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesItem>;
219
210
  /**
220
211
  * No description
221
212
  *
@@ -226,14 +217,14 @@ export declare const getApiV2ItemsIdShipnoticeItemsCount: (client: HttpClient, {
226
217
  */
227
218
  export declare const getApiV2ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV2EntitiesShipnoticeItem[]>;
228
219
  /**
229
- * @description Returns count of item transactions
220
+ * No description
230
221
  *
231
222
  * @tags items
232
- * @name GetApiV2ItemsIdTransactionsCount
233
- * @summary Count the transactions in an item's history
234
- * @request GET:/api/v2/items/{id}/transactions/count
223
+ * @name GetApiV2ItemsIdShipnoticeItemsCount
224
+ * @summary Count associated ship notice items
225
+ * @request GET:/api/v2/items/{id}/shipnotice_items/count
235
226
  */
236
- export declare const getApiV2ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
227
+ export declare const getApiV2ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
237
228
  /**
238
229
  * @description Get all transactions for an item
239
230
  *
@@ -244,14 +235,23 @@ export declare const getApiV2ItemsIdTransactionsCount: (client: HttpClient, { id
244
235
  */
245
236
  export declare const getApiV2ItemsIdTransactions: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdTransactionsParams, params?: RequestParams) => Promise<APIV2EntitiesTransaction[]>;
246
237
  /**
247
- * No description
238
+ * @description Returns count of item transactions
248
239
  *
249
240
  * @tags items
250
- * @name PostApiV21Items
251
- * @summary Create an item
252
- * @request POST:/api/v2.1/items
241
+ * @name GetApiV2ItemsIdTransactionsCount
242
+ * @summary Count the transactions in an item's history
243
+ * @request GET:/api/v2/items/{id}/transactions/count
244
+ */
245
+ export declare const getApiV2ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV2ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
246
+ /**
247
+ * @description Get resource actions
248
+ *
249
+ * @tags items
250
+ * @name GetApiV21ItemsActions
251
+ * @summary List actions you can perform
252
+ * @request GET:/api/v2.1/items/actions
253
253
  */
254
- export declare const postApiV21Items: (client: HttpClient, ApiV21Items: PostApiV21Items, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
254
+ export declare const getApiV21ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
255
255
  /**
256
256
  * No description
257
257
  *
@@ -262,41 +262,41 @@ export declare const postApiV21Items: (client: HttpClient, ApiV21Items: PostApiV
262
262
  */
263
263
  export declare const getApiV21Items: (client: HttpClient, query: GetApiV21ItemsParams, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
264
264
  /**
265
- * @description Get resource actions
265
+ * No description
266
266
  *
267
267
  * @tags items
268
- * @name GetApiV21ItemsActions
269
- * @summary List actions you can perform
270
- * @request GET:/api/v2.1/items/actions
268
+ * @name PostApiV21Items
269
+ * @summary Create an item
270
+ * @request POST:/api/v2.1/items
271
271
  */
272
- export declare const getApiV21ItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
272
+ export declare const postApiV21Items: (client: HttpClient, postApiV21Items: PostApiV21Items, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
273
273
  /**
274
- * @description An item may have many alternate scancodes
274
+ * No description
275
275
  *
276
276
  * @tags originators
277
- * @name GetApiV21ItemsOriginatorOriginatorIdScancodes
278
- * @summary List all scancodes associated with this item
279
- * @request GET:/api/v2.1/items/originator/{originator_id}/scancodes
277
+ * @name GetApiV21ItemsOriginatorOriginatorId
278
+ * @summary Retrieve an item
279
+ * @request GET:/api/v2.1/items/originator/{originator_id}
280
280
  */
281
- export declare const getApiV21ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
281
+ export declare const getApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
282
282
  /**
283
- * @description Retrieve the quantity of this item in each warehouse in which it has stock
283
+ * No description
284
284
  *
285
285
  * @tags originators
286
- * @name GetApiV21ItemsOriginatorOriginatorIdWarehouseQuantities
287
- * @summary Item stock by warehouse
288
- * @request GET:/api/v2.1/items/originator/{originator_id}/warehouse_quantities
286
+ * @name PutApiV21ItemsOriginatorOriginatorId
287
+ * @summary Update an item
288
+ * @request PUT:/api/v2.1/items/originator/{originator_id}
289
289
  */
290
- export declare const getApiV21ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
290
+ export declare const putApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV21ItemsOriginatorOriginatorId: PutApiV21ItemsOriginatorOriginatorId, params?: RequestParams) => Promise<void>;
291
291
  /**
292
- * No description
292
+ * @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.
293
293
  *
294
294
  * @tags originators
295
- * @name GetApiV21ItemsOriginatorOriginatorIdBundleItems
296
- * @summary List all bundle items containing this item
297
- * @request GET:/api/v2.1/items/originator/{originator_id}/bundle_items
295
+ * @name DeleteApiV21ItemsOriginatorOriginatorId
296
+ * @summary Archive an item
297
+ * @request DELETE:/api/v2.1/items/originator/{originator_id}
298
298
  */
299
- export declare const getApiV21ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
299
+ export declare const deleteApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
300
300
  /**
301
301
  * No description
302
302
  *
@@ -307,68 +307,77 @@ export declare const getApiV21ItemsOriginatorOriginatorIdBundleItems: (client: H
307
307
  */
308
308
  export declare const getApiV21ItemsOriginatorOriginatorIdInBundles: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
309
309
  /**
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.
310
+ * No description
311
311
  *
312
312
  * @tags originators
313
- * @name DeleteApiV21ItemsOriginatorOriginatorId
314
- * @summary Archive an item
315
- * @request DELETE:/api/v2.1/items/originator/{originator_id}
313
+ * @name GetApiV21ItemsOriginatorOriginatorIdBundleItems
314
+ * @summary List all bundle items containing this item
315
+ * @request GET:/api/v2.1/items/originator/{originator_id}/bundle_items
316
316
  */
317
- export declare const deleteApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<void>;
317
+ export declare const getApiV21ItemsOriginatorOriginatorIdBundleItems: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesBundleItem[]>;
318
318
  /**
319
- * No description
319
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
320
320
  *
321
321
  * @tags originators
322
- * @name PutApiV21ItemsOriginatorOriginatorId
323
- * @summary Update an item
324
- * @request PUT:/api/v2.1/items/originator/{originator_id}
322
+ * @name GetApiV21ItemsOriginatorOriginatorIdWarehouseQuantities
323
+ * @summary Item stock by warehouse
324
+ * @request GET:/api/v2.1/items/originator/{originator_id}/warehouse_quantities
325
325
  */
326
- export declare const putApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, ApiV21ItemsOriginator: PutApiV21ItemsOriginator, params?: RequestParams) => Promise<void>;
326
+ export declare const getApiV21ItemsOriginatorOriginatorIdWarehouseQuantities: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
327
327
  /**
328
- * No description
328
+ * @description An item may have many alternate scancodes
329
329
  *
330
330
  * @tags originators
331
- * @name GetApiV21ItemsOriginatorOriginatorId
332
- * @summary Retrieve an item
333
- * @request GET:/api/v2.1/items/originator/{originator_id}
331
+ * @name GetApiV21ItemsOriginatorOriginatorIdScancodes
332
+ * @summary List all scancodes associated with this item
333
+ * @request GET:/api/v2.1/items/originator/{originator_id}/scancodes
334
334
  */
335
- export declare const getApiV21ItemsOriginatorOriginatorId: (client: HttpClient, originatorId: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
335
+ export declare const getApiV21ItemsOriginatorOriginatorIdScancodes: (client: HttpClient, { originatorId, ...query }: GetApiV21ItemsOriginatorOriginatorIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
336
336
  /**
337
- * @description Update Item meta fields
337
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
338
338
  *
339
339
  * @tags items
340
- * @name PutApiV21ItemsIdMetaFields
341
- * @summary Set meta fields
342
- * @request PUT:/api/v2.1/items/{id}/meta_fields
340
+ * @name GetApiV21ItemsIdOriginators
341
+ * @summary List associated originators
342
+ * @request GET:/api/v2.1/items/{id}/originators
343
343
  */
344
- export declare const putApiV21ItemsIdMetaFields: (client: HttpClient, id: number, ApiV21ItemsIdMetaFields: PutApiV21ItemsIdMetaFields, params?: RequestParams) => Promise<void>;
344
+ export declare const getApiV21ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
345
345
  /**
346
- * @description Get the meta fields for a(n) Item
346
+ * No description
347
347
  *
348
348
  * @tags items
349
- * @name GetApiV21ItemsIdMetaFields
350
- * @summary List meta fields
351
- * @request GET:/api/v2.1/items/{id}/meta_fields
349
+ * @name GetApiV21ItemsId
350
+ * @summary Retrieve an item
351
+ * @request GET:/api/v2.1/items/{id}
352
352
  */
353
- export declare const getApiV21ItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
353
+ export declare const getApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
354
354
  /**
355
- * @description An item may have many alternate scancodes
355
+ * No description
356
356
  *
357
357
  * @tags items
358
- * @name GetApiV21ItemsIdScancodes
359
- * @summary List all scancodes associated with this item
360
- * @request GET:/api/v2.1/items/{id}/scancodes
358
+ * @name PutApiV21ItemsId
359
+ * @summary Update an item
360
+ * @request PUT:/api/v2.1/items/{id}
361
361
  */
362
- export declare const getApiV21ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
362
+ export declare const putApiV21ItemsId: (client: HttpClient, id: number, putApiV21ItemsId: PutApiV21ItemsId, params?: RequestParams) => Promise<void>;
363
363
  /**
364
- * @description Retrieve the quantity of this item in each warehouse in which it has stock
364
+ * @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.
365
365
  *
366
366
  * @tags items
367
- * @name GetApiV21ItemsIdWarehouseQuantities
368
- * @summary Item stock by warehouse
369
- * @request GET:/api/v2.1/items/{id}/warehouse_quantities
367
+ * @name DeleteApiV21ItemsId
368
+ * @summary Archive an item
369
+ * @request DELETE:/api/v2.1/items/{id}
370
370
  */
371
- export declare const getApiV21ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
371
+ export declare const deleteApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
372
+ /**
373
+ * No description
374
+ *
375
+ * @tags items
376
+ * @name GetApiV21ItemsIdInBundles
377
+ * @summary List all instances of this item in bundles
378
+ * @request GET:/api/v2.1/items/{id}/in_bundles
379
+ */
380
+ export declare const getApiV21ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
372
381
  /**
373
382
  * No description
374
383
  *
@@ -386,52 +395,43 @@ export declare const getApiV21ItemsIdBundleItems: (client: HttpClient, id: numbe
386
395
  * @summary Add an item to an bundle
387
396
  * @request POST:/api/v2.1/items/{id}/bundle_items
388
397
  */
389
- export declare const postApiV21ItemsIdBundleItems: (client: HttpClient, id: number, ApiV21ItemsIdBundleItems: PostApiV21ItemsIdBundleItems, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
390
- /**
391
- * No description
392
- *
393
- * @tags items
394
- * @name GetApiV21ItemsIdInBundles
395
- * @summary List all instances of this item in bundles
396
- * @request GET:/api/v2.1/items/{id}/in_bundles
397
- */
398
- export declare const getApiV21ItemsIdInBundles: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem[]>;
398
+ export declare const postApiV21ItemsIdBundleItems: (client: HttpClient, id: number, postApiV21ItemsIdBundleItems: PostApiV21ItemsIdBundleItems, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
399
399
  /**
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.
400
+ * @description Retrieve the quantity of this item in each warehouse in which it has stock
401
401
  *
402
402
  * @tags items
403
- * @name DeleteApiV21ItemsId
404
- * @summary Archive an item
405
- * @request DELETE:/api/v2.1/items/{id}
403
+ * @name GetApiV21ItemsIdWarehouseQuantities
404
+ * @summary Item stock by warehouse
405
+ * @request GET:/api/v2.1/items/{id}/warehouse_quantities
406
406
  */
407
- export declare const deleteApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
407
+ export declare const getApiV21ItemsIdWarehouseQuantities: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesItemWarehouseQuantity>;
408
408
  /**
409
- * No description
409
+ * @description An item may have many alternate scancodes
410
410
  *
411
411
  * @tags items
412
- * @name PutApiV21ItemsId
413
- * @summary Update an item
414
- * @request PUT:/api/v2.1/items/{id}
412
+ * @name GetApiV21ItemsIdScancodes
413
+ * @summary List all scancodes associated with this item
414
+ * @request GET:/api/v2.1/items/{id}/scancodes
415
415
  */
416
- export declare const putApiV21ItemsId: (client: HttpClient, id: number, ApiV21Items: PutApiV21Items, params?: RequestParams) => Promise<void>;
416
+ export declare const getApiV21ItemsIdScancodes: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdScancodesParams, params?: RequestParams) => Promise<APIV2EntitiesScancode[]>;
417
417
  /**
418
- * No description
418
+ * @description Get the meta fields for a(n) Item
419
419
  *
420
420
  * @tags items
421
- * @name GetApiV21ItemsId
422
- * @summary Retrieve an item
423
- * @request GET:/api/v2.1/items/{id}
421
+ * @name GetApiV21ItemsIdMetaFields
422
+ * @summary List meta fields
423
+ * @request GET:/api/v2.1/items/{id}/meta_fields
424
424
  */
425
- export declare const getApiV21ItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesItem>;
425
+ export declare const getApiV21ItemsIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
426
426
  /**
427
- * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
427
+ * @description Update Item meta fields
428
428
  *
429
429
  * @tags items
430
- * @name GetApiV21ItemsIdOriginators
431
- * @summary List associated originators
432
- * @request GET:/api/v2.1/items/{id}/originators
430
+ * @name PutApiV21ItemsIdMetaFields
431
+ * @summary Set meta fields
432
+ * @request PUT:/api/v2.1/items/{id}/meta_fields
433
433
  */
434
- export declare const getApiV21ItemsIdOriginators: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdOriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
434
+ export declare const putApiV21ItemsIdMetaFields: (client: HttpClient, id: number, putApiV21ItemsIdMetaFields: PutApiV21ItemsIdMetaFields, params?: RequestParams) => Promise<void>;
435
435
  /**
436
436
  * No description
437
437
  *
@@ -449,16 +449,7 @@ export declare const getApiV21ItemsCount: (client: HttpClient, query: GetApiV21I
449
449
  * @summary Perform an action on an item
450
450
  * @request PUT:/api/v2.1/items/{id}/call/{action}
451
451
  */
452
- export declare const putApiV21ItemsIdCallAction: (client: HttpClient, action: string, id: number, ApiV21ItemsIdCall: PutApiV21ItemsIdCall, params?: RequestParams) => Promise<void>;
453
- /**
454
- * No description
455
- *
456
- * @tags items
457
- * @name GetApiV21ItemsIdShipnoticeItemsCount
458
- * @summary Count associated ship notice items
459
- * @request GET:/api/v2.1/items/{id}/shipnotice_items/count
460
- */
461
- export declare const getApiV21ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
452
+ export declare const putApiV21ItemsIdCallAction: (client: HttpClient, action: string, id: number, putApiV21ItemsIdCallAction: PutApiV21ItemsIdCallAction, params?: RequestParams) => Promise<void>;
462
453
  /**
463
454
  * No description
464
455
  *
@@ -469,14 +460,14 @@ export declare const getApiV21ItemsIdShipnoticeItemsCount: (client: HttpClient,
469
460
  */
470
461
  export declare const getApiV21ItemsIdShipnoticeItems: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsParams, params?: RequestParams) => Promise<APIV21EntitiesShipnoticeItem[]>;
471
462
  /**
472
- * @description Returns count of item transactions
463
+ * No description
473
464
  *
474
465
  * @tags items
475
- * @name GetApiV21ItemsIdTransactionsCount
476
- * @summary Count the transactions in an item's history
477
- * @request GET:/api/v2.1/items/{id}/transactions/count
466
+ * @name GetApiV21ItemsIdShipnoticeItemsCount
467
+ * @summary Count associated ship notice items
468
+ * @request GET:/api/v2.1/items/{id}/shipnotice_items/count
478
469
  */
479
- export declare const getApiV21ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
470
+ export declare const getApiV21ItemsIdShipnoticeItemsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdShipnoticeItemsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
480
471
  /**
481
472
  * @description Get all transactions for an item
482
473
  *
@@ -486,3 +477,12 @@ export declare const getApiV21ItemsIdTransactionsCount: (client: HttpClient, { i
486
477
  * @request GET:/api/v2.1/items/{id}/transactions
487
478
  */
488
479
  export declare const getApiV21ItemsIdTransactions: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdTransactionsParams, params?: RequestParams) => Promise<APIV2EntitiesTransaction[]>;
480
+ /**
481
+ * @description Returns count of item transactions
482
+ *
483
+ * @tags items
484
+ * @name GetApiV21ItemsIdTransactionsCount
485
+ * @summary Count the transactions in an item's history
486
+ * @request GET:/api/v2.1/items/{id}/transactions/count
487
+ */
488
+ export declare const getApiV21ItemsIdTransactionsCount: (client: HttpClient, { id, ...query }: GetApiV21ItemsIdTransactionsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;