@notiflows/node 0.0.1

package/resources/users/preferences.d.mts

@@ -0,0 +1,166 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Preferences extends APIResource {
+    /**
+     * Retrieve a user's notification preferences.
+     *
+     * Preferences control which notifications the user receives:
+     *
+     * - `channel_types`: Global opt-in/opt-out per channel type (email, sms, push,
+     *   etc.)
+     * - `notiflows`: Per-notiflow preferences with optional channel overrides
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.retrieve(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    retrieve(userID: string, options?: RequestOptions): APIPromise<Preferences>;
+    /**
+     * Update a user's notification preferences. Only provided fields are updated
+     * (partial update).
+     *
+     * **Channel types:** Set to `false` to opt the user out of a channel globally.
+     *
+     * **Notiflow preferences:** Override settings for specific notiflows:
+     *
+     * ```json
+     * {
+     *   "notiflows": {
+     *     "notiflow_uuid": {
+     *       "enabled": true,
+     *       "channel_types": {
+     *         "email": false
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.update(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    update(userID: string, body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<Preferences>;
+}
+/**
+ * User notification preferences
+ */
+export interface Preferences {
+    /**
+     * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+     * opted out.
+     */
+    channel_types?: Preferences.ChannelTypes;
+    /**
+     * Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+     */
+    notiflows?: {
+        [key: string]: Preferences.Notiflows;
+    };
+}
+export declare namespace Preferences {
+    /**
+     * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+     * opted out.
+     */
+    interface ChannelTypes {
+        /**
+         * Chat notifications (Slack, etc.)
+         */
+        chat?: boolean;
+        /**
+         * Email notifications
+         */
+        email?: boolean;
+        /**
+         * In-app feed notifications
+         */
+        in_app?: boolean;
+        /**
+         * Mobile push notifications (iOS/Android)
+         */
+        mobile_push?: boolean;
+        /**
+         * SMS notifications
+         */
+        sms?: boolean;
+        /**
+         * Web push notifications
+         */
+        web_push?: boolean;
+    }
+    interface Notiflows {
+        /**
+         * Channel-specific overrides for this notiflow
+         */
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        /**
+         * Whether this notiflow is enabled for the user
+         */
+        enabled?: boolean;
+        /**
+         * Notiflow name (read-only, for display)
+         */
+        name?: string;
+    }
+}
+/**
+ * Request body for updating user preferences. Only provided fields are updated.
+ */
+export interface UpdatePreferencesRequest {
+    /**
+     * Global channel type preferences
+     */
+    channel_types?: {
+        [key: string]: boolean;
+    };
+    /**
+     * Per-notiflow preferences (keyed by notiflow ID)
+     */
+    notiflows?: {
+        [key: string]: UpdatePreferencesRequest.Notiflows;
+    };
+}
+export declare namespace UpdatePreferencesRequest {
+    interface Notiflows {
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        enabled?: boolean;
+    }
+}
+export interface PreferenceUpdateParams {
+    /**
+     * Global channel type preferences
+     */
+    channel_types?: {
+        [key: string]: boolean;
+    };
+    /**
+     * Per-notiflow preferences (keyed by notiflow ID)
+     */
+    notiflows?: {
+        [key: string]: PreferenceUpdateParams.Notiflows;
+    };
+}
+export declare namespace PreferenceUpdateParams {
+    interface Notiflows {
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        enabled?: boolean;
+    }
+}
+export declare namespace Preferences {
+    export { type Preferences as Preferences, type UpdatePreferencesRequest as UpdatePreferencesRequest, type PreferenceUpdateParams as PreferenceUpdateParams, };
+}
+//# sourceMappingURL=preferences.d.mts.map

package/resources/users/preferences.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.mts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI3E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAGxG;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,SAAS,CAAA;KAAE,CAAC;CACtD;AAED,yBAAiB,WAAW,CAAC;IAC3B;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAC,SAAS,CAAA;KAAE,CAAC;CACnE;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,SAAS;QACxB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,CAAC,SAAS,CAAA;KAAE,CAAC;CACjE;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,SAAS;QACxB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/users/preferences.d.ts

@@ -0,0 +1,166 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Preferences extends APIResource {
+    /**
+     * Retrieve a user's notification preferences.
+     *
+     * Preferences control which notifications the user receives:
+     *
+     * - `channel_types`: Global opt-in/opt-out per channel type (email, sms, push,
+     *   etc.)
+     * - `notiflows`: Per-notiflow preferences with optional channel overrides
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.retrieve(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    retrieve(userID: string, options?: RequestOptions): APIPromise<Preferences>;
+    /**
+     * Update a user's notification preferences. Only provided fields are updated
+     * (partial update).
+     *
+     * **Channel types:** Set to `false` to opt the user out of a channel globally.
+     *
+     * **Notiflow preferences:** Override settings for specific notiflows:
+     *
+     * ```json
+     * {
+     *   "notiflows": {
+     *     "notiflow_uuid": {
+     *       "enabled": true,
+     *       "channel_types": {
+     *         "email": false
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.update(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    update(userID: string, body: PreferenceUpdateParams, options?: RequestOptions): APIPromise<Preferences>;
+}
+/**
+ * User notification preferences
+ */
+export interface Preferences {
+    /**
+     * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+     * opted out.
+     */
+    channel_types?: Preferences.ChannelTypes;
+    /**
+     * Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+     */
+    notiflows?: {
+        [key: string]: Preferences.Notiflows;
+    };
+}
+export declare namespace Preferences {
+    /**
+     * Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+     * opted out.
+     */
+    interface ChannelTypes {
+        /**
+         * Chat notifications (Slack, etc.)
+         */
+        chat?: boolean;
+        /**
+         * Email notifications
+         */
+        email?: boolean;
+        /**
+         * In-app feed notifications
+         */
+        in_app?: boolean;
+        /**
+         * Mobile push notifications (iOS/Android)
+         */
+        mobile_push?: boolean;
+        /**
+         * SMS notifications
+         */
+        sms?: boolean;
+        /**
+         * Web push notifications
+         */
+        web_push?: boolean;
+    }
+    interface Notiflows {
+        /**
+         * Channel-specific overrides for this notiflow
+         */
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        /**
+         * Whether this notiflow is enabled for the user
+         */
+        enabled?: boolean;
+        /**
+         * Notiflow name (read-only, for display)
+         */
+        name?: string;
+    }
+}
+/**
+ * Request body for updating user preferences. Only provided fields are updated.
+ */
+export interface UpdatePreferencesRequest {
+    /**
+     * Global channel type preferences
+     */
+    channel_types?: {
+        [key: string]: boolean;
+    };
+    /**
+     * Per-notiflow preferences (keyed by notiflow ID)
+     */
+    notiflows?: {
+        [key: string]: UpdatePreferencesRequest.Notiflows;
+    };
+}
+export declare namespace UpdatePreferencesRequest {
+    interface Notiflows {
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        enabled?: boolean;
+    }
+}
+export interface PreferenceUpdateParams {
+    /**
+     * Global channel type preferences
+     */
+    channel_types?: {
+        [key: string]: boolean;
+    };
+    /**
+     * Per-notiflow preferences (keyed by notiflow ID)
+     */
+    notiflows?: {
+        [key: string]: PreferenceUpdateParams.Notiflows;
+    };
+}
+export declare namespace PreferenceUpdateParams {
+    interface Notiflows {
+        channel_types?: {
+            [key: string]: boolean;
+        };
+        enabled?: boolean;
+    }
+}
+export declare namespace Preferences {
+    export { type Preferences as Preferences, type UpdatePreferencesRequest as UpdatePreferencesRequest, type PreferenceUpdateParams as PreferenceUpdateParams, };
+}
+//# sourceMappingURL=preferences.d.ts.map

package/resources/users/preferences.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.d.ts","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI3E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;CAGxG;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,SAAS,CAAA;KAAE,CAAC;CACtD;AAED,yBAAiB,WAAW,CAAC;IAC3B;;;OAGG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,UAAiB,SAAS;QACxB;;WAEG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAC,SAAS,CAAA;KAAE,CAAC;CACnE;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,SAAS;QACxB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,sBAAsB,CAAC,SAAS,CAAA;KAAE,CAAC;CACjE;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,SAAS;QACxB,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/users/preferences.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Preferences = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Preferences extends resource_1.APIResource {
+    /**
+     * Retrieve a user's notification preferences.
+     *
+     * Preferences control which notifications the user receives:
+     *
+     * - `channel_types`: Global opt-in/opt-out per channel type (email, sms, push,
+     *   etc.)
+     * - `notiflows`: Per-notiflow preferences with optional channel overrides
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.retrieve(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    retrieve(userID, options) {
+        return this._client.get((0, path_1.path) `/users/${userID}/preferences`, options);
+    }
+    /**
+     * Update a user's notification preferences. Only provided fields are updated
+     * (partial update).
+     *
+     * **Channel types:** Set to `false` to opt the user out of a channel globally.
+     *
+     * **Notiflow preferences:** Override settings for specific notiflows:
+     *
+     * ```json
+     * {
+     *   "notiflows": {
+     *     "notiflow_uuid": {
+     *       "enabled": true,
+     *       "channel_types": {
+     *         "email": false
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.update(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    update(userID, body, options) {
+        return this._client.put((0, path_1.path) `/users/${userID}/preferences`, { body, ...options });
+    }
+}
+exports.Preferences = Preferences;
+//# sourceMappingURL=preferences.js.map

package/resources/users/preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAAc,EAAE,IAA4B,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,UAAU,MAAM,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AApDD,kCAoDC"}

package/resources/users/preferences.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Preferences extends APIResource {
+    /**
+     * Retrieve a user's notification preferences.
+     *
+     * Preferences control which notifications the user receives:
+     *
+     * - `channel_types`: Global opt-in/opt-out per channel type (email, sms, push,
+     *   etc.)
+     * - `notiflows`: Per-notiflow preferences with optional channel overrides
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.retrieve(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    retrieve(userID, options) {
+        return this._client.get(path `/users/${userID}/preferences`, options);
+    }
+    /**
+     * Update a user's notification preferences. Only provided fields are updated
+     * (partial update).
+     *
+     * **Channel types:** Set to `false` to opt the user out of a channel globally.
+     *
+     * **Notiflow preferences:** Override settings for specific notiflows:
+     *
+     * ```json
+     * {
+     *   "notiflows": {
+     *     "notiflow_uuid": {
+     *       "enabled": true,
+     *       "channel_types": {
+     *         "email": false
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.preferences.update(
+     *   'user_12345',
+     * );
+     * ```
+     */
+    update(userID, body, options) {
+        return this._client.put(path `/users/${userID}/preferences`, { body, ...options });
+    }
+}
+//# sourceMappingURL=preferences.mjs.map

package/resources/users/preferences.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.mjs","sourceRoot":"","sources":["../../src/resources/users/preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CAAC,MAAc,EAAE,IAA4B,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,UAAU,MAAM,cAAc,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}

package/resources/users/subscriptions.d.mts

@@ -0,0 +1,121 @@
+import { APIResource } from "../../core/resource.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Subscriptions extends APIResource {
+    /**
+     * Check if a user is subscribed to a specific topic.
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.users.subscriptions.retrieve(
+     *     'order-updates',
+     *     { user_id: 'user_12345' },
+     *   );
+     * ```
+     */
+    retrieve(topicName: string, params: SubscriptionRetrieveParams, options?: RequestOptions): APIPromise<Subscription>;
+    /**
+     * Retrieve all topic subscriptions for a user.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscription of client.users.subscriptions.list(
+     *   'user_12345',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(userID: string, query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionsCursorPage, Subscription>;
+    /**
+     * Subscribe a user to a topic. Topics are created automatically if they don't
+     * exist.
+     *
+     * **Idempotent:** If the user is already subscribed, returns the existing
+     * subscription with `200 OK`.
+     *
+     * @example
+     * ```ts
+     * const subscription =
+     *   await client.users.subscriptions.subscribe('user_12345', {
+     *     topic_name: 'order-updates',
+     *   });
+     * ```
+     */
+    subscribe(userID: string, body: SubscriptionSubscribeParams, options?: RequestOptions): APIPromise<Subscription>;
+    /**
+     * Remove a user's subscription from a topic. The user will no longer receive
+     * notifications triggered for this topic.
+     *
+     * @example
+     * ```ts
+     * await client.users.subscriptions.unsubscribe(
+     *   'order-updates',
+     *   { user_id: 'user_12345' },
+     * );
+     * ```
+     */
+    unsubscribe(topicName: string, params: SubscriptionUnsubscribeParams, options?: RequestOptions): APIPromise<void>;
+}
+export type SubscriptionsCursorPage = CursorPage<Subscription>;
+/**
+ * A user's subscription to a topic
+ */
+export interface Subscription {
+    /**
+     * Subscription ID
+     */
+    id: string;
+    /**
+     * When the subscription was created
+     */
+    created_at: string;
+    /**
+     * Name of the subscribed topic
+     */
+    topic_name: string;
+    /**
+     * User's internal ID
+     */
+    user_id: string;
+}
+export interface SubscriptionRetrieveParams {
+    /**
+     * User external ID
+     */
+    user_id: string;
+}
+export interface SubscriptionListParams extends CursorPageParams {
+    /**
+     * Cursor for fetching the previous page
+     */
+    before?: string;
+    /**
+     * Filter by created after (ISO 8601 datetime)
+     */
+    created_after?: string;
+    /**
+     * Filter by created before (ISO 8601 datetime)
+     */
+    created_before?: string;
+}
+export interface SubscriptionSubscribeParams {
+    /**
+     * Name of the topic to subscribe to. Topics are created automatically if they
+     * don't exist.
+     */
+    topic_name: string;
+}
+export interface SubscriptionUnsubscribeParams {
+    /**
+     * User external ID
+     */
+    user_id: string;
+}
+export declare namespace Subscriptions {
+    export { type Subscription as Subscription, type SubscriptionsCursorPage as SubscriptionsCursorPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionSubscribeParams as SubscriptionSubscribeParams, type SubscriptionUnsubscribeParams as SubscriptionUnsubscribeParams, };
+}
+//# sourceMappingURL=subscriptions.d.mts.map

package/resources/users/subscriptions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.mts","sourceRoot":"","sources":["../../src/resources/users/subscriptions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAElD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAK3B;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAOrD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;OAWG;IACH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}