hcloud-sdk 16.0.0 → 18.0.0

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

@@ -31,14 +31,14 @@ class High5Webhook extends Base_1.default {
      * @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, }) {
+    searchWebhooks(_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}/webhooks/search?limit=${limit}&page=${page}`), {
                 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 High5Webhook extends Base_1.default {
      * @param webhookId ID of the Webhook
      * @returns The requested Webhook
      */
-    getWebhook(orgName, spaceName, webhookId) {
+    getWebhook(orgName, spaceName, webhookId, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -61,10 +61,10 @@ class High5Webhook extends Base_1.default {
      * @param webhookId ID of the Webhook
      * @returns The updated Webhook
      */
-    regenerateWebhookUrl(orgName, spaceName, webhookId) {
+    regenerateWebhookUrl(orgName, spaceName, webhookId, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -74,10 +74,10 @@ class High5Webhook extends Base_1.default {
      * @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) {
+    createWebhook(orgName, spaceName, WebhookCreate, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -88,10 +88,10 @@ class High5Webhook extends Base_1.default {
      * @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) {
+    updateWebhook(orgName, spaceName, webhookId, webhookUpdate, raw) {
         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;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -100,18 +100,20 @@ class High5Webhook extends Base_1.default {
      * @param spaceName Name of the Space
      * @param webhookId ID of the webhook to be deleted
      */
-    deleteWebhook(orgName, spaceName, webhookId) {
+    deleteWebhook(orgName, spaceName, webhookId, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/webhooks/${webhookId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Executes all Events and Streams connected to the specified Webhook.
      * @param webhookUrl URL of the webhook to be triggered / executed
      */
-    triggerWebhook(webhookUrl) {
+    triggerWebhook(webhookUrl, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.post(this.getEndpoint(webhookUrl));
+            const resp = yield this.axios.post(this.getEndpoint(webhookUrl));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -120,7 +122,7 @@ class High5Webhook extends Base_1.default {
      * @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) {
+    executeWebhookByUrl(webhookUrl, payload, headers, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const h = {};
             if (headers) {
@@ -128,9 +130,10 @@ class High5Webhook extends Base_1.default {
                     h[key] = headers[key];
                 });
             }
-            yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
+            const resp = yield this.axios.post(this.getEndpoint(webhookUrl), payload, {
                 headers: h,
             });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -140,10 +143,11 @@ class High5Webhook extends Base_1.default {
      * @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) {
+    respondToWebhook(callbackURL, status, headers, body, raw) {
         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" } });
+            const resp = yield this.axios.post(url, { status, headers: headers !== null && headers !== void 0 ? headers : {}, body }, { headers: { "Content-Type": "application/json" } });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     /**
@@ -152,10 +156,10 @@ class High5Webhook extends Base_1.default {
      * @param challenge String to be returned
      * @returns The provided challenge string as plaint text
      */
-    validateWebhookUrl(webhookUrl, challenge) {
+    validateWebhookUrl(webhookUrl, challenge, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint(`${webhookUrl}?challenge=${challenge}`));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     getEndpoint(endpoint) {

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

@@ -1,4 +1,4 @@
-import Base from "../../../../../Base";
+import Base, { MaybeRaw } from "../../../../../Base";
 import { PaginatedResponse } from "../../../../../interfaces/global";
 import { WebhookLog } from "../../../../../interfaces/high5/space/webhook";
 export declare class High5WebhookLog extends Base {
@@ -11,6 +11,8 @@ export declare class High5WebhookLog extends Base {
      * @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>>;
+    getWebhookLogs<R extends boolean = false>(orgName: string, spaceName: string, webhookId: string, limit?: number, page?: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<WebhookLog>>>;
     protected getEndpoint(endpoint: string): string;
 }

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

@@ -22,12 +22,12 @@ class High5WebhookLog extends Base_1.default {
      * @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) {
+    getWebhookLogs(orgName, spaceName, webhookId, limit, page, raw) {
         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);
+            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));
         });
     }
     getEndpoint(endpoint) {

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

@@ -0,0 +1,11 @@
+import Base from "../../../Base";
+import { Stats } from "../../../interfaces/high5/stats";
+export declare class High5OrgStat extends Base {
+    /**
+     * Retrieves usage statistics for a specific organization.
+     * @param orgName Name of the organization
+     * @returns Statistics information
+     */
+    getStats(orgName: string): Promise<Stats>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,30 @@
+"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.High5OrgStat = void 0;
+const Base_1 = require("../../../Base");
+class High5OrgStat extends Base_1.default {
+    /**
+     * Retrieves usage statistics for a specific organization.
+     * @param orgName Name of the organization
+     * @returns Statistics information
+     */
+    getStats(orgName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/org/${orgName}/stats`));
+            return resp.data;
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/high5/v1${endpoint}`;
+    }
+}
+exports.High5OrgStat = High5OrgStat;

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

@@ -1,6 +1,7 @@
 import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../../Base";
+import Base, { MaybeRaw, Options } from "../../../../Base";
 import { Catalog, CatalogRegistry, Engine, EngineRegistry, StreamNodeSpecifications, StreamNodeSpecificationWrappedWithEngineVersion, WildcardRegistry } from "../../../../interfaces/high5";
+import { Release } from "../../../../interfaces/high5/wave/changelog";
 /**
  * Class for reading the S3 bucket of a wave engine and catalogs
  */
@@ -11,45 +12,67 @@ export declare class S3 extends Base {
      * @param waveBucketUrl Public base url to S3 bucket
      * @returns registry.json
      */
-    getCatalogRegistry(waveBucketUrl: string): Promise<CatalogRegistry>;
+    getCatalogRegistry<R extends boolean = false>(waveBucketUrl: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, 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>;
+    getEngineRegistry<R extends boolean = false>(waveBucketUrl: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, 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>;
+    getCatalog<R extends boolean = false>(catalogUrl: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, 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>;
+    getEngine<R extends boolean = false>(engineUrl: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Engine>>;
     /**
      * Get a list of available wildcards of a specific engine version from the S3 bucket
      * @param engineUrl Public url of the engine
      * @param engineVersion Version of the enigne
      * @returns Wildcards.json list of available wildcards
      */
-    getWildcardsOfEngine(engineUrl: string, engineVersion: string): Promise<WildcardRegistry>;
+    getWildcardsOfEngine<R extends boolean = false>(engineUrl: string, engineVersion: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, WildcardRegistry>>;
     /**
      * 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>;
+    getCatalogVersion<R extends boolean = false>(catalogUrl: string, version: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, 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>;
+    getNodeDocumentation<R extends boolean = false>(catalogUrl: string, version: string, nodeName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, string>>;
+    /**
+     * Get the catalogs changelog from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns string the changelog.json of the node
+     */
+    getChangelog<R extends boolean = false>(catalogUrl: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Release[]>>;
     protected getEndpoint(): string;
 }

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

@@ -10,8 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.S3 = void 0;
+const axios_1 = require("axios");
+const package_json_1 = require("../../../../../package.json");
 const Base_1 = require("../../../../Base");
-const axios_1 = require("../../../../interfaces/axios");
+const axios_2 = require("../../../../interfaces/axios");
+const sdkVersion = "hcloud-sdk-js/v" + package_json_1.version;
 /**
  * Class for reading the S3 bucket of a wave engine and catalogs
  */
@@ -24,10 +27,12 @@ class S3 extends Base_1.default {
      * @param waveBucketUrl Public base url to S3 bucket
      * @returns registry.json
      */
-    getCatalogRegistry(waveBucketUrl) {
+    getCatalogRegistry(waveBucketUrl, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.axios.get(`${waveBucketUrl}/catalogs/registry.json`, { headers: axios_1.disableCacheHeaders });
-            return resp.data;
+            const resp = yield axios_1.default.get(`${waveBucketUrl}/catalogs/registry.json`, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -35,10 +40,12 @@ class S3 extends Base_1.default {
      * @param waveBucketUrl Public base url to S3 bucket
      * @returns registry.json
      */
-    getEngineRegistry(waveBucketUrl) {
+    getEngineRegistry(waveBucketUrl, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.axios.get(`${waveBucketUrl}/engines/registry.json`, { headers: axios_1.disableCacheHeaders });
-            return resp.data;
+            const resp = yield axios_1.default.get(`${waveBucketUrl}/engines/registry.json`, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -46,10 +53,12 @@ class S3 extends Base_1.default {
      * @param catalogUrl Public url of the catalog
      * @returns index.json of catalog
      */
-    getCatalog(catalogUrl) {
+    getCatalog(catalogUrl, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.axios.get(`${catalogUrl}`, { headers: axios_1.disableCacheHeaders });
-            return resp.data;
+            const resp = yield axios_1.default.get(`${catalogUrl}`, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -57,10 +66,12 @@ class S3 extends Base_1.default {
      * @param catalogUrl Public url of the catalog
      * @returns index.json of catalog
      */
-    getEngine(engineUrl) {
+    getEngine(engineUrl, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.axios.get(`${engineUrl}`, { headers: axios_1.disableCacheHeaders });
-            return resp.data;
+            const resp = yield axios_1.default.get(`${engineUrl}`, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -69,12 +80,12 @@ class S3 extends Base_1.default {
      * @param engineVersion Version of the enigne
      * @returns Wildcards.json list of available wildcards
      */
-    getWildcardsOfEngine(engineUrl, engineVersion) {
+    getWildcardsOfEngine(engineUrl, engineVersion, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            const resp = yield this.axios.get(`${engineUrl.replace("/index.json", "")}/${engineVersion}/wildcards.json`, {
-                headers: axios_1.disableCacheHeaders,
+            const resp = yield axios_1.default.get(`${engineUrl.replace("/index.json", "")}/${engineVersion}/wildcards.json`, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -83,13 +94,13 @@ class S3 extends Base_1.default {
      * @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, version) {
+    getCatalogVersion(catalogUrl, version, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + "/" + version + "/specification.json";
-            const resp = yield this.axios.get(specificationUrl, {
-                headers: axios_1.disableCacheHeaders,
+            const resp = yield axios_1.default.get(specificationUrl, {
+                headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }),
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -98,13 +109,30 @@ class S3 extends Base_1.default {
      * @param version The catalog version
      * @returns string the markdown documentation of the node
      */
-    getNodeDocumentation(catalogUrl, version, nodeName) {
+    getNodeDocumentation(catalogUrl, version, nodeName, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const specificationUrl = catalogUrl.split("/").slice(0, -1).join("/") + `/${version}/docs/${nodeName}.md`;
-            const resp = yield this.axios.get(specificationUrl).catch(err => {
+            const resp = yield axios_1.default
+                .get(specificationUrl, { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }) })
+                .catch(err => {
+                throw new Error(`Node documentation not found: ${err}`);
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Get the catalogs changelog from the S3 bucket
+     * @param catalogUrl Public url of the catalog
+     * @returns string the changelog.json of the node
+     */
+    getChangelog(catalogUrl, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield axios_1.default
+                .get(catalogUrl + "changelog.json", { headers: Object.assign(Object.assign({}, axios_2.disableCacheHeaders), { "x-hcloud-user-agent": sdkVersion, Authorization: undefined }) })
+                .catch(err => {
                 throw new Error(`Node documentation not found: ${err}`);
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     getEndpoint() {

package/lib/service/idp/guest/index.d.ts

@@ -0,0 +1,42 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { SuccessfulAuth } from "../../../interfaces/idp";
+export declare class IdpGuest extends Base {
+    /**
+     * Creates a new guest user account.
+     *
+     * @param email - The email address of the guest to create.
+     * @param name - The display name of the guest user.
+     * @param emailHMAC - An HMAC signature of the email, used for validation.
+     * @returns A promise resolving to a `SuccessfulAuth` object containing:
+     *   - `user`: The created `User` object.
+     *   - `token`: An authorization token returned by the API.
+     */
+    createGuest<R extends boolean = false>(email: string, name: string, emailHMAC: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, SuccessfulAuth>>;
+    /**
+     * Logs in as an existing guest user.
+     *
+     * @param email - The email address of the guest to log in.
+     * @param emailHMAC - An HMAC signature of the email, used for validation.
+     * @returns A promise resolving to a `SuccessfulAuth` object containing:
+     *   - `user`: The authenticated `User` object.
+     *   - `token`: An authorization token returned by the API.
+     */
+    loginAsGuest<R extends boolean = false>(email: string, emailHMAC: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, SuccessfulAuth>>;
+    /**
+     * Checks whether an email corresponds to a guest account.
+     *
+     * @param email - The email address to check.
+     * @returns A promise resolving to one of:
+     *   - `"no user"` → No user exists with the given email.
+     *   - `"not guest"` → A user exists but is not a guest.
+     *   - `"guest"` → The email belongs to a guest account.
+     */
+    isGuest<R extends boolean = false>(email: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, "no user" | "not guest" | "guest">>;
+    protected getEndpoint(endpoint: string): string;
+}

package/lib/service/idp/guest/index.js

@@ -0,0 +1,66 @@
+"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.IdpGuest = void 0;
+const Base_1 = require("../../../Base");
+class IdpGuest extends Base_1.default {
+    /**
+     * Creates a new guest user account.
+     *
+     * @param email - The email address of the guest to create.
+     * @param name - The display name of the guest user.
+     * @param emailHMAC - An HMAC signature of the email, used for validation.
+     * @returns A promise resolving to a `SuccessfulAuth` object containing:
+     *   - `user`: The created `User` object.
+     *   - `token`: An authorization token returned by the API.
+     */
+    createGuest(email, name, emailHMAC, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint("/v1/guest"), { email, name, hmac: emailHMAC });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw)
+                ? Object.assign(Object.assign({}, resp), { data: { user: resp.data, token: resp.headers.authorization } }) : { user: resp.data, token: resp.headers.authorization });
+        });
+    }
+    /**
+     * Logs in as an existing guest user.
+     *
+     * @param email - The email address of the guest to log in.
+     * @param emailHMAC - An HMAC signature of the email, used for validation.
+     * @returns A promise resolving to a `SuccessfulAuth` object containing:
+     *   - `user`: The authenticated `User` object.
+     *   - `token`: An authorization token returned by the API.
+     */
+    loginAsGuest(email, emailHMAC, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.put(this.getEndpoint("/v1/guest"), { email, hmac: emailHMAC });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, res), { data: { user: res.data, token: res.headers.authorization } }) : { user: res.data, token: res.headers.authorization });
+        });
+    }
+    /**
+     * Checks whether an email corresponds to a guest account.
+     *
+     * @param email - The email address to check.
+     * @returns A promise resolving to one of:
+     *   - `"no user"` → No user exists with the given email.
+     *   - `"not guest"` → A user exists but is not a guest.
+     *   - `"guest"` → The email belongs to a guest account.
+     */
+    isGuest(email, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.get(this.getEndpoint(`/v1/guest/email/${email}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/account${endpoint}`;
+    }
+}
+exports.IdpGuest = IdpGuest;

package/lib/service/idp/index.d.ts

@@ -1,7 +1,8 @@
-import Base from "../../Base";
+import Base, { MaybeRaw } from "../../Base";
 import { Version } from "../../interfaces/global";
 import { PreLoginResponse } from "../../interfaces/idp";
 import { SuccessfulAuth } from "../../interfaces/idp/user/SuccessfulAuth";
+import { IdpGuest } from "./guest";
 import { IdpInternal } from "./internal";
 import { IdpOAuth } from "./oauth";
 import { IdpOrganization } from "./organization";
@@ -28,6 +29,11 @@ export default class Idp extends Base {
      */
     get user(): IdpUser;
     private _user?;
+    /**
+     * Handles everything around a guest
+     */
+    get guest(): IdpGuest;
+    private _guest?;
     /**
      * Handles everything around idp's internal endpoints
      */
@@ -37,7 +43,9 @@ export default class Idp extends Base {
      * Requests the endpoint version
      * @returns Version object
      */
-    version(): Promise<Version>;
+    version<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Version>>;
     /**
      * Authenticates against the identity provider with a given email and password.
      * @param email Email of the user
@@ -45,7 +53,9 @@ export default class Idp extends Base {
      * @param token (optional) token if 2FA-TOTP is enabled
      * @returns SuccessfulAuth object holding the token and the user
      */
-    login(email: string, password: string, token?: string): Promise<SuccessfulAuth>;
+    login<R extends boolean = false>(email: string, password: string, token?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, SuccessfulAuth>>;
     /**
      * Starts the login process via OIDC
      * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
@@ -54,14 +64,18 @@ export default class Idp extends Base {
      * @param hint Valid email address of the user that wants to login. Hint must be defined when provider is not.
      * @returns URL that must be accessed via a browser to continue the login process.
      */
-    loginWithOIDC(origin: string, oidcProvider?: string, hint?: string): Promise<string>;
+    loginWithOIDC<R extends boolean = false>(origin: string, oidcProvider?: string, hint?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, string>>;
     /**
      * Starts the login process via SAML 2.0
      * @param origin The starting URL of the process. After obtaining the credentials, the user will be redirected back to this url.
      * @param email  Email of the user. The email domain will be used to determine the appropriate SAML 2.0 provider to use going forward.
      * @returns URL that must be accessed via a browser to continue the login process.
      */
-    loginWithSAML(origin: string, email: string): Promise<string>;
+    loginWithSAML<R extends boolean = false>(origin: string, email: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, string>>;
     /**
      * Determine if/how the given email can authenticate.
      *
@@ -71,7 +85,9 @@ export default class Idp extends Base {
      * @returns object that dictates if: the user needs to REGISTER; the user needs to VERIFY_EMAIL; the user can LOGIN using this email;
      *          or the authentication process should continue via an EXTERNAL provider that can be found via the location property.
      */
-    preLogin(email: string, origin: string): Promise<PreLoginResponse>;
+    preLogin<R extends boolean = false>(email: string, origin: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PreLoginResponse>>;
     /**
      * Initiate the password reset process. An email will be sent to the user to move to the next phase.
      *
@@ -79,6 +95,8 @@ export default class Idp extends Base {
      * @param captcha Valid google reCAPTCHAV2
      * @param targetUrl Optional url the link in the mail will point to
      */
-    resetPassword(email: string, captcha: string, targetUrl?: string): Promise<void>;
+    resetPassword<R extends boolean = false>(email: string, captcha: string, targetUrl?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }