Function PluginApiFactory

Returns {
    cancelPackageInstallation(
        requestParameters: PluginApiCancelPackageInstallationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    disablePlugin(
        requestParameters: PluginApiDisablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    enablePlugin(
        requestParameters: PluginApiEnablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getConfigurationPages(
        requestParameters?: PluginApiGetConfigurationPagesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfigurationPageInfo[]>;
    getDashboardConfigurationPage(
        requestParameters?: PluginApiGetDashboardConfigurationPageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getPackageInfo(
        requestParameters: PluginApiGetPackageInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PackageInfo>;
    getPackages(options?: RawAxiosRequestConfig): AxiosPromise<PackageInfo[]>;
    getPluginConfiguration(
        requestParameters: PluginApiGetPluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<object>;
    getPluginImage(
        requestParameters: PluginApiGetPluginImageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getPluginManifest(
        requestParameters: PluginApiGetPluginManifestRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<PluginInfo[]>;
    getRepositories(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RepositoryInfo[]>;
    installPackage(
        requestParameters: PluginApiInstallPackageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    setRepositories(
        requestParameters: PluginApiSetRepositoriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    uninstallPlugin(
        requestParameters: PluginApiUninstallPluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    uninstallPluginByVersion(
        requestParameters: PluginApiUninstallPluginByVersionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updatePluginConfiguration(
        requestParameters: PluginApiUpdatePluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• cancelPackageInstallation: function

  • cancelPackageInstallation(
        requestParameters: PluginApiCancelPackageInstallationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiCancelPackageInstallationRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• disablePlugin: function

  • disablePlugin(
        requestParameters: PluginApiDisablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiDisablePluginRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• enablePlugin: function

  • enablePlugin(
        requestParameters: PluginApiEnablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiEnablePluginRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getConfigurationPages: function

  • getConfigurationPages(
        requestParameters?: PluginApiGetConfigurationPagesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ConfigurationPageInfo[]>

    Parameters

    • requestParameters: PluginApiGetConfigurationPagesRequest = {}

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ConfigurationPageInfo[]>

    Throws

• getDashboardConfigurationPage: function

  • getDashboardConfigurationPage(
        requestParameters?: PluginApiGetDashboardConfigurationPageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    Parameters

    • requestParameters: PluginApiGetDashboardConfigurationPageRequest = {}

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• getPackageInfo: function

  • getPackageInfo(
        requestParameters: PluginApiGetPackageInfoRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PackageInfo>

    Parameters

    • requestParameters: PluginApiGetPackageInfoRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PackageInfo>

    Throws

• getPackages: function

  • getPackages(options?: RawAxiosRequestConfig): AxiosPromise<PackageInfo[]>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PackageInfo[]>

    Throws

• getPluginConfiguration: function

  • getPluginConfiguration(
        requestParameters: PluginApiGetPluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<object>

    Parameters

    • requestParameters: PluginApiGetPluginConfigurationRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<object>

    Throws

• getPluginImage: function

  • getPluginImage(
        requestParameters: PluginApiGetPluginImageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    Parameters

    • requestParameters: PluginApiGetPluginImageRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• getPluginManifest: function

  • getPluginManifest(
        requestParameters: PluginApiGetPluginManifestRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiGetPluginManifestRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getPlugins: function

  • getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<PluginInfo[]>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PluginInfo[]>

    Throws

• getRepositories: function

  • getRepositories(options?: RawAxiosRequestConfig): AxiosPromise<RepositoryInfo[]>

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RepositoryInfo[]>

    Throws

• installPackage: function

  • installPackage(
        requestParameters: PluginApiInstallPackageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiInstallPackageRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• setRepositories: function

  • setRepositories(
        requestParameters: PluginApiSetRepositoriesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiSetRepositoriesRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• uninstallPlugin: function

  • uninstallPlugin(
        requestParameters: PluginApiUninstallPluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiUninstallPluginRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• uninstallPluginByVersion: function

  • uninstallPluginByVersion(
        requestParameters: PluginApiUninstallPluginByVersionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: PluginApiUninstallPluginByVersionRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePluginConfiguration: function

  • updatePluginConfiguration(
        requestParameters: PluginApiUpdatePluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Accepts plugin configuration as JSON body.

    Parameters

    • requestParameters: PluginApiUpdatePluginConfigurationRequest

      Request parameters.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws