Class UserApi

Hierarchy

BaseAPI
- UserApi

Index

Constructors

Properties

Methods

getUserSettings getUserSettingsCurrentLoggedInUser getUserSettingsCurrentLoggedInUserRaw getUserSettingsRaw request session sessionInfo sessionInfoRaw sessionRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getUserSettings

getUserSettings(requestParameters: GetUserSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUserSettingsInfo>
Retrieve user settings by user ID.
Parameters
- requestParameters: GetUserSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUserSettingsInfo>
- Defined in apis/UserApi.ts:81

getUserSettingsCurrentLoggedInUser

getUserSettingsCurrentLoggedInUser(requestParameters?: GetUserSettingsCurrentLoggedInUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUserSettingsInfo>
Get user settings for the currently signed-in user if there is one, or else return the default settings.
Parameters
- requestParameters: GetUserSettingsCurrentLoggedInUserRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUserSettingsInfo>
- Defined in apis/UserApi.ts:114

getUserSettingsCurrentLoggedInUserRaw

getUserSettingsCurrentLoggedInUserRaw(requestParameters: GetUserSettingsCurrentLoggedInUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUserSettingsInfo>>
Get user settings for the currently signed-in user if there is one, or else return the default settings.
Parameters
- requestParameters: GetUserSettingsCurrentLoggedInUserRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUserSettingsInfo>>
- Defined in apis/UserApi.ts:89

getUserSettingsRaw

getUserSettingsRaw(requestParameters: GetUserSettingsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUserSettingsInfo>>
Retrieve user settings by user ID.
Parameters
- requestParameters: GetUserSettingsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUserSettingsInfo>>
- Defined in apis/UserApi.ts:52

`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

session

session(requestParameters: SessionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Check if current user is signed-in.Information returned depends on OAuth2ReadPII scope.
Parameters
- requestParameters: SessionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/UserApi.ts:150

sessionInfo

sessionInfo(initOverrides?: RequestInit | InitOverrideFunction): Promise<BTUserOAuth2SummaryInfo>
Check if current user is signed-in. Information returned depends on OAuth2ReadPII scope.
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTUserOAuth2SummaryInfo>
- Defined in apis/UserApi.ts:179

sessionInfoRaw

sessionInfoRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTUserOAuth2SummaryInfo>>
Check if current user is signed-in. Information returned depends on OAuth2ReadPII scope.
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTUserOAuth2SummaryInfo>>
- Defined in apis/UserApi.ts:158

sessionRaw

sessionRaw(requestParameters: SessionRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Check if current user is signed-in.Information returned depends on OAuth2ReadPII scope.
Parameters
- requestParameters: SessionRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/UserApi.ts:122

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 UserApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns UserApi

Properties

Protected configuration

Methods

getUserSettings

Parameters

requestParameters: GetUserSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTUserSettingsInfo>

getUserSettingsCurrentLoggedInUser

Parameters

requestParameters: GetUserSettingsCurrentLoggedInUserRequest = {}

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTUserSettingsInfo>

getUserSettingsCurrentLoggedInUserRaw

Parameters

requestParameters: GetUserSettingsCurrentLoggedInUserRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTUserSettingsInfo>>

getUserSettingsRaw

Parameters

requestParameters: GetUserSettingsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTUserSettingsInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

session

Parameters

requestParameters: SessionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

sessionInfo

Parameters

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTUserOAuth2SummaryInfo>

sessionInfoRaw

Parameters

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTUserOAuth2SummaryInfo>>

sessionRaw

Parameters

requestParameters: SessionRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

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

Settings

Member Visibility

`Protected` configuration

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