@medusajs/js-sdk 2.0.1-snapshot-20241025090810 → 2.0.1

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 (33) hide show
  1. package/dist/admin/price-list.d.ts +195 -1
  2. package/dist/admin/price-list.d.ts.map +1 -1
  3. package/dist/admin/price-list.js +194 -0
  4. package/dist/admin/price-list.js.map +1 -1
  5. package/dist/admin/price-preference.d.ts +133 -0
  6. package/dist/admin/price-preference.d.ts.map +1 -1
  7. package/dist/admin/price-preference.js +133 -0
  8. package/dist/admin/price-preference.js.map +1 -1
  9. package/dist/admin/product-category.d.ts +150 -0
  10. package/dist/admin/product-category.d.ts.map +1 -1
  11. package/dist/admin/product-category.js +150 -0
  12. package/dist/admin/product-category.js.map +1 -1
  13. package/dist/admin/product-collection.d.ts +149 -0
  14. package/dist/admin/product-collection.d.ts.map +1 -1
  15. package/dist/admin/product-collection.js +149 -0
  16. package/dist/admin/product-collection.js.map +1 -1
  17. package/dist/esm/admin/price-list.d.ts +195 -1
  18. package/dist/esm/admin/price-list.d.ts.map +1 -1
  19. package/dist/esm/admin/price-list.js +194 -0
  20. package/dist/esm/admin/price-list.js.map +1 -1
  21. package/dist/esm/admin/price-preference.d.ts +133 -0
  22. package/dist/esm/admin/price-preference.d.ts.map +1 -1
  23. package/dist/esm/admin/price-preference.js +133 -0
  24. package/dist/esm/admin/price-preference.js.map +1 -1
  25. package/dist/esm/admin/product-category.d.ts +150 -0
  26. package/dist/esm/admin/product-category.d.ts.map +1 -1
  27. package/dist/esm/admin/product-category.js +150 -0
  28. package/dist/esm/admin/product-category.js.map +1 -1
  29. package/dist/esm/admin/product-collection.d.ts +149 -0
  30. package/dist/esm/admin/product-collection.d.ts.map +1 -1
  31. package/dist/esm/admin/product-collection.js +149 -0
  32. package/dist/esm/admin/product-collection.js.map +1 -1
  33. package/package.json +2 -2
