@whiplashmerch/whiplash-api-client 0.4.76 → 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.
Files changed (92) hide show
  1. package/dist/client.esm.js +18494 -2141
  2. package/dist/client.esm.js.map +1 -1
  3. package/dist/constants/index.d.ts +1 -0
  4. package/dist/constants/search.d.ts +9 -0
  5. package/dist/generated/AccountTransactions.d.ts +56 -0
  6. package/dist/generated/Accounts.d.ts +171 -0
  7. package/dist/generated/Allocations.d.ts +38 -0
  8. package/dist/generated/Broadcasts.d.ts +164 -0
  9. package/dist/generated/Cache.d.ts +56 -0
  10. package/dist/generated/CarrierAccounts.d.ts +191 -0
  11. package/dist/generated/Carriers.d.ts +20 -0
  12. package/dist/generated/Chromalists.d.ts +56 -0
  13. package/dist/generated/ConsumerReturns.d.ts +89 -1
  14. package/dist/generated/Currencies.d.ts +56 -0
  15. package/dist/generated/Customers.d.ts +172 -1
  16. package/dist/generated/CustomsInfos.d.ts +56 -0
  17. package/dist/generated/Dashboards.d.ts +38 -0
  18. package/dist/generated/Documents.d.ts +37 -1
  19. package/dist/generated/ExtApp.d.ts +30 -0
  20. package/dist/generated/FilterSets.d.ts +288 -0
  21. package/dist/generated/ImporterOfRecords.d.ts +92 -0
  22. package/dist/generated/Incidents.d.ts +128 -0
  23. package/dist/generated/InvoiceItems.d.ts +56 -0
  24. package/dist/generated/Invoices.d.ts +110 -0
  25. package/dist/generated/Items.d.ts +260 -1
  26. package/dist/generated/Locales.d.ts +19 -0
  27. package/dist/generated/LocationAdjustments.d.ts +65 -0
  28. package/dist/generated/LocationAudits.d.ts +162 -0
  29. package/dist/generated/LocationTransfers.d.ts +162 -0
  30. package/dist/generated/Locations.d.ts +207 -0
  31. package/dist/generated/Lots.d.ts +119 -0
  32. package/dist/generated/Manifests.d.ts +128 -0
  33. package/dist/generated/Me.d.ts +20 -0
  34. package/dist/generated/Nav.d.ts +20 -0
  35. package/dist/generated/NavItems.d.ts +20 -0
  36. package/dist/generated/OrderBatchItems.d.ts +54 -0
  37. package/dist/generated/OrderBatchRequests.d.ts +38 -0
  38. package/dist/generated/OrderBatches.d.ts +315 -0
  39. package/dist/generated/OrderDocuments.d.ts +37 -0
  40. package/dist/generated/OrderItems.d.ts +98 -1
  41. package/dist/generated/OrderTotes.d.ts +20 -0
  42. package/dist/generated/Orders.d.ts +468 -1
  43. package/dist/generated/Originators.d.ts +28 -1
  44. package/dist/generated/Packages.d.ts +205 -0
  45. package/dist/generated/Partners.d.ts +110 -0
  46. package/dist/generated/Prepacks.d.ts +11 -0
  47. package/dist/generated/ProjectTasks.d.ts +56 -0
  48. package/dist/generated/Projects.d.ts +163 -1
  49. package/dist/generated/Rates.d.ts +119 -0
  50. package/dist/generated/ReasonCodes.d.ts +20 -0
  51. package/dist/generated/ReturnAddresses.d.ts +92 -0
  52. package/dist/generated/RuleDismissals.d.ts +19 -0
  53. package/dist/generated/Rules.d.ts +155 -0
  54. package/dist/generated/Scancodes.d.ts +20 -0
  55. package/dist/generated/SerialNumbers.d.ts +56 -0
  56. package/dist/generated/ShipnoticeItems.d.ts +197 -1
  57. package/dist/generated/Shipnotices.d.ts +242 -1
  58. package/dist/generated/ShippingAliases.d.ts +119 -0
  59. package/dist/generated/ShippingBlacklistedMethods.d.ts +110 -0
  60. package/dist/generated/ShippingMethodMarkups.d.ts +11 -0
  61. package/dist/generated/ShippingMethods.d.ts +110 -0
  62. package/dist/generated/Shops.d.ts +47 -0
  63. package/dist/generated/Stats.d.ts +54 -0
  64. package/dist/generated/SurchargeMarkups.d.ts +56 -0
  65. package/dist/generated/TemplateTypes.d.ts +20 -0
  66. package/dist/generated/Templates.d.ts +82 -1
  67. package/dist/generated/Transactions.d.ts +11 -0
  68. package/dist/generated/TransportationMarkups.d.ts +56 -0
  69. package/dist/generated/Users.d.ts +245 -0
  70. package/dist/generated/Utilities.d.ts +38 -0
  71. package/dist/generated/WarehouseFeatures.d.ts +110 -0
  72. package/dist/generated/Warehouses.d.ts +245 -0
  73. package/dist/generated/Wholesales.d.ts +56 -0
  74. package/dist/generated/data-contracts.d.ts +20237 -4725
  75. package/dist/generated/index.d.ts +57 -0
  76. package/dist/index.d.ts +3 -0
  77. package/dist/mocks/customer.d.ts +2 -0
  78. package/dist/mocks/index.d.ts +4 -0
  79. package/dist/mocks/nav.d.ts +2 -0
  80. package/dist/mocks/user.d.ts +2 -0
  81. package/dist/mocks/warehouse.d.ts +2 -0
  82. package/dist/utils/errorHandler.d.ts +2 -0
  83. package/dist/utils/index.d.ts +9 -0
  84. package/dist/utils/nav.d.ts +9 -0
  85. package/dist/utils/orderBatch.d.ts +19 -0
  86. package/dist/utils/orders.d.ts +54 -0
  87. package/dist/utils/pusher.d.ts +25 -0
  88. package/dist/utils/rules.d.ts +8 -0
  89. package/dist/utils/user.d.ts +19 -0
  90. package/dist/utils/utilities.d.ts +8 -0
  91. package/dist/utils/warehouse.d.ts +26 -0
  92. package/package.json +1 -1
