Class FlowsClient

Index

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
    })
```

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"
    })
```

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"]
    })
```

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.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.delete("id")
```

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.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_executions

_executions: ExecutionsClient | undefined

`Protected`_vault

_vault: VaultClient | undefined

Class FlowsClient

Index

Accessors

Constructors

Methods

Properties

Accessors

executions

Returns ExecutionsClient

vault

Returns VaultClient

Constructors

constructor

Parameters

Returns FlowsClient

Methods

list

Parameters

Returns Promise<Page<FlowSummary, ListFlowsOffsetPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateFlowResponseContent>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetFlowResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateFlowResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_executions

Protected_vault

Settings

On This Page

`Protected` `Readonly`_options

`Protected`_executions

`Protected`_vault