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

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

@@ -8,7 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 const taxRegionUrl = "/admin/tax-regions";
-// TODO: Add support for updating a tax region
+/**
+ * @privateRemarks
+ *
+ * TODO: Add support for updating a tax region
+ */
 export class TaxRegion {
     /**
      * @ignore
@@ -16,6 +20,31 @@ export 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)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(taxRegionUrl, {
@@ -26,6 +55,21 @@ export class TaxRegion {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`${taxRegionUrl}/${id}`, {
@@ -34,6 +78,39 @@ export class TaxRegion {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`${taxRegionUrl}/${id}`, {
@@ -43,6 +120,53 @@ export class TaxRegion {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(taxRegionUrl, {

package/dist/esm/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,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"tax-region.js","sourceRoot":"","sources":["../../../src/admin/tax-region.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,YAAY,GAAG,oBAAoB,CAAA;AAEzC;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAKpB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,IAAoC,EACpC,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAU,EACV,KAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,GAAG,YAAY,IAAI,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAA0C,EAC1C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,YAAY,EACZ;gBACE,MAAM,EAAE,KAAK;gBACb,OAAO;gBACP,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/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/esm/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/esm/admin/upload.js

@@ -14,7 +14,38 @@ export 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)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             const form = new FormData();
@@ -42,6 +73,22 @@ export class Upload {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/uploads/${id}`, {
@@ -50,6 +97,21 @@ export class Upload {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/uploads/${id}`, {

package/dist/esm/admin/upload.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../../src/admin/upload.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,+HAA+H;IACzH,MAAM,CACV,IAA+B,EAC/B,KAAoB,EACpB,OAAuB;;YAEvB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAA;YAC3B,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5B,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC1B,IAAI,CAAC,MAAM,CACT,OAAO,EACP,SAAS,IAAI,IAAI;wBACf,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;4BACvB,IAAI,EAAE,YAAY;yBACnB,CAAC;wBACJ,CAAC,CAAC,IAAI,EACR,IAAI,CAAC,IAAI,CACV,CAAA;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO,kCACF,OAAO;oBACV,8CAA8C;oBAC9C,cAAc,EAAE,IAAI,GACrB;gBACD,IAAI,EAAE,IAAI;gBACV,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../../src/admin/upload.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,MAAM,CACV,IAA+B,EAC/B,KAAoB,EACpB,OAAuB;;YAEvB,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAA;YAC3B,IAAI,IAAI,YAAY,QAAQ,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;gBAC5B,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC1B,IAAI,CAAC,MAAM,CACT,OAAO,EACP,SAAS,IAAI,IAAI;wBACf,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;4BACvB,IAAI,EAAE,YAAY;yBACnB,CAAC;wBACJ,CAAC,CAAC,IAAI,EACR,IAAI,CAAC,IAAI,CACV,CAAA;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAChB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO,kCACF,OAAO;oBACV,8CAA8C;oBAC9C,cAAc,EAAE,IAAI,GACrB;gBACD,IAAI,EAAE,IAAI;gBACV,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;;YACtE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,EAAE,EAAE,EACtB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

package/dist/esm/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/esm/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/esm/admin/user.js

@@ -14,6 +14,26 @@ export 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)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/users/${id}`, {
@@ -24,6 +44,53 @@ export class User {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/users`, {
@@ -32,6 +99,39 @@ export class User {
             });
         });
     }
+    /**
+     * 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, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/users/${id}`, {
@@ -40,6 +140,21 @@ export class User {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/users/${id}`, {
@@ -48,6 +163,38 @@ export class User {
             });
         });
     }
+    /**
+     * 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, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.client.fetch(`/admin/users/me`, {