@@ -1,4 +1,4 @@
1
- import { APIV21EntitiesCustomsInfo, APIV21EntitiesOrder, APIV21EntitiesOrderItem, APIV21EntitiesPostResponse, APIV21EntitiesWholesale, APIV2EntitiesCount, APIV2EntitiesCustomsInfo, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesResult, APIV2EntitiesSerialNumber, APIV2EntitiesWholesale, GetApiV21OrdersCountParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersParams, PostApiV21Orders, PostApiV21OrdersBulk, PostApiV21OrdersIdOrderDocuments, PostApiV21OrdersIdOrderItems, PostApiV2Orders, PostApiV2OrdersBulk, PostApiV2OrdersIdOrderDocuments, PostApiV2OrdersIdOrderItems, PutApiV21OrdersId, PutApiV21OrdersIdCallAction, PutApiV21OrdersIdMetaFields, PutApiV21OrdersOriginatorOriginatorId, PutApiV2OrdersId, PutApiV2OrdersIdCallAction, PutApiV2OrdersIdMetaFields, PutApiV2OrdersOriginatorOriginatorId } from "./data-contracts";
1
+ import { APIV21EntitiesCustomsInfo, APIV21EntitiesIncident, APIV21EntitiesOrder, APIV21EntitiesOrderItem, APIV21EntitiesPostResponse, APIV21EntitiesWholesale, APIV2EntitiesAudits, APIV2EntitiesCount, APIV2EntitiesCustomsInfo, APIV2EntitiesIncident, APIV2EntitiesMessage, APIV2EntitiesMetaFields, APIV2EntitiesOrder, APIV2EntitiesOrderDocument, APIV2EntitiesOrderEvent, APIV2EntitiesOrderItem, APIV2EntitiesOrderItemLotMap, APIV2EntitiesOriginator, APIV2EntitiesPackage, APIV2EntitiesResult, APIV2EntitiesRuleDismissal, APIV2EntitiesSerialNumber, APIV2EntitiesSidekiqBatch, APIV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21Orders, PostApiV21OrdersBulk, PostApiV21OrdersIdIncidents, PostApiV21OrdersIdMessages, PostApiV21OrdersIdOrderDocuments, PostApiV21OrdersIdOrderItems, PostApiV21OrdersIdPackages, PostApiV21OrdersIdRuleDismissals, PostApiV2Orders, PostApiV2OrdersBulk, PostApiV2OrdersIdIncidents, PostApiV2OrdersIdMessages, PostApiV2OrdersIdOrderDocuments, PostApiV2OrdersIdOrderItems, PostApiV2OrdersIdPackages, PostApiV2OrdersIdRuleDismissals, PutApiV21OrdersId, PutApiV21OrdersIdCallAction, PutApiV21OrdersIdCallAsyncAction, PutApiV21OrdersIdCustomsInfo, PutApiV21OrdersIdMetaFields, PutApiV21OrdersIdWholesale, PutApiV21OrdersOriginatorOriginatorId, PutApiV2OrdersId, PutApiV2OrdersIdCallAction, PutApiV2OrdersIdCallAsyncAction, PutApiV2OrdersIdCustomsInfo, PutApiV2OrdersIdMetaFields, PutApiV2OrdersIdWholesale, PutApiV2OrdersOriginatorOriginatorId } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * @description Get resource actions
@@ -9,6 +9,15 @@ import { HttpClient, RequestParams } from "./http-client";
9
9
  * @request GET:/api/v2/orders/actions
10
10
  */
11
11
  export declare const getApiV2OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
+ /**
13
+ * @description Get orders traits
14
+ *
15
+ * @tags orders
16
+ * @name GetApiV2OrdersTraits
17
+ * @summary List orders traits
18
+ * @request GET:/api/v2/orders/traits
19
+ */
20
+ export declare const getApiV2OrdersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
12
21
  /**
13
22
  * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created orders.
14
23
  *
@@ -45,6 +54,14 @@ export declare const postApiV2Orders: (client: HttpClient, postApiV2Orders: Post
45
54
  * @request GET:/api/v2/orders/count
46
55
  */
