hcloud-sdk 14.13.2 → 16.0.0

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

@@ -14,58 +14,112 @@ 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);
+    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, debug = false) {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/stream/id/${streamId}`), high5ExecutionRequest, {
+                params: {
+                    design,
+                    debug,
+                },
+            });
             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* () {
+    }
+    /**
+     * 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
-         */
-        this.getStreamExecutionPackage = (orgName, spaceName, streamId, secret) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * 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
-         */
-        this.high5ExecutionStatusAndLogResponse = (orgName, spaceName, secret, high5ExecutionResponse) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * 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);
         });
-        this.high5ExecutionLogs = new index_1.High5SpaceExecutionLogs(options, axios);
-        this.high5ExecutionStates = new index_2.High5SpaceExecutionStates(options, axios);
+    }
+    /**
+     * Issue debug command to a stopped execution running in debug mode.
+     * If the agent that is handling this execution does not acknowledge
+     * the debug command after a certain timeframe, a timeout error will
+     * be thrown.
+     *
+     * Only the user that triggered the execution can send debug commands.
+     *
+     * @param orgName      Name of the organization
+     * @param spaceName    Name of the space
+     * @param executionId  ID of the execution. Obtained from High5ExecutionResponse
+     * @param command      DebugCommand to send
+     */
+    issueDebugCommand(orgName, spaceName, executionId, command) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execute/${executionId}`), command);
+        });
+    }
+    /**
+     * Log an execution crash to High5
+     *
+     * Useful when regular logging is not possible.
+     *
+     * @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 message    crash log
+     */
+    logExecutionCrash(orgName, spaceName, secret, message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/${secret}/crash`), { message });
+        });
     }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/high5${endpoint}`;

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

@@ -1,9 +1,7 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../../Base";
+import Base 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
@@ -14,11 +12,11 @@ export declare class High5SpaceExecutionLogs extends Base {
      * @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 & {
+    searchExecutionLogs({ orgName, spaceName, payload, filters, sorting, limit, page, }: SearchParams & {
         orgName: string;
         spaceName: string;
         payload?: boolean;
-    }) => Promise<PaginatedResponse<High5ExecutionLog>>;
+    }): Promise<PaginatedResponse<High5ExecutionLog>>;
     /**
      * Retrieves the execution log of a stream.
      * @param orgName Name of the Organization
@@ -26,6 +24,6 @@ export declare class High5SpaceExecutionLogs extends Base {
      * @param streamLogId ID of the stream log
      * @returns Stream execution log
      */
-    getStreamExecutionLog: (orgName: string, spaceName: string, streamLogId: string, payload?: boolean) => Promise<High5ExecutionLog>;
+    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

@@ -14,19 +14,18 @@ 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, }) {
+    /**
+     * 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,
@@ -34,14 +33,16 @@ class High5SpaceExecutionLogs extends Base_1.default {
             });
             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) {
+    }
+    /**
+     * 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) => {

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

@@ -11,6 +11,6 @@ export declare class High5SpaceExecutionStates extends Base {
      * @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>>;
+    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

@@ -15,14 +15,16 @@ const paginatedResponseHelper_1 = require("../../../../../helper/paginatedRespon
 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) {
+    }
+    /**
+     * Retrieves all stream execution logs for a given stream.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param streamStatusId ID of the stream status
+     * @returns Object containing an array of Stream execution logs as well as the total number of results
+     */
+    getStreamExecutionStatus(orgName_1, spaceName_1, streamStatusId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, streamStatusId, limit = 25, page = 0) {
             const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/execution/streams/status/${streamStatusId}?page=${page}&limit=${limit}`));
             return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
         });

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

@@ -1,22 +1,29 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../Base";
+import Base from "../../../Base";
 import { PaginatedResponse, SearchParams } from "../../../interfaces/global";
 import { Stream } from "../../../interfaces/high5";
 import { High5Space as Space, High5SpaceEntityPermission as SpaceEntityPermission, High5SpacePermission as SpacePermission } from "../../../interfaces/high5/space";
 import { High5Event } from "./event";
 import { High5SpaceExecute } from "./execution";
 import High5Node from "./node";
+import High5Pool from "./pool";
 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);
+    get event(): High5Event;
+    private _event?;
+    get execute(): High5SpaceExecute;
+    private _execute?;
+    get webhook(): High5Webhook;
+    private _webhook?;
+    get secret(): High5Secret;
+    private _secret?;
+    get pool(): High5Pool;
+    private _pool?;
+    get wave(): High5Wave;
+    private _wave?;
+    get node(): High5Node;
+    private _node?;
     /**
      * Retrieves all High5 Spaces of the specified Organization matching the search filter(s). Will return all Spaces if no search filter is provided.
      * @param orgName Name of the organization
@@ -26,9 +33,9 @@ export declare class High5Space extends Base {
      * @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 & {
+    searchSpaces({ orgName, filters, sorting, limit, page }: SearchParams & {
         orgName: string;
-    }) => Promise<PaginatedResponse<Space>>;
+    }): 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
@@ -39,30 +46,30 @@ export declare class High5Space extends Base {
      * @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 & {
+    searchSpacePermissions({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
         orgName: string;
         spaceName: string;
-    }) => Promise<PaginatedResponse<SpaceEntityPermission>>;
+    }): 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>;
+    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>;
+    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>;
+    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
@@ -71,7 +78,7 @@ export declare class High5Space extends Base {
      * @param permission New permission
      * @returns The Space with updated permissions
      */
-    updateUserSpacePermission: (orgName: string, spaceName: string, userId: string, permission: SpacePermission) => Promise<SpaceEntityPermission>;
+    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
@@ -80,7 +87,7 @@ export declare class High5Space extends Base {
      * @param permission New permission
      * @returns The Space with updated permissions
      */
-    updateTeamSpacePermission: (orgName: string, spaceName: string, teamName: string, permission: SpacePermission) => Promise<SpaceEntityPermission>;
+    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
@@ -91,10 +98,10 @@ export declare class High5Space extends Base {
      * @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 & {
+    searchStreamsOfSpace({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
         orgName: string;
         spaceName: string;
-    }) => Promise<PaginatedResponse<Stream>>;
+    }): Promise<PaginatedResponse<Stream>>;
     /**
      * Updates the name of a space.
      * @param orgName Name of the organization
@@ -102,6 +109,6 @@ export declare class High5Space extends Base {
      * @param newName New name for the space
      * @returns The updated space
      */
-    renameSpace: (orgName: string, spaceName: string, newSpaceName: string) => Promise<Space>;
+    renameSpace(orgName: string, spaceName: string, newSpaceName: string): Promise<Space>;
     protected getEndpoint(endpoint: string): string;
 }