hcloud-sdk 0.0.16 → 15.0.0

package/lib/service/high5/space/secret/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 });
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+class High5Secret extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+    }
+    /**
+     * Requests all secret keys of the provided space which match the search filter(s) (paginated request).
+     * Only the keys of the secret are sent back in the response by default, not the actual encrypted values.
+     * Will return all secrets 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)
+     * @param encrypted - (optional) Whether to get all secret values only in encrypted form.
+     * @returns Object containing an array of secret keys as well as the total number of results found in the database (independent of limit and page)
+     */
+    searchSecrets(_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) => {
+                return new searchFilter_1.SearchFilterDTO(f);
+            });
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/secrets/search?limit=${limit}&page=${page}`), {
+                filters: filtersDTO,
+                sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Adds a secret key-value pair to a space.
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @param value - Value of the key-value pair
+     * @param encrypted - (optional) Boolean defining if the value should be stored encrypted (defaults to false).
+     * @returns The created Secret
+     */
+    addSecret(orgName, spaceName, secret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/secrets`), secret);
+            return resp.data;
+        });
+    }
+    /**
+     * Updates the value for an existent secret key-value pair.
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @param value - The new value of the key-value pair
+     * @param encrypted - (optional) Boolean defining if the value should be stored encrypted (defaults to false).
+     * @returns The updated Secret
+     */
+    updateSecret(orgName, spaceName, key, secret) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/secrets/${key}`), secret);
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes a key-value pair of the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     */
+    deleteSecret(orgName, spaceName, key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/secrets/${key}`));
+        });
+    }
+    /**
+     * Get secret value by its key
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param key - Key of the key-value pair
+     * @returns Secret details
+     */
+    getSecret(orgName, spaceName, key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/secrets/${key}`));
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5Secret;

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

@@ -0,0 +1,36 @@
+import Base from "../../../../Base";
+import { SpacePatchWaveCatalog, SpacePatchWaveEngine, WaveCatalog, WaveEngine } from "../../../../interfaces/high5";
+export default class High5Wave extends Base {
+    /**
+     * Patch wave engine version for a space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param spacePatchWaveEngine - Patch wave engine object holding url and version
+     * @returns WaveEngine object
+     */
+    patchSpaceWaveEngine(orgName: string, spaceName: string, spacePatchWaveEngine: SpacePatchWaveEngine): Promise<WaveEngine>;
+    /**
+     * Get wave engine version currently active for the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @returns WaveEngine object
+     */
+    getSpaceWaveEngine(orgName: string, spaceName: string): Promise<WaveEngine>;
+    /**
+     * Adds a new wave catalog version for a space or updates existing
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param spacePatchWaveCatalog - Patch wave catalog object holding url, version and optionally a minimumEngineVersion
+     * @returns WaveCatalog object
+     */
+    addUpdateSpaceWaveCatalog(orgName: string, spaceName: string, spacePatchCatalog: SpacePatchWaveCatalog): Promise<WaveCatalog>;
+    /**
+     * Get wave catalogs currently active for the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @returns WaveCatalog array
+     */
+    getSpaceWaveCatalogs(orgName: string, spaceName: string): Promise<WaveCatalog[]>;
+    deleteSpaceWaveCatalog(orgName: string, spaceName: string, catalogId: string): Promise<void>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,73 @@
+"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");
+class High5Wave extends Base_1.default {
+    /**
+     * Patch wave engine version for a space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param spacePatchWaveEngine - Patch wave engine object holding url and version
+     * @returns WaveEngine object
+     */
+    patchSpaceWaveEngine(orgName, spaceName, spacePatchWaveEngine) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/engine`), spacePatchWaveEngine);
+            return resp.data;
+        });
+    }
+    /**
+     * Get wave engine version currently active for the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @returns WaveEngine object
+     */
+    getSpaceWaveEngine(orgName, spaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/engine`));
+            return resp.data;
+        });
+    }
+    /**
+     * Adds a new wave catalog version for a space or updates existing
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @param spacePatchWaveCatalog - Patch wave catalog object holding url, version and optionally a minimumEngineVersion
+     * @returns WaveCatalog object
+     */
+    addUpdateSpaceWaveCatalog(orgName, spaceName, spacePatchCatalog) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog`), spacePatchCatalog);
+            return resp.data;
+        });
+    }
+    /**
+     * Get wave catalogs currently active for the space
+     * @param orgName - Name of the organization
+     * @param spaceName - Name of the space
+     * @returns WaveCatalog array
+     */
+    getSpaceWaveCatalogs(orgName, spaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog`));
+            return resp.data;
+        });
+    }
+    deleteSpaceWaveCatalog(orgName, spaceName, catalogId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/wave/catalog/${catalogId}`));
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.default = High5Wave;

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

