@picteus/extension-sdk 0.2.5

package/dist/picteus-ws-client/apis/ExtensionApi.js

@@ -0,0 +1,482 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.2.6
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import { ExtensionFromJSON, ExtensionActivityFromJSON, ExtensionGenerationOptionsToJSON, ExtensionSettingsFromJSON, ExtensionSettingsToJSON, ExtensionsConfigurationFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class ExtensionApi extends runtime.BaseAPI {
+    /**
+     * Returns all the installed and active extensions activities.
+     * Indicates the extension activities
+     */
+    async extensionActivitiesRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/activities`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ExtensionActivityFromJSON));
+    }
+    /**
+     * Returns all the installed and active extensions activities.
+     * Indicates the extension activities
+     */
+    async extensionActivities(initOverrides) {
+        const response = await this.extensionActivitiesRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Scaffolds an extension respecting a set of specifications.
+     * Generates an extension
+     */
+    async extensionGenerateRaw(requestParameters, initOverrides) {
+        if (requestParameters['withPublicSdk'] == null) {
+            throw new runtime.RequiredError('withPublicSdk', 'Required parameter "withPublicSdk" was null or undefined when calling extensionGenerate().');
+        }
+        if (requestParameters['extensionGenerationOptions'] == null) {
+            throw new runtime.RequiredError('extensionGenerationOptions', 'Required parameter "extensionGenerationOptions" was null or undefined when calling extensionGenerate().');
+        }
+        const queryParameters = {};
+        if (requestParameters['withPublicSdk'] != null) {
+            queryParameters['withPublicSdk'] = requestParameters['withPublicSdk'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/generate`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ExtensionGenerationOptionsToJSON(requestParameters['extensionGenerationOptions']),
+        }, initOverrides);
+        return new runtime.BlobApiResponse(response);
+    }
+    /**
+     * Scaffolds an extension respecting a set of specifications.
+     * Generates an extension
+     */
+    async extensionGenerate(requestParameters, initOverrides) {
+        const response = await this.extensionGenerateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns the details about an extension.
+     * Gets an extension
+     */
+    async extensionGetRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionGet().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/get`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+    /**
+     * Returns the details about an extension.
+     * Gets an extension
+     */
+    async extensionGet(requestParameters, initOverrides) {
+        const response = await this.extensionGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns the details in terms of all installed extensions capabilities, i.e. what they can offer, and the command they offer.
+     * Provides the extensions configuration
+     */
+    async extensionGetConfigurationRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/getConfiguration`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionsConfigurationFromJSON(jsonValue));
+    }
+    /**
+     * Returns the details in terms of all installed extensions capabilities, i.e. what they can offer, and the command they offer.
+     * Provides the extensions configuration
+     */
+    async extensionGetConfiguration(initOverrides) {
+        const response = await this.extensionGetConfigurationRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns the settings of an extension.
+     * Gets an extension settings
+     */
+    async extensionGetSettingsRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionGetSettings().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/getSettings`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionSettingsFromJSON(jsonValue));
+    }
+    /**
+     * Returns the settings of an extension.
+     * Gets an extension settings
+     */
+    async extensionGetSettings(requestParameters, initOverrides) {
+        const response = await this.extensionGetSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Analyzes the extension and installs it.
+     * Installs an extension
+     */
+    async extensionInstallRaw(requestParameters, initOverrides) {
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling extensionInstall().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/zip';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/install`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+    /**
+     * Analyzes the extension and installs it.
+     * Installs an extension
+     */
+    async extensionInstall(requestParameters, initOverrides) {
+        const response = await this.extensionInstallRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Returns all installed extensions.
+     * Lists all extensions
+     */
+    async extensionListRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/list`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ExtensionFromJSON));
+    }
+    /**
+     * Returns all installed extensions.
+     * Lists all extensions
+     */
+    async extensionList(initOverrides) {
+        const response = await this.extensionListRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Either stops and marks it as paused the extension or starts it.
+     * Pauses or resumes an extension
+     */
+    async extensionPauseOrResumeRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionPauseOrResume().');
+        }
+        if (requestParameters['isPause'] == null) {
+            throw new runtime.RequiredError('isPause', 'Required parameter "isPause" was null or undefined when calling extensionPauseOrResume().');
+        }
+        const queryParameters = {};
+        if (requestParameters['isPause'] != null) {
+            queryParameters['isPause'] = requestParameters['isPause'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/pauseOrResume`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Either stops and marks it as paused the extension or starts it.
+     * Pauses or resumes an extension
+     */
+    async extensionPauseOrResume(requestParameters, initOverrides) {
+        await this.extensionPauseOrResumeRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Runs a command exposed by an extension, on images
+     */
+    async extensionRunImageCommandRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionRunImageCommand().');
+        }
+        if (requestParameters['commandId'] == null) {
+            throw new runtime.RequiredError('commandId', 'Required parameter "commandId" was null or undefined when calling extensionRunImageCommand().');
+        }
+        if (requestParameters['imageIds'] == null) {
+            throw new runtime.RequiredError('imageIds', 'Required parameter "imageIds" was null or undefined when calling extensionRunImageCommand().');
+        }
+        const queryParameters = {};
+        if (requestParameters['commandId'] != null) {
+            queryParameters['commandId'] = requestParameters['commandId'];
+        }
+        if (requestParameters['imageIds'] != null) {
+            queryParameters['imageIds'] = requestParameters['imageIds'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/runImageCommand`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Runs the command defined for images, by triggering the relevant event to the extension.
+     * Runs a command exposed by an extension, on images
+     */
+    async extensionRunImageCommand(requestParameters, initOverrides) {
+        await this.extensionRunImageCommandRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Runs the command defined for the process, by triggering the relevant event to the extension.
+     * Runs a command exposed by an extension, on the process
+     */
+    async extensionRunProcessCommandRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionRunProcessCommand().');
+        }
+        if (requestParameters['commandId'] == null) {
+            throw new runtime.RequiredError('commandId', 'Required parameter "commandId" was null or undefined when calling extensionRunProcessCommand().');
+        }
+        const queryParameters = {};
+        if (requestParameters['commandId'] != null) {
+            queryParameters['commandId'] = requestParameters['commandId'];
+        }
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/runProcessCommand`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Runs the command defined for the process, by triggering the relevant event to the extension.
+     * Runs a command exposed by an extension, on the process
+     */
+    async extensionRunProcessCommand(requestParameters, initOverrides) {
+        await this.extensionRunProcessCommandRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Defines the settings of an extension.
+     * Sets an extension settings
+     */
+    async extensionSetSettingsRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionSetSettings().');
+        }
+        if (requestParameters['extensionSettings'] == null) {
+            throw new runtime.RequiredError('extensionSettings', 'Required parameter "extensionSettings" was null or undefined when calling extensionSetSettings().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/setSettings`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ExtensionSettingsToJSON(requestParameters['extensionSettings']),
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Defines the settings of an extension.
+     * Sets an extension settings
+     */
+    async extensionSetSettings(requestParameters, initOverrides) {
+        await this.extensionSetSettingsRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Iterates over all images available in the repositories and asks the extension to operate its work if the image is not indexed by it.
+     * Synchronizes the images via an extension
+     */
+    async extensionSynchronizeRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionSynchronize().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/synchronize`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Iterates over all images available in the repositories and asks the extension to operate its work if the image is not indexed by it.
+     * Synchronizes the images via an extension
+     */
+    async extensionSynchronize(requestParameters, initOverrides) {
+        await this.extensionSynchronizeRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Stops the extension and uninstalls it.
+     * Uninstalls an extension
+     */
+    async extensionUninstallRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionUninstall().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/uninstall`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Stops the extension and uninstalls it.
+     * Uninstalls an extension
+     */
+    async extensionUninstall(requestParameters, initOverrides) {
+        await this.extensionUninstallRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Analyzes the extension and updates it.
+     * Updates an extension
+     */
+    async extensionUpdateRaw(requestParameters, initOverrides) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling extensionUpdate().');
+        }
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling extensionUpdate().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/zip';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/extension/{id}/update`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExtensionFromJSON(jsonValue));
+    }
+    /**
+     * Analyzes the extension and updates it.
+     * Updates an extension
+     */
+    async extensionUpdate(requestParameters, initOverrides) {
+        const response = await this.extensionUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}