@acmekit/js-sdk 2.13.2 → 2.13.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (297) hide show
  1. package/dist/admin/index.d.ts +2 -177
  2. package/dist/admin/index.d.ts.map +1 -1
  3. package/dist/admin/index.js +3 -76
  4. package/dist/admin/index.js.map +1 -1
  5. package/dist/esm/admin/index.d.ts +2 -177
  6. package/dist/esm/admin/index.d.ts.map +1 -1
  7. package/dist/esm/admin/index.js +3 -73
  8. package/dist/esm/admin/index.js.map +1 -1
  9. package/dist/esm/store/index.d.ts +5 -1193
  10. package/dist/esm/store/index.d.ts.map +1 -1
  11. package/dist/esm/store/index.js +6 -1418
  12. package/dist/esm/store/index.js.map +1 -1
  13. package/dist/store/index.d.ts +5 -1193
  14. package/dist/store/index.d.ts.map +1 -1
  15. package/dist/store/index.js +6 -1408
  16. package/dist/store/index.js.map +1 -1
  17. package/package.json +2 -2
  18. package/dist/admin/campaign.d.ts +0 -164
  19. package/dist/admin/campaign.d.ts.map +0 -1
  20. package/dist/admin/campaign.js +0 -196
  21. package/dist/admin/campaign.js.map +0 -1
  22. package/dist/admin/claim.d.ts +0 -558
  23. package/dist/admin/claim.d.ts.map +0 -1
  24. package/dist/admin/claim.js +0 -693
  25. package/dist/admin/claim.js.map +0 -1
  26. package/dist/admin/currency.d.ts +0 -95
  27. package/dist/admin/currency.d.ts.map +0 -1
  28. package/dist/admin/currency.js +0 -104
  29. package/dist/admin/currency.js.map +0 -1
  30. package/dist/admin/draft-order.d.ts +0 -430
  31. package/dist/admin/draft-order.d.ts.map +0 -1
  32. package/dist/admin/draft-order.js +0 -547
  33. package/dist/admin/draft-order.js.map +0 -1
  34. package/dist/admin/exchange.d.ts +0 -487
  35. package/dist/admin/exchange.d.ts.map +0 -1
  36. package/dist/admin/exchange.js +0 -602
  37. package/dist/admin/exchange.js.map +0 -1
  38. package/dist/admin/fulfillment-provider.d.ts +0 -78
  39. package/dist/admin/fulfillment-provider.d.ts.map +0 -1
  40. package/dist/admin/fulfillment-provider.js +0 -88
  41. package/dist/admin/fulfillment-provider.js.map +0 -1
  42. package/dist/admin/fulfillment-set.d.ts +0 -141
  43. package/dist/admin/fulfillment-set.d.ts.map +0 -1
  44. package/dist/admin/fulfillment-set.js +0 -170
  45. package/dist/admin/fulfillment-set.js.map +0 -1
  46. package/dist/admin/fulfillment.d.ts +0 -91
  47. package/dist/admin/fulfillment.d.ts.map +0 -1
  48. package/dist/admin/fulfillment.js +0 -111
  49. package/dist/admin/fulfillment.js.map +0 -1
  50. package/dist/admin/inventory-item.d.ts +0 -320
  51. package/dist/admin/inventory-item.d.ts.map +0 -1
  52. package/dist/admin/inventory-item.js +0 -384
  53. package/dist/admin/inventory-item.js.map +0 -1
  54. package/dist/admin/order-edit.d.ts +0 -189
  55. package/dist/admin/order-edit.d.ts.map +0 -1
  56. package/dist/admin/order-edit.js +0 -240
  57. package/dist/admin/order-edit.js.map +0 -1
  58. package/dist/admin/order.d.ts +0 -452
  59. package/dist/admin/order.d.ts.map +0 -1
  60. package/dist/admin/order.js +0 -560
  61. package/dist/admin/order.js.map +0 -1
  62. package/dist/admin/payment-collection.d.ts +0 -72
  63. package/dist/admin/payment-collection.d.ts.map +0 -1
  64. package/dist/admin/payment-collection.js +0 -90
  65. package/dist/admin/payment-collection.js.map +0 -1
  66. package/dist/admin/payment.d.ts +0 -180
  67. package/dist/admin/payment.d.ts.map +0 -1
  68. package/dist/admin/payment.js +0 -208
  69. package/dist/admin/payment.js.map +0 -1
  70. package/dist/admin/price-list.d.ts +0 -234
  71. package/dist/admin/price-list.d.ts.map +0 -1
  72. package/dist/admin/price-list.js +0 -284
  73. package/dist/admin/price-list.js.map +0 -1
  74. package/dist/admin/price-preference.d.ts +0 -152
  75. package/dist/admin/price-preference.d.ts.map +0 -1
  76. package/dist/admin/price-preference.js +0 -182
  77. package/dist/admin/price-preference.js.map +0 -1
  78. package/dist/admin/product-category.d.ts +0 -170
  79. package/dist/admin/product-category.d.ts.map +0 -1
  80. package/dist/admin/product-category.js +0 -205
  81. package/dist/admin/product-category.js.map +0 -1
  82. package/dist/admin/product-collection.d.ts +0 -169
  83. package/dist/admin/product-collection.d.ts.map +0 -1
  84. package/dist/admin/product-collection.js +0 -203
  85. package/dist/admin/product-collection.js.map +0 -1
  86. package/dist/admin/product-tag.d.ts +0 -149
  87. package/dist/admin/product-tag.d.ts.map +0 -1
  88. package/dist/admin/product-tag.js +0 -177
  89. package/dist/admin/product-tag.js.map +0 -1
  90. package/dist/admin/product-type.d.ts +0 -150
  91. package/dist/admin/product-type.d.ts.map +0 -1
  92. package/dist/admin/product-type.js +0 -178
  93. package/dist/admin/product-type.js.map +0 -1
  94. package/dist/admin/product-variant.d.ts +0 -62
  95. package/dist/admin/product-variant.d.ts.map +0 -1
  96. package/dist/admin/product-variant.js +0 -66
  97. package/dist/admin/product-variant.js.map +0 -1
  98. package/dist/admin/product.d.ts +0 -740
  99. package/dist/admin/product.d.ts.map +0 -1
  100. package/dist/admin/product.js +0 -948
  101. package/dist/admin/product.js.map +0 -1
  102. package/dist/admin/promotion.d.ts +0 -310
  103. package/dist/admin/promotion.d.ts.map +0 -1
  104. package/dist/admin/promotion.js +0 -374
  105. package/dist/admin/promotion.js.map +0 -1
  106. package/dist/admin/refund-reasons.d.ts +0 -163
  107. package/dist/admin/refund-reasons.d.ts.map +0 -1
  108. package/dist/admin/refund-reasons.js +0 -192
  109. package/dist/admin/refund-reasons.js.map +0 -1
  110. package/dist/admin/region.d.ts +0 -152
  111. package/dist/admin/region.d.ts.map +0 -1
  112. package/dist/admin/region.js +0 -180
  113. package/dist/admin/region.js.map +0 -1
  114. package/dist/admin/reservation.d.ts +0 -154
  115. package/dist/admin/reservation.d.ts.map +0 -1
  116. package/dist/admin/reservation.js +0 -182
  117. package/dist/admin/reservation.js.map +0 -1
  118. package/dist/admin/return-reason.d.ts +0 -154
  119. package/dist/admin/return-reason.d.ts.map +0 -1
  120. package/dist/admin/return-reason.js +0 -183
  121. package/dist/admin/return-reason.js.map +0 -1
  122. package/dist/admin/return.d.ts +0 -558
  123. package/dist/admin/return.d.ts.map +0 -1
  124. package/dist/admin/return.js +0 -700
  125. package/dist/admin/return.js.map +0 -1
  126. package/dist/admin/sales-channel.d.ts +0 -196
  127. package/dist/admin/sales-channel.d.ts.map +0 -1
  128. package/dist/admin/sales-channel.js +0 -238
  129. package/dist/admin/sales-channel.js.map +0 -1
  130. package/dist/admin/shipping-option-type.d.ts +0 -152
  131. package/dist/admin/shipping-option-type.d.ts.map +0 -1
  132. package/dist/admin/shipping-option-type.js +0 -180
  133. package/dist/admin/shipping-option-type.js.map +0 -1
  134. package/dist/admin/shipping-option.d.ts +0 -171
  135. package/dist/admin/shipping-option.d.ts.map +0 -1
  136. package/dist/admin/shipping-option.js +0 -207
  137. package/dist/admin/shipping-option.js.map +0 -1
  138. package/dist/admin/shipping-profile.d.ts +0 -151
  139. package/dist/admin/shipping-profile.d.ts.map +0 -1
  140. package/dist/admin/shipping-profile.js +0 -181
  141. package/dist/admin/shipping-profile.js.map +0 -1
  142. package/dist/admin/stock-location.d.ts +0 -212
  143. package/dist/admin/stock-location.d.ts.map +0 -1
  144. package/dist/admin/stock-location.js +0 -260
  145. package/dist/admin/stock-location.js.map +0 -1
  146. package/dist/admin/tax-provider.d.ts +0 -64
  147. package/dist/admin/tax-provider.d.ts.map +0 -1
  148. package/dist/admin/tax-provider.js +0 -70
  149. package/dist/admin/tax-provider.js.map +0 -1
  150. package/dist/admin/tax-rate.d.ts +0 -155
  151. package/dist/admin/tax-rate.d.ts.map +0 -1
  152. package/dist/admin/tax-rate.js +0 -186
  153. package/dist/admin/tax-rate.js.map +0 -1
  154. package/dist/admin/tax-region.d.ts +0 -165
  155. package/dist/admin/tax-region.d.ts.map +0 -1
  156. package/dist/admin/tax-region.js +0 -196
  157. package/dist/admin/tax-region.js.map +0 -1
  158. package/dist/esm/admin/campaign.d.ts +0 -164
  159. package/dist/esm/admin/campaign.d.ts.map +0 -1
  160. package/dist/esm/admin/campaign.js +0 -213
  161. package/dist/esm/admin/campaign.js.map +0 -1
  162. package/dist/esm/admin/claim.d.ts +0 -558
  163. package/dist/esm/admin/claim.d.ts.map +0 -1
  164. package/dist/esm/admin/claim.js +0 -740
  165. package/dist/esm/admin/claim.js.map +0 -1
  166. package/dist/esm/admin/currency.d.ts +0 -95
  167. package/dist/esm/admin/currency.d.ts.map +0 -1
  168. package/dist/esm/admin/currency.js +0 -113
  169. package/dist/esm/admin/currency.js.map +0 -1
  170. package/dist/esm/admin/draft-order.d.ts +0 -430
  171. package/dist/esm/admin/draft-order.d.ts.map +0 -1
  172. package/dist/esm/admin/draft-order.js +0 -594
  173. package/dist/esm/admin/draft-order.js.map +0 -1
  174. package/dist/esm/admin/exchange.d.ts +0 -487
  175. package/dist/esm/admin/exchange.d.ts.map +0 -1
  176. package/dist/esm/admin/exchange.js +0 -643
  177. package/dist/esm/admin/exchange.js.map +0 -1
  178. package/dist/esm/admin/fulfillment-provider.d.ts +0 -78
  179. package/dist/esm/admin/fulfillment-provider.d.ts.map +0 -1
  180. package/dist/esm/admin/fulfillment-provider.js +0 -97
  181. package/dist/esm/admin/fulfillment-provider.js.map +0 -1
  182. package/dist/esm/admin/fulfillment-set.d.ts +0 -141
  183. package/dist/esm/admin/fulfillment-set.d.ts.map +0 -1
  184. package/dist/esm/admin/fulfillment-set.js +0 -185
  185. package/dist/esm/admin/fulfillment-set.js.map +0 -1
  186. package/dist/esm/admin/fulfillment.d.ts +0 -91
  187. package/dist/esm/admin/fulfillment.d.ts.map +0 -1
  188. package/dist/esm/admin/fulfillment.js +0 -122
  189. package/dist/esm/admin/fulfillment.js.map +0 -1
  190. package/dist/esm/admin/inventory-item.d.ts +0 -320
  191. package/dist/esm/admin/inventory-item.d.ts.map +0 -1
  192. package/dist/esm/admin/inventory-item.js +0 -411
  193. package/dist/esm/admin/inventory-item.js.map +0 -1
  194. package/dist/esm/admin/order-edit.d.ts +0 -189
  195. package/dist/esm/admin/order-edit.d.ts.map +0 -1
  196. package/dist/esm/admin/order-edit.js +0 -261
  197. package/dist/esm/admin/order-edit.js.map +0 -1
  198. package/dist/esm/admin/order.d.ts +0 -452
  199. package/dist/esm/admin/order.d.ts.map +0 -1
  200. package/dist/esm/admin/order.js +0 -603
  201. package/dist/esm/admin/order.js.map +0 -1
  202. package/dist/esm/admin/payment-collection.d.ts +0 -72
  203. package/dist/esm/admin/payment-collection.d.ts.map +0 -1
  204. package/dist/esm/admin/payment-collection.js +0 -101
  205. package/dist/esm/admin/payment-collection.js.map +0 -1
  206. package/dist/esm/admin/payment.d.ts +0 -180
  207. package/dist/esm/admin/payment.d.ts.map +0 -1
  208. package/dist/esm/admin/payment.js +0 -223
  209. package/dist/esm/admin/payment.js.map +0 -1
  210. package/dist/esm/admin/price-list.d.ts +0 -234
  211. package/dist/esm/admin/price-list.d.ts.map +0 -1
  212. package/dist/esm/admin/price-list.js +0 -305
  213. package/dist/esm/admin/price-list.js.map +0 -1
  214. package/dist/esm/admin/price-preference.d.ts +0 -152
  215. package/dist/esm/admin/price-preference.d.ts.map +0 -1
  216. package/dist/esm/admin/price-preference.js +0 -197
  217. package/dist/esm/admin/price-preference.js.map +0 -1
  218. package/dist/esm/admin/product-category.d.ts +0 -170
  219. package/dist/esm/admin/product-category.d.ts.map +0 -1
  220. package/dist/esm/admin/product-category.js +0 -222
  221. package/dist/esm/admin/product-category.js.map +0 -1
  222. package/dist/esm/admin/product-collection.d.ts +0 -169
  223. package/dist/esm/admin/product-collection.d.ts.map +0 -1
  224. package/dist/esm/admin/product-collection.js +0 -220
  225. package/dist/esm/admin/product-collection.js.map +0 -1
  226. package/dist/esm/admin/product-tag.d.ts +0 -149
  227. package/dist/esm/admin/product-tag.d.ts.map +0 -1
  228. package/dist/esm/admin/product-tag.js +0 -192
  229. package/dist/esm/admin/product-tag.js.map +0 -1
  230. package/dist/esm/admin/product-type.d.ts +0 -150
  231. package/dist/esm/admin/product-type.d.ts.map +0 -1
  232. package/dist/esm/admin/product-type.js +0 -193
  233. package/dist/esm/admin/product-type.js.map +0 -1
  234. package/dist/esm/admin/product-variant.d.ts +0 -62
  235. package/dist/esm/admin/product-variant.d.ts.map +0 -1
  236. package/dist/esm/admin/product-variant.js +0 -73
  237. package/dist/esm/admin/product-variant.js.map +0 -1
  238. package/dist/esm/admin/product.d.ts +0 -740
  239. package/dist/esm/admin/product.d.ts.map +0 -1
  240. package/dist/esm/admin/product.js +0 -995
  241. package/dist/esm/admin/product.js.map +0 -1
  242. package/dist/esm/admin/promotion.d.ts +0 -310
  243. package/dist/esm/admin/promotion.d.ts.map +0 -1
  244. package/dist/esm/admin/promotion.js +0 -401
  245. package/dist/esm/admin/promotion.js.map +0 -1
  246. package/dist/esm/admin/refund-reasons.d.ts +0 -163
  247. package/dist/esm/admin/refund-reasons.d.ts.map +0 -1
  248. package/dist/esm/admin/refund-reasons.js +0 -207
  249. package/dist/esm/admin/refund-reasons.js.map +0 -1
  250. package/dist/esm/admin/region.d.ts +0 -152
  251. package/dist/esm/admin/region.d.ts.map +0 -1
  252. package/dist/esm/admin/region.js +0 -195
  253. package/dist/esm/admin/region.js.map +0 -1
  254. package/dist/esm/admin/reservation.d.ts +0 -154
  255. package/dist/esm/admin/reservation.d.ts.map +0 -1
  256. package/dist/esm/admin/reservation.js +0 -199
  257. package/dist/esm/admin/reservation.js.map +0 -1
  258. package/dist/esm/admin/return-reason.d.ts +0 -154
  259. package/dist/esm/admin/return-reason.d.ts.map +0 -1
  260. package/dist/esm/admin/return-reason.js +0 -198
  261. package/dist/esm/admin/return-reason.js.map +0 -1
  262. package/dist/esm/admin/return.d.ts +0 -558
  263. package/dist/esm/admin/return.d.ts.map +0 -1
  264. package/dist/esm/admin/return.js +0 -749
  265. package/dist/esm/admin/return.js.map +0 -1
  266. package/dist/esm/admin/sales-channel.d.ts +0 -196
  267. package/dist/esm/admin/sales-channel.d.ts.map +0 -1
  268. package/dist/esm/admin/sales-channel.js +0 -257
  269. package/dist/esm/admin/sales-channel.js.map +0 -1
  270. package/dist/esm/admin/shipping-option-type.d.ts +0 -152
  271. package/dist/esm/admin/shipping-option-type.d.ts.map +0 -1
  272. package/dist/esm/admin/shipping-option-type.js +0 -195
  273. package/dist/esm/admin/shipping-option-type.js.map +0 -1
  274. package/dist/esm/admin/shipping-option.d.ts +0 -171
  275. package/dist/esm/admin/shipping-option.d.ts.map +0 -1
  276. package/dist/esm/admin/shipping-option.js +0 -224
  277. package/dist/esm/admin/shipping-option.js.map +0 -1
  278. package/dist/esm/admin/shipping-profile.d.ts +0 -151
  279. package/dist/esm/admin/shipping-profile.d.ts.map +0 -1
  280. package/dist/esm/admin/shipping-profile.js +0 -196
  281. package/dist/esm/admin/shipping-profile.js.map +0 -1
  282. package/dist/esm/admin/stock-location.d.ts +0 -212
  283. package/dist/esm/admin/stock-location.d.ts.map +0 -1
  284. package/dist/esm/admin/stock-location.js +0 -281
  285. package/dist/esm/admin/stock-location.js.map +0 -1
  286. package/dist/esm/admin/tax-provider.d.ts +0 -64
  287. package/dist/esm/admin/tax-provider.d.ts.map +0 -1
  288. package/dist/esm/admin/tax-provider.js +0 -77
  289. package/dist/esm/admin/tax-provider.js.map +0 -1
  290. package/dist/esm/admin/tax-rate.d.ts +0 -155
  291. package/dist/esm/admin/tax-rate.d.ts.map +0 -1
  292. package/dist/esm/admin/tax-rate.js +0 -201
  293. package/dist/esm/admin/tax-rate.js.map +0 -1
  294. package/dist/esm/admin/tax-region.d.ts +0 -165
  295. package/dist/esm/admin/tax-region.d.ts.map +0 -1
  296. package/dist/esm/admin/tax-region.js +0 -211
  297. package/dist/esm/admin/tax-region.js.map +0 -1
