@zyphr-dev/node-sdk 0.1.39 → 0.1.41

package/src/src/apis/WorkflowsApi.ts

@@ -0,0 +1,912 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zyphr API
+ * Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account\'s current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zyphr.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  AddWorkflowStep201Response,
+  AddWorkflowStepRequest,
+  ApiError,
+  CreateWorkflow201Response,
+  CreateWorkflowRequest,
+  DeleteWorkflow200Response,
+  DeleteWorkflowStep200Response,
+  ListWorkflowExecutions200Response,
+  ListWorkflows200Response,
+  ReorderWorkflowStepsRequest,
+  TriggerWorkflow202Response,
+  TriggerWorkflowRequest,
+  UpdateWorkflowRequest,
+  UpdateWorkflowStatusRequest,
+  UpdateWorkflowStepRequest,
+  WorkflowStatus,
+} from '../models/index';
+import {
+    AddWorkflowStep201ResponseFromJSON,
+    AddWorkflowStep201ResponseToJSON,
+    AddWorkflowStepRequestFromJSON,
+    AddWorkflowStepRequestToJSON,
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    CreateWorkflow201ResponseFromJSON,
+    CreateWorkflow201ResponseToJSON,
+    CreateWorkflowRequestFromJSON,
+    CreateWorkflowRequestToJSON,
+    DeleteWorkflow200ResponseFromJSON,
+    DeleteWorkflow200ResponseToJSON,
+    DeleteWorkflowStep200ResponseFromJSON,
+    DeleteWorkflowStep200ResponseToJSON,
+    ListWorkflowExecutions200ResponseFromJSON,
+    ListWorkflowExecutions200ResponseToJSON,
+    ListWorkflows200ResponseFromJSON,
+    ListWorkflows200ResponseToJSON,
+    ReorderWorkflowStepsRequestFromJSON,
+    ReorderWorkflowStepsRequestToJSON,
+    TriggerWorkflow202ResponseFromJSON,
+    TriggerWorkflow202ResponseToJSON,
+    TriggerWorkflowRequestFromJSON,
+    TriggerWorkflowRequestToJSON,
+    UpdateWorkflowRequestFromJSON,
+    UpdateWorkflowRequestToJSON,
+    UpdateWorkflowStatusRequestFromJSON,
+    UpdateWorkflowStatusRequestToJSON,
+    UpdateWorkflowStepRequestFromJSON,
+    UpdateWorkflowStepRequestToJSON,
+    WorkflowStatusFromJSON,
+    WorkflowStatusToJSON,
+} from '../models/index';
+
+export interface WorkflowsApiAddWorkflowStepOperationRequest {
+    key: string;
+    addWorkflowStepRequest: AddWorkflowStepRequest;
+}
+
+export interface WorkflowsApiCreateWorkflowOperationRequest {
+    createWorkflowRequest: CreateWorkflowRequest;
+}
+
+export interface WorkflowsApiDeleteWorkflowRequest {
+    key: string;
+}
+
+export interface WorkflowsApiDeleteWorkflowStepRequest {
+    key: string;
+    stepKey: string;
+}
+
+export interface WorkflowsApiGetWorkflowRequest {
+    key: string;
+}
+
+export interface WorkflowsApiListWorkflowExecutionsRequest {
+    key: string;
+    page?: number;
+    perPage?: number;
+}
+
+export interface WorkflowsApiListWorkflowsRequest {
+    page?: number;
+    perPage?: number;
+    search?: string;
+    status?: WorkflowStatus;
+}
+
+export interface WorkflowsApiReorderWorkflowStepsOperationRequest {
+    key: string;
+    reorderWorkflowStepsRequest: ReorderWorkflowStepsRequest;
+}
+
+export interface WorkflowsApiTriggerWorkflowOperationRequest {
+    key: string;
+    triggerWorkflowRequest: TriggerWorkflowRequest;
+}
+
+export interface WorkflowsApiUpdateWorkflowOperationRequest {
+    key: string;
+    updateWorkflowRequest: UpdateWorkflowRequest;
+}
+
+export interface WorkflowsApiUpdateWorkflowStatusOperationRequest {
+    key: string;
+    updateWorkflowStatusRequest: UpdateWorkflowStatusRequest;
+}
+
+export interface WorkflowsApiUpdateWorkflowStepOperationRequest {
+    key: string;
+    stepKey: string;
+    updateWorkflowStepRequest: UpdateWorkflowStepRequest;
+}
+
+/**
+ * WorkflowsApi - interface
+ * 
+ * @export
+ * @interface WorkflowsApiInterface
+ */
+export interface WorkflowsApiInterface {
+    /**
+     * Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+     * @summary Add a workflow step
+     * @param {string} key The workflow key.
+     * @param {AddWorkflowStepRequest} addWorkflowStepRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    addWorkflowStepRaw(requestParameters: WorkflowsApiAddWorkflowStepOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddWorkflowStep201Response>>;
+
+    /**
+     * Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+     * Add a workflow step
+     */
+    addWorkflowStep(key: string, addWorkflowStepRequest: AddWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddWorkflowStep201Response>;
+
+    /**
+     * Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+     * @summary Create a workflow
+     * @param {CreateWorkflowRequest} createWorkflowRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    createWorkflowRaw(requestParameters: WorkflowsApiCreateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>>;
+
+    /**
+     * Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+     * Create a workflow
+     */
+    createWorkflow(createWorkflowRequest: CreateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response>;
+
+    /**
+     * Permanently delete a workflow and all of its steps.
+     * @summary Delete a workflow
+     * @param {string} key The workflow key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    deleteWorkflowRaw(requestParameters: WorkflowsApiDeleteWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWorkflow200Response>>;
+
+    /**
+     * Permanently delete a workflow and all of its steps.
+     * Delete a workflow
+     */
+    deleteWorkflow(key: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWorkflow200Response>;
+
+    /**
+     * Remove a step from a workflow.
+     * @summary Delete a workflow step
+     * @param {string} key The workflow key.
+     * @param {string} stepKey The step key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    deleteWorkflowStepRaw(requestParameters: WorkflowsApiDeleteWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWorkflowStep200Response>>;
+
+    /**
+     * Remove a step from a workflow.
+     * Delete a workflow step
+     */
+    deleteWorkflowStep(key: string, stepKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWorkflowStep200Response>;
+
+    /**
+     * Retrieve a single workflow by its key, including its ordered steps.
+     * @summary Get a workflow
+     * @param {string} key The workflow key.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    getWorkflowRaw(requestParameters: WorkflowsApiGetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>>;
+
+    /**
+     * Retrieve a single workflow by its key, including its ordered steps.
+     * Get a workflow
+     */
+    getWorkflow(key: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response>;
+
+    /**
+     * List the executions of a workflow, most recent first. Supports pagination.
+     * @summary List workflow executions
+     * @param {string} key The workflow key.
+     * @param {number} [page] Page number (1-based).
+     * @param {number} [perPage] Number of executions per page (max 100).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    listWorkflowExecutionsRaw(requestParameters: WorkflowsApiListWorkflowExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkflowExecutions200Response>>;
+
+    /**
+     * List the executions of a workflow, most recent first. Supports pagination.
+     * List workflow executions
+     */
+    listWorkflowExecutions(key: string, page?: number, perPage?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkflowExecutions200Response>;
+
+    /**
+     * List workflows in the project. Supports pagination, free-text search, and status filtering.
+     * @summary List workflows
+     * @param {number} [page] Page number (1-based).
+     * @param {number} [perPage] Number of workflows per page (max 100).
+     * @param {string} [search] Free-text search over workflow name and key.
+     * @param {WorkflowStatus} [status] Filter by workflow status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    listWorkflowsRaw(requestParameters: WorkflowsApiListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkflows200Response>>;
+
+    /**
+     * List workflows in the project. Supports pagination, free-text search, and status filtering.
+     * List workflows
+     */
+    listWorkflows(page?: number, perPage?: number, search?: string, status?: WorkflowStatus, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkflows200Response>;
+
+    /**
+     * Reorder a workflow\'s steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow\'s existing step keys. 
+     * @summary Reorder workflow steps
+     * @param {string} key The workflow key.
+     * @param {ReorderWorkflowStepsRequest} reorderWorkflowStepsRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    reorderWorkflowStepsRaw(requestParameters: WorkflowsApiReorderWorkflowStepsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>>;
+
+    /**
+     * Reorder a workflow\'s steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow\'s existing step keys. 
+     * Reorder workflow steps
+     */
+    reorderWorkflowSteps(key: string, reorderWorkflowStepsRequest: ReorderWorkflowStepsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response>;
+
+    /**
+     * Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+     * @summary Trigger a workflow
+     * @param {string} key The workflow key.
+     * @param {TriggerWorkflowRequest} triggerWorkflowRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    triggerWorkflowRaw(requestParameters: WorkflowsApiTriggerWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerWorkflow202Response>>;
+
+    /**
+     * Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+     * Trigger a workflow
+     */
+    triggerWorkflow(key: string, triggerWorkflowRequest: TriggerWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerWorkflow202Response>;
+
+    /**
+     * Update a workflow\'s metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+     * @summary Update a workflow
+     * @param {string} key The workflow key.
+     * @param {UpdateWorkflowRequest} updateWorkflowRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    updateWorkflowRaw(requestParameters: WorkflowsApiUpdateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>>;
+
+    /**
+     * Update a workflow\'s metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+     * Update a workflow
+     */
+    updateWorkflow(key: string, updateWorkflowRequest: UpdateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response>;
+
+    /**
+     * Change a workflow\'s lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+     * @summary Update workflow status
+     * @param {string} key The workflow key.
+     * @param {UpdateWorkflowStatusRequest} updateWorkflowStatusRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    updateWorkflowStatusRaw(requestParameters: WorkflowsApiUpdateWorkflowStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>>;
+
+    /**
+     * Change a workflow\'s lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+     * Update workflow status
+     */
+    updateWorkflowStatus(key: string, updateWorkflowStatusRequest: UpdateWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response>;
+
+    /**
+     * Update a step\'s name and/or config. Only the provided fields are changed.
+     * @summary Update a workflow step
+     * @param {string} key The workflow key.
+     * @param {string} stepKey The step key.
+     * @param {UpdateWorkflowStepRequest} updateWorkflowStepRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    updateWorkflowStepRaw(requestParameters: WorkflowsApiUpdateWorkflowStepOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddWorkflowStep201Response>>;
+
+    /**
+     * Update a step\'s name and/or config. Only the provided fields are changed.
+     * Update a workflow step
+     */
+    updateWorkflowStep(key: string, stepKey: string, updateWorkflowStepRequest: UpdateWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddWorkflowStep201Response>;
+
+}
+
+/**
+ * 
+ */
+export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
+
+    /**
+     * Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+     * Add a workflow step
+     */
+    async addWorkflowStepRaw(requestParameters: WorkflowsApiAddWorkflowStepOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddWorkflowStep201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling addWorkflowStep().'
+            );
+        }
+
+        if (requestParameters['addWorkflowStepRequest'] == null) {
+            throw new runtime.RequiredError(
+                'addWorkflowStepRequest',
+                'Required parameter "addWorkflowStepRequest" was null or undefined when calling addWorkflowStep().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/steps`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AddWorkflowStepRequestToJSON(requestParameters['addWorkflowStepRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AddWorkflowStep201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+     * Add a workflow step
+     */
+    async addWorkflowStep(key: string, addWorkflowStepRequest: AddWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddWorkflowStep201Response> {
+        const response = await this.addWorkflowStepRaw({ key: key, addWorkflowStepRequest: addWorkflowStepRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+     * Create a workflow
+     */
+    async createWorkflowRaw(requestParameters: WorkflowsApiCreateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>> {
+        if (requestParameters['createWorkflowRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createWorkflowRequest',
+                'Required parameter "createWorkflowRequest" was null or undefined when calling createWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateWorkflowRequestToJSON(requestParameters['createWorkflowRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWorkflow201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+     * Create a workflow
+     */
+    async createWorkflow(createWorkflowRequest: CreateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response> {
+        const response = await this.createWorkflowRaw({ createWorkflowRequest: createWorkflowRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Permanently delete a workflow and all of its steps.
+     * Delete a workflow
+     */
+    async deleteWorkflowRaw(requestParameters: WorkflowsApiDeleteWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWorkflow200Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling deleteWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeleteWorkflow200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Permanently delete a workflow and all of its steps.
+     * Delete a workflow
+     */
+    async deleteWorkflow(key: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWorkflow200Response> {
+        const response = await this.deleteWorkflowRaw({ key: key }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Remove a step from a workflow.
+     * Delete a workflow step
+     */
+    async deleteWorkflowStepRaw(requestParameters: WorkflowsApiDeleteWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteWorkflowStep200Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling deleteWorkflowStep().'
+            );
+        }
+
+        if (requestParameters['stepKey'] == null) {
+            throw new runtime.RequiredError(
+                'stepKey',
+                'Required parameter "stepKey" was null or undefined when calling deleteWorkflowStep().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/steps/{stepKey}`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))).replace(`{${"stepKey"}}`, encodeURIComponent(String(requestParameters['stepKey']))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeleteWorkflowStep200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Remove a step from a workflow.
+     * Delete a workflow step
+     */
+    async deleteWorkflowStep(key: string, stepKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteWorkflowStep200Response> {
+        const response = await this.deleteWorkflowStepRaw({ key: key, stepKey: stepKey }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieve a single workflow by its key, including its ordered steps.
+     * Get a workflow
+     */
+    async getWorkflowRaw(requestParameters: WorkflowsApiGetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling getWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWorkflow201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a single workflow by its key, including its ordered steps.
+     * Get a workflow
+     */
+    async getWorkflow(key: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response> {
+        const response = await this.getWorkflowRaw({ key: key }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List the executions of a workflow, most recent first. Supports pagination.
+     * List workflow executions
+     */
+    async listWorkflowExecutionsRaw(requestParameters: WorkflowsApiListWorkflowExecutionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkflowExecutions200Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling listWorkflowExecutions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/executions`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWorkflowExecutions200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List the executions of a workflow, most recent first. Supports pagination.
+     * List workflow executions
+     */
+    async listWorkflowExecutions(key: string, page?: number, perPage?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkflowExecutions200Response> {
+        const response = await this.listWorkflowExecutionsRaw({ key: key, page: page, perPage: perPage }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List workflows in the project. Supports pagination, free-text search, and status filtering.
+     * List workflows
+     */
+    async listWorkflowsRaw(requestParameters: WorkflowsApiListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListWorkflows200Response>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['perPage'] != null) {
+            queryParameters['per_page'] = requestParameters['perPage'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListWorkflows200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List workflows in the project. Supports pagination, free-text search, and status filtering.
+     * List workflows
+     */
+    async listWorkflows(page?: number, perPage?: number, search?: string, status?: WorkflowStatus, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListWorkflows200Response> {
+        const response = await this.listWorkflowsRaw({ page: page, perPage: perPage, search: search, status: status }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Reorder a workflow\'s steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow\'s existing step keys. 
+     * Reorder workflow steps
+     */
+    async reorderWorkflowStepsRaw(requestParameters: WorkflowsApiReorderWorkflowStepsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling reorderWorkflowSteps().'
+            );
+        }
+
+        if (requestParameters['reorderWorkflowStepsRequest'] == null) {
+            throw new runtime.RequiredError(
+                'reorderWorkflowStepsRequest',
+                'Required parameter "reorderWorkflowStepsRequest" was null or undefined when calling reorderWorkflowSteps().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/steps/reorder`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ReorderWorkflowStepsRequestToJSON(requestParameters['reorderWorkflowStepsRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWorkflow201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Reorder a workflow\'s steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow\'s existing step keys. 
+     * Reorder workflow steps
+     */
+    async reorderWorkflowSteps(key: string, reorderWorkflowStepsRequest: ReorderWorkflowStepsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response> {
+        const response = await this.reorderWorkflowStepsRaw({ key: key, reorderWorkflowStepsRequest: reorderWorkflowStepsRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+     * Trigger a workflow
+     */
+    async triggerWorkflowRaw(requestParameters: WorkflowsApiTriggerWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TriggerWorkflow202Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling triggerWorkflow().'
+            );
+        }
+
+        if (requestParameters['triggerWorkflowRequest'] == null) {
+            throw new runtime.RequiredError(
+                'triggerWorkflowRequest',
+                'Required parameter "triggerWorkflowRequest" was null or undefined when calling triggerWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/trigger`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TriggerWorkflowRequestToJSON(requestParameters['triggerWorkflowRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TriggerWorkflow202ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+     * Trigger a workflow
+     */
+    async triggerWorkflow(key: string, triggerWorkflowRequest: TriggerWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TriggerWorkflow202Response> {
+        const response = await this.triggerWorkflowRaw({ key: key, triggerWorkflowRequest: triggerWorkflowRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a workflow\'s metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+     * Update a workflow
+     */
+    async updateWorkflowRaw(requestParameters: WorkflowsApiUpdateWorkflowOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling updateWorkflow().'
+            );
+        }
+
+        if (requestParameters['updateWorkflowRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateWorkflowRequest',
+                'Required parameter "updateWorkflowRequest" was null or undefined when calling updateWorkflow().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateWorkflowRequestToJSON(requestParameters['updateWorkflowRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWorkflow201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a workflow\'s metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+     * Update a workflow
+     */
+    async updateWorkflow(key: string, updateWorkflowRequest: UpdateWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response> {
+        const response = await this.updateWorkflowRaw({ key: key, updateWorkflowRequest: updateWorkflowRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Change a workflow\'s lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+     * Update workflow status
+     */
+    async updateWorkflowStatusRaw(requestParameters: WorkflowsApiUpdateWorkflowStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWorkflow201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling updateWorkflowStatus().'
+            );
+        }
+
+        if (requestParameters['updateWorkflowStatusRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateWorkflowStatusRequest',
+                'Required parameter "updateWorkflowStatusRequest" was null or undefined when calling updateWorkflowStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/status`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateWorkflowStatusRequestToJSON(requestParameters['updateWorkflowStatusRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateWorkflow201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Change a workflow\'s lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+     * Update workflow status
+     */
+    async updateWorkflowStatus(key: string, updateWorkflowStatusRequest: UpdateWorkflowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWorkflow201Response> {
+        const response = await this.updateWorkflowStatusRaw({ key: key, updateWorkflowStatusRequest: updateWorkflowStatusRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a step\'s name and/or config. Only the provided fields are changed.
+     * Update a workflow step
+     */
+    async updateWorkflowStepRaw(requestParameters: WorkflowsApiUpdateWorkflowStepOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddWorkflowStep201Response>> {
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling updateWorkflowStep().'
+            );
+        }
+
+        if (requestParameters['stepKey'] == null) {
+            throw new runtime.RequiredError(
+                'stepKey',
+                'Required parameter "stepKey" was null or undefined when calling updateWorkflowStep().'
+            );
+        }
+
+        if (requestParameters['updateWorkflowStepRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateWorkflowStepRequest',
+                'Required parameter "updateWorkflowStepRequest" was null or undefined when calling updateWorkflowStep().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // ApiKeyAuth authentication
+        }
+
+        const response = await this.request({
+            path: `/workflows/{key}/steps/{stepKey}`.replace(`{${"key"}}`, encodeURIComponent(String(requestParameters['key']))).replace(`{${"stepKey"}}`, encodeURIComponent(String(requestParameters['stepKey']))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateWorkflowStepRequestToJSON(requestParameters['updateWorkflowStepRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AddWorkflowStep201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a step\'s name and/or config. Only the provided fields are changed.
+     * Update a workflow step
+     */
+    async updateWorkflowStep(key: string, stepKey: string, updateWorkflowStepRequest: UpdateWorkflowStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddWorkflowStep201Response> {
+        const response = await this.updateWorkflowStepRaw({ key: key, stepKey: stepKey, updateWorkflowStepRequest: updateWorkflowStepRequest }, initOverrides);
+        return await response.value();
+    }
+
+}