Class PluginApi

PluginApi - object-oriented interface

Hierarchy

BaseAPI
- PluginApi

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

cancelPackageInstallation

cancelPackageInstallation(
requestParameters: PluginApiCancelPackageInstallationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiCancelPackageInstallationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1296

disablePlugin

disablePlugin(
requestParameters: PluginApiDisablePluginRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiDisablePluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1307

enablePlugin

enablePlugin(
requestParameters: PluginApiEnablePluginRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiEnablePluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1318

getConfigurationPages

getConfigurationPages(
requestParameters?: PluginApiGetConfigurationPagesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ConfigurationPageInfo[], any, {}>>
Parameters
- requestParameters: PluginApiGetConfigurationPagesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConfigurationPageInfo[], any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1329

getDashboardConfigurationPage

getDashboardConfigurationPage(
requestParameters?: PluginApiGetDashboardConfigurationPageRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: PluginApiGetDashboardConfigurationPageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1340

getPackageInfo

getPackageInfo(
requestParameters: PluginApiGetPackageInfoRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PackageInfo, any, {}>>
Parameters
- requestParameters: PluginApiGetPackageInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PackageInfo, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1351

getPackages

getPackages(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PackageInfo[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PackageInfo[], any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1361

getPluginConfiguration

getPluginConfiguration(
requestParameters: PluginApiGetPluginConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<object, any, {}>>
Parameters
- requestParameters: PluginApiGetPluginConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<object, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1372

getPluginImage

getPluginImage(
requestParameters: PluginApiGetPluginImageRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: PluginApiGetPluginImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1383

getPluginManifest

getPluginManifest(
requestParameters: PluginApiGetPluginManifestRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiGetPluginManifestRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1394

getPlugins

getPlugins(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PluginInfo[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PluginInfo[], any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1404

getRepositories

getRepositories(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RepositoryInfo[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RepositoryInfo[], any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1414

installPackage

installPackage(
requestParameters: PluginApiInstallPackageRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiInstallPackageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1425

setRepositories

setRepositories(
requestParameters: PluginApiSetRepositoriesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiSetRepositoriesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1436

uninstallPlugin

uninstallPlugin(
requestParameters: PluginApiUninstallPluginRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiUninstallPluginRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1447

uninstallPluginByVersion

uninstallPluginByVersion(
requestParameters: PluginApiUninstallPluginByVersionRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: PluginApiUninstallPluginByVersionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1458

updatePluginConfiguration

updatePluginConfiguration(
requestParameters: PluginApiUpdatePluginConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Accepts plugin configuration as JSON body.
Parameters
- requestParameters: PluginApiUpdatePluginConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/plugin-api.ts:1469

Class PluginApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PluginApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

cancelPackageInstallation

Parameters

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

Throws

disablePlugin

Parameters

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

Throws

enablePlugin

Parameters

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

Throws

getConfigurationPages

Parameters

Returns Promise<AxiosResponse<ConfigurationPageInfo[], any, {}>>

Throws

getDashboardConfigurationPage

Parameters

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

Throws

getPackageInfo

Parameters

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

Throws

getPackages

Parameters

Returns Promise<AxiosResponse<PackageInfo[], any, {}>>

Throws

getPluginConfiguration

Parameters

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

Throws

getPluginImage

Parameters

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

Throws

getPluginManifest

Parameters

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

Throws

getPlugins

Parameters

Returns Promise<AxiosResponse<PluginInfo[], any, {}>>

Throws

getRepositories

Parameters

Returns Promise<AxiosResponse<RepositoryInfo[], any, {}>>

Throws

installPackage

Parameters

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

Throws

setRepositories

Parameters

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

Throws

uninstallPlugin

Parameters

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

Throws

uninstallPluginByVersion

Parameters

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

Throws

updatePluginConfiguration

`Protected`axios

`Protected`basePath

`Protected`configuration