Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/windmill/windmill-api/services/FlowService.ts>FlowService

Windmill deno client (separated from the main repo because most of the code is auto-generated from the openapi and not worth committing)
Go to Latest
class FlowService
import { FlowService } from "https://deno.land/x/windmill@v1.397.0/windmill-api/services/FlowService.ts";

Static Methods

archiveFlowByPath(unnamed 0: { workspace: string; path: string; requestBody: { archived?: boolean; }; }): CancelablePromise<string>

archive flow by path

createFlow(unnamed 0: { workspace: string; requestBody: (OpenFlowWPath & { draft_only?: boolean; deployment_message?: string; }); }): CancelablePromise<string>

create flow

deleteFlowByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<string>

delete flow by path

existsFlowByPath(unnamed 0: { workspace: string; path: string; }): CancelablePromise<boolean>

exists flow by path

getFlowByPath(unnamed 0: { workspace: string; path: string; withStarredInfo?: boolean; }): CancelablePromise<Flow>

get flow by path

getFlowByPathWithDraft(unnamed 0: { workspace: string; path: string; }): CancelablePromise<(Flow & { draft?: Flow; })>

get flow by path with draft

getFlowHistory(unnamed 0: { workspace: string; path: string; }): CancelablePromise<Array<FlowVersion>>

get flow history by path

getFlowVersion(unnamed 0: { workspace: string; version: number; path: string; }): CancelablePromise<Flow>

get flow version

getHubFlowById(unnamed 0: { id: number; }): CancelablePromise<{ flow?: OpenFlow; }>

get hub flow by id

listFlowPaths(unnamed 0: { workspace: string; }): CancelablePromise<Array<string>>

list all flow paths

listFlows(unnamed 0: { workspace: string; page?: number; perPage?: number; orderDesc?: boolean; createdBy?: string; pathStart?: string; pathExact?: string; showArchived?: boolean; starredOnly?: boolean; includeDraftOnly?: boolean; withDeploymentMsg?: boolean; }): CancelablePromise<Array<(Flow & { has_draft?: boolean; draft_only?: boolean; })>>

list all flows

listHubFlows(): CancelablePromise<{ flows?: Array<{ id: number; flow_id: number; summary: string; apps: Array<string>; approved: boolean; votes: number; }>; }>

list all hub flows

listSearchFlow(unnamed 0: { workspace: string; }): CancelablePromise<Array<{ path: string; value: any; }>>

list flows for search

toggleWorkspaceErrorHandlerForFlow(unnamed 0: { workspace: string; path: string; requestBody: { muted?: boolean; }; }): CancelablePromise<string>

Toggle ON and OFF the workspace error handler for a given flow

updateFlow(unnamed 0: { workspace: string; path: string; requestBody: (OpenFlowWPath & { deployment_message?: string; }); }): CancelablePromise<string>

update flow

updateFlowHistory(unnamed 0: { workspace: string; version: number; path: string; requestBody: { deployment_msg: string; }; }): CancelablePromise<string>

update flow history