@@ -0,0 +1,90 @@
+import Base from "../../../../Base";
+import { PaginatedResponse, SearchParams } from "../../../../interfaces/global";
+import { KeyValuePair, Webhook, WebhookCreate, WebhookUpdate } from "../../../../interfaces/high5/space/webhook";
+import { High5WebhookLog } from "./log";
+export declare class High5Webhook extends Base {
+    get log(): High5WebhookLog;
+    private _log?;
+    /**
+     * Retrieves all Webhooks of the specified space that match the provided search filter(s). Will return all Webhooks if no search 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 Webhooks and the total number of results found in the database (independent of limit and page)
+     */
+    searchWebhooks({ orgName, spaceName, filters, sorting, limit, page, }: SearchParams & {
+        orgName: string;
+        spaceName: string;
+    }): Promise<PaginatedResponse<Webhook>>;
+    /**
+     * Requests a Webhhok by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The requested Webhook
+     */
+    getWebhook(orgName: string, spaceName: string, webhookId: string): Promise<Webhook>;
+    /**
+     * Generates a new URL for the specified Webhook. This is suggested if a leak of the current URL is likely.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The updated Webhook
+     */
+    regenerateWebhookUrl(orgName: string, spaceName: string, webhookId: string): Promise<Webhook>;
+    /**
+     * Creates a new Webhook in the specified High5 space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
+     * @returns The created Webhook
+     */
+    createWebhook(orgName: string, spaceName: string, WebhookCreate: WebhookCreate): Promise<Webhook>;
+    /**
+     * Updates an existing Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook to be updated
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
+     * @returns the updated Webhook
+     */
+    updateWebhook(orgName: string, spaceName: string, webhookId: string, webhookUpdate: WebhookUpdate): Promise<Webhook>;
+    /**
+     * Deletes a Webhook by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the webhook to be deleted
+     */
+    deleteWebhook(orgName: string, spaceName: string, webhookId: string): Promise<void>;
+    /**
+     * Executes all Events and Streams connected to the specified Webhook.
+     * @param webhookUrl URL of the webhook to be triggered / executed
+     */
+    triggerWebhook(webhookUrl: string): Promise<void>;
+    /**
+     * Executes a webhook by its URL.
+     * @param webhookUrl Webhook URL to be triggered / executed (your hcloud domain + webhook.relativeUrl)
+     * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
+     * @param headers (optional) Security headers.
+     */
+    executeWebhookByUrl(webhookUrl: string, payload: unknown, headers?: KeyValuePair<string>): Promise<void>;
+    /**
+     * Respond to a webhook via callback.
+     * @param callbackURL            Full or partial URL callback URL. This URL is unique per webhook execution
+     * @param status                 HTTP status code to send in the response
+     * @param headers     (optional) HTTP headers to send in the response
+     * @param body        (optional) Body to send in the HTTP response
+     */
+    respondToWebhook(callbackURL: string, status: number, headers?: Record<string, string | string[]>, body?: string): Promise<void>;
+    /**
+     * Validates the provided webhook URL by sending a challenge query parameter.
+     * @param url Webhook URL to be validated (your hcloud domain + webhook.relativeUrl)
+     * @param challenge String to be returned
+     * @returns The provided challenge string as plaint text
+     */
+    validateWebhookUrl(webhookUrl: string, challenge: string): Promise<string>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,165 @@
+"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.High5Webhook = void 0;
+const Base_1 = require("../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../helper/paginatedResponseHelper");
+const searchFilter_1 = require("../../../../helper/searchFilter");
+const log_1 = require("./log");
+class High5Webhook extends Base_1.default {
+    get log() {
+        if (this._log === undefined) {
+            this._log = new log_1.High5WebhookLog(this.options, this.axios);
+        }
+        return this._log;
+    }
+    /**
+     * Retrieves all Webhooks of the specified space that match the provided search filter(s). Will return all Webhooks if no search 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 Webhooks and the total number of results found in the database (independent of limit and page)
+     */
+    searchWebhooks(_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}/webhooks/search?limit=${limit}&page=${page}`), {
+                filters: filtersDTO,
+                sorting: sorting,
+            });
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    /**
+     * Requests a Webhhok by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The requested Webhook
+     */
+    getWebhook(orgName, spaceName, webhookId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+            return resp.data;
+        });
+    }
+    /**
+     * Generates a new URL for the specified Webhook. This is suggested if a leak of the current URL is likely.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @returns The updated Webhook
+     */
+    regenerateWebhookUrl(orgName, spaceName, webhookId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}/regenerateUrl`));
+            return resp.data;
+        });
+    }
+    /**
+     * Creates a new Webhook in the specified High5 space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the new webhook
+     * @returns The created Webhook
+     */
+    createWebhook(orgName, spaceName, WebhookCreate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks`), WebhookCreate);
+            return resp.data;
+        });
+    }
+    /**
+     * Updates an existing Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook to be updated
+     * @param WebhookCreate Object/JSON containing the name, token, eventId, spaceId, target and (optionally) security headers for the updated webhook
+     * @returns the updated Webhook
+     */
+    updateWebhook(orgName, spaceName, webhookId, webhookUpdate) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`), webhookUpdate);
+            return resp.data;
+        });
+    }
+    /**
+     * Deletes a Webhook by its ID.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the webhook to be deleted
+     */
+    deleteWebhook(orgName, spaceName, webhookId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+        });
+    }
+    /**
+     * Executes all Events and Streams connected to the specified Webhook.
+     * @param webhookUrl URL of the webhook to be triggered / executed
+     */
+    triggerWebhook(webhookUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(this.getEndpoint(webhookUrl));
+        });
+    }
+    /**
+     * Executes a webhook by its URL.
+     * @param webhookUrl Webhook URL to be triggered / executed (your hcloud domain + webhook.relativeUrl)
+     * @param payload Payload to be used in the event execution that will be triggered by the webhook, as JSON.
+     * @param headers (optional) Security headers.
+     */
+    executeWebhookByUrl(webhookUrl, payload, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const h = {};
+            if (headers) {
+                Object.keys(headers).forEach((key) => {
+                    h[key] = headers[key];
+                });
+            }
+            yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
+                headers: h,
+            });
+        });
+    }
+    /**
+     * Respond to a webhook via callback.
+     * @param callbackURL            Full or partial URL callback URL. This URL is unique per webhook execution
+     * @param status                 HTTP status code to send in the response
+     * @param headers     (optional) HTTP headers to send in the response
+     * @param body        (optional) Body to send in the HTTP response
+     */
+    respondToWebhook(callbackURL, status, headers, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = callbackURL.startsWith("http") ? callbackURL : this.getEndpoint(callbackURL);
+            yield this.axios.post(url, { status, headers: headers !== null && headers !== void 0 ? headers : {}, body }, { headers: { "Content-Type": "application/json" } });
+        });
+    }
+    /**
+     * Validates the provided webhook URL by sending a challenge query parameter.
+     * @param url Webhook URL to be validated (your hcloud domain + webhook.relativeUrl)
+     * @param challenge String to be returned
+     * @returns The provided challenge string as plaint text
+     */
+    validateWebhookUrl(webhookUrl, challenge) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`${webhookUrl}?challenge=${challenge}`));
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Webhook = High5Webhook;

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

