Class WorkflowApi

Hierarchy

BaseAPI
- WorkflowApi

Index

Constructors

Properties

Methods

enumerateObjectWorkflows enumerateObjectWorkflowsRaw getActiveWorkflows getActiveWorkflowsRaw getAllowedApprovers getAllowedApproversRaw getAuditLog getAuditLogRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new WorkflowApi(configuration?: Configuration): WorkflowApi
Parameters
- configuration: Configuration = DefaultConfig
Returns WorkflowApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

enumerateObjectWorkflows

enumerateObjectWorkflows(requestParameters: EnumerateObjectWorkflowsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTObjectWorkflowInfo>
Enumerate all workflowable objects like RELEASES, TASKS in a company by last modified time. Caller must be a company admin. Specify modifiedAfter and use the next URI to do complete enumeration. Enumerate workflowable objects created in a company.
Parameters
- requestParameters: EnumerateObjectWorkflowsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTObjectWorkflowInfo>
- Defined in apis/WorkflowApi.ts:116

enumerateObjectWorkflowsRaw

enumerateObjectWorkflowsRaw(requestParameters: EnumerateObjectWorkflowsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTObjectWorkflowInfo>>
Enumerate all workflowable objects like RELEASES, TASKS in a company by last modified time. Caller must be a company admin. Specify modifiedAfter and use the next URI to do complete enumeration. Enumerate workflowable objects created in a company.
Parameters
- requestParameters: EnumerateObjectWorkflowsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTObjectWorkflowInfo>>
- Defined in apis/WorkflowApi.ts:69

getActiveWorkflows

getActiveWorkflows(requestParameters?: GetActiveWorkflowsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTActiveWorkflowInfo>
Retrieve active workflow.
Parameters
- requestParameters: GetActiveWorkflowsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTActiveWorkflowInfo>
- Defined in apis/WorkflowApi.ts:154

getActiveWorkflowsRaw

getActiveWorkflowsRaw(requestParameters: GetActiveWorkflowsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTActiveWorkflowInfo>>
Retrieve active workflow.
Parameters
- requestParameters: GetActiveWorkflowsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTActiveWorkflowInfo>>
- Defined in apis/WorkflowApi.ts:124

getAllowedApprovers

getAllowedApprovers(requestParameters: GetAllowedApproversRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTWorkflowObserverOptionInfo>
Parameters
- requestParameters: GetAllowedApproversRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTWorkflowObserverOptionInfo>
- Defined in apis/WorkflowApi.ts:202

getAllowedApproversRaw

getAllowedApproversRaw(requestParameters: GetAllowedApproversRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTWorkflowObserverOptionInfo>>
Parameters
- requestParameters: GetAllowedApproversRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTWorkflowObserverOptionInfo>>
- Defined in apis/WorkflowApi.ts:161

getAuditLog

getAuditLog(requestParameters: GetAuditLogRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTWorkflowAuditLogInfo>
Parameters
- requestParameters: GetAuditLogRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTWorkflowAuditLogInfo>
- Defined in apis/WorkflowApi.ts:238

getAuditLogRaw

getAuditLogRaw(requestParameters: GetAuditLogRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTWorkflowAuditLogInfo>>
Parameters
- requestParameters: GetAuditLogRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTWorkflowAuditLogInfo>>
- Defined in apis/WorkflowApi.ts:209

`Protected` request

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

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class WorkflowApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns WorkflowApi

Properties

Protected configuration

Methods

enumerateObjectWorkflows

Parameters

requestParameters: EnumerateObjectWorkflowsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTListResponseBTObjectWorkflowInfo>

enumerateObjectWorkflowsRaw

Parameters

requestParameters: EnumerateObjectWorkflowsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTListResponseBTObjectWorkflowInfo>>

getActiveWorkflows

Parameters

requestParameters: GetActiveWorkflowsRequest = {}

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTActiveWorkflowInfo>

getActiveWorkflowsRaw

Parameters

requestParameters: GetActiveWorkflowsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTActiveWorkflowInfo>>

getAllowedApprovers

Parameters

requestParameters: GetAllowedApproversRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTListResponseBTWorkflowObserverOptionInfo>

getAllowedApproversRaw

Parameters

requestParameters: GetAllowedApproversRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTListResponseBTWorkflowObserverOptionInfo>>

getAuditLog

Parameters

requestParameters: GetAuditLogRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTWorkflowAuditLogInfo>

getAuditLogRaw

Parameters

requestParameters: GetAuditLogRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTWorkflowAuditLogInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

Returns T

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]