@acmekit/js-sdk 2.13.1

package/dist/admin/invite.js

@@ -0,0 +1,211 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Invite = void 0;
+class Invite {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method accepts an invite. It requires sending a previous request to
+     * the {@link Auth.register}.
+     *
+     * This method sends a request to the [Accept Invite]
+     * (https://docs.acmekit.com/api/admin#invites_postinvitesaccept)
+     * API route.
+     *
+     * @param input - The details of the user to create.
+     * @param query - Configure the fields to retrieve in the user.
+     * @param headers - Headers to pass in the request
+     * @returns The user's details.
+     *
+     * @example
+     * await sdk.auth.register("user", "emailpass", {
+     *   email: "user@gmail.com",
+     *   password: "supersecret"
+     * })
+     *
+     * // all subsequent requests will use the token in the header
+     * const { user } = await sdk.admin.invite.accept(
+     *   {
+     *     email: "user@gmail.com",
+     *     first_name: "John",
+     *     last_name: "Smith",
+     *     invite_token: "12345..."
+     *   },
+     * )
+     */
+    async accept(input, query, headers) {
+        const { invite_token, ...rest } = input;
+        return await this.client.fetch(`/admin/invites/accept?token=${input.invite_token}`, {
+            method: "POST",
+            headers,
+            body: rest,
+            query,
+        });
+    }
+    /**
+     * This method creates an invite. It sends a request to the
+     * [Create Invite](https://docs.acmekit.com/api/admin#invites_postinvites)
+     * API route.
+     *
+     * @param body - The invite's details.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.create({
+     *   email: "user@gmail.com",
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
+    async create(body, query, headers) {
+        return await this.client.fetch(`/admin/invites`, {
+            method: "POST",
+            headers,
+            body,
+            query,
+        });
+    }
+    /**
+     * This method retrieves an invite by its ID. It sends a request to the
+     * [Get Invite](https://docs.acmekit.com/api/admin#invites_getinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param query - Configure the fields to retrieve in the invite.
+     * @param headers - Headers to pass in the request
+     * @returns The invite's details.
+     *
+     * @example
+     * To retrieve an invite its ID:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.invite.retrieve("invite_123", {
+     *   fields: "id,email"
+     * })
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async retrieve(id, query, headers) {
+        return await this.client.fetch(`/admin/invites/${id}`, {
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a paginated list of invites. It sends a request to the
+     * [List Invites](https://docs.acmekit.com/api/admin#invites_getinvites)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of invites.
+     *
+     * @example
+     * To retrieve the list of invites:
+     *
+     * ```ts
+     * sdk.admin.invite.list()
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * 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.invite.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each invite:
+     *
+     * ```ts
+     * sdk.admin.invite.list({
+     *   fields: "id,email"
+     * })
+     * .then(({ invites, count, limit, offset }) => {
+     *   console.log(invites)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async list(queryParams, headers) {
+        return await this.client.fetch(`/admin/invites`, {
+            headers,
+            query: queryParams,
+        });
+    }
+    /**
+     * This method refreshes the token of an invite. It sends a request to the
+     * [Refresh Invite Token](https://docs.acmekit.com/api/admin#invites_postinvitesidresend)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The invite's details.
+     *
+     * @example
+     * sdk.admin.invite.resend("invite_123")
+     * .then(({ invite }) => {
+     *   console.log(invite)
+     * })
+     */
+    async resend(id, headers) {
+        return await this.client.fetch(`/admin/invites/${id}/resend`, {
+            method: "POST",
+            headers,
+        });
+    }
+    /**
+     * This method deletes an invite. It sends a request to the
+     * [Delete Invite](https://docs.acmekit.com/api/admin#invites_deleteinvitesid)
+     * API route.
+     *
+     * @param id - The invite's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.invite.delete("invite_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
+    async delete(id, headers) {
+        return await this.client.fetch(`/admin/invites/${id}`, {
+            method: "DELETE",
+            headers,
+        });
+    }
+}
+exports.Invite = Invite;
+//# sourceMappingURL=invite.js.map

package/dist/admin/invite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invite.js","sourceRoot":"","sources":["../../src/admin/invite.ts"],"names":[],"mappings":";;;AAQA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,MAAM,CACV,KAKC,EACD,KAAoB,EACpB,OAAuB;QAEvB,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAA;QACvC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,KAAK,CAAC,YAAY,EAAE,EACnD;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI;YACV,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,MAAM,CACV,IAAiC,EACjC,KAAoB,EACpB,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI;YACJ,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAoB,EAAE,OAAuB;QACtE,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,WAAwB,EAAE,OAAuB;QAC1D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,gBAAgB,EAAE;YAClB,OAAO;YACP,KAAK,EAAE,WAAW;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,SAAS,EAC7B;YACE,MAAM,EAAE,MAAM;YACd,OAAO;SACR,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB;QAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,kBAAkB,EAAE,EAAE,EACtB;YACE,MAAM,EAAE,QAAQ;YAChB,OAAO;SACR,CACF,CAAA;IACH,CAAC;CACF;AArPD,wBAqPC"}

package/dist/admin/locale.d.ts

@@ -0,0 +1,95 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Locale {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a paginated list of locales. It sends a request to the
+     * [List Locales](https://docs.acmekit.com/api/admin#locales_getlocales)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of locales.
+     *
+     * @example
+     * To retrieve the list of locales:
+     *
+     * ```ts
+     * sdk.admin.locale.list()
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * 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.locale.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each locale:
+     *
+     * ```ts
+     * sdk.admin.locale.list({
+     *   fields: "code,name"
+     * })
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminLocaleListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminLocaleListResponse>;
+    /**
+     * This method retrieves a locale by its code. It sends a request to the
+     * [Get Locale](https://docs.acmekit.com/api/admin#locales_getlocalescode) API route.
+     *
+     * @param code - The locale's code in BCP 47 format.
+     * @param query - Configure the fields to retrieve in the locale.
+     * @param headers - Headers to pass in the request
+     * @returns The locale's details.
+     *
+     * @example
+     * To retrieve a locale by its code:
+     *
+     * ```ts
+     * sdk.admin.locale.retrieve("en-US")
+     * .then(({ locale }) => {
+     *   console.log(locale)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.locale.retrieve("en-US", {
+     *   fields: "code,name"
+     * })
+     * .then(({ locale }) => {
+     *   console.log(locale)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    retrieve(code: string, query?: HttpTypes.AdminLocaleParams, headers?: ClientHeaders): Promise<HttpTypes.AdminLocaleResponse>;
+}
+//# sourceMappingURL=locale.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"locale.d.ts","sourceRoot":"","sources":["../../src/admin/locale.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE,aAAa;IAU3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,SAAS,CAAC,iBAAiB,EACnC,OAAO,CAAC,EAAE,aAAa;CAU1B"}

package/dist/admin/locale.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Locale = void 0;
+class Locale {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a paginated list of locales. It sends a request to the
+     * [List Locales](https://docs.acmekit.com/api/admin#locales_getlocales)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of locales.
+     *
+     * @example
+     * To retrieve the list of locales:
+     *
+     * ```ts
+     * sdk.admin.locale.list()
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * 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.locale.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each locale:
+     *
+     * ```ts
+     * sdk.admin.locale.list({
+     *   fields: "code,name"
+     * })
+     * .then(({ locales, count, limit, offset }) => {
+     *   console.log(locales)
+     * })
+     * ```
+     *
+     * 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 this.client.fetch(`/admin/locales`, {
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a locale by its code. It sends a request to the
+     * [Get Locale](https://docs.acmekit.com/api/admin#locales_getlocalescode) API route.
+     *
+     * @param code - The locale's code in BCP 47 format.
+     * @param query - Configure the fields to retrieve in the locale.
+     * @param headers - Headers to pass in the request
+     * @returns The locale's details.
+     *
+     * @example
+     * To retrieve a locale by its code:
+     *
+     * ```ts
+     * sdk.admin.locale.retrieve("en-US")
+     * .then(({ locale }) => {
+     *   console.log(locale)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.locale.retrieve("en-US", {
+     *   fields: "code,name"
+     * })
+     * .then(({ locale }) => {
+     *   console.log(locale)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async retrieve(code, query, headers) {
+        return this.client.fetch(`/admin/locales/${code}`, {
+            headers,
+            query,
+        });
+    }
+}
+exports.Locale = Locale;
+//# sourceMappingURL=locale.js.map

package/dist/admin/locale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locale.js","sourceRoot":"","sources":["../../src/admin/locale.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CAAC,KAAuC,EAAE,OAAuB;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAChB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CACZ,IAAY,EACZ,KAAmC,EACnC,OAAuB;QAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,kBAAkB,IAAI,EAAE,EACxB;YACE,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAlHD,wBAkHC"}

package/dist/admin/notification.d.ts

@@ -0,0 +1,96 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders } from "../types";
+export declare class Notification {
+    /**
+     * @ignore
+     */
+    private client;
+    /**
+     * @ignore
+     */
+    constructor(client: Client);
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.acmekit.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    retrieve(id: string, query?: HttpTypes.AdminNotificationParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationResponse>;
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.acmekit.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    list(query?: HttpTypes.AdminNotificationListParams, headers?: ClientHeaders): Promise<HttpTypes.AdminNotificationListResponse>;
+}
+//# sourceMappingURL=notification.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,YAAY;IACvB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,uBAAuB,EACzC,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,IAAI,CACR,KAAK,CAAC,EAAE,SAAS,CAAC,2BAA2B,EAC7C,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/admin/notification.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notification = void 0;
+class Notification {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a notification's details. It sends a request to the
+     * [Get Notification](https://docs.acmekit.com/api/admin#notifications_getnotificationsid)
+     * API route.
+     *
+     * @param id - The notification's ID.
+     * @param query - Configure the fields to retrieve in the notification.
+     * @param headers - Headers to pass in the request
+     * @returns The notification's details.
+     *
+     * @example
+     * To retrieve a notification by its ID:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123")
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * To specify the fields and relations to retrieve:
+     *
+     * ```ts
+     * sdk.admin.notification.retrieve("notif_123", {
+     *   fields: "id,to"
+     * })
+     * .then(({ notification }) => {
+     *   console.log(notification)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/store#select-fields-and-relations).
+     */
+    async retrieve(id, query, headers) {
+        return await this.client.fetch(`/admin/notifications/${id}`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+    /**
+     * This method retrieves a paginated list of notifications. It sends a request to the
+     * [List Notifications](https://docs.acmekit.com/api/admin#notifications_getnotifications)
+     * API route.
+     *
+     * @param query - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of notifications.
+     *
+     * @example
+     * To retrieve the list of notifications:
+     *
+     * ```ts
+     * sdk.admin.notification.list()
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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.notification.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each notification:
+     *
+     * ```ts
+     * sdk.admin.notification.list({
+     *   fields: "id,to"
+     * })
+     * .then(({ notifications, count, limit, offset }) => {
+     *   console.log(notifications)
+     * })
+     * ```
+     *
+     * 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/notifications`, {
+            method: "GET",
+            headers,
+            query,
+        });
+    }
+}
+exports.Notification = Notification;
+//# sourceMappingURL=notification.js.map

package/dist/admin/notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../src/admin/notification.ts"],"names":[],"mappings":";;;AAIA,MAAa,YAAY;IAKvB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,KAAyC,EACzC,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,wBAAwB,EAAE,EAAE,EAC5B;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,KAAK,CAAC,IAAI,CACR,KAA6C,EAC7C,OAAuB;QAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,sBAAsB,EACtB;YACE,MAAM,EAAE,KAAK;YACb,OAAO;YACP,KAAK;SACN,CACF,CAAA;IACH,CAAC;CACF;AAxHD,oCAwHC"}