@@ -0,0 +1,16 @@
+import Base from "../../../../../Base";
+import { PaginatedResponse } from "../../../../../interfaces/global";
+import { WebhookLog } from "../../../../../interfaces/high5/space/webhook";
+export declare class High5WebhookLog extends Base {
+    /**
+     * Retrieves all Webhook logs for the specified Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @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 Webhook logs and the total number of results found in the database (independent of limit and page)
+     */
+    getWebhookLogs(orgName: string, spaceName: string, webhookId: string, limit?: number, page?: number): Promise<PaginatedResponse<WebhookLog>>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/high5/space/webhook/log/index.js

@@ -0,0 +1,37 @@
+"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.High5WebhookLog = void 0;
+const Base_1 = require("../../../../../Base");
+const paginatedResponseHelper_1 = require("../../../../../helper/paginatedResponseHelper");
+class High5WebhookLog extends Base_1.default {
+    /**
+     * Retrieves all Webhook logs for the specified Webhook.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param webhookId ID of the Webhook
+     * @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 Webhook logs and the total number of results found in the database (independent of limit and page)
+     */
+    getWebhookLogs(orgName, spaceName, webhookId, 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}/spaces/${spaceName}/webhooks/${webhookId}/logs?limit=${limit}&page=${page}`));
+            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5WebhookLog = High5WebhookLog;

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

@@ -0,0 +1,8 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../Base";
+import { S3 } from "./s3";
+export declare class High5Wave extends Base {
+    s3: S3;
+    constructor(options: Options, axios: AxiosInstance);
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.High5Wave = void 0;
+const Base_1 = require("../../../Base");
+const s3_1 = require("./s3");
+class High5Wave extends Base_1.default {
+    constructor(options, axios) {
+        super(options, axios);
+        this.s3 = new s3_1.S3(this.options, this.axios);
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5${endpoint}`;
+    }
+}
+exports.High5Wave = High5Wave;

