Class ConfigurationApi

ConfigurationApi - object-oriented interface

Export

ConfigurationApi

Hierarchy

BaseAPI
- ConfigurationApi

Index

Constructors

constructor

new ConfigurationApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: Configuration | undefined

Methods

getConfiguration

getConfiguration(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ServerConfiguration, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerConfiguration, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:494

getDefaultMetadataOptions

getDefaultMetadataOptions(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<MetadataOptions, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MetadataOptions, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:505

getNamedConfiguration

getNamedConfiguration(
requestParameters: ConfigurationApiGetNamedConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: ConfigurationApiGetNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:517

updateBrandingConfiguration

updateBrandingConfiguration(
requestParameters: ConfigurationApiUpdateBrandingConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: ConfigurationApiUpdateBrandingConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:529

updateConfiguration

updateConfiguration(
requestParameters: ConfigurationApiUpdateConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: ConfigurationApiUpdateConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:541

updateNamedConfiguration

updateNamedConfiguration(
requestParameters: ConfigurationApiUpdateNamedConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: ConfigurationApiUpdateNamedConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>
Throws
Memberof
ConfigurationApi
- Defined in generated-client/api/configuration-api.ts:553

Class ConfigurationApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConfigurationApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getConfiguration

Parameters

Returns Promise<AxiosResponse<ServerConfiguration, any, {}>>

Throws

Memberof

getDefaultMetadataOptions

Parameters

Returns Promise<AxiosResponse<MetadataOptions, any, {}>>

Throws

Memberof

getNamedConfiguration

Parameters

Returns Promise<AxiosResponse<File, any, {}>>

Throws

Memberof

updateBrandingConfiguration

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

updateConfiguration

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

updateNamedConfiguration

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration