Class Executions

Index

Constructors

Methods

list get delete _getAuthorizationHeader

Properties

Constructors

constructor

new Executions(_options: Executions.Options): Executions
Parameters
- _options: Executions.Options
Returns Executions

Methods

list

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

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.flows.executions.list("flow_id")
```

get

get(
    flowId: string,
    executionId: string,
    request?: Management.ExecutionsGetRequest,
    requestOptions?: Executions.RequestOptions,
): HttpResponsePromise<GetFlowExecutionResponseContent>
Parameters
- flowId: string
  Flow id
- executionId: string
  Flow execution id
- request: Management.ExecutionsGetRequest = {}
- OptionalrequestOptions: Executions.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetFlowExecutionResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

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

delete

delete(
    flowId: string,
    executionId: string,
    requestOptions?: Executions.RequestOptions,
): HttpResponsePromise<void>
Parameters
- flowId: string
  Flows id
- executionId: string
  Flow execution identifier
- OptionalrequestOptions: Executions.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")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Executions.Options