• management
• SDK
• FlowsClient

Class FlowsClient

Index

Accessors

executionsvault

Constructors

constructor

Methods

listcreategetdeleteupdate

Properties

_options_executions_vault

Accessors

executions

get executions(): ExecutionsClient

Returns ExecutionsClient

vault

get vault(): VaultClient

Returns VaultClient

Constructors

constructor

new FlowsClient(options: BaseClientOptions): FlowsClient

Parameters

• options: BaseClientOptions

Returns FlowsClient

Methods

list

list(
request?: ListFlowsRequestParameters,
requestOptions?: FlowsClient.RequestOptions,
): Promise<Page<FlowSummary, ListFlowsOffsetPaginatedResponseContent>>

Parameters

• request: ListFlowsRequestParameters = {}
• OptionalrequestOptions: FlowsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<FlowSummary, ListFlowsOffsetPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.flows.list({ page: 1, per_page: 1, include_totals: true, hydrate: ["form_count"], synchronous: true })Copy

create

create(
request: CreateFlowRequestContent,
requestOptions?: FlowsClient.RequestOptions,
): HttpResponsePromise<CreateFlowResponseContent>

Parameters

• request: CreateFlowRequestContent
• OptionalrequestOptions: FlowsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateFlowResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.flows.create({ name: "name" })Copy

get

get(
id: string,
request?: GetFlowRequestParameters,
requestOptions?: FlowsClient.RequestOptions,
): HttpResponsePromise<GetFlowResponseContent>

Parameters

• id: string

Flow identifier

• request: GetFlowRequestParameters = {}
• OptionalrequestOptions: FlowsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetFlowResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.flows.get("id", { hydrate: ["form_count"] })Copy

delete

delete(
id: string,
requestOptions?: FlowsClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

• id: string

Flow id

• OptionalrequestOptions: FlowsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.flows.delete("id")Copy

update

update(
id: string,
request?: UpdateFlowRequestContent,
requestOptions?: FlowsClient.RequestOptions,
): HttpResponsePromise<UpdateFlowResponseContent>

Parameters

• id: string

Flow identifier

• request: UpdateFlowRequestContent = {}
• OptionalrequestOptions: FlowsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateFlowResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.flows.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_executions

_executions: ExecutionsClient | undefined

Protected_vault

_vault: VaultClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors executionsvault Constructors constructor Methods listcreategetdeleteupdate Properties _options_executions_vault