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

package/dist/admin/product-category.d.ts

@@ -10,11 +10,161 @@ export declare class ProductCategory {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a product category. It sends a request to the
+     * [Create Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategories)
+     * API route.
+     *
+     * @param body - The details of the category to create.
+     * @param query - Configure the fields to retrieve in the category.
+     * @param headers - Headers to pass in the request
+     * @returns The category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.create({
+     *   name: "Shirts"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     create(body: HttpTypes.AdminCreateProductCategory, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
+    /**
+     * This method updates a product category. It sends a request to the
+     * [Update Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesid)
+     * API route.
+     *
+     * @param id - The product category's ID.
+     * @param body - The data to update in the category.
+     * @param query - Configure the fields to retrieve in the category.
+     * @param headers - Headers to pass in the request
+     * @returns The category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.update("pcat_123", {
+     *   name: "Shirts"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateProductCategory, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
+    /**
+     * This method retrieves a paginated list of product categories. It sends a request to the
+     * [List Product Categories](https://docs.medusajs.com/api/admin#product-categories_getproductcategories) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product categories.
+     *
+     * @example
+     * To retrieve the list of product categories:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list()
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product category:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminProductCategoryListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryListResponse>;
+    /**
+     * This method retrieves a product category by its ID. It sends a request to the
+     * [Get Product Category](https://docs.medusajs.com/api/admin#product-categories_getproductcategoriesid) API route.
+     *
+     * @param id - The category's ID.
+     * @param query - Configure the fields to retrieve in the product category.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * To retrieve a product category by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCategory.retrieve("pcat_123")
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCategory.retrieve("pcat_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
+    /**
+     * This method deletes a product category. It sends a request to the
+     * [Delete Product Category](https://docs.medusajs.com/api/admin#product-categories_deleteproductcategoriesid)
+     * API route.
+     *
+     * @param id - The category's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCategory.delete("pcat_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryDeleteResponse>;
+    /**
+     * This method manaes the products of a category to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesidproducts)
+     * API route.
+     *
+     * @param id - The category's ID.
+     * @param body - The products to create or update.
+     * @param query - Configure the fields to retrieve in the product category.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.updateProducts("pcat_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     updateProducts(id: string, body: HttpTypes.AdminUpdateProductCategoryProducts, query?: HttpTypes.AdminProductCategoryParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductCategoryResponse>;
 }
 //# sourceMappingURL=product-category.d.ts.map

package/dist/admin/product-category.d.ts.map

@@ -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"}
+{"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"}

package/dist/admin/product-category.js

@@ -8,6 +8,24 @@ class ProductCategory {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a product category. It sends a request to the
+     * [Create Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategories)
+     * API route.
+     *
+     * @param body - The details of the category to create.
+     * @param query - Configure the fields to retrieve in the category.
+     * @param headers - Headers to pass in the request
+     * @returns The category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.create({
+     *   name: "Shirts"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/product-categories`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ProductCategory {
             query,
         });
     }
+    /**
+     * This method updates a product category. It sends a request to the
+     * [Update Category](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesid)
+     * API route.
+     *
+     * @param id - The product category's ID.
+     * @param body - The data to update in the category.
+     * @param query - Configure the fields to retrieve in the category.
+     * @param headers - Headers to pass in the request
+     * @returns The category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.update("pcat_123", {
+     *   name: "Shirts"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/product-categories/${id}`, {
             method: "POST",
@@ -24,24 +61,137 @@ class ProductCategory {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of product categories. It sends a request to the
+     * [List Product Categories](https://docs.medusajs.com/api/admin#product-categories_getproductcategories) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product categories.
+     *
+     * @example
+     * To retrieve the list of product categories:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list()
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product category:
+     *
+     * ```ts
+     * sdk.admin.productCategory.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_categories, count, limit, offset }) => {
+     *   console.log(product_categories)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async list(query, headers) {
         return this.client.fetch(`/admin/product-categories`, {
             headers,
             query: query,
         });
     }
+    /**
+     * This method retrieves a product category by its ID. It sends a request to the
+     * [Get Product Category](https://docs.medusajs.com/api/admin#product-categories_getproductcategoriesid) API route.
+     *
+     * @param id - The category's ID.
+     * @param query - Configure the fields to retrieve in the product category.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * To retrieve a product category by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCategory.retrieve("pcat_123")
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCategory.retrieve("pcat_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return this.client.fetch(`/admin/product-categories/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a product category. It sends a request to the
+     * [Delete Product Category](https://docs.medusajs.com/api/admin#product-categories_deleteproductcategoriesid)
+     * API route.
+     *
+     * @param id - The category's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCategory.delete("pcat_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/product-categories/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method manaes the products of a category to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#product-categories_postproductcategoriesidproducts)
+     * API route.
+     *
+     * @param id - The category's ID.
+     * @param body - The products to create or update.
+     * @param query - Configure the fields to retrieve in the product category.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCategory.updateProducts("pcat_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ product_category }) => {
+     *   console.log(product_category)
+     * })
+     */
     async updateProducts(id, body, query, headers) {
         return this.client.fetch(`/admin/product-categories/${id}/products`, {
             method: "POST",

package/dist/admin/product-category.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-category.js","sourceRoot":"","sources":["../../src/admin/product-category.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAK1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAAkD,EAClD,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,WAAW,EAC1C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlGD,0CAkGC"}
+{"version":3,"file":"product-category.js","sourceRoot":"","sources":["../../src/admin/product-category.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAK1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,2BAA2B,EAC3B;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,EAAE,EACjC;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,6BAA6B,EAAE,EAAE,EACjC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAAkD,EAClD,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,6BAA6B,EAAE,WAAW,EAC1C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxPD,0CAwPC"}

package/dist/admin/product-collection.d.ts

@@ -10,11 +10,160 @@ export declare class ProductCollection {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a product collection. It sends a request to the
+     * [Create Collection](https://docs.medusajs.com/api/admin#collections_postcollections)
+     * API route.
+     *
+     * @param body - The details of the product collection to create.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.create({
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     create(body: HttpTypes.AdminCreateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method updates a collection. It sends a request to the
+     * [Update Collection](https://docs.medusajs.com/api/admin#collections_postcollectionsid)
+     * API route.
+     *
+     * @param id - The ID of the collection.
+     * @param body - The data to update in the collection.
+     * @param query - Configure the fields to retrieve in the product collection.
+     * @param headers - Headers to pass in the request
+     * @returns The product collection's details.
+     *
+     * @example
+     * sdk.admin.productCollection.update("pcol_123", {
+     *   title: "Summer Collection"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateCollection, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method retrieves a paginated list of collections. It sends a request to the
+     * [List Collections](https://docs.medusajs.com/api/admin#collections_getcollections) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of collections.
+     *
+     * @example
+     * To retrieve the list of collections:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list()
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each collection:
+     *
+     * ```ts
+     * sdk.admin.productCollection.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ collections, count, limit, offset }) => {
+     *   console.log(collections)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(queryParams?: HttpTypes.AdminCollectionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionListResponse>;
+    /**
+     * This method retrieves a collection by its ID. It sends a request to the
+     * [Get Collection](https://docs.medusajs.com/api/admin#collections_getcollectionsid) API route.
+     *
+     * @param id - The collection's ID.
+     * @param query - Configure the fields to retrieve in the collection.
+     * @param headers - Headers to pass in the request
+     * @returns The collection's details.
+     *
+     * @example
+     * To retrieve a collection by its ID:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123")
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productCollection.retrieve("pcol_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.AdminCollectionParams, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
+    /**
+     * This method deletes a product collection. It sends a request to the
+     * [Delete Collection](https://docs.medusajs.com/api/admin#collections_deletecollectionsid)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productCollection.delete("pcol_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionDeleteResponse>;
+    /**
+     * This method manages the products of a collection to add or remove them. It sends a request
+     * to the [Manage Products](https://docs.medusajs.com/api/admin#collections_postcollectionsidproducts)
+     * API route.
+     *
+     * @param id - The collection's ID.
+     * @param body - The products to add or remove.
+     * @param headers - Headers to pass in the request
+     * @returns The product category's details.
+     *
+     * @example
+     * sdk.admin.productCollection.updateProducts("pcol_123", {
+     *   add: ["prod_123"],
+     *   remove: ["prod_321"]
+     * })
+     * .then(({ collection }) => {
+     *   console.log(collection)
+     * })
+     */
     updateProducts(id: string, body: HttpTypes.AdminUpdateCollectionProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminCollectionResponse>;
 }
 //# sourceMappingURL=product-collection.d.ts.map

package/dist/admin/product-collection.d.ts.map

@@ -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"}
+{"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"}