@enbbox/api 1.0.0

package/dist/esm/api/workflows-api.d.ts

@@ -0,0 +1,493 @@
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CreateWorkflow } from '../models';
+import type { PaginatedWorkflowRecord } from '../models';
+import type { PreviewResult } from '../models';
+import type { StepPreview } from '../models';
+import type { StepRecord } from '../models';
+import type { SyncWorkflow } from '../models';
+import type { UpdateWorkflow } from '../models';
+import type { WorkflowRecord } from '../models';
+import type { WorkflowStatus } from '../models';
+/**
+ * WorkflowsApi - axios parameter creator
+ */
+export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/workflows
+     * @param {CreateWorkflow} createWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWorkflow: (createWorkflow: CreateWorkflow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWorkflow: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/duplicate — clone workflow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    duplicateWorkflow: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id/steps/:step_id — get step details
+     * @param {string} id
+     * @param {string} stepId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStep: (id: string, stepId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflow: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/workflows
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflows: (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/step/:step_id/preview — render step template
+     * @param {string} id
+     * @param {string} stepId
+     * @param {StepPreview} stepPreview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stepPreview: (id: string, stepId: string, stepPreview: StepPreview, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+     * @param {string} id
+     * @param {SyncWorkflow} syncWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    syncWorkflow: (id: string, syncWorkflow: SyncWorkflow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {UpdateWorkflow} updateWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflow: (id: string, updateWorkflow: UpdateWorkflow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/status
+     * @param {string} id Workflow ID
+     * @param {WorkflowStatus} workflowStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowStatus: (id: string, workflowStatus: WorkflowStatus, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * WorkflowsApi - functional programming interface
+ */
+export declare const WorkflowsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/workflows
+     * @param {CreateWorkflow} createWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWorkflow(createWorkflow: CreateWorkflow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+    /**
+     *
+     * @summary DELETE /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/duplicate — clone workflow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    duplicateWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id/steps/:step_id — get step details
+     * @param {string} id
+     * @param {string} stepId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStep(id: string, stepId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StepRecord>>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+    /**
+     *
+     * @summary GET /v1/workflows
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflows(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedWorkflowRecord>>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/step/:step_id/preview — render step template
+     * @param {string} id
+     * @param {string} stepId
+     * @param {StepPreview} stepPreview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stepPreview(id: string, stepId: string, stepPreview: StepPreview, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreviewResult>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+     * @param {string} id
+     * @param {SyncWorkflow} syncWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    syncWorkflow(id: string, syncWorkflow: SyncWorkflow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {UpdateWorkflow} updateWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflow(id: string, updateWorkflow: UpdateWorkflow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/status
+     * @param {string} id Workflow ID
+     * @param {WorkflowStatus} workflowStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowStatus(id: string, workflowStatus: WorkflowStatus, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkflowRecord>>;
+};
+/**
+ * WorkflowsApi - factory interface
+ */
+export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary POST /v1/workflows
+     * @param {CreateWorkflow} createWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWorkflow(createWorkflow: CreateWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary DELETE /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/duplicate — clone workflow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    duplicateWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id/steps/:step_id — get step details
+     * @param {string} id
+     * @param {string} stepId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStep(id: string, stepId: string, options?: RawAxiosRequestConfig): AxiosPromise<StepRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflows(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedWorkflowRecord>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/step/:step_id/preview — render step template
+     * @param {string} id
+     * @param {string} stepId
+     * @param {StepPreview} stepPreview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stepPreview(id: string, stepId: string, stepPreview: StepPreview, options?: RawAxiosRequestConfig): AxiosPromise<PreviewResult>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+     * @param {string} id
+     * @param {SyncWorkflow} syncWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    syncWorkflow(id: string, syncWorkflow: SyncWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {UpdateWorkflow} updateWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflow(id: string, updateWorkflow: UpdateWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/status
+     * @param {string} id Workflow ID
+     * @param {WorkflowStatus} workflowStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowStatus(id: string, workflowStatus: WorkflowStatus, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+};
+/**
+ * WorkflowsApi - interface
+ */
+export interface WorkflowsApiInterface {
+    /**
+     *
+     * @summary POST /v1/workflows
+     * @param {CreateWorkflow} createWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWorkflow(createWorkflow: CreateWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary DELETE /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/duplicate — clone workflow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    duplicateWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id/steps/:step_id — get step details
+     * @param {string} id
+     * @param {string} stepId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStep(id: string, stepId: string, options?: RawAxiosRequestConfig): AxiosPromise<StepRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflow(id: string, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary GET /v1/workflows
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflows(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedWorkflowRecord>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/step/:step_id/preview — render step template
+     * @param {string} id
+     * @param {string} stepId
+     * @param {StepPreview} stepPreview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stepPreview(id: string, stepId: string, stepPreview: StepPreview, options?: RawAxiosRequestConfig): AxiosPromise<PreviewResult>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+     * @param {string} id
+     * @param {SyncWorkflow} syncWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    syncWorkflow(id: string, syncWorkflow: SyncWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {UpdateWorkflow} updateWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflow(id: string, updateWorkflow: UpdateWorkflow, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/status
+     * @param {string} id Workflow ID
+     * @param {WorkflowStatus} workflowStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowStatus(id: string, workflowStatus: WorkflowStatus, options?: RawAxiosRequestConfig): AxiosPromise<WorkflowRecord>;
+}
+/**
+ * WorkflowsApi - object-oriented interface
+ */
+export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
+    /**
+     *
+     * @summary POST /v1/workflows
+     * @param {CreateWorkflow} createWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createWorkflow(createWorkflow: CreateWorkflow, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/duplicate — clone workflow
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    duplicateWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id/steps/:step_id — get step details
+     * @param {string} id
+     * @param {string} stepId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStep(id: string, stepId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StepRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getWorkflow(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/workflows
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listWorkflows(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedWorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/workflows/:id/step/:step_id/preview — render step template
+     * @param {string} id
+     * @param {string} stepId
+     * @param {StepPreview} stepPreview
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    stepPreview(id: string, stepId: string, stepPreview: StepPreview, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreviewResult, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/sync — sync from code-first workflow definition
+     * @param {string} id
+     * @param {SyncWorkflow} syncWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    syncWorkflow(id: string, syncWorkflow: SyncWorkflow, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id
+     * @param {string} id Workflow ID
+     * @param {UpdateWorkflow} updateWorkflow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflow(id: string, updateWorkflow: UpdateWorkflow, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/workflows/:id/status
+     * @param {string} id Workflow ID
+     * @param {WorkflowStatus} workflowStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowStatus(id: string, workflowStatus: WorkflowStatus, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkflowRecord, any, {}>>;
+}