hcloud-sdk 0.0.15 → 14.13.2

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

@@ -0,0 +1,164 @@
+"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.High5Stream = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../helper/searchFilter");
+const design_1 = require("./design");
+class High5Stream extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all Streams of an Event which match the provided search filter(s). Will return all Streams if no filter is provided.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @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 as well as the total number of results found in the database (independent of limit and page)
+         */
+        this.searchStreams = (_a) => __awaiter(this, [_a], void 0, function* ({ orgName, spaceName, eventName, 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}/events/${eventName}/streams/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Retrieves a Stream by its ID.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         * @returns The requested stream
+         */
+        this.getStream = (orgName, spaceName, eventName, streamId) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}`));
+            return resp.data;
+        });
+        /**
+         * Creates a new Stream for the specified Event.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param name Name for the new stream
+         * @returns The created stream
+         */
+        this.createStream = (orgName, spaceName, eventName, name) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams`), {
+                name: name,
+            });
+            return resp.data;
+        });
+        /**
+         * Duplicate a Stream for the specified Event.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param name Name for the new stream
+         * @param sourceStreamId ID for the stream to duplicate
+         * @returns The created stream
+         */
+        this.duplicateStream = (orgName, spaceName, eventName, name, sourceStreamId) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams`), {
+                name: name,
+                streamId: sourceStreamId,
+            });
+            return resp.data;
+        });
+        /**
+         * Patches the order of Streams for an Event.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param StreamPatchOrder List of all event streams with their new order
+         * @returns Array of updated Streams
+         */
+        this.patchStreamOrderMulti = (orgName, spaceName, eventName, streamList) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/order`), streamList);
+            return resp.data;
+        });
+        /**
+         * Activate or deactivate a stream
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         * @param StreamPatchActive Object defining if stream should be active or inactive
+         * @returns Details of the updated stream
+         */
+        this.patchStreamState = (orgName, spaceName, eventName, streamId, streamPatchActive) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/active`), streamPatchActive);
+            return resp.data;
+        });
+        /**
+         * Moves a Stream up or down in the existing Streams order.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         * @param SingleStreamPatchOrder Object defining if stream should move up or down
+         * @returns Array of updated Streams
+         */
+        this.patchStreamOrder = (orgName, spaceName, eventName, streamId, singleStreamPatchOrder) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/order`), singleStreamPatchOrder);
+            return resp.data;
+        });
+        /**
+         * Rename a stream
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         * @param name New name of the stream
+         * @returns Updated stream
+         */
+        this.renameStream = (orgName, spaceName, eventName, streamId, name) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/name`), { name });
+            return resp.data;
+        });
+        /**
+         * Moves a Stream to another event.
+         *
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         * @param newEventName Name of the new event
+         * @param [name] (optional) New name for stream. Is the new event already has a stream with the same name as this one, this parameter is mandatory.
+         * @param [order] (optional) Order the stream should have in the new event
+         * @returns Updated Stream
+         */
+        this.moveStream = (orgName, spaceName, eventName, streamId, newEventName, name, order) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/event`), { eventName: newEventName, name, order });
+            return resp.data;
+        });
+        /**
+         * Deletes a Stream by its ID.
+         * @param orgName Name of the organization
+         * @param spaceName Name of the space
+         * @param eventName Name of the event
+         * @param streamId ID of the stream
+         */
+        this.deleteStream = (orgName, spaceName, eventName, streamId) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}`));
+        });
+        this.design = new design_1.High5Design(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Stream = High5Stream;

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

@@ -0,0 +1,48 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { High5ExecutionPackage, High5ExecutionPatch, High5ExecutionRequest, High5ExecutionResponse } from "../../../../interfaces/high5/space/execution";
+import { High5SpaceExecutionLogs } from "./log/index";
+import { High5SpaceExecutionStates } from "./status/index";
+export declare class High5SpaceExecute extends Base {
+    high5ExecutionLogs: High5SpaceExecutionLogs;
+    high5ExecutionStates: High5SpaceExecutionStates;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * executeStream executes a single stream by its ID and an execution request
+     * @param orgName the organizations's name
+     * @param spaceName the spaces's name
+     * @param streamId to identify the stream
+     * @param high5ExecutionRequest the stream execution request, containing the data, target, wait boolean and timeout
+     * @returns the stream result
+     */
+    executeHigh5Stream: (orgName: string, spaceName: string, streamId: string, high5ExecutionRequest: High5ExecutionRequest) => Promise<High5ExecutionResponse>;
+    /**
+     * Executes all streams within an event.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param eventName Name of the Event
+     * @param eventExecutionRequest Event execution request containing payload, target and a boolean specifying if it should be a dry run
+     * @returns Array of stream results
+     */
+    executeHigh5Event: (orgName: string, spaceName: string, eventName: string, high5EventExecutionRequest: High5ExecutionRequest) => Promise<High5ExecutionResponse[]>;
+    /**
+     * Requests the StreamExecutionPackage for the provided Stream, which will hold all informations required to execute the Stream.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param streamId ID of the Stream
+     * @param secret Secret of the Stream execution object
+     * @returns StreamExecutionPackage
+     */
+    getStreamExecutionPackage: (orgName: string, spaceName: string, streamId: string, secret: string) => Promise<High5ExecutionPackage>;
+    /**
+     * Publishes the stream status and logs to high5
+     * @param orgName the organizations's name
+     * @param spaceName the spaces's name
+     * @param streamId the id of the stream
+     * @param secret the secret of the stream execution object
+     * @param streamResult the result of the stream
+     * @returns StreamLog
+     */
+    high5ExecutionStatusAndLogResponse: (orgName: string, spaceName: string, secret: string, high5ExecutionResponse: High5ExecutionPatch) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,74 @@
+"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.High5SpaceExecute = void 0;
+const Base_1 = require("../../../../Base");
+const index_1 = require("./log/index");
+const index_2 = require("./status/index");
+class High5SpaceExecute extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * executeStream executes a single stream by its ID and an execution request
+         * @param orgName the organizations's name
+         * @param spaceName the spaces's name
+         * @param streamId to identify the stream
+         * @param high5ExecutionRequest the stream execution request, containing the data, target, wait boolean and timeout
+         * @returns the stream result
+         */
+        this.executeHigh5Stream = (orgName, spaceName, streamId, high5ExecutionRequest) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/stream/id/${streamId}`), high5ExecutionRequest);
+            return resp.data;
+        });
+        /**
+         * Executes all streams within an event.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param eventName Name of the Event
+         * @param eventExecutionRequest Event execution request containing payload, target and a boolean specifying if it should be a dry run
+         * @returns Array of stream results
+         */
+        this.executeHigh5Event = (orgName, spaceName, eventName, high5EventExecutionRequest) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/event/name/${eventName}`), high5EventExecutionRequest);
+            return resp.data;
+        });
+        /**
+         * Requests the StreamExecutionPackage for the provided Stream, which will hold all informations required to execute the Stream.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param streamId ID of the Stream
+         * @param secret Secret of the Stream execution object
+         * @returns StreamExecutionPackage
+         */
+        this.getStreamExecutionPackage = (orgName, spaceName, streamId, secret) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/stream/id/${streamId}/package/${secret}`));
+            return resp.data;
+        });
+        /**
+         * Publishes the stream status and logs to high5
+         * @param orgName the organizations's name
+         * @param spaceName the spaces's name
+         * @param streamId the id of the stream
+         * @param secret the secret of the stream execution object
+         * @param streamResult the result of the stream
+         * @returns StreamLog
+         */
+        this.high5ExecutionStatusAndLogResponse = (orgName, spaceName, secret, high5ExecutionResponse) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/${secret}`), high5ExecutionResponse);
+        });
+        this.high5ExecutionLogs = new index_1.High5SpaceExecutionLogs(options, axios);
+        this.high5ExecutionStates = new index_2.High5SpaceExecutionStates(options, axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5SpaceExecute = High5SpaceExecute;

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

@@ -0,0 +1,31 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
+import { High5ExecutionLog } from "../../../../../interfaces/high5/space/execution";
+export declare class High5SpaceExecutionLogs extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Retrieves all stream execution logs for a given execution inside a space.
+     * @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 Stream execution logs as well as the total number of results
+     */
+    searchExecutionLogs: ({ orgName, spaceName, payload, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        payload?: boolean;
+    }) => Promise<PaginatedResponse<High5ExecutionLog>>;
+    /**
+     * Retrieves the execution log of a stream.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param streamLogId ID of the stream log
+     * @returns Stream execution log
+     */
+    getStreamExecutionLog: (orgName: string, spaceName: string, streamLogId: string, payload?: boolean) => Promise<High5ExecutionLog>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,57 @@
+"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.High5SpaceExecutionLogs = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../helper/searchFilter");
+class High5SpaceExecutionLogs extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all stream execution logs for a given execution inside a space.
+         * @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 Stream execution logs as well as the total number of results
+         */
+        this.searchExecutionLogs = (_a) => __awaiter(this, [_a], void 0, function* ({ orgName, spaceName, payload = false, 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}/execution/logs/search?page=${page}&limit=${limit}&payload=${payload}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Retrieves the execution log of a stream.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param streamLogId ID of the stream log
+         * @returns Stream execution log
+         */
+        this.getStreamExecutionLog = (orgName_1, spaceName_1, streamLogId_1, ...args_1) => __awaiter(this, [orgName_1, spaceName_1, streamLogId_1, ...args_1], void 0, function* (orgName, spaceName, streamLogId, payload = false) {
+            const resp = yield this.axios
+                .get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/logs/${streamLogId}?payload=${payload}`))
+                .catch((err) => {
+                throw err;
+            });
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5SpaceExecutionLogs = High5SpaceExecutionLogs;

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

@@ -0,0 +1,16 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../../Base";
+import { PaginatedResponse } from "../../../../../interfaces/global";
+import { High5ExecutionStatus } from "../../../../../interfaces/high5/space/execution";
+export declare class High5SpaceExecutionStates extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * 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: string, spaceName: string, streamStatusId: string, limit?: number, page?: number) => Promise<PaginatedResponse<High5ExecutionStatus>>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,34 @@
+"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
+         */
+        this.getStreamExecutionStatus = (orgName_1, spaceName_1, streamStatusId_1, ...args_1) => __awaiter(this, [orgName_1, spaceName_1, streamStatusId_1, ...args_1], 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,107 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } 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 {
+    event: High5Event;
+    execute: High5SpaceExecute;
+    webhook: High5Webhook;
+    secret: High5Secret;
+    wave: High5Wave;
+    node: High5Node;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * 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;
+}