@knocklabs/node 1.30.0 → 1.31.0

package/resources/workflow-recipient-runs.d.mts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.mjs";
+import * as RecipientsAPI from "./recipients/recipients.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { ItemsCursor, type ItemsCursorParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * A workflow run represents an individual execution of a workflow for a specific recipient.
+ */
+export declare class WorkflowRecipientRuns extends APIResource {
+    /**
+     * Returns a paginated list of workflow recipient runs for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const workflowRecipientRun of client.workflowRecipientRuns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: WorkflowRecipientRunListParams | null | undefined, options?: RequestOptions): PagePromise<WorkflowRecipientRunsItemsCursor, WorkflowRecipientRun>;
+    /**
+     * Returns a single workflow recipient run with its associated events.
+     *
+     * @example
+     * ```ts
+     * const workflowRecipientRunDetail =
+     *   await client.workflowRecipientRuns.get('id');
+     * ```
+     */
+    get(id: string, options?: RequestOptions): APIPromise<WorkflowRecipientRunDetail>;
+}
+export type WorkflowRecipientRunsItemsCursor = ItemsCursor<WorkflowRecipientRun>;
+/**
+ * A workflow recipient run represents an individual execution of a workflow for a
+ * specific recipient.
+ */
+export interface WorkflowRecipientRun {
+    /**
+     * The unique identifier for the workflow recipient run (per-recipient).
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * A reference to a recipient, either a user identifier (string) or an object
+     * reference (ID, collection).
+     */
+    recipient: RecipientsAPI.RecipientReference;
+    /**
+     * The current status of the workflow recipient run. One of `queued`, `processing`,
+     * `paused`, `completed`, or `cancelled`.
+     */
+    status: 'queued' | 'processing' | 'paused' | 'completed' | 'cancelled';
+    /**
+     * Describes how the workflow was triggered.
+     */
+    trigger_source: WorkflowRecipientRun.TriggerSource;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * The key of the workflow that was executed.
+     */
+    workflow: string;
+    /**
+     * The identifier for the top-level workflow run shared across all recipients in a
+     * single trigger.
+     */
+    workflow_run_id: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    actor?: RecipientsAPI.Recipient | null;
+    /**
+     * The number of errors encountered during the workflow recipient run.
+     */
+    error_count?: number;
+    /**
+     * The tenant associated with the workflow recipient run.
+     */
+    tenant?: string | null;
+}
+export declare namespace WorkflowRecipientRun {
+    /**
+     * Describes how the workflow was triggered.
+     */
+    interface TriggerSource {
+        /**
+         * The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`,
+         * `workflow_step`, `integration`, or `rehearsal`.
+         */
+        type: 'api' | 'audience' | 'schedule' | 'broadcast' | 'workflow_step' | 'integration' | 'rehearsal';
+        /**
+         * The key of the audience that triggered the workflow.
+         */
+        audience_key?: string | null;
+        /**
+         * The cancellation key provided when the workflow was triggered via the API.
+         */
+        cancellation_key?: string | null;
+        /**
+         * The ID of the schedule that triggered the workflow.
+         */
+        schedule_id?: string | null;
+    }
+}
+/**
+ * A single workflow recipient run with its events.
+ */
+export interface WorkflowRecipientRunDetail extends WorkflowRecipientRun {
+    /**
+     * A list of events that occurred during the workflow recipient run.
+     */
+    events: Array<WorkflowRecipientRunEvent>;
+}
+/**
+ * An event that occurred during a workflow recipient run.
+ */
+export interface WorkflowRecipientRunEvent {
+    /**
+     * The unique identifier for the event.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The type of event that occurred.
+     */
+    event: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * Whether the event represents a successful or error state.
+     */
+    status: 'ok' | 'error';
+    /**
+     * The attempt number of the workflow recipient run event. Increments for each
+     * retry.
+     */
+    attempt?: number;
+    /**
+     * Event-specific data associated with the event.
+     */
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The reference of the workflow step associated with this event.
+     */
+    step_ref?: string | null;
+    /**
+     * The type of workflow step associated with this event.
+     */
+    step_type?: string | null;
+}
+export interface WorkflowRecipientRunListParams extends ItemsCursorParams {
+    /**
+     * Limits the results to workflow recipient runs started before the given date.
+     */
+    ending_at?: string;
+    /**
+     * Limits the results to workflow recipient runs that have errors.
+     */
+    has_errors?: boolean;
+    /**
+     * Limits the results to workflow recipient runs for the given recipient. Accepts a
+     * user ID string or an object reference with `id` and `collection`.
+     */
+    recipient?: RecipientsAPI.RecipientReference;
+    /**
+     * Limits the results to workflow recipient runs started after the given date.
+     */
+    starting_at?: string;
+    /**
+     * Limits the results to workflow recipient runs with the given status.
+     */
+    status?: Array<'queued' | 'processing' | 'paused' | 'completed' | 'cancelled'>;
+    /**
+     * Limits the results to workflow recipient runs for the given tenant.
+     */
+    tenant?: string;
+    /**
+     * Limits the results to workflow recipient runs for the given workflow key.
+     */
+    workflow?: string;
+}
+export declare namespace WorkflowRecipientRuns {
+    export { type WorkflowRecipientRun as WorkflowRecipientRun, type WorkflowRecipientRunDetail as WorkflowRecipientRunDetail, type WorkflowRecipientRunEvent as WorkflowRecipientRunEvent, type WorkflowRecipientRunsItemsCursor as WorkflowRecipientRunsItemsCursor, type WorkflowRecipientRunListParams as WorkflowRecipientRunListParams, };
+}
+//# sourceMappingURL=workflow-recipient-runs.d.mts.map

