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

package/dist/admin/tax-region.js

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TaxRegion = void 0;
 const taxRegionUrl = "/admin/tax-regions";
-// TODO: Add support for updating a tax region
+/**
+ * @privateRemarks
+ *
+ * TODO: Add support for updating a tax region
+ */
 class TaxRegion {
     /**
      * @ignore
@@ -10,6 +14,31 @@ class TaxRegion {
     constructor(client) {
         this.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)
+     * })
+     */
     async create(body, query, headers) {
         return await this.client.fetch(taxRegionUrl, {
             method: "POST",
@@ -18,12 +47,60 @@ class TaxRegion {
             query,
         });
     }
+    /**
+     * 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)
+     * })
+     */
     async delete(id, headers) {
         return await this.client.fetch(`${taxRegionUrl}/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * 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).
+     */
     async retrieve(id, query, headers) {
         return await this.client.fetch(`${taxRegionUrl}/${id}`, {
             method: "GET",
@@ -31,6 +108,53 @@ class TaxRegion {
             query,
         });
     }
+    /**
+     * 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).
+     */
     async list(query, headers) {
         return await this.client.fetch(taxRegionUrl, {
             method: "GET",

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

@@ -1 +1 @@
-{"version":3,"file":"tax-region.js","sourceRoot":"","sources":["../../src/admin/tax-region.ts"],"names":[],"mappings":";;;AAIA,MAAM,YAAY,GAAG,oBAAoB,CAAA;AAEzC,8CAA8C;AAC9C,MAAa,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;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,YAAY,IAAI,EAAE,EAAE,EACvB;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,YAAY,IAAI,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlED,8BAkEC"}
+{"version":3,"file":"tax-region.js","sourceRoot":"","sources":["../../src/admin/tax-region.ts"],"names":[],"mappings":";;;AAIA,MAAM,YAAY,GAAG,oBAAoB,CAAA;AAEzC;;;;GAIG;AACH,MAAa,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,MAAM,CACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;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,YAAY,IAAI,EAAE,EAAE,EACvB;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,YAAY,IAAI,EAAE,EAAE,EACvB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA0C,EAC1C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AA1LD,8BA0LC"}

package/dist/admin/upload.d.ts

@@ -10,12 +10,71 @@ export declare class Upload {
      * @ignore
      */
     constructor(client: Client);
-    create(body: HttpTypes.AdminUploadFile, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        files: HttpTypes.AdminFile[];
-    }>;
-    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<{
-        file: HttpTypes.AdminFile;
-    }>;
+    /**
+     * This method creates a new upload. It sends a request to the
+     * [Upload Files](https://docs.medusajs.com/api/admin#uploads_postuploads)
+     * API route.
+     *
+     * @param body - The details of the files to upload.
+     * @param query - Configure the fields and relations to retrieve in the uploaded files.
+     * @param headers - Headers to pass in the request.
+     * @returns The upload files' details.
+     *
+     * @privateRemarks
+     *
+     * Note: The creation/upload flow be made more advanced, with support for streaming and progress, but for now we keep it simple
+     *
+     * @example
+     * sdk.admin.upload.create(
+     *   {
+     *     files: [
+     *        // file uploaded as a base64 string
+     *       {
+     *         name: "test.txt",
+     *         content: "test", // Should be the base64 content of the file
+     *       },
+     *       // file uploaded as a File object
+     *       new File(["test"], "test.txt", { type: "text/plain" })
+     *     ],
+     *   }
+     * )
+     * .then(({ files }) => {
+     *   console.log(files)
+     * })
+     */
+    create(body: HttpTypes.AdminUploadFile, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFileListResponse>;
+    /**
+     * This method retrieves a file's details by its ID. It sends a request to the
+     * [Get File](https://docs.medusajs.com/api/admin#uploads_getuploadsid)
+     * API route.
+     *
+     * @param id - The ID of the file to retrieve.
+     * @param query - Query parameters to pass in the request.
+     * @param headers - Headers to pass in the request.
+     * @returns The file's details.
+     *
+     * @example
+     * sdk.admin.upload.retrieve("test.txt")
+     * .then(({ file }) => {
+     *   console.log(file)
+     * })
+     */
+    retrieve(id: string, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminFileResponse>;
+    /**
+     * This method deletes a file by its ID from the configured File Module Provider. It sends a request to the
+     * [Delete File](https://docs.medusajs.com/api/admin#uploads_deleteuploadsid)
+     * API route.
+     *
+     * @param id - The ID of the file to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.upload.delete("test.txt")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminFileDeleteResponse>;
 }
 //# sourceMappingURL=upload.d.ts.map

package/dist/admin/upload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/admin/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAKpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;eAqBW,SAAS,CAAC,SAAS,EAAE;;IAenD,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;cACrC,SAAS,CAAC,SAAS;;IAShD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}
+{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/admin/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;IAoCzB;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa;IAUxE;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CASjD"}

package/dist/admin/upload.js

@@ -8,7 +8,38 @@ class Upload {
     constructor(client) {
         this.client = client;
     }
-    // Note: The creation/upload flow be made more advanced, with support for streaming and progress, but for now we keep it simple
+    /**
+     * This method creates a new upload. It sends a request to the
+     * [Upload Files](https://docs.medusajs.com/api/admin#uploads_postuploads)
+     * API route.
+     *
+     * @param body - The details of the files to upload.
+     * @param query - Configure the fields and relations to retrieve in the uploaded files.
+     * @param headers - Headers to pass in the request.
+     * @returns The upload files' details.
+     *
+     * @privateRemarks
+     *
+     * Note: The creation/upload flow be made more advanced, with support for streaming and progress, but for now we keep it simple
+     *
+     * @example
+     * sdk.admin.upload.create(
+     *   {
+     *     files: [
+     *        // file uploaded as a base64 string
+     *       {
+     *         name: "test.txt",
+     *         content: "test", // Should be the base64 content of the file
+     *       },
+     *       // file uploaded as a File object
+     *       new File(["test"], "test.txt", { type: "text/plain" })
+     *     ],
+     *   }
+     * )
+     * .then(({ files }) => {
+     *   console.log(files)
+     * })
+     */
     async create(body, query, headers) {
         const form = new FormData();
         if (body instanceof FileList) {
@@ -36,12 +67,43 @@ class Upload {
             query,
         });
     }
+    /**
+     * This method retrieves a file's details by its ID. It sends a request to the
+     * [Get File](https://docs.medusajs.com/api/admin#uploads_getuploadsid)
+     * API route.
+     *
+     * @param id - The ID of the file to retrieve.
+     * @param query - Query parameters to pass in the request.
+     * @param headers - Headers to pass in the request.
+     * @returns The file's details.
+     *
+     * @example
+     * sdk.admin.upload.retrieve("test.txt")
+     * .then(({ file }) => {
+     *   console.log(file)
+     * })
+     */
     async retrieve(id, query, headers) {
         return this.client.fetch(`/admin/uploads/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a file by its ID from the configured File Module Provider. It sends a request to the
+     * [Delete File](https://docs.medusajs.com/api/admin#uploads_deleteuploadsid)
+     * API route.
+     *
+     * @param id - The ID of the file to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.upload.delete("test.txt")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/uploads/${id}`, {
             method: "DELETE",

package/dist/admin/upload.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/admin/upload.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,+HAA+H;IAC/H,KAAK,CAAC,MAAM,CACV,IAA+B,EAC/B,KAAoB,EACpB,OAAuB;QAEvB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAA;QAC3B,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC1B,IAAI,CAAC,MAAM,CACT,OAAO,EACP,SAAS,IAAI,IAAI;oBACf,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;wBACvB,IAAI,EAAE,YAAY;qBACnB,CAAC;oBACJ,CAAC,CAAC,IAAI,EACR,IAAI,CAAC,IAAI,CACV,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,8CAA8C;gBAC9C,cAAc,EAAE,IAAI;aACrB;YACD,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AAvED,wBAuEC"}
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/admin/upload.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,MAAM,CACV,IAA+B,EAC/B,KAAoB,EACpB,OAAuB;QAEvB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAA;QAC3B,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC1B,IAAI,CAAC,MAAM,CACT,OAAO,EACP,SAAS,IAAI,IAAI;oBACf,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;wBACvB,IAAI,EAAE,YAAY;qBACnB,CAAC;oBACJ,CAAC,CAAC,IAAI,EACR,IAAI,CAAC,IAAI,CACV,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,8CAA8C;gBAC9C,cAAc,EAAE,IAAI;aACrB;YACD,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;YACE,KAAK;YACL,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AArID,wBAqIC"}

package/dist/admin/user.d.ts

@@ -10,10 +10,157 @@ export declare class User {
      * @ignore
      */
     constructor(client: Client);
+    /**
+     * This method updates a user. It sends a request to the
+     * [Update User](https://docs.medusajs.com/api/admin#users_postusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to update.
+     * @param body - The details of the user to update.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * sdk.admin.user.update("user_123", {
+     *   first_name: "John",
+     *   last_name: "Doe",
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateUser, query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;
+    /**
+     * This method retrieves a list of users. It sends a request to the
+     * [List Users](https://docs.medusajs.com/api/admin#users_getusers)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of users.
+     *
+     * @example
+     * To retrieve the list of users:
+     *
+     * ```ts
+     * sdk.admin.user.list()
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * 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.user.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each user:
+     *
+     * ```ts
+     * sdk.admin.user.list({
+     *   fields: "id,email"
+     * })
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     list(queryParams?: HttpTypes.AdminUserListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserListResponse>;
+    /**
+     * This method retrieves a user. It sends a request to the
+     * [Get User](https://docs.medusajs.com/api/admin#users_getusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the user.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * To retrieve a user by its ID:
+     *
+     * ```ts
+     * sdk.admin.user.retrieve("user_123")
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.user.retrieve("user_123", {
+     *   fields: "id,email"
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * 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.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;
+    /**
+     * This method deletes a user. It sends a request to the
+     * [Delete User](https://docs.medusajs.com/api/admin#users_deleteusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.user.delete("user_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminUserDeleteResponse>;
+    /**
+     * This method retrieves the currently authenticated user. It sends a request to the
+     * [Get Logged-In User](https://docs.medusajs.com/api/admin#users_getusersme)
+     * API route.
+     *
+     * @param query - Configure the fields and relations to retrieve in the user.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * To retrieve the currently authenticated user:
+     *
+     * ```ts
+     * sdk.admin.user.me()
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.user.me({
+     *   fields: "id,email"
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     me(query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;
 }
 //# sourceMappingURL=user.d.ts.map

package/dist/admin/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/admin/user.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,IAAI;IACf;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAC3C,OAAO,CAAC,EAAE,aAAa;IAQnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa;CAMpE"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/admin/user.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,IAAI;IACf;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAC3C,OAAO,CAAC,EAAE,aAAa;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAWzB;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa;CAMpE"}

package/dist/admin/user.js

@@ -8,6 +8,26 @@ class User {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This method updates a user. It sends a request to the
+     * [Update User](https://docs.medusajs.com/api/admin#users_postusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to update.
+     * @param body - The details of the user to update.
+     * @param query - Configure the fields and relations to retrieve in the tax region.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * sdk.admin.user.update("user_123", {
+     *   first_name: "John",
+     *   last_name: "Doe",
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     */
     async update(id, body, query, headers) {
         return this.client.fetch(`/admin/users/${id}`, {
             method: "POST",
@@ -16,24 +36,151 @@ class User {
             query,
         });
     }
+    /**
+     * This method retrieves a list of users. It sends a request to the
+     * [List Users](https://docs.medusajs.com/api/admin#users_getusers)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of users.
+     *
+     * @example
+     * To retrieve the list of users:
+     *
+     * ```ts
+     * sdk.admin.user.list()
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * 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.user.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each user:
+     *
+     * ```ts
+     * sdk.admin.user.list({
+     *   fields: "id,email"
+     * })
+     * .then(({ users, count, limit, offset }) => {
+     *   console.log(users)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     async list(queryParams, headers) {
         return this.client.fetch(`/admin/users`, {
             headers,
             query: queryParams,
         });
     }
+    /**
+     * This method retrieves a user. It sends a request to the
+     * [Get User](https://docs.medusajs.com/api/admin#users_getusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to retrieve.
+     * @param query - Configure the fields and relations to retrieve in the user.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * To retrieve a user by its ID:
+     *
+     * ```ts
+     * sdk.admin.user.retrieve("user_123")
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.user.retrieve("user_123", {
+     *   fields: "id,email"
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * 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 this.client.fetch(`/admin/users/${id}`, {
             query,
             headers,
         });
     }
+    /**
+     * This method deletes a user. It sends a request to the
+     * [Delete User](https://docs.medusajs.com/api/admin#users_deleteusersid)
+     * API route.
+     *
+     * @param id - The ID of the user to delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.user.delete("user_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     async delete(id, headers) {
         return this.client.fetch(`/admin/users/${id}`, {
             method: "DELETE",
             headers,
         });
     }
+    /**
+     * This method retrieves the currently authenticated user. It sends a request to the
+     * [Get Logged-In User](https://docs.medusajs.com/api/admin#users_getusersme)
+     * API route.
+     *
+     * @param query - Configure the fields and relations to retrieve in the user.
+     * @param headers - Headers to pass in the request.
+     * @returns The user's details.
+     *
+     * @example
+     * To retrieve the currently authenticated user:
+     *
+     * ```ts
+     * sdk.admin.user.me()
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.user.me({
+     *   fields: "id,email"
+     * })
+     * .then(({ user }) => {
+     *   console.log(user)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/api/admin#select-fields-and-relations).
+     */
     async me(query, headers) {
         return this.client.fetch(`/admin/users/me`, {
             query,