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

package/dist/admin/price-list.js

@@ -8,6 +8,39 @@ class PriceList {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a price list. It sends a request to the
+     * [Get Price List](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * To retrieve a price list by its ID:
+     *
+     * ```ts
+     * sdk.admin.priceList.retrieve("plist_123")
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.priceList.retrieve("plist_123", {
+     *   fields: "id,*prices"
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async retrieve(id, query, headers) {
         return this.client.fetch(`/admin/price-lists/${id}`, {
             method: "GET",
@@ -15,6 +48,52 @@ class PriceList {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of price lists. It sends a request to the
+     * [List Price Lists](https://docs.medusajs.com/v2/api/admin#price-lists_getpricelists) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of price lists.
+     *
+     * @example
+     * To retrieve the list of price lists:
+     *
+     * ```ts
+     * sdk.admin.priceList.list()
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * 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.priceList.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each price list:
+     *
+     * ```ts
+     * sdk.admin.priceList.list({
+     *   fields: "id,*prices"
+     * })
+     * .then(({ price_lists, count, limit, offset }) => {
+     *   console.log(price_lists)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     async list(query, headers) {
         return this.client.fetch(`/admin/price-lists`, {
             method: "GET",
@@ -22,6 +101,36 @@ class PriceList {
             query,
         });
     }
+    /**
+     * This method creates a price list. It sends a request to the
+     * [Create Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelists)
+     * API route.
+     *
+     * @param body - The details of the price list to create.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.create({
+     *   title: "My Price List",
+     *   status: "active",
+     *   type: "sale",
+     *   prices: [
+     *     {
+     *       variant_id: "variant_123",
+     *       amount: 10,
+     *       currency_code: "usd",
+     *       rules: {
+     *         region_id: "reg_123"
+     *       }
+     *     }
+     *   ]
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/price-lists`, {
             method: "POST",
@@ -30,6 +139,25 @@ class PriceList {
             query,
         });
     }
+    /**
+     * This method updates a price list. It sends a request to the
+     * [Update Price List](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The data to update in the price list.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.update("plist_123", {
+     *   title: "My Price List",
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/price-lists/${id}`, {
             method: "POST",
@@ -38,12 +166,59 @@ class PriceList {
             query,
         });
     }
+    /**
+     * This method deletes a price list. It sends a request to the
+     * [Delete Price List](https://docs.medusajs.com/v2/api/admin#price-lists_deletepricelistsid)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.priceList.delete("plist_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/price-lists/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method manages the prices of a price list to create, update, or delete them.
+     * It sends a request to the [Manage Prices](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidpricesbatch)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The prices to create, update, or delete.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.batchPrices("plist_123", {
+     *   create: [{
+     *     variant_id: "variant_123",
+     *     currency_code: "usd",
+     *     amount: 10,
+     *     rules: {
+     *       region_id: "reg_123"
+     *     }
+     *   }],
+     *   update: [{
+     *     id: "price_123",
+     *     variant_id: "variant_123",
+     *     amount: 20,
+     *   }],
+     *   delete: ["price_123"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     */
     async batchPrices(id, body, query, headers) {
         return this.client.fetch(`/admin/price-lists/${id}/prices/batch`, {
             method: "POST",
@@ -52,6 +227,25 @@ class PriceList {
             query,
         });
     }
+    /**
+     * This method removes products from a price list. It sends a request to the
+     * [Remove Product](https://docs.medusajs.com/v2/api/admin#price-lists_postpricelistsidproducts)
+     * API route.
+     *
+     * @param id - The price list's ID.
+     * @param body - The details of the products to remove.
+     * @param query - Configure the fields to retrieve in the price list.
+     * @param headers - Headers to pass in the request
+     * @returns The price list's details.
+     *
+     * @example
+     * sdk.admin.priceList.linkProducts("plist_123", {
+     *   remove: ["prod_123"]
+     * })
+     * .then(({ price_list }) => {
+     *   console.log(price_list)
+     * })
+     */
     async linkProducts(id, body, query, headers) {
         return this.client.fetch(`/admin/price-lists/${id}/products`, {
             method: "POST",

package/dist/admin/price-list.js.map

@@ -1 +1 @@
-{"version":3,"file":"price-list.js","sourceRoot":"","sources":["../../src/admin/price-list.ts"],"names":[],"mappings":";;;AAIA,MAAa,SAAS;IAMpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAAwC,EACxC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,eAAe,EACvC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,EAAU,EACV,IAA0C,EAC1C,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAtHD,8BAsHC"}
+{"version":3,"file":"price-list.js","sourceRoot":"","sources":["../../src/admin/price-list.ts"],"names":[],"mappings":";;;AAIA,MAAa,SAAS;IAMpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,MAAM,CACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,oBAAoB,EACpB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAoC,EACpC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,EAAE,EAC1B;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,WAAW,CACf,EAAU,EACV,IAAwC,EACxC,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,eAAe,EACvC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,YAAY,CAChB,EAAU,EACV,IAA0C,EAC1C,KAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,sBAAsB,EAAE,WAAW,EACnC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxTD,8BAwTC"}

package/dist/admin/price-preference.d.ts

@@ -10,10 +10,143 @@ export declare class PricePreference {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method retrieves a price preference. It sends a request to the
+     * [Get Price Preference](https://docs.medusajs.com/api/admin#price-preferences_getpricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * To retrieve a price preference by its ID:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.retrieve("prpref_123")
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.retrieve("prpref_123", {
+     *   fields: "id,is_tax_inclusive"
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     * ```
+     *
+     * 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.AdminPricePreferenceParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPricePreferenceResponse>;
+    /**
+     * This method retrieves a paginated list of price preferences. It sends a request to the
+     * [List Price Preferences](https://docs.medusajs.com/api/admin#price-preferences_getpricepreferences) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of price preferences.
+     *
+     * @example
+     * To retrieve the list of price preferences:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.list()
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * 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.pricePreference.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each price preference:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.list({
+     *   fields: "id,is_tax_inclusive"
+     * })
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/store#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminPricePreferenceListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPricePreferenceListResponse>;
+    /**
+     * This method creates a price preference. It sends a request to the
+     * [Create Price Preference](https://docs.medusajs.com/api/admin#price-preferences_postpricepreferences)
+     * API route.
+     *
+     * @param body - The details of the price preference to create.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.create({
+     *   attribute: "region_id",
+     *   value: "region_123",
+     *   is_tax_inclusive: true
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     */
     create(body: HttpTypes.AdminCreatePricePreference, query?: HttpTypes.AdminPricePreferenceParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPricePreferenceResponse>;
+    /**
+     * This method updates a price preference. It sends a request to the
+     * [Update Price Preference](https://docs.medusajs.com/api/admin#price-preferences_postpricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param body - The data to update in the price preference.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.update("prpref_123", {
+     *   is_tax_inclusive: true
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdatePricePreference, query?: HttpTypes.AdminPricePreferenceParams, headers?: ClientHeaders): Promise<HttpTypes.AdminPricePreferenceResponse>;
+    /**
+     * This method deletes a price preference. It sends a request to the
+     * [Delete Price Preference](https://docs.medusajs.com/api/admin#price-preferences_deletepricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.delete("prpref_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminPricePreferenceDeleteResponse>;
 }
 //# sourceMappingURL=price-preference.d.ts.map

package/dist/admin/price-preference.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"price-preference.d.ts","sourceRoot":"","sources":["../../src/admin/price-preference.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;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYnB,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAYnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"price-preference.d.ts","sourceRoot":"","sources":["../../src/admin/price-preference.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;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,8BAA8B,EAChD,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,0BAA0B,EAC1C,KAAK,CAAC,EAAE,SAAS,CAAC,0BAA0B,EAC5C,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/admin/price-preference.js

@@ -8,6 +8,39 @@ class PricePreference {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a price preference. It sends a request to the
+     * [Get Price Preference](https://docs.medusajs.com/api/admin#price-preferences_getpricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * To retrieve a price preference by its ID:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.retrieve("prpref_123")
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.retrieve("prpref_123", {
+     *   fields: "id,is_tax_inclusive"
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     * ```
+     *
+     * 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/price-preferences/${id}`, {
             method: "GET",
@@ -15,6 +48,52 @@ class PricePreference {
             query,
         });
     }
+    /**
+     * This method retrieves a paginated list of price preferences. It sends a request to the
+     * [List Price Preferences](https://docs.medusajs.com/api/admin#price-preferences_getpricepreferences) API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of price preferences.
+     *
+     * @example
+     * To retrieve the list of price preferences:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.list()
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * 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.pricePreference.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each price preference:
+     *
+     * ```ts
+     * sdk.admin.pricePreference.list({
+     *   fields: "id,is_tax_inclusive"
+     * })
+     * .then(({ price_preferences, count, limit, offset }) => {
+     *   console.log(price_preferences)
+     * })
+     * ```
+     *
+     * 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/price-preferences`, {
             method: "GET",
@@ -22,6 +101,26 @@ class PricePreference {
             query,
         });
     }
+    /**
+     * This method creates a price preference. It sends a request to the
+     * [Create Price Preference](https://docs.medusajs.com/api/admin#price-preferences_postpricepreferences)
+     * API route.
+     *
+     * @param body - The details of the price preference to create.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.create({
+     *   attribute: "region_id",
+     *   value: "region_123",
+     *   is_tax_inclusive: true
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     */
     async create(body, query, headers) {
         return this.client.fetch(`/admin/price-preferences`, {
             method: "POST",
@@ -30,6 +129,25 @@ class PricePreference {
             query,
         });
     }
+    /**
+     * This method updates a price preference. It sends a request to the
+     * [Update Price Preference](https://docs.medusajs.com/api/admin#price-preferences_postpricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param body - The data to update in the price preference.
+     * @param query - Configure the fields to retrieve in the price preference.
+     * @param headers - Headers to pass in the request
+     * @returns The price preference's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.update("prpref_123", {
+     *   is_tax_inclusive: true
+     * })
+     * .then(({ price_preference }) => {
+     *   console.log(price_preference)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/price-preferences/${id}`, {
             method: "POST",
@@ -38,6 +156,21 @@ class PricePreference {
             query,
         });
     }
+    /**
+     * This method deletes a price preference. It sends a request to the
+     * [Delete Price Preference](https://docs.medusajs.com/api/admin#price-preferences_deletepricepreferencesid)
+     * API route.
+     *
+     * @param id - The price preference's ID.
+     * @param headers - Headers to pass in the request
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.pricePreference.delete("prpref_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/price-preferences/${id}`, {
             method: "DELETE",

package/dist/admin/price-preference.js.map

@@ -1 +1 @@
-{"version":3,"file":"price-preference.js","sourceRoot":"","sources":["../../src/admin/price-preference.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAM1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,0BAA0B,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,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,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AApFD,0CAoFC"}
+{"version":3,"file":"price-preference.js","sourceRoot":"","sources":["../../src/admin/price-preference.ts"],"names":[],"mappings":";;;AAIA,MAAa,eAAe;IAM1B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,KAAK,CAAC,IAAI,CACR,KAAgD,EAChD,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,0BAA0B,EAC1B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CACV,IAA0C,EAC1C,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,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,KAA4C,EAC5C,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,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,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,4BAA4B,EAAE,EAAE,EAChC;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAzND,0CAyNC"}