Class UserControllerApi

Hierarchy

BaseAPI
- UserControllerApi

Index

Constructors

Properties

Methods

getJsonPropertyAsString getJsonPropertyAsStringRaw getUserInfo getUserInfoRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new UserControllerApi(configuration?: Configuration): UserControllerApi
Parameters
- configuration: Configuration = ...
Returns UserControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getJsonPropertyAsString

getJsonPropertyAsString(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<string>
Utility function to extract properties from JSON objects in language where this is cumbersome.
Parameters
- requestParameters: GetJsonPropertyAsStringRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getJsonPropertyAsStringRaw

getJsonPropertyAsStringRaw(requestParameters: GetJsonPropertyAsStringRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Utility function to extract properties from JSON objects in language where this is cumbersome.
Parameters
- requestParameters: GetJsonPropertyAsStringRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getUserInfo

getUserInfo(initOverrides?: RequestInit): Promise<UserInfoDto>
Get account information for your user
Parameters
- Optional initOverrides: RequestInit
Returns Promise<UserInfoDto>

getUserInfoRaw

getUserInfoRaw(initOverrides?: RequestInit): Promise<ApiResponse<UserInfoDto>>
Get account information for your user
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<UserInfoDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

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

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

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