package/lib/service/high5/wave/s3/index.d.ts

@@ -0,0 +1,48 @@
+import { AxiosInstance } from "axios";
+import Base, { Options } from "../../../../Base";
+import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion } from "../../../../interfaces/high5";
+/**
+ * Class for reading the S3 bucket of a wave engine and catalogs
+ */
+export declare class S3 extends Base {
+    constructor(options: Options, axios: AxiosInstance);
+    /**
+     * Get the registry.json of the default wave catalog from the S3 bucket
+     * @param waveBucketUrl Public base url to S3 bucket
+     * @returns registry.json
+     */
+    getCatalogRegistry(waveBucketUrl: string): Promise<CatalogRegistry>;
+    /**
+     * Get the registry.json of the default wave engine from the S3 bucket
+     * @param waveBucketUrl Public base url to S3 bucket
+     * @returns registry.json
+     */
+    getEngineRegistry(waveBucketUrl: string): Promise<EngineRegistry>;
+    /**
+     * Get the catalog.json from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns index.json of catalog
+     */
+    getCatalog(catalogUrl: string): Promise<Catalog>;
+    /**
+     * Get the catalog.json from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns index.json of catalog
+     */
+    getEngine(engineUrl: string): Promise<Engine>;
+    /**
+     * Get the node specifications of all nodes of a specific catalog version from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @param version The catalog version
+     * @returns StreamNodeSpecification[] | StreamNodeSpecificationWrappedWithEngineVersion an array of all node specification of that catalog version, maybe wrapped in an object with the engine version
+     */
+    getCatalogVersion(catalogUrl: string, version: string): Promise<StreamNodeSpecifications[] | StreamNodeSpecificationWrappedWithEngineVersion>;
+    /**
+     * Get the node documentation from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @param version The catalog version
+     * @returns string the markdown documentation of the node
+     */
+    getNodeDocumentation(catalogUrl: string, version: string, nodeName: string): Promise<string>;
+    protected getEndpoint(): string;
+}