hcloud-sdk 0.0.16 → 14.13.2

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

@@ -0,0 +1,89 @@
+"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.High5Event = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const stream_1 = require("./stream");
+class High5Event extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves all Events of a High5 Space which match the provided search filter(s). Will return all Events 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)
+         * @returns Object containing an array of Events and the total number of results found in the database (independent of limit and page)
+         */
+        this.searchEvents = (_a) => __awaiter(this, [_a], 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}/events/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Retrieves an Event by its name.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param eventName Name of the Event
+         * @returns The requested Event
+         */
+        this.getEvent = (orgName, spaceName, eventName) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}`));
+            return resp.data;
+        });
+        /**
+         * Creates a new Event in the provided Space.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param name Name of the new Event
+         * @returns The created Event
+         */
+        this.createEvent = (orgName, spaceName, name) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events`), { name: name });
+            return resp.data;
+        });
+        /**
+         * Rename an event
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param eventName Name of the Event
+         * @param name New name of the Event
+         * @returns Updated Event
+         */
+        this.renameEvent = (orgName, spaceName, eventName, name) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/name`), {
+                name: name,
+            });
+            return resp.data;
+        });
+        /**
+         * Deletes an Event by its name.
+         * @param orgName Name of the Organization
+         * @param spaceName Name of the Space
+         * @param eventName Name of the Event
+         */
+        this.deleteEvent = (orgName, spaceName, eventName) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}`));
+        });
+        this.stream = new stream_1.High5Stream(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Event = High5Event;

package/lib/service/high5/space/event/stream/design/DesignOperations.d.ts

@@ -0,0 +1,31 @@
+import Base from "../../../../../../Base";
+import { Design } from "../../../../../../interfaces/high5";
+import { AddNode, DesignOperation, EditNode, LinkNodes, MoveNode } from "../../../../../../interfaces/high5/space/event/stream/design/DesignOperation";
+import { DesignerNode } from "../../../../../../interfaces/high5/space/event/stream/design/StreamDesign";
+export default class DesignOperations extends Base {
+    send(orgName: string, spaceName: string, eventName: string, streamId: string, designHash: string, operations: DesignOperation[]): Promise<Design>;
+    queue(): OperationQueue;
+    addNode(details: DesignerNode): OperationQueue;
+    deleteNode(uuid: string): OperationQueue;
+    moveNode(uuid: string, newCoords: MoveNode["newCoords"]): OperationQueue;
+    editNode(uuid: string, changes: EditNode["changes"]): OperationQueue;
+    linkNodes(details: LinkNodes["details"]): OperationQueue;
+    unlinkNodes(uuid: string): OperationQueue;
+    protected getEndpoint(endpoint: string): string;
+}
+declare class OperationQueue {
+    operations: DesignOperation[];
+    parent: DesignOperations;
+    constructor(parent: DesignOperations);
+    send(orgName: string, spaceName: string, eventName: string, streamId: string, designHash: string): Promise<Design>;
+    addNode(details: AddNode["details"]): this;
+    deleteNode(uuid: string): this;
+    moveNode(uuid: string, newCoords: {
+        x: number;
+        y: number;
+    }): this;
+    editNode(uuid: string, changes: EditNode["changes"]): this;
+    linkNodes(details: LinkNodes["details"]): this;
+    unlinkNodes(uuid: string): this;
+}
+export {};

package/lib/service/high5/space/event/stream/design/DesignOperations.js

@@ -0,0 +1,117 @@
+"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");
+const DesignOperation_1 = require("../../../../../../interfaces/high5/space/event/stream/design/DesignOperation");
+class DesignOperations extends Base_1.default {
+    send(orgName, spaceName, eventName, streamId, designHash, operations) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/operations`), { hash: designHash, operations });
+            return resp.data;
+        });
+    }
+    queue() {
+        return new OperationQueue(this);
+    }
+    addNode(details) {
+        const queue = new OperationQueue(this);
+        return queue.addNode(details);
+    }
+    deleteNode(uuid) {
+        const queue = new OperationQueue(this);
+        return queue.deleteNode(uuid);
+    }
+    moveNode(uuid, newCoords) {
+        const queue = new OperationQueue(this);
+        return queue.moveNode(uuid, newCoords);
+    }
+    editNode(uuid, changes) {
+        const queue = new OperationQueue(this);
+        return queue.editNode(uuid, changes);
+    }
+    linkNodes(details) {
+        const queue = new OperationQueue(this);
+        return queue.linkNodes(details);
+    }
+    unlinkNodes(uuid) {
+        const queue = new OperationQueue(this);
+        return queue.unlinkNodes(uuid);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = DesignOperations;
+class OperationQueue {
+    constructor(parent) {
+        this.operations = [];
+        this.parent = parent;
+    }
+    send(orgName, spaceName, eventName, streamId, designHash) {
+        return this.parent.send(orgName, spaceName, eventName, streamId, designHash, this.operations);
+    }
+    addNode(details) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.NODE,
+            type: DesignOperation_1.NodeOperation.ADD,
+            details,
+        };
+        this.operations.push(op);
+        return this;
+    }
+    deleteNode(uuid) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.NODE,
+            type: DesignOperation_1.NodeOperation.DELETE,
+            uuid,
+        };
+        this.operations.push(op);
+        return this;
+    }
+    moveNode(uuid, newCoords) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.NODE,
+            type: DesignOperation_1.NodeOperation.MOVE,
+            uuid,
+            newCoords,
+        };
+        this.operations.push(op);
+        return this;
+    }
+    editNode(uuid, changes) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.NODE,
+            type: DesignOperation_1.NodeOperation.EDIT,
+            uuid,
+            changes,
+        };
+        this.operations.push(op);
+        return this;
+    }
+    linkNodes(details) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.LINK,
+            type: DesignOperation_1.LinkOperation.LINK,
+            details,
+        };
+        this.operations.push(op);
+        return this;
+    }
+    unlinkNodes(uuid) {
+        const op = {
+            target: DesignOperation_1.OperationTarget.LINK,
+            type: DesignOperation_1.LinkOperation.UNLINK,
+            uuid,
+        };
+        this.operations.push(op);
+        return this;
+    }
+}

package/lib/service/high5/space/event/stream/design/index.d.ts

@@ -0,0 +1,38 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../../../Base";
+import { Design } from "../../../../../../interfaces/high5/space/event/stream/design";
+import { DesignContent } from "../../../../../../interfaces/high5/space/event/stream/design/StreamDesign";
+import DesignOperations from "./DesignOperations";
+import High5DesignSnapshots from "./snapshot";
+export declare class High5Design extends Base {
+    /**
+     * API to manage design snapshots
+     */
+    snapshots: High5DesignSnapshots;
+    /**
+     * API to perform operations on the Stream Design
+     */
+    operations: DesignOperations;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Retrieves a stream's design.
+     * @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 design
+     */
+    getDesign: (orgName: string, spaceName: string, eventName: string, streamId: string) => Promise<Design>;
+    /**
+     * Creates/overwrites a new design for the specified 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 content Design as Json payload (schema created by Stream Designer Studio)
+     * @param build Rendered design as Json payload (schema created by Stream Designer Studio; ready to be executed by wave engine)
+     * @returns The created design
+     */
+    createDesign: (orgName: string, spaceName: string, eventName: string, streamId: string, name: string, content: DesignContent, build?: unknown) => Promise<Design>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,56 @@
+"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.High5Design = void 0;
+const Base_1 = require("../../../../../../Base");
+const DesignOperations_1 = require("./DesignOperations");
+const snapshot_1 = require("./snapshot");
+class High5Design extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        /**
+         * Retrieves a stream's design.
+         * @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 design
+         */
+        this.getDesign = (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}/design`));
+            return resp.data;
+        });
+        /**
+         * Creates/overwrites a new design for the specified 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 content Design as Json payload (schema created by Stream Designer Studio)
+         * @param build Rendered design as Json payload (schema created by Stream Designer Studio; ready to be executed by wave engine)
+         * @returns The created design
+         */
+        this.createDesign = (orgName, spaceName, eventName, streamId, name, content, build) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design`), {
+                name,
+                content,
+                build,
+            });
+            return resp.data;
+        });
+        this.operations = new DesignOperations_1.default(options, axios);
+        this.snapshots = new snapshot_1.default(options, axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Design = High5Design;

package/lib/service/high5/space/event/stream/design/snapshot/index.d.ts

@@ -0,0 +1,62 @@
+import Base from "../../../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../../../interfaces/global";
+import DesignSnapshot from "../../../../../../../interfaces/high5/space/event/stream/design/snapshot";
+export default class High5DesignSnapshots extends Base {
+    /**
+     * Search the snapshots of stream's design.
+     * @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 content (optional) Is it necessary to retrieve content for each snapshot (disabled by default)
+     * @param filters Search filters to apply
+     * @param sorting Sorting criteria for the result
+     * @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 snapshots of the stream design and the total number of results found in the database (independent of limit and page)
+     */
+    search: (orgName: string, spaceName: string, eventName: string, streamId: string, content: boolean | undefined, { filters, sorting, limit, page }: SearchParams) => Promise<PaginatedResponse<DesignSnapshot>>;
+    /**
+     * Create a snapshot of stream's design.
+     * @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 Name of the snapshot
+     * @returns The snapshot
+     */
+    create: (orgName: string, spaceName: string, eventName: string, streamId: string, name: string) => Promise<DesignSnapshot>;
+    /**
+     * Update a snapshot's name.
+     * @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 snapshotId ID of the snapshot
+     * @param name Name of the snapshot
+     * @returns The snapshot
+     */
+    update: (orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string, name: string) => Promise<DesignSnapshot>;
+    /**
+     * Delete a stream design's snapshot.
+     * @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 snapshotId ID of the snapshot
+     */
+    delete: (orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string) => Promise<void>;
+    /**
+     * Restore a stream's design to a certain snapshot.
+     *
+     * **WARNING**: This is a destructive action. It will overwrite the current design for the 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 snapshotId ID of the snapshot
+     */
+    restore: (orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,100 @@
+"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");
+const paginatedResponseHelper_1 = require("../../../../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../../../../helper/searchFilter");
+class High5DesignSnapshots extends Base_1.default {
+    constructor() {
+        super(...arguments);
+        /**
+         * Search the snapshots of stream's design.
+         * @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 content (optional) Is it necessary to retrieve content for each snapshot (disabled by default)
+         * @param filters Search filters to apply
+         * @param sorting Sorting criteria for the result
+         * @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 snapshots of the stream design and the total number of results found in the database (independent of limit and page)
+         */
+        this.search = (orgName_1, spaceName_1, eventName_1, streamId_1, ...args_1) => __awaiter(this, [orgName_1, spaceName_1, eventName_1, streamId_1, ...args_1], void 0, function* (orgName, spaceName, eventName, streamId, content = false, { filters, sorting, limit = 25, page = 0 }) {
+            const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => {
+                return new searchFilter_1.SearchFilterDTO(f);
+            });
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/snapshots/search`), {
+                filters: filtersDTO,
+                sorting,
+            }, {
+                params: { content, limit, page },
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+        /**
+         * Create a snapshot of stream's design.
+         * @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 Name of the snapshot
+         * @returns The snapshot
+         */
+        this.create = (orgName, spaceName, eventName, streamId, name) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/snapshots`), { name });
+            return resp.data;
+        });
+        /**
+         * Update a snapshot's name.
+         * @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 snapshotId ID of the snapshot
+         * @param name Name of the snapshot
+         * @returns The snapshot
+         */
+        this.update = (orgName, spaceName, eventName, streamId, snapshotId, 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}/design/snapshots/${snapshotId}`), { name });
+            return resp.data;
+        });
+        /**
+         * Delete a stream design's snapshot.
+         * @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 snapshotId ID of the snapshot
+         */
+        this.delete = (orgName, spaceName, eventName, streamId, snapshotId) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/snapshots/${snapshotId}`));
+        });
+        /**
+         * Restore a stream's design to a certain snapshot.
+         *
+         * **WARNING**: This is a destructive action. It will overwrite the current design for the 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 snapshotId ID of the snapshot
+         */
+        this.restore = (orgName, spaceName, eventName, streamId, snapshotId) => __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/snapshots/${snapshotId}/restore`));
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5DesignSnapshots;

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

