@notiflows/node 0.0.1

package/resources/notifications.d.ts

@@ -0,0 +1,170 @@
+import { APIResource } from "../core/resource.js";
+import * as DeliveriesAPI from "./deliveries.js";
+import { DeliveriesCursorPage } from "./deliveries.js";
+import * as UsersAPI from "./users/users.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Notifications extends APIResource {
+    /**
+     * Retrieve a single notification by ID, including the recipient, actor, and all
+     * delivery attempts.
+     *
+     * @example
+     * ```ts
+     * const notification = await client.notifications.retrieve(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Notification>;
+    /**
+     * Retrieve a paginated list of all notifications in your project.
+     *
+     * A notification represents a message sent to a single recipient through a
+     * notiflow run. Each notification can have multiple deliveries (one per channel).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const notification of client.notifications.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: NotificationListParams | null | undefined, options?: RequestOptions): PagePromise<NotificationsCursorPage, Notification>;
+    /**
+     * Retrieve all delivery attempts for a specific notification.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const delivery of client.notifications.listDeliveries(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listDeliveries(notificationID: string, query?: NotificationListDeliveriesParams | null | undefined, options?: RequestOptions): PagePromise<DeliveriesCursorPage, DeliveriesAPI.Delivery>;
+}
+export type NotificationsCursorPage = CursorPage<Notification>;
+/**
+ * A notification sent to a recipient through a notiflow run
+ */
+export interface Notification {
+    /**
+     * Notification ID
+     */
+    id: string;
+    /**
+     * When the notification was created
+     */
+    created_at: string;
+    /**
+     * Template variables passed when running the notiflow
+     */
+    data: unknown;
+    /**
+     * ID of the notiflow that generated this notification
+     */
+    notiflow_id: string;
+    /**
+     * ID of the specific notiflow run
+     */
+    notiflow_run_id: string;
+    /**
+     * Internal ID of the recipient user
+     */
+    recipient_id: string;
+    /**
+     * Notification processing status:
+     *
+     * - `pending`: Queued for processing
+     * - `processing`: Currently being processed
+     * - `processed`: Successfully processed (deliveries created)
+     * - `failed`: Processing failed
+     */
+    status: 'pending' | 'processing' | 'processed' | 'failed';
+    /**
+     * When the notification was last updated
+     */
+    updated_at: string;
+    /**
+     * A user (recipient) in your project
+     */
+    actor?: UsersAPI.User | null;
+    /**
+     * Internal ID of the actor (user who triggered the notification)
+     */
+    actor_id?: string | null;
+    /**
+     * Delivery attempts for this notification (when expanded)
+     */
+    deliveries?: Array<DeliveriesAPI.Delivery>;
+    /**
+     * When the notification was processed
+     */
+    processed_at?: string | null;
+    /**
+     * A user (recipient) in your project
+     */
+    recipient?: UsersAPI.User;
+    /**
+     * Topic name if triggered via topic
+     */
+    topic?: string | null;
+}
+export interface NotificationListParams 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;
+    /**
+     * Filter by status
+     */
+    status?: string;
+    /**
+     * Filter by topic
+     */
+    topic?: string;
+}
+export interface NotificationListDeliveriesParams extends CursorPageParams {
+    /**
+     * Cursor for fetching the previous page
+     */
+    before?: string;
+    /**
+     * Filter by channel ID (UUID)
+     */
+    channel_id?: string;
+    /**
+     * Filter by created after (ISO 8601 datetime)
+     */
+    created_after?: string;
+    /**
+     * Filter by created before (ISO 8601 datetime)
+     */
+    created_before?: string;
+    /**
+     * Filter by status (pending, sent, failed)
+     */
+    status?: string;
+    /**
+     * Filter by topic name
+     */
+    topic?: string;
+}
+export declare namespace Notifications {
+    export { type Notification as Notification, type NotificationsCursorPage as NotificationsCursorPage, type NotificationListParams as NotificationListParams, type NotificationListDeliveriesParams as NotificationListDeliveriesParams, };
+}
+export { type DeliveriesCursorPage };
+//# sourceMappingURL=notifications.d.ts.map

package/resources/notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,oBAAoB,EAAE;OACxB,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIxE;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,YAAY,CAAC;IAIrD;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,cAAc,EAAE,MAAM,EACtB,KAAK,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,aAAa,CAAC,QAAQ,CAAC;CAO7D;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,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAE1D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;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;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAiC,SAAQ,gBAAgB;IACxE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH;AAED,OAAO,EAAE,KAAK,oBAAoB,EAAE,CAAC"}

package/resources/notifications.js