@@ -1,169 +0,0 @@
1
- import { HttpTypes } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class ProductCollection {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method creates a product collection. It sends a request to the
15
- * [Create Collection](https://docs.acmekit.com/api/admin#collections_postcollections)
16
- * API route.
17
- *
18
- * @param body - The details of the product collection to create.
19
- * @param query - Configure the fields to retrieve in the product collection.
20
- * @param headers - Headers to pass in the request
21
- * @returns The product collection's details.
22
- *
23
- * @example
24
- * sdk.admin.productCollection.create({
25
- * title: "Summer Collection"
26
- * })
27
- * .then(({ collection }) => {
28
- * console.log(collection)
29
- * })
30
- */
31
- create(body: HttpTypes.AdminCreateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
32
- /**
33
- * This method updates a collection. It sends a request to the
34
- * [Update Collection](https://docs.acmekit.com/api/admin#collections_postcollectionsid)
35
- * API route.
36
- *
37
- * @param id - The ID of the collection.
38
- * @param body - The data to update in the collection.
39
- * @param query - Configure the fields to retrieve in the product collection.
40
- * @param headers - Headers to pass in the request
41
- * @returns The product collection's details.
42
- *
43
- * @example
44
- * sdk.admin.productCollection.update("pcol_123", {
45
- * title: "Summer Collection"
46
- * })
47
- * .then(({ collection }) => {
48
- * console.log(collection)
49
- * })
50
- */
51
- update(id: string, body: HttpTypes.AdminUpdateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
52
- /**
53
- * This method retrieves a paginated list of collections. It sends a request to the
54
- * [List Collections](https://docs.acmekit.com/api/admin#collections_getcollections) API route.
55
- *
56
- * @param queryParams - Filters and pagination configurations.
57
- * @param headers - Headers to pass in the request.
58
- * @returns The paginated list of collections.
59
- *
60
- * @example
61
- * To retrieve the list of collections:
62
- *
63
- * ```ts
64
- * sdk.admin.productCollection.list()
65
- * .then(({ collections, count, limit, offset }) => {
66
- * console.log(collections)
67
- * })
68
- * ```
69
- *
70
- * To configure the pagination, pass the `limit` and `offset` query parameters.
71
- *
72
- * For example, to retrieve only 10 items and skip 10 items:
73
- *
74
- * ```ts
75
- * sdk.admin.productCollection.list({
76
- * limit: 10,
77
- * offset: 10
78
- * })
79
- * .then(({ collections, count, limit, offset }) => {
80
- * console.log(collections)
81
- * })
82
- * ```
83
- *
84
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
85
- * in each collection:
86
- *
87
- * ```ts
88
- * sdk.admin.productCollection.list({
89
- * fields: "id,*products"
90
- * })
91
- * .then(({ collections, count, limit, offset }) => {
92
- * console.log(collections)
93
- * })
94
- * ```
95
- *
96
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
97
- */
98
- list(queryParams?: HttpTypes.AdminCollectionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionListResponse>;
99
- /**
100
- * This method retrieves a collection by its ID. It sends a request to the
101
- * [Get Collection](https://docs.acmekit.com/api/admin#collections_getcollectionsid) API route.
102
- *
103
- * @param id - The collection's ID.
104
- * @param query - Configure the fields to retrieve in the collection.
105
- * @param headers - Headers to pass in the request
106
- * @returns The collection's details.
107
- *
108
- * @example
109
- * To retrieve a collection by its ID:
110
- *
111
- * ```ts
112
- * sdk.admin.productCollection.retrieve("pcol_123")
113
- * .then(({ collection }) => {
114
- * console.log(collection)
115
- * })
116
- * ```
117
- *
118
- * To specify the fields and relations to retrieve:
119
- *
120
- * ```ts
121
- * sdk.admin.productCollection.retrieve("pcol_123", {
122
- * fields: "id,*products"
123
- * })
124
- * .then(({ collection }) => {
125
- * console.log(collection)
126
- * })
127
- * ```
128
- *
129
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
130
- */
131
- retrieve(id: string, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
132
- /**
133
- * This method deletes a product collection. It sends a request to the
134
- * [Delete Collection](https://docs.acmekit.com/api/admin#collections_deletecollectionsid)
135
- * API route.
136
- *
137
- * @param id - The collection's ID.
138
- * @param headers - Headers to pass in the request
139
- * @returns The deletion's details.
140
- *
141
- * @example
142
- * sdk.admin.productCollection.delete("pcol_123")
143
- * .then(({ deleted }) => {
144
- * console.log(deleted)
145
- * })
146
- */
147
- delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionDeleteResponse>;
148
- /**
149
- * This method manages the products of a collection to add or remove them. It sends a request
150
- * to the [Manage Products](https://docs.acmekit.com/api/admin#collections_postcollectionsidproducts)
151
- * API route.
152
- *
153
- * @param id - The collection's ID.
154
- * @param body - The products to add or remove.
155
- * @param headers - Headers to pass in the request
156
- * @returns The product category's details.
157
- *
158
- * @example
159
- * sdk.admin.productCollection.updateProducts("pcol_123", {
160
- * add: ["prod_123"],
161
- * remove: ["prod_321"]
162
- * })
163
- * .then(({ collection }) => {
164
- * console.log(collection)
165
- * })
166
- */
167
- updateProducts(id: string, body: HttpTypes.AdminUpdateCollectionProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
168
- }
169
- //# sourceMappingURL=product-collection.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../src/admin/product-collection.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,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
@@ -1,203 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ProductCollection = void 0;
4
- class ProductCollection {
5
- /**
6
- * @ignore
7
- */
8
- constructor(client) {
9
- this.client = client;
10
- }
11
- /**
12
- * This method creates a product collection. It sends a request to the
13
- * [Create Collection](https://docs.acmekit.com/api/admin#collections_postcollections)
14
- * API route.
15
- *
16
- * @param body - The details of the product collection to create.
17
- * @param query - Configure the fields to retrieve in the product collection.
18
- * @param headers - Headers to pass in the request
19
- * @returns The product collection's details.
20
- *
21
- * @example
22
- * sdk.admin.productCollection.create({
23
- * title: "Summer Collection"
24
- * })
25
- * .then(({ collection }) => {
26
- * console.log(collection)
27
- * })
28
- */
29
- async create(body, query, headers) {
30
- return this.client.fetch(`/admin/collections`, {
31
- method: "POST",
32
- headers,
33
- body,
34
- query,
35
- });
36
- }
37
- /**
38
- * This method updates a collection. It sends a request to the
39
- * [Update Collection](https://docs.acmekit.com/api/admin#collections_postcollectionsid)
40
- * API route.
41
- *
42
- * @param id - The ID of the collection.
43
- * @param body - The data to update in the collection.
44
- * @param query - Configure the fields to retrieve in the product collection.
45
- * @param headers - Headers to pass in the request
46
- * @returns The product collection's details.
47
- *
48
- * @example
49
- * sdk.admin.productCollection.update("pcol_123", {
50
- * title: "Summer Collection"
51
- * })
52
- * .then(({ collection }) => {
53
- * console.log(collection)
54
- * })
55
- */
56
- async update(id, body, query, headers) {
57
- return this.client.fetch(`/admin/collections/${id}`, {
58
- method: "POST",
59
- headers,
60
- body,
61
- query,
62
- });
63
- }
64
- /**
65
- * This method retrieves a paginated list of collections. It sends a request to the
66
- * [List Collections](https://docs.acmekit.com/api/admin#collections_getcollections) API route.
67
- *
68
- * @param queryParams - Filters and pagination configurations.
69
- * @param headers - Headers to pass in the request.
70
- * @returns The paginated list of collections.
71
- *
72
- * @example
73
- * To retrieve the list of collections:
74
- *
75
- * ```ts
76
- * sdk.admin.productCollection.list()
77
- * .then(({ collections, count, limit, offset }) => {
78
- * console.log(collections)
79
- * })
80
- * ```
81
- *
82
- * To configure the pagination, pass the `limit` and `offset` query parameters.
83
- *
84
- * For example, to retrieve only 10 items and skip 10 items:
85
- *
86
- * ```ts
87
- * sdk.admin.productCollection.list({
88
- * limit: 10,
89
- * offset: 10
90
- * })
91
- * .then(({ collections, count, limit, offset }) => {
92
- * console.log(collections)
93
- * })
94
- * ```
95
- *
96
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
97
- * in each collection:
98
- *
99
- * ```ts
100
- * sdk.admin.productCollection.list({
101
- * fields: "id,*products"
102
- * })
103
- * .then(({ collections, count, limit, offset }) => {
104
- * console.log(collections)
105
- * })
106
- * ```
107
- *
108
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
109
- */
110
- async list(queryParams, headers) {
111
- return this.client.fetch(`/admin/collections`, {
112
- headers,
113
- query: queryParams,
114
- });
115
- }
116
- /**
117
- * This method retrieves a collection by its ID. It sends a request to the
118
- * [Get Collection](https://docs.acmekit.com/api/admin#collections_getcollectionsid) API route.
119
- *
120
- * @param id - The collection's ID.
121
- * @param query - Configure the fields to retrieve in the collection.
122
- * @param headers - Headers to pass in the request
123
- * @returns The collection's details.
124
- *
125
- * @example
126
- * To retrieve a collection by its ID:
127
- *
128
- * ```ts
129
- * sdk.admin.productCollection.retrieve("pcol_123")
130
- * .then(({ collection }) => {
131
- * console.log(collection)
132
- * })
133
- * ```
134
- *
135
- * To specify the fields and relations to retrieve:
136
- *
137
- * ```ts
138
- * sdk.admin.productCollection.retrieve("pcol_123", {
139
- * fields: "id,*products"
140
- * })
141
- * .then(({ collection }) => {
142
- * console.log(collection)
143
- * })
144
- * ```
145
- *
146
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
147
- */
148
- async retrieve(id, query, headers) {
149
- return this.client.fetch(`/admin/collections/${id}`, {
150
- query,
151
- headers,
152
- });
153
- }
154
- /**
155
- * This method deletes a product collection. It sends a request to the
156
- * [Delete Collection](https://docs.acmekit.com/api/admin#collections_deletecollectionsid)
157
- * API route.
158
- *
159
- * @param id - The collection's ID.
160
- * @param headers - Headers to pass in the request
161
- * @returns The deletion's details.
162
- *
163
- * @example
164
- * sdk.admin.productCollection.delete("pcol_123")
165
- * .then(({ deleted }) => {
166
- * console.log(deleted)
167
- * })
168
- */
169
- async delete(id, headers) {
170
- return this.client.fetch(`/admin/collections/${id}`, {
171
- method: "DELETE",
172
- headers,
173
- });
174
- }
175
- /**
176
- * This method manages the products of a collection to add or remove them. It sends a request
177
- * to the [Manage Products](https://docs.acmekit.com/api/admin#collections_postcollectionsidproducts)
178
- * API route.
179
- *
180
- * @param id - The collection's ID.
181
- * @param body - The products to add or remove.
182
- * @param headers - Headers to pass in the request
183
- * @returns The product category's details.
184
- *
185
- * @example
186
- * sdk.admin.productCollection.updateProducts("pcol_123", {
187
- * add: ["prod_123"],
188
- * remove: ["prod_321"]
189
- * })
190
- * .then(({ collection }) => {
191
- * console.log(collection)
192
- * })
193
- */
194
- async updateProducts(id, body, headers) {
195
- return this.client.fetch(`/admin/collections/${id}/products`, {
196
- method: "POST",
197
- headers,
198
- body,
199
- });
200
- }
201
- }
202
- exports.ProductCollection = ProductCollection;
203
- //# sourceMappingURL=product-collection.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../src/admin/product-collection.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,WAAiD,EACjD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AArPD,8CAqPC"}
@@ -1,149 +0,0 @@
1
- import { HttpTypes } from "@acmekit/types";
2
- import { Client } from "../client";
3
- import { ClientHeaders } from "../types";
4
- export declare class ProductTag {
5
- /**
6
- * @ignore
7
- */
8
- private client;
9
- /**
10
- * @ignore
11
- */
12
- constructor(client: Client);
13
- /**
14
- * This method creates a product tag. It sends a request to the
15
- * [Create Product Tag](https://docs.acmekit.com/api/admin#product-tags_postproducttags)
16
- * API route.
17
- *
18
- * @param body - The details of the product tag.
19
- * @param query - Configure the fields to retrieve in the product tag.
20
- * @param headers - Headers to pass in the request
21
- * @returns The product tag's details.
22
- *
23
- * @example
24
- * sdk.admin.productTag.create({
25
- * value: "shirt"
26
- * })
27
- * .then(({ product_tag }) => {
28
- * console.log(product_tag)
29
- * })
30
- */
31
- create(body: HttpTypes.AdminCreateProductTag, query?: HttpTypes.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
32
- /**
33
- * This method updates a tag's details. It sends a request to the
34
- * [Update Product Tag](https://docs.acmekit.com/api/admin#product-tags_postproducttagsid)
35
- * API route.
36
- *
37
- * @param id - The tag's ID.
38
- * @param body - The data to update in the tag.
39
- * @param query - Configure the fields to retrieve in the product tag.
40
- * @param headers - Headers to pass in the request
41
- * @returns The product tag's details.
42
- *
43
- * @example
44
- * sdk.admin.productTag.update("ptag_123", {
45
- * value: "shirt"
46
- * })
47
- * .then(({ product_tag }) => {
48
- * console.log(product_tag)
49
- * })
50
- */
51
- update(id: string, body: HttpTypes.AdminUpdateProductTag, query?: HttpTypes.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
52
- /**
53
- * This method retrieves a paginated list of product tags. It sends a request to the
54
- * [List Product Tags](https://docs.acmekit.com/api/admin#product-tags_getproducttags) API route.
55
- *
56
- * @param query - Filters and pagination configurations.
57
- * @param headers - Headers to pass in the request.
58
- * @returns The paginated list of product tags.
59
- *
60
- * @example
61
- * To retrieve the list of product tags:
62
- *
63
- * ```ts
64
- * sdk.admin.productTag.list()
65
- * .then(({ product_tags, count, limit, offset }) => {
66
- * console.log(product_tags)
67
- * })
68
- * ```
69
- *
70
- * To configure the pagination, pass the `limit` and `offset` query parameters.
71
- *
72
- * For example, to retrieve only 10 items and skip 10 items:
73
- *
74
- * ```ts
75
- * sdk.admin.productTag.list({
76
- * limit: 10,
77
- * offset: 10
78
- * })
79
- * .then(({ product_tags, count, limit, offset }) => {
80
- * console.log(product_tags)
81
- * })
82
- * ```
83
- *
84
- * Using the `fields` query parameter, you can specify the fields and relations to retrieve
85
- * in each product tag:
86
- *
87
- * ```ts
88
- * sdk.admin.productTag.list({
89
- * fields: "id,*products"
90
- * })
91
- * .then(({ product_tags, count, limit, offset }) => {
92
- * console.log(product_tags)
93
- * })
94
- * ```
95
- *
96
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
97
- */
98
- list(query?: HttpTypes.AdminProductTagListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagListResponse>;
99
- /**
100
- * This method retrieves a product tag by its ID. It sends a request to the
101
- * [Get Product Tag](https://docs.acmekit.com/api/admin#product-tags_getproducttagsid) API route.
102
- *
103
- * @param id - The product tag's ID.
104
- * @param query - Configure the fields to retrieve in the product tag.
105
- * @param headers - Headers to pass in the request
106
- * @returns The product tag's details.
107
- *
108
- * @example
109
- * To retrieve a product tag by its ID:
110
- *
111
- * ```ts
112
- * sdk.admin.productTag.retrieve("ptag_123")
113
- * .then(({ product_tag }) => {
114
- * console.log(product_tag)
115
- * })
116
- * ```
117
- *
118
- * To specify the fields and relations to retrieve:
119
- *
120
- * ```ts
121
- * sdk.admin.productTag.retrieve("ptag_123", {
122
- * fields: "id,*products"
123
- * })
124
- * .then(({ product_tag }) => {
125
- * console.log(product_tag)
126
- * })
127
- * ```
128
- *
129
- * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
130
- */
131
- retrieve(id: string, query?: HttpTypes.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
132
- /**
133
- * This method deletes a product tag. It sends a request to the
134
- * [Delete Product Tag](https://docs.acmekit.com/api/admin#product-tags_deleteproducttagsid)
135
- * API route.
136
- *
137
- * @param id - The tag's ID.
138
- * @param headers - Headers to pass in the request
139
- * @returns The deletion's details.
140
- *
141
- * @example
142
- * sdk.admin.productTag.delete("ptag_123")
143
- * .then(({ deleted }) => {
144
- * console.log(deleted)
145
- * })
146
- */
147
- delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagDeleteResponse>;
148
- }
149
- //# sourceMappingURL=product-tag.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"product-tag.d.ts","sourceRoot":"","sources":["../../src/admin/product-tag.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,UAAU;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAC3C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}