hcloud-sdk 0.0.16 → 15.0.0

package/lib/service/high5/space/execution/status/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5SpaceExecutionStates = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+class High5SpaceExecutionStates extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+    }
+    /**
+     * Retrieves all stream execution logs for a given stream.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param streamStatusId ID of the stream status
+     * @returns Object containing an array of Stream execution logs as well as the total number of results
+     */
+    getStreamExecutionStatus(orgName_1, spaceName_1, streamStatusId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, streamStatusId, limit = 25, page = 0) {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/status/${streamStatusId}?page=${page}&limit=${limit}`));
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5SpaceExecutionStates = High5SpaceExecutionStates;

package/lib/service/high5/space/index.d.ts

@@ -0,0 +1,111 @@
+import Base from "../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../interfaces/global";
+import { Stream } from "../../../interfaces/high5";
+import { High5Space as Space, High5SpaceEntityPermission as SpaceEntityPermission, High5SpacePermission as SpacePermission } from "../../../interfaces/high5/space";
+import { High5Event } from "./event";
+import { High5SpaceExecute } from "./execution";
+import High5Node from "./node";
+import High5Secret from "./secret";
+import High5Wave from "./wave";
+import { High5Webhook } from "./webhook";
+export declare class High5Space extends Base {
+    get event(): High5Event;
+    private _event?;
+    get execute(): High5SpaceExecute;
+    private _execute?;
+    get webhook(): High5Webhook;
+    private _webhook?;
+    get secret(): High5Secret;
+    private _secret?;
+    get wave(): High5Wave;
+    private _wave?;
+    get node(): High5Node;
+    private _node?;
+    /**
+     * Retrieves all High5 Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of High5 Spaces and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpaces({ orgName, filters, sorting, limit, page }: SearchParams & {
+        orgName: string;
+    }): Promise<PaginatedResponse<Space>>;
+    /**
+     * Retrieves permissions of a space matching the search filter(s). Will return all permissions of the space if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of High5 Space Permissions and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpacePermissions({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<SpaceEntityPermission>>;
+    /**
+     * Retrieves a High5 Space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceId ID of the High5 Space
+     * @returns The requested Space
+     */
+    getSpace(orgName: string, spaceName: string): Promise<Space>;
+    /**
+     * Creates a new High5 Space in the specified Organization.
+     * @param orgName Name of the Organization
+     * @param name Name for the new Space
+     * @returns The created Space
+     */
+    createSpace(orgName: string, name: string): Promise<Space>;
+    /**
+     * Delete a space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     */
+    deleteSpace(orgName: string, spaceName: string): Promise<void>;
+    /**
+     * Adds/Updates/Removes the permission a user has in the specified space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param userId ID of the User
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateUserSpacePermission(orgName: string, spaceName: string, userId: string, permission: SpacePermission): Promise<SpaceEntityPermission>;
+    /**
+     * Adds/Updates/Removes the permission a team has in the specified space. Note: A team cannot be an owner of a Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param teamName Name of the Team
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateTeamSpacePermission(orgName: string, spaceName: string, teamName: string, permission: SpacePermission): Promise<SpaceEntityPermission>;
+    /**
+     * Retrieves all streams of a space matching the search filter(s). Will return all streams if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param orgName Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of streams and the total number of results found in the database (independent of limit and page)
+     */
+    searchStreamsOfSpace({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<Stream>>;
+    /**
+     * Updates the name of a space.
+     * @param orgName Name of the organization
+     * @param newSpaceName Current name of the space
+     * @param newName New name for the space
+     * @returns The updated space
+     */
+    renameSpace(orgName: string, spaceName: string, newSpaceName: string): Promise<Space>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/index.js

@@ -0,0 +1,205 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5Space = void 0;
+const Base_1 = require("../../../Base");
+const paginatedResponseHelper_1 = require("../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../helper/searchFilter");
+const event_1 = require("./event");
+const execution_1 = require("./execution");
+const node_1 = require("./node");
+const secret_1 = require("./secret");
+const wave_1 = require("./wave");
+const webhook_1 = require("./webhook");
+class High5Space extends Base_1.default {
+    get event() {
+        if (this._event === undefined) {
+            this._event = new event_1.High5Event(this.options, this.axios);
+        }
+        return this._event;
+    }
+    get execute() {
+        if (this._execute === undefined) {
+            this._execute = new execution_1.High5SpaceExecute(this.options, this.axios);
+        }
+        return this._execute;
+    }
+    get webhook() {
+        if (this._webhook === undefined) {
+            this._webhook = new webhook_1.High5Webhook(this.options, this.axios);
+        }
+        return this._webhook;
+    }
+    get secret() {
+        if (this._secret === undefined) {
+            this._secret = new secret_1.default(this.options, this.axios);
+        }
+        return this._secret;
+    }
+    get wave() {
+        if (this._wave === undefined) {
+            this._wave = new wave_1.default(this.options, this.axios);
+        }
+        return this._wave;
+    }
+    get node() {
+        if (this._node === undefined) {
+            this._node = new node_1.default(this.options, this.axios);
+        }
+        return this._node;
+    }
+    /**
+     * Retrieves all High5 Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of High5 Spaces and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpaces(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, filters, sorting, limit = 25, page = 0 }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Retrieves permissions of a space matching the search filter(s). Will return all permissions of the space if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of High5 Space Permissions and the total number of results found in the database (independent of limit and page)
+     */
+    searchSpacePermissions(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Retrieves a High5 Space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceId ID of the High5 Space
+     * @returns The requested Space
+     */
+    getSpace(orgName, spaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Creates a new High5 Space in the specified Organization.
+     * @param orgName Name of the Organization
+     * @param name Name for the new Space
+     * @returns The created Space
+     */
+    createSpace(orgName, name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces`), { name: name });
+            return resp.data;
+        });
+    }
+    /**
+     * Delete a space by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     */
+    deleteSpace(orgName, spaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
+        });
+    }
+    /**
+     * Adds/Updates/Removes the permission a user has in the specified space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param userId ID of the User
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateUserSpacePermission(orgName, spaceName, userId, permission) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/user`), {
+                userId,
+                permission,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Adds/Updates/Removes the permission a team has in the specified space. Note: A team cannot be an owner of a Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param teamName Name of the Team
+     * @param permission New permission
+     * @returns The Space with updated permissions
+     */
+    updateTeamSpacePermission(orgName, spaceName, teamName, permission) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/permissions/team`), {
+                teamName,
+                permission,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Retrieves all streams of a space matching the search filter(s). Will return all streams if no search filter is provided.
+     * @param orgName Name of the organization
+     * @param orgName Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Object containing an array of streams and the total number of results found in the database (independent of limit and page)
+     */
+    searchStreamsOfSpace(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/streams/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Updates the name of a space.
+     * @param orgName Name of the organization
+     * @param newSpaceName Current name of the space
+     * @param newName New name for the space
+     * @returns The updated space
+     */
+    renameSpace(orgName, spaceName, newSpaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/name`), {
+                newSpaceName,
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Space = High5Space;

package/lib/service/high5/space/node/index.d.ts

@@ -0,0 +1,58 @@
+import Base from "../../../../Base";
+import { Node, NodeCategory } from "../../../../interfaces/high5/space/event/stream/node";
+export default class High5Node extends Base {
+    /**
+     * Retrieves all Nodes for the specified stream.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Array containg the Nodes
+     */
+    getAllNodes(orgName: string, spaceName: string, limit?: number, page?: number): Promise<Node[]>;
+    /**
+     * Retrieves a Node by its ID.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId Id of the Node
+     * @returns The requested Node
+     */
+    getNode(orgName: string, spaceName: string, nodeId: string): Promise<Node>;
+    /**
+     * Adds a new Node to a stream.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeCategory Category of the node
+     * @param specification Specification of the node as a base64 string
+     * @param typescript Typescript code as a base64 string
+     * @returns The created Node
+     */
+    createNode(orgName: string, spaceName: string, nodeCategory: NodeCategory, specification: string, typescript: string): Promise<Node>;
+    /**
+     * Deletes a Node by its ID
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId Id of the node
+     */
+    deleteNode(orgName: string, spaceName: string, nodeId: string): Promise<void>;
+    /**
+     * Patches the Typescript code and specification of the Node.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId ID of the node
+     * @param regenerateSecret Boolean to specify if a new secret shall be created
+     * @param specification (optional) Specification of the node as a base64 string
+     * @param typescript (optional) Typescript code as a base64 string
+     * @return The updated Node
+     */
+    patchNode(orgName: string, spaceName: string, nodeId: string, regenerateSecret: boolean, specification?: string, typescript?: string): Promise<Node>;
+    /**
+     * Retrieves the content (raw javascript code) of a Node.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param secret Secret of the Node (a unique sha512 hash)
+     * @rerurns Raw javascript representation of the Node's content
+     */
+    getNodeContent(orgName: string, spaceName: string, secret: string): Promise<string>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/node/index.js

@@ -0,0 +1,116 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Base_1 = require("../../../../Base");
+class High5Node extends Base_1.default {
+    /**
+     * Retrieves all Nodes for the specified stream.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param limit (optional) Max number of results (1-100; defaults to 25)
+     * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @returns Array containg the Nodes
+     */
+    getAllNodes(orgName, spaceName, limit, page) {
+        return __awaiter(this, void 0, void 0, function* () {
+            limit = limit || 25;
+            page = page || 0;
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes?page=${page}&limit=${limit}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Retrieves a Node by its ID.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId Id of the Node
+     * @returns The requested Node
+     */
+    getNode(orgName, spaceName, nodeId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes/${nodeId}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Adds a new Node to a stream.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeCategory Category of the node
+     * @param specification Specification of the node as a base64 string
+     * @param typescript Typescript code as a base64 string
+     * @returns The created Node
+     */
+    createNode(orgName, spaceName, nodeCategory, specification, typescript) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes`), {
+                category: nodeCategory,
+                specification: specification,
+                typescript: typescript,
+            });
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes a Node by its ID
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId Id of the node
+     */
+    deleteNode(orgName, spaceName, nodeId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes/${nodeId}`));
+        });
+    }
+    /**
+     * Patches the Typescript code and specification of the Node.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param nodeId ID of the node
+     * @param regenerateSecret Boolean to specify if a new secret shall be created
+     * @param specification (optional) Specification of the node as a base64 string
+     * @param typescript (optional) Typescript code as a base64 string
+     * @return The updated Node
+     */
+    patchNode(orgName, spaceName, nodeId, regenerateSecret, specification, typescript) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const patchNode = {
+                specification: specification,
+                typescript: typescript,
+            };
+            if (!specification) {
+                delete patchNode.specification;
+            }
+            if (!typescript) {
+                delete patchNode.typescript;
+            }
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes/${nodeId}?regenerateSecret=${regenerateSecret}`), patchNode);
+            return resp.data;
+        });
+    }
+    /**
+     * Retrieves the content (raw javascript code) of a Node.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param secret Secret of the Node (a unique sha512 hash)
+     * @rerurns Raw javascript representation of the Node's content
+     */
+    getNodeContent(orgName, spaceName, secret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/nodes/content/${secret}`));
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5Node;