package/resources/workflow-recipient-runs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-recipient-runs.d.mts","sourceRoot":"","sources":["../src/resources/workflow-recipient-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,WAAW,EAAE;OACpD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,oBAAoB,CAAC;IAOtE;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,WAAW,CAAC,oBAAoB,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAE5C;;;OAGG;IACH,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvE;;OAEG;IACH,cAAc,EAAE,oBAAoB,CAAC,aAAa,CAAC;IAEnD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,aAAa,GAAG,WAAW,CAAC;QAEpG;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;IACvE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAE7C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC;IAE/E;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB,CAAC;IAC7C,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/workflow-recipient-runs.d.ts

@@ -0,0 +1,202 @@
+import { APIResource } from "../core/resource.js";
+import * as RecipientsAPI from "./recipients/recipients.js";
+import { APIPromise } from "../core/api-promise.js";
+import { ItemsCursor, type ItemsCursorParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * A workflow run represents an individual execution of a workflow for a specific recipient.
+ */
+export declare class WorkflowRecipientRuns extends APIResource {
+    /**
+     * Returns a paginated list of workflow recipient runs for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const workflowRecipientRun of client.workflowRecipientRuns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: WorkflowRecipientRunListParams | null | undefined, options?: RequestOptions): PagePromise<WorkflowRecipientRunsItemsCursor, WorkflowRecipientRun>;
+    /**
+     * Returns a single workflow recipient run with its associated events.
+     *
+     * @example
+     * ```ts
+     * const workflowRecipientRunDetail =
+     *   await client.workflowRecipientRuns.get('id');
+     * ```
+     */
+    get(id: string, options?: RequestOptions): APIPromise<WorkflowRecipientRunDetail>;
+}
+export type WorkflowRecipientRunsItemsCursor = ItemsCursor<WorkflowRecipientRun>;
+/**
+ * A workflow recipient run represents an individual execution of a workflow for a
+ * specific recipient.
+ */
+export interface WorkflowRecipientRun {
+    /**
+     * The unique identifier for the workflow recipient run (per-recipient).
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * A reference to a recipient, either a user identifier (string) or an object
+     * reference (ID, collection).
+     */
+    recipient: RecipientsAPI.RecipientReference;
+    /**
+     * The current status of the workflow recipient run. One of `queued`, `processing`,
+     * `paused`, `completed`, or `cancelled`.
+     */
+    status: 'queued' | 'processing' | 'paused' | 'completed' | 'cancelled';
+    /**
+     * Describes how the workflow was triggered.
+     */
+    trigger_source: WorkflowRecipientRun.TriggerSource;
+    /**
+     * The timestamp when the resource was last updated.
+     */
+    updated_at: string;
+    /**
+     * The key of the workflow that was executed.
+     */
+    workflow: string;
+    /**
+     * The identifier for the top-level workflow run shared across all recipients in a
+     * single trigger.
+     */
+    workflow_run_id: string;
+    /**
+     * A recipient of a notification, which is either a user or an object.
+     */
+    actor?: RecipientsAPI.Recipient | null;
+    /**
+     * The number of errors encountered during the workflow recipient run.
+     */
+    error_count?: number;
+    /**
+     * The tenant associated with the workflow recipient run.
+     */
+    tenant?: string | null;
+}
+export declare namespace WorkflowRecipientRun {
+    /**
+     * Describes how the workflow was triggered.
+     */
+    interface TriggerSource {
+        /**
+         * The type of trigger source. One of `api`, `audience`, `schedule`, `broadcast`,
+         * `workflow_step`, `integration`, or `rehearsal`.
+         */
+        type: 'api' | 'audience' | 'schedule' | 'broadcast' | 'workflow_step' | 'integration' | 'rehearsal';
+        /**
+         * The key of the audience that triggered the workflow.
+         */
+        audience_key?: string | null;
+        /**
+         * The cancellation key provided when the workflow was triggered via the API.
+         */
+        cancellation_key?: string | null;
+        /**
+         * The ID of the schedule that triggered the workflow.
+         */
+        schedule_id?: string | null;
+    }
+}
+/**
+ * A single workflow recipient run with its events.
+ */
+export interface WorkflowRecipientRunDetail extends WorkflowRecipientRun {
+    /**
+     * A list of events that occurred during the workflow recipient run.
+     */
+    events: Array<WorkflowRecipientRunEvent>;
+}
+/**
+ * An event that occurred during a workflow recipient run.
+ */
+export interface WorkflowRecipientRunEvent {
+    /**
+     * The unique identifier for the event.
+     */
+    id: string;
+    /**
+     * The typename of the schema.
+     */
+    __typename: string;
+    /**
+     * The type of event that occurred.
+     */
+    event: string;
+    /**
+     * Timestamp when the resource was created.
+     */
+    inserted_at: string;
+    /**
+     * Whether the event represents a successful or error state.
+     */
+    status: 'ok' | 'error';
+    /**
+     * The attempt number of the workflow recipient run event. Increments for each
+     * retry.
+     */
+    attempt?: number;
+    /**
+     * Event-specific data associated with the event.
+     */
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The reference of the workflow step associated with this event.
+     */
+    step_ref?: string | null;
+    /**
+     * The type of workflow step associated with this event.
+     */
+    step_type?: string | null;
+}
+export interface WorkflowRecipientRunListParams extends ItemsCursorParams {
+    /**
+     * Limits the results to workflow recipient runs started before the given date.
+     */
+    ending_at?: string;
+    /**
+     * Limits the results to workflow recipient runs that have errors.
+     */
+    has_errors?: boolean;
+    /**
+     * Limits the results to workflow recipient runs for the given recipient. Accepts a
+     * user ID string or an object reference with `id` and `collection`.
+     */
+    recipient?: RecipientsAPI.RecipientReference;
+    /**
+     * Limits the results to workflow recipient runs started after the given date.
+     */
+    starting_at?: string;
+    /**
+     * Limits the results to workflow recipient runs with the given status.
+     */
+    status?: Array<'queued' | 'processing' | 'paused' | 'completed' | 'cancelled'>;
+    /**
+     * Limits the results to workflow recipient runs for the given tenant.
+     */
+    tenant?: string;
+    /**
+     * Limits the results to workflow recipient runs for the given workflow key.
+     */
+    workflow?: string;
+}
+export declare namespace WorkflowRecipientRuns {
+    export { type WorkflowRecipientRun as WorkflowRecipientRun, type WorkflowRecipientRunDetail as WorkflowRecipientRunDetail, type WorkflowRecipientRunEvent as WorkflowRecipientRunEvent, type WorkflowRecipientRunsItemsCursor as WorkflowRecipientRunsItemsCursor, type WorkflowRecipientRunListParams as WorkflowRecipientRunListParams, };
+}
+//# sourceMappingURL=workflow-recipient-runs.d.ts.map

package/resources/workflow-recipient-runs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-recipient-runs.d.ts","sourceRoot":"","sources":["../src/resources/workflow-recipient-runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE,WAAW,EAAE;OACpD,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,oBAAoB,CAAC;IAOtE;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGlF;AAED,MAAM,MAAM,gCAAgC,GAAG,WAAW,CAAC,oBAAoB,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAE5C;;;OAGG;IACH,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvE;;OAEG;IACH,cAAc,EAAE,oBAAoB,CAAC,aAAa,CAAC;IAEnD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;;WAGG;QACH,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,aAAa,GAAG,WAAW,CAAC;QAEpG;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;CACF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA+B,SAAQ,iBAAiB;IACvE;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC,kBAAkB,CAAC;IAE7C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC,CAAC;IAE/E;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,qBAAqB,CAAC;IAC7C,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/workflow-recipient-runs.js

@@ -0,0 +1,43 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowRecipientRuns = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * A workflow run represents an individual execution of a workflow for a specific recipient.
+ */
+class WorkflowRecipientRuns extends resource_1.APIResource {
+    /**
+     * Returns a paginated list of workflow recipient runs for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const workflowRecipientRun of client.workflowRecipientRuns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/workflow_recipient_runs', (pagination_1.ItemsCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Returns a single workflow recipient run with its associated events.
+     *
+     * @example
+     * ```ts
+     * const workflowRecipientRunDetail =
+     *   await client.workflowRecipientRuns.get('id');
+     * ```
+     */
+    get(id, options) {
+        return this._client.get((0, path_1.path) `/v1/workflow_recipient_runs/${id}`, options);
+    }
+}
+exports.WorkflowRecipientRuns = WorkflowRecipientRuns;
+//# sourceMappingURL=workflow-recipient-runs.js.map

package/resources/workflow-recipient-runs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-recipient-runs.js","sourceRoot":"","sources":["../src/resources/workflow-recipient-runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAsF;AAEtF,oDAA8C;AAE9C;;GAEG;AACH,MAAa,qBAAsB,SAAQ,sBAAW;IACpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,wBAAiC,CAAA,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF;AAlCD,sDAkCC"}

package/resources/workflow-recipient-runs.mjs

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { ItemsCursor } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * A workflow run represents an individual execution of a workflow for a specific recipient.
+ */
+export class WorkflowRecipientRuns extends APIResource {
+    /**
+     * Returns a paginated list of workflow recipient runs for the current environment.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const workflowRecipientRun of client.workflowRecipientRuns.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/workflow_recipient_runs', (ItemsCursor), {
+            query,
+            ...options,
+        });
+    }
+    /**
+     * Returns a single workflow recipient run with its associated events.
+     *
+     * @example
+     * ```ts
+     * const workflowRecipientRunDetail =
+     *   await client.workflowRecipientRuns.get('id');
+     * ```
+     */
+    get(id, options) {
+        return this._client.get(path `/v1/workflow_recipient_runs/${id}`, options);
+    }
+}
+//# sourceMappingURL=workflow-recipient-runs.mjs.map

package/resources/workflow-recipient-runs.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-recipient-runs.mjs","sourceRoot":"","sources":["../src/resources/workflow-recipient-runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,WAAW,EAAuC;OAEpD,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAA,WAAiC,CAAA,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAU,EAAE,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;CACF"}

package/src/client.ts

@@ -37,6 +37,14 @@ import {
   Audiences,
 } from './resources/audiences';
 import { BulkOperation, BulkOperations } from './resources/bulk-operations';
+import {
+  WorkflowRecipientRun,
+  WorkflowRecipientRunDetail,
+  WorkflowRecipientRunEvent,
+  WorkflowRecipientRunListParams,
+  WorkflowRecipientRuns,
+  WorkflowRecipientRunsItemsCursor,
+} from './resources/workflow-recipient-runs';
 import {
   WorkflowCancelParams,
   WorkflowTriggerParams,
@@ -891,6 +899,10 @@ export class Knock {
    * A workflow is a structured set of steps that is triggered to produce notifications sent over channels.
    */
   workflows: API.Workflows = new API.Workflows(this);
+  /**
+   * A workflow run represents an individual execution of a workflow for a specific recipient.
+   */
+  workflowRecipientRuns: API.WorkflowRecipientRuns = new API.WorkflowRecipientRuns(this);
   /**
    * A schedule is a per-recipient, timezone-aware configuration for when to invoke a workflow.
    */
@@ -911,6 +923,7 @@ Knock.Messages = Messages;
 Knock.Providers = Providers;
 Knock.Integrations = Integrations;
 Knock.Workflows = Workflows;
+Knock.WorkflowRecipientRuns = WorkflowRecipientRuns;
 Knock.Schedules = Schedules;
 Knock.Channels = Channels;
 Knock.Audiences = Audiences;
@@ -1025,6 +1038,15 @@ export declare namespace Knock {
     type WorkflowTriggerParams as WorkflowTriggerParams,
   };
 
+  export {
+    WorkflowRecipientRuns as WorkflowRecipientRuns,
+    type WorkflowRecipientRun as WorkflowRecipientRun,
+    type WorkflowRecipientRunDetail as WorkflowRecipientRunDetail,
+    type WorkflowRecipientRunEvent as WorkflowRecipientRunEvent,
+    type WorkflowRecipientRunsItemsCursor as WorkflowRecipientRunsItemsCursor,
+    type WorkflowRecipientRunListParams as WorkflowRecipientRunListParams,
+  };
+
   export {
     Schedules as Schedules,
     type Schedule as Schedule,

package/src/resources/index.ts

@@ -93,6 +93,14 @@ export {
   type UserSetPreferencesParams,
   type UsersEntriesCursor,
 } from './users/users';
+export {
+  WorkflowRecipientRuns,
+  type WorkflowRecipientRun,
+  type WorkflowRecipientRunDetail,
+  type WorkflowRecipientRunEvent,
+  type WorkflowRecipientRunListParams,
+  type WorkflowRecipientRunsItemsCursor,
+} from './workflow-recipient-runs';
 export {
   Workflows,
   type WorkflowTriggerResponse,