@acmekit/js-sdk 2.13.2 → 2.13.3

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 (297) hide show
  1. package/dist/admin/index.d.ts +2 -177
  2. package/dist/admin/index.d.ts.map +1 -1
  3. package/dist/admin/index.js +3 -76
  4. package/dist/admin/index.js.map +1 -1
  5. package/dist/esm/admin/index.d.ts +2 -177
  6. package/dist/esm/admin/index.d.ts.map +1 -1
  7. package/dist/esm/admin/index.js +3 -73
  8. package/dist/esm/admin/index.js.map +1 -1
  9. package/dist/esm/store/index.d.ts +5 -1193
  10. package/dist/esm/store/index.d.ts.map +1 -1
  11. package/dist/esm/store/index.js +6 -1418
  12. package/dist/esm/store/index.js.map +1 -1
  13. package/dist/store/index.d.ts +5 -1193
  14. package/dist/store/index.d.ts.map +1 -1
  15. package/dist/store/index.js +6 -1408
  16. package/dist/store/index.js.map +1 -1
  17. package/package.json +2 -2
  18. package/dist/admin/campaign.d.ts +0 -164
  19. package/dist/admin/campaign.d.ts.map +0 -1
  20. package/dist/admin/campaign.js +0 -196
  21. package/dist/admin/campaign.js.map +0 -1
  22. package/dist/admin/claim.d.ts +0 -558
  23. package/dist/admin/claim.d.ts.map +0 -1
  24. package/dist/admin/claim.js +0 -693
  25. package/dist/admin/claim.js.map +0 -1
  26. package/dist/admin/currency.d.ts +0 -95
  27. package/dist/admin/currency.d.ts.map +0 -1
  28. package/dist/admin/currency.js +0 -104
  29. package/dist/admin/currency.js.map +0 -1
  30. package/dist/admin/draft-order.d.ts +0 -430
  31. package/dist/admin/draft-order.d.ts.map +0 -1
  32. package/dist/admin/draft-order.js +0 -547
  33. package/dist/admin/draft-order.js.map +0 -1
  34. package/dist/admin/exchange.d.ts +0 -487
  35. package/dist/admin/exchange.d.ts.map +0 -1
  36. package/dist/admin/exchange.js +0 -602
  37. package/dist/admin/exchange.js.map +0 -1
  38. package/dist/admin/fulfillment-provider.d.ts +0 -78
  39. package/dist/admin/fulfillment-provider.d.ts.map +0 -1
  40. package/dist/admin/fulfillment-provider.js +0 -88
  41. package/dist/admin/fulfillment-provider.js.map +0 -1
  42. package/dist/admin/fulfillment-set.d.ts +0 -141
  43. package/dist/admin/fulfillment-set.d.ts.map +0 -1
  44. package/dist/admin/fulfillment-set.js +0 -170
  45. package/dist/admin/fulfillment-set.js.map +0 -1
  46. package/dist/admin/fulfillment.d.ts +0 -91
  47. package/dist/admin/fulfillment.d.ts.map +0 -1
  48. package/dist/admin/fulfillment.js +0 -111
  49. package/dist/admin/fulfillment.js.map +0 -1
  50. package/dist/admin/inventory-item.d.ts +0 -320
  51. package/dist/admin/inventory-item.d.ts.map +0 -1
  52. package/dist/admin/inventory-item.js +0 -384
  53. package/dist/admin/inventory-item.js.map +0 -1
  54. package/dist/admin/order-edit.d.ts +0 -189
  55. package/dist/admin/order-edit.d.ts.map +0 -1
  56. package/dist/admin/order-edit.js +0 -240
  57. package/dist/admin/order-edit.js.map +0 -1
  58. package/dist/admin/order.d.ts +0 -452
  59. package/dist/admin/order.d.ts.map +0 -1
  60. package/dist/admin/order.js +0 -560
  61. package/dist/admin/order.js.map +0 -1
  62. package/dist/admin/payment-collection.d.ts +0 -72
  63. package/dist/admin/payment-collection.d.ts.map +0 -1
  64. package/dist/admin/payment-collection.js +0 -90
  65. package/dist/admin/payment-collection.js.map +0 -1
  66. package/dist/admin/payment.d.ts +0 -180
  67. package/dist/admin/payment.d.ts.map +0 -1
  68. package/dist/admin/payment.js +0 -208
  69. package/dist/admin/payment.js.map +0 -1
  70. package/dist/admin/price-list.d.ts +0 -234
  71. package/dist/admin/price-list.d.ts.map +0 -1
  72. package/dist/admin/price-list.js +0 -284
  73. package/dist/admin/price-list.js.map +0 -1
  74. package/dist/admin/price-preference.d.ts +0 -152
  75. package/dist/admin/price-preference.d.ts.map +0 -1
  76. package/dist/admin/price-preference.js +0 -182
  77. package/dist/admin/price-preference.js.map +0 -1
  78. package/dist/admin/product-category.d.ts +0 -170
  79. package/dist/admin/product-category.d.ts.map +0 -1
  80. package/dist/admin/product-category.js +0 -205
  81. package/dist/admin/product-category.js.map +0 -1
  82. package/dist/admin/product-collection.d.ts +0 -169
  83. package/dist/admin/product-collection.d.ts.map +0 -1
  84. package/dist/admin/product-collection.js +0 -203
  85. package/dist/admin/product-collection.js.map +0 -1
  86. package/dist/admin/product-tag.d.ts +0 -149
  87. package/dist/admin/product-tag.d.ts.map +0 -1
  88. package/dist/admin/product-tag.js +0 -177
  89. package/dist/admin/product-tag.js.map +0 -1
  90. package/dist/admin/product-type.d.ts +0 -150
  91. package/dist/admin/product-type.d.ts.map +0 -1
  92. package/dist/admin/product-type.js +0 -178
  93. package/dist/admin/product-type.js.map +0 -1
  94. package/dist/admin/product-variant.d.ts +0 -62
  95. package/dist/admin/product-variant.d.ts.map +0 -1
  96. package/dist/admin/product-variant.js +0 -66
  97. package/dist/admin/product-variant.js.map +0 -1
  98. package/dist/admin/product.d.ts +0 -740
  99. package/dist/admin/product.d.ts.map +0 -1
  100. package/dist/admin/product.js +0 -948
  101. package/dist/admin/product.js.map +0 -1
  102. package/dist/admin/promotion.d.ts +0 -310
  103. package/dist/admin/promotion.d.ts.map +0 -1
  104. package/dist/admin/promotion.js +0 -374
  105. package/dist/admin/promotion.js.map +0 -1
  106. package/dist/admin/refund-reasons.d.ts +0 -163
  107. package/dist/admin/refund-reasons.d.ts.map +0 -1
  108. package/dist/admin/refund-reasons.js +0 -192
  109. package/dist/admin/refund-reasons.js.map +0 -1
  110. package/dist/admin/region.d.ts +0 -152
  111. package/dist/admin/region.d.ts.map +0 -1
  112. package/dist/admin/region.js +0 -180
  113. package/dist/admin/region.js.map +0 -1
  114. package/dist/admin/reservation.d.ts +0 -154
  115. package/dist/admin/reservation.d.ts.map +0 -1
  116. package/dist/admin/reservation.js +0 -182
  117. package/dist/admin/reservation.js.map +0 -1
  118. package/dist/admin/return-reason.d.ts +0 -154
  119. package/dist/admin/return-reason.d.ts.map +0 -1
  120. package/dist/admin/return-reason.js +0 -183
  121. package/dist/admin/return-reason.js.map +0 -1
  122. package/dist/admin/return.d.ts +0 -558
  123. package/dist/admin/return.d.ts.map +0 -1
  124. package/dist/admin/return.js +0 -700
  125. package/dist/admin/return.js.map +0 -1
  126. package/dist/admin/sales-channel.d.ts +0 -196
  127. package/dist/admin/sales-channel.d.ts.map +0 -1
  128. package/dist/admin/sales-channel.js +0 -238
  129. package/dist/admin/sales-channel.js.map +0 -1
  130. package/dist/admin/shipping-option-type.d.ts +0 -152
  131. package/dist/admin/shipping-option-type.d.ts.map +0 -1
  132. package/dist/admin/shipping-option-type.js +0 -180
  133. package/dist/admin/shipping-option-type.js.map +0 -1
  134. package/dist/admin/shipping-option.d.ts +0 -171
  135. package/dist/admin/shipping-option.d.ts.map +0 -1
  136. package/dist/admin/shipping-option.js +0 -207
  137. package/dist/admin/shipping-option.js.map +0 -1
  138. package/dist/admin/shipping-profile.d.ts +0 -151
  139. package/dist/admin/shipping-profile.d.ts.map +0 -1
  140. package/dist/admin/shipping-profile.js +0 -181
  141. package/dist/admin/shipping-profile.js.map +0 -1
  142. package/dist/admin/stock-location.d.ts +0 -212
  143. package/dist/admin/stock-location.d.ts.map +0 -1
  144. package/dist/admin/stock-location.js +0 -260
  145. package/dist/admin/stock-location.js.map +0 -1
  146. package/dist/admin/tax-provider.d.ts +0 -64
  147. package/dist/admin/tax-provider.d.ts.map +0 -1
  148. package/dist/admin/tax-provider.js +0 -70
  149. package/dist/admin/tax-provider.js.map +0 -1
  150. package/dist/admin/tax-rate.d.ts +0 -155
  151. package/dist/admin/tax-rate.d.ts.map +0 -1
  152. package/dist/admin/tax-rate.js +0 -186
  153. package/dist/admin/tax-rate.js.map +0 -1
  154. package/dist/admin/tax-region.d.ts +0 -165
  155. package/dist/admin/tax-region.d.ts.map +0 -1
  156. package/dist/admin/tax-region.js +0 -196
  157. package/dist/admin/tax-region.js.map +0 -1
  158. package/dist/esm/admin/campaign.d.ts +0 -164
  159. package/dist/esm/admin/campaign.d.ts.map +0 -1
  160. package/dist/esm/admin/campaign.js +0 -213
  161. package/dist/esm/admin/campaign.js.map +0 -1
  162. package/dist/esm/admin/claim.d.ts +0 -558
  163. package/dist/esm/admin/claim.d.ts.map +0 -1
  164. package/dist/esm/admin/claim.js +0 -740
  165. package/dist/esm/admin/claim.js.map +0 -1
  166. package/dist/esm/admin/currency.d.ts +0 -95
  167. package/dist/esm/admin/currency.d.ts.map +0 -1
  168. package/dist/esm/admin/currency.js +0 -113
  169. package/dist/esm/admin/currency.js.map +0 -1
  170. package/dist/esm/admin/draft-order.d.ts +0 -430
  171. package/dist/esm/admin/draft-order.d.ts.map +0 -1
  172. package/dist/esm/admin/draft-order.js +0 -594
  173. package/dist/esm/admin/draft-order.js.map +0 -1
  174. package/dist/esm/admin/exchange.d.ts +0 -487
  175. package/dist/esm/admin/exchange.d.ts.map +0 -1
  176. package/dist/esm/admin/exchange.js +0 -643
  177. package/dist/esm/admin/exchange.js.map +0 -1
  178. package/dist/esm/admin/fulfillment-provider.d.ts +0 -78
  179. package/dist/esm/admin/fulfillment-provider.d.ts.map +0 -1
  180. package/dist/esm/admin/fulfillment-provider.js +0 -97
  181. package/dist/esm/admin/fulfillment-provider.js.map +0 -1
  182. package/dist/esm/admin/fulfillment-set.d.ts +0 -141
  183. package/dist/esm/admin/fulfillment-set.d.ts.map +0 -1
  184. package/dist/esm/admin/fulfillment-set.js +0 -185
  185. package/dist/esm/admin/fulfillment-set.js.map +0 -1
  186. package/dist/esm/admin/fulfillment.d.ts +0 -91
  187. package/dist/esm/admin/fulfillment.d.ts.map +0 -1
  188. package/dist/esm/admin/fulfillment.js +0 -122
  189. package/dist/esm/admin/fulfillment.js.map +0 -1
  190. package/dist/esm/admin/inventory-item.d.ts +0 -320
  191. package/dist/esm/admin/inventory-item.d.ts.map +0 -1
  192. package/dist/esm/admin/inventory-item.js +0 -411
  193. package/dist/esm/admin/inventory-item.js.map +0 -1
  194. package/dist/esm/admin/order-edit.d.ts +0 -189
  195. package/dist/esm/admin/order-edit.d.ts.map +0 -1
  196. package/dist/esm/admin/order-edit.js +0 -261
  197. package/dist/esm/admin/order-edit.js.map +0 -1
  198. package/dist/esm/admin/order.d.ts +0 -452
  199. package/dist/esm/admin/order.d.ts.map +0 -1
  200. package/dist/esm/admin/order.js +0 -603
  201. package/dist/esm/admin/order.js.map +0 -1
  202. package/dist/esm/admin/payment-collection.d.ts +0 -72
  203. package/dist/esm/admin/payment-collection.d.ts.map +0 -1
  204. package/dist/esm/admin/payment-collection.js +0 -101
  205. package/dist/esm/admin/payment-collection.js.map +0 -1
  206. package/dist/esm/admin/payment.d.ts +0 -180
  207. package/dist/esm/admin/payment.d.ts.map +0 -1
  208. package/dist/esm/admin/payment.js +0 -223
  209. package/dist/esm/admin/payment.js.map +0 -1
  210. package/dist/esm/admin/price-list.d.ts +0 -234
  211. package/dist/esm/admin/price-list.d.ts.map +0 -1
  212. package/dist/esm/admin/price-list.js +0 -305
  213. package/dist/esm/admin/price-list.js.map +0 -1
  214. package/dist/esm/admin/price-preference.d.ts +0 -152
  215. package/dist/esm/admin/price-preference.d.ts.map +0 -1
  216. package/dist/esm/admin/price-preference.js +0 -197
  217. package/dist/esm/admin/price-preference.js.map +0 -1
  218. package/dist/esm/admin/product-category.d.ts +0 -170
  219. package/dist/esm/admin/product-category.d.ts.map +0 -1
  220. package/dist/esm/admin/product-category.js +0 -222
  221. package/dist/esm/admin/product-category.js.map +0 -1
  222. package/dist/esm/admin/product-collection.d.ts +0 -169
  223. package/dist/esm/admin/product-collection.d.ts.map +0 -1
  224. package/dist/esm/admin/product-collection.js +0 -220
  225. package/dist/esm/admin/product-collection.js.map +0 -1
  226. package/dist/esm/admin/product-tag.d.ts +0 -149
  227. package/dist/esm/admin/product-tag.d.ts.map +0 -1
  228. package/dist/esm/admin/product-tag.js +0 -192
  229. package/dist/esm/admin/product-tag.js.map +0 -1
  230. package/dist/esm/admin/product-type.d.ts +0 -150
  231. package/dist/esm/admin/product-type.d.ts.map +0 -1
  232. package/dist/esm/admin/product-type.js +0 -193
  233. package/dist/esm/admin/product-type.js.map +0 -1
  234. package/dist/esm/admin/product-variant.d.ts +0 -62
  235. package/dist/esm/admin/product-variant.d.ts.map +0 -1
  236. package/dist/esm/admin/product-variant.js +0 -73
  237. package/dist/esm/admin/product-variant.js.map +0 -1
  238. package/dist/esm/admin/product.d.ts +0 -740
  239. package/dist/esm/admin/product.d.ts.map +0 -1
  240. package/dist/esm/admin/product.js +0 -995
  241. package/dist/esm/admin/product.js.map +0 -1
  242. package/dist/esm/admin/promotion.d.ts +0 -310
  243. package/dist/esm/admin/promotion.d.ts.map +0 -1
  244. package/dist/esm/admin/promotion.js +0 -401
  245. package/dist/esm/admin/promotion.js.map +0 -1
  246. package/dist/esm/admin/refund-reasons.d.ts +0 -163
  247. package/dist/esm/admin/refund-reasons.d.ts.map +0 -1
  248. package/dist/esm/admin/refund-reasons.js +0 -207
  249. package/dist/esm/admin/refund-reasons.js.map +0 -1
  250. package/dist/esm/admin/region.d.ts +0 -152
  251. package/dist/esm/admin/region.d.ts.map +0 -1
  252. package/dist/esm/admin/region.js +0 -195
  253. package/dist/esm/admin/region.js.map +0 -1
  254. package/dist/esm/admin/reservation.d.ts +0 -154
  255. package/dist/esm/admin/reservation.d.ts.map +0 -1
  256. package/dist/esm/admin/reservation.js +0 -199
  257. package/dist/esm/admin/reservation.js.map +0 -1
  258. package/dist/esm/admin/return-reason.d.ts +0 -154
  259. package/dist/esm/admin/return-reason.d.ts.map +0 -1
  260. package/dist/esm/admin/return-reason.js +0 -198
  261. package/dist/esm/admin/return-reason.js.map +0 -1
  262. package/dist/esm/admin/return.d.ts +0 -558
  263. package/dist/esm/admin/return.d.ts.map +0 -1
  264. package/dist/esm/admin/return.js +0 -749
  265. package/dist/esm/admin/return.js.map +0 -1
  266. package/dist/esm/admin/sales-channel.d.ts +0 -196
  267. package/dist/esm/admin/sales-channel.d.ts.map +0 -1
  268. package/dist/esm/admin/sales-channel.js +0 -257
  269. package/dist/esm/admin/sales-channel.js.map +0 -1
  270. package/dist/esm/admin/shipping-option-type.d.ts +0 -152
  271. package/dist/esm/admin/shipping-option-type.d.ts.map +0 -1
  272. package/dist/esm/admin/shipping-option-type.js +0 -195
  273. package/dist/esm/admin/shipping-option-type.js.map +0 -1
  274. package/dist/esm/admin/shipping-option.d.ts +0 -171
  275. package/dist/esm/admin/shipping-option.d.ts.map +0 -1
  276. package/dist/esm/admin/shipping-option.js +0 -224
  277. package/dist/esm/admin/shipping-option.js.map +0 -1
  278. package/dist/esm/admin/shipping-profile.d.ts +0 -151
  279. package/dist/esm/admin/shipping-profile.d.ts.map +0 -1
  280. package/dist/esm/admin/shipping-profile.js +0 -196
  281. package/dist/esm/admin/shipping-profile.js.map +0 -1
  282. package/dist/esm/admin/stock-location.d.ts +0 -212
  283. package/dist/esm/admin/stock-location.d.ts.map +0 -1
  284. package/dist/esm/admin/stock-location.js +0 -281
  285. package/dist/esm/admin/stock-location.js.map +0 -1
  286. package/dist/esm/admin/tax-provider.d.ts +0 -64
  287. package/dist/esm/admin/tax-provider.d.ts.map +0 -1
  288. package/dist/esm/admin/tax-provider.js +0 -77
  289. package/dist/esm/admin/tax-provider.js.map +0 -1
  290. package/dist/esm/admin/tax-rate.d.ts +0 -155
  291. package/dist/esm/admin/tax-rate.d.ts.map +0 -1
  292. package/dist/esm/admin/tax-rate.js +0 -201
  293. package/dist/esm/admin/tax-rate.js.map +0 -1
  294. package/dist/esm/admin/tax-region.d.ts +0 -165
  295. package/dist/esm/admin/tax-region.d.ts.map +0 -1
  296. package/dist/esm/admin/tax-region.js +0 -211
  297. package/dist/esm/admin/tax-region.js.map +0 -1