package/lib/service/high5/space/secret/index.d.ts

@@ -0,0 +1,60 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { CreateSecret, Secret, UpdateSecret } from "../../../../interfaces/high5/space/secret";
+export default class High5Secret extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Requests all secret keys of the provided space which match the search filter(s) (paginated request).
+     * Only the keys of the secret are sent back in the response by default, not the actual encrypted values.
+     * Will return all secrets of the space if no filter is provided.
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param filters (optional) Array of search filters
+     * @param sorting (optional) Sorting object
+     * @param limit - (optional) Max number of results (1-100; defaults to 25)
+     * @param page - (optional) Page number: Skip the first (page * limit) results (defaults to 0)
+     * @param encrypted - (optional) Whether to get all secret values only in encrypted form.
+     * @returns Object containing an array of secret keys as well as the total number of results found in the database (independent of limit and page)
+     */
+    searchSecrets({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<Secret>>;
+    /**
+     * Adds a secret key-value pair to a space.
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @param value - Value of the key-value pair
+     * @param encrypted - (optional) Boolean defining if the value should be stored encrypted (defaults to false).
+     * @returns The created Secret
+     */
+    addSecret(orgName: string, spaceName: string, secret: CreateSecret): Promise<Secret>;
+    /**
+     * Updates the value for an existent secret key-value pair.
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @param value - The new value of the key-value pair
+     * @param encrypted - (optional) Boolean defining if the value should be stored encrypted (defaults to false).
+     * @returns The updated Secret
+     */
+    updateSecret(orgName: string, spaceName: string, key: string, secret: UpdateSecret): Promise<Secret>;
+    /**
+     * Deletes a key-value pair of the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     */
+    deleteSecret(orgName: string, spaceName: string, key: string): Promise<void>;
+    /**
+     * Get secret value by its key
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @returns Secret details
+     */
+    getSecret(orgName: string, spaceName: string, key: string): Promise<Secret>;
+    protected getEndpoint(endpoint: string): string;
+}