Class UserApi

UserApi - object-oriented interface

Hierarchy (View Summary)

BaseAPI
- UserApi

Index

Constructors

Properties

axios basePath configuration

Methods

connectSocialNetworkProvider disconnectSocialNetworkProvider getCurrentUser getPublicUserByName getSystemCollectionStats updateCurrentUser

Constructors

constructor

new UserApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): UserApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UserApi
Inherited from BaseAPI.constructor
- Defined in src/generated/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

connectSocialNetworkProvider

connectSocialNetworkProvider(
provider: generated.ConnectSocialNetworkProviderProviderEnum,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- provider: generated.ConnectSocialNetworkProviderProviderEnum
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in src/generated/api.ts:4722

disconnectSocialNetworkProvider

disconnectSocialNetworkProvider(
provider: generated.DisconnectSocialNetworkProviderProviderEnum,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- provider: generated.DisconnectSocialNetworkProviderProviderEnum
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in src/generated/api.ts:4732

getCurrentUser

getCurrentUser(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetCurrentUserResponse, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetCurrentUserResponse, any, {}>>

Throws
- Defined in src/generated/api.ts:4741

getPublicUserByName

getPublicUserByName(
name: number,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetPublicUserByNameResponse, any, {}>>
Parameters
- name: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetPublicUserByNameResponse, any, {}>>

Throws
- Defined in src/generated/api.ts:4751

getSystemCollectionStats

getSystemCollectionStats(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetSystemCollectionStatsResponse, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetSystemCollectionStatsResponse, any, {}>>

Throws
- Defined in src/generated/api.ts:4760

updateCurrentUser

updateCurrentUser(
updateCurrentUserRequest?: UpdateCurrentUserRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UpdateCurrentUserResponse, any, {}>>
Parameters
- OptionalupdateCurrentUserRequest: UpdateCurrentUserRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UpdateCurrentUserResponse, any, {}>>

Throws
- Defined in src/generated/api.ts:4770