Class ConfigurationApi

ConfigurationApi - object-oriented interface

Export

ConfigurationApi

Hierarchy

BaseAPI
- ConfigurationApi

Index

Constructors

Properties

axios basePath configuration

Methods

getConfiguration getDefaultMetadataOptions getNamedConfiguration updateConfiguration updateNamedConfiguration

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getConfiguration

getConfiguration(options?): Promise<AxiosResponse<ServerConfiguration, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerConfiguration, any>>
Summary
Gets application configuration.

Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:416

getDefaultMetadataOptions

getDefaultMetadataOptions(options?): Promise<AxiosResponse<MetadataOptions, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetadataOptions, any>>
Summary
Gets a default MetadataOptions object.

Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:427

getNamedConfiguration

getNamedConfiguration(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ConfigurationApiGetNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a named configuration.

Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:439

updateConfiguration

updateConfiguration(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ConfigurationApiUpdateConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates application configuration.

Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:451

updateNamedConfiguration

updateNamedConfiguration(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ConfigurationApiUpdateNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates named configuration.

Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:463