47
56
  export declare const getApiV2OrdersCount: (client: HttpClient, query: GetApiV2OrdersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
57
+ /**
58
+ * @description Returns aggregated orders
59
+ *
60
+ * @tags orders
61
+ * @name GetApiV2OrdersAggregate
62
+ * @request GET:/api/v2/orders/aggregate
63
+ */
64
+ export declare const getApiV2OrdersAggregate: (client: HttpClient, query: GetApiV2OrdersAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
48
65
  /**
49
66
  * @description Retrieve an order
50
67
  *
@@ -63,6 +80,33 @@ export declare const getApiV2OrdersOriginatorOriginatorId: (client: HttpClient,
63
80
  * @request PUT:/api/v2/orders/originator/{originator_id}
64
81
  */
65
82
  export declare const putApiV2OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV2OrdersOriginatorOriginatorId: PutApiV2OrdersOriginatorOriginatorId, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
83
+ /**
84
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
85
+ *
86
+ * @tags orders
87
+ * @name GetApiV2OrdersIdOriginator
88
+ * @summary Retrieve the associated originator
89
+ * @request GET:/api/v2/orders/{id}/originator
90
+ */
91
+ export declare const getApiV2OrdersIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
92
+ /**
93
+ * No description
94
+ *
95
+ * @tags orders
96
+ * @name GetApiV2OrdersIdAudits
97
+ * @summary Retrieve audit info for users
98
+ * @request GET:/api/v2/orders/{id}/audits
99
+ */
100
+ export declare const getApiV2OrdersIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
101
+ /**
102
+ * No description
103
+ *
104
+ * @tags orders
105
+ * @name GetApiV2OrdersIdTraits
106
+ * @summary Retrieve the specified orders traits
107
+ * @request GET:/api/v2/orders/{id}/traits
108
+ */
109
+ export declare const getApiV2OrdersIdTraits: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
66
110
  /**
67
111
  * @description Get the meta fields for a(n) Order
68
112
  *
@@ -99,6 +143,45 @@ export declare const getApiV2OrdersId: (client: HttpClient, id: number, params?:
99
143
  * @request PUT:/api/v2/orders/{id}
100
144
  */
101
145
  export declare const putApiV2OrdersId: (client: HttpClient, id: number, putApiV2OrdersId: PutApiV2OrdersId, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
146
+ /**
147
+ * @description Various and sundry fees, currency, and editability
148
+ *
149
+ * @tags orders
150
+ * @name GetApiV2OrdersIdMeta
151
+ * @summary Retrieve meta info for an order
152
+ * @request GET:/api/v2/orders/{id}/meta
153
+ * @deprecated
154
+ */
155
+ export declare const getApiV2OrdersIdMeta: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
156
+ /**
157
+ * @description Get the shipping weight for an order
158
+ *
159
+ * @tags orders
160
+ * @name GetApiV2OrdersIdShippingWeight
161
+ * @summary Retrieve an order's shipping weight
162
+ * @request GET:/api/v2/orders/{id}/shipping_weight
163
+ * @deprecated
164
+ */
165
+ export declare const getApiV2OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
166
+ /**
167
+ * @description List shipping rates for an order
168
+ *
169
+ * @tags orders
170
+ * @name GetApiV2OrdersIdShippingRates
171
+ * @summary Retrieve shipping rates for an order
172
+ * @request GET:/api/v2/orders/{id}/shipping_rates
173
+ * @deprecated
174
+ */
175
+ export declare const getApiV2OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
176
+ /**
177
+ * @description List shipping rates for an order
178
+ *
179
+ * @tags orders
180
+ * @name GetApiV2OrdersIdShipmentRates
181
+ * @summary Retrieve shipment rates for an order, excluding fees
182
+ * @request GET:/api/v2/orders/{id}/shipment_rates
183
+ */
184
+ export declare const getApiV2OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder[]>;
102
185
  /**
103
186
  * @description Get the order history
104
187
  *
@@ -117,6 +200,44 @@ export declare const getApiV2OrdersIdEvents: (client: HttpClient, { id, ...query
117
200
  * @request GET:/api/v2/orders/{id}/events/count
118
201
  */
119
202
  export declare const getApiV2OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
203
+ /**
204
+ * @description Get the order lots
205
+ *
206
+ * @tags orders
207
+ * @name GetApiV2OrdersIdLots
208
+ * @summary Retrieve lot info for an order
209
+ * @request GET:/api/v2/orders/{id}/lots
210
+ * @deprecated
211
+ */
212
+ export declare const getApiV2OrdersIdLots: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderItemLotMap[]>;
213
+ /**
214
+ * @description Duplicate an order
215
+ *
216
+ * @tags orders
217
+ * @name PostApiV2OrdersIdDuplicate
218
+ * @summary Duplicate an order
219
+ * @request POST:/api/v2/orders/{id}/duplicate
220
+ */
221
+ export declare const postApiV2OrdersIdDuplicate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
222
+ /**
223
+ * @description returns the binary form of an order packingslip pdf
224
+ *
225
+ * @tags orders
226
+ * @name GetApiV2OrdersIdPackingslip
227
+ * @summary Retrieve the order packingslip pdf in binary form
228
+ * @request GET:/api/v2/orders/{id}/packingslip
229
+ * @deprecated
230
+ */
231
+ export declare const getApiV2OrdersIdPackingslip: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
232
+ /**
233
+ * No description
234
+ *
235
+ * @tags orders
236
+ * @name GetApiV2OrdersIdCallTrait
237
+ * @summary Retrieve the specified orders trait
238
+ * @request GET:/api/v2/orders/{id}/call/{trait}
239
+ */
240
+ export declare const getApiV2OrdersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV2OrdersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
120
241
  /**
121
242
  * @description get the CustomsInfo object for an order
122
243
  *
@@ -126,6 +247,69 @@ export declare const getApiV2OrdersIdEventsCount: (client: HttpClient, { id, ...
126
247
  * @request GET:/api/v2/orders/{id}/customs_info
127
248
  */
128
249
  export declare const getApiV2OrdersIdCustomsInfo: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesCustomsInfo>;
250
+ /**
251
+ * No description
252
+ *
253
+ * @tags orders
254
+ * @name PutApiV2OrdersIdCustomsInfo
255
+ * @summary Update a customs_info object
256
+ * @request PUT:/api/v2/orders/{id}/customs_info
257
+ */
258
+ export declare const putApiV2OrdersIdCustomsInfo: (client: HttpClient, id: number, putApiV2OrdersIdCustomsInfo: PutApiV2OrdersIdCustomsInfo, params?: RequestParams) => Promise<APIV2EntitiesCustomsInfo>;
259
+ /**
260
+ * @description Get all incidents for a(n) Order
261
+ *
262
+ * @tags orders
263
+ * @name GetApiV2OrdersIdIncidents
264
+ * @summary List all incidents for a resource
265
+ * @request GET:/api/v2/orders/{id}/incidents
266
+ */
267
+ export declare const getApiV2OrdersIdIncidents: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdIncidentsParams, params?: RequestParams) => Promise<APIV2EntitiesIncident[]>;
268
+ /**
269
+ * @description Create an incident for a(n) Order
270
+ *
271
+ * @tags orders
272
+ * @name PostApiV2OrdersIdIncidents
273
+ * @summary Create an incident for a resource
274
+ * @request POST:/api/v2/orders/{id}/incidents
275
+ */
276
+ export declare const postApiV2OrdersIdIncidents: (client: HttpClient, id: number, postApiV2OrdersIdIncidents: PostApiV2OrdersIdIncidents, params?: RequestParams) => Promise<APIV2EntitiesIncident>;
277
+ /**
278
+ * @description Returns count of incidents for a(n) Order
279
+ *
280
+ * @tags orders
281
+ * @name GetApiV2OrdersIdIncidentsCount
282
+ * @summary Count incidents for a resource
283
+ * @request GET:/api/v2/orders/{id}/incidents/count
284
+ */
285
+ export declare const getApiV2OrdersIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
286
+ /**
287
+ * @description Get all messages for a(n) Order
288
+ *
289
+ * @tags orders
290
+ * @name GetApiV2OrdersIdMessages
291
+ * @summary List all messages
292
+ * @request GET:/api/v2/orders/{id}/messages
293
+ */
294
+ export declare const getApiV2OrdersIdMessages: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdMessagesParams, params?: RequestParams) => Promise<APIV2EntitiesMessage[]>;
295
+ /**
296
+ * @description Create a messages for a(n) Order
297
+ *
298
+ * @tags orders
299
+ * @name PostApiV2OrdersIdMessages
300
+ * @summary Create a message
301
+ * @request POST:/api/v2/orders/{id}/messages
302
+ */
303
+ export declare const postApiV2OrdersIdMessages: (client: HttpClient, id: number, postApiV2OrdersIdMessages: PostApiV2OrdersIdMessages, params?: RequestParams) => Promise<APIV2EntitiesMessage>;
304
+ /**
305
+ * @description Returns count of messages for a(n) Order
306
+ *
307
+ * @tags orders
308
+ * @name GetApiV2OrdersIdMessagesCount
309
+ * @summary Count messages
310
+ * @request GET:/api/v2/orders/{id}/messages/count
311
+ */
312
+ export declare const getApiV2OrdersIdMessagesCount: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdMessagesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
129
313
  /**
130
314
  * @description Retrieve all order documents for an order
131
315
  *
@@ -180,6 +364,51 @@ export declare const getApiV2OrdersIdOrderItemsCount: (client: HttpClient, { id,
180
364
  * @request PUT:/api/v2/orders/{id}/call/{action}
181
365
  */
182
366
  export declare const putApiV2OrdersIdCallAction: (client: HttpClient, action: string, id: number, putApiV2OrdersIdCallAction: PutApiV2OrdersIdCallAction, params?: RequestParams) => Promise<APIV2EntitiesOrder>;
367
+ /**
368
+ * @description Perform an action on an order asynchronously
369
+ *
370
+ * @tags orders
371
+ * @name PutApiV2OrdersIdCallAsyncAction
372
+ * @summary Perform an action on an order asynchronously
373
+ * @request PUT:/api/v2/orders/{id}/call_async/{action}
374
+ */
375
+ export declare const putApiV2OrdersIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV2OrdersIdCallAsyncAction: PutApiV2OrdersIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
376
+ /**
377
+ * @description Get all packages for an order
378
+ *
379
+ * @tags orders
380
+ * @name GetApiV2OrdersIdPackages
381
+ * @summary List all packages for an order
382
+ * @request GET:/api/v2/orders/{id}/packages
383
+ */
384
+ export declare const getApiV2OrdersIdPackages: (client: HttpClient, { id, ...query }: GetApiV2OrdersIdPackagesParams, params?: RequestParams) => Promise<APIV2EntitiesPackage[]>;
385
+ /**
386
+ * No description
387
+ *
388
+ * @tags orders
389
+ * @name PostApiV2OrdersIdPackages
390
+ * @summary Create a package
391
+ * @request POST:/api/v2/orders/{id}/packages
392
+ */
393
+ export declare const postApiV2OrdersIdPackages: (client: HttpClient, id: number, postApiV2OrdersIdPackages: PostApiV2OrdersIdPackages, params?: RequestParams) => Promise<APIV2EntitiesPackage>;
394
+ /**
395
+ * @description List an order's rule dismissals
396
+ *
397
+ * @tags orders
398
+ * @name GetApiV2OrdersIdRuleDismissals
399
+ * @summary List rule dismissals for an order
400
+ * @request GET:/api/v2/orders/{id}/rule_dismissals
401
+ */
402
+ export declare const getApiV2OrdersIdRuleDismissals: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesRuleDismissal[]>;
403
+ /**
404
+ * No description
405
+ *
406
+ * @tags orders
407
+ * @name PostApiV2OrdersIdRuleDismissals
408
+ * @summary Create a rule dismissal
409
+ * @request POST:/api/v2/orders/{id}/rule_dismissals
410
+ */
411
+ export declare const postApiV2OrdersIdRuleDismissals: (client: HttpClient, id: number, postApiV2OrdersIdRuleDismissals: PostApiV2OrdersIdRuleDismissals, params?: RequestParams) => Promise<APIV2EntitiesRuleDismissal>;
183
412
  /**
184
413
  * @description Serial numbers are scanned and saved during the packing process.
185
414
  *
@@ -198,6 +427,15 @@ export declare const getApiV2OrdersIdSerialNumbers: (client: HttpClient, id: num
198
427
  * @request GET:/api/v2/orders/{id}/wholesale
199
428
  */
200
429
  export declare const getApiV2OrdersIdWholesale: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesWholesale>;
430
+ /**
431
+ * No description
432
+ *
433
+ * @tags orders
434
+ * @name PutApiV2OrdersIdWholesale
435
+ * @summary Update a wholesale object
436
+ * @request PUT:/api/v2/orders/{id}/wholesale
437
+ */
438
+ export declare const putApiV2OrdersIdWholesale: (client: HttpClient, id: number, putApiV2OrdersIdWholesale: PutApiV2OrdersIdWholesale, params?: RequestParams) => Promise<APIV2EntitiesWholesale>;
201
439
  /**
202
440
  * @description Get resource actions
203
441
  *
@@ -207,6 +445,15 @@ export declare const getApiV2OrdersIdWholesale: (client: HttpClient, id: number,
207
445
  * @request GET:/api/v2.1/orders/actions
208
446
  */
209
447
  export declare const getApiV21OrdersActions: (client: HttpClient, params?: RequestParams) => Promise<void>;
448
+ /**
449
+ * @description Get orders traits
450
+ *
451
+ * @tags orders
452
+ * @name GetApiV21OrdersTraits
453
+ * @summary List orders traits
454
+ * @request GET:/api/v2.1/orders/traits
455
+ */
456
+ export declare const getApiV21OrdersTraits: (client: HttpClient, params?: RequestParams) => Promise<void>;
210
457
  /**
211
458
  * @description Bulk requests are processed asynchronously. They automatically create a saved search with all of the newly created orders.
212
459
  *
@@ -243,6 +490,14 @@ export declare const postApiV21Orders: (client: HttpClient, postApiV21Orders: Po
243
490
  * @request GET:/api/v2.1/orders/count
244
491
  */
245
492
  export declare const getApiV21OrdersCount: (client: HttpClient, query: GetApiV21OrdersCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
493
+ /**
494
+ * @description Returns aggregated orders
495
+ *
496
+ * @tags orders
497
+ * @name GetApiV21OrdersAggregate
498
+ * @request GET:/api/v2.1/orders/aggregate
499
+ */
500
+ export declare const getApiV21OrdersAggregate: (client: HttpClient, query: GetApiV21OrdersAggregateParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
246
501
  /**
247
502
  * @description Retrieve an order
248
503
  *
@@ -261,6 +516,24 @@ export declare const getApiV21OrdersOriginatorOriginatorId: (client: HttpClient,
261
516
  * @request PUT:/api/v2.1/orders/originator/{originator_id}
262
517
  */
263
518
  export declare const putApiV21OrdersOriginatorOriginatorId: (client: HttpClient, originatorId: number, putApiV21OrdersOriginatorOriginatorId: PutApiV21OrdersOriginatorOriginatorId, params?: RequestParams) => Promise<void>;
519
+ /**
520
+ * @description Originators are e-commerce, API, or ERP representations of this item. They contain your system's ID and details.
521
+ *
522
+ * @tags orders
523
+ * @name GetApiV21OrdersIdOriginator
524
+ * @summary Retrieve the associated originator
525
+ * @request GET:/api/v2.1/orders/{id}/originator
526
+ */
527
+ export declare const getApiV21OrdersIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
528
+ /**
529
+ * No description
530
+ *
531
+ * @tags orders
532
+ * @name GetApiV21OrdersIdTraits
533
+ * @summary Retrieve the specified orders traits
534
+ * @request GET:/api/v2.1/orders/{id}/traits
535
+ */
536
+ export declare const getApiV21OrdersIdTraits: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdTraitsParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
264
537
  /**
265
538
  * @description Get the meta fields for a(n) Order
266
539
  *
@@ -297,6 +570,45 @@ export declare const getApiV21OrdersId: (client: HttpClient, id: number, params?
297
570
  * @request PUT:/api/v2.1/orders/{id}
298
571
  */
299
572
  export declare const putApiV21OrdersId: (client: HttpClient, id: number, putApiV21OrdersId: PutApiV21OrdersId, params?: RequestParams) => Promise<void>;
573
+ /**
574
+ * @description Various and sundry fees, currency, and editability
575
+ *
576
+ * @tags orders
577
+ * @name GetApiV21OrdersIdMeta
578
+ * @summary Retrieve meta info for an order
579
+ * @request GET:/api/v2.1/orders/{id}/meta
580
+ * @deprecated
581
+ */
582
+ export declare const getApiV21OrdersIdMeta: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
583
+ /**
584
+ * @description Get the shipping weight for an order
585
+ *
586
+ * @tags orders
587
+ * @name GetApiV21OrdersIdShippingWeight
588
+ * @summary Retrieve an order's shipping weight
589
+ * @request GET:/api/v2.1/orders/{id}/shipping_weight
590
+ * @deprecated
591
+ */
592
+ export declare const getApiV21OrdersIdShippingWeight: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder>;
593
+ /**
594
+ * @description List shipping rates for an order
595
+ *
596
+ * @tags orders
597
+ * @name GetApiV21OrdersIdShippingRates
598
+ * @summary Retrieve shipping rates for an order
599
+ * @request GET:/api/v2.1/orders/{id}/shipping_rates
600
+ * @deprecated
601
+ */
602
+ export declare const getApiV21OrdersIdShippingRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder[]>;
603
+ /**
604
+ * @description List shipping rates for an order
605
+ *
606
+ * @tags orders
607
+ * @name GetApiV21OrdersIdShipmentRates
608
+ * @summary Retrieve shipment rates for an order, excluding fees
609
+ * @request GET:/api/v2.1/orders/{id}/shipment_rates
610
+ */
611
+ export declare const getApiV21OrdersIdShipmentRates: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesOrder[]>;
300
612
  /**
301
613
  * @description Get the order history
302
614
  *
@@ -315,6 +627,44 @@ export declare const getApiV21OrdersIdEvents: (client: HttpClient, { id, ...quer
315
627
  * @request GET:/api/v2.1/orders/{id}/events/count
316
628
  */
317
629
  export declare const getApiV21OrdersIdEventsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdEventsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
630
+ /**
631
+ * @description Get the order lots
632
+ *
633
+ * @tags orders
634
+ * @name GetApiV21OrdersIdLots
635
+ * @summary Retrieve lot info for an order
636
+ * @request GET:/api/v2.1/orders/{id}/lots
637
+ * @deprecated
638
+ */
639
+ export declare const getApiV21OrdersIdLots: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesOrderItemLotMap[]>;
640
+ /**
641
+ * @description Duplicate an order
642
+ *
643
+ * @tags orders
644
+ * @name PostApiV21OrdersIdDuplicate
645
+ * @summary Duplicate an order
646
+ * @request POST:/api/v2.1/orders/{id}/duplicate
647
+ */
648
+ export declare const postApiV21OrdersIdDuplicate: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
649
+ /**
650
+ * @description returns the binary form of an order packingslip pdf
651
+ *
652
+ * @tags orders
653
+ * @name GetApiV21OrdersIdPackingslip
654
+ * @summary Retrieve the order packingslip pdf in binary form
655
+ * @request GET:/api/v2.1/orders/{id}/packingslip
656
+ * @deprecated
657
+ */
658
+ export declare const getApiV21OrdersIdPackingslip: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
659
+ /**
660
+ * No description
661
+ *
662
+ * @tags orders
663
+ * @name GetApiV21OrdersIdCallTrait
664
+ * @summary Retrieve the specified orders trait
665
+ * @request GET:/api/v2.1/orders/{id}/call/{trait}
666
+ */
667
+ export declare const getApiV21OrdersIdCallTrait: (client: HttpClient, { trait, id, ...query }: GetApiV21OrdersIdCallTraitParams, params?: RequestParams) => Promise<APIV2EntitiesResult>;
318
668
  /**
319
669
  * @description get the CustomsInfo object for an order
320
670
  *
@@ -324,6 +674,69 @@ export declare const getApiV21OrdersIdEventsCount: (client: HttpClient, { id, ..
324
674
  * @request GET:/api/v2.1/orders/{id}/customs_info
325
675
  */
326
676
  export declare const getApiV21OrdersIdCustomsInfo: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesCustomsInfo>;
677
+ /**
678
+ * No description
679
+ *
680
+ * @tags orders
681
+ * @name PutApiV21OrdersIdCustomsInfo
682
+ * @summary Update a customs_info object
683
+ * @request PUT:/api/v2.1/orders/{id}/customs_info
684
+ */
685
+ export declare const putApiV21OrdersIdCustomsInfo: (client: HttpClient, id: number, putApiV21OrdersIdCustomsInfo: PutApiV21OrdersIdCustomsInfo, params?: RequestParams) => Promise<void>;
686
+ /**
687
+ * @description Get all incidents for a(n) Order
688
+ *
689
+ * @tags orders
690
+ * @name GetApiV21OrdersIdIncidents
691
+ * @summary List all incidents for a resource
692
+ * @request GET:/api/v2.1/orders/{id}/incidents
693
+ */
694
+ export declare const getApiV21OrdersIdIncidents: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdIncidentsParams, params?: RequestParams) => Promise<APIV21EntitiesIncident[]>;
695
+ /**
696
+ * @description Create an incident for a(n) Order
697
+ *
698
+ * @tags orders
699
+ * @name PostApiV21OrdersIdIncidents
700
+ * @summary Create an incident for a resource
701
+ * @request POST:/api/v2.1/orders/{id}/incidents
702
+ */
703
+ export declare const postApiV21OrdersIdIncidents: (client: HttpClient, id: number, postApiV21OrdersIdIncidents: PostApiV21OrdersIdIncidents, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
704
+ /**
705
+ * @description Returns count of incidents for a(n) Order
706
+ *
707
+ * @tags orders
708
+ * @name GetApiV21OrdersIdIncidentsCount
709
+ * @summary Count incidents for a resource
710
+ * @request GET:/api/v2.1/orders/{id}/incidents/count
711
+ */
712
+ export declare const getApiV21OrdersIdIncidentsCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdIncidentsCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
713
+ /**
714
+ * @description Get all messages for a(n) Order
715
+ *
716
+ * @tags orders
717
+ * @name GetApiV21OrdersIdMessages
718
+ * @summary List all messages
719
+ * @request GET:/api/v2.1/orders/{id}/messages
720
+ */
721
+ export declare const getApiV21OrdersIdMessages: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdMessagesParams, params?: RequestParams) => Promise<APIV2EntitiesMessage[]>;
722
+ /**
723
+ * @description Create a messages for a(n) Order
724
+ *
725
+ * @tags orders
726
+ * @name PostApiV21OrdersIdMessages
727
+ * @summary Create a message
728
+ * @request POST:/api/v2.1/orders/{id}/messages
729
+ */
730
+ export declare const postApiV21OrdersIdMessages: (client: HttpClient, id: number, postApiV21OrdersIdMessages: PostApiV21OrdersIdMessages, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
731
+ /**
732
+ * @description Returns count of messages for a(n) Order
733
+ *
734
+ * @tags orders
735
+ * @name GetApiV21OrdersIdMessagesCount
736
+ * @summary Count messages
737
+ * @request GET:/api/v2.1/orders/{id}/messages/count
738
+ */
739
+ export declare const getApiV21OrdersIdMessagesCount: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdMessagesCountParams, params?: RequestParams) => Promise<APIV2EntitiesCount>;
327
740
  /**
328
741
  * @description Retrieve all order documents for an order
329
742
  *
@@ -378,6 +791,51 @@ export declare const getApiV21OrdersIdOrderItemsCount: (client: HttpClient, { id
378
791
  * @request PUT:/api/v2.1/orders/{id}/call/{action}
379
792
  */
380
793
  export declare const putApiV21OrdersIdCallAction: (client: HttpClient, action: string, id: number, putApiV21OrdersIdCallAction: PutApiV21OrdersIdCallAction, params?: RequestParams) => Promise<void>;
794
+ /**
795
+ * @description Perform an action on an order asynchronously
796
+ *
797
+ * @tags orders
798
+ * @name PutApiV21OrdersIdCallAsyncAction
799
+ * @summary Perform an action on an order asynchronously
800
+ * @request PUT:/api/v2.1/orders/{id}/call_async/{action}
801
+ */
802
+ export declare const putApiV21OrdersIdCallAsyncAction: (client: HttpClient, action: string, id: number, putApiV21OrdersIdCallAsyncAction: PutApiV21OrdersIdCallAsyncAction, params?: RequestParams) => Promise<APIV2EntitiesSidekiqBatch>;
803
+ /**
804
+ * @description Get all packages for an order
805
+ *
806
+ * @tags orders
807
+ * @name GetApiV21OrdersIdPackages
808
+ * @summary List all packages for an order
809
+ * @request GET:/api/v2.1/orders/{id}/packages
810
+ */
811
+ export declare const getApiV21OrdersIdPackages: (client: HttpClient, { id, ...query }: GetApiV21OrdersIdPackagesParams, params?: RequestParams) => Promise<APIV2EntitiesPackage[]>;
812
+ /**
813
+ * No description
814
+ *
815
+ * @tags orders
816
+ * @name PostApiV21OrdersIdPackages
817
+ * @summary Create a package
818
+ * @request POST:/api/v2.1/orders/{id}/packages
819
+ */
820
+ export declare const postApiV21OrdersIdPackages: (client: HttpClient, id: number, postApiV21OrdersIdPackages: PostApiV21OrdersIdPackages, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
821
+ /**
822
+ * @description List an order's rule dismissals
823
+ *
824
+ * @tags orders
825
+ * @name GetApiV21OrdersIdRuleDismissals
826
+ * @summary List rule dismissals for an order
827
+ * @request GET:/api/v2.1/orders/{id}/rule_dismissals
828
+ */
829
+ export declare const getApiV21OrdersIdRuleDismissals: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesRuleDismissal[]>;
830
+ /**
831
+ * No description
832
+ *
833
+ * @tags orders
834
+ * @name PostApiV21OrdersIdRuleDismissals
835
+ * @summary Create a rule dismissal
836
+ * @request POST:/api/v2.1/orders/{id}/rule_dismissals
837
+ */
838
+ export declare const postApiV21OrdersIdRuleDismissals: (client: HttpClient, id: number, postApiV21OrdersIdRuleDismissals: PostApiV21OrdersIdRuleDismissals, params?: RequestParams) => Promise<APIV21EntitiesPostResponse>;
381
839
  /**
382
840
  * @description Serial numbers are scanned and saved during the packing process.
383
841
  *
@@ -396,3 +854,12 @@ export declare const getApiV21OrdersIdSerialNumbers: (client: HttpClient, id: nu
396
854
  * @request GET:/api/v2.1/orders/{id}/wholesale
397
855
  */
398
856
  export declare const getApiV21OrdersIdWholesale: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV21EntitiesWholesale>;
857
+ /**
858
+ * No description
859
+ *
860
+ * @tags orders
861
+ * @name PutApiV21OrdersIdWholesale
862
+ * @summary Update a wholesale object
863
+ * @request PUT:/api/v2.1/orders/{id}/wholesale
864
+ */
865
+ export declare const putApiV21OrdersIdWholesale: (client: HttpClient, id: number, putApiV21OrdersIdWholesale: PutApiV21OrdersIdWholesale, params?: RequestParams) => Promise<void>;
@@ -1,4 +1,4 @@
1
- import { APIV2EntitiesOriginator, GetApiV21OriginatorsParams, GetApiV2OriginatorsParams } from "./data-contracts";
1
+ import { APIV2EntitiesAudits, APIV2EntitiesOriginator, GetApiV21OriginatorsParams, GetApiV2OriginatorsParams, PutApiV21OriginatorsId, PutApiV2OriginatorsId } from "./data-contracts";
2
2
  import { HttpClient, RequestParams } from "./http-client";
3
3
  /**
4
4
  * No description
@@ -9,6 +9,24 @@ import { HttpClient, RequestParams } from "./http-client";
9
9
  * @request GET:/api/v2/originators
10
10
  */
11
11
  export declare const getApiV2Originators: (client: HttpClient, query: GetApiV2OriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator[]>;
12
+ /**
13
+ * @description If an item ID changes in your system, it may be helpful to update that data in Whiplash as well.
14
+ *
15
+ * @tags originators
16
+ * @name PutApiV2OriginatorsId
17
+ * @summary Update an originator
18
+ * @request PUT:/api/v2/originators/{id}
19
+ */
20
+ export declare const putApiV2OriginatorsId: (client: HttpClient, id: number, putApiV2OriginatorsId: PutApiV2OriginatorsId, params?: RequestParams) => Promise<APIV2EntitiesOriginator>;
21
+ /**
22
+ * No description
23
+ *
24
+ * @tags originators
25
+ * @name GetApiV2OriginatorsIdAudits
26
+ * @summary Retrieve audit info for users
27
+ * @request GET:/api/v2/originators/{id}/audits
28
+ */
29
+ export declare const getApiV2OriginatorsIdAudits: (client: HttpClient, id: number, params?: RequestParams) => Promise<APIV2EntitiesAudits>;
12
30
  /**
13
31
  * No description
14
32
  *
@@ -18,3 +36,12 @@ export declare const getApiV2Originators: (client: HttpClient, query: GetApiV2Or
18
36
  * @request GET:/api/v2.1/originators
19
37
  */
20
38
  export declare const getApiV21Originators: (client: HttpClient, query: GetApiV21OriginatorsParams, params?: RequestParams) => Promise<APIV2EntitiesOriginator[]>;
39
+ /**
40
+ * @description If an item ID changes in your system, it may be helpful to update that data in Whiplash as well.
41
+ *
42
+ * @tags originators
43
+ * @name PutApiV21OriginatorsId
44
+ * @summary Update an originator
45
+ * @request PUT:/api/v2.1/originators/{id}
46
+ */
47
+ export declare const putApiV21OriginatorsId: (client: HttpClient, id: number, putApiV21OriginatorsId: PutApiV21OriginatorsId, params?: RequestParams) => Promise<void>;