Function PluginsApiFactory

Returns {
    disablePlugin(
        requestParameters: PluginsApiDisablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    enablePlugin(
        requestParameters: PluginsApiEnablePluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getPluginConfiguration(
        requestParameters: PluginsApiGetPluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<object>;
    getPluginImage(
        requestParameters: PluginsApiGetPluginImageRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getPluginManifest(
        requestParameters: PluginsApiGetPluginManifestRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getPlugins(options?: RawAxiosRequestConfig): AxiosPromise<PluginInfo[]>;
    uninstallPlugin(
        requestParameters: PluginsApiUninstallPluginRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    uninstallPluginByVersion(
        requestParameters: PluginsApiUninstallPluginByVersionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updatePluginConfiguration(
        requestParameters: PluginsApiUpdatePluginConfigurationRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• disablePlugin: function

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

    Parameters

    • requestParameters: PluginsApiDisablePluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• enablePlugin: function

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

    Parameters

    • requestParameters: PluginsApiEnablePluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• getPluginConfiguration: function

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

    Parameters

    • requestParameters: PluginsApiGetPluginConfigurationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<object>

    Throws

• getPluginImage: function

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

    Parameters

    • requestParameters: PluginsApiGetPluginImageRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• getPluginManifest: function

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

    Parameters

    • requestParameters: PluginsApiGetPluginManifestRequest

      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

• uninstallPlugin: function

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

    Parameters

    • requestParameters: PluginsApiUninstallPluginRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Deprecated

    Throws

• uninstallPluginByVersion: function

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

    Parameters

    • requestParameters: PluginsApiUninstallPluginByVersionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• updatePluginConfiguration: function

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

    Accepts plugin configuration as JSON body.

    Parameters

    • requestParameters: PluginsApiUpdatePluginConfigurationRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws