Class ExecutionsClient

Index

Constructors

Methods

list get delete

Properties

Constructors

constructor

new ExecutionsClient(options: BaseClientOptions): ExecutionsClient
Parameters
- options: BaseClientOptions
Returns ExecutionsClient

Methods

list

list(
    flow_id: string,
    request?: ListFlowExecutionsRequestParameters,
    requestOptions?: ExecutionsClient.RequestOptions,
): Promise<
    Page<FlowExecutionSummary, ListFlowExecutionsPaginatedResponseContent>,
>
Parameters
- flow_id: string
  Flow id
- request: ListFlowExecutionsRequestParameters = {}
- OptionalrequestOptions: ExecutionsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<FlowExecutionSummary, ListFlowExecutionsPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.executions.list("flow_id", {
        include_totals: true,
        from: "from",
        take: 1
    })
```

get

get(
    flow_id: string,
    execution_id: string,
    request?: GetFlowExecutionRequestParameters,
    requestOptions?: ExecutionsClient.RequestOptions,
): HttpResponsePromise<GetFlowExecutionResponseContent>
Parameters
- flow_id: string
  Flow id
- execution_id: string
  Flow execution id
- request: GetFlowExecutionRequestParameters = {}
- OptionalrequestOptions: ExecutionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetFlowExecutionResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.executions.get("flow_id", "execution_id", {
        hydrate: ["debug"]
    })
```

delete

delete(
    flow_id: string,
    execution_id: string,
    requestOptions?: ExecutionsClient.RequestOptions,
): HttpResponsePromise<void>
Parameters
- flow_id: string
  Flows id
- execution_id: string
  Flow execution identifier
- OptionalrequestOptions: ExecutionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.executions.delete("flow_id", "execution_id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>