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

package/dist/admin/store.js

@@ -8,6 +8,39 @@ class Store {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method retrieves a store by its ID. It sends a request to the
+     * [Get Store](https://docs.medusajs.com/api/admin#stores_getstoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * To retrieve a store by its ID:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123")
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.store.retrieve("store_123", {
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     * ```
+     *
+     * 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/stores/${id}`, {
             method: "GET",
@@ -15,6 +48,53 @@ class Store {
             query,
         });
     }
+    /**
+     * This method retrieves a list of stores. It sends a request to the
+     * [List Stores](https://docs.medusajs.com/api/admin#stores_getstores)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of stores.
+     *
+     * @example
+     * To retrieve the list of stores:
+     *
+     * ```ts
+     * sdk.admin.store.list()
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * 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.store.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each store:
+     *
+     * ```ts
+     * sdk.admin.store.list({
+     *   fields: "id,*supported_currencies"
+     * })
+     * .then(({ stores, count, limit, offset }) => {
+     *   console.log(stores)
+     * })
+     * ```
+     *
+     * 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/stores`, {
             method: "GET",
@@ -22,6 +102,25 @@ class Store {
             query,
         });
     }
+    /**
+     * This method updates a store. It sends a request to the
+     * [Update Store](https://docs.medusajs.com/api/admin#stores_poststoresid)
+     * API route.
+     *
+     * @param id - The ID of the store to update.
+     * @param body - The details of the store to update.
+     * @param query - Configure the fields and relations to retrieve in the store.
+     * @param headers - Headers to pass in the request.
+     * @returns The store's details.
+     *
+     * @example
+     * sdk.admin.store.update("store_123", {
+     *   name: "My Store",
+     * })
+     * .then(({ store }) => {
+     *   console.log(store)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`/admin/stores/${id}`, {
             method: "POST",

package/dist/admin/store.js.map

@@ -1 +1 @@
-{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/admin/store.ts"],"names":[],"mappings":";;;AAIA,MAAa,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAkC,EAClC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAsC,EAAE,OAAuB;QACxE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAgC,EAChC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAtDD,sBAsDC"}
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/admin/store.ts"],"names":[],"mappings":";;;AAIA,MAAa,KAAK;IAKhB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAkC,EAClC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,KAAsC,EAAE,OAAuB;QACxE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,eAAe,EACf;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAgC,EAChC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAzJD,sBAyJC"}

package/dist/admin/tax-rate.d.ts

@@ -10,10 +10,146 @@ export declare class TaxRate {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a tax rate. It sends a request to the
+     * [Create Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_posttaxrates)
+     * API route.
+     *
+     * @param body - The details of the tax rate to create.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * sdk.admin.taxRate.create({
+     *   name: "VAT",
+     *   tax_region_id: "txreg_123",
+     *   code: "VAT",
+     *   rate: 2, // 2%
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     */
     create(body: HttpTypes.AdminCreateTaxRate, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateResponse>;
+    /**
+     * This method updates a tax rate. It sends a request to the
+     * [Update Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_posttaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to update.
+     * @param body - The details of the tax rate to update.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * sdk.admin.taxRate.update("txrat_123", {
+     *   name: "VAT",
+     *   code: "VAT",
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateTaxRate, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateResponse>;
+    /**
+     * This method deletes a tax rate. It sends a request to the
+     * [Delete Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_deletetaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.taxRate.delete("txrat_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateDeleteResponse>;
+    /**
+     * This method retrieves a tax rate. It sends a request to the
+     * [Get Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_gettaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * To retrieve a tax rate by its ID:
+     *
+     * ```ts
+     * sdk.admin.taxRate.retrieve("txrat_123")
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.taxRate.retrieve("txrat_123", {
+     *   fields: "id,*tax_region"
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     * ```
+     *
+     * 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.AdminTaxRateResponse>;
+    /**
+     * This method retrieves a list of tax rates. It sends a request to the
+     * [List Tax Rates](https://docs.medusajs.com/api/admin#tax-rates_gettaxrates)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax rates.
+     *
+     * @example
+     * To retrieve the list of tax rates:
+     *
+     * ```ts
+     * sdk.admin.taxRate.list()
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * 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.taxRate.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each tax rate:
+     *
+     * ```ts
+     * sdk.admin.taxRate.list({
+     *   fields: "id,*tax_region"
+     * })
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminTaxRateListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRateListResponse>;
 }
 //# sourceMappingURL=tax-rate.d.ts.map

package/dist/admin/tax-rate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tax-rate.d.ts","sourceRoot":"","sources":["../../src/admin/tax-rate.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;AAIxC,qBAAa,OAAO;IAClB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAUnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,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,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"tax-rate.d.ts","sourceRoot":"","sources":["../../src/admin/tax-rate.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;AAIxC,qBAAa,OAAO;IAClB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,KAAK,CAAC,EAAE,SAAS,CAAC,YAAY,EAC9B,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,kBAAkB,EAClC,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,sBAAsB,EACxC,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/tax-rate.js

@@ -9,6 +9,27 @@ class TaxRate {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method creates a tax rate. It sends a request to the
+     * [Create Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_posttaxrates)
+     * API route.
+     *
+     * @param body - The details of the tax rate to create.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * sdk.admin.taxRate.create({
+     *   name: "VAT",
+     *   tax_region_id: "txreg_123",
+     *   code: "VAT",
+     *   rate: 2, // 2%
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(taxRateUrl, {
             method: "POST",
@@ -17,6 +38,26 @@ class TaxRate {
             query,
         });
     }
+    /**
+     * This method updates a tax rate. It sends a request to the
+     * [Update Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_posttaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to update.
+     * @param body - The details of the tax rate to update.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * sdk.admin.taxRate.update("txrat_123", {
+     *   name: "VAT",
+     *   code: "VAT",
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     */
     async update(id, body, query, headers) {
         return await this.client.fetch(`${taxRateUrl}/${id}`, {
             method: "POST",
@@ -25,12 +66,60 @@ class TaxRate {
             query,
         });
     }
+    /**
+     * This method deletes a tax rate. It sends a request to the
+     * [Delete Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_deletetaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.taxRate.delete("txrat_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`${taxRateUrl}/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method retrieves a tax rate. It sends a request to the
+     * [Get Tax Rate](https://docs.medusajs.com/api/admin#tax-rates_gettaxratesid)
+     * API route.
+     *
+     * @param id - The ID of the tax rate to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the tax rate.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax rate's details.
+     *
+     * @example
+     * To retrieve a tax rate by its ID:
+     *
+     * ```ts
+     * sdk.admin.taxRate.retrieve("txrat_123")
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.taxRate.retrieve("txrat_123", {
+     *   fields: "id,*tax_region"
+     * })
+     * .then(({ tax_rate }) => {
+     *   console.log(tax_rate)
+     * })
+     * ```
+     *
+     * 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(`${taxRateUrl}/${id}`, {
             method: "GET",
@@ -38,6 +127,53 @@ class TaxRate {
             query,
         });
     }
+    /**
+     * This method retrieves a list of tax rates. It sends a request to the
+     * [List Tax Rates](https://docs.medusajs.com/api/admin#tax-rates_gettaxrates)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax rates.
+     *
+     * @example
+     * To retrieve the list of tax rates:
+     *
+     * ```ts
+     * sdk.admin.taxRate.list()
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * 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.taxRate.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each tax rate:
+     *
+     * ```ts
+     * sdk.admin.taxRate.list({
+     *   fields: "id,*tax_region"
+     * })
+     * .then(({ tax_rates, count, limit, offset }) => {
+     *   console.log(tax_rates)
+     * })
+     * ```
+     *
+     * 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(taxRateUrl, {
             method: "GET",

package/dist/admin/tax-rate.js.map

@@ -1 +1 @@
-{"version":3,"file":"tax-rate.js","sourceRoot":"","sources":["../../src/admin/tax-rate.ts"],"names":[],"mappings":";;;AAIA,MAAM,UAAU,GAAG,kBAAkB,CAAA;AAErC,MAAa,OAAO;IAKlB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAiC,UAAU,EAAE;YACzE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;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,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;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,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAAwC,EACxC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,UAAU,EACV;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAhFD,0BAgFC"}
+{"version":3,"file":"tax-rate.js","sourceRoot":"","sources":["../../src/admin/tax-rate.ts"],"names":[],"mappings":";;;AAIA,MAAM,UAAU,GAAG,kBAAkB,CAAA;AAErC,MAAa,OAAO;IAKlB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,MAAM,CACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAiC,UAAU,EAAE;YACzE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAAkC,EAClC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;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,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;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,GAAG,UAAU,IAAI,EAAE,EAAE,EACrB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAAwC,EACxC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,UAAU,EACV;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxND,0BAwNC"}

package/dist/admin/tax-region.d.ts

@@ -1,6 +1,11 @@
 import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
+/**
+ * @privateRemarks
+ *
+ * TODO: Add support for updating a tax region
+ */
 export declare class TaxRegion {
     /**
      * @ignore
@@ -10,9 +15,129 @@ export declare class TaxRegion {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method creates a tax region. It sends a request to the
+     * [Create Tax Region](https://docs.medusajs.com/api/admin#tax-regions_posttaxregions)
+     * API route.
+     *
+     * @param body - The details of the tax region to create.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax region's details.
+     *
+     * @example
+     * sdk.admin.taxRegion.create({
+     *   country_code: "us",
+     *   province_code: "ca",
+     *   default_tax_rate: {
+     *     code: "VAT",
+     *     name: "VAT",
+     *     rate: 20, // 20%
+     *     is_combinable: true,
+     *   },
+     * })
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     */
     create(body: HttpTypes.AdminCreateTaxRegion, query?: HttpTypes.SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRegionResponse>;
+    /**
+     * This method deletes a tax region. It sends a request to the
+     * [Delete Tax Region](https://docs.medusajs.com/api/admin#tax-regions_deletetaxregionsid)
+     * API route.
+     *
+     * @param id - The ID of the tax region to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.taxRegion.delete("txreg_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRegionDeleteResponse>;
+    /**
+     * This method retrieves a tax region. It sends a request to the
+     * [Get Tax Region](https://docs.medusajs.com/api/admin#tax-regions_gettaxregionsid)
+     * API route.
+     *
+     * @param id - The ID of the tax region to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The tax region's details.
+     *
+     * @example
+     * To retrieve a tax region by its ID:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.retrieve("txreg_123")
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.retrieve("txreg_123", {
+     *   fields: "id,*tax_rates"
+     * })
+     * .then(({ tax_region }) => {
+     *   console.log(tax_region)
+     * })
+     * ```
+     *
+     * 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.AdminTaxRegionResponse>;
+    /**
+     * This method retrieves a list of tax regions. It sends a request to the
+     * [List Tax Regions](https://docs.medusajs.com/api/admin#tax-regions_gettaxregions)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of tax regions.
+     *
+     * @example
+     * To retrieve the list of tax regions:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.list()
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * 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.taxRegion.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each tax region:
+     *
+     * ```ts
+     * sdk.admin.taxRegion.list({
+     *   fields: "id,*tax_rates"
+     * })
+     * .then(({ tax_regions, count, limit, offset }) => {
+     *   console.log(tax_regions)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(query?: HttpTypes.AdminTaxRegionListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminTaxRegionListResponse>;
 }
 //# sourceMappingURL=tax-region.d.ts.map

package/dist/admin/tax-region.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tax-region.d.ts","sourceRoot":"","sources":["../../src/admin/tax-region.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;AAKxC,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,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,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"tax-region.d.ts","sourceRoot":"","sources":["../../src/admin/tax-region.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;AAIxC;;;;GAIG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,oBAAoB,EACpC,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,wBAAwB,EAC1C,OAAO,CAAC,EAAE,aAAa;CAW1B"}