@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,234 +0,0 @@
1
- import { HttpTypes } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class PriceList {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method retrieves a price list. It sends a request to the
15
- * [Get Price List](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelistsid)
16
- * API route.
17
- *
18
- * @param id - The price list's ID.
19
- * @param query - Configure the fields to retrieve in the price list.
20
- * @param headers - Headers to pass in the request
21
- * @returns The price list's details.
22
- *
23
- * @example
24
- * To retrieve a price list by its ID:
25
- *
26
- * ```ts
27
- * sdk.admin.priceList.retrieve("plist_123")
28
- * .then(({ price_list }) => {
29
- * console.log(price_list)
30
- * })
31
- * ```
32
- *
33
- * To specify the fields and relations to retrieve:
34
- *
35
- * ```ts
36
- * sdk.admin.priceList.retrieve("plist_123", {
37
- * fields: "id,*prices"
38
- * })
39
- * .then(({ price_list }) => {
40
- * console.log(price_list)
41
- * })
42
- * ```
43
- *
44
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/v2/api/store#select-fields-and-relations).
45
- */
46
- retrieve(id: string, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
47
- /**
48
- * This method retrieves a paginated list of price lists. It sends a request to the
49
- * [List Price Lists](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelists) API route.
50
- *
51
- * @param query - Filters and pagination configurations.
52
- * @param headers - Headers to pass in the request.
53
- * @returns The paginated list of price lists.
54
- *
55
- * @example
56
- * To retrieve the list of price lists:
57
- *
58
- * ```ts
59
- * sdk.admin.priceList.list()
60
- * .then(({ price_lists, count, limit, offset }) => {
61
- * console.log(price_lists)
62
- * })
63
- * ```
64
- *
65
- * To configure the pagination, pass the `limit` and `offset` query parameters.
66
- *
67
- * For example, to retrieve only 10 items and skip 10 items:
68
- *
69
- * ```ts
70
- * sdk.admin.priceList.list({
71
- * limit: 10,
72
- * offset: 10
73
- * })
74
- * .then(({ price_lists, count, limit, offset }) => {
75
- * console.log(price_lists)
76
- * })
77
- * ```
78
- *
79
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
80
- * in each price list:
81
- *
82
- * ```ts
83
- * sdk.admin.priceList.list({
84
- * fields: "id,*prices"
85
- * })
86
- * .then(({ price_lists, count, limit, offset }) => {
87
- * console.log(price_lists)
88
- * })
89
- * ```
90
- *
91
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/v2/api/store#select-fields-and-relations).
92
- */
93
- list(query?: HttpTypes.AdminPriceListListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListListResponse>;
94
- /**
95
- * This method creates a price list. It sends a request to the
96
- * [Create Price List](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelists)
97
- * API route.
98
- *
99
- * @param body - The details of the price list to create.
100
- * @param query - Configure the fields to retrieve in the price list.
101
- * @param headers - Headers to pass in the request
102
- * @returns The price list's details.
103
- *
104
- * @example
105
- * sdk.admin.priceList.create({
106
- * title: "My Price List",
107
- * status: "active",
108
- * type: "sale",
109
- * prices: [
110
- * {
111
- * variant_id: "variant_123",
112
- * amount: 10,
113
- * currency_code: "usd",
114
- * rules: {
115
- * region_id: "reg_123"
116
- * }
117
- * }
118
- * ]
119
- * })
120
- * .then(({ price_list }) => {
121
- * console.log(price_list)
122
- * })
123
- */
124
- create(body: HttpTypes.AdminCreatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
125
- /**
126
- * This method updates a price list. It sends a request to the
127
- * [Update Price List](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsid)
128
- * API route.
129
- *
130
- * @param id - The price list's ID.
131
- * @param body - The data to update in the price list.
132
- * @param query - Configure the fields to retrieve in the price list.
133
- * @param headers - Headers to pass in the request
134
- * @returns The price list's details.
135
- *
136
- * @example
137
- * sdk.admin.priceList.update("plist_123", {
138
- * title: "My Price List",
139
- * })
140
- * .then(({ price_list }) => {
141
- * console.log(price_list)
142
- * })
143
- */
144
- update(id: string, body: HttpTypes.AdminUpdatePriceList, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
145
- /**
146
- * This method deletes a price list. It sends a request to the
147
- * [Delete Price List](https://docs.acmekit.com/v2/api/admin#price-lists_deletepricelistsid)
148
- * API route.
149
- *
150
- * @param id - The price list's ID.
151
- * @param headers - Headers to pass in the request
152
- * @returns The deletion's details.
153
- *
154
- * @example
155
- * sdk.admin.priceList.delete("plist_123")
156
- * .then(({ deleted }) => {
157
- * console.log(deleted)
158
- * })
159
- */
160
- delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListDeleteResponse>;
161
- /**
162
- * This method manages the prices of a price list to create, update, or delete them.
163
- * It sends a request to the [Manage Prices](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsidpricesbatch)
164
- * API route.
165
- *
166
- * @param id - The price list's ID.
167
- * @param body - The prices to create, update, or delete.
168
- * @param query - Configure the fields to retrieve in the price list.
169
- * @param headers - Headers to pass in the request
170
- * @returns The price list's details.
171
- *
172
- * @example
173
- * sdk.admin.priceList.batchPrices("plist_123", {
174
- * create: [{
175
- * variant_id: "variant_123",
176
- * currency_code: "usd",
177
- * amount: 10,
178
- * rules: {
179
- * region_id: "reg_123"
180
- * }
181
- * }],
182
- * update: [{
183
- * id: "price_123",
184
- * variant_id: "variant_123",
185
- * amount: 20,
186
- * }],
187
- * delete: ["price_123"]
188
- * })
189
- * .then(({ created, updated, deleted }) => {
190
- * console.log(created, updated, deleted)
191
- * })
192
- */
193
- batchPrices(id: string, body: HttpTypes.AdminBatchPriceListPrice, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListBatchResponse>;
194
- /**
195
- * This method retrieves the prices of a price list. It sends a request to the
196
- * [Get Prices](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelistsidprices)
197
- * API route.
198
- *
199
- * @since 2.12.3
200
- *
201
- * @param id - The price list's ID.
202
- * @param query - Configure the fields to retrieve in the price list.
203
- * @param headers - Headers to pass in the request
204
- * @returns The price list's prices.
205
- *
206
- * @example
207
- * sdk.admin.priceList.prices("plist_123")
208
- * .then(({ prices }) => {
209
- * console.log(prices)
210
- * })
211
- */
212
- prices(id: string, query?: HttpTypes.AdminPriceListPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListPriceListResponse>;
213
- /**
214
- * This method removes products from a price list. It sends a request to the
215
- * [Remove Product](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsidproducts)
216
- * API route.
217
- *
218
- * @param id - The price list's ID.
219
- * @param body - The details of the products to remove.
220
- * @param query - Configure the fields to retrieve in the price list.
221
- * @param headers - Headers to pass in the request
222
- * @returns The price list's details.
223
- *
224
- * @example
225
- * sdk.admin.priceList.linkProducts("plist_123", {
226
- * remove: ["prod_123"]
227
- * })
228
- * .then(({ price_list }) => {
229
- * console.log(price_list)
230
- * })
231
- */
232
- linkProducts(id: string, body: HttpTypes.AdminLinkPriceListProducts, query?: HttpTypes.AdminPriceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPriceListResponse>;
233
- }
234
- //# sourceMappingURL=price-list.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"price-list.d.ts","sourceRoot":"","sources":["../../../src/admin/price-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,wBAAwB,EACxC,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,6BAA6B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,YAAY,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,oBAAoB,EACtC,OAAO,CAAC,EAAE,aAAa;CAY1B"}
@@ -1,305 +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 PriceList {
11
- /**
12
- * @ignore
13
- */
14
- constructor(client) {
15
- this.client = client;
16
- }
17
- /**
18
- * This method retrieves a price list. It sends a request to the
19
- * [Get Price List](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelistsid)
20
- * API route.
21
- *
22
- * @param id - The price list's ID.
23
- * @param query - Configure the fields to retrieve in the price list.
24
- * @param headers - Headers to pass in the request
25
- * @returns The price list's details.
26
- *
27
- * @example
28
- * To retrieve a price list by its ID:
29
- *
30
- * ```ts
31
- * sdk.admin.priceList.retrieve("plist_123")
32
- * .then(({ price_list }) => {
33
- * console.log(price_list)
34
- * })
35
- * ```
36
- *
37
- * To specify the fields and relations to retrieve:
38
- *
39
- * ```ts
40
- * sdk.admin.priceList.retrieve("plist_123", {
41
- * fields: "id,*prices"
42
- * })
43
- * .then(({ price_list }) => {
44
- * console.log(price_list)
45
- * })
46
- * ```
47
- *
48
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/v2/api/store#select-fields-and-relations).
49
- */
50
- retrieve(id, query, headers) {
51
- return __awaiter(this, void 0, void 0, function* () {
52
- return this.client.fetch(`/admin/price-lists/${id}`, {
53
- method: "GET",
54
- headers,
55
- query,
56
- });
57
- });
58
- }
59
- /**
60
- * This method retrieves a paginated list of price lists. It sends a request to the
61
- * [List Price Lists](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelists) API route.
62
- *
63
- * @param query - Filters and pagination configurations.
64
- * @param headers - Headers to pass in the request.
65
- * @returns The paginated list of price lists.
66
- *
67
- * @example
68
- * To retrieve the list of price lists:
69
- *
70
- * ```ts
71
- * sdk.admin.priceList.list()
72
- * .then(({ price_lists, count, limit, offset }) => {
73
- * console.log(price_lists)
74
- * })
75
- * ```
76
- *
77
- * To configure the pagination, pass the `limit` and `offset` query parameters.
78
- *
79
- * For example, to retrieve only 10 items and skip 10 items:
80
- *
81
- * ```ts
82
- * sdk.admin.priceList.list({
83
- * limit: 10,
84
- * offset: 10
85
- * })
86
- * .then(({ price_lists, count, limit, offset }) => {
87
- * console.log(price_lists)
88
- * })
89
- * ```
90
- *
91
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
92
- * in each price list:
93
- *
94
- * ```ts
95
- * sdk.admin.priceList.list({
96
- * fields: "id,*prices"
97
- * })
98
- * .then(({ price_lists, count, limit, offset }) => {
99
- * console.log(price_lists)
100
- * })
101
- * ```
102
- *
103
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/v2/api/store#select-fields-and-relations).
104
- */
105
- list(query, headers) {
106
- return __awaiter(this, void 0, void 0, function* () {
107
- return this.client.fetch(`/admin/price-lists`, {
108
- method: "GET",
109
- headers,
110
- query,
111
- });
112
- });
113
- }
114
- /**
115
- * This method creates a price list. It sends a request to the
116
- * [Create Price List](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelists)
117
- * API route.
118
- *
119
- * @param body - The details of the price list to create.
120
- * @param query - Configure the fields to retrieve in the price list.
121
- * @param headers - Headers to pass in the request
122
- * @returns The price list's details.
123
- *
124
- * @example
125
- * sdk.admin.priceList.create({
126
- * title: "My Price List",
127
- * status: "active",
128
- * type: "sale",
129
- * prices: [
130
- * {
131
- * variant_id: "variant_123",
132
- * amount: 10,
133
- * currency_code: "usd",
134
- * rules: {
135
- * region_id: "reg_123"
136
- * }
137
- * }
138
- * ]
139
- * })
140
- * .then(({ price_list }) => {
141
- * console.log(price_list)
142
- * })
143
- */
144
- create(body, query, headers) {
145
- return __awaiter(this, void 0, void 0, function* () {
146
- return this.client.fetch(`/admin/price-lists`, {
147
- method: "POST",
148
- headers,
149
- body,
150
- query,
151
- });
152
- });
153
- }
154
- /**
155
- * This method updates a price list. It sends a request to the
156
- * [Update Price List](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsid)
157
- * API route.
158
- *
159
- * @param id - The price list's ID.
160
- * @param body - The data to update in the price list.
161
- * @param query - Configure the fields to retrieve in the price list.
162
- * @param headers - Headers to pass in the request
163
- * @returns The price list's details.
164
- *
165
- * @example
166
- * sdk.admin.priceList.update("plist_123", {
167
- * title: "My Price List",
168
- * })
169
- * .then(({ price_list }) => {
170
- * console.log(price_list)
171
- * })
172
- */
173
- update(id, body, query, headers) {
174
- return __awaiter(this, void 0, void 0, function* () {
175
- return this.client.fetch(`/admin/price-lists/${id}`, {
176
- method: "POST",
177
- headers,
178
- body,
179
- query,
180
- });
181
- });
182
- }
183
- /**
184
- * This method deletes a price list. It sends a request to the
185
- * [Delete Price List](https://docs.acmekit.com/v2/api/admin#price-lists_deletepricelistsid)
186
- * API route.
187
- *
188
- * @param id - The price list's ID.
189
- * @param headers - Headers to pass in the request
190
- * @returns The deletion's details.
191
- *
192
- * @example
193
- * sdk.admin.priceList.delete("plist_123")
194
- * .then(({ deleted }) => {
195
- * console.log(deleted)
196
- * })
197
- */
198
- delete(id, headers) {
199
- return __awaiter(this, void 0, void 0, function* () {
200
- return this.client.fetch(`/admin/price-lists/${id}`, {
201
- method: "DELETE",
202
- headers,
203
- });
204
- });
205
- }
206
- /**
207
- * This method manages the prices of a price list to create, update, or delete them.
208
- * It sends a request to the [Manage Prices](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsidpricesbatch)
209
- * API route.
210
- *
211
- * @param id - The price list's ID.
212
- * @param body - The prices to create, update, or delete.
213
- * @param query - Configure the fields to retrieve in the price list.
214
- * @param headers - Headers to pass in the request
215
- * @returns The price list's details.
216
- *
217
- * @example
218
- * sdk.admin.priceList.batchPrices("plist_123", {
219
- * create: [{
220
- * variant_id: "variant_123",
221
- * currency_code: "usd",
222
- * amount: 10,
223
- * rules: {
224
- * region_id: "reg_123"
225
- * }
226
- * }],
227
- * update: [{
228
- * id: "price_123",
229
- * variant_id: "variant_123",
230
- * amount: 20,
231
- * }],
232
- * delete: ["price_123"]
233
- * })
234
- * .then(({ created, updated, deleted }) => {
235
- * console.log(created, updated, deleted)
236
- * })
237
- */
238
- batchPrices(id, body, query, headers) {
239
- return __awaiter(this, void 0, void 0, function* () {
240
- return this.client.fetch(`/admin/price-lists/${id}/prices/batch`, {
241
- method: "POST",
242
- headers,
243
- body,
244
- query,
245
- });
246
- });
247
- }
248
- /**
249
- * This method retrieves the prices of a price list. It sends a request to the
250
- * [Get Prices](https://docs.acmekit.com/v2/api/admin#price-lists_getpricelistsidprices)
251
- * API route.
252
- *
253
- * @since 2.12.3
254
- *
255
- * @param id - The price list's ID.
256
- * @param query - Configure the fields to retrieve in the price list.
257
- * @param headers - Headers to pass in the request
258
- * @returns The price list's prices.
259
- *
260
- * @example
261
- * sdk.admin.priceList.prices("plist_123")
262
- * .then(({ prices }) => {
263
- * console.log(prices)
264
- * })
265
- */
266
- prices(id, query, headers) {
267
- return __awaiter(this, void 0, void 0, function* () {
268
- return this.client.fetch(`/admin/price-lists/${id}/prices`, {
269
- method: "GET",
270
- headers,
271
- query,
272
- });
273
- });
274
- }
275
- /**
276
- * This method removes products from a price list. It sends a request to the
277
- * [Remove Product](https://docs.acmekit.com/v2/api/admin#price-lists_postpricelistsidproducts)
278
- * API route.
279
- *
280
- * @param id - The price list's ID.
281
- * @param body - The details of the products to remove.
282
- * @param query - Configure the fields to retrieve in the price list.
283
- * @param headers - Headers to pass in the request
284
- * @returns The price list's details.
285
- *
286
- * @example
287
- * sdk.admin.priceList.linkProducts("plist_123", {
288
- * remove: ["prod_123"]
289
- * })
290
- * .then(({ price_list }) => {
291
- * console.log(price_list)
292
- * })
293
- */
294
- linkProducts(id, body, query, headers) {
295
- return __awaiter(this, void 0, void 0, function* () {
296
- return this.client.fetch(`/admin/price-lists/${id}/products`, {
297
- method: "POST",
298
- headers,
299
- body,
300
- query,
301
- });
302
- });
303
- }
304
- }
305
- //# sourceMappingURL=price-list.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"price-list.js","sourceRoot":"","sources":["../../../src/admin/price-list.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,SAAS;IAMpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAAsC,EACtC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,MAAM,CACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,WAAW,CACf,EAAU,EACV,IAAwC,EACxC,KAAsC,EACtC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,eAAe,EACvC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAU,EACV,KAA+C,EAC/C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,SAAS,EACjC;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACG,YAAY,CAChB,EAAU,EACV,IAA0C,EAC1C,KAAsC,EACtC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}