Class AliasApi

Hierarchy

BaseAPI
- AliasApi

Index

Constructors

Properties

Methods

createAlias createAliasRaw deleteAlias deleteAliasRaw getAlias getAliasMembers getAliasMembersRaw getAliasRaw getAliasesInCompany getAliasesInCompanyRaw request updateAlias updateAliasRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createAlias

createAlias(requestParameters: CreateAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAliasInfo>
Create an alias that contains users and/or teams.
Parameters
- requestParameters: CreateAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAliasInfo>
- Defined in apis/AliasApi.ts:109

createAliasRaw

createAliasRaw(requestParameters: CreateAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAliasInfo>>
Create an alias that contains users and/or teams.
Parameters
- requestParameters: CreateAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAliasInfo>>
- Defined in apis/AliasApi.ts:76

deleteAlias

deleteAlias(requestParameters: DeleteAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete alias by alias ID.
Parameters
- requestParameters: DeleteAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/AliasApi.ts:147

deleteAliasRaw

deleteAliasRaw(requestParameters: DeleteAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete alias by alias ID.
Parameters
- requestParameters: DeleteAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/AliasApi.ts:117

getAlias

getAlias(requestParameters: GetAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAliasInfo>
Retrieve an alias by alias ID.
Parameters
- requestParameters: GetAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAliasInfo>
- Defined in apis/AliasApi.ts:185

getAliasMembers

getAliasMembers(requestParameters: GetAliasMembersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTAliasEntryInfo>
Retrieve all alias members by alias ID.
Parameters
- requestParameters: GetAliasMembersRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTAliasEntryInfo>
- Defined in apis/AliasApi.ts:243

getAliasMembersRaw

getAliasMembersRaw(requestParameters: GetAliasMembersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTAliasEntryInfo>>
Retrieve all alias members by alias ID.
Parameters
- requestParameters: GetAliasMembersRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTAliasEntryInfo>>
- Defined in apis/AliasApi.ts:193

getAliasRaw

getAliasRaw(requestParameters: GetAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAliasInfo>>
Retrieve an alias by alias ID.
Parameters
- requestParameters: GetAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAliasInfo>>
- Defined in apis/AliasApi.ts:155

getAliasesInCompany

getAliasesInCompany(requestParameters?: GetAliasesInCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTAliasInfo>
Retrieve an array of aliases for the enterprise.
Parameters
- requestParameters: GetAliasesInCompanyRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTAliasInfo>
- Defined in apis/AliasApi.ts:297

getAliasesInCompanyRaw

getAliasesInCompanyRaw(requestParameters: GetAliasesInCompanyRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTAliasInfo>>
Retrieve an array of aliases for the enterprise.
Parameters
- requestParameters: GetAliasesInCompanyRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTAliasInfo>>
- Defined in apis/AliasApi.ts:251

`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

updateAlias

updateAlias(requestParameters: UpdateAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAliasInfo>
Update alias by alias ID.
Parameters
- requestParameters: UpdateAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAliasInfo>
- Defined in apis/AliasApi.ts:342

updateAliasRaw

updateAliasRaw(requestParameters: UpdateAliasRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAliasInfo>>
Update alias by alias ID.
Parameters
- requestParameters: UpdateAliasRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAliasInfo>>
- Defined in apis/AliasApi.ts:305

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

Generated using TypeDoc