Class ConfigApi

Hierarchy (View Summary)

BaseAPI
- ConfigApi

Index

Constructors

Properties

Methods

isJsonMime listConfigFiles listConfigFilesRaw loadConfigFile loadConfigFileRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ConfigApi(configuration?: Configuration): ConfigApi
Parameters
- configuration: Configuration = DefaultConfig
Returns ConfigApi
Inherited from BaseAPI.constructor
- Defined in swittest-api/generated/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

`Protected`isJsonMime

isJsonMime(mime: string): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in swittest-api/generated/runtime.ts:127

listConfigFiles

listConfigFiles(
requestParameters?: ListConfigFilesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ListDirectorySchema>
List Config Files
Parameters
- requestParameters: ListConfigFilesRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ListDirectorySchema>
- Defined in swittest-api/generated/apis/ConfigApi.ts:74

listConfigFilesRaw

listConfigFilesRaw(
requestParameters: ListConfigFilesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ListDirectorySchema>>
List Config Files
Parameters
- requestParameters: ListConfigFilesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ListDirectorySchema>>
- Defined in swittest-api/generated/apis/ConfigApi.ts:44

loadConfigFile

loadConfigFile(
requestParameters: LoadConfigFileRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<{ [key: string]: any }>
Load Config File
Parameters
- requestParameters: LoadConfigFileRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<{ [key: string]: any }>
- Defined in swittest-api/generated/apis/ConfigApi.ts:119

loadConfigFileRaw

loadConfigFileRaw(
requestParameters: LoadConfigFileRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<{ [key: string]: any }>>
Load Config File
Parameters
- requestParameters: LoadConfigFileRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<{ [key: string]: any }>>
- Defined in swittest-api/generated/apis/ConfigApi.ts:82

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in swittest-api/generated/runtime.ts:134

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in swittest-api/generated/runtime.ts:101

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
this: T,
...postMiddlewares: (context: ResponseContext) => Promise<void | Response>[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (context: ResponseContext) => Promise<void | Response>[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in swittest-api/generated/runtime.ts:112

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
this: T,
...preMiddlewares: (context: RequestContext) => Promise<void | FetchParams>[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (context: RequestContext) => Promise<void | FetchParams>[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in swittest-api/generated/runtime.ts:107