Class APIApplicationApi

Hierarchy

BaseAPI
- APIApplicationApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteAppSettings

deleteAppSettings(requestParameters: DeleteAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<void>
Delete application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: DeleteAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in apis/APIApplicationApi.ts:114

deleteAppSettingsRaw

deleteAppSettingsRaw(requestParameters: DeleteAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<void>>
Delete application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: DeleteAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in apis/APIApplicationApi.ts:81

deleteCompanyAppSettings

deleteCompanyAppSettings(requestParameters: DeleteCompanyAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: DeleteCompanyAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/APIApplicationApi.ts:154

deleteCompanyAppSettingsRaw

deleteCompanyAppSettingsRaw(requestParameters: DeleteCompanyAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: DeleteCompanyAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/APIApplicationApi.ts:121

getApplicableExtensionsForClient

getApplicableExtensionsForClient(requestParameters: GetApplicableExtensionsForClientRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTAPIApplicationExtensionInfo[]>
Get list of client extensions the user has granted/accepted terms for
Parameters
- requestParameters: GetApplicableExtensionsForClientRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTAPIApplicationExtensionInfo[]>
- Defined in apis/APIApplicationApi.ts:200

getApplicableExtensionsForClientRaw

getApplicableExtensionsForClientRaw(requestParameters: GetApplicableExtensionsForClientRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTAPIApplicationExtensionInfo[]>>
Get list of client extensions the user has granted/accepted terms for
Parameters
- requestParameters: GetApplicableExtensionsForClientRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTAPIApplicationExtensionInfo[]>>
- Defined in apis/APIApplicationApi.ts:162

getCompanyAppSettings

getCompanyAppSettings(requestParameters: GetCompanyAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUserAppSettingsInfo>
Retrieve company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: GetCompanyAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUserAppSettingsInfo>
- Defined in apis/APIApplicationApi.ts:241

getCompanyAppSettingsRaw

getCompanyAppSettingsRaw(requestParameters: GetCompanyAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUserAppSettingsInfo>>
Retrieve company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: GetCompanyAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUserAppSettingsInfo>>
- Defined in apis/APIApplicationApi.ts:208

getUserAppSettings

getUserAppSettings(requestParameters: GetUserAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUserAppSettingsInfo>
Retrieve application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: GetUserAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUserAppSettingsInfo>
- Defined in apis/APIApplicationApi.ts:282

getUserAppSettingsRaw

getUserAppSettingsRaw(requestParameters: GetUserAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUserAppSettingsInfo>>
Retrieve application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: GetUserAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUserAppSettingsInfo>>
- Defined in apis/APIApplicationApi.ts:249

`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

updateAppCompanySettings

updateAppCompanySettings(requestParameters: UpdateAppCompanySettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update or create company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: UpdateAppCompanySettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/APIApplicationApi.ts:326

updateAppCompanySettingsRaw

updateAppCompanySettingsRaw(requestParameters: UpdateAppCompanySettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update or create company level settings for this application by client ID and company ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: UpdateAppCompanySettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/APIApplicationApi.ts:290

updateAppSettings

updateAppSettings(requestParameters: UpdateAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Update or create application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: UpdateAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/APIApplicationApi.ts:370

updateAppSettingsRaw

updateAppSettingsRaw(requestParameters: UpdateAppSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Update or create application settings for a user by client ID and user ID. This API may only be used with an OAuth token and only by the current user.
Parameters
- requestParameters: UpdateAppSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/APIApplicationApi.ts:334

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 APIApplicationApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns APIApplicationApi

Properties

Protected configuration

Methods

deleteAppSettings

Parameters

requestParameters: DeleteAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<void>

deleteAppSettingsRaw

Parameters

requestParameters: DeleteAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<void>>

deleteCompanyAppSettings

Parameters

requestParameters: DeleteCompanyAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteCompanyAppSettingsRaw

Parameters

requestParameters: DeleteCompanyAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getApplicableExtensionsForClient

Parameters

requestParameters: GetApplicableExtensionsForClientRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTAPIApplicationExtensionInfo[]>

getApplicableExtensionsForClientRaw

Parameters

requestParameters: GetApplicableExtensionsForClientRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTAPIApplicationExtensionInfo[]>>

getCompanyAppSettings

Parameters

requestParameters: GetCompanyAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTUserAppSettingsInfo>

getCompanyAppSettingsRaw

Parameters

requestParameters: GetCompanyAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTUserAppSettingsInfo>>

getUserAppSettings

Parameters

requestParameters: GetUserAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTUserAppSettingsInfo>

getUserAppSettingsRaw

Parameters

requestParameters: GetUserAppSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTUserAppSettingsInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateAppCompanySettings

Parameters

requestParameters: UpdateAppCompanySettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

updateAppCompanySettingsRaw

Parameters

requestParameters: UpdateAppCompanySettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

updateAppSettings

`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

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`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>)[]