@coveo/platform-client/dist/cjs/resources/Extensions/Extensions.js

The main goal of this package is to provide an easy to configure and straightforward way of querying Coveo Cloud APIs using JavaScript.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const tslib_1 = require("tslib");
const APICore_js_1 = tslib_1.__importDefault(require("../../APICore.js"));
const Resource_js_1 = tslib_1.__importDefault(require("../Resource.js"));
class Extension extends Resource_js_1.default {
    static baseUrl = `/rest/organizations/${APICore_js_1.default.orgPlaceholder}/extensions`;
    /**
     * Creates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extension The configuration to use for the new extension.
     * @returns The newly created extension.
     */
    create(extension) {
        return this.api.post(Extension.baseUrl, extension);
    }
    /**
     * Updates an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionId The unique identifier of the extension to update.
     * @param options The new configuration to use for the updated extension.
     * @returns The updated extension.
     */
    update(extensionId, options) {
        return this.api.put(`${Extension.baseUrl}/${extensionId}`, options);
    }
    /**
     * Deletes an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionId The unique identifier of the extension to delete.
     * @returns
     */
    delete(extensionId) {
        return this.api.delete(`${Extension.baseUrl}/${extensionId}`);
    }
    /**
     * Enables a disabled [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     *
     * Note: Disabled extensions are not executed.
     * @param extensionId The unique identifier of the extension to enable.
     * @returns
     */
    enable(extensionId) {
        return this.api.post(`${Extension.baseUrl}/${extensionId}/enable`);
    }
    /**
     * Disables an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     *
     * Note: Disabled extensions are not executed.
     * @param extensionId The unique identifier of the extension to disable.
     * @param reason The reason why the extension is disabled.
     * @returns
     */
    disable(extensionId, reason) {
        return this.api.post(`${Extension.baseUrl}/${extensionId}/disable`, { reason });
    }
    /**
     * Shows an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionId Shows an extension in a Coveo Cloud organization.
     * @returns The extension specified by the provided id.
     */
    get(extensionId) {
        return this.api.get(`${Extension.baseUrl}/${extensionId}`);
    }
    /**
     * Lists all [extensions](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @returns A list of extensions.
     */
    list() {
        return this.api.get(Extension.baseUrl);
    }
    /**
     * Lists all versions of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionId he unique identifier of the target extension.
     * @returns A list of versions of the extension.
     */
    listVersions(extensionId) {
        return this.api.get(`${Extension.baseUrl}/${extensionId}/versions`);
    }
    /**
     * Shows a specific version of an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionId The unique identifier of the target extension.
     * @param versionId The unique identifier of the extension version to show.
     * @returns The extension specified by the provided id and version id.
     */
    getVersion(extensionId, versionId) {
        return this.api.get(`${Extension.baseUrl}/${extensionId}/versions/${versionId}`);
    }
    /**
     * Tries to compile code that would be used in an [extension](https://docs.coveo.com/en/206/) in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).
     * @param extensionCode The code to compile
     * @returns Details regarding the outcome of an extension script compilation.
     */
    validateCode(extensionCode) {
        return this.api.post(`${Extension.baseUrl}/test/compile`, extensionCode);
    }
}
exports.default = Extension;
//# sourceMappingURL=Extensions.js.map