@medusajs/js-sdk 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406164537

package/dist/admin/sales-channel.d.ts

@@ -10,12 +10,187 @@ export declare class SalesChannel {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a new sales channel. It sends a request to the
+     * [Create Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannels)
+     * API route.
+     *
+     * @param body - The details of the sales channel to create.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.create({
+     *   name: "Storefront",
+     * })
+     * .then(({ salesChannel }) => {
+     *   console.log(salesChannel)
+     * })
+     */
     create(body: HttpTypes.AdminCreateSalesChannel, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
+    /**
+     * This method updates a sales channel. It sends a request to the
+     * [Update Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to update.
+     * @param body - The details of the sales channel to update.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.update(
+     *   "sc_123",
+     *   {
+     *     name: "Storefront",
+     *   }
+     * )
+     * .then(({ salesChannel }) => {
+     *   console.log(salesChannel)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateSalesChannel, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
+    /**
+     * This method deletes a sales channel. It sends a request to the
+     * [Delete Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_deletesaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.delete("sc_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelDeleteResponse>;
+    /**
+     * This method retrieves a sales channel. It sends a request to the
+     * [Retrieve Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_getsaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * To retrieve a sales channel by its ID:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.retrieve("sc_123")
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.retrieve("sc_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
+    /**
+     * This method retrieves a list of sales channels. It sends a request to the
+     * [List Sales Channels](https://docs.medusajs.com/api/admin#sales-channels_getsaleschannels)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of sales channels.
+     *
+     * @example
+     * To retrieve the list of sales channels:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.list()
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * 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.salesChannel.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each sales channel:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminSalesChannelListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelListResponse>;
+    /**
+     * This method manages the products in a sales channel to add or remove them. It sends a request to the
+     * [Manage Products in Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsidproducts)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to manage the products for.
+     * @param body - The details of the products to add or remove from the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.updateProducts("sc_123", {
+     *   add: ["prod_123", "prod_456"],
+     *   remove: ["prod_789"]
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     *
+     * @deprecated Use {@link batchProducts} instead
+     */
     updateProducts(id: string, body: HttpTypes.AdminUpdateSalesChannelProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
-    batchProducts(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
+    /**
+     * This method manages the products in a sales channel to add or remove them. It sends a request to the
+     * [Manage Products in Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsidproducts)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to manage the products for.
+     * @param body - The details of the products to add or remove from the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.batchProducts("sc_123", {
+     *   add: ["prod_123", "prod_456"],
+     *   remove: ["prod_789"]
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     */
+    batchProducts(id: string, body: HttpTypes.AdminUpdateSalesChannelProducts, headers?: ClientHeaders): Promise<HttpTypes.AdminSalesChannelResponse>;
 }
 //# sourceMappingURL=sales-channel.d.ts.map

package/dist/admin/sales-channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sales-channel.d.ts","sourceRoot":"","sources":["../../src/admin/sales-channel.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,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYnB,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYnB,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"sales-channel.d.ts","sourceRoot":"","sources":["../../src/admin/sales-channel.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,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,uBAAuB,EACvC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAClB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,+BAA+B,EAC/C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/sales-channel.js

@@ -8,6 +8,24 @@ class SalesChannel {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a new sales channel. It sends a request to the
+     * [Create Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannels)
+     * API route.
+     *
+     * @param body - The details of the sales channel to create.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.create({
+     *   name: "Storefront",
+     * })
+     * .then(({ salesChannel }) => {
+     *   console.log(salesChannel)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/sales-channels`, {
             method: "POST",
@@ -16,6 +34,28 @@ class SalesChannel {
             query,
         });
     }
+    /**
+     * This method updates a sales channel. It sends a request to the
+     * [Update Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to update.
+     * @param body - The details of the sales channel to update.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.update(
+     *   "sc_123",
+     *   {
+     *     name: "Storefront",
+     *   }
+     * )
+     * .then(({ salesChannel }) => {
+     *   console.log(salesChannel)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/sales-channels/${id}`, {
             method: "POST",
@@ -24,12 +64,60 @@ class SalesChannel {
             query,
         });
     }
+    /**
+     * This method deletes a sales channel. It sends a request to the
+     * [Delete Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_deletesaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.delete("sc_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/sales-channels/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method retrieves a sales channel. It sends a request to the
+     * [Retrieve Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_getsaleschannelsid)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * To retrieve a sales channel by its ID:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.retrieve("sc_123")
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.retrieve("sc_123", {
+     *   fields: "id,*products"
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/sales-channels/${id}`, {
             method: "GET",
@@ -37,6 +125,53 @@ class SalesChannel {
             query,
         });
     }
+    /**
+     * This method retrieves a list of sales channels. It sends a request to the
+     * [List Sales Channels](https://docs.medusajs.com/api/admin#sales-channels_getsaleschannels)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of sales channels.
+     *
+     * @example
+     * To retrieve the list of sales channels:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.list()
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * 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.salesChannel.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each sales channel:
+     *
+     * ```ts
+     * sdk.admin.salesChannel.list({
+     *   fields: "id,*products"
+     * })
+     * .then(({ sales_channels, count, limit, offset }) => {
+     *   console.log(sales_channels)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/sales-channels`, {
             method: "GET",
@@ -44,6 +179,27 @@ class SalesChannel {
             query,
         });
     }
+    /**
+     * This method manages the products in a sales channel to add or remove them. It sends a request to the
+     * [Manage Products in Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsidproducts)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to manage the products for.
+     * @param body - The details of the products to add or remove from the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.updateProducts("sc_123", {
+     *   add: ["prod_123", "prod_456"],
+     *   remove: ["prod_789"]
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     *
+     * @deprecated Use {@link batchProducts} instead
+     */
     async updateProducts(id, body, headers) {
         return await this.client.fetch(`/admin/sales-channels/${id}/products`, {
             method: "POST",
@@ -51,6 +207,25 @@ class SalesChannel {
             body,
         });
     }
+    /**
+     * This method manages the products in a sales channel to add or remove them. It sends a request to the
+     * [Manage Products in Sales Channel](https://docs.medusajs.com/api/admin#sales-channels_postsaleschannelsidproducts)
+     * API route.
+     *
+     * @param id - The ID of the sales channel to manage the products for.
+     * @param body - The details of the products to add or remove from the sales channel.
+     * @param headers - Headers to pass in the request.
+     * @returns The sales channel's details.
+     *
+     * @example
+     * sdk.admin.salesChannel.batchProducts("sc_123", {
+     *   add: ["prod_123", "prod_456"],
+     *   remove: ["prod_789"]
+     * })
+     * .then(({ sales_channel }) => {
+     *   console.log(sales_channel)
+     * })
+     */
     async batchProducts(id, body, headers) {
         return await this.client.fetch(`/admin/sales-channels/${id}/products`, {
             method: "POST",

package/dist/admin/sales-channel.js.map

@@ -1 +1 @@
-{"version":3,"file":"sales-channel.js","sourceRoot":"","sources":["../../src/admin/sales-channel.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,WAAW,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,WAAW,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAjHD,oCAiHC"}
+{"version":3,"file":"sales-channel.js","sourceRoot":"","sources":["../../src/admin/sales-channel.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAuC,EACvC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,EAAE,EAC7B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,uBAAuB,EACvB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,cAAc,CAClB,EAAU,EACV,IAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,WAAW,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EAAE,WAAW,EACtC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAhSD,oCAgSC"}

package/dist/admin/shipping-option.d.ts

@@ -10,11 +10,162 @@ export declare class ShippingOption {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a shipping option. It sends a request to the
+     * [Create Shipping Option](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions)
+     * API route.
+     *
+     * @param body - The details of the shipping option to create.
+     * @param query - Configure the fields and relations to retrieve in the shipping option.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping option's details.
+     *
+     * @example
+     * sdk.admin.shippingOption.create({
+     *   name: "Standard Shipping",
+     *   profile_id: "shp_123",
+     * })
+     * .then(({ shipping_option }) => {
+     *   console.log(shipping_option)
+     * })
+     */
     create(body: HttpTypes.AdminCreateShippingOption, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
+    /**
+     * This method retrieves a shipping option. It sends a request to the
+     * [Get Shipping Option](https://docs.medusajs.com/api/admin#shipping-options_getshippingoptionsid)
+     * API route.
+     *
+     * @param id - The ID of the shipping option to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the shipping option.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping option's details.
+     *
+     * @example
+     * To retrieve a shipping option by its ID:
+     *
+     * ```ts
+     * sdk.admin.shippingOption.retrieve("so_123")
+     * .then(({ shipping_option }) => {
+     *   console.log(shipping_option)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.shippingOption.retrieve("so_123", {
+     *   fields: "id,*service_zone"
+     * })
+     * .then(({ shipping_option }) => {
+     *   console.log(shipping_option)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     retrieve(id: string, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
+    /**
+     * This method updates a shipping option. It sends a request to the
+     * [Update Shipping Option](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptionsid)
+     * API route.
+     *
+     * @param id - The ID of the shipping option to update.
+     * @param body - The details of the shipping option to update.
+     * @param query - Configure the fields and relations to retrieve in the shipping option.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping option's details.
+     *
+     * @example
+     * sdk.admin.shippingOption.update("so_123", {
+     *   name: "Standard Shipping",
+     * })
+     * .then(({ shipping_option }) => {
+     *   console.log(shipping_option)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateShippingOption, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionResponse>;
+    /**
+     * This method deletes a shipping option. It sends a request to the
+     * [Delete Shipping Option](https://docs.medusajs.com/api/admin#shipping-options_deleteshippingoptionsid)
+     * API route.
+     *
+     * @param id - The ID of the shipping option to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.shippingOption.delete("so_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionDeleteResponse>;
+    /**
+     * This method retrieves a list of shipping options. It sends a request to the
+     * [List Shipping Options](https://docs.medusajs.com/api/admin#shipping-options_getshippingoptions)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of shipping options.
+     *
+     * @example
+     * To retrieve the list of shipping options:
+     *
+     * ```ts
+     * sdk.admin.shippingOption.list()
+     * .then(({ shipping_options, count, limit, offset }) => {
+     *   console.log(shipping_options)
+     * })
+     * ```
+     *
+     * 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.shippingOption.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ shipping_options, count, limit, offset }) => {
+     *   console.log(shipping_options)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each shipping option:
+     *
+     * ```ts
+     * sdk.admin.shippingOption.list({
+     *   fields: "id,*service_zone"
+     * })
+     * .then(({ shipping_options, count, limit, offset }) => {
+     *   console.log(shipping_options)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminShippingOptionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingOptionListResponse>;
+    /**
+     * This method manages the rules of a shipping option to create, update, or remove them. It sends a request to the
+     * [Manage Rules of a Shipping Option](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptionsidrulesbatch)
+     * API route.
+     *
+     * @param id - The ID of the shipping option to manage the rules for.
+     * @param body - The details of the shipping option rules to manage.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping option's details.
+     *
+     * @example
+     * sdk.admin.shippingOption.updateRules("so_123", {
+     *   create: [{ attribute: "enabled_in_store", operator: "eq", value: "true" }],
+     * })
+     * .then(({ shipping_option }) => {
+     *   console.log(shipping_option)
+     * })
+     */
     updateRules(id: string, body: HttpTypes.AdminUpdateShippingOptionRules, headers?: ClientHeaders): Promise<HttpTypes.AdminUpdateShippingOptionRulesResponse>;
 }
 //# sourceMappingURL=shipping-option.d.ts.map

package/dist/admin/shipping-option.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../src/admin/shipping-option.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,6BAA6B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYnB,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"shipping-option.d.ts","sourceRoot":"","sources":["../../src/admin/shipping-option.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,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAG1B;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,yBAAyB,EACzC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,6BAA6B,EAC/C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,OAAO,CAAC,EAAE,aAAa;CAW1B"}