Class ConfigApi

ConfigApi - object-oriented interface

Hierarchy

BaseAPI
- ConfigApi

Index

Constructors

Properties

axios basePath configuration

Methods

listConfigFiles loadConfigFile

Constructors

constructor

new ConfigApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ConfigApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ConfigApi
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

listConfigFiles

listConfigFiles(
requestParameters?: ConfigApiListConfigFilesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ListDirectorySchema, any, {}>>
Parameters
- requestParameters: ConfigApiListConfigFilesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ListDirectorySchema, any, {}>>
Throws
- Defined in api.ts:1051

loadConfigFile

loadConfigFile(
requestParameters: ConfigApiLoadConfigFileRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<object, any, {}>>
Parameters
- requestParameters: ConfigApiLoadConfigFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<object, any, {}>>
Throws
- Defined in api.ts:1062