@@ -10,11 +10,161 @@ export declare class ProductCategory {
10
10
  * @ignore
11
11
  */
12
12
  constructor(client: Client);
13
+ /**
14
+ * This method creates a product category. It sends a request to the
15
+ * [Create Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategories)
16
+ * API route.
17
+ *
18
+ * @param body - The details of the category to create.
19
+ * @param query - Configure the fields to retrieve in the category.
20
+ * @param headers - Headers to pass in the request
21
+ * @returns The category's details.
22
+ *
23
+ * @example
24
+ * sdk.admin.productCategory.create({
25
+ * name: "Shirts"
26
+ * })
27
+ * .then(({ product_category }) => {
28
+ * console.log(product_category)
29
+ * })
30
+ */
13
31
  create(body: HttpTypes.AdminCreateProductCategory, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
32
+ /**
33
+ * This method updates a product category. It sends a request to the
34
+ * [Update Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesid)
35
+ * API route.
36
+ *
37
+ * @param id - The product category's ID.
38
+ * @param body - The data to update in the category.
39
+ * @param query - Configure the fields to retrieve in the category.
40
+ * @param headers - Headers to pass in the request
41
+ * @returns The category's details.
42
+ *
43
+ * @example
44
+ * sdk.admin.productCategory.update("pcat_123", {
45
+ * name: "Shirts"
46
+ * })
47
+ * .then(({ product_category }) => {
48
+ * console.log(product_category)
49
+ * })
50
+ */
14
51
  update(id: string, body: HttpTypes.AdminUpdateProductCategory, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
52
+ /**
53
+ * This method retrieves a paginated list of product categories. It sends a request to the
54
+ * [List Product Categories](https://docs.medusajs.com/api/admin#product-categories_getproductcategories) 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 categories.
59
+ *
60
+ * @example
61
+ * To retrieve the list of product categories:
62
+ *
63
+ * ```ts
64
+ * sdk.admin.productCategory.list()
65
+ * .then(({ product_categories, count, limit, offset }) => {
66
+ * console.log(product_categories)
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.productCategory.list({
76
+ * limit: 10,
77
+ * offset: 10
78
+ * })
79
+ * .then(({ product_categories, count, limit, offset }) => {
80
+ * console.log(product_categories)
81
+ * })
82
+ * ```
83
+ *
84
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
85
+ * in each product category:
86
+ *
87
+ * ```ts
88
+ * sdk.admin.productCategory.list({
89
+ * fields: "id,*products"
90
+ * })
91
+ * .then(({ product_categories, count, limit, offset }) => {
92
+ * console.log(product_categories)
93
+ * })
94
+ * ```
95
+ *
96
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
97
+ */
15
98
  list(query?: HttpTypes.AdminProductCategoryListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryListResponse>;
99
+ /**
100
+ * This method retrieves a product category by its ID. It sends a request to the
101
+ * [Get Product Category](https://docs.medusajs.com/api/admin#product-categories_getproductcategoriesid) API route.
102
+ *
103
+ * @param id - The category's ID.
104
+ * @param query - Configure the fields to retrieve in the product category.
105
+ * @param headers - Headers to pass in the request
106
+ * @returns The product category's details.
107
+ *
108
+ * @example
109
+ * To retrieve a product category by its ID:
110
+ *
111
+ * ```ts
112
+ * sdk.admin.productCategory.retrieve("pcat_123")
113
+ * .then(({ product_category }) => {
114
+ * console.log(product_category)
115
+ * })
116
+ * ```
117
+ *
118
+ * To specify the fields and relations to retrieve:
119
+ *
120
+ * ```ts
121
+ * sdk.admin.productCategory.retrieve("pcat_123", {
122
+ * fields: "id,*products"
123
+ * })
124
+ * .then(({ product_category }) => {
125
+ * console.log(product_category)
126
+ * })
127
+ * ```
128
+ *
129
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
130
+ */
16
131
  retrieve(id: string, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
132
+ /**
133
+ * This method deletes a product category. It sends a request to the
134
+ * [Delete Product Category](https://docs.medusajs.com/api/admin#product-categories_deleteproductcategoriesid)
135
+ * API route.
136
+ *
137
+ * @param id - The category's ID.
138
+ * @param headers - Headers to pass in the request
139
+ * @returns The deletion's details.
140
+ *
141
+ * @example
142
+ * sdk.admin.productCategory.delete("pcat_123")
143
+ * .then(({ deleted }) => {
144
+ * console.log(deleted)
145
+ * })
146
+ */
17
147
  delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryDeleteResponse>;
148
+ /**
149
+ * This method manaes the products of a category to add or remove them. It sends a request
150
+ * to the [Manage Products](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesidproducts)
151
+ * API route.
152
+ *
153
+ * @param id - The category's ID.
154
+ * @param body - The products to create or update.
155
+ * @param query - Configure the fields to retrieve in the product category.
156
+ * @param headers - Headers to pass in the request
157
+ * @returns The product category's details.
158
+ *
159
+ * @example
160
+ * sdk.admin.productCategory.updateProducts("pcat_123", {
161
+ * add: ["prod_123"],
162
+ * remove: ["prod_321"]
163
+ * })
164
+ * .then(({ product_category }) => {
165
+ * console.log(product_category)
166
+ * })
167
+ */
18
168
  updateProducts(id: string, body: HttpTypes.AdminUpdateProductCategoryProducts, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
19
169
  }
20
170
  //# sourceMappingURL=product-category.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"product-category.d.ts","sourceRoot":"","sources":["../../../src/admin/product-category.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,eAAe;IAC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kCAAkC,EAClD,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;CAY1B"}
1
+ {"version":3,"file":"product-category.d.ts","sourceRoot":"","sources":["../../../src/admin/product-category.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,eAAe;IAC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kCAAkC,EAClD,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;CAY1B"}
@@ -14,6 +14,24 @@ export class ProductCategory {
14
14
  constructor(client) {
15
15
  this.client = client;
16
16
  }
17
+ /**
18
+ * This method creates a product category. It sends a request to the
19
+ * [Create Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategories)
20
+ * API route.
21
+ *
22
+ * @param body - The details of the category to create.
23
+ * @param query - Configure the fields to retrieve in the category.
24
+ * @param headers - Headers to pass in the request
25
+ * @returns The category's details.
26
+ *
27
+ * @example
28
+ * sdk.admin.productCategory.create({
29
+ * name: "Shirts"
30
+ * })
31
+ * .then(({ product_category }) => {
32
+ * console.log(product_category)
33
+ * })
34
+ */
17
35
  create(body, query, headers) {
18
36
  return __awaiter(this, void 0, void 0, function* () {
19
37
  return this.client.fetch(`/admin/product-categories`, {
@@ -24,6 +42,25 @@ export class ProductCategory {
24
42
  });
25
43
  });
26
44
  }
45
+ /**
46
+ * This method updates a product category. It sends a request to the
47
+ * [Update Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesid)
48
+ * API route.
49
+ *
50
+ * @param id - The product category's ID.
51
+ * @param body - The data to update in the category.
52
+ * @param query - Configure the fields to retrieve in the category.
53
+ * @param headers - Headers to pass in the request
54
+ * @returns The category's details.
55
+ *
56
+ * @example
57
+ * sdk.admin.productCategory.update("pcat_123", {
58
+ * name: "Shirts"
59
+ * })
60
+ * .then(({ product_category }) => {
61
+ * console.log(product_category)
62
+ * })
63
+ */
27
64
  update(id, body, query, headers) {
28
65
  return __awaiter(this, void 0, void 0, function* () {
29
66
  return this.client.fetch(`/admin/product-categories/${id}`, {
@@ -34,6 +71,52 @@ export class ProductCategory {
34
71
  });
35
72
  });
36
73
  }
74
+ /**
75
+ * This method retrieves a paginated list of product categories. It sends a request to the
76
+ * [List Product Categories](https://docs.medusajs.com/api/admin#product-categories_getproductcategories) API route.
77
+ *
78
+ * @param query - Filters and pagination configurations.
79
+ * @param headers - Headers to pass in the request.
80
+ * @returns The paginated list of product categories.
81
+ *
82
+ * @example
83
+ * To retrieve the list of product categories:
84
+ *
85
+ * ```ts
86
+ * sdk.admin.productCategory.list()
87
+ * .then(({ product_categories, count, limit, offset }) => {
88
+ * console.log(product_categories)
89
+ * })
90
+ * ```
91
+ *
92
+ * To configure the pagination, pass the `limit` and `offset` query parameters.
93
+ *
94
+ * For example, to retrieve only 10 items and skip 10 items:
95
+ *
96
+ * ```ts
97
+ * sdk.admin.productCategory.list({
98
+ * limit: 10,
99
+ * offset: 10
100
+ * })
101
+ * .then(({ product_categories, count, limit, offset }) => {
102
+ * console.log(product_categories)
103
+ * })
104
+ * ```
105
+ *
106
+ * Using the `fields` query parameter, you can specify the fields and relations to retrieve
107
+ * in each product category:
108
+ *
109
+ * ```ts
110
+ * sdk.admin.productCategory.list({
111
+ * fields: "id,*products"
112
+ * })
113
+ * .then(({ product_categories, count, limit, offset }) => {
114
+ * console.log(product_categories)
115
+ * })
116
+ * ```
117
+ *
118
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
119
+ */
37
120
  list(query, headers) {
38
121
  return __awaiter(this, void 0, void 0, function* () {
39
122
  return this.client.fetch(`/admin/product-categories`, {
@@ -42,6 +125,38 @@ export class ProductCategory {
42
125
  });
43
126
  });
44
127
  }
128
+ /**
129
+ * This method retrieves a product category by its ID. It sends a request to the
130
+ * [Get Product Category](https://docs.medusajs.com/api/admin#product-categories_getproductcategoriesid) API route.
131
+ *
132
+ * @param id - The category's ID.
133
+ * @param query - Configure the fields to retrieve in the product category.
134
+ * @param headers - Headers to pass in the request
135
+ * @returns The product category's details.
136
+ *
137
+ * @example
138
+ * To retrieve a product category by its ID:
139
+ *
140
+ * ```ts
141
+ * sdk.admin.productCategory.retrieve("pcat_123")
142
+ * .then(({ product_category }) => {
143
+ * console.log(product_category)
144
+ * })
145
+ * ```
146
+ *
147
+ * To specify the fields and relations to retrieve:
148
+ *
149
+ * ```ts
150
+ * sdk.admin.productCategory.retrieve("pcat_123", {
151
+ * fields: "id,*products"
152
+ * })
153
+ * .then(({ product_category }) => {
154
+ * console.log(product_category)
155
+ * })
156
+ * ```
157
+ *
158
+ * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
159
+ */
45
160
  retrieve(id, query, headers) {
46
161
  return __awaiter(this, void 0, void 0, function* () {
47
162
  return this.client.fetch(`/admin/product-categories/${id}`, {
@@ -50,6 +165,21 @@ export class ProductCategory {
50
165
  });
51
166
  });
52
167
  }
168
+ /**
169
+ * This method deletes a product category. It sends a request to the
170
+ * [Delete Product Category](https://docs.medusajs.com/api/admin#product-categories_deleteproductcategoriesid)
171
+ * API route.
172
+ *
173
+ * @param id - The category's ID.
174
+ * @param headers - Headers to pass in the request
175
+ * @returns The deletion's details.
176
+ *
177
+ * @example
178
+ * sdk.admin.productCategory.delete("pcat_123")
179
+ * .then(({ deleted }) => {
180
+ * console.log(deleted)
181
+ * })
182
+ */
53
183
  delete(id, headers) {
54
184
  return __awaiter(this, void 0, void 0, function* () {
55
185
  return this.client.fetch(`/admin/product-categories/${id}`, {
@@ -58,6 +188,26 @@ export class ProductCategory {
58
188
  });
59
189
  });
60
190
  }
191
+ /**
192
+ * This method manaes the products of a category to add or remove them. It sends a request
193
+ * to the [Manage Products](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesidproducts)
194
+ * API route.
195
+ *
196
+ * @param id - The category's ID.
197
+ * @param body - The products to create or update.
198
+ * @param query - Configure the fields to retrieve in the product category.
199
+ * @param headers - Headers to pass in the request
200
+ * @returns The product category's details.
201
+ *
202
+ * @example
203
+ * sdk.admin.productCategory.updateProducts("pcat_123", {
204
+ * add: ["prod_123"],
205
+ * remove: ["prod_321"]
206
+ * })
207
+ * .then(({ product_category }) => {
208
+ * console.log(product_category)
209
+ * })
210
+ */
61
211
  updateProducts(id, body, query, headers) {
62
212
  return __awaiter(this, void 0, void 0, function* () {
63
213
  return this.client.fetch(`/admin/product-categories/${id}/products`, {
@@ -1 +1 @@
1
- {"version":3,"file":"product-category.js","sourceRoot":"","sources":["../../../src/admin/product-category.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,eAAe;IAK1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAAgD,EAChD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;gBACE,OAAO;gBACP,KAAK,EAAE,KAAK;aACb,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAAkD,EAClD,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,WAAW,EAC1C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
1
+ {"version":3,"file":"product-category.js","sourceRoot":"","sources":["../../../src/admin/product-category.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,eAAe;IAK1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAgD,EAChD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;gBACE,OAAO;gBACP,KAAK,EAAE,KAAK;aACb,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAClB,EAAU,EACV,IAAkD,EAClD,KAA4C,EAC5C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,WAAW,EAC1C;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
@@ -10,11 +10,160 @@ export declare class ProductCollection {
10
10
  * @ignore
11
11
  */
12
12
  constructor(client: Client);
13
+ /**
14
+ * This method creates a product collection. It sends a request to the
15
+ * [Create Collection](https://docs.medusajs.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
+ */
13
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.medusajs.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
+ */
14
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.medusajs.com/api/admin#collections_getcollections) 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 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.medusajs.com/api/store#select-fields-and-relations).
97
+ */
15
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.medusajs.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.medusajs.com/api/store#select-fields-and-relations).
130
+ */
16
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.medusajs.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
+ */
17
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.medusajs.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
+ */
18
167
  updateProducts(id: string, body: HttpTypes.AdminUpdateCollectionProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
19
168
  }
20
169
  //# sourceMappingURL=product-collection.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,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;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,qBAAqB,EACrC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,yBAAyB,EACjD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,6BAA6B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
1
+ {"version":3,"file":"product-collection.d.ts","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,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"}