@acmekit/js-sdk 2.13.2 → 2.13.4

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,740 +0,0 @@
1
- import { HttpTypes, SelectParams } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class Product {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method creates a product import. The products are only imported after
15
- * the import is confirmed using the {@link confirmImport} method.
16
- *
17
- * This method sends a request to the
18
- * [Create Product Import](https://docs.acmekit.com/api/admin#products_postproductsimport)
19
- * API route.
20
- *
21
- * @param body - The import's details.
22
- * @param query - Query parameters to pass to the request.
23
- * @param headers - Headers to pass in the request.
24
- * @returns The import's details.
25
- *
26
- * @example
27
- * sdk.admin.product.import({
28
- * file // uploaded File instance
29
- * })
30
- * .then(({ transaction_id }) => {
31
- * console.log(transaction_id)
32
- * })
33
- */
34
- import(body: HttpTypes.AdminImportProductRequest, query?: {}, headers?: ClientHeaders): Promise<HttpTypes.AdminImportProductResponse>;
35
- /**
36
- * This method creates a product import. The products are only imported after
37
- * the import is confirmed using the {@link confirmImport} method.
38
- *
39
- * This method sends a request to the
40
- * [Create Product Import](https://docs.acmekit.com/api/admin#products_postproductsimports)
41
- * API route.
42
- *
43
- * @since 2.8.5
44
- *
45
- * @param body - The import's details.
46
- * @param query - Query parameters to pass to the request.
47
- * @param headers - Headers to pass in the request.
48
- * @returns The import's details.
49
- *
50
- * @example
51
- * sdk.admin.product.createImport({
52
- * file // uploaded File instance
53
- * })
54
- * .then(({ transaction_id }) => {
55
- * console.log(transaction_id)
56
- * })
57
- */
58
- createImport(body: HttpTypes.AdminImportProductRequest, query?: {}, headers?: ClientHeaders): Promise<HttpTypes.AdminImportProductsResponse>;
59
- /**
60
- * This method confirms a product import created using the method {@link import}.
61
- * It sends a request to the
62
- * [Confirm Product Import](https://docs.acmekit.com/api/admin#products_postproductsimporttransaction_idconfirm)
63
- * API route.
64
- *
65
- * @since 2.8.5
66
- *
67
- * @param transactionId - The ID of the transaction of the created product import. This is returned
68
- * by the API route used to create the product import.
69
- * @param query - Query parameters to pass in the request.
70
- * @param headers - Headers to pass in the request.
71
- *
72
- * @example
73
- * sdk.admin.product.confirmImport("transaction_123")
74
- * .then(() => {
75
- * console.log("Import confirmed")
76
- * })
77
- */
78
- confirmImport(transactionId: string, query?: {}, headers?: ClientHeaders): Promise<{}>;
79
- /**
80
- * This method starts a product export process to retrieve a CSV of exported products.
81
- *
82
- * You'll receive in the response the transaction ID of the workflow generating the CSV file.
83
- * To check the status of the execution, send a `GET` request to
84
- * `/admin/workflows-executions/export-products/:transaction-id`.
85
- *
86
- * Once the execution finishes successfully, a notification is created for the export.
87
- * You can retrieve the notifications using the `/admin/notification` API route to
88
- * retrieve the file's download URL.
89
- *
90
- * This method sends a request to the [Export Product](https://docs.acmekit.com/api/admin#products_postproductsexport)
91
- * API route.
92
- *
93
- * @param body - The export's details.
94
- * @param query - Filters to specify which products to export.
95
- * @param headers - Headers to pass in the request.
96
- * @returns The export's details.
97
- *
98
- * @example
99
- * sdk.admin.product.export({})
100
- * .then(({ transaction_id }) => {
101
- * console.log(transaction_id)
102
- * })
103
- */
104
- export(body: HttpTypes.AdminExportProductRequest, query?: HttpTypes.AdminProductListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminExportProductResponse>;
105
- /**
106
- * This method manages products to create, update, or delete them. It sends a request to the
107
- * [Manage Products](https://docs.acmekit.com/api/admin#products_postproductsbatch)
108
- * API route.
109
- *
110
- * @param body - The products to create, update, or delete.
111
- * @param query - Configure the fields to retrieve in the products.
112
- * @param headers - Headers to pass in the request
113
- * @returns The batch operations details.
114
- *
115
- * @example
116
- * sdk.admin.product.batch({
117
- * create: [
118
- * {
119
- * title: "Shirt",
120
- * options: [{
121
- * title: "Default",
122
- * values: ["Default Option"]
123
- * }],
124
- * variants: [
125
- * {
126
- * title: "Default",
127
- * options: {
128
- * Default: "Default Option"
129
- * },
130
- * prices: []
131
- * }
132
- * ]
133
- * }
134
- * ],
135
- * update: [{
136
- * id: "prod_123",
137
- * title: "Pants"
138
- * }],
139
- * delete: ["prod_321"]
140
- * })
141
- * .then(({ created, updated, deleted }) => {
142
- * console.log(created, updated, deleted)
143
- * })
144
- */
145
- batch(body: HttpTypes.AdminBatchProductRequest, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchProductResponse>;
146
- /**
147
- * This method creates a product. It sends a request to the
148
- * [Create Product](https://docs.acmekit.com/api/admin#products_postproducts)
149
- * API route.
150
- *
151
- * @param body - The product's details.
152
- * @param query - Configure the fields to retrieve in the product.
153
- * @param headers - Headers to pass in the request
154
- * @returns The product's details.
155
- *
156
- * @example
157
- * sdk.admin.product.create({
158
- * title: "Shirt",
159
- * options: [{
160
- * title: "Default",
161
- * values: ["Default Option"]
162
- * }],
163
- * variants: [
164
- * {
165
- * title: "Default",
166
- * options: {
167
- * Default: "Default Option"
168
- * },
169
- * prices: []
170
- * }
171
- * ],
172
- * shipping_profile_id: "sp_123"
173
- * })
174
- * .then(({ product }) => {
175
- * console.log(product)
176
- * })
177
- */
178
- create(body: HttpTypes.AdminCreateProduct, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
179
- /**
180
- * This method updates a product. It sends a request to the
181
- * [Update Product](https://docs.acmekit.com/api/admin#products_postproductsid)
182
- * API route.
183
- *
184
- * @param id - The product's ID.
185
- * @param body - The data to update in the product.
186
- * @param query - Configure the fields to retrieve in the product.
187
- * @param headers - Headers to pass in the request
188
- * @returns The product's details.
189
- *
190
- * @example
191
- * sdk.admin.product.update("prod_123", {
192
- * title: "Shirt",
193
- * })
194
- * .then(({ product }) => {
195
- * console.log(product)
196
- * })
197
- */
198
- update(id: string, body: HttpTypes.AdminUpdateProduct, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
199
- /**
200
- * This method retrieves a paginated list of products. It sends a request to the
201
- * [List Products](https://docs.acmekit.com/api/admin#products_getproducts) API route.
202
- *
203
- * @param queryParams - Filters and pagination configurations.
204
- * @param headers - Headers to pass in the request.
205
- * @returns The paginated list of products.
206
- *
207
- * @example
208
- * To retrieve the list of products:
209
- *
210
- * ```ts
211
- * sdk.admin.product.list()
212
- * .then(({ products, count, limit, offset }) => {
213
- * console.log(products)
214
- * })
215
- * ```
216
- *
217
- * To configure the pagination, pass the `limit` and `offset` query parameters.
218
- *
219
- * For example, to retrieve only 10 items and skip 10 items:
220
- *
221
- * ```ts
222
- * sdk.admin.product.list({
223
- * limit: 10,
224
- * offset: 10
225
- * })
226
- * .then(({ products, count, limit, offset }) => {
227
- * console.log(products)
228
- * })
229
- * ```
230
- *
231
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
232
- * in each products:
233
- *
234
- * ```ts
235
- * sdk.admin.product.list({
236
- * fields: "id,*variants"
237
- * })
238
- * .then(({ products, count, limit, offset }) => {
239
- * console.log(products)
240
- * })
241
- * ```
242
- *
243
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
244
- */
245
- list(queryParams?: HttpTypes.AdminProductListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductListResponse>;
246
- /**
247
- * This method retrieves a product by its ID. It sends a request to the
248
- * [Get Product](https://docs.acmekit.com/api/admin#products_getproductsid)
249
- * API route.
250
- *
251
- * @param id - The product's ID.
252
- * @param query - Configure the fields to retrieve in the product.
253
- * @param headers - Headers to pass in the request
254
- * @returns The product's details.
255
- *
256
- * @example
257
- * To retrieve a product by its ID:
258
- *
259
- * ```ts
260
- * sdk.admin.product.retrieve("prod_123")
261
- * .then(({ product }) => {
262
- * console.log(product)
263
- * })
264
- * ```
265
- *
266
- * To specify the fields and relations to retrieve:
267
- *
268
- * ```ts
269
- * sdk.admin.product.retrieve("prod_123", {
270
- * fields: "id,*variants"
271
- * })
272
- * .then(({ product }) => {
273
- * console.log(product)
274
- * })
275
- * ```
276
- *
277
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
278
- */
279
- retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
280
- /**
281
- * This method deletes a product. It sends a request to the
282
- * [Delete Product](https://docs.acmekit.com/api/admin#products_deleteproductsid)
283
- * API route.
284
- *
285
- * @param id - The product's ID.
286
- * @param headers - Headers to pass in the request
287
- * @returns The deletion's details.
288
- *
289
- * @example
290
- * sdk.admin.product.delete("prod_123")
291
- * .then(({ deleted }) => {
292
- * console.log(deleted)
293
- * })
294
- */
295
- delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductDeleteResponse>;
296
- /**
297
- * This method manages the variants of a product. It sends a request to the
298
- * [Manage Variants](https://docs.acmekit.com/api/admin#products_postproductsidvariantsbatch)
299
- * API route.
300
- *
301
- * @param productId - The product's ID.
302
- * @param body - The variants to create, update, or delete.
303
- * @param query - Configure the fields to retrieve in the product variants.
304
- * @param headers - Headers to pass in the request
305
- * @returns The product variants' details.
306
- *
307
- * @example
308
- * sdk.admin.product.batchVariants("prod_123", {
309
- * create: [
310
- * {
311
- * title: "Blue Shirt",
312
- * options: {
313
- * Color: "Blue"
314
- * },
315
- * prices: []
316
- * }
317
- * ],
318
- * update: [
319
- * {
320
- * id: "variant_123",
321
- * title: "Pants"
322
- * }
323
- * ],
324
- * delete: ["variant_123"]
325
- * })
326
- * .then(({ created, updated, deleted }) => {
327
- * console.log(created, updated, deleted)
328
- * })
329
- */
330
- batchVariants(productId: string, body: HttpTypes.AdminBatchProductVariantRequest, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchProductVariantResponse>;
331
- /**
332
- * This method creates a variant for a product. It sends a request to the
333
- * [Create Variant](https://docs.acmekit.com/api/admin#products_postproductsidvariants)
334
- * API route.
335
- *
336
- * @param productId - The product's ID.
337
- * @param body - The variant's details.
338
- * @param query - Configure the fields to retrieve in the product.
339
- * @param headers - Headers to pass in the request
340
- * @returns The product's details.
341
- *
342
- * @example
343
- * sdk.admin.product.createVariant("prod_123", {
344
- * title: "Blue Shirt",
345
- * options: {
346
- * Color: "Blue"
347
- * },
348
- * prices: [
349
- * {
350
- * amount: 10,
351
- * currency_code: "usd"
352
- * }
353
- * ]
354
- * })
355
- * .then(({ product }) => {
356
- * console.log(product)
357
- * })
358
- */
359
- createVariant(productId: string, body: HttpTypes.AdminCreateProductVariant, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
360
- /**
361
- * This method updates a variant of a product. It sends a request to the
362
- * [Update Variant](https://docs.acmekit.com/api/admin#products_postproductsidvariantsvariant_id)
363
- * API route.
364
- *
365
- * @param productId - The product's ID.
366
- * @param id - The variant's ID.
367
- * @param body - The data to update in the variant.
368
- * @param query - Configure the fields to retrieve in the product.
369
- * @param headers - Headers to pass in the request
370
- * @returns The product's details.
371
- *
372
- * @example
373
- * sdk.admin.product.updateVariant(
374
- * "prod_123",
375
- * "variant_123",
376
- * {
377
- * title: "Blue Shirt",
378
- * }
379
- * )
380
- * .then(({ product }) => {
381
- * console.log(product)
382
- * })
383
- */
384
- updateVariant(productId: string, id: string, body: HttpTypes.AdminUpdateProductVariant, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
385
- /**
386
- * This method retrieves a paginated list of products. It sends a request to the
387
- * [List Products](https://docs.acmekit.com/api/admin#products_getproductsidvariants) API route.
388
- *
389
- * @param productId - The ID of the product to retrieve its variants.
390
- * @param query - Filters and pagination configurations.
391
- * @param headers - Headers to pass in the request.
392
- * @returns The paginated list of product variants.
393
- *
394
- * @example
395
- * To retrieve the list of product variants:
396
- *
397
- * ```ts
398
- * sdk.admin.product.listVariants("prod_123")
399
- * .then(({ variants, count, limit, offset }) => {
400
- * console.log(variants)
401
- * })
402
- * ```
403
- *
404
- * To configure the pagination, pass the `limit` and `offset` query parameters.
405
- *
406
- * For example, to retrieve only 10 items and skip 10 items:
407
- *
408
- * ```ts
409
- * sdk.admin.product.listVariants("prod_123", {
410
- * limit: 10,
411
- * offset: 10
412
- * })
413
- * .then(({ variants, count, limit, offset }) => {
414
- * console.log(variants)
415
- * })
416
- * ```
417
- *
418
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
419
- * in each product variant:
420
- *
421
- * ```ts
422
- * sdk.admin.product.listVariants("prod_123", {
423
- * fields: "id,*product"
424
- * })
425
- * .then(({ variants, count, limit, offset }) => {
426
- * console.log(variants)
427
- * })
428
- * ```
429
- *
430
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
431
- */
432
- listVariants(productId: string, query?: HttpTypes.AdminProductVariantParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductVariantListResponse>;
433
- /**
434
- * This method retrieves a product's variant. It sends a request to the
435
- * [Retrieve Variant](https://docs.acmekit.com/api/admin#products_getproductsidvariantsvariant_id)
436
- * API route.
437
- *
438
- * @param productId - The product's ID.
439
- * @param id - The variant's ID.
440
- * @param query - Configure the fields to retrieve in the product variant.
441
- * @param headers - Headers to pass in the request
442
- * @returns The product variant's details.
443
- *
444
- * @example
445
- * To retrieve a product variant by its ID:
446
- *
447
- * ```ts
448
- * sdk.admin.product.retrieveVariant(
449
- * "prod_123",
450
- * "variant_123"
451
- * )
452
- * .then(({ variant }) => {
453
- * console.log(variant)
454
- * })
455
- * ```
456
- *
457
- * To specify the fields and relations to retrieve:
458
- *
459
- * ```ts
460
- * sdk.admin.product.retrieveVariant(
461
- * "prod_123",
462
- * "variant_123",
463
- * {
464
- * fields: "id, *product"
465
- * }
466
- * )
467
- * .then(({ variant }) => {
468
- * console.log(variant)
469
- * })
470
- * ```
471
- *
472
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
473
- */
474
- retrieveVariant(productId: string, id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductVariantResponse>;
475
- /**
476
- * This method deletes a product's variant. It sends a request to the
477
- * [Delete Variant](https://docs.acmekit.com/api/admin#products_deleteproductsidvariantsvariant_id)
478
- * API route.
479
- *
480
- * @param productId - The product's ID.
481
- * @param id - The ID of the variant.
482
- * @param headers - Headers to pass in the request
483
- * @returns The deletion's details.
484
- *
485
- * @example
486
- * sdk.admin.product.deleteVariant("prod_123", "variant_123")
487
- * .then(({ deleted }) => {
488
- * console.log(deleted)
489
- * })
490
- */
491
- deleteVariant(productId: string, id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductVariantDeleteResponse>;
492
- /**
493
- * This method manages a product's variant's inventories to associate them with inventory items,
494
- * update their inventory items, or delete their association with inventory items.
495
- *
496
- * It sends a request to the
497
- * [Manage Variant Inventory](https://docs.acmekit.com/api/admin#products_postproductsidvariantsinventoryitemsbatch)
498
- * API route.
499
- *
500
- * @param productId - The ID of the product that the variant belongs to.
501
- * @param body - The inventory items to create, update, or delete.
502
- * @param query - Pass query parameters in the request.
503
- * @param headers - Headers to pass in the request
504
- * @returns The details of the created, updated, or deleted inventory items.
505
- *
506
- * @example
507
- * sdk.admin.product.batchVariantInventoryItems(
508
- * "prod_123",
509
- * {
510
- * create: [
511
- * {
512
- * inventory_item_id: "iitem_123",
513
- * variant_id: "variant_123",
514
- * required_quantity: 10
515
- * }
516
- * ],
517
- * update: [
518
- * {
519
- * inventory_item_id: "iitem_1234",
520
- * variant_id: "variant_1234",
521
- * required_quantity: 20
522
- * }
523
- * ],
524
- * delete: [
525
- * {
526
- * inventory_item_id: "iitem_321",
527
- * variant_id: "variant_321"
528
- * }
529
- * ]
530
- * }
531
- * )
532
- * .then(({ created, updated, deleted }) => {
533
- * console.log(created, updated, deleted)
534
- * })
535
- */
536
- batchVariantInventoryItems(productId: string, body: HttpTypes.AdminBatchProductVariantInventoryItemRequest, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchProductVariantInventoryItemResponse>;
537
- /**
538
- * This method creates an option in a product. It sends a request to the
539
- * [Create Option](https://docs.acmekit.com/api/admin#products_postproductsidoptions)
540
- * API route.
541
- *
542
- * @param productId - The product's ID.
543
- * @param body - The option's details.
544
- * @param query - Configure the fields to retrieve in the product.
545
- * @param headers - Headers to pass in the request
546
- * @returns The product's details.
547
- *
548
- * @example
549
- * sdk.admin.product.createOption(
550
- * "prod_123",
551
- * {
552
- * title: "Color",
553
- * values: ["Green", "Blue"]
554
- * }
555
- * )
556
- * .then(({ product }) => {
557
- * console.log(product)
558
- * })
559
- */
560
- createOption(productId: string, body: HttpTypes.AdminCreateProductOption, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
561
- /**
562
- * This method updates a product's option. It sends a request to the
563
- * [Update Option](https://docs.acmekit.com/api/admin#products_postproductsidoptionsoption_id)
564
- * API route.
565
- *
566
- * @param productId - The product's ID.
567
- * @param id - The ID of the option to update.
568
- * @param body - The data to update in the option.
569
- * @param query - Configure the fields to retrieve in the product.
570
- * @param headers - Headers to pass in the request
571
- * @returns The product's details.
572
- *
573
- * @example
574
- * sdk.admin.product.updateOption(
575
- * "prod_123",
576
- * "prodopt_123",
577
- * {
578
- * title: "Color"
579
- * }
580
- * )
581
- * .then(({ product }) => {
582
- * console.log(product)
583
- * })
584
- */
585
- updateOption(productId: string, id: string, body: HttpTypes.AdminUpdateProductOption, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductResponse>;
586
- /**
587
- * This method retrieves a paginated list of product options. It sends a request to the
588
- * [List Options](https://docs.acmekit.com/api/admin#products_getproductsidoptions) API route.
589
- *
590
- * @param productId - The ID of the product to retrieve its options
591
- * @param query - Filters and pagination configurations.
592
- * @param headers - Headers to pass in the request.
593
- * @returns The paginated list of product options.
594
- *
595
- * @example
596
- * To retrieve the list of product options:
597
- *
598
- * ```ts
599
- * sdk.admin.product.listOptions("prod_123")
600
- * .then(({ product_options, count, limit, offset }) => {
601
- * console.log(product_options)
602
- * })
603
- * ```
604
- *
605
- * To configure the pagination, pass the `limit` and `offset` query parameters.
606
- *
607
- * For example, to retrieve only 10 items and skip 10 items:
608
- *
609
- * ```ts
610
- * sdk.admin.product.listOptions("prod_123", {
611
- * limit: 10,
612
- * offset: 10
613
- * })
614
- * .then(({ product_options, count, limit, offset }) => {
615
- * console.log(product_options)
616
- * })
617
- * ```
618
- *
619
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
620
- * in each product options:
621
- *
622
- * ```ts
623
- * sdk.admin.product.listOptions("prod_123", {
624
- * fields: "id,title"
625
- * })
626
- * .then(({ product_options, count, limit, offset }) => {
627
- * console.log(product_options)
628
- * })
629
- * ```
630
- *
631
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
632
- */
633
- listOptions(productId: string, query?: HttpTypes.AdminProductOptionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductOptionListResponse>;
634
- /**
635
- * This method retrieves a product's option. It sends a request to the
636
- * [Get Option](https://docs.acmekit.com/api/admin#products_getproductsidoptionsoption_id)
637
- * API route.
638
- *
639
- * @param productId - The product's ID.
640
- * @param id - The product option's ID.
641
- * @param query - Configure the fields to retrieve in the product option.
642
- * @param headers - Headers to pass in the request
643
- * @returns The product option's details.
644
- *
645
- * @example
646
- * To retrieve a product option by its ID:
647
- *
648
- * ```ts
649
- * sdk.admin.product.retrieveOption(
650
- * "prod_123",
651
- * "prodopt_123"
652
- * )
653
- * .then(({ product_option }) => {
654
- * console.log(product_option)
655
- * })
656
- * ```
657
- *
658
- * To specify the fields and relations to retrieve:
659
- *
660
- * ```ts
661
- * sdk.admin.product.retrieveOption(
662
- * "prod_123",
663
- * "prodopt_123",
664
- * {
665
- * fields: "id,title"
666
- * }
667
- * )
668
- * .then(({ product_option }) => {
669
- * console.log(product_option)
670
- * })
671
- * ```
672
- *
673
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
674
- */
675
- retrieveOption(productId: string, id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductOptionResponse>;
676
- /**
677
- * This method deletes a product's option. It sends a request to the
678
- * [Delete Option](https://docs.acmekit.com/api/admin#products_deleteproductsidoptionsoption_id)
679
- * API route.
680
- *
681
- * @param productId - The product's ID.
682
- * @param id - The option's ID.
683
- * @param headers - Headers to pass in the request
684
- * @returns The deletion's details.
685
- *
686
- * @example
687
- * sdk.admin.product.deleteOption("prod_123", "prodopt_123")
688
- * .then(({ deleted }) => {
689
- * console.log(deleted)
690
- * })
691
- */
692
- deleteOption(productId: string, id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductOptionDeleteResponse>;
693
- /**
694
- * This method manages image-variant associations for a specific image. It sends a request to the
695
- * [Batch Image Variants](https://docs.acmekit.com/api/admin#products_postproductsidimagesimage_idvariantsbatch)
696
- * API route.
697
- *
698
- * @since 2.11.2
699
- *
700
- * @param productId - The product's ID.
701
- * @param imageId - The image's ID.
702
- * @param body - The variants to add or remove from the image.
703
- * @param headers - Headers to pass in the request
704
- * @returns The batch operation details.
705
- *
706
- * @example
707
- * sdk.admin.product.batchImageVariants("prod_123", "img_123", {
708
- * add: ["variant_123", "variant_456"],
709
- * remove: ["variant_789"]
710
- * })
711
- * .then(({ added, removed }) => {
712
- * console.log(added, removed)
713
- * })
714
- */
715
- batchImageVariants(productId: string, imageId: string, body: HttpTypes.AdminBatchImageVariantRequest, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchImageVariantResponse>;
716
- /**
717
- * This method manages variant-image associations for a specific variant. It sends a request to the
718
- * [Batch Variant Images](https://docs.acmekit.com/api/admin#products_postproductsidvariantsvariant_idimagesbatch)
719
- * API route.
720
- *
721
- * @since 2.11.2
722
- *
723
- * @param productId - The product's ID.
724
- * @param variantId - The variant's ID.
725
- * @param body - The images to add or remove from the variant.
726
- * @param headers - Headers to pass in the request
727
- * @returns The batch operation details.
728
- *
729
- * @example
730
- * sdk.admin.product.batchVariantImages("prod_123", "variant_123", {
731
- * add: ["img_123", "img_456"],
732
- * remove: ["img_789"]
733
- * })
734
- * .then(({ added, removed }) => {
735
- * console.log(added, removed)
736
- * })
737
- */
738
- batchVariantImages(productId: string, variantId: string, body: HttpTypes.AdminBatchVariantImagesRequest, headers?: ClientHeaders): Promise<HttpTypes.AdminBatchVariantImagesResponse>;
739
- }
740
- //# sourceMappingURL=product.d.ts.map