Class SystemInfoApi

SystemInfoApi - object-oriented interface

Hierarchy

BaseAPI
- SystemInfoApi

Index

Constructors

Properties

axios basePath configuration

Methods

getSystemInfo getSystemUser getSystemUserPreferences putUpdateSystemUserPreferences

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getSystemInfo

getSystemInfo(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SystemInfoSchema, any, {}>>
Retreive basic system info
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SystemInfoSchema, any, {}>>
Throws
- Defined in api.ts:12863

getSystemUser

getSystemUser(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserSchema, any, {}>>
Retreive basic user info
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserSchema, any, {}>>
Throws
- Defined in api.ts:12873

getSystemUserPreferences

getSystemUserPreferences(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserPreferences, any, {}>>
Retreive user preferences
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserPreferences, any, {}>>
Throws
- Defined in api.ts:12883

putUpdateSystemUserPreferences

putUpdateSystemUserPreferences(
requestParameters: SystemInfoApiPutUpdateSystemUserPreferencesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserPreferences, any, {}>>
Update user preferences
Parameters
- requestParameters: SystemInfoApiPutUpdateSystemUserPreferencesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserPreferences, any, {}>>
Throws
- Defined in api.ts:12894