@@ -0,0 +1,114 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
+import { SingleStreamPatchOrder, Stream, StreamPatchActive, StreamPatchOrder } from "../../../../../interfaces/high5/space/event/stream";
+import { High5Design } from "./design";
+export declare class High5Stream extends Base {
+    design: High5Design;
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * 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)
+     */
+    searchStreams: ({ orgName, spaceName, eventName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+        eventName: string;
+    }) => Promise<PaginatedResponse<Stream>>;
+    /**
+     * 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
+     */
+    getStream: (orgName: string, spaceName: string, eventName: string, streamId: string) => Promise<Stream>;
+    /**
+     * 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
+     */
+    createStream: (orgName: string, spaceName: string, eventName: string, name: string) => Promise<Stream>;
+    /**
+     * 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
+     */
+    duplicateStream: (orgName: string, spaceName: string, eventName: string, name: string, sourceStreamId: string) => Promise<Stream>;
+    /**
+     * 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
+     */
+    patchStreamOrderMulti: (orgName: string, spaceName: string, eventName: string, streamList: StreamPatchOrder[]) => Promise<Stream[]>;
+    /**
+     * 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
+     */
+    patchStreamState: (orgName: string, spaceName: string, eventName: string, streamId: string, streamPatchActive: StreamPatchActive) => Promise<Stream>;
+    /**
+     * 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
+     */
+    patchStreamOrder: (orgName: string, spaceName: string, eventName: string, streamId: string, singleStreamPatchOrder: SingleStreamPatchOrder) => Promise<Stream[]>;
+    /**
+     * 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
+     */
+    renameStream: (orgName: string, spaceName: string, eventName: string, streamId: string, name: string) => Promise<Stream>;
+    /**
+     * 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
+     */
+    moveStream: (orgName: string, spaceName: string, eventName: string, streamId: string, newEventName: string, name?: string, order?: number) => Promise<Stream>;
+    /**
+     * 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
+     */
+    deleteStream: (orgName: string, spaceName: string, eventName: string, streamId: string) => Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}