Class SystemInfoApi

SystemInfoApi - object-oriented interface

Export

SystemInfoApi

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:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getSystemInfo

getSystemInfo(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<SystemInfoSchema, any>>
Retreive basic system info
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SystemInfoSchema, any>>
Throws
Memberof
SystemInfoApi
- Defined in api.ts:17227

getSystemUser

getSystemUser(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<UserSchema, any>>
Retreive basic user info
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserSchema, any>>
Throws
Memberof
SystemInfoApi
- Defined in api.ts:17238

getSystemUserPreferences

getSystemUserPreferences(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<UserPreferences, any>>
Retreive user preferences
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserPreferences, any>>
Throws
Memberof
SystemInfoApi
- Defined in api.ts:17249

putUpdateSystemUserPreferences

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