hcloud-sdk 0.0.16 → 15.0.0

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

@@ -0,0 +1,107 @@
+"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 {
+    /**
+     * 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_1, spaceName_1, eventName_1, streamId_1) {
+        return __awaiter(this, arguments, 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
+     */
+    create(orgName, spaceName, eventName, streamId, name) {
+        return __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
+     */
+    update(orgName, spaceName, eventName, streamId, snapshotId, name) {
+        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/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
+     */
+    delete(orgName, spaceName, eventName, streamId, snapshotId) {
+        return __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
+     */
+    restore(orgName, spaceName, eventName, streamId, snapshotId) {
+        return __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,113 @@
+import Base 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 {
+    get design(): High5Design;
+    private _design?;
+    /**
+     * 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;
+}

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

@@ -0,0 +1,186 @@
+"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 {
+    get design() {
+        if (this._design === undefined) {
+            this._design = new design_1.High5Design(this.options, this.axios);
+        }
+        return this._design;
+    }
+    /**
+     * 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(_a) {
+        return __awaiter(this, arguments, 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
+     */
+    getStream(orgName, spaceName, eventName, streamId) {
+        return __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
+     */
+    createStream(orgName, spaceName, eventName, name) {
+        return __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
+     */
+    duplicateStream(orgName, spaceName, eventName, name, sourceStreamId) {
+        return __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
+     */
+    patchStreamOrderMulti(orgName, spaceName, eventName, streamList) {
+        return __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
+     */
+    patchStreamState(orgName, spaceName, eventName, streamId, streamPatchActive) {
+        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}/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
+     */
+    patchStreamOrder(orgName, spaceName, eventName, streamId, singleStreamPatchOrder) {
+        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}/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
+     */
+    renameStream(orgName, spaceName, eventName, streamId, name) {
+        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}/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
+     */
+    moveStream(orgName, spaceName, eventName, streamId, newEventName, name, order) {
+        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}/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
+     */
+    deleteStream(orgName, spaceName, eventName, streamId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}`));
+        });
+    }
+    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 Base 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 {
+    get high5ExecutionLogs(): High5SpaceExecutionLogs;
+    private _high5ExecutionLogs?;
+    get high5ExecutionStates(): High5SpaceExecutionStates;
+    private _high5ExecutionStates?;
+    /**
+     * 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, design?: boolean): 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,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.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 {
+    get high5ExecutionLogs() {
+        if (this._high5ExecutionLogs === undefined) {
+            this._high5ExecutionLogs = new index_1.High5SpaceExecutionLogs(this.options, this.axios);
+        }
+        return this._high5ExecutionLogs;
+    }
+    get high5ExecutionStates() {
+        if (this._high5ExecutionStates === undefined) {
+            this._high5ExecutionStates = new index_2.High5SpaceExecutionStates(this.options, this.axios);
+        }
+        return this._high5ExecutionStates;
+    }
+    /**
+     * 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_1, spaceName_1, streamId_1, high5ExecutionRequest_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, streamId, high5ExecutionRequest, design = false) {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/stream/id/${streamId}${design ? "&design=true" : ""}`), 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
+     */
+    executeHigh5Event(orgName, spaceName, eventName, high5EventExecutionRequest) {
+        return __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
+     */
+    getStreamExecutionPackage(orgName, spaceName, streamId, secret) {
+        return __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
+     */
+    high5ExecutionStatusAndLogResponse(orgName, spaceName, secret, high5ExecutionResponse) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/${secret}`), high5ExecutionResponse);
+        });
+    }
+    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,29 @@
+import Base from "../../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../../interfaces/global";
+import { High5ExecutionLog } from "../../../../../interfaces/high5/space/execution";
+export declare class High5SpaceExecutionLogs extends Base {
+    /**
+     * 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,58 @@
+"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 {
+    /**
+     * 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(_a) {
+        return __awaiter(this, arguments, 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
+     */
+    getStreamExecutionLog(orgName_1, spaceName_1, streamLogId_1) {
+        return __awaiter(this, arguments, 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;
+}