@whiplashmerch/whiplash-api-client 0.4.77 → 0.4.78
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 +18494 -2141
- package/dist/client.esm.js.map +1 -1
- package/dist/constants/index.d.ts +1 -0
- package/dist/constants/search.d.ts +9 -0
- package/dist/generated/AccountTransactions.d.ts +56 -0
- package/dist/generated/Accounts.d.ts +171 -0
- package/dist/generated/Allocations.d.ts +38 -0
- package/dist/generated/Broadcasts.d.ts +164 -0
- package/dist/generated/Cache.d.ts +56 -0
- package/dist/generated/CarrierAccounts.d.ts +191 -0
- package/dist/generated/Carriers.d.ts +20 -0
- package/dist/generated/Chromalists.d.ts +56 -0
- package/dist/generated/ConsumerReturns.d.ts +89 -1
- package/dist/generated/Currencies.d.ts +56 -0
- package/dist/generated/Customers.d.ts +172 -1
- package/dist/generated/CustomsInfos.d.ts +56 -0
- package/dist/generated/Dashboards.d.ts +38 -0
- package/dist/generated/Documents.d.ts +37 -1
- package/dist/generated/ExtApp.d.ts +30 -0
- package/dist/generated/FilterSets.d.ts +288 -0
- package/dist/generated/ImporterOfRecords.d.ts +92 -0
- package/dist/generated/Incidents.d.ts +128 -0
- package/dist/generated/InvoiceItems.d.ts +56 -0
- package/dist/generated/Invoices.d.ts +110 -0
- package/dist/generated/Items.d.ts +260 -1
- package/dist/generated/Locales.d.ts +19 -0
- package/dist/generated/LocationAdjustments.d.ts +65 -0
- package/dist/generated/LocationAudits.d.ts +162 -0
- package/dist/generated/LocationTransfers.d.ts +162 -0
- package/dist/generated/Locations.d.ts +207 -0
- package/dist/generated/Lots.d.ts +119 -0
- package/dist/generated/Manifests.d.ts +128 -0
- package/dist/generated/Me.d.ts +20 -0
- package/dist/generated/Nav.d.ts +20 -0
- package/dist/generated/NavItems.d.ts +20 -0
- package/dist/generated/OrderBatchItems.d.ts +54 -0
- package/dist/generated/OrderBatchRequests.d.ts +38 -0
- package/dist/generated/OrderBatches.d.ts +315 -0
- package/dist/generated/OrderDocuments.d.ts +37 -0
- package/dist/generated/OrderItems.d.ts +98 -1
- package/dist/generated/OrderTotes.d.ts +20 -0
- package/dist/generated/Orders.d.ts +468 -1
- package/dist/generated/Originators.d.ts +28 -1
- package/dist/generated/Packages.d.ts +205 -0
- package/dist/generated/Partners.d.ts +110 -0
- package/dist/generated/Prepacks.d.ts +11 -0
- package/dist/generated/ProjectTasks.d.ts +56 -0
- package/dist/generated/Projects.d.ts +163 -1
- package/dist/generated/Rates.d.ts +119 -0
- package/dist/generated/ReasonCodes.d.ts +20 -0
- package/dist/generated/ReturnAddresses.d.ts +92 -0
- package/dist/generated/RuleDismissals.d.ts +19 -0
- package/dist/generated/Rules.d.ts +155 -0
- package/dist/generated/Scancodes.d.ts +20 -0
- package/dist/generated/SerialNumbers.d.ts +56 -0
- package/dist/generated/ShipnoticeItems.d.ts +197 -1
- package/dist/generated/Shipnotices.d.ts +242 -1
- package/dist/generated/ShippingAliases.d.ts +119 -0
- package/dist/generated/ShippingBlacklistedMethods.d.ts +110 -0
- package/dist/generated/ShippingMethodMarkups.d.ts +11 -0
- package/dist/generated/ShippingMethods.d.ts +110 -0
- package/dist/generated/Shops.d.ts +47 -0
- package/dist/generated/Stats.d.ts +54 -0
- package/dist/generated/SurchargeMarkups.d.ts +56 -0
- package/dist/generated/TemplateTypes.d.ts +20 -0
- package/dist/generated/Templates.d.ts +82 -1
- package/dist/generated/Transactions.d.ts +11 -0
- package/dist/generated/TransportationMarkups.d.ts +56 -0
- package/dist/generated/Users.d.ts +245 -0
- package/dist/generated/Utilities.d.ts +38 -0
- package/dist/generated/WarehouseFeatures.d.ts +110 -0
- package/dist/generated/Warehouses.d.ts +245 -0
- package/dist/generated/Wholesales.d.ts +56 -0
- package/dist/generated/data-contracts.d.ts +20237 -4725
- package/dist/generated/index.d.ts +57 -0
- package/dist/index.d.ts +3 -0
- package/dist/mocks/customer.d.ts +2 -0
- package/dist/mocks/index.d.ts +4 -0
- package/dist/mocks/nav.d.ts +2 -0
- package/dist/mocks/user.d.ts +2 -0
- package/dist/mocks/warehouse.d.ts +2 -0
- package/dist/utils/errorHandler.d.ts +2 -0
- package/dist/utils/index.d.ts +9 -0
- package/dist/utils/nav.d.ts +9 -0
- package/dist/utils/orderBatch.d.ts +19 -0
- package/dist/utils/orders.d.ts +54 -0
- package/dist/utils/pusher.d.ts +25 -0
- package/dist/utils/rules.d.ts +8 -0
- package/dist/utils/user.d.ts +19 -0
- package/dist/utils/utilities.d.ts +8 -0
- package/dist/utils/warehouse.d.ts +26 -0
- package/package.json +1 -1
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
import { APIV21EntitiesIncident, APIV21EntitiesOrderBatch, APIV21EntitiesPostResponse, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesIncident, APIV2EntitiesMetaFields, APIV2EntitiesOrderBatch, APIV2EntitiesOrderBatchItem, APIV2EntitiesPackingslipsArray, APIV2EntitiesResult, APIV2EntitiesSidekiqBatch, GetApiV21OrderBatchesAggregateParams, GetApiV21OrderBatchesIdCallTraitParams, GetApiV21OrderBatchesIdIncidentsCountParams, GetApiV21OrderBatchesIdIncidentsParams, GetApiV21OrderBatchesIdMetaFieldsParams, GetApiV21OrderBatchesIdOrderBatchItemsParams, GetApiV21OrderBatchesIdPackingslipsParams, GetApiV21OrderBatchesIdTraitsParams, GetApiV21OrderBatchesParams, GetApiV2OrderBatchesAggregateParams, GetApiV2OrderBatchesIdCallTraitParams, GetApiV2OrderBatchesIdIncidentsCountParams, GetApiV2OrderBatchesIdIncidentsParams, GetApiV2OrderBatchesIdMetaFieldsParams, GetApiV2OrderBatchesIdOrderBatchItemsParams, GetApiV2OrderBatchesIdPackingslipsParams, GetApiV2OrderBatchesIdTraitsParams, GetApiV2OrderBatchesParams, PostApiV21OrderBatchesIdIncidents, PostApiV2OrderBatchesIdIncidents, PutApiV21OrderBatchesId, PutApiV21OrderBatchesIdCallAction, PutApiV21OrderBatchesIdCallAsyncAction, PutApiV21OrderBatchesIdMetaFields, PutApiV2OrderBatchesId, PutApiV2OrderBatchesIdCallAction, PutApiV2OrderBatchesIdCallAsyncAction, PutApiV2OrderBatchesIdMetaFields } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Get resource actions
|
|
5
|
+
*
|
|
6
|
+
* @tags order_batches
|
|
7
|
+
* @name GetApiV2OrderBatchesActions
|
|
8
|
+
* @summary List actions you can perform
|
|
9
|
+
* @request GET:/api/v2/order_batches/actions
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2OrderBatchesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Returns all order batches
|
|
14
|
+
*
|
|
15
|
+
* @tags order_batches
|
|
16
|
+
* @name GetApiV2OrderBatches
|
|
17
|
+
* @summary List all order batches
|
|
18
|
+
* @request GET:/api/v2/order_batches
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2OrderBatches: (client: HttpClient, query: GetApiV2OrderBatchesParams, params?: RequestParams) => Promise<APIV2EntitiesOrderBatch[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Get order_batches traits
|
|
23
|
+
*
|
|
24
|
+
* @tags order_batches
|
|
25
|
+
* @name GetApiV2OrderBatchesTraits
|
|
26
|
+
* @summary List order_batches traits
|
|
27
|
+
* @request GET:/api/v2/order_batches/traits
|
|
28
|
+
*/
|
|
29
|
+
export declare const getApiV2OrderBatchesTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Returns aggregated order_batches
|
|
32
|
+
*
|
|
33
|
+
* @tags order_batches
|
|
34
|
+
* @name GetApiV2OrderBatchesAggregate
|
|
35
|
+
* @request GET:/api/v2/order_batches/aggregate
|
|
36
|
+
*/
|
|
37
|
+
export declare const getApiV2OrderBatchesAggregate: (client: HttpClient, query: GetApiV2OrderBatchesAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
38
|
+
/**
|
|
39
|
+
* @description Get packingslips for an order batch
|
|
40
|
+
*
|
|
41
|
+
* @tags order_batches
|
|
42
|
+
* @name GetApiV2OrderBatchesIdPackingslips
|
|
43
|
+
* @summary Retrieve packingslips for an order batch
|
|
44
|
+
* @request GET:/api/v2/order_batches/{id}/packingslips
|
|
45
|
+
*/
|
|
46
|
+
export declare const getApiV2OrderBatchesIdPackingslips: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdPackingslipsParams, params?: RequestParams) => Promise<APIV2EntitiesPackingslipsArray>;
|
|
47
|
+
/**
|
|
48
|
+
* @description get an order batch
|
|
49
|
+
*
|
|
50
|
+
* @tags order_batches
|
|
51
|
+
* @name GetApiV2OrderBatchesId
|
|
52
|
+
* @summary Retrieve an order batch
|
|
53
|
+
* @request GET:/api/v2/order_batches/{id}
|
|
54
|
+
*/
|
|
55
|
+
export declare const getApiV2OrderBatchesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderBatch>;
|
|
56
|
+
/**
|
|
57
|
+
* @description Update an order batch
|
|
58
|
+
*
|
|
59
|
+
* @tags order_batches
|
|
60
|
+
* @name PutApiV2OrderBatchesId
|
|
61
|
+
* @summary Update an order batch
|
|
62
|
+
* @request PUT:/api/v2/order_batches/{id}
|
|
63
|
+
*/
|
|
64
|
+
export declare const putApiV2OrderBatchesId: (client: HttpClient, id: number, putApiV2OrderBatchesId: PutApiV2OrderBatchesId, params?: RequestParams) => Promise<APIV2EntitiesOrderBatch>;
|
|
65
|
+
/**
|
|
66
|
+
* No description
|
|
67
|
+
*
|
|
68
|
+
* @tags order_batches
|
|
69
|
+
* @name GetApiV2OrderBatchesIdAudits
|
|
70
|
+
* @summary Retrieve audit info for users
|
|
71
|
+
* @request GET:/api/v2/order_batches/{id}/audits
|
|
72
|
+
*/
|
|
73
|
+
export declare const getApiV2OrderBatchesIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
|
|
74
|
+
/**
|
|
75
|
+
* No description
|
|
76
|
+
*
|
|
77
|
+
* @tags order_batches
|
|
78
|
+
* @name GetApiV2OrderBatchesIdTraits
|
|
79
|
+
* @summary Retrieve the specified order_batches traits
|
|
80
|
+
* @request GET:/api/v2/order_batches/{id}/traits
|
|
81
|
+
*/
|
|
82
|
+
export declare const getApiV2OrderBatchesIdTraits: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
83
|
+
/**
|
|
84
|
+
* @description Get the meta fields for a(n) Shop
|
|
85
|
+
*
|
|
86
|
+
* @tags order_batches
|
|
87
|
+
* @name GetApiV2OrderBatchesIdMetaFields
|
|
88
|
+
* @summary List all Meta Fields
|
|
89
|
+
* @request GET:/api/v2/order_batches/{id}/meta_fields
|
|
90
|
+
*/
|
|
91
|
+
export declare const getApiV2OrderBatchesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
92
|
+
/**
|
|
93
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
94
|
+
*
|
|
95
|
+
* @tags order_batches
|
|
96
|
+
* @name PutApiV2OrderBatchesIdMetaFields
|
|
97
|
+
* @summary Set Meta Fields
|
|
98
|
+
* @request PUT:/api/v2/order_batches/{id}/meta_fields
|
|
99
|
+
*/
|
|
100
|
+
export declare const putApiV2OrderBatchesIdMetaFields: (client: HttpClient, id: number, putApiV2OrderBatchesIdMetaFields: PutApiV2OrderBatchesIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
101
|
+
/**
|
|
102
|
+
* @description Perform an action on an order_batch
|
|
103
|
+
*
|
|
104
|
+
* @tags order_batches
|
|
105
|
+
* @name PutApiV2OrderBatchesIdCallAction
|
|
106
|
+
* @summary Perform an action on an order_batch
|
|
107
|
+
* @request PUT:/api/v2/order_batches/{id}/call/{action}
|
|
108
|
+
*/
|
|
109
|
+
export declare const putApiV2OrderBatchesIdCallAction: (client: HttpClient, action: string, id: number, putApiV2OrderBatchesIdCallAction: PutApiV2OrderBatchesIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesOrderBatch>;
|
|
110
|
+
/**
|
|
111
|
+
* @description Perform an action on an order_batch asynchronously
|
|
112
|
+
*
|
|
113
|
+
* @tags order_batches
|
|
114
|
+
* @name PutApiV2OrderBatchesIdCallAsyncAction
|
|
115
|
+
* @summary Perform an action on an order_batch asynchronously
|
|
116
|
+
* @request PUT:/api/v2/order_batches/{id}/call_async/{action}
|
|
117
|
+
*/
|
|
118
|
+
export declare const putApiV2OrderBatchesIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV2OrderBatchesIdCallAsyncAction: PutApiV2OrderBatchesIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
|
|
119
|
+
/**
|
|
120
|
+
* No description
|
|
121
|
+
*
|
|
122
|
+
* @tags order_batches
|
|
123
|
+
* @name GetApiV2OrderBatchesIdCallTrait
|
|
124
|
+
* @summary Retrieve the specified order_batches trait
|
|
125
|
+
* @request GET:/api/v2/order_batches/{id}/call/{trait}
|
|
126
|
+
*/
|
|
127
|
+
export declare const getApiV2OrderBatchesIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV2OrderBatchesIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
128
|
+
/**
|
|
129
|
+
* @description Get all incidents for a(n) OrderBatch
|
|
130
|
+
*
|
|
131
|
+
* @tags order_batches
|
|
132
|
+
* @name GetApiV2OrderBatchesIdIncidents
|
|
133
|
+
* @summary List all incidents for a resource
|
|
134
|
+
* @request GET:/api/v2/order_batches/{id}/incidents
|
|
135
|
+
*/
|
|
136
|
+
export declare const getApiV2OrderBatchesIdIncidents: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdIncidentsParams, params?: RequestParams) => Promise<APIV2EntitiesIncident[]>;
|
|
137
|
+
/**
|
|
138
|
+
* @description Create an incident for a(n) OrderBatch
|
|
139
|
+
*
|
|
140
|
+
* @tags order_batches
|
|
141
|
+
* @name PostApiV2OrderBatchesIdIncidents
|
|
142
|
+
* @summary Create an incident for a resource
|
|
143
|
+
* @request POST:/api/v2/order_batches/{id}/incidents
|
|
144
|
+
*/
|
|
145
|
+
export declare const postApiV2OrderBatchesIdIncidents: (client: HttpClient, id: number, postApiV2OrderBatchesIdIncidents: PostApiV2OrderBatchesIdIncidents, params?: RequestParams) => Promise<APIV2EntitiesIncident>;
|
|
146
|
+
/**
|
|
147
|
+
* @description Returns count of incidents for a(n) OrderBatch
|
|
148
|
+
*
|
|
149
|
+
* @tags order_batches
|
|
150
|
+
* @name GetApiV2OrderBatchesIdIncidentsCount
|
|
151
|
+
* @summary Count incidents for a resource
|
|
152
|
+
* @request GET:/api/v2/order_batches/{id}/incidents/count
|
|
153
|
+
*/
|
|
154
|
+
export declare const getApiV2OrderBatchesIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
155
|
+
/**
|
|
156
|
+
* @description Get order_batch_items for an order batch
|
|
157
|
+
*
|
|
158
|
+
* @tags order_batches
|
|
159
|
+
* @name GetApiV2OrderBatchesIdOrderBatchItems
|
|
160
|
+
* @summary Retrieve all order batch items for an order batch
|
|
161
|
+
* @request GET:/api/v2/order_batches/{id}/order_batch_items
|
|
162
|
+
*/
|
|
163
|
+
export declare const getApiV2OrderBatchesIdOrderBatchItems: (client: HttpClient, { id, ...query }: GetApiV2OrderBatchesIdOrderBatchItemsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderBatchItem[]>;
|
|
164
|
+
/**
|
|
165
|
+
* @description Get resource actions
|
|
166
|
+
*
|
|
167
|
+
* @tags order_batches
|
|
168
|
+
* @name GetApiV21OrderBatchesActions
|
|
169
|
+
* @summary List actions you can perform
|
|
170
|
+
* @request GET:/api/v2.1/order_batches/actions
|
|
171
|
+
*/
|
|
172
|
+
export declare const getApiV21OrderBatchesActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
173
|
+
/**
|
|
174
|
+
* @description Returns all order batches
|
|
175
|
+
*
|
|
176
|
+
* @tags order_batches
|
|
177
|
+
* @name GetApiV21OrderBatches
|
|
178
|
+
* @summary List all order batches
|
|
179
|
+
* @request GET:/api/v2.1/order_batches
|
|
180
|
+
*/
|
|
181
|
+
export declare const getApiV21OrderBatches: (client: HttpClient, query: GetApiV21OrderBatchesParams, params?: RequestParams) => Promise<APIV21EntitiesOrderBatch[]>;
|
|
182
|
+
/**
|
|
183
|
+
* @description Get order_batches traits
|
|
184
|
+
*
|
|
185
|
+
* @tags order_batches
|
|
186
|
+
* @name GetApiV21OrderBatchesTraits
|
|
187
|
+
* @summary List order_batches traits
|
|
188
|
+
* @request GET:/api/v2.1/order_batches/traits
|
|
189
|
+
*/
|
|
190
|
+
export declare const getApiV21OrderBatchesTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
191
|
+
/**
|
|
192
|
+
* @description Returns aggregated order_batches
|
|
193
|
+
*
|
|
194
|
+
* @tags order_batches
|
|
195
|
+
* @name GetApiV21OrderBatchesAggregate
|
|
196
|
+
* @request GET:/api/v2.1/order_batches/aggregate
|
|
197
|
+
*/
|
|
198
|
+
export declare const getApiV21OrderBatchesAggregate: (client: HttpClient, query: GetApiV21OrderBatchesAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
199
|
+
/**
|
|
200
|
+
* @description Get packingslips for an order batch
|
|
201
|
+
*
|
|
202
|
+
* @tags order_batches
|
|
203
|
+
* @name GetApiV21OrderBatchesIdPackingslips
|
|
204
|
+
* @summary Retrieve packingslips for an order batch
|
|
205
|
+
* @request GET:/api/v2.1/order_batches/{id}/packingslips
|
|
206
|
+
*/
|
|
207
|
+
export declare const getApiV21OrderBatchesIdPackingslips: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdPackingslipsParams, params?: RequestParams) => Promise<APIV2EntitiesPackingslipsArray>;
|
|
208
|
+
/**
|
|
209
|
+
* @description get an order batch
|
|
210
|
+
*
|
|
211
|
+
* @tags order_batches
|
|
212
|
+
* @name GetApiV21OrderBatchesId
|
|
213
|
+
* @summary Retrieve an order batch
|
|
214
|
+
* @request GET:/api/v2.1/order_batches/{id}
|
|
215
|
+
*/
|
|
216
|
+
export declare const getApiV21OrderBatchesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrderBatch>;
|
|
217
|
+
/**
|
|
218
|
+
* @description Update an order batch
|
|
219
|
+
*
|
|
220
|
+
* @tags order_batches
|
|
221
|
+
* @name PutApiV21OrderBatchesId
|
|
222
|
+
* @summary Update an order batch
|
|
223
|
+
* @request PUT:/api/v2.1/order_batches/{id}
|
|
224
|
+
*/
|
|
225
|
+
export declare const putApiV21OrderBatchesId: (client: HttpClient, id: number, putApiV21OrderBatchesId: PutApiV21OrderBatchesId, params?: RequestParams) => Promise<void>;
|
|
226
|
+
/**
|
|
227
|
+
* No description
|
|
228
|
+
*
|
|
229
|
+
* @tags order_batches
|
|
230
|
+
* @name GetApiV21OrderBatchesIdTraits
|
|
231
|
+
* @summary Retrieve the specified order_batches traits
|
|
232
|
+
* @request GET:/api/v2.1/order_batches/{id}/traits
|
|
233
|
+
*/
|
|
234
|
+
export declare const getApiV21OrderBatchesIdTraits: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
235
|
+
/**
|
|
236
|
+
* @description Get the meta fields for a(n) Shop
|
|
237
|
+
*
|
|
238
|
+
* @tags order_batches
|
|
239
|
+
* @name GetApiV21OrderBatchesIdMetaFields
|
|
240
|
+
* @summary List all Meta Fields
|
|
241
|
+
* @request GET:/api/v2.1/order_batches/{id}/meta_fields
|
|
242
|
+
*/
|
|
243
|
+
export declare const getApiV21OrderBatchesIdMetaFields: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdMetaFieldsParams, params?: RequestParams) => Promise<APIV2EntitiesMetaFields>;
|
|
244
|
+
/**
|
|
245
|
+
* @description Because you can also set Meta Fields for child resources, this update is performed in the background. You'll receive an error if validation fails; otherwise, you can assume that the job will process correctly and update shortly.
|
|
246
|
+
*
|
|
247
|
+
* @tags order_batches
|
|
248
|
+
* @name PutApiV21OrderBatchesIdMetaFields
|
|
249
|
+
* @summary Set Meta Fields
|
|
250
|
+
* @request PUT:/api/v2.1/order_batches/{id}/meta_fields
|
|
251
|
+
*/
|
|
252
|
+
export declare const putApiV21OrderBatchesIdMetaFields: (client: HttpClient, id: number, putApiV21OrderBatchesIdMetaFields: PutApiV21OrderBatchesIdMetaFields, params?: RequestParams) => Promise<void>;
|
|
253
|
+
/**
|
|
254
|
+
* @description Perform an action on an order_batch
|
|
255
|
+
*
|
|
256
|
+
* @tags order_batches
|
|
257
|
+
* @name PutApiV21OrderBatchesIdCallAction
|
|
258
|
+
* @summary Perform an action on an order_batch
|
|
259
|
+
* @request PUT:/api/v2.1/order_batches/{id}/call/{action}
|
|
260
|
+
*/
|
|
261
|
+
export declare const putApiV21OrderBatchesIdCallAction: (client: HttpClient, action: string, id: number, putApiV21OrderBatchesIdCallAction: PutApiV21OrderBatchesIdCallAction, params?: RequestParams) => Promise<void>;
|
|
262
|
+
/**
|
|
263
|
+
* @description Perform an action on an order_batch asynchronously
|
|
264
|
+
*
|
|
265
|
+
* @tags order_batches
|
|
266
|
+
* @name PutApiV21OrderBatchesIdCallAsyncAction
|
|
267
|
+
* @summary Perform an action on an order_batch asynchronously
|
|
268
|
+
* @request PUT:/api/v2.1/order_batches/{id}/call_async/{action}
|
|
269
|
+
*/
|
|
270
|
+
export declare const putApiV21OrderBatchesIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV21OrderBatchesIdCallAsyncAction: PutApiV21OrderBatchesIdCallAsyncAction, params?: RequestParams) => Promise<void>;
|
|
271
|
+
/**
|
|
272
|
+
* No description
|
|
273
|
+
*
|
|
274
|
+
* @tags order_batches
|
|
275
|
+
* @name GetApiV21OrderBatchesIdCallTrait
|
|
276
|
+
* @summary Retrieve the specified order_batches trait
|
|
277
|
+
* @request GET:/api/v2.1/order_batches/{id}/call/{trait}
|
|
278
|
+
*/
|
|
279
|
+
export declare const getApiV21OrderBatchesIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21OrderBatchesIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
|
|
280
|
+
/**
|
|
281
|
+
* @description Get all incidents for a(n) OrderBatch
|
|
282
|
+
*
|
|
283
|
+
* @tags order_batches
|
|
284
|
+
* @name GetApiV21OrderBatchesIdIncidents
|
|
285
|
+
* @summary List all incidents for a resource
|
|
286
|
+
* @request GET:/api/v2.1/order_batches/{id}/incidents
|
|
287
|
+
*/
|
|
288
|
+
export declare const getApiV21OrderBatchesIdIncidents: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdIncidentsParams, params?: RequestParams) => Promise<APIV21EntitiesIncident[]>;
|
|
289
|
+
/**
|
|
290
|
+
* @description Create an incident for a(n) OrderBatch
|
|
291
|
+
*
|
|
292
|
+
* @tags order_batches
|
|
293
|
+
* @name PostApiV21OrderBatchesIdIncidents
|
|
294
|
+
* @summary Create an incident for a resource
|
|
295
|
+
* @request POST:/api/v2.1/order_batches/{id}/incidents
|
|
296
|
+
*/
|
|
297
|
+
export declare const postApiV21OrderBatchesIdIncidents: (client: HttpClient, id: number, postApiV21OrderBatchesIdIncidents: PostApiV21OrderBatchesIdIncidents, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
|
|
298
|
+
/**
|
|
299
|
+
* @description Returns count of incidents for a(n) OrderBatch
|
|
300
|
+
*
|
|
301
|
+
* @tags order_batches
|
|
302
|
+
* @name GetApiV21OrderBatchesIdIncidentsCount
|
|
303
|
+
* @summary Count incidents for a resource
|
|
304
|
+
* @request GET:/api/v2.1/order_batches/{id}/incidents/count
|
|
305
|
+
*/
|
|
306
|
+
export declare const getApiV21OrderBatchesIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
307
|
+
/**
|
|
308
|
+
* @description Get order_batch_items for an order batch
|
|
309
|
+
*
|
|
310
|
+
* @tags order_batches
|
|
311
|
+
* @name GetApiV21OrderBatchesIdOrderBatchItems
|
|
312
|
+
* @summary Retrieve all order batch items for an order batch
|
|
313
|
+
* @request GET:/api/v2.1/order_batches/{id}/order_batch_items
|
|
314
|
+
*/
|
|
315
|
+
export declare const getApiV21OrderBatchesIdOrderBatchItems: (client: HttpClient, { id, ...query }: GetApiV21OrderBatchesIdOrderBatchItemsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderBatchItem[]>;
|
|
@@ -1,4 +1,23 @@
|
|
|
1
|
+
import { APIV2EntitiesOrderDocument, PutApiV21OrderDocumentsId, PutApiV2OrderDocumentsId } from "./data-contracts";
|
|
1
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* @description Retrieve an order document
|
|
5
|
+
*
|
|
6
|
+
* @tags order_documents
|
|
7
|
+
* @name GetApiV2OrderDocumentsId
|
|
8
|
+
* @summary Get an order document
|
|
9
|
+
* @request GET:/api/v2/order_documents/{id}
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Update an order document
|
|
14
|
+
*
|
|
15
|
+
* @tags order_documents
|
|
16
|
+
* @name PutApiV2OrderDocumentsId
|
|
17
|
+
* @summary Update an order document
|
|
18
|
+
* @request PUT:/api/v2/order_documents/{id}
|
|
19
|
+
*/
|
|
20
|
+
export declare const putApiV2OrderDocumentsId: (client: HttpClient, id: number, putApiV2OrderDocumentsId: PutApiV2OrderDocumentsId, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument>;
|
|
2
21
|
/**
|
|
3
22
|
* @description Remove an order document from an order
|
|
4
23
|
*
|
|
@@ -8,6 +27,24 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
8
27
|
* @request DELETE:/api/v2/order_documents/{id}
|
|
9
28
|
*/
|
|
10
29
|
export declare const deleteApiV2OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
30
|
+
/**
|
|
31
|
+
* @description Retrieve an order document
|
|
32
|
+
*
|
|
33
|
+
* @tags order_documents
|
|
34
|
+
* @name GetApiV21OrderDocumentsId
|
|
35
|
+
* @summary Get an order document
|
|
36
|
+
* @request GET:/api/v2.1/order_documents/{id}
|
|
37
|
+
*/
|
|
38
|
+
export declare const getApiV21OrderDocumentsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderDocument>;
|
|
39
|
+
/**
|
|
40
|
+
* @description Update an order document
|
|
41
|
+
*
|
|
42
|
+
* @tags order_documents
|
|
43
|
+
* @name PutApiV21OrderDocumentsId
|
|
44
|
+
* @summary Update an order document
|
|
45
|
+
* @request PUT:/api/v2.1/order_documents/{id}
|
|
46
|
+
*/
|
|
47
|
+
export declare const putApiV21OrderDocumentsId: (client: HttpClient, id: number, putApiV21OrderDocumentsId: PutApiV21OrderDocumentsId, params?: RequestParams) => Promise<void>;
|
|
11
48
|
/**
|
|
12
49
|
* @description Remove an order document from an order
|
|
13
50
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIV21EntitiesOrderItem, APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesSerialNumber, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, PutApiV21OrderItemsId, PutApiV21OrderItemsIdCallAction, PutApiV21OrderItemsIdMetaFields, PutApiV2OrderItemsId, PutApiV2OrderItemsIdCallAction, PutApiV2OrderItemsIdMetaFields } from "./data-contracts";
|
|
1
|
+
import { APIV21EntitiesOrderItem, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesLot, APIV2EntitiesMetaFields, APIV2EntitiesOrderItem, APIV2EntitiesOriginator, APIV2EntitiesSerialNumber, GetApiV21OrderItemsAggregateParams, GetApiV21OrderItemsIdMetaFieldsParams, GetApiV21OrderItemsIdParams, GetApiV21OrderItemsParams, GetApiV2OrderItemsAggregateParams, GetApiV2OrderItemsIdMetaFieldsParams, GetApiV2OrderItemsIdParams, GetApiV2OrderItemsParams, PutApiV21OrderItemsId, PutApiV21OrderItemsIdCallAction, PutApiV21OrderItemsIdMetaFields, PutApiV21OrderItemsIdSplit, PutApiV2OrderItemsId, PutApiV2OrderItemsIdCallAction, PutApiV2OrderItemsIdMetaFields, PutApiV2OrderItemsIdSplit } from "./data-contracts";
|
|
2
2
|
import { HttpClient, RequestParams } from "./http-client";
|
|
3
3
|
/**
|
|
4
4
|
* @description Get resource actions
|
|
@@ -9,6 +9,41 @@ import { HttpClient, RequestParams } from "./http-client";
|
|
|
9
9
|
* @request GET:/api/v2/order_items/actions
|
|
10
10
|
*/
|
|
11
11
|
export declare const getApiV2OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* @description Get all order items
|
|
14
|
+
*
|
|
15
|
+
* @tags order_items
|
|
16
|
+
* @name GetApiV2OrderItems
|
|
17
|
+
* @summary List all order items
|
|
18
|
+
* @request GET:/api/v2/order_items
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV2OrderItems: (client: HttpClient, query: GetApiV2OrderItemsParams, params?: RequestParams) => Promise<APIV2EntitiesOrderItem[]>;
|
|
21
|
+
/**
|
|
22
|
+
* @description Returns aggregated order_items
|
|
23
|
+
*
|
|
24
|
+
* @tags order_items
|
|
25
|
+
* @name GetApiV2OrderItemsAggregate
|
|
26
|
+
* @request GET:/api/v2/order_items/aggregate
|
|
27
|
+
*/
|
|
28
|
+
export declare const getApiV2OrderItemsAggregate: (client: HttpClient, query: GetApiV2OrderItemsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
29
|
+
/**
|
|
30
|
+
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
31
|
+
*
|
|
32
|
+
* @tags order_items
|
|
33
|
+
* @name GetApiV2OrderItemsIdOriginator
|
|
34
|
+
* @summary Retrieve the associated originator
|
|
35
|
+
* @request GET:/api/v2/order_items/{id}/originator
|
|
36
|
+
*/
|
|
37
|
+
export declare const getApiV2OrderItemsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
38
|
+
/**
|
|
39
|
+
* No description
|
|
40
|
+
*
|
|
41
|
+
* @tags order_items
|
|
42
|
+
* @name GetApiV2OrderItemsIdAudits
|
|
43
|
+
* @summary Retrieve audit info for users
|
|
44
|
+
* @request GET:/api/v2/order_items/{id}/audits
|
|
45
|
+
*/
|
|
46
|
+
export declare const getApiV2OrderItemsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
|
|
12
47
|
/**
|
|
13
48
|
* @description Get the meta fields for a(n) OrderItem
|
|
14
49
|
*
|
|
@@ -54,6 +89,15 @@ export declare const putApiV2OrderItemsId: (client: HttpClient, id: number, putA
|
|
|
54
89
|
* @request DELETE:/api/v2/order_items/{id}
|
|
55
90
|
*/
|
|
56
91
|
export declare const deleteApiV2OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
92
|
+
/**
|
|
93
|
+
* @description Return lots on batched order_items
|
|
94
|
+
*
|
|
95
|
+
* @tags order_items
|
|
96
|
+
* @name GetApiV2OrderItemsIdLots
|
|
97
|
+
* @summary List all lots associated with a batched order item
|
|
98
|
+
* @request GET:/api/v2/order_items/{id}/lots
|
|
99
|
+
*/
|
|
100
|
+
export declare const getApiV2OrderItemsIdLots: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesLot[]>;
|
|
57
101
|
/**
|
|
58
102
|
* @description Separate an order item into a new order
|
|
59
103
|
*
|
|
@@ -63,6 +107,15 @@ export declare const deleteApiV2OrderItemsId: (client: HttpClient, id: number, p
|
|
|
63
107
|
* @request PUT:/api/v2/order_items/{id}/separate
|
|
64
108
|
*/
|
|
65
109
|
export declare const putApiV2OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderItem>;
|
|
110
|
+
/**
|
|
111
|
+
* @description Split an order item into multiple order items
|
|
112
|
+
*
|
|
113
|
+
* @tags order_items
|
|
114
|
+
* @name PutApiV2OrderItemsIdSplit
|
|
115
|
+
* @summary Split an order item
|
|
116
|
+
* @request PUT:/api/v2/order_items/{id}/split
|
|
117
|
+
*/
|
|
118
|
+
export declare const putApiV2OrderItemsIdSplit: (client: HttpClient, id: number, putApiV2OrderItemsIdSplit: PutApiV2OrderItemsIdSplit, params?: RequestParams) => Promise<void>;
|
|
66
119
|
/**
|
|
67
120
|
* @description Perform an action on an order_item
|
|
68
121
|
*
|
|
@@ -90,6 +143,32 @@ export declare const getApiV2OrderItemsIdSerialNumbers: (client: HttpClient, id:
|
|
|
90
143
|
* @request GET:/api/v2.1/order_items/actions
|
|
91
144
|
*/
|
|
92
145
|
export declare const getApiV21OrderItemsActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
|
|
146
|
+
/**
|
|
147
|
+
* @description Get all order items
|
|
148
|
+
*
|
|
149
|
+
* @tags order_items
|
|
150
|
+
* @name GetApiV21OrderItems
|
|
151
|
+
* @summary List all order items
|
|
152
|
+
* @request GET:/api/v2.1/order_items
|
|
153
|
+
*/
|
|
154
|
+
export declare const getApiV21OrderItems: (client: HttpClient, query: GetApiV21OrderItemsParams, params?: RequestParams) => Promise<APIV21EntitiesOrderItem[]>;
|
|
155
|
+
/**
|
|
156
|
+
* @description Returns aggregated order_items
|
|
157
|
+
*
|
|
158
|
+
* @tags order_items
|
|
159
|
+
* @name GetApiV21OrderItemsAggregate
|
|
160
|
+
* @request GET:/api/v2.1/order_items/aggregate
|
|
161
|
+
*/
|
|
162
|
+
export declare const getApiV21OrderItemsAggregate: (client: HttpClient, query: GetApiV21OrderItemsAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
|
|
163
|
+
/**
|
|
164
|
+
* @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
|
|
165
|
+
*
|
|
166
|
+
* @tags order_items
|
|
167
|
+
* @name GetApiV21OrderItemsIdOriginator
|
|
168
|
+
* @summary Retrieve the associated originator
|
|
169
|
+
* @request GET:/api/v2.1/order_items/{id}/originator
|
|
170
|
+
*/
|
|
171
|
+
export declare const getApiV21OrderItemsIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
|
|
93
172
|
/**
|
|
94
173
|
* @description Get the meta fields for a(n) OrderItem
|
|
95
174
|
*
|
|
@@ -135,6 +214,15 @@ export declare const putApiV21OrderItemsId: (client: HttpClient, id: number, put
|
|
|
135
214
|
* @request DELETE:/api/v2.1/order_items/{id}
|
|
136
215
|
*/
|
|
137
216
|
export declare const deleteApiV21OrderItemsId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
|
|
217
|
+
/**
|
|
218
|
+
* @description Return lots on batched order_items
|
|
219
|
+
*
|
|
220
|
+
* @tags order_items
|
|
221
|
+
* @name GetApiV21OrderItemsIdLots
|
|
222
|
+
* @summary List all lots associated with a batched order item
|
|
223
|
+
* @request GET:/api/v2.1/order_items/{id}/lots
|
|
224
|
+
*/
|
|
225
|
+
export declare const getApiV21OrderItemsIdLots: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesLot[]>;
|
|
138
226
|
/**
|
|
139
227
|
* @description Separate an order item into a new order
|
|
140
228
|
*
|
|
@@ -144,6 +232,15 @@ export declare const deleteApiV21OrderItemsId: (client: HttpClient, id: number,
|
|
|
144
232
|
* @request PUT:/api/v2.1/order_items/{id}/separate
|
|
145
233
|
*/
|
|
146
234
|
export declare const putApiV21OrderItemsIdSeparate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrderItem>;
|
|
235
|
+
/**
|
|
236
|
+
* @description Split an order item into multiple order items
|
|
237
|
+
*
|
|
238
|
+
* @tags order_items
|
|
239
|
+
* @name PutApiV21OrderItemsIdSplit
|
|
240
|
+
* @summary Split an order item
|
|
241
|
+
* @request PUT:/api/v2.1/order_items/{id}/split
|
|
242
|
+
*/
|
|
243
|
+
export declare const putApiV21OrderItemsIdSplit: (client: HttpClient, id: number, putApiV21OrderItemsIdSplit: PutApiV21OrderItemsIdSplit, params?: RequestParams) => Promise<void>;
|
|
147
244
|
/**
|
|
148
245
|
* @description Perform an action on an order_item
|
|
149
246
|
*
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { APIV2EntitiesOrderTote, GetApiV21OrderTotesParams, GetApiV2OrderTotesParams } from "./data-contracts";
|
|
2
|
+
import { HttpClient, RequestParams } from "./http-client";
|
|
3
|
+
/**
|
|
4
|
+
* No description
|
|
5
|
+
*
|
|
6
|
+
* @tags order_totes
|
|
7
|
+
* @name GetApiV2OrderTotes
|
|
8
|
+
* @summary List all order totes
|
|
9
|
+
* @request GET:/api/v2/order_totes
|
|
10
|
+
*/
|
|
11
|
+
export declare const getApiV2OrderTotes: (client: HttpClient, query: GetApiV2OrderTotesParams, params?: RequestParams) => Promise<APIV2EntitiesOrderTote[]>;
|
|
12
|
+
/**
|
|
13
|
+
* No description
|
|
14
|
+
*
|
|
15
|
+
* @tags order_totes
|
|
16
|
+
* @name GetApiV21OrderTotes
|
|
17
|
+
* @summary List all order totes
|
|
18
|
+
* @request GET:/api/v2.1/order_totes
|
|
19
|
+
*/
|
|
20
|
+
export declare const getApiV21OrderTotes: (client: HttpClient, query: GetApiV21OrderTotesParams, params?: RequestParams) => Promise<APIV2EntitiesOrderTote[]>;
|