@@ -0,0 +1,58 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notifications = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class Notifications extends resource_1.APIResource {
+    /**
+     * Retrieve a single notification by ID, including the recipient, actor, and all
+     * delivery attempts.
+     *
+     * @example
+     * ```ts
+     * const notification = await client.notifications.retrieve(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/notifications/${id}`, options);
+    }
+    /**
+     * Retrieve a paginated list of all notifications in your project.
+     *
+     * A notification represents a message sent to a single recipient through a
+     * notiflow run. Each notification can have multiple deliveries (one per channel).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const notification of client.notifications.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/notifications', (pagination_1.CursorPage), { query, ...options });
+    }
+    /**
+     * Retrieve all delivery attempts for a specific notification.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const delivery of client.notifications.listDeliveries(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listDeliveries(notificationID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/notifications/${notificationID}/deliveries`, (pagination_1.CursorPage), { query, ...options });
+    }
+}
+exports.Notifications = Notifications;
+//# sourceMappingURL=notifications.js.map

package/resources/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,uBAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,cAAsB,EACtB,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,kBAAkB,cAAc,aAAa,EACjD,CAAA,uBAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA7DD,sCA6DC"}

package/resources/notifications.mjs

@@ -0,0 +1,54 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Notifications extends APIResource {
+    /**
+     * Retrieve a single notification by ID, including the recipient, actor, and all
+     * delivery attempts.
+     *
+     * @example
+     * ```ts
+     * const notification = await client.notifications.retrieve(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/notifications/${id}`, options);
+    }
+    /**
+     * Retrieve a paginated list of all notifications in your project.
+     *
+     * A notification represents a message sent to a single recipient through a
+     * notiflow run. Each notification can have multiple deliveries (one per channel).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const notification of client.notifications.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/notifications', (CursorPage), { query, ...options });
+    }
+    /**
+     * Retrieve all delivery attempts for a specific notification.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const delivery of client.notifications.listDeliveries(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    listDeliveries(notificationID, query = {}, options) {
+        return this._client.getAPIList(path `/notifications/${notificationID}/deliveries`, (CursorPage), { query, ...options });
+    }
+}
+//# sourceMappingURL=notifications.mjs.map

package/resources/notifications.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.mjs","sourceRoot":"","sources":["../src/resources/notifications.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,UAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,cAAc,CACZ,cAAsB,EACtB,QAA6D,EAAE,EAC/D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,kBAAkB,cAAc,aAAa,EACjD,CAAA,UAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}

package/resources/notiflows.d.mts

@@ -0,0 +1,122 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class NotiflowsResource extends APIResource {
+    /**
+     * Execute a notiflow to send notifications to one or more recipients.
+     *
+     * You must provide either `recipients` (direct targeting) or `topic` (pub/sub
+     * targeting), but not both.
+     *
+     * **Direct targeting (`recipients`):** Specify exactly which users should receive
+     * the notification. Users are identified by their `external_id`. If a user doesn't
+     * exist, they will be created automatically with the provided attributes.
+     *
+     * **Topic targeting (`topic`):** Send to all users subscribed to the specified
+     * topic. Useful for broadcast scenarios.
+     *
+     * **Template variables:** The `data` object is passed to notification templates.
+     * Access variables using Liquid syntax: `{{ data.variable_name }}`
+     *
+     * @example
+     * ```ts
+     * const response = await client.notiflows.run(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    run(notiflowID: string, body: NotiflowRunParams, options?: RequestOptions): APIPromise<NotiflowRunResponse>;
+}
+/**
+ * Response after successfully running a notiflow
+ */
+export interface NotiflowRunResponse {
+    /**
+     * ID of the notiflow run. Use this to query notifications created by this run.
+     */
+    notiflow_run_id: string;
+}
+export interface NotiflowRunParams {
+    /**
+     * Actor (triggering user) specification. Accessible in templates as `actor.*`.
+     */
+    actor?: NotiflowRunParams.Actor;
+    /**
+     * Template variables. Accessible in notification templates as `data.*`.
+     */
+    data?: unknown;
+    /**
+     * List of recipients. Each recipient must have an `external_id`. Users are
+     * auto-created if they don't exist.
+     */
+    recipients?: Array<NotiflowRunParams.Recipient>;
+    /**
+     * Topic name for pub/sub targeting. Cannot be used with `recipients`.
+     */
+    topic?: string;
+}
+export declare namespace NotiflowRunParams {
+    /**
+     * Actor (triggering user) specification. Accessible in templates as `actor.*`.
+     */
+    interface Actor {
+        /**
+         * Your system's identifier for the actor (required)
+         */
+        external_id: string;
+        avatar?: string;
+        custom_fields?: unknown;
+        email?: string;
+        first_name?: string;
+        last_name?: string;
+        locale?: string;
+        phone?: string;
+        timezone?: string;
+    }
+    /**
+     * Recipient specification for running a notiflow. Users are auto-created if they
+     * don't exist.
+     */
+    interface Recipient {
+        /**
+         * Your system's unique identifier for this user (required)
+         */
+        external_id: string;
+        /**
+         * Avatar URL
+         */
+        avatar?: string;
+        /**
+         * Custom attributes
+         */
+        custom_fields?: unknown;
+        /**
+         * Email address (used if user is auto-created)
+         */
+        email?: string;
+        /**
+         * First name
+         */
+        first_name?: string;
+        /**
+         * Last name
+         */
+        last_name?: string;
+        /**
+         * BCP 47 locale
+         */
+        locale?: string;
+        /**
+         * Phone number in E.164 format
+         */
+        phone?: string;
+        /**
+         * IANA timezone
+         */
+        timezone?: string;
+    }
+}
+export declare namespace NotiflowsResource {
+    export { type NotiflowRunResponse as NotiflowRunResponse, type NotiflowRunParams as NotiflowRunParams };
+}
+//# sourceMappingURL=notiflows.d.mts.map

package/resources/notiflows.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notiflows.d.mts","sourceRoot":"","sources":["../src/resources/notiflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAEhD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/notiflows.d.ts

@@ -0,0 +1,122 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class NotiflowsResource extends APIResource {
+    /**
+     * Execute a notiflow to send notifications to one or more recipients.
+     *
+     * You must provide either `recipients` (direct targeting) or `topic` (pub/sub
+     * targeting), but not both.
+     *
+     * **Direct targeting (`recipients`):** Specify exactly which users should receive
+     * the notification. Users are identified by their `external_id`. If a user doesn't
+     * exist, they will be created automatically with the provided attributes.
+     *
+     * **Topic targeting (`topic`):** Send to all users subscribed to the specified
+     * topic. Useful for broadcast scenarios.
+     *
+     * **Template variables:** The `data` object is passed to notification templates.
+     * Access variables using Liquid syntax: `{{ data.variable_name }}`
+     *
+     * @example
+     * ```ts
+     * const response = await client.notiflows.run(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    run(notiflowID: string, body: NotiflowRunParams, options?: RequestOptions): APIPromise<NotiflowRunResponse>;
+}
+/**
+ * Response after successfully running a notiflow
+ */
+export interface NotiflowRunResponse {
+    /**
+     * ID of the notiflow run. Use this to query notifications created by this run.
+     */
+    notiflow_run_id: string;
+}
+export interface NotiflowRunParams {
+    /**
+     * Actor (triggering user) specification. Accessible in templates as `actor.*`.
+     */
+    actor?: NotiflowRunParams.Actor;
+    /**
+     * Template variables. Accessible in notification templates as `data.*`.
+     */
+    data?: unknown;
+    /**
+     * List of recipients. Each recipient must have an `external_id`. Users are
+     * auto-created if they don't exist.
+     */
+    recipients?: Array<NotiflowRunParams.Recipient>;
+    /**
+     * Topic name for pub/sub targeting. Cannot be used with `recipients`.
+     */
+    topic?: string;
+}
+export declare namespace NotiflowRunParams {
+    /**
+     * Actor (triggering user) specification. Accessible in templates as `actor.*`.
+     */
+    interface Actor {
+        /**
+         * Your system's identifier for the actor (required)
+         */
+        external_id: string;
+        avatar?: string;
+        custom_fields?: unknown;
+        email?: string;
+        first_name?: string;
+        last_name?: string;
+        locale?: string;
+        phone?: string;
+        timezone?: string;
+    }
+    /**
+     * Recipient specification for running a notiflow. Users are auto-created if they
+     * don't exist.
+     */
+    interface Recipient {
+        /**
+         * Your system's unique identifier for this user (required)
+         */
+        external_id: string;
+        /**
+         * Avatar URL
+         */
+        avatar?: string;
+        /**
+         * Custom attributes
+         */
+        custom_fields?: unknown;
+        /**
+         * Email address (used if user is auto-created)
+         */
+        email?: string;
+        /**
+         * First name
+         */
+        first_name?: string;
+        /**
+         * Last name
+         */
+        last_name?: string;
+        /**
+         * BCP 47 locale
+         */
+        locale?: string;
+        /**
+         * Phone number in E.164 format
+         */
+        phone?: string;
+        /**
+         * IANA timezone
+         */
+        timezone?: string;
+    }
+}
+export declare namespace NotiflowsResource {
+    export { type NotiflowRunResponse as NotiflowRunResponse, type NotiflowRunParams as NotiflowRunParams };
+}
+//# sourceMappingURL=notiflows.d.ts.map

package/resources/notiflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notiflows.d.ts","sourceRoot":"","sources":["../src/resources/notiflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAC,KAAK,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAEhD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/notiflows.js

@@ -0,0 +1,36 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotiflowsResource = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class NotiflowsResource extends resource_1.APIResource {
+    /**
+     * Execute a notiflow to send notifications to one or more recipients.
+     *
+     * You must provide either `recipients` (direct targeting) or `topic` (pub/sub
+     * targeting), but not both.
+     *
+     * **Direct targeting (`recipients`):** Specify exactly which users should receive
+     * the notification. Users are identified by their `external_id`. If a user doesn't
+     * exist, they will be created automatically with the provided attributes.
+     *
+     * **Topic targeting (`topic`):** Send to all users subscribed to the specified
+     * topic. Useful for broadcast scenarios.
+     *
+     * **Template variables:** The `data` object is passed to notification templates.
+     * Access variables using Liquid syntax: `{{ data.variable_name }}`
+     *
+     * @example
+     * ```ts
+     * const response = await client.notiflows.run(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    run(notiflowID, body, options) {
+        return this._client.post((0, path_1.path) `/notiflows/${notiflowID}/run`, { body, ...options });
+    }
+}
+exports.NotiflowsResource = NotiflowsResource;
+//# sourceMappingURL=notiflows.js.map

package/resources/notiflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notiflows.js","sourceRoot":"","sources":["../src/resources/notiflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,iBAAkB,SAAQ,sBAAW;IAChD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CACD,UAAkB,EAClB,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA/BD,8CA+BC"}

package/resources/notiflows.mjs

@@ -0,0 +1,32 @@
+// 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 NotiflowsResource extends APIResource {
+    /**
+     * Execute a notiflow to send notifications to one or more recipients.
+     *
+     * You must provide either `recipients` (direct targeting) or `topic` (pub/sub
+     * targeting), but not both.
+     *
+     * **Direct targeting (`recipients`):** Specify exactly which users should receive
+     * the notification. Users are identified by their `external_id`. If a user doesn't
+     * exist, they will be created automatically with the provided attributes.
+     *
+     * **Topic targeting (`topic`):** Send to all users subscribed to the specified
+     * topic. Useful for broadcast scenarios.
+     *
+     * **Template variables:** The `data` object is passed to notification templates.
+     * Access variables using Liquid syntax: `{{ data.variable_name }}`
+     *
+     * @example
+     * ```ts
+     * const response = await client.notiflows.run(
+     *   '01HQXYZ123456789ABCDEFGHIJ',
+     * );
+     * ```
+     */
+    run(notiflowID, body, options) {
+        return this._client.post(path `/notiflows/${notiflowID}/run`, { body, ...options });
+    }
+}
+//# sourceMappingURL=notiflows.mjs.map

package/resources/notiflows.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"notiflows.mjs","sourceRoot":"","sources":["../src/resources/notiflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,iBAAkB,SAAQ,WAAW;IAChD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CACD,UAAkB,EAClB,IAAuB,EACvB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,UAAU,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}

package/resources/topics/index.d.mts

@@ -0,0 +1,3 @@
+export { Subscriptions, type BulkOperationResponse, type BulkSubscribeRequest, type SubscriptionListParams, type SubscriptionSubscribeBulkParams, type SubscriptionUnsubscribeBulkParams, } from "./subscriptions.mjs";
+export { Topics, type Topic, type TopicListParams, type TopicsCursorPage } from "./topics.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/topics/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/topics/index.ts"],"names":[],"mappings":"OAEO,EACL,aAAa,EACb,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,GACvC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE"}

package/resources/topics/index.d.ts

@@ -0,0 +1,3 @@
+export { Subscriptions, type BulkOperationResponse, type BulkSubscribeRequest, type SubscriptionListParams, type SubscriptionSubscribeBulkParams, type SubscriptionUnsubscribeBulkParams, } from "./subscriptions.js";
+export { Topics, type Topic, type TopicListParams, type TopicsCursorPage } from "./topics.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/topics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/topics/index.ts"],"names":[],"mappings":"OAEO,EACL,aAAa,EACb,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,iCAAiC,GACvC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,eAAe,EAAE,KAAK,gBAAgB,EAAE"}

package/resources/topics/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Topics = exports.Subscriptions = void 0;
+var subscriptions_1 = require("./subscriptions.js");
+Object.defineProperty(exports, "Subscriptions", { enumerable: true, get: function () { return subscriptions_1.Subscriptions; } });
+var topics_1 = require("./topics.js");
+Object.defineProperty(exports, "Topics", { enumerable: true, get: function () { return topics_1.Topics; } });
+//# sourceMappingURL=index.js.map

package/resources/topics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/topics/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,oDAOyB;AANvB,8GAAA,aAAa,OAAA;AAOf,sCAA2F;AAAlF,gGAAA,MAAM,OAAA"}

package/resources/topics/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Subscriptions, } from "./subscriptions.mjs";
+export { Topics } from "./topics.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/topics/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/topics/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,aAAa,GAMd;OACM,EAAE,MAAM,EAA2D"}