@acmekit/js-sdk 2.13.1 → 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,603 +0,0 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- export class Order {
11
- /**
12
- * @ignore
13
- */
14
- constructor(client) {
15
- this.client = client;
16
- }
17
- /**
18
- * This method retrieves an order by its ID. It sends a request to the
19
- * [Get Order](https://docs.acmekit.com/api/admin#orders_getordersid)
20
- * API route.
21
- *
22
- * @param id - The order's ID.
23
- * @param query - Configure the fields to retrieve in the order.
24
- * @param headers - Headers to pass in the request
25
- * @returns The order's details.
26
- *
27
- * @example
28
- * To retrieve an order by its ID:
29
- *
30
- * ```ts
31
- * sdk.admin.order.retrieve("order_123")
32
- * .then(({ order }) => {
33
- * console.log(order)
34
- * })
35
- * ```
36
- *
37
- * To specify the fields and relations to retrieve:
38
- *
39
- * ```ts
40
- * sdk.admin.order.retrieve("order_123", {
41
- * fields: "id,*items"
42
- * })
43
- * .then(({ order }) => {
44
- * console.log(order)
45
- * })
46
- * ```
47
- *
48
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
49
- */
50
- retrieve(id, query, headers) {
51
- return __awaiter(this, void 0, void 0, function* () {
52
- return yield this.client.fetch(`/admin/orders/${id}`, {
53
- query,
54
- headers,
55
- });
56
- });
57
- }
58
- /**
59
- * This method updates an order. It sends a request to the
60
- * [Update Order Email](https://docs.acmekit.com/api/admin#orders_postordersid)
61
- * API route.
62
- *
63
- * @param id - The order's ID.
64
- * @param body - The update details.
65
- * @param headers - Headers to pass in the request
66
- * @returns The order's details.
67
- *
68
- * @example
69
- * sdk.admin.order.update(
70
- * "order_123",
71
- * {
72
- * email: "new_email@example.com",
73
- * shipping_address: {
74
- * first_name: "John",
75
- * last_name: "Doe",
76
- * address_1: "123 Main St",
77
- * }
78
- * }
79
- * )
80
- * .then(({ order }) => {
81
- * console.log(order)
82
- * })
83
- */
84
- update(id, body, headers) {
85
- return __awaiter(this, void 0, void 0, function* () {
86
- return yield this.client.fetch(`/admin/orders/${id}`, {
87
- method: "POST",
88
- headers,
89
- body,
90
- });
91
- });
92
- }
93
- /**
94
- * This method retrieves the preview of an order based on its last associated change. It sends a request to the
95
- * [Get Order Preview](https://docs.acmekit.com/api/admin#orders_getordersidpreview) API route.
96
- *
97
- * @param id - The order's ID.
98
- * @param query - Query parameters.
99
- * @param headers - Headers to pass in the request
100
- * @returns The order preview's details.
101
- *
102
- * @example
103
- * sdk.admin.order.retrievePreview("order_123")
104
- * .then(({ order }) => {
105
- * console.log(order)
106
- * })
107
- */
108
- retrievePreview(id, query, headers) {
109
- return __awaiter(this, void 0, void 0, function* () {
110
- return yield this.client.fetch(`/admin/orders/${id}/preview`, {
111
- query,
112
- headers,
113
- });
114
- });
115
- }
116
- /**
117
- * This method retrieves a paginated list of orders. It sends a request to the
118
- * [List Orders](https://docs.acmekit.com/api/admin#orders_getorders) API route.
119
- *
120
- * @param queryParams - Filters and pagination configurations.
121
- * @param headers - Headers to pass in the request.
122
- * @returns The paginated list of orders.
123
- *
124
- * @example
125
- * To retrieve the list of orders:
126
- *
127
- * ```ts
128
- * sdk.admin.order.list()
129
- * .then(({ orders, count, limit, offset }) => {
130
- * console.log(orders)
131
- * })
132
- * ```
133
- *
134
- * To configure the pagination, pass the `limit` and `offset` query parameters.
135
- *
136
- * For example, to retrieve only 10 items and skip 10 items:
137
- *
138
- * ```ts
139
- * sdk.admin.order.list({
140
- * limit: 10,
141
- * offset: 10
142
- * })
143
- * .then(({ orders, count, limit, offset }) => {
144
- * console.log(orders)
145
- * })
146
- * ```
147
- *
148
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
149
- * in each order:
150
- *
151
- * ```ts
152
- * sdk.admin.order.list({
153
- * fields: "id,*items"
154
- * })
155
- * .then(({ orders, count, limit, offset }) => {
156
- * console.log(orders)
157
- * })
158
- * ```
159
- *
160
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
161
- */
162
- list(queryParams, headers) {
163
- return __awaiter(this, void 0, void 0, function* () {
164
- return yield this.client.fetch(`/admin/orders`, {
165
- query: queryParams,
166
- headers,
167
- });
168
- });
169
- }
170
- /**
171
- * This method archives an order. It sends a request to the
172
- * [Archive Order](https://docs.acmekit.com/api/admin#orders_postordersidarchive)
173
- * API route.
174
- *
175
- * @param id - The order's ID.
176
- * @param queryParams - Configure the fields to retrieve in the order.
177
- * @param headers - Headers to pass in the request
178
- * @returns The order's details.
179
- *
180
- * @example
181
- * sdk.admin.order.archive("order_123")
182
- * .then(({ order }) => {
183
- * console.log(order)
184
- * })
185
- */
186
- archive(id, queryParams, headers) {
187
- return __awaiter(this, void 0, void 0, function* () {
188
- return yield this.client.fetch(`/admin/orders/${id}/archive`, {
189
- method: "POST",
190
- query: queryParams,
191
- headers,
192
- });
193
- });
194
- }
195
- /**
196
- * This method cancels an order. It sends a request to the
197
- * [Cancel Order](https://docs.acmekit.com/api/admin#orders_postordersidcancel)
198
- * API route.
199
- *
200
- * @param id - The order's ID.
201
- * @param headers - Headers to pass in the request.
202
- * @returns The order's details.
203
- *
204
- * @example
205
- * sdk.admin.order.cancel("order_123")
206
- * .then(({ order }) => {
207
- * console.log(order)
208
- * })
209
- */
210
- cancel(id, headers) {
211
- return __awaiter(this, void 0, void 0, function* () {
212
- return yield this.client.fetch(`/admin/orders/${id}/cancel`, {
213
- method: "POST",
214
- headers,
215
- });
216
- });
217
- }
218
- /**
219
- * This method completes an order. It sends a request to the
220
- * [Complete Order](https://docs.acmekit.com/api/admin#orders_postordersidcomplete)
221
- * API route.
222
- *
223
- * @param id - The order's ID.
224
- * @param headers - Headers to pass in the request.
225
- * @returns The order's details.
226
- *
227
- * @example
228
- * sdk.admin.order.complete("order_123")
229
- * .then(({ order }) => {
230
- * console.log(order)
231
- * })
232
- */
233
- complete(id, body, queryParams, headers) {
234
- return __awaiter(this, void 0, void 0, function* () {
235
- return yield this.client.fetch(`/admin/orders/${id}/complete`, {
236
- method: "POST",
237
- body,
238
- query: queryParams,
239
- headers,
240
- });
241
- });
242
- }
243
- /**
244
- * This method requests an order transfer. It sends a request to the
245
- * [Request Order Transfer](https://docs.acmekit.com/api/admin#orders_postordersidrequesttransfer)
246
- * API route.
247
- *
248
- * @param id - The order's ID.
249
- * @param headers - Headers to pass in the request.
250
- * @param body - The transfer's details - the id of the next owner.
251
- * @returns The order's details.
252
- *
253
- * @example
254
- * sdk.admin.order.requestTransfer("order_123", {
255
- * customer_id: "cus_123",
256
- * internal_note: "Internal note",
257
- * })
258
- * .then(({ order }) => {
259
- * console.log(order)
260
- * })
261
- */
262
- requestTransfer(id, body, headers) {
263
- return __awaiter(this, void 0, void 0, function* () {
264
- return yield this.client.fetch(`/admin/orders/${id}/transfer`, {
265
- method: "POST",
266
- headers,
267
- body,
268
- });
269
- });
270
- }
271
- /**
272
- * This method cancels an order transfer request. It sends a request to the
273
- * [Cancel Order Transfer Request](https://docs.acmekit.com/api/admin#orders_postordersidcanceltransferrequest)
274
- * API route.
275
- *
276
- * @param id - The order's ID.
277
- * @param headers - Headers to pass in the request.
278
- * @returns The order's details.
279
- *
280
- * @example
281
- * sdk.admin.order.cancelTransfer("order_123")
282
- * .then(({ order }) => {
283
- * console.log(order)
284
- * })
285
- */
286
- cancelTransfer(id, headers) {
287
- return __awaiter(this, void 0, void 0, function* () {
288
- return yield this.client.fetch(`/admin/orders/${id}/transfer/cancel`, {
289
- method: "POST",
290
- headers,
291
- });
292
- });
293
- }
294
- /**
295
- * This method creates a fulfillment for an order. It sends a request to the
296
- * [Create Fulfillment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillments)
297
- * API route.
298
- *
299
- * @param id - The order's ID.
300
- * @param body - The fulfillment's details.
301
- * @param query - Configure the fields to retrieve in the order.
302
- * @param headers - Headers to pass in the request
303
- * @returns The order's details.
304
- *
305
- * @example
306
- * sdk.admin.order.createFulfillment("order_123", {
307
- * items: [
308
- * {
309
- * id: "orli_123",
310
- * quantity: 1
311
- * }
312
- * ]
313
- * })
314
- * .then(({ order }) => {
315
- * console.log(order)
316
- * })
317
- */
318
- createFulfillment(id, body, query, headers) {
319
- return __awaiter(this, void 0, void 0, function* () {
320
- return yield this.client.fetch(`/admin/orders/${id}/fulfillments`, {
321
- method: "POST",
322
- headers,
323
- body,
324
- query,
325
- });
326
- });
327
- }
328
- /**
329
- * This method cancels an order's fulfillment. It sends a request to the
330
- * [Cancel Fulfillment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idcancel)
331
- * API route.
332
- *
333
- * @param id - The order's ID.
334
- * @param fulfillmentId - The ID of the fulfillment to cancel.
335
- * @param body - The cancelation's details.
336
- * @param headers - Headers to pass in the request
337
- * @returns The order's details.
338
- *
339
- * @example
340
- * sdk.admin.order.cancelFulfillment(
341
- * "order_123",
342
- * "ful_123",
343
- * {
344
- * no_notification: false
345
- * }
346
- * )
347
- * .then(({ order }) => {
348
- * console.log(order)
349
- * })
350
- */
351
- cancelFulfillment(id, fulfillmentId, body, headers) {
352
- return __awaiter(this, void 0, void 0, function* () {
353
- return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/cancel`, {
354
- method: "POST",
355
- headers,
356
- body,
357
- });
358
- });
359
- }
360
- /**
361
- * This method creates a shipment for an order's fulfillment. It sends a request to the
362
- * [Create Shipment](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idshipments)
363
- * API route.
364
- *
365
- * @param id - The order's ID.
366
- * @param fulfillmentId - The ID of the fulfillment.
367
- * @param body - The shipment's details.
368
- * @param query - Configure the fields to retrieve in the order.
369
- * @param headers - Headers to pass in the request
370
- * @returns The order's details.
371
- *
372
- * @example
373
- * sdk.admin.order.createShipment(
374
- * "order_123",
375
- * "ful_123",
376
- * {
377
- * items: [
378
- * {
379
- * id: "fulit_123",
380
- * quantity: 1
381
- * }
382
- * ]
383
- * }
384
- * )
385
- * .then(({ order }) => {
386
- * console.log(order)
387
- * })
388
- */
389
- createShipment(id, fulfillmentId, body, query, headers) {
390
- return __awaiter(this, void 0, void 0, function* () {
391
- return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/shipments`, {
392
- method: "POST",
393
- headers,
394
- body,
395
- query,
396
- });
397
- });
398
- }
399
- /**
400
- * This method marks an order's fulfillment as delivered. It sends a request to the
401
- * [Mark Delivered ](https://docs.acmekit.com/api/admin#orders_postordersidfulfillmentsfulfillment_idmarkasdelivered)
402
- * API route.
403
- *
404
- * @param id - The order's ID.
405
- * @param fulfillmentId - The fulfillment's ID.
406
- * @param query - Configure the fields to retrieve in the order.
407
- * @param headers - Headers to pass in the request
408
- * @returns The order's details.
409
- *
410
- * @example
411
- * sdk.admin.order.markAsDelivered(
412
- * "order_123",
413
- * "ful_123",
414
- * )
415
- * .then(({ order }) => {
416
- * console.log(order)
417
- * })
418
- */
419
- markAsDelivered(id, fulfillmentId, query, headers) {
420
- return __awaiter(this, void 0, void 0, function* () {
421
- return yield this.client.fetch(`/admin/orders/${id}/fulfillments/${fulfillmentId}/mark-as-delivered`, {
422
- method: "POST",
423
- headers,
424
- query,
425
- });
426
- });
427
- }
428
- /**
429
- * This method retrieves a list of shipping options for an order based on the order's shipping address.
430
- *
431
- * This method sends a request to the [List Shipping Options](https://docs.acmekit.com/api/admin#orders_getordersidshipping-options)
432
- * API route.
433
- *
434
- * @param id - The order's ID.
435
- * @param queryParams - Configure the fields to retrieve in each shipping option.
436
- * @param headers - Headers to pass in the request
437
- * @returns The list of shipping options.
438
- *
439
- * @example
440
- * sdk.admin.order.listShippingOptions("order_123")
441
- * .then(({ shipping_options }) => {
442
- * console.log(shipping_options)
443
- * })
444
- */
445
- listShippingOptions(id, queryParams, headers) {
446
- return __awaiter(this, void 0, void 0, function* () {
447
- return yield this.client.fetch(`/admin/orders/${id}/shipping-options`, {
448
- query: queryParams,
449
- headers,
450
- });
451
- });
452
- }
453
- /**
454
- * This method retrieves a list of changes made on an order, including returns, exchanges, etc...
455
- *
456
- * This method sends a request to the [List Changes](https://docs.acmekit.com/api/admin#orders_getordersidchanges)
457
- * API route.
458
- *
459
- * @param id - The order's ID.
460
- * @param queryParams - Configure the fields to retrieve in each order change.
461
- * @param headers - Headers to pass in the request
462
- * @returns The list of order changes.
463
- *
464
- * @example
465
- * sdk.admin.order.listChanges("order_123")
466
- * .then(({ order_changes }) => {
467
- * console.log(order_changes)
468
- * })
469
- */
470
- listChanges(id, queryParams, headers) {
471
- return __awaiter(this, void 0, void 0, function* () {
472
- return yield this.client.fetch(`/admin/orders/${id}/changes`, {
473
- query: queryParams,
474
- headers,
475
- });
476
- });
477
- }
478
- /**
479
- * This method retrieves the order's line items. It sends a request to the
480
- * [List Line Items](https://docs.acmekit.com/api/admin#orders_getordersidlineitems)
481
- * API routes.
482
- *
483
- * @param id - The order's ID.
484
- * @param queryParams - Configure the fields to retrieve in each line item.
485
- * @param headers - Headers to pass in the request
486
- * @returns The list of line items.
487
- *
488
- * @example
489
- * sdk.admin.order.listLineItems("order_123")
490
- * .then(({ order_items }) => {
491
- * console.log(order_items)
492
- * })
493
- */
494
- listLineItems(id, queryParams, headers) {
495
- return __awaiter(this, void 0, void 0, function* () {
496
- return yield this.client.fetch(`/admin/orders/${id}/line-items`, {
497
- query: queryParams,
498
- headers,
499
- });
500
- });
501
- }
502
- /**
503
- * This method creates a credit line for an order. It sends a request to the
504
- * [Create Credit Line](https://docs.acmekit.com/api/admin#orders_postordersidcredit-lines) API route.
505
- *
506
- * @param orderId - The order's ID.
507
- * @param body - The credit line's details.
508
- * @param query - Configure the fields to retrieve in the order.
509
- * @param headers - Headers to pass in the request
510
- * @returns The order's details.
511
- *
512
- * @example
513
- * sdk.admin.order.createCreditLine(
514
- * "order_123",
515
- * {
516
- * amount: 100,
517
- * reference: "order",
518
- * reference_id: "order_123",
519
- * }
520
- * )
521
- * .then(({ order }) => {
522
- * console.log(order)
523
- * })
524
- */
525
- createCreditLine(orderId, body, query, headers) {
526
- return __awaiter(this, void 0, void 0, function* () {
527
- return yield this.client.fetch(`/admin/orders/${orderId}/credit-lines`, {
528
- method: "POST",
529
- headers,
530
- body,
531
- query,
532
- });
533
- });
534
- }
535
- /**
536
- * This method updates an order change. It sends a request to the
537
- * [Update Order Change](https://docs.acmekit.com/api/admin#order-changes_postorder-changesid)
538
- * API route.
539
- *
540
- * @since 2.12.0
541
- *
542
- * @param id - The order change's ID.
543
- * @param body - The update details.
544
- * @param query - Configure the fields to retrieve in the order change.
545
- * @param headers - Headers to pass in the request
546
- * @returns The order change's details.
547
- *
548
- * @example
549
- * sdk.admin.order.updateOrderChange(
550
- * "ordch_123",
551
- * {
552
- * carry_over_promotions: true
553
- * }
554
- * )
555
- * .then(({ order_change }) => {
556
- * console.log(order_change)
557
- * })
558
- */
559
- updateOrderChange(id, body, query, headers) {
560
- return __awaiter(this, void 0, void 0, function* () {
561
- return yield this.client.fetch(`/admin/order-changes/${id}`, {
562
- method: "POST",
563
- headers,
564
- body,
565
- query,
566
- });
567
- });
568
- }
569
- /**
570
- * This method starts an order export process to retrieve a CSV of exported orders. It sends
571
- * a request to the [Export Orders](https://docs.acmekit.com/api/admin#orders_postordersexport) API route.
572
- *
573
- * You'll receive in the response the transaction ID of the workflow generating the CSV file.
574
- * To check the status of the execution, send a `GET` request to
575
- * `/admin/workflows-executions/export-orders/:transaction-id`.
576
- *
577
- * Once the execution finishes successfully, a notification is created for the export.
578
- * You can retrieve the notifications using the `/admin/notification` API route to
579
- * retrieve the file's download URL.
580
- *
581
- * @since 2.12.3
582
- *
583
- * @param query - Filters to specify which orders to export.
584
- * @param headers - Headers to pass in the request.
585
- * @returns The export's details.
586
- *
587
- * @example
588
- * sdk.admin.order.export()
589
- * .then(({ transaction_id }) => {
590
- * console.log(transaction_id)
591
- * })
592
- */
593
- export(query, headers) {
594
- return __awaiter(this, void 0, void 0, function* () {
595
- return yield this.client.fetch(`/admin/orders/export`, {
596
- method: "POST",
597
- headers,
598
- query,
599
- });
600
- });
601
- }
602
- }
603
- //# sourceMappingURL=order.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"order.js","sourceRoot":"","sources":["../../../src/admin/order.ts"],"names":[],"mappings":";;;;;;;;;AAYA,MAAM,OAAO,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CACV,EAAU,EACV,IAAgC,EAChC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,eAAe,CACnB,EAAU,EACV,KAAmC,EACnC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CACX,EAAU,EACV,WAA0B,EAC1B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,UAAU,EAC7B;gBACE,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,SAAS,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACZ,EAAU,EACV,IAA8B,EAC9B,WAA0B,EAC1B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,WAAW,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,eAAe,CACnB,EAAU,EACV,IAAyC,EACzC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,WAAW,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,EAAU,EAAE,OAAuB;;YACtD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,kBAAkB,EACrC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAA2C,EAC3C,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,eAAe,EAClC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,iBAAiB,CACrB,EAAU,EACV,aAAqB,EACrB,IAA2C,EAC3C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,SAAS,EAC1D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,cAAc,CAClB,EAAU,EACV,aAAqB,EACrB,IAAwC,EACxC,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,YAAY,EAC7D;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CACnB,EAAU,EACV,aAAqB,EACrB,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,iBAAiB,aAAa,oBAAoB,EACrE;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CACvB,EAAU,EACV,WAAoE,EACpE,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE3B,iBAAiB,EAAE,mBAAmB,EAAE;gBACzC,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CACf,EAAU,EACV,WAA6D,EAC7D,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE,UAAU,EAAE;gBAC/B,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACjB,EAAU,EACV,WAA2D,EAC3D,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,aAAa,EAChC;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,OAAe,EACf,IAAgD,EAChD,KAAoB,EACpB,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,OAAO,eAAe,EACvC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CACrB,EAAU,EACV,IAAsC,EACtC,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,KAAmC,EAAE,OAAuB;;YACvE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
@@ -1,72 +0,0 @@
1
- import { HttpTypes, SelectParams } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class PaymentCollection {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method creates a payment collection. It sends a request to the
15
- * [Create Payment Collection](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollections)
16
- * API route.
17
- *
18
- * @param body - The details of the payment collection to create.
19
- * @param query - Configure the fields to retrieve in the payment collection.
20
- * @param headers - Headers to pass in the request
21
- * @returns The payment collection's details.
22
- *
23
- * @example
24
- * sdk.admin.paymentCollection.create({
25
- * order_id: "order_123"
26
- * })
27
- * .then(({ payment_collection }) => {
28
- * console.log(payment_collection)
29
- * })
30
- */
31
- create(body: HttpTypes.AdminCreatePaymentCollection, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
32
- /**
33
- * This method deletes a payment collection. It sends a request to the
34
- * [Delete Payment Collection](https://docs.acmekit.com/api/admin#payment-collections_deletepaymentcollectionsid)
35
- * API route.
36
- *
37
- * @param id - The payment collection's ID.
38
- * @param headers - Headers to pass in the request
39
- * @returns The deletion's details.
40
- *
41
- * @example
42
- * sdk.admin.paymentCollection.delete("paycol_123")
43
- * .then(({ deleted }) => {
44
- * console.log(deleted)
45
- * })
46
- */
47
- delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminDeletePaymentCollectionResponse>;
48
- /**
49
- * This method marks a payment collection as paid. It sends a request to the
50
- * [Mark as Paid](https://docs.acmekit.com/api/admin#payment-collections_postpaymentcollectionsidmarkaspaid)
51
- * API route.
52
- *
53
- * The API route creates and authorizes a payment session, then capture its payment,
54
- * using the manual payment provider.
55
- *
56
- * @param id - The payment collection to mark as paid.
57
- * @param body - The details to mark the payment collection as paid.
58
- * @param query - Configure the fields to retrieve in the payment collection.
59
- * @param headers - Headers to pass in the request.
60
- * @returns The payment collection's details.
61
- *
62
- * @example
63
- * sdk.admin.paymentCollection.markAsPaid("paycol_123", {
64
- * order_id: "order_123"
65
- * })
66
- * .then(({ payment_collection }) => {
67
- * console.log(payment_collection)
68
- * })
69
- */
70
- markAsPaid(id: string, body: HttpTypes.AdminMarkPaymentCollectionAsPaid, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPaymentCollectionResponse>;
71
- }
72
- //# sourceMappingURL=payment-collection.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"payment-collection.d.ts","sourceRoot":"","sources":["../../../src/admin/payment-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,4BAA4B,EAC5C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,gCAAgC,EAChD,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}