hcloud-sdk 14.13.2 → 16.0.0

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

@@ -15,44 +15,52 @@ const paginatedResponseHelper_1 = require("../../../helper/paginatedResponseHelp
 class High5JoinToken extends Base_1.default {
     constructor(options, axios) {
         super(options, axios);
-        /**
-         * Retrieves join tokens of the specified organization (paginated request)
-         * @param orgName Name of the Organization
-         * @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 join tokens and the total number of results found in the database (independent of limit and page)
-         */
-        this.get = (orgName, limit, page) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Retrieves join tokens of the specified organization (paginated request)
+     * @param orgName Name of the Organization
+     * @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 join tokens and the total number of results found in the database (independent of limit and page)
+     */
+    get(orgName, limit, page) {
+        return __awaiter(this, void 0, void 0, function* () {
             limit = limit || 25;
             page = page || 0;
             const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/join/token?page=${page}&limit=${limit}`));
             return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
         });
-        /**
-         * Creates a join token for the specified organization
-         * @param orgName Name of the Organization
-         * @param name Name of the Join Token
-         * @returns Created join token
-         */
-        this.create = (orgName, name) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Creates a join token for the specified organization
+     * @param orgName Name of the Organization
+     * @param name Name of the Join Token
+     * @returns Created join token
+     */
+    create(orgName, name) {
+        return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/join/token`), { name });
             return resp.data;
         });
-        /**
-         * Revokes a join token of the specified organization
-         * @param orgName Name of the Organization
-         * @param tokenId ID of the Join Token
-         */
-        this.revoke = (orgName, tokenId) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Revokes a join token of the specified organization
+     * @param orgName Name of the Organization
+     * @param tokenId ID of the Join Token
+     */
+    revoke(orgName, tokenId) {
+        return __awaiter(this, void 0, void 0, function* () {
             yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/join/token/${tokenId}`));
         });
-        /**
-         * Exchanges a join token for an agent user
-         *
-         * @param joinToken Join token
-         * @returns An object containing the User object and the PAT that represents the agent user
-         */
-        this.exchange = (joinToken) => __awaiter(this, void 0, void 0, function* () {
+    }
+    /**
+     * Exchanges a join token for an agent user
+     *
+     * @param joinToken Join token
+     * @returns An object containing the User object and the PAT that represents the agent user
+     */
+    exchange(joinToken) {
+        return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.axios.post(this.getEndpoint(`/v1/join/token`), {}, { headers: { Authorization: joinToken } });
             return { user: res.data, pat: res.headers.authorization };
         });

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

@@ -1,11 +1,10 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../Base";
+import Base from "../../../../Base";
 import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
 import { Event } from "../../../../interfaces/high5/space/event";
 import { High5Stream } from "./stream";
 export declare class High5Event extends Base {
-    stream: High5Stream;
-    constructor(options: Options, axios: AxiosInstance);
+    get stream(): High5Stream;
+    private _stream?;
     /**
      * 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
@@ -16,10 +15,10 @@ export declare class High5Event extends Base {
      * @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)
      */
-    searchEvents: ({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+    searchEvents({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
         orgName: string;
         spaceName: string;
-    }) => Promise<PaginatedResponse<Event>>;
+    }): Promise<PaginatedResponse<Event>>;
     /**
      * Retrieves an Event by its name.
      * @param orgName Name of the Organization
@@ -27,7 +26,7 @@ export declare class High5Event extends Base {
      * @param eventName Name of the Event
      * @returns The requested Event
      */
-    getEvent: (orgName: string, spaceName: string, eventName: string) => Promise<Event>;
+    getEvent(orgName: string, spaceName: string, eventName: string): Promise<Event>;
     /**
      * Creates a new Event in the provided Space.
      * @param orgName Name of the Organization
@@ -35,7 +34,7 @@ export declare class High5Event extends Base {
      * @param name Name of the new Event
      * @returns The created Event
      */
-    createEvent: (orgName: string, spaceName: string, name: string) => Promise<Event>;
+    createEvent(orgName: string, spaceName: string, name: string): Promise<Event>;
     /**
      * Rename an event
      * @param orgName Name of the Organization
@@ -44,13 +43,13 @@ export declare class High5Event extends Base {
      * @param name New name of the Event
      * @returns Updated Event
      */
-    renameEvent: (orgName: string, spaceName: string, eventName: string, name: string) => Promise<Event>;
+    renameEvent(orgName: string, spaceName: string, eventName: string, name: string): Promise<Event>;
     /**
      * Deletes an Event by its name.
      * @param orgName Name of the Organization
      * @param spaceName Name of the Space
      * @param eventName Name of the Event
      */
-    deleteEvent: (orgName: string, spaceName: string, eventName: string) => Promise<void>;
+    deleteEvent(orgName: string, spaceName: string, eventName: string): Promise<void>;
     protected getEndpoint(endpoint: string): string;
 }

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

@@ -15,19 +15,24 @@ const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseH
 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, }) {
+    get stream() {
+        if (this._stream === undefined) {
+            this._stream = new stream_1.High5Stream(this.options, this.axios);
+        }
+        return this._stream;
+    }
+    /**
+     * 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)
+     */
+    searchEvents(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0, }) {
             const filtersDTO = filters === null || filters === void 0 ? void 0 : filters.map((f) => new searchFilter_1.SearchFilterDTO(f));
             const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/search?page=${page}&limit=${limit}`), {
                 filters: filtersDTO,
@@ -35,52 +40,59 @@ class High5Event extends Base_1.default {
             });
             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* () {
+    }
+    /**
+     * 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
+     */
+    getEvent(orgName, spaceName, eventName) {
+        return __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* () {
+    }
+    /**
+     * 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
+     */
+    createEvent(orgName, spaceName, name) {
+        return __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* () {
+    }
+    /**
+     * 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
+     */
+    renameEvent(orgName, spaceName, eventName, name) {
+        return __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* () {
+    }
+    /**
+     * Deletes an Event by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param eventName Name of the Event
+     */
+    deleteEvent(orgName, spaceName, eventName) {
+        return __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}`;

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

@@ -13,7 +13,7 @@ export default class DesignOperations extends Base {
     unlinkNodes(uuid: string): OperationQueue;
     protected getEndpoint(endpoint: string): string;
 }
-declare class OperationQueue {
+export declare class OperationQueue {
     operations: DesignOperation[];
     parent: DesignOperations;
     constructor(parent: DesignOperations);
@@ -28,4 +28,3 @@ declare class OperationQueue {
     linkNodes(details: LinkNodes["details"]): this;
     unlinkNodes(uuid: string): this;
 }
-export {};

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

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationQueue = void 0;
 const Base_1 = require("../../../../../../Base");
 const DesignOperation_1 = require("../../../../../../interfaces/high5/space/event/stream/design/DesignOperation");
 class DesignOperations extends Base_1.default {
@@ -115,3 +116,4 @@ class OperationQueue {
         return this;
     }
 }
+exports.OperationQueue = OperationQueue;

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

@@ -1,5 +1,4 @@
-import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../../../Base";
+import Base 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";
@@ -8,12 +7,13 @@ export declare class High5Design extends Base {
     /**
      * API to manage design snapshots
      */
-    snapshots: High5DesignSnapshots;
+    get snapshots(): High5DesignSnapshots;
+    private _snapshots?;
     /**
      * API to perform operations on the Stream Design
      */
-    operations: DesignOperations;
-    constructor(options: Options, axios: AxiosInstance);
+    get operations(): DesignOperations;
+    private _operations?;
     /**
      * Retrieves a stream's design.
      * @param orgName Name of the organization
@@ -22,17 +22,32 @@ export declare class High5Design extends Base {
      * @param streamId ID of the stream
      * @returns The requested design
      */
-    getDesign: (orgName: string, spaceName: string, eventName: string, streamId: string) => Promise<Design>;
+    getDesign(orgName: string, spaceName: string, eventName: string, streamId: string): Promise<Design>;
     /**
      * Creates/overwrites a new design for the specified stream.
+     *
+     * To publish the current design for execution use the {@link publishDesign} method
+     *
      * @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>;
+    createDesign(orgName: string, spaceName: string, eventName: string, streamId: string, name: string, content: DesignContent): Promise<Design>;
+    /**
+     * Publish the current design for a specified stream
+     *
+     * To set the current design use the {@link createDesign} method
+     *
+     * @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)
+     * @returns The created design
+     */
+    publishDesign(orgName: string, spaceName: string, eventName: string, streamId: string): Promise<void>;
     protected getEndpoint(endpoint: string): string;
 }

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

@@ -14,40 +14,75 @@ 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* () {
+    /**
+     * API to manage design snapshots
+     */
+    get snapshots() {
+        if (this._snapshots === undefined) {
+            this._snapshots = new snapshot_1.default(this.options, this.axios);
+        }
+        return this._snapshots;
+    }
+    /**
+     * API to perform operations on the Stream Design
+     */
+    get operations() {
+        if (this._operations === undefined) {
+            this._operations = new DesignOperations_1.default(this.options, this.axios);
+        }
+        return this._operations;
+    }
+    /**
+     * 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, 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}/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* () {
+    }
+    /**
+     * Creates/overwrites a new design for the specified stream.
+     *
+     * To publish the current design for execution use the {@link publishDesign} method
+     *
+     * @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)
+     * @returns The created design
+     */
+    createDesign(orgName, spaceName, eventName, streamId, name, content) {
+        return __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);
+    }
+    /**
+     * Publish the current design for a specified stream
+     *
+     * To set the current design use the {@link createDesign} method
+     *
+     * @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)
+     * @returns The created design
+     */
+    publishDesign(orgName, spaceName, eventName, streamId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/publish`));
+        });
     }
     getEndpoint(endpoint) {
         return `${this.options.server}/api/high5${endpoint}`;

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

@@ -15,7 +15,7 @@ export default class High5DesignSnapshots extends Base {
      * @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>>;
+    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
@@ -25,7 +25,7 @@ export default class High5DesignSnapshots extends Base {
      * @param name Name of the snapshot
      * @returns The snapshot
      */
-    create: (orgName: string, spaceName: string, eventName: string, streamId: string, name: string) => Promise<DesignSnapshot>;
+    create(orgName: string, spaceName: string, eventName: string, streamId: string, name: string): Promise<DesignSnapshot>;
     /**
      * Update a snapshot's name.
      * @param orgName Name of the organization
@@ -36,7 +36,7 @@ export default class High5DesignSnapshots extends Base {
      * @param name Name of the snapshot
      * @returns The snapshot
      */
-    update: (orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string, name: string) => Promise<DesignSnapshot>;
+    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
@@ -45,7 +45,7 @@ export default class High5DesignSnapshots extends Base {
      * @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>;
+    delete(orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string): Promise<void>;
     /**
      * Restore a stream's design to a certain snapshot.
      *
@@ -57,6 +57,6 @@ export default class High5DesignSnapshots extends Base {
      * @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>;
+    restore(orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string): Promise<void>;
     protected getEndpoint(endpoint: string): string;
 }