client.workflows

Accessed via client.workflows.

Methods

`create`

Create a workflow.

TypeScript

create(params: CreateWorkflowParams): Promise<Workflow>

Types: CreateWorkflowParams · Workflow

`delete`

Soft-delete a workflow.

TypeScript

delete(params: DeleteWorkflowParams): Promise<SuccessResponse>

Types: DeleteWorkflowParams · SuccessResponse

`list`

List workflows.

TypeScript

list(params?: Omit<ListWorkflowsParams, "filter" | "orderBy"> & { filter?: WorkflowFilter; orderBy?: WorkflowOrderBy[]; } & WorkflowShorthands): Promise<Page<Workflow>>

Types: ListWorkflowsParams · WorkflowFilter · WorkflowOrderBy · WorkflowShorthands · Page · Workflow

`purge`

Permanently delete a soft-deleted workflow.

TypeScript

purge(params: PurgeWorkflowParams): Promise<SuccessResponse>

Types: PurgeWorkflowParams · SuccessResponse

`restore`

Restore a soft-deleted workflow.

TypeScript

restore(params: RestoreWorkflowParams): Promise<Workflow>

Types: RestoreWorkflowParams · Workflow

`retrieve`

Get a workflow by ID.

TypeScript

retrieve(params: RetrieveWorkflowParams): Promise<Workflow>

Types: RetrieveWorkflowParams · Workflow

`update`

Update a workflow.

TypeScript

update(params: UpdateWorkflowParams): Promise<Workflow>

Types: UpdateWorkflowParams · Workflow

client.workflows.runs

Sub-resource for retrieving the hydrated workflow-run projection.

Accessed via client.workflows.runs.

`get`

Get a specific workflow run with hydrated children + nodes + edges. GET /api/workflows/:id/runs/:runId

TypeScript

get(params: GetWorkflowRunParams): Promise<WorkflowRun>

Types: GetWorkflowRunParams · WorkflowRun