@medusajs/js-sdk 2.0.5-preview-20241119150151 → 2.0.5-preview-20241119210153

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

@@ -10,10 +10,140 @@ export declare class ProductTag {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a product tag. It sends a request to the
+     * [Create Product Tag](https://docs.medusajs.com/api/admin#product-tags_postproducttags)
+     * API route.
+     *
+     * @param body - The details of the product tag.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * sdk.admin.productTag.create({
+     *   value: "shirt"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     */
     create(body: HttpTypes.AdminCreateProductTag, query?: HttpTypes.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
+    /**
+     * This method updates a tag's details. It sends a request to the
+     * [Update Product Tag](https://docs.medusajs.com/api/admin#product-tags_postproducttagsid)
+     * API route.
+     *
+     * @param id - The tag's ID.
+     * @param body - The data to update in the tag.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * sdk.admin.productTag.update("ptag_123", {
+     *   value: "shirt"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateProductTag, query?: HttpTypes.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
+    /**
+     * This method retrieves a paginated list of product tags. It sends a request to the
+     * [List Product Tags](https://docs.medusajs.com/api/admin#product-tags_getproducttags) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product tags.
+     *
+     * @example
+     * To retrieve the list of product tags:
+     *
+     * ```ts
+     * sdk.admin.productTag.list()
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * 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.productTag.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product tag:
+     *
+     * ```ts
+     * sdk.admin.productTag.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminProductTagListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagListResponse>;
+    /**
+     * This method retrieves a product tag by its ID. It sends a request to the
+     * [Get Product Tag](https://docs.medusajs.com/api/admin#product-tags_getproducttagsid) API route.
+     *
+     * @param id - The product tag's ID.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * To retrieve a product tag by its ID:
+     *
+     * ```ts
+     * sdk.admin.productTag.retrieve("ptag_123")
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productTag.retrieve("ptag_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     * ```
+     *
+     * 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.AdminProductTagParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagResponse>;
+    /**
+     * This method deletes a product tag. It sends a request to the
+     * [Delete Product Tag](https://docs.medusajs.com/api/admin#product-tags_deleteproducttagsid)
+     * API route.
+     *
+     * @param id - The tag's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productTag.delete("ptag_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTagDeleteResponse>;
 }
 //# sourceMappingURL=product-tag.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"product-tag.d.ts","sourceRoot":"","sources":["../../src/admin/product-tag.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,UAAU;IACrB;;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;IAanB,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,KAAK,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAC3C,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;CASjD"}
+{"version":3,"file":"product-tag.d.ts","sourceRoot":"","sources":["../../src/admin/product-tag.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,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"}

package/dist/admin/product-tag.js

@@ -8,6 +8,24 @@ class ProductTag {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a product tag. It sends a request to the
+     * [Create Product Tag](https://docs.medusajs.com/api/admin#product-tags_postproducttags)
+     * API route.
+     *
+     * @param body - The details of the product tag.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * sdk.admin.productTag.create({
+     *   value: "shirt"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/product-tags`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ProductTag {
             query,
         });
     }
+    /**
+     * This method updates a tag's details. It sends a request to the
+     * [Update Product Tag](https://docs.medusajs.com/api/admin#product-tags_postproducttagsid)
+     * API route.
+     *
+     * @param id - The tag's ID.
+     * @param body - The data to update in the tag.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * sdk.admin.productTag.update("ptag_123", {
+     *   value: "shirt"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/product-tags/${id}`, {
             method: "POST",
@@ -24,18 +61,111 @@ class ProductTag {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of product tags. It sends a request to the
+     * [List Product Tags](https://docs.medusajs.com/api/admin#product-tags_getproducttags) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product tags.
+     *
+     * @example
+     * To retrieve the list of product tags:
+     *
+     * ```ts
+     * sdk.admin.productTag.list()
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * 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.productTag.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product tag:
+     *
+     * ```ts
+     * sdk.admin.productTag.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_tags, count, limit, offset }) => {
+     *   console.log(product_tags)
+     * })
+     * ```
+     *
+     * 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-tags`, {
             headers,
             query: query,
         });
     }
+    /**
+     * This method retrieves a product tag by its ID. It sends a request to the
+     * [Get Product Tag](https://docs.medusajs.com/api/admin#product-tags_getproducttagsid) API route.
+     *
+     * @param id - The product tag's ID.
+     * @param query - Configure the fields to retrieve in the product tag.
+     * @param headers - Headers to pass in the request
+     * @returns The product tag's details.
+     *
+     * @example
+     * To retrieve a product tag by its ID:
+     *
+     * ```ts
+     * sdk.admin.productTag.retrieve("ptag_123")
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productTag.retrieve("ptag_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_tag }) => {
+     *   console.log(product_tag)
+     * })
+     * ```
+     *
+     * 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-tags/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a product tag. It sends a request to the
+     * [Delete Product Tag](https://docs.medusajs.com/api/admin#product-tags_deleteproducttagsid)
+     * API route.
+     *
+     * @param id - The tag's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.productTag.delete("ptag_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/product-tags/${id}`, {
             method: "DELETE",

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

@@ -1 +1 @@
-{"version":3,"file":"product-tag.js","sourceRoot":"","sources":["../../src/admin/product-tag.ts"],"names":[],"mappings":";;;AAIA,MAAa,UAAU;IAKrB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,EACrB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAqC,EACrC,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA2C,EAC3C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,EACrB;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAuC,EACvC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,uBAAuB,EAAE,EAAE,EAC3B;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,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAjFD,gCAiFC"}
+{"version":3,"file":"product-tag.js","sourceRoot":"","sources":["../../src/admin/product-tag.ts"],"names":[],"mappings":";;;AAIA,MAAa,UAAU;IAKrB;;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,qBAAqB,EACrB;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,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAA2C,EAC3C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,qBAAqB,EACrB;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,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,uBAAuB,EAAE,EAAE,EAC3B;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,uBAAuB,EAAE,EAAE,EAC3B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAnND,gCAmNC"}

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

@@ -10,10 +10,141 @@ export declare class ProductType {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a product type. It sends a request to the
+     * [Create Product Type](https://docs.medusajs.com/api/admin#product-types_postproducttypes)
+     * API route.
+     *
+     * @param body - The product type's details.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.create({
+     *   value: "Clothes"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     */
     create(body: HttpTypes.AdminCreateProductType, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTypeResponse>;
+    /**
+     * This method updates a product type. It sends a request to the
+     * [Update Product Type](https://docs.medusajs.com/api/admin#product-types_postproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param body - The data to update in the product type.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.update("ptyp_123", {
+     *   value: "Clothes"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateProductType, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTypeResponse>;
+    /**
+     * This method retrieves a paginated list of product types. It sends a request to the
+     * [List Product Types](https://docs.medusajs.com/api/admin#product-types_getproducttypes) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product types.
+     *
+     * @example
+     * To retrieve the list of product types:
+     *
+     * ```ts
+     * sdk.admin.productType.list()
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * 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.productType.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product type:
+     *
+     * ```ts
+     * sdk.admin.productType.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminProductTypeListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTypeListResponse>;
+    /**
+     * This method retrieves a product type by its ID. It sends a request to the
+     * [Get Product Type](https://docs.medusajs.com/api/admin#product-types_getproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * To retrieve a product type by its ID:
+     *
+     * ```ts
+     * sdk.admin.productType.retrieve("ptyp_123")
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productType.retrieve("ptyp_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     * ```
+     *
+     * 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.AdminProductTypeParams, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTypeResponse>;
+    /**
+     * This method deletes a product type. It sends a request to the
+     * [Delete Product Type](https://docs.medusajs.com/api/admin#product-types_deleteproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.delete("ptyp_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminProductTypeDeleteResponse>;
 }
 //# sourceMappingURL=product-type.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"product-type.d.ts","sourceRoot":"","sources":["../../src/admin/product-type.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,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"product-type.d.ts","sourceRoot":"","sources":["../../src/admin/product-type.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,WAAW;IACtB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,sBAAsB,EACtC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/admin/product-type.js

@@ -8,6 +8,24 @@ class ProductType {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a product type. It sends a request to the
+     * [Create Product Type](https://docs.medusajs.com/api/admin#product-types_postproducttypes)
+     * API route.
+     *
+     * @param body - The product type's details.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.create({
+     *   value: "Clothes"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/product-types`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ProductType {
             query,
         });
     }
+    /**
+     * This method updates a product type. It sends a request to the
+     * [Update Product Type](https://docs.medusajs.com/api/admin#product-types_postproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param body - The data to update in the product type.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.update("ptyp_123", {
+     *   value: "Clothes"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/product-types/${id}`, {
             method: "POST",
@@ -24,18 +61,112 @@ class ProductType {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of product types. It sends a request to the
+     * [List Product Types](https://docs.medusajs.com/api/admin#product-types_getproducttypes) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of product types.
+     *
+     * @example
+     * To retrieve the list of product types:
+     *
+     * ```ts
+     * sdk.admin.productType.list()
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * 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.productType.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each product type:
+     *
+     * ```ts
+     * sdk.admin.productType.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_types, count, limit, offset }) => {
+     *   console.log(product_types)
+     * })
+     * ```
+     *
+     * 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-types`, {
             headers,
             query: query,
         });
     }
+    /**
+     * This method retrieves a product type by its ID. It sends a request to the
+     * [Get Product Type](https://docs.medusajs.com/api/admin#product-types_getproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param query - Configure the fields to retrieve in the product type.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * To retrieve a product type by its ID:
+     *
+     * ```ts
+     * sdk.admin.productType.retrieve("ptyp_123")
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.productType.retrieve("ptyp_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ product_type }) => {
+     *   console.log(product_type)
+     * })
+     * ```
+     *
+     * 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-types/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a product type. It sends a request to the
+     * [Delete Product Type](https://docs.medusajs.com/api/admin#product-types_deleteproducttypesid)
+     * API route.
+     *
+     * @param id - The product type's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The product type's details.
+     *
+     * @example
+     * sdk.admin.productType.delete("ptyp_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/product-types/${id}`, {
             method: "DELETE",

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

@@ -1 +1 @@
-{"version":3,"file":"product-type.js","sourceRoot":"","sources":["../../src/admin/product-type.ts"],"names":[],"mappings":";;;AAIA,MAAa,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EACtB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EACtB;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,wBAAwB,EAAE,EAAE,EAC5B;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,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAjFD,kCAiFC"}
+{"version":3,"file":"product-type.js","sourceRoot":"","sources":["../../src/admin/product-type.ts"],"names":[],"mappings":";;;AAIA,MAAa,WAAW;IAKtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EACtB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAsC,EACtC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EACtB;YACE,OAAO;YACP,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAwC,EACxC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,wBAAwB,EAAE,EAAE,EAC5B;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,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AApND,kCAoNC"}