Class ReleasePackageApi

Hierarchy

BaseAPI
- ReleasePackageApi

Index

Constructors

Properties

Methods

createObsoletionPackage createObsoletionPackageRaw createReleasePackage createReleasePackageRaw getCompanyReleaseWorkflow getCompanyReleaseWorkflowRaw getReleasePackage getReleasePackageRaw request updateReleasePackage updateReleasePackageRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createObsoletionPackage

createObsoletionPackage(requestParameters: CreateObsoletionPackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update release package obsoletion by workflow ID.
Parameters
- requestParameters: CreateObsoletionPackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ReleasePackageApi.ts:112

createObsoletionPackageRaw

createObsoletionPackageRaw(requestParameters: CreateObsoletionPackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update release package obsoletion by workflow ID.
Parameters
- requestParameters: CreateObsoletionPackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ReleasePackageApi.ts:70

createReleasePackage

createReleasePackage(requestParameters: CreateReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update release package release by workflow ID.
Parameters
- requestParameters: CreateReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/ReleasePackageApi.ts:161

createReleasePackageRaw

createReleasePackageRaw(requestParameters: CreateReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update release package release by workflow ID.
Parameters
- requestParameters: CreateReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/ReleasePackageApi.ts:120

getCompanyReleaseWorkflow

getCompanyReleaseWorkflow(requestParameters?: GetCompanyReleaseWorkflowRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTActiveWorkflowInfo>
Retrieve release packages company release workflow.
Parameters
- requestParameters: GetCompanyReleaseWorkflowRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTActiveWorkflowInfo>
- Defined in apis/ReleasePackageApi.ts:199

getCompanyReleaseWorkflowRaw

getCompanyReleaseWorkflowRaw(requestParameters: GetCompanyReleaseWorkflowRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTActiveWorkflowInfo>>
Retrieve release packages company release workflow.
Parameters
- requestParameters: GetCompanyReleaseWorkflowRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTActiveWorkflowInfo>>
- Defined in apis/ReleasePackageApi.ts:169

getReleasePackage

getReleasePackage(requestParameters: GetReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTReleasePackageInfo>
Retrieve release packages by release package ID.
Parameters
- requestParameters: GetReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTReleasePackageInfo>
- Defined in apis/ReleasePackageApi.ts:241

getReleasePackageRaw

getReleasePackageRaw(requestParameters: GetReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTReleasePackageInfo>>
Retrieve release packages by release package ID.
Parameters
- requestParameters: GetReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTReleasePackageInfo>>
- Defined in apis/ReleasePackageApi.ts:207

`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

updateReleasePackage

updateReleasePackage(requestParameters: UpdateReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTReleasePackageInfo>
Update release packages by release package ID.
Parameters
- requestParameters: UpdateReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTReleasePackageInfo>
- Defined in apis/ReleasePackageApi.ts:294

updateReleasePackageRaw

updateReleasePackageRaw(requestParameters: UpdateReleasePackageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTReleasePackageInfo>>
Update release packages by release package ID.
Parameters
- requestParameters: UpdateReleasePackageRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTReleasePackageInfo>>
- Defined in apis/ReleasePackageApi.ts:249

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 ReleasePackageApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns ReleasePackageApi

Properties

Protected configuration

Methods

createObsoletionPackage

Parameters

requestParameters: CreateObsoletionPackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

createObsoletionPackageRaw

Parameters

requestParameters: CreateObsoletionPackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

createReleasePackage

Parameters

requestParameters: CreateReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

createReleasePackageRaw

Parameters

requestParameters: CreateReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getCompanyReleaseWorkflow

Parameters

requestParameters: GetCompanyReleaseWorkflowRequest = {}

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTActiveWorkflowInfo>

getCompanyReleaseWorkflowRaw

Parameters

requestParameters: GetCompanyReleaseWorkflowRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTActiveWorkflowInfo>>

getReleasePackage

Parameters

requestParameters: GetReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTReleasePackageInfo>

getReleasePackageRaw

Parameters

requestParameters: GetReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTReleasePackageInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateReleasePackage

Parameters

requestParameters: UpdateReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTReleasePackageInfo>

updateReleasePackageRaw

Parameters

requestParameters: UpdateReleasePackageRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTReleasePackageInfo>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

`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

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

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

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