@@ -1,240 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrderEdit = void 0;
4
- class OrderEdit {
5
- /**
6
- * @ignore
7
- */
8
- constructor(client) {
9
- this.client = client;
10
- }
11
- /**
12
- * This method creates an order edit request. It sends a HTTP request to the
13
- * [Create Order Edit](https://docs.acmekit.com/api/admin#order-edits_postorderedits)
14
- * API route.
15
- *
16
- * @param body - The order edit's details.
17
- * @param query - Configure the fields to retrieve in the order edit.
18
- * @param headers - Headers to pass in the request.
19
- * @returns The order edit's details.
20
- *
21
- * @example
22
- * sdk.admin.orderEdit.initiateRequest({
23
- * order_id: "order_123"
24
- * })
25
- * .then(({ order_change }) => {
26
- * console.log(order_change)
27
- * })
28
- */
29
- async initiateRequest(body, query, headers) {
30
- return await this.client.fetch(`/admin/order-edits`, {
31
- method: "POST",
32
- headers,
33
- body,
34
- query,
35
- });
36
- }
37
- /**
38
- * This method changes an order edit to requested. It sends a request to the
39
- * [Request Order Edit](https://docs.acmekit.com/api/admin#order-edits_postordereditsidrequest)
40
- * API route.
41
- *
42
- * @param id - The ID of the order that is being edited.
43
- * @param query - Configure the fields to retrieve in the order preview.
44
- * @param headers - Headers to pass in the request.
45
- * @returns The order preview's details.
46
- *
47
- * @example
48
- * sdk.admin.orderEdit.request("order_123")
49
- * .then(({ order_preview }) => {
50
- * console.log(order_preview)
51
- * })
52
- */
53
- async request(id, query, headers) {
54
- return await this.client.fetch(`/admin/order-edits/${id}/request`, {
55
- method: "POST",
56
- headers,
57
- query,
58
- });
59
- }
60
- /**
61
- * This method confirms an order edit and applies it on the order. It sends a request
62
- * to the [Confirm Order Edit](https://docs.acmekit.com/api/admin#order-edits_postordereditsidconfirm)
63
- * API route.
64
- *
65
- * @param id - The ID of the order that is being edited.
66
- * @param query - Configure the fields to retrieve in the order preview.
67
- * @param headers - Headers to pass in the request.
68
- * @returns The order preview's details.
69
- *
70
- * @example
71
- * sdk.admin.orderEdit.confirm("order_123")
72
- * .then(({ order_preview }) => {
73
- * console.log(order_preview)
74
- * })
75
- */
76
- async confirm(id, query, headers) {
77
- return await this.client.fetch(`/admin/order-edits/${id}/confirm`, {
78
- method: "POST",
79
- headers,
80
- query,
81
- });
82
- }
83
- /**
84
- * This method cancels a requested order edit. It sends a request to the
85
- * [Cancel Order Edit](https://docs.acmekit.com/api/admin#order-edits_deleteordereditsid)
86
- * API route.
87
- *
88
- * @param id - The ID of the order that is being edited.
89
- * @param query - Query parameters
90
- * @param headers - Headers to pass in the request.
91
- * @returns The deletion's details.
92
- *
93
- * @example
94
- * sdk.admin.orderEdit.cancelRequest("order_123")
95
- * .then(({ deleted }) => {
96
- * console.log(deleted)
97
- * })
98
- */
99
- async cancelRequest(id, query, headers) {
100
- return await this.client.fetch(`/admin/order-edits/${id}`, {
101
- method: "DELETE",
102
- headers,
103
- query,
104
- });
105
- }
106
- /**
107
- * This method adds items to an order edit. These items will have the action `ITEM_ADD`.
108
- *
109
- * The method sends a request to the [Add Items](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditems)
110
- * API route.
111
- *
112
- * @param id - The ID of the order that is being edited.
113
- * @param body - The items to add.
114
- * @param query - Configure the fields to retrieve in the order preview.
115
- * @param headers - Headers to pass in the request.
116
- * @returns The order preview's details.
117
- *
118
- * @example
119
- * sdk.admin.orderEdit.addItems("order_123", {
120
- * items: [
121
- * {
122
- * variant_id: "variant_123",
123
- * quantity: 1
124
- * }
125
- * ]
126
- * })
127
- * .then(({ order_preview }) => {
128
- * console.log(order_preview)
129
- * })
130
- */
131
- async addItems(id, body, query, headers) {
132
- return await this.client.fetch(`/admin/order-edits/${id}/items`, {
133
- method: "POST",
134
- headers,
135
- body,
136
- query,
137
- });
138
- }
139
- /**
140
- * This method updates the quantity and other details of an item in an order. It sends a request to the
141
- * [Update Item Quantity](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditemsitemitem_id)
142
- * API route.
143
- *
144
- * You can also use this method to remove an item from an order by setting the `quantity` to `0`.
145
- *
146
- * @param id - The ID of the order that is being edited.
147
- * @param itemId - The item's ID in the order.
148
- * @param body - The data to edit in the item.
149
- * @param query - Configure the fields to retrieve in the order preview.
150
- * @param headers - Headers to pass in the request.
151
- * @returns The order preview's details.
152
- *
153
- * @example
154
- * sdk.admin.orderEdit.updateOriginalItem(
155
- * "order_123",
156
- * "orli_123",
157
- * {
158
- * quantity: 1
159
- * }
160
- * )
161
- * .then(({ order_preview }) => {
162
- * console.log(order_preview)
163
- * })
164
- */
165
- async updateOriginalItem(id, itemId, body, query, headers) {
166
- return await this.client.fetch(`/admin/order-edits/${id}/items/item/${itemId}`, {
167
- method: "POST",
168
- headers,
169
- body,
170
- query,
171
- });
172
- }
173
- /**
174
- * This method updates an added item in the order edit by the ID of the item's `ITEM_ADD` action.
175
- *
176
- * Every item has an `actions` property, whose value is an array of actions.
177
- * You can check the action's name using its `action` property, and use the value of the `id` property.
178
- *
179
- * It sends a request
180
- * to the [Update Item](https://docs.acmekit.com/api/admin#order-edits_postordereditsiditemsaction_id)
181
- * API route.
182
- *
183
- * @param id - The ID of the order that is being edited.
184
- * @param actionId - The id of the new item's `ITEM_ADD` action.
185
- * @param body - The data to update.
186
- * @param query - Configure the fields to retrieve in the order preview.
187
- * @param headers - Headers to pass in the request.
188
- * @returns The order preview's details.
189
- *
190
- * @example
191
- * sdk.admin.orderEdit.updateAddedItem(
192
- * "order_123",
193
- * "orli_123",
194
- * {
195
- * quantity: 1
196
- * }
197
- * )
198
- * .then(({ order_preview }) => {
199
- * console.log(order_preview)
200
- * })
201
- */
202
- async updateAddedItem(id, actionId, body, query, headers) {
203
- return await this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {
204
- method: "POST",
205
- headers,
206
- body,
207
- query,
208
- });
209
- }
210
- /**
211
- * This method removes an added item in the order edit by the ID of the item's `ITEM_ADD` action.
212
- *
213
- * Every item has an `actions` property, whose value is an array of actions.
214
- * You can check the action's name using its `action` property, and use the value of the `id` property.
215
- *
216
- * @param id - The ID of the order that is being edited.
217
- * @param actionId - The id of the new item's `ITEM_ADD` action.
218
- * @param query - Configure the fields to retrieve in the order preview.
219
- * @param headers - Headers to pass in the request.
220
- * @returns The order preview's details.
221
- *
222
- * @example
223
- * sdk.admin.orderEdit.removeAddedItem(
224
- * "order_123",
225
- * "orli_123",
226
- * )
227
- * .then(({ order_preview }) => {
228
- * console.log(order_preview)
229
- * })
230
- */
231
- async removeAddedItem(id, actionId, query, headers) {
232
- return await this.client.fetch(`/admin/order-edits/${id}/items/${actionId}`, {
233
- method: "DELETE",
234
- headers,
235
- query,
236
- });
237
- }
238
- }
239
- exports.OrderEdit = OrderEdit;
240
- //# sourceMappingURL=order-edit.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"order-edit.js","sourceRoot":"","sources":["../../src/admin/order-edit.ts"],"names":[],"mappings":";;;AAIA,MAAa,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,eAAe,CACnB,IAA6C,EAC7C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,EAClC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,QAAQ,EAChC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,kBAAkB,CACtB,EAAU,EACV,MAAc,EACd,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,eAAe,MAAM,EAAE,EAC/C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,IAAwC,EACxC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,eAAe,CACnB,EAAU,EACV,QAAgB,EAChB,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EAAE,UAAU,QAAQ,EAAE,EAC5C;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AApTD,8BAoTC"}
@@ -1,452 +0,0 @@
1
- import { AdminOrderChangesResponse, CreateOrderCreditLineDTO, FindParams, HttpTypes, SelectParams } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class Order {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method retrieves an order by its ID. It sends a request to the
15
- * [Get Order](https://docs.acmekit.com/api/admin#orders_getordersid)
16
- * API route.
17
- *
18
- * @param id - The order's ID.
19
- * @param query - Configure the fields to retrieve in the order.
20
- * @param headers - Headers to pass in the request
21
- * @returns The order's details.
22
- *
23
- * @example
24
- * To retrieve an order by its ID:
25
- *
26
- * ```ts
27
- * sdk.admin.order.retrieve("order_123")
28
- * .then(({ order }) => {
29
- * console.log(order)
30
- * })
31
- * ```
32
- *
33
- * To specify the fields and relations to retrieve:
34
- *
35
- * ```ts
36
- * sdk.admin.order.retrieve("order_123", {
37
- * fields: "id,*items"
38
- * })
39
- * .then(({ order }) => {
40
- * console.log(order)
41
- * })
42
- * ```
43
- *
44
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
45
- */
46
- retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
47
- /**
48
- * This method updates an order. It sends a request to the
49
- * [Update Order Email](https://docs.acmekit.com/api/admin#orders_postordersid)
50
- * API route.
51
- *
52
- * @param id - The order's ID.
53
- * @param body - The update details.
54
- * @param headers - Headers to pass in the request
55
- * @returns The order's details.
56
- *
57
- * @example
58
- * sdk.admin.order.update(
59
- * "order_123",
60
- * {
61
- * email: "new_email@example.com",
62
- * shipping_address: {
63
- * first_name: "John",
64
- * last_name: "Doe",
65
- * address_1: "123 Main St",
66
- * }
67
- * }
68
- * )
69
- * .then(({ order }) => {
70
- * console.log(order)
71
- * })
72
- */
73
- update(id: string, body: HttpTypes.AdminUpdateOrder, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
74
- /**
75
- * This method retrieves the preview of an order based on its last associated change. It sends a request to the
76
- * [Get Order Preview](https://docs.acmekit.com/api/admin#orders_getordersidpreview) API route.
77
- *
78
- * @param id - The order's ID.
79
- * @param query - Query parameters.
80
- * @param headers - Headers to pass in the request
81
- * @returns The order preview's details.
82
- *
83
- * @example
84
- * sdk.admin.order.retrievePreview("order_123")
85
- * .then(({ order }) => {
86
- * console.log(order)
87
- * })
88
- */
89
- retrievePreview(id: string, query?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderPreviewResponse>;
90
- /**
91
- * This method retrieves a paginated list of orders. It sends a request to the
92
- * [List Orders](https://docs.acmekit.com/api/admin#orders_getorders) API route.
93
- *
94
- * @param queryParams - Filters and pagination configurations.
95
- * @param headers - Headers to pass in the request.
96
- * @returns The paginated list of orders.
97
- *
98
- * @example
99
- * To retrieve the list of orders:
100
- *
101
- * ```ts
102
- * sdk.admin.order.list()
103
- * .then(({ orders, count, limit, offset }) => {
104
- * console.log(orders)
105
- * })
106
- * ```
107
- *
108
- * To configure the pagination, pass the `limit` and `offset` query parameters.
109
- *
110
- * For example, to retrieve only 10 items and skip 10 items:
111
- *
112
- * ```ts
113
- * sdk.admin.order.list({
114
- * limit: 10,
115
- * offset: 10
116
- * })
117
- * .then(({ orders, count, limit, offset }) => {
118
- * console.log(orders)
119
- * })
120
- * ```
121
- *
122
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
123
- * in each order:
124
- *
125
- * ```ts
126
- * sdk.admin.order.list({
127
- * fields: "id,*items"
128
- * })
129
- * .then(({ orders, count, limit, offset }) => {
130
- * console.log(orders)
131
- * })
132
- * ```
133
- *
134
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
135
- */
136
- list(queryParams?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderListResponse>;
137
- /**
138
- * This method archives an order. It sends a request to the
139
- * [Archive Order](https://docs.acmekit.com/api/admin#orders_postordersidarchive)
140
- * API route.
141
- *
142
- * @param id - The order's ID.
143
- * @param queryParams - Configure the fields to retrieve in the order.
144
- * @param headers - Headers to pass in the request
145
- * @returns The order's details.
146
- *
147
- * @example
148
- * sdk.admin.order.archive("order_123")
149
- * .then(({ order }) => {
150
- * console.log(order)
151
- * })
152
- */
153
- archive(id: string, queryParams?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
154
- /**
155
- * This method cancels an order. It sends a request to the
156
- * [Cancel Order](https://docs.acmekit.com/api/admin#orders_postordersidcancel)
157
- * API route.
158
- *
159
- * @param id - The order's ID.
160
- * @param headers - Headers to pass in the request.
161
- * @returns The order's details.
162
- *
163
- * @example
164
- * sdk.admin.order.cancel("order_123")
165
- * .then(({ order }) => {
166
- * console.log(order)
167
- * })
168
- */
169
- cancel(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
170
- /**
171
- * This method completes an order. It sends a request to the
172
- * [Complete Order](https://docs.acmekit.com/api/admin#orders_postordersidcomplete)
173
- * API route.
174
- *
175
- * @param id - The order's ID.
176
- * @param headers - Headers to pass in the request.
177
- * @returns The order's details.
178
- *
179
- * @example
180
- * sdk.admin.order.complete("order_123")
181
- * .then(({ order }) => {
182
- * console.log(order)
183
- * })
184
- */
185
- complete(id: string, body: HttpTypes.AdditionalData, queryParams?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
186
- /**
187
- * This method requests an order transfer. It sends a request to the
188
- * [Request Order Transfer](https://docs.acmekit.com/api/admin#orders_postordersidrequesttransfer)
189
- * API route.
190
- *
191
- * @param id - The order's ID.
192
- * @param headers - Headers to pass in the request.
193
- * @param body - The transfer's details - the id of the next owner.
194
- * @returns The order's details.
195
- *
196
- * @example
197
- * sdk.admin.order.requestTransfer("order_123", {
198
- * customer_id: "cus_123",
199
- * internal_note: "Internal note",
200
- * })
201
- * .then(({ order }) => {
202
- * console.log(order)
203
- * })
204
- */
205
- requestTransfer(id: string, body: HttpTypes.AdminRequestOrderTransfer, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
206
- /**
207
- * This method cancels an order transfer request. It sends a request to the
208
- * [Cancel Order Transfer Request](https://docs.acmekit.com/api/admin#orders_postordersidcanceltransferrequest)
209
- * API route.
210
- *
211
- * @param id - The order's ID.
212
- * @param headers - Headers to pass in the request.
213
- * @returns The order's details.
214
- *
215
- * @example
216
- * sdk.admin.order.cancelTransfer("order_123")
217
- * .then(({ order }) => {
218
- * console.log(order)
219
- * })
220
- */
221
- cancelTransfer(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
222
- /**
223
- * This method creates a fulfillment for an order. It sends a request to the
224
- * [Create Fulfillment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillments)
225
- * API route.
226
- *
227
- * @param id - The order's ID.
228
- * @param body - The fulfillment's details.
229
- * @param query - Configure the fields to retrieve in the order.
230
- * @param headers - Headers to pass in the request
231
- * @returns The order's details.
232
- *
233
- * @example
234
- * sdk.admin.order.createFulfillment("order_123", {
235
- * items: [
236
- * {
237
- * id: "orli_123",
238
- * quantity: 1
239
- * }
240
- * ]
241
- * })
242
- * .then(({ order }) => {
243
- * console.log(order)
244
- * })
245
- */
246
- createFulfillment(id: string, body: HttpTypes.AdminCreateOrderFulfillment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
247
- /**
248
- * This method cancels an order's fulfillment. It sends a request to the
249
- * [Cancel Fulfillment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idcancel)
250
- * API route.
251
- *
252
- * @param id - The order's ID.
253
- * @param fulfillmentId - The ID of the fulfillment to cancel.
254
- * @param body - The cancelation's details.
255
- * @param headers - Headers to pass in the request
256
- * @returns The order's details.
257
- *
258
- * @example
259
- * sdk.admin.order.cancelFulfillment(
260
- * "order_123",
261
- * "ful_123",
262
- * {
263
- * no_notification: false
264
- * }
265
- * )
266
- * .then(({ order }) => {
267
- * console.log(order)
268
- * })
269
- */
270
- cancelFulfillment(id: string, fulfillmentId: string, body: HttpTypes.AdminCancelOrderFulfillment, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
271
- /**
272
- * This method creates a shipment for an order's fulfillment. It sends a request to the
273
- * [Create Shipment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idshipments)
274
- * API route.
275
- *
276
- * @param id - The order's ID.
277
- * @param fulfillmentId - The ID of the fulfillment.
278
- * @param body - The shipment's details.
279
- * @param query - Configure the fields to retrieve in the order.
280
- * @param headers - Headers to pass in the request
281
- * @returns The order's details.
282
- *
283
- * @example
284
- * sdk.admin.order.createShipment(
285
- * "order_123",
286
- * "ful_123",
287
- * {
288
- * items: [
289
- * {
290
- * id: "fulit_123",
291
- * quantity: 1
292
- * }
293
- * ]
294
- * }
295
- * )
296
- * .then(({ order }) => {
297
- * console.log(order)
298
- * })
299
- */
300
- createShipment(id: string, fulfillmentId: string, body: HttpTypes.AdminCreateOrderShipment, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
301
- /**
302
- * This method marks an order's fulfillment as delivered. It sends a request to the
303
- * [Mark Delivered ](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered)
304
- * API route.
305
- *
306
- * @param id - The order's ID.
307
- * @param fulfillmentId - The fulfillment's ID.
308
- * @param query - Configure the fields to retrieve in the order.
309
- * @param headers - Headers to pass in the request
310
- * @returns The order's details.
311
- *
312
- * @example
313
- * sdk.admin.order.markAsDelivered(
314
- * "order_123",
315
- * "ful_123",
316
- * )
317
- * .then(({ order }) => {
318
- * console.log(order)
319
- * })
320
- */
321
- markAsDelivered(id: string, fulfillmentId: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
322
- /**
323
- * This method retrieves a list of shipping options for an order based on the order's shipping address.
324
- *
325
- * This method sends a request to the [List Shipping Options](https://docs.acmekit.com/api/admin#orders_getordersidshipping-options)
326
- * API route.
327
- *
328
- * @param id - The order's ID.
329
- * @param queryParams - Configure the fields to retrieve in each shipping option.
330
- * @param headers - Headers to pass in the request
331
- * @returns The list of shipping options.
332
- *
333
- * @example
334
- * sdk.admin.order.listShippingOptions("order_123")
335
- * .then(({ shipping_options }) => {
336
- * console.log(shipping_options)
337
- * })
338
- */
339
- listShippingOptions(id: string, queryParams?: FindParams & HttpTypes.AdminGetOrderShippingOptionList, headers?: ClientHeaders): Promise<{
340
- shipping_options: HttpTypes.AdminShippingOption[];
341
- }>;
342
- /**
343
- * This method retrieves a list of changes made on an order, including returns, exchanges, etc...
344
- *
345
- * This method sends a request to the [List Changes](https://docs.acmekit.com/api/admin#orders_getordersidchanges)
346
- * API route.
347
- *
348
- * @param id - The order's ID.
349
- * @param queryParams - Configure the fields to retrieve in each order change.
350
- * @param headers - Headers to pass in the request
351
- * @returns The list of order changes.
352
- *
353
- * @example
354
- * sdk.admin.order.listChanges("order_123")
355
- * .then(({ order_changes }) => {
356
- * console.log(order_changes)
357
- * })
358
- */
359
- listChanges(id: string, queryParams?: FindParams & HttpTypes.AdminOrderChangesFilters, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<AdminOrderChangesResponse>>;
360
- /**
361
- * This method retrieves the order's line items. It sends a request to the
362
- * [List Line Items](https://docs.acmekit.com/api/admin#orders_getordersidlineitems)
363
- * API routes.
364
- *
365
- * @param id - The order's ID.
366
- * @param queryParams - Configure the fields to retrieve in each line item.
367
- * @param headers - Headers to pass in the request
368
- * @returns The list of line items.
369
- *
370
- * @example
371
- * sdk.admin.order.listLineItems("order_123")
372
- * .then(({ order_items }) => {
373
- * console.log(order_items)
374
- * })
375
- */
376
- listLineItems(id: string, queryParams?: FindParams & HttpTypes.AdminOrderItemsFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderLineItemsListResponse>;
377
- /**
378
- * This method creates a credit line for an order. It sends a request to the
379
- * [Create Credit Line](https://docs.acmekit.com/api/admin#orders_postordersidcredit-lines) API route.
380
- *
381
- * @param orderId - The order's ID.
382
- * @param body - The credit line's details.
383
- * @param query - Configure the fields to retrieve in the order.
384
- * @param headers - Headers to pass in the request
385
- * @returns The order's details.
386
- *
387
- * @example
388
- * sdk.admin.order.createCreditLine(
389
- * "order_123",
390
- * {
391
- * amount: 100,
392
- * reference: "order",
393
- * reference_id: "order_123",
394
- * }
395
- * )
396
- * .then(({ order }) => {
397
- * console.log(order)
398
- * })
399
- */
400
- createCreditLine(orderId: string, body: Omit<CreateOrderCreditLineDTO, "order_id">, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderResponse>;
401
- /**
402
- * This method updates an order change. It sends a request to the
403
- * [Update Order Change](https://docs.acmekit.com/api/admin#order-changes_postorder-changesid)
404
- * API route.
405
- *
406
- * @since 2.12.0
407
- *
408
- * @param id - The order change's ID.
409
- * @param body - The update details.
410
- * @param query - Configure the fields to retrieve in the order change.
411
- * @param headers - Headers to pass in the request
412
- * @returns The order change's details.
413
- *
414
- * @example
415
- * sdk.admin.order.updateOrderChange(
416
- * "ordch_123",
417
- * {
418
- * carry_over_promotions: true
419
- * }
420
- * )
421
- * .then(({ order_change }) => {
422
- * console.log(order_change)
423
- * })
424
- */
425
- updateOrderChange(id: string, body: HttpTypes.AdminUpdateOrderChange, query?: HttpTypes.AdminOrderChangesFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminOrderChangeResponse>;
426
- /**
427
- * This method starts an order export process to retrieve a CSV of exported orders. It sends
428
- * a request to the [Export Orders](https://docs.acmekit.com/api/admin#orders_postordersexport) API route.
429
- *
430
- * You'll receive in the response the transaction ID of the workflow generating the CSV file.
431
- * To check the status of the execution, send a `GET` request to
432
- * `/admin/workflows-executions/export-orders/:transaction-id`.
433
- *
434
- * Once the execution finishes successfully, a notification is created for the export.
435
- * You can retrieve the notifications using the `/admin/notification` API route to
436
- * retrieve the file's download URL.
437
- *
438
- * @since 2.12.3
439
- *
440
- * @param query - Filters to specify which orders to export.
441
- * @param headers - Headers to pass in the request.
442
- * @returns The export's details.
443
- *
444
- * @example
445
- * sdk.admin.order.export()
446
- * .then(({ transaction_id }) => {
447
- * console.log(transaction_id)
448
- * })
449
- */
450
- export(query?: HttpTypes.AdminOrderFilters, headers?: ClientHeaders): Promise<HttpTypes.AdminExportOrderResponse>;
451
- }
452
- //# sourceMappingURL=order.d.ts.map