Class FlowsManager

Hierarchy

BaseAPI
- FlowsManager

Index

Constructors

Properties

Methods

create createConnection delete deleteConnection deleteExecution get getAll getAllConnections getAllExecutions getConnection getExecution request update updateConnection

Constructors

constructor

new FlowsManager(configuration): FlowsManager
Parameters
- configuration: Configuration
Returns FlowsManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

create

create(bodyParameters, initOverrides?): Promise<ApiResponse<PostFlows201Response>>
Create a flow

Throws
Parameters
- bodyParameters: PostFlowsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlows201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:425

createConnection

createConnection(bodyParameters, initOverrides?): Promise<ApiResponse<PostFlowsVaultConnections201Response>>
Create a Flows Vault connection

Throws
Parameters
- bodyParameters: PostFlowsVaultConnectionsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlowsVaultConnections201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:451

delete

delete(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a flow

Throws
Parameters
- requestParameters: DeleteFlowsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/flows-manager.ts:44

deleteConnection

deleteConnection(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a Flows Vault connection

Throws
Parameters
- requestParameters: DeleteFlowsVaultConnectionsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/flows-manager.ts:90

deleteExecution

deleteExecution(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete a flow execution

Throws
Parameters
- requestParameters: DeleteFlowsExecutionsByExecutionIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/flows-manager.ts:66

get

get(requestParameters, initOverrides?): Promise<ApiResponse<PostFlows201Response>>
Get a flow

Throws
Parameters
- requestParameters: GetFlowsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlows201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:170

getAll

getAll(requestParameters, initOverrides?): Promise<ApiResponse<GetFlows200ResponseOneOf>>
Get flows

Throws
Parameters
- requestParameters: GetFlowsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlows200ResponseOneOf>>
- Defined in src/management/__generated/managers/flows-manager.ts:115
getAll(requestParameters?, initOverrides?): Promise<ApiResponse<GetFlows200ResponseOneOfInner[]>>
Parameters
- Optional requestParameters: GetFlowsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlows200ResponseOneOfInner[]>>
- Defined in src/management/__generated/managers/flows-manager.ts:119

getAllConnections

getAllConnections(requestParameters, initOverrides?): Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOf>>
Get Flows Vault connection list

Throws
Parameters
- requestParameters: GetFlowsVaultConnectionsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOf>>
- Defined in src/management/__generated/managers/flows-manager.ts:295
getAllConnections(requestParameters?, initOverrides?): Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOfInner[]>>
Parameters
- Optional requestParameters: GetFlowsVaultConnectionsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOfInner[]>>
- Defined in src/management/__generated/managers/flows-manager.ts:299

getAllExecutions

getAllExecutions(requestParameters, initOverrides?): Promise<ApiResponse<GetFlowsExecutions200ResponseOneOf>>
Get flow executions

Throws
Parameters
- requestParameters: GetFlowsExecutionsRequest & {
  include_totals: true;
  }
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlowsExecutions200ResponseOneOf>>
- Defined in src/management/__generated/managers/flows-manager.ts:203
getAllExecutions(requestParameters?, initOverrides?): Promise<ApiResponse<GetFlowsExecutions200ResponseOneOfInner[]>>
Parameters
- Optional requestParameters: GetFlowsExecutionsRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlowsExecutions200ResponseOneOfInner[]>>
- Defined in src/management/__generated/managers/flows-manager.ts:207

getConnection

getConnection(requestParameters, initOverrides?): Promise<ApiResponse<PostFlowsVaultConnections201Response>>
Get a Flows Vault connection

Throws
Parameters
- requestParameters: GetFlowsVaultConnectionsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlowsVaultConnections201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:339

getExecution

getExecution(requestParameters, initOverrides?): Promise<ApiResponse<GetFlowsExecutionsByExecutionId200Response>>
Get a flow execution

Throws
Parameters
- requestParameters: GetFlowsExecutionsByExecutionIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetFlowsExecutionsByExecutionId200Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:260

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

update

update(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<PostFlows201Response>>
Update a flow

Throws
Parameters
- requestParameters: PatchFlowsByIdOperationRequest
- bodyParameters: PatchFlowsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlows201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:364

updateConnection

updateConnection(requestParameters, bodyParameters, initOverrides?): Promise<ApiResponse<PostFlowsVaultConnections201Response>>
Update a Flows Vault connection

Throws
Parameters
- requestParameters: PatchFlowsVaultConnectionsByIdOperationRequest
- bodyParameters: PatchFlowsVaultConnectionsByIdRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostFlowsVaultConnections201Response>>
- Defined in src/management/__generated/managers/flows-manager.ts:393

Class FlowsManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration

Returns FlowsManager

Properties

Protected configuration

Methods

create

Throws

Parameters

bodyParameters: PostFlowsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostFlows201Response>>

createConnection

Throws

Parameters

bodyParameters: PostFlowsVaultConnectionsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostFlowsVaultConnections201Response>>

delete

Throws

Parameters

requestParameters: DeleteFlowsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

deleteConnection

Throws

Parameters

requestParameters: DeleteFlowsVaultConnectionsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

deleteExecution

Throws

Parameters

requestParameters: DeleteFlowsExecutionsByExecutionIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<void>>

get

Throws

Parameters

requestParameters: GetFlowsByIdRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<PostFlows201Response>>

getAll

Throws

Parameters

requestParameters: GetFlowsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlows200ResponseOneOf>>

Parameters

Optional requestParameters: GetFlowsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlows200ResponseOneOfInner[]>>

getAllConnections

Throws

Parameters

requestParameters: GetFlowsVaultConnectionsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOf>>

Parameters

Optional requestParameters: GetFlowsVaultConnectionsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlowsVaultConnections200ResponseOneOfInner[]>>

getAllExecutions

Throws

Parameters

requestParameters: GetFlowsExecutionsRequest & { include_totals: true; }

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlowsExecutions200ResponseOneOf>>

Parameters

Optional requestParameters: GetFlowsExecutionsRequest

Optional initOverrides: InitOverride

Returns Promise<ApiResponse<GetFlowsExecutions200ResponseOneOfInner[]>>

`Protected` configuration

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

requestParameters: GetFlowsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetFlowsRequest

`Optional` initOverrides: InitOverride

requestParameters: GetFlowsVaultConnectionsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetFlowsVaultConnectionsRequest

`Optional` initOverrides: InitOverride

requestParameters: GetFlowsExecutionsRequest & {
include_totals: true;
}

`Optional` initOverrides: InitOverride

`Optional` requestParameters: GetFlowsExecutionsRequest

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: InitOverride

`Optional` initOverrides: InitOverride