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

package/dist/esm/admin/product-collection.js

@@ -14,6 +14,24 @@ export class ProductCollection {
     constructor(client) {
         this.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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections`, {
@@ -24,6 +42,25 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * 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, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -34,6 +71,52 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections`, {
@@ -42,6 +125,38 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -50,6 +165,21 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}`, {
@@ -58,6 +188,25 @@ export class ProductCollection {
             });
         });
     }
+    /**
+     * 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, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/collections/${id}/products`, {

package/dist/esm/admin/product-collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IACK,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAAiD,EACjD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"product-collection.js","sourceRoot":"","sources":["../../../src/admin/product-collection.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAiD,EACjD,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;gBACE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,sBAAsB,EAAE,EAAE,EAC1B;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAClB,EAAU,EACV,IAA6C,EAC7C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medusajs/js-sdk",
-  "version": "2.0.1-snapshot-20241025090810",
+  "version": "2.0.1",
   "description": "SDK for the Medusa API",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -35,7 +35,7 @@
     "typescript": "^5.6.2"
   },
   "dependencies": {
-    "@medusajs/types": "2.0.1-snapshot-20241025090810",
+    "@medusajs/types": "^2.0.1",
     "fetch-event-stream": "^0.1.5",
     "qs": "^6.12.1"
   },