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

package/dist/admin/shipping-option.js

@@ -8,6 +8,25 @@ class ShippingOption {
     constructor(client) {
         this.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)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/shipping-options`, {
             method: "POST",
@@ -16,6 +35,39 @@ class ShippingOption {
             query,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`/admin/shipping-options/${id}`, {
             method: "GET",
@@ -23,6 +75,25 @@ class ShippingOption {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/shipping-options/${id}`, {
             method: "POST",
@@ -31,12 +102,74 @@ class ShippingOption {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/shipping-options/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * 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).
+     */
     async list(query, headers) {
         return await this.client.fetch(`/admin/shipping-options`, {
             method: "GET",
@@ -44,6 +177,24 @@ class ShippingOption {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async updateRules(id, body, headers) {
         return await this.client.fetch(`/admin/shipping-options/${id}/rules/batch`, {
             method: "POST",

package/dist/admin/shipping-option.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../src/admin/shipping-option.ts"],"names":[],"mappings":";;;AAIA,MAAa,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;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,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAA8C,EAC9C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,cAAc,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAlGD,wCAkGC"}
+{"version":3,"file":"shipping-option.js","sourceRoot":"","sources":["../../src/admin/shipping-option.ts"],"names":[],"mappings":";;;AAIA,MAAa,cAAc;IAKzB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,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,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAyC,EACzC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,EAAE,EAC/B;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,2BAA2B,EAAE,EAAE,EAC/B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,yBAAyB,EACzB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAA8C,EAC9C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAAE,cAAc,EAC3C;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;CACF;AAxPD,wCAwPC"}

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

@@ -10,10 +10,142 @@ export declare class ShippingProfile {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a new shipping profile. It sends a request to the
+     * [Create Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_postshippingprofiles)
+     * API route.
+     *
+     * @param body - The details of the shipping profile to create.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.create({
+     *   name: "Default Shipping Profile",
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     */
     create(body: HttpTypes.AdminCreateShippingProfile, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingProfileResponse>;
+    /**
+     * This method updates a shipping profile. It sends a request to the
+     * [Update Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_postshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to update.
+     * @param body - The details of the shipping profile to update.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.update("sp_123", {
+     *   name: "Updated Shipping Profile",
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateShippingProfile, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingProfileResponse>;
+    /**
+     * This method deletes a shipping profile. It sends a request to the
+     * [Delete Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_deleteshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.delete("sp_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingProfileDeleteResponse>;
+    /**
+     * This method retrieves a list of shipping profiles. It sends a request to the
+     * [List Shipping Profiles](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofiles)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of shipping profiles.
+     *
+     * @example
+     * To retrieve the list of shipping profiles:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.list()
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * 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.shippingProfile.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each shipping profile:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminShippingProfileListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminShippingProfileListResponse>;
+    /**
+     * This method retrieves a shipping profile. It sends a request to the
+     * [Get Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * To retrieve a shipping profile by its ID:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.retrieve("sp_123")
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.retrieve("sp_123", {
+     *   fields: "id,name"
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     * ```
+     *
+     * 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.AdminShippingProfileResponse>;
 }
 //# sourceMappingURL=shipping-profile.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../src/admin/shipping-profile.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,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,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,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAYnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../src/admin/shipping-profile.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,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,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,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/shipping-profile.js

@@ -8,6 +8,24 @@ class ShippingProfile {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a new shipping profile. It sends a request to the
+     * [Create Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_postshippingprofiles)
+     * API route.
+     *
+     * @param body - The details of the shipping profile to create.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.create({
+     *   name: "Default Shipping Profile",
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(`/admin/shipping-profiles`, {
             method: "POST",
@@ -16,6 +34,25 @@ class ShippingProfile {
             query,
         });
     }
+    /**
+     * This method updates a shipping profile. It sends a request to the
+     * [Update Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_postshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to update.
+     * @param body - The details of the shipping profile to update.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.update("sp_123", {
+     *   name: "Updated Shipping Profile",
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/shipping-profiles/${id}`, {
             method: "POST",
@@ -24,12 +61,74 @@ class ShippingProfile {
             query,
         });
     }
+    /**
+     * This method deletes a shipping profile. It sends a request to the
+     * [Delete Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_deleteshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.shippingProfile.delete("sp_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`/admin/shipping-profiles/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method retrieves a list of shipping profiles. It sends a request to the
+     * [List Shipping Profiles](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofiles)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of shipping profiles.
+     *
+     * @example
+     * To retrieve the list of shipping profiles:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.list()
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * 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.shippingProfile.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each shipping profile:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ shipping_profiles, count, limit, offset }) => {
+     *   console.log(shipping_profiles)
+     * })
+     * ```
+     *
+     * 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/shipping-profiles`, {
             method: "GET",
@@ -37,6 +136,39 @@ class ShippingProfile {
             query,
         });
     }
+    /**
+     * This method retrieves a shipping profile. It sends a request to the
+     * [Get Shipping Profile](https://docs.medusajs.com/api/admin#shipping-profiles_getshippingprofilesid)
+     * API route.
+     *
+     * @param id - The ID of the shipping profile to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the shipping profile.
+     * @param headers - Headers to pass in the request.
+     * @returns The shipping profile's details.
+     *
+     * @example
+     * To retrieve a shipping profile by its ID:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.retrieve("sp_123")
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.shippingProfile.retrieve("sp_123", {
+     *   fields: "id,name"
+     * })
+     * .then(({ shipping_profile }) => {
+     *   console.log(shipping_profile)
+     * })
+     * ```
+     *
+     * 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/shipping-profiles/${id}`, {
             method: "GET",

package/dist/admin/shipping-profile.js.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../src/admin/shipping-profile.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,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAC1B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA0C,EAC1C,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAAE,EAAE,EAChC;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,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAnFD,0CAmFC"}
+{"version":3,"file":"shipping-profile.js","sourceRoot":"","sources":["../../src/admin/shipping-profile.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,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAC1B;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,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,4BAA4B,EAAE,EAAE,EAChC;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,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,0BAA0B,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,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,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAvND,0CAuNC"}