@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,749 +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 Return {
11
- /**
12
- * @ignore
13
- */
14
- constructor(client) {
15
- this.client = client;
16
- }
17
- /**
18
- * This method retrieves a list of returns. It sends a request to the
19
- * [List Returns](https://docs.acmekit.com/api/admin#returns_getreturns)
20
- * API route.
21
- *
22
- * @param query - Filters and pagination configurations.
23
- * @param headers - Headers to pass in the request.
24
- * @returns The list of returns.
25
- *
26
- * @example
27
- * To retrieve the list of returns:
28
- *
29
- * ```ts
30
- * sdk.admin.return.list()
31
- * .then(({ returns, count, limit, offset }) => {
32
- * console.log(returns)
33
- * })
34
- * ```
35
- *
36
- * To configure the pagination, pass the `limit` and `offset` query parameters.
37
- *
38
- * For example, to retrieve only 10 items and skip 10 items:
39
- *
40
- * ```ts
41
- * sdk.admin.return.list({
42
- * limit: 10,
43
- * offset: 10
44
- * })
45
- * .then(({ returns, count, limit, offset }) => {
46
- * console.log(returns)
47
- * })
48
- * ```
49
- *
50
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
51
- * in each return:
52
- *
53
- * ```ts
54
- * sdk.admin.return.list({
55
- * fields: "id,*items"
56
- * })
57
- * .then(({ returns, count, limit, offset }) => {
58
- * console.log(returns)
59
- * })
60
- * ```
61
- *
62
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
63
- */
64
- list(query, headers) {
65
- return __awaiter(this, void 0, void 0, function* () {
66
- return yield this.client.fetch(`/admin/returns`, {
67
- query,
68
- headers,
69
- });
70
- });
71
- }
72
- /**
73
- * This method retrieves a return by ID. It sends a request to the
74
- * [Get Return](https://docs.acmekit.com/api/admin#returns_getreturnsid)
75
- * API route.
76
- *
77
- * @param id - The ID of the return to retrieve.
78
- * @param query - Configure the fields and relations to retrieve in the return.
79
- * @param headers - Headers to pass in the request.
80
- * @returns The return's details.
81
- *
82
- * @example
83
- * To retrieve a return by its ID:
84
- *
85
- * ```ts
86
- * sdk.admin.return.retrieve("return_123")
87
- * .then(({ return }) => {
88
- * console.log(return)
89
- * })
90
- * ```
91
- *
92
- * To specify the fields and relations to retrieve:
93
- *
94
- * ```ts
95
- * sdk.admin.return.retrieve("return_123", {
96
- * fields: "id,*items"
97
- * })
98
- * .then(({ return }) => {
99
- * console.log(return)
100
- * })
101
- * ```
102
- *
103
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
104
- */
105
- retrieve(id, query, headers) {
106
- return __awaiter(this, void 0, void 0, function* () {
107
- return yield this.client.fetch(`/admin/returns/${id}`, {
108
- query,
109
- headers,
110
- });
111
- });
112
- }
113
- /**
114
- * This method initiates a return request by creating a return. It sends a request to the
115
- * [Create Return](https://docs.acmekit.com/api/admin#returns_postreturns)
116
- * API route.
117
- *
118
- * @param body - The details of the return to create.
119
- * @param query - Configure the fields and relations to retrieve in the return.
120
- * @param headers - Headers to pass in the request.
121
- * @returns The return's details.
122
- *
123
- * @example
124
- * sdk.admin.return.initiateRequest({
125
- * order_id: "order_123",
126
- * })
127
- * .then(({ return }) => {
128
- * console.log(return)
129
- * })
130
- */
131
- initiateRequest(body, query, headers) {
132
- return __awaiter(this, void 0, void 0, function* () {
133
- return yield this.client.fetch(`/admin/returns`, {
134
- method: "POST",
135
- headers,
136
- body,
137
- query,
138
- });
139
- });
140
- }
141
- /**
142
- * This method cancels a return. It sends a request to the
143
- * [Cancel Return](https://docs.acmekit.com/api/admin#returns_postreturnsidcancel)
144
- * API route.
145
- *
146
- * @param id - The ID of the return to cancel.
147
- * @param query - Configure the fields and relations to retrieve in the return.
148
- * @param headers - Headers to pass in the request.
149
- * @returns The return's details.
150
- *
151
- * @example
152
- * sdk.admin.return.cancel("return_123")
153
- * .then(({ return }) => {
154
- * console.log(return)
155
- * })
156
- */
157
- cancel(id, query, headers) {
158
- return __awaiter(this, void 0, void 0, function* () {
159
- return yield this.client.fetch(`/admin/returns/${id}/cancel`, {
160
- method: "POST",
161
- headers,
162
- query,
163
- });
164
- });
165
- }
166
- /**
167
- * This method cancels a return request. It sends a request to the
168
- * [Cancel Return Request](https://docs.acmekit.com/api/admin#returns_deletereturnsidrequest)
169
- * API route.
170
- *
171
- * @param id - The ID of the return to cancel.
172
- * @param query - Configure the fields and relations to retrieve in the return.
173
- * @param headers - Headers to pass in the request.
174
- * @returns The return's details.
175
- *
176
- * @example
177
- * sdk.admin.return.cancelRequest("return_123")
178
- * .then(({ return }) => {
179
- * console.log(return)
180
- * })
181
- */
182
- cancelRequest(id, query, headers) {
183
- return __awaiter(this, void 0, void 0, function* () {
184
- return yield this.client.fetch(`/admin/returns/${id}/request`, {
185
- method: "DELETE",
186
- headers,
187
- query,
188
- });
189
- });
190
- }
191
- /**
192
- * This method adds an item to a return request. It sends a request to the
193
- * [Add Return Item](https://docs.acmekit.com/api/admin#returns_postreturnsidrequestitems)
194
- * API route.
195
- *
196
- * @param id - The ID of the return to add the item to.
197
- * @param body - The details of the item to add to the return.
198
- * @param query - Configure the fields and relations to retrieve in the return.
199
- * @param headers - Headers to pass in the request.
200
- * @returns The return's details.
201
- *
202
- * @example
203
- * sdk.admin.return.addReturnItem("return_123", {
204
- * id: "orlitem_123",
205
- * quantity: 1,
206
- * })
207
- * .then(({ return }) => {
208
- * console.log(return)
209
- * })
210
- */
211
- addReturnItem(id, body, query, headers) {
212
- return __awaiter(this, void 0, void 0, function* () {
213
- return yield this.client.fetch(`/admin/returns/${id}/request-items`, {
214
- method: "POST",
215
- headers,
216
- body,
217
- query,
218
- });
219
- });
220
- }
221
- /**
222
- * This method updates an item in a return request by the ID of the item's `RETURN_ITEM` action.
223
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
224
- * using its `action` property, and use the value of the `id` property. For example,
225
- * `item.actions.find((action) => action.action === "RETURN_ITEM")?.id` is the ID of an item's `RETURN_ITEM` action.
226
- *
227
- * This method sends a request to the
228
- * [Update Requested Return Item](https://docs.acmekit.com/api/admin#returns_postreturnsidrequestitemsaction_id)
229
- * API route.
230
- *
231
- * @param id - The ID of the return to update the item in.
232
- * @param actionId - The ID of the item's `RETURN_ITEM` action.
233
- * @param body - The details of the item to update.
234
- * @param query - Configure the fields and relations to retrieve in the return.
235
- * @param headers - Headers to pass in the request.
236
- * @returns The return's details.
237
- *
238
- * @example
239
- * sdk.admin.return.updateReturnItem("return_123", "orchach_123", {
240
- * quantity: 2,
241
- * })
242
- * .then(({ return }) => {
243
- * console.log(return)
244
- * })
245
- */
246
- updateReturnItem(id, actionId, body, query, headers) {
247
- return __awaiter(this, void 0, void 0, function* () {
248
- return yield this.client.fetch(`/admin/returns/${id}/request-items/${actionId}`, {
249
- method: "POST",
250
- headers,
251
- body,
252
- query,
253
- });
254
- });
255
- }
256
- /**
257
- * This method removes an item from a return request by the ID of the item's `RETURN_ITEM` action.
258
- *
259
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
260
- * using its `action` property, and use the value of the `id` property. For example,
261
- * `item.actions.find((action) => action.action === "RETURN_ITEM")?.id` is the ID of an item's `RETURN_ITEM` action.
262
- *
263
- * This method sends a request to the
264
- * [Remove Item from Return](https://docs.acmekit.com/api/admin#returns_deletereturnsidrequestitemsaction_id)
265
- * API route.
266
- *
267
- * @param id - The ID of the return to remove the item from.
268
- * @param actionId - The ID of the item's `RETURN_ITEM` action.
269
- * @param query - Configure the fields and relations to retrieve in the return.
270
- * @param headers - Headers to pass in the request.
271
- * @returns The return's details.
272
- *
273
- * @example
274
- * sdk.admin.return.removeReturnItem("return_123", "orchach_123")
275
- * .then(({ return }) => {
276
- * console.log(return)
277
- * })
278
- */
279
- removeReturnItem(id, actionId, query, headers) {
280
- return __awaiter(this, void 0, void 0, function* () {
281
- return yield this.client.fetch(`/admin/returns/${id}/request-items/${actionId}`, {
282
- method: "DELETE",
283
- headers,
284
- query,
285
- });
286
- });
287
- }
288
- /**
289
- * This method adds a shipping method to a return request. It sends a request to the
290
- * [Add Shipping Method to Return](https://docs.acmekit.com/api/admin#returns_postreturnsidshippingmethod)
291
- * API route.
292
- *
293
- * @param id - The ID of the return to add the shipping method to.
294
- * @param body - The details of the shipping method to add to the return.
295
- * @param query - Configure the fields and relations to retrieve in the return.
296
- * @param headers - Headers to pass in the request.
297
- * @returns The return's details.
298
- *
299
- * @example
300
- * sdk.admin.return.addReturnShipping("return_123", {
301
- * shipping_option_id: "so_123",
302
- * })
303
- * .then(({ return }) => {
304
- * console.log(return)
305
- * })
306
- */
307
- addReturnShipping(id, body, query, headers) {
308
- return __awaiter(this, void 0, void 0, function* () {
309
- return yield this.client.fetch(`/admin/returns/${id}/shipping-method`, {
310
- method: "POST",
311
- headers,
312
- body,
313
- query,
314
- });
315
- });
316
- }
317
- /**
318
- * This method updates a shipping method in a return request by the ID of the shipping method's `SHIPPING_ADD` action.
319
- *
320
- * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name
321
- * using its `action` property, and use the value of the `id` property.
322
- *
323
- * For example, `shipping_method.actions.find((action) => action.action === "SHIPPING_ADD")?.id` is
324
- * the ID of a shipping method's `SHIPPING_ADD` action.
325
- *
326
- * This method sends a request to the
327
- * [Update Shipping Method in Return](https://docs.acmekit.com/api/admin#returns_postreturnsidshippingmethodaction_id)
328
- * API route.
329
- *
330
- * @param id - The ID of the return to update the shipping method in.
331
- * @param actionId - The ID of the shipping method's `SHIPPING_ADD` action.
332
- * @param body - The details of the shipping method to update.
333
- * @param query - Configure the fields and relations to retrieve in the return.
334
- * @param headers - Headers to pass in the request.
335
- * @returns The return's details.
336
- *
337
- * @example
338
- * sdk.admin.return.updateReturnShipping("return_123", "orchach_123", {
339
- * custom_amount: 100,
340
- * })
341
- * .then(({ return }) => {
342
- * console.log(return)
343
- * })
344
- */
345
- updateReturnShipping(id, actionId, body, query, headers) {
346
- return __awaiter(this, void 0, void 0, function* () {
347
- return yield this.client.fetch(`/admin/returns/${id}/shipping-method/${actionId}`, {
348
- method: "POST",
349
- headers,
350
- body,
351
- query,
352
- });
353
- });
354
- }
355
- /**
356
- * This method removes a shipping method from a return request by the ID of the shipping method's `SHIPPING_ADD` action.
357
- *
358
- * Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name
359
- * using its `action` property, and use the value of the `id` property.
360
- *
361
- * For example, `shipping_method.actions.find((action) => action.action === "SHIPPING_ADD")?.id` is
362
- * the ID of a shipping method's `SHIPPING_ADD` action.
363
- *
364
- * This method sends a request to the
365
- * [Remove Shipping Method from Return](https://docs.acmekit.com/api/admin#returns_deletereturnsidshippingmethodaction_id)
366
- * API route.
367
- *
368
- * @param id - The ID of the return to remove the shipping method from.
369
- * @param actionId - The ID of the shipping method's `SHIPPING_ADD` action.
370
- * @param query - Configure the fields and relations to retrieve in the return.
371
- * @param headers - Headers to pass in the request.
372
- * @returns The return's details.
373
- *
374
- * @example
375
- * sdk.admin.return.deleteReturnShipping("return_123", "orchach_123")
376
- * .then(({ return }) => {
377
- * console.log(return)
378
- * })
379
- */
380
- deleteReturnShipping(id, actionId, query, headers) {
381
- return __awaiter(this, void 0, void 0, function* () {
382
- return yield this.client.fetch(`/admin/returns/${id}/shipping-method/${actionId}`, {
383
- method: "DELETE",
384
- headers,
385
- query,
386
- });
387
- });
388
- }
389
- /**
390
- * This method updates a return request. It sends a request to the
391
- * [Update Return](https://docs.acmekit.com/api/admin#returns_postreturnsid)
392
- * API route.
393
- *
394
- * @param id - The ID of the return to update.
395
- * @param body - The details of the return to update.
396
- * @param query - Configure the fields and relations to retrieve in the return.
397
- * @param headers - Headers to pass in the request.
398
- * @returns The return's details.
399
- *
400
- * @example
401
- * sdk.admin.return.updateRequest("return_123", {
402
- * location_id: "sloc_123",
403
- * })
404
- * .then(({ return }) => {
405
- * console.log(return)
406
- * })
407
- */
408
- updateRequest(id, body, query, headers) {
409
- return __awaiter(this, void 0, void 0, function* () {
410
- return yield this.client.fetch(`/admin/returns/${id}`, {
411
- method: "POST",
412
- headers,
413
- body,
414
- query,
415
- });
416
- });
417
- }
418
- /**
419
- * This method confirms a return request. The return's changes are applied on the inventory quantity of the return
420
- * items and the order only after the return has been confirmed as received using the
421
- * [Confirm Return Receival](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveconfirm)
422
- * API route.
423
- *
424
- * This method sends a request to the
425
- * [Confirm Return Request](https://docs.acmekit.com/api/admin#returns_postreturnsidrequest)
426
- * API route.
427
- *
428
- * @param id - The ID of the return to confirm.
429
- * @param body - The details of the return to confirm.
430
- * @param query - Configure the fields and relations to retrieve in the return.
431
- * @param headers - Headers to pass in the request.
432
- * @returns The return's details.
433
- *
434
- * @example
435
- * sdk.admin.return.confirmRequest("return_123", {
436
- * no_notification: true,
437
- * })
438
- * .then(({ return }) => {
439
- * console.log(return)
440
- * })
441
- */
442
- confirmRequest(id, body, query, headers) {
443
- return __awaiter(this, void 0, void 0, function* () {
444
- return yield this.client.fetch(`/admin/returns/${id}/request`, {
445
- method: "POST",
446
- headers,
447
- body,
448
- query,
449
- });
450
- });
451
- }
452
- /**
453
- * This method starts the return receival process. It sends a request to the
454
- * [Start Return Receival](https://docs.acmekit.com/api/admin#returns_postreturnsidreceive)
455
- * API route.
456
- *
457
- * @param id - The ID of the return to start the receival process.
458
- * @param body - The details of the return to start the receival process.
459
- * @param query - Configure the fields and relations to retrieve in the return.
460
- * @param headers - Headers to pass in the request.
461
- * @returns The return's details.
462
- *
463
- * @example
464
- * sdk.admin.return.initiateReceive("return_123", {
465
- * internal_note: "Return received by the customer",
466
- * })
467
- * .then(({ return }) => {
468
- * console.log(return)
469
- * })
470
- */
471
- initiateReceive(id, body, query, headers) {
472
- return __awaiter(this, void 0, void 0, function* () {
473
- return yield this.client.fetch(`/admin/returns/${id}/receive`, {
474
- method: "POST",
475
- headers,
476
- body,
477
- query,
478
- });
479
- });
480
- }
481
- /**
482
- * This method adds received items to a return. These items will have the action `RECEIVE_RETURN_ITEM`.
483
- *
484
- * The method sends a request to the
485
- * [Add Received Items](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitems)
486
- * API route.
487
- *
488
- * @param id - The ID of the return to add the received items to.
489
- * @param body - The details of the received items to add to the return.
490
- * @param query - Configure the fields and relations to retrieve in the return.
491
- * @param headers - Headers to pass in the request.
492
- * @returns The return's details.
493
- *
494
- * @example
495
- * sdk.admin.return.receiveItems("return_123", {
496
- * items: [
497
- * { id: "item_123", quantity: 1 },
498
- * ],
499
- * })
500
- * .then(({ return }) => {
501
- * console.log(return)
502
- * })
503
- */
504
- receiveItems(id, body, query, headers) {
505
- return __awaiter(this, void 0, void 0, function* () {
506
- return yield this.client.fetch(`/admin/returns/${id}/receive-items`, {
507
- method: "POST",
508
- headers,
509
- body,
510
- query,
511
- });
512
- });
513
- }
514
- /**
515
- * This method updates a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action.
516
- *
517
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
518
- * using its `action` property, and use the value of the `id` property.
519
- *
520
- * For example, `received_item.actions.find((action) => action.action === "RECEIVE_RETURN_ITEM")?.id` is
521
- * the ID of a received item's `RECEIVE_RETURN_ITEM` action.
522
- *
523
- * This method sends a request to the
524
- * [Update Received Item](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveitemsaction_id)
525
- * API route.
526
- *
527
- * @param id - The ID of the return to update the received item in.
528
- * @param actionId - The ID of the received item's `RECEIVE_RETURN_ITEM` action.
529
- * @param body - The details of the received item to update.
530
- * @param query - Configure the fields and relations to retrieve in the return.
531
- * @param headers - Headers to pass in the request.
532
- * @returns The return's details.
533
- *
534
- * @example
535
- * sdk.admin.return.updateReceiveItem("return_123", "orchach_123", {
536
- * quantity: 2,
537
- * })
538
- * .then(({ return }) => {
539
- * console.log(return)
540
- * })
541
- */
542
- updateReceiveItem(id, actionId, body, query, headers) {
543
- return __awaiter(this, void 0, void 0, function* () {
544
- return yield this.client.fetch(`/admin/returns/${id}/receive-items/${actionId}`, {
545
- method: "POST",
546
- headers,
547
- body,
548
- query,
549
- });
550
- });
551
- }
552
- /**
553
- * This method removes a received item from the return by the ID of the item's `RECEIVE_RETURN_ITEM` action.
554
- *
555
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
556
- * using its `action` property, and use the value of the `id` property.
557
- *
558
- * For example, `received_item.actions.find((action) => action.action === "RECEIVE_RETURN_ITEM")?.id` is
559
- * the ID of a received item's `RECEIVE_RETURN_ITEM` action.
560
- *
561
- * This method sends a request to the
562
- * [Remove Received Item](https://docs.acmekit.com/api/admin#returns_deletereturnsidreceiveitemsaction_id)
563
- * API route.
564
- *
565
- * @param id - The ID of the return to remove the received item from.
566
- * @param actionId - The ID of the received item's `RECEIVE_RETURN_ITEM` action.
567
- * @param query - Configure the fields and relations to retrieve in the return.
568
- * @param headers - Headers to pass in the request.
569
- * @returns The return's details.
570
- *
571
- * @example
572
- * sdk.admin.return.removeReceiveItem("return_123", "orchach_123")
573
- * .then(({ return }) => {
574
- * console.log(return)
575
- * })
576
- */
577
- removeReceiveItem(id, actionId, query, headers) {
578
- return __awaiter(this, void 0, void 0, function* () {
579
- return yield this.client.fetch(`/admin/returns/${id}/receive-items/${actionId}`, {
580
- method: "DELETE",
581
- headers,
582
- query,
583
- });
584
- });
585
- }
586
- /**
587
- * This method adds damaged items to the return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`.
588
- *
589
- * A damaged item's quantity is not added back to the associated inventory item's quantity in the
590
- * stock location where the return is initiated from.
591
- *
592
- * The method sends a request to the
593
- * [Add Damaged Items](https://docs.acmekit.com/api/admin#returns_postreturnsiddismissitems)
594
- * API route.
595
- *
596
- * @param id - The ID of the return to add the damaged items to.
597
- * @param body - The details of the damaged items to add to the return.
598
- * @param query - Configure the fields and relations to retrieve in the return.
599
- * @param headers - Headers to pass in the request.
600
- * @returns The return's details.
601
- *
602
- * @example
603
- * sdk.admin.return.dismissItems("return_123", {
604
- * items: [
605
- * { id: "orli_123", quantity: 1 },
606
- * ],
607
- * })
608
- * .then(({ return }) => {
609
- * console.log(return)
610
- * })
611
- */
612
- dismissItems(id, body, query, headers) {
613
- return __awaiter(this, void 0, void 0, function* () {
614
- return yield this.client.fetch(`/admin/returns/${id}/dismiss-items`, {
615
- method: "POST",
616
- headers,
617
- body,
618
- query,
619
- });
620
- });
621
- }
622
- /**
623
- * This method updates a damaged item in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
624
- *
625
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
626
- * using its `action` property, and use the value of the `id` property.
627
- *
628
- * For example, `item.actions.find((action) => action.action === "RECEIVE_DAMAGED_RETURN_ITEM")?.id` is
629
- * the ID of a damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
630
- *
631
- * This method sends a request to the
632
- * [Update Damaged Item](https://docs.acmekit.com/api/admin#returns_postreturnsiddismissitemsaction_id)
633
- * API route.
634
- *
635
- * @param id - The ID of the return to update the damaged item in.
636
- * @param actionId - The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
637
- * @param body - The details of the damaged item to update.
638
- * @param query - Configure the fields and relations to retrieve in the return.
639
- * @param headers - Headers to pass in the request.
640
- * @returns The return's details.
641
- *
642
- * @example
643
- * sdk.admin.return.updateDismissItem("return_123", "orchach_123", {
644
- * quantity: 2,
645
- * })
646
- * .then(({ return }) => {
647
- * console.log(return)
648
- * })
649
- */
650
- updateDismissItem(id, actionId, body, query, headers) {
651
- return __awaiter(this, void 0, void 0, function* () {
652
- return yield this.client.fetch(`/admin/returns/${id}/dismiss-items/${actionId}`, {
653
- method: "POST",
654
- headers,
655
- body,
656
- query,
657
- });
658
- });
659
- }
660
- /**
661
- * This method removes a damaged item from the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
662
- *
663
- * Every item has an `actions` property, whose value is an array of actions. You can check the action's name
664
- * using its `action` property, and use the value of the `id` property.
665
- *
666
- * For example, `item.actions.find((action) => action.action === "RECEIVE_DAMAGED_RETURN_ITEM")?.id` is
667
- * the ID of a damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
668
- *
669
- * This method sends a request to the
670
- * [Remove Damaged Item](https://docs.acmekit.com/api/admin#returns_deletereturnsiddismissitemsaction_id)
671
- * API route.
672
- *
673
- * @param id - The ID of the return to remove the damaged item from.
674
- * @param actionId - The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action.
675
- * @param query - Configure the fields and relations to retrieve in the return.
676
- * @param headers - Headers to pass in the request.
677
- * @returns The return's details.
678
- *
679
- * @example
680
- * sdk.admin.return.removeDismissItem("return_123", "orchach_123")
681
- * .then(({ return }) => {
682
- * console.log(return)
683
- * })
684
- */
685
- removeDismissItem(id, actionId, query, headers) {
686
- return __awaiter(this, void 0, void 0, function* () {
687
- return yield this.client.fetch(`/admin/returns/${id}/dismiss-items/${actionId}`, {
688
- method: "DELETE",
689
- headers,
690
- query,
691
- });
692
- });
693
- }
694
- /**
695
- * This method confirms the return receival. It sends a request to the
696
- * [Confirm Return Receival](https://docs.acmekit.com/api/admin#returns_postreturnsidreceiveconfirm)
697
- * API route.
698
- *
699
- * @param id - The ID of the return to confirm the receival of.
700
- * @param body - The details of the receival confirmation.
701
- * @param query - Configure the fields and relations to retrieve in the return.
702
- * @param headers - Headers to pass in the request.
703
- * @returns The return's details.
704
- *
705
- * @example
706
- * sdk.admin.return.confirmReceive("return_123", {
707
- * no_notification: true,
708
- * })
709
- * .then(({ return }) => {
710
- * console.log(return)
711
- * })
712
- */
713
- confirmReceive(id, body, query, headers) {
714
- return __awaiter(this, void 0, void 0, function* () {
715
- return yield this.client.fetch(`/admin/returns/${id}/receive/confirm`, {
716
- method: "POST",
717
- headers,
718
- body,
719
- query,
720
- });
721
- });
722
- }
723
- /**
724
- * This method cancels a return receival. It sends a request to the
725
- * [Cancel Return Receival](https://docs.acmekit.com/api/admin#returns_deletereturnsidreceive)
726
- * API route.
727
- *
728
- * @param id - The ID of the return to cancel the receival of.
729
- * @param query - Configure the fields and relations to retrieve in the return.
730
- * @param headers - Headers to pass in the request.
731
- * @returns The return's details.
732
- *
733
- * @example
734
- * sdk.admin.return.cancelReceive("return_123")
735
- * .then(({ return }) => {
736
- * console.log(return)
737
- * })
738
- */
739
- cancelReceive(id, query, headers) {
740
- return __awaiter(this, void 0, void 0, function* () {
741
- return yield this.client.fetch(`/admin/returns/${id}/receive`, {
742
- method: "DELETE",
743
- headers,
744
- query,
745
- });
746
- });
747
- }
748
- }
749
- //# sourceMappingURL=return.js.map