hcloud-sdk 16.0.0 → 18.0.0

package/lib/service/high5/space/database/document/number/index.d.ts

@@ -0,0 +1,51 @@
+import Base, { MaybeRaw } from "../../../../../../Base";
+import { Document } from "../../../../../../interfaces/high5";
+export declare class High5DocumentNumber extends Base {
+    /**
+     * Increments the current integer value by one.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns Updated Document
+     */
+    increment<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Decrements the current integer value by one.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns Updated Document
+     */
+    decrement<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Adds value to current numeric document value.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param value Value to be added
+     * @returns Updated Document
+     */
+    add<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, value: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    /**
+     * Subtracts value from current numeric document value.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param value Value to be subtracted
+     * @returns Updated Document
+     */
+    subtract<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, key: string, value: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Document>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/database/document/number/index.js

@@ -0,0 +1,77 @@
+"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.High5DocumentNumber = void 0;
+const Base_1 = require("../../../../../../Base");
+class High5DocumentNumber extends Base_1.default {
+    /**
+     * Increments the current integer value by one.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns Updated Document
+     */
+    increment(orgName, spaceName, dbName, key, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/inc`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Decrements the current integer value by one.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @returns Updated Document
+     */
+    decrement(orgName, spaceName, dbName, key, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/dec`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Adds value to current numeric document value.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param value Value to be added
+     * @returns Updated Document
+     */
+    add(orgName, spaceName, dbName, key, value, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/inc/${value}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Subtracts value from current numeric document value.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param key Key of the Document
+     * @param value Value to be subtracted
+     * @returns Updated Document
+     */
+    subtract(orgName, spaceName, dbName, key, value, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/documents/${key}/dec/${value}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5DocumentNumber = High5DocumentNumber;

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

@@ -0,0 +1,65 @@
+import Base, { MaybeRaw } from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { Database } from "../../../../interfaces/high5";
+import { High5Document } from "./document";
+export declare class High5Database extends Base {
+    get document(): High5Document;
+    private _document?;
+    /**
+     * Retrieves all Databases of a High5 Space which match the provided search filter(s). Will return all Databases 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 Databases and the total number of results found in the database (independent of limit and page)
+     */
+    searchDatabases<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<Database>>>;
+    /**
+     * Retrieves a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @returns The requested Database
+     */
+    getDatabase<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Database>>;
+    /**
+     * Creates a new Database in the provided Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param name Name of the new Database
+     * @returns The created Database
+     */
+    createDatabase<R extends boolean = false>(orgName: string, spaceName: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Database>>;
+    /**
+     * Rename a Database
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param name New name of the Database
+     * @returns Updated Database
+     */
+    renameDatabase<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Database>>;
+    /**
+     * Deletes a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     */
+    deleteDatabase<R extends boolean = false>(orgName: string, spaceName: string, dbName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,102 @@
+"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.High5Database = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const document_1 = require("./document");
+class High5Database extends Base_1.default {
+    get document() {
+        if (this._document === undefined) {
+            this._document = new document_1.High5Document(this.options, this.axios);
+        }
+        return this._document;
+    }
+    /**
+     * Retrieves all Databases of a High5 Space which match the provided search filter(s). Will return all Databases 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 Databases and the total number of results found in the database (independent of limit and page)
+     */
+    searchDatabases(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0 }, raw) {
+            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}/databases/search?page=${page}&limit=${limit}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
+        });
+    }
+    /**
+     * Retrieves a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @returns The requested Database
+     */
+    getDatabase(orgName, spaceName, dbName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Creates a new Database in the provided Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param name Name of the new Database
+     * @returns The created Database
+     */
+    createDatabase(orgName, spaceName, name, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases`), { name });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Rename a Database
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     * @param name New name of the Database
+     * @returns Updated Database
+     */
+    renameDatabase(orgName, spaceName, dbName, name, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}/name`), {
+                name: name,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Deletes a Database by its name.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param dbName Name of the Database
+     */
+    deleteDatabase(orgName, spaceName, dbName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/databases/${dbName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Database = High5Database;

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

@@ -1,4 +1,4 @@
-import Base from "../../../../Base";
+import Base, { MaybeRaw } from "../../../../Base";
 import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
 import { Event } from "../../../../interfaces/high5/space/event";
 import { High5Stream } from "./stream";
@@ -15,10 +15,12 @@ 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<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page }: SearchParams & {
         orgName: string;
         spaceName: string;
-    }): Promise<PaginatedResponse<Event>>;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<Event>>>;
     /**
      * Retrieves an Event by its name.
      * @param orgName Name of the Organization
@@ -26,7 +28,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Event>>;
     /**
      * Creates a new Event in the provided Space.
      * @param orgName Name of the Organization
@@ -34,7 +38,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Event>>;
     /**
      * Rename an event
      * @param orgName Name of the Organization
@@ -43,13 +49,17 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

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

@@ -31,14 +31,14 @@ class High5Event extends Base_1.default {
      * @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, }) {
+    searchEvents(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit = 25, page = 0 }, raw) {
             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);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
         });
     }
     /**
@@ -48,10 +48,10 @@ class High5Event extends Base_1.default {
      * @param eventName Name of the Event
      * @returns The requested Event
      */
-    getEvent(orgName, spaceName, eventName) {
+    getEvent(orgName, spaceName, eventName, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -61,10 +61,10 @@ class High5Event extends Base_1.default {
      * @param name Name of the new Event
      * @returns The created Event
      */
-    createEvent(orgName, spaceName, name) {
+    createEvent(orgName, spaceName, name, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -75,12 +75,12 @@ class High5Event extends Base_1.default {
      * @param name New name of the Event
      * @returns Updated Event
      */
-    renameEvent(orgName, spaceName, eventName, name) {
+    renameEvent(orgName, spaceName, eventName, name, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -89,9 +89,10 @@ class High5Event extends Base_1.default {
      * @param spaceName Name of the Space
      * @param eventName Name of the Event
      */
-    deleteEvent(orgName, spaceName, eventName) {
+    deleteEvent(orgName, spaceName, eventName, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

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

@@ -1,9 +1,11 @@
-import Base from "../../../../../../Base";
+import Base, { MaybeRaw } 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>;
+    send<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, designHash: string, operations: DesignOperation[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Design>>;
     queue(): OperationQueue;
     addNode(details: DesignerNode): OperationQueue;
     deleteNode(uuid: string): OperationQueue;

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

@@ -13,10 +13,10 @@ 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 {
-    send(orgName, spaceName, eventName, streamId, designHash, operations) {
+    send(orgName, spaceName, eventName, streamId, designHash, operations, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     queue() {
@@ -57,7 +57,9 @@ class OperationQueue {
         this.parent = parent;
     }
     send(orgName, spaceName, eventName, streamId, designHash) {
-        return this.parent.send(orgName, spaceName, eventName, streamId, designHash, this.operations);
+        const entriesToSend = [...this.operations];
+        this.operations = [];
+        return this.parent.send(orgName, spaceName, eventName, streamId, designHash, entriesToSend);
     }
     addNode(details) {
         const op = {

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

@@ -1,4 +1,4 @@
-import Base from "../../../../../../Base";
+import Base, { MaybeRaw } 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";
@@ -22,7 +22,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Design>>;
     /**
      * Creates/overwrites a new design for the specified stream.
      *
@@ -35,7 +37,9 @@ export declare class High5Design extends Base {
      * @param content Design as Json payload (schema created by Stream Designer Studio)
      * @returns The created design
      */
-    createDesign(orgName: string, spaceName: string, eventName: string, streamId: string, name: string, content: DesignContent): Promise<Design>;
+    createDesign<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, name: string, content: DesignContent, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Design>>;
     /**
      * Publish the current design for a specified stream
      *
@@ -48,6 +52,8 @@ export declare class High5Design extends Base {
      * @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>;
+    publishDesign<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

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

@@ -40,10 +40,10 @@ class High5Design extends Base_1.default {
      * @param streamId ID of the stream
      * @returns The requested design
      */
-    getDesign(orgName, spaceName, eventName, streamId) {
+    getDesign(orgName, spaceName, eventName, streamId, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -58,13 +58,13 @@ class High5Design extends Base_1.default {
      * @param content Design as Json payload (schema created by Stream Designer Studio)
      * @returns The created design
      */
-    createDesign(orgName, spaceName, eventName, streamId, name, content) {
+    createDesign(orgName, spaceName, eventName, streamId, name, content, raw) {
         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,
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -79,9 +79,10 @@ class High5Design extends Base_1.default {
      * @param content Design as Json payload (schema created by Stream Designer Studio)
      * @returns The created design
      */
-    publishDesign(orgName, spaceName, eventName, streamId) {
+    publishDesign(orgName, spaceName, eventName, streamId, raw) {
         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`));
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/events/${eventName}/streams/${streamId}/design/publish`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

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

@@ -1,4 +1,4 @@
-import Base from "../../../../../../../Base";
+import Base, { MaybeRaw } from "../../../../../../../Base";
 import { PaginatedResponse, SearchParams } from "../../../../../../../interfaces/global";
 import DesignSnapshot from "../../../../../../../interfaces/high5/space/event/stream/design/snapshot";
 export default class High5DesignSnapshots extends Base {
@@ -15,7 +15,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, content: boolean | undefined, { filters, sorting, limit, page }: SearchParams, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<DesignSnapshot>>>;
     /**
      * Create a snapshot of stream's design.
      * @param orgName Name of the organization
@@ -25,7 +27,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, DesignSnapshot>>;
     /**
      * Update a snapshot's name.
      * @param orgName Name of the organization
@@ -36,7 +40,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string, name: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, DesignSnapshot>>;
     /**
      * Delete a stream design's snapshot.
      * @param orgName Name of the organization
@@ -45,7 +51,9 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     /**
      * Restore a stream's design to a certain snapshot.
      *
@@ -57,6 +65,8 @@ 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<R extends boolean = false>(orgName: string, spaceName: string, eventName: string, streamId: string, snapshotId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }