@acmekit/js-sdk 2.13.1

package/dist/admin/translation.js

@@ -0,0 +1,284 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Translation = void 0;
+class Translation {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a paginated list of translations. It sends a request to the
+     * [List Translations](https://docs.acmekit.com/api/admin#translations_gettranslations)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of translations.
+     *
+     * @example
+     * To retrieve the list of translations:
+     *
+     * ```ts
+     * sdk.admin.translation.list()
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * 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.translation.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each translation:
+     *
+     * ```ts
+     * sdk.admin.translation.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ translations, count, limit, offset }) => {
+     *   console.log(translations)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async list(query, headers) {
+        return await this.client.fetch(`/admin/translations`, {
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method allows bulk operations on translations. It sends a request to the
+     * [Manage Translations](https://docs.acmekit.com/api/admin#translations_posttranslationsbatch)
+     * API route.
+     *
+     * @param payload - The translations to create, update, or delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The translations' details.
+     *
+     * @example
+     * sdk.admin.translation.batch({
+     *   create: [
+     *     {
+     *       reference_id: "prod_123",
+     *       reference: "product",
+     *       locale_code: "en-US",
+     *       translations: { title: "Shirt" }
+     *     }
+     *   ],
+     *   update: [
+     *     {
+     *       id: "trans_123",
+     *       translations: { title: "Pants" }
+     *     }
+     *   ],
+     *   delete: ["trans_321"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     */
+    async batch(body, headers) {
+        return await this.client.fetch(`/admin/translations/batch`, {
+            method: "POST",
+            headers,
+            body,
+        });
+    }
+    /**
+     * This method retrieves the settings for the translations for a given entity type or all entity types if no entity type is provided.
+     * It sends a request to the
+     * [Get Translation Settings](https://docs.acmekit.com/api/admin#translations_gettranslationssettings) API route.
+     *
+     * @param query - The query parameters which can optionally include the entity type to get the settings for and whether to get the settings for active/inactive entities only.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation settings.
+     *
+     * @example
+     * To retrieve the settings for the translations for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   entity_type: "product"
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for all entity types:
+     *
+     * ```ts
+     * sdk.admin.translation.settings()
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for active entities only:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   is_active: true
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     *
+     * To retrieve the settings for inactive entities only:
+     *
+     * ```ts
+     * sdk.admin.translation.settings({
+     *   is_active: false
+     * })
+     * .then(({ translation_settings }) => {
+     *   console.log(translation_settings)
+     * })
+     * ```
+     */
+    async settings(query, headers) {
+        return await this.client.fetch(`/admin/translations/settings`, {
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method allows bulk operations on translation settings. It sends a request to the
+     * [Batch Translation Settings](https://docs.acmekit.com/api/admin#translations_posttranslationssettingsbatch)
+     * API route.
+     *
+     * @since 2.12.6
+     *
+     * @param body - The translation settings to create, update, or delete.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation settings' details.
+     *
+     * @example
+     * sdk.admin.translation.batchSettings({
+     *   create: [
+     *     {
+     *       entity_type: "product",
+     *       fields: ["title", "description"],
+     *       is_active: true
+     *     }
+     *   ],
+     *   update: [
+     *     {
+     *       id: "trset_123",
+     *       fields: ["title", "description", "subtitle"],
+     *       is_active: true
+     *     }
+     *   ],
+     *   delete: ["trset_456"]
+     * })
+     * .then(({ created, updated, deleted }) => {
+     *   console.log(created, updated, deleted)
+     * })
+     * ```
+     */
+    async batchSettings(body, headers) {
+        return await this.client.fetch(`/admin/translations/settings/batch`, {
+            method: "POST",
+            headers,
+            body,
+        });
+    }
+    /**
+     * This method retrieves a paginated list of entities for a given entity type with only their
+     * translatable fields.
+     * It sends a request to the
+     * [Get Translation Entities](https://docs.acmekit.com/api/admin#translations_gettranslationentities) API route.
+     *
+     * @since 2.12.4
+     *
+     * @param query - The query parameters including the entity type and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of entities with their translatable fields.
+     *
+     * @example
+     * To retrieve the entities for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.entities({
+     *   type: "product"
+     * })
+     * .then(({ data, count, offset, limit }) => {
+     *   console.log(data)
+     * })
+     * ```
+     *
+     * 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.translation.entities({
+     *   type: "product",
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ data, count, offset, limit }) => {
+     *   console.log(data)
+     * })
+     * ```
+     */
+    async entities(query, headers) {
+        return await this.client.fetch(`/admin/translations/entities`, {
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves the statistics for the translations for a given entity type or all entity types if no entity type is provided.
+     * It sends a request to the
+     * [Get Translation Statistics](https://docs.acmekit.com/api/admin#translations_gettranslationsstatistics) API route.
+     *
+     * @param query - The query parameters which can optionally include the entity type to get the statistics for.
+     * @param headers - Headers to pass in the request.
+     * @returns The translation statistics.
+     *
+     * @example
+     * To retrieve the statistics for the translations for a given entity type:
+     *
+     * ```ts
+     * sdk.admin.translation.statistics({
+     *   entity_type: "product"
+     * })
+     * .then(({ statistics }) => {
+     *   console.log(statistics)
+     * })
+     * ```
+     *
+     * To retrieve the statistics for all entity types:
+     *
+     * ```ts
+     * sdk.admin.translation.statistics()
+     * .then(({ statistics }) => {
+     *   console.log(statistics)
+     * })
+     * ```
+     */
+    async statistics(query, headers) {
+        return await this.client.fetch(`/admin/translations/statistics`, {
+            headers,
+            query,
+        });
+    }
+}
+exports.Translation = Translation;
+//# sourceMappingURL=translation.js.map

package/dist/admin/translation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation.js","sourceRoot":"","sources":["../../src/admin/translation.ts"],"names":[],"mappings":";;;AAIA,MAAa,WAAW;IAMtB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,qBAAqB,EACrB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,KAAK,CAAC,KAAK,CAAC,IAAsC,EAAE,OAAuB;QACzE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,2BAA2B,EAC3B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,KAAK,CAAC,QAAQ,CACZ,KAAgD,EAChD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,aAAa,CACjB,IAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,oCAAoC,EACpC;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;SACL,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,KAAK,CAAC,QAAQ,CACZ,KAA+C,EAC/C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,8BAA8B,EAC9B;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,UAAU,CACd,KAAkD,EAClD,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gCAAgC,EAChC;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlUD,kCAkUC"}

package/dist/admin/upload.d.ts

@@ -0,0 +1,97 @@
+import { HttpTypes, SelectParams } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Upload {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method creates a new upload. It sends a request to the
+     * [Upload Files](https://docs.acmekit.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 binary string
+     *       {
+     *         name: "test.txt",
+     *         content: "test", // Should be the binary string 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.acmekit.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.acmekit.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>;
+    /**
+     * This method creates a presigned URL for a file upload. It sends a request to the
+     * `/admin/uploads/presigned-urls` API route.
+     *
+     * @param body - The details of the file to upload.
+     * @param query - Query parameters to pass in the request.
+     * @param headers - Headers to pass in the request.
+     * @returns The presigned URL for the file upload.
+     *
+     * @example
+     * sdk.admin.upload.presignedUrl({
+     *   name: "test.txt",
+     *   size: 1000,
+     *   type: "text/plain",
+     * }))
+     */
+    presignedUrl(body: HttpTypes.AdminUploadPreSignedUrlRequest, query?: SelectParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUploadPreSignedUrlResponse>;
+}
+//# sourceMappingURL=upload.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/admin/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AACxD,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;IAUhD;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAChB,IAAI,EAAE,SAAS,CAAC,8BAA8B,EAC9C,KAAK,CAAC,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,aAAa;CAY1B"}

package/dist/admin/upload.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Upload = void 0;
+class Upload {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method creates a new upload. It sends a request to the
+     * [Upload Files](https://docs.acmekit.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 binary string
+     *       {
+     *         name: "test.txt",
+     *         content: "test", // Should be the binary string 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) {
+            Array.from(body).forEach((file) => {
+                form.append("files", file);
+            });
+        }
+        else {
+            body.files.forEach((file) => {
+                form.append("files", "content" in file
+                    ? new Blob([file.content], {
+                        type: "text/plain",
+                    })
+                    : file, file.name);
+            });
+        }
+        return this.client.fetch(`/admin/uploads`, {
+            method: "POST",
+            headers: {
+                ...headers,
+                // Let the browser determine the content type.
+                "content-type": null,
+            },
+            body: form,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a file's details by its ID. It sends a request to the
+     * [Get File](https://docs.acmekit.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.acmekit.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",
+            headers,
+        });
+    }
+    /**
+     * This method creates a presigned URL for a file upload. It sends a request to the
+     * `/admin/uploads/presigned-urls` API route.
+     *
+     * @param body - The details of the file to upload.
+     * @param query - Query parameters to pass in the request.
+     * @param headers - Headers to pass in the request.
+     * @returns The presigned URL for the file upload.
+     *
+     * @example
+     * sdk.admin.upload.presignedUrl({
+     *   name: "test.txt",
+     *   size: 1000,
+     *   type: "text/plain",
+     * }))
+     */
+    async presignedUrl(body, query, headers) {
+        return this.client.fetch(`/admin/uploads/presigned-urls`, {
+            method: "POST",
+            headers,
+            body,
+            query,
+        });
+    }
+}
+exports.Upload = Upload;
+//# sourceMappingURL=upload.js.map

package/dist/admin/upload.js.map

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,YAAY,CAChB,IAA8C,EAC9C,KAAoB,EACpB,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,+BAA+B,EAC/B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AArKD,wBAqKC"}

package/dist/admin/user.d.ts

@@ -0,0 +1,166 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class User {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method updates a user. It sends a request to the
+     * [Update User](https://docs.acmekit.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.acmekit.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.acmekit.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.acmekit.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.acmekit.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.acmekit.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.acmekit.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.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    me(query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;
+}
+//# sourceMappingURL=user.d.ts.map