hcloud-sdk 17.0.0 → 19.0.0

package/lib/service/cosmo/share/index.js

@@ -0,0 +1,227 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosmoShare = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+/**
+ * @class Share
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Share resource in Cosmo, providing methods to interact with the Share API.
+ */
+class CosmoShare extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * Create a new Share in the specified Organization and Space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param createShare The Share object to create
+     *
+     * @returns The created Share
+     */
+    createShare(orgName, spaceName, createShare, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares`), createShare);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Links the user to a Share, making the assets shared available to the user
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param shareId The ID of the Share to link
+     *
+     * @returns The created Share
+     */
+    linkShare(orgName, spaceName, shareId, password, shareIdHMAC, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}`), {
+                password,
+                shareIdHMAC,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Delete Shares by ID.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param shareIds The IDs of the Shares to delete
+     *
+     * @returns 204 No Content if successful
+     */
+    deleteShare(orgName, spaceName, shareIds, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares`), {
+                data: { shareIds },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Fetch a Share.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param shareId The ID of the Share to link
+     *
+     * @returns Detailed Share object
+     */
+    fetchShare(orgName, spaceName, shareId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Searches for shares within a specific space in an organization.
+     *
+     * @param {string} orgName - The name of the organization.
+     * @param {string} spaceName - The name of the space.
+     * @param {{ sorting?: Sorting, filters?: SearchFilter[] }} search - Search criteria including optional sorting and filters.
+     * @param {number} limit - Maximum number of results per page.
+     * @param {number} page - The page number to retrieve.
+     * @returns {Promise<ShareWithUsers[]>} A promise that resolves to a list of shares with their associated users.
+     */
+    searchSharesOfSpace(orgName, spaceName, search, limit, page, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/search`), search, {
+                params: {
+                    limit,
+                    page,
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Searches for shares the current user is linked to.
+     *
+     * @param {{ sorting?: Sorting, filters?: SearchFilter[] }} search - Search criteria including optional sorting and filters.
+     * @param {number} limit - Maximum number of results per page.
+     * @param {number} page - The page number to retrieve.
+     * @returns {Promise<Share[]>} A promise that resolves to a list of shares the current user is linked to.
+     */
+    searchSharesOfUser(search, limit, page, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/user/shares/search`), search, {
+                params: {
+                    limit,
+                    page,
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Unlinks the current user from a specific share in a space.
+     *
+     * @param {string} orgName - The name of the organization.
+     * @param {string} spaceName - The name of the space.
+     * @param {string} shareId - The ID of the share to unlink from.
+     * @returns {Promise<void>} A promise that resolves when the unlinking is complete.
+     */
+    unlinkSelf(orgName, spaceName, shareId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}/link`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Unlinks another user from a specific share in a space.
+     *
+     * @param {string} orgName - The name of the organization.
+     * @param {string} spaceName - The name of the space.
+     * @param {string} shareId - The ID of the share to unlink from.
+     * @param {string} userId - The ID of the user to unlink.
+     * @returns {Promise<void>} A promise that resolves when the unlinking is complete.
+     */
+    unlinkOther(orgName, spaceName, shareId, userId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}/user/${userId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Patch a Share in the specified Organization and Space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param shareId ID of the Share
+     * @param patchObject An object whose properties will be used to replace the existing Share ones
+     *
+     * @returns The patched Share
+     */
+    patchShare(orgName, spaceName, shareId, patchObject, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}`), patchObject);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Resends share emails to **all recipients** associated with a share.
+     *
+     * This will trigger the backend to re-send the share notification email
+     * to every email address that has previously been invited to the share.
+     *
+     * @typeParam R - When `true`, the raw Axios response is returned instead of `undefined`
+     *
+     * @param orgName   - The organization identifier
+     * @param spaceName - The space identifier within the organization
+     * @param shareId   - The share ID whose emails should be resent
+     * @param raw       - Optional flag to return the raw Axios response
+     *
+     * @returns `undefined` by default, or the raw Axios response when `raw.raw` is `true`
+     */
+    resendAllEmails(orgName, spaceName, shareId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}/email/all`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Resends share emails to **specific recipients** for a share.
+     *
+     * Only the provided email addresses will receive a new share notification.
+     * At least one email address must be provided.
+     *
+     * @typeParam R - When `true`, the raw Axios response is returned instead of `undefined`
+     *
+     * @param orgName   - The organization identifier
+     * @param spaceName - The space identifier within the organization
+     * @param shareId   - The share ID whose emails should be resent
+     * @param emails    - A non-empty list of email addresses to resend the share to
+     * @param raw       - Optional flag to return the raw Axios response
+     *
+     * @returns `undefined` by default, or the raw Axios response when `raw.raw` is `true`
+     */
+    resendEmails(orgName, spaceName, shareId, emails, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/shares/${shareId}/email`), { emails });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+}
+exports.CosmoShare = CosmoShare;

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

@@ -0,0 +1,131 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { High5SpaceInfo, CosmoSpace as ICosmoSpace, SpaceUser, TrashPolicy } from "../../../interfaces/cosmo/space";
+/**
+ * @class Space
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Space resource in Cosmo, providing methods to interact with the Space API.
+ */
+export declare class CosmoSpace extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Create a new Space in the specified Organization.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param noAvatar Optional flag to create the Space without an avatar
+     * @returns The created Space
+     */
+    createSpace<R extends boolean = false>(orgName: string, spaceName: string, noAvatar?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * List spaces of an Organization.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param limit Maximum number of Spaces to return
+     * @param page Page number for pagination
+     * @returns A list of Spaces in the Organization
+     */
+    listSpaces<R extends boolean = false>(orgName: string, limit: number, page: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace[]>>;
+    /**
+     * Fetch a single space by its Name.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space to fetch
+     * @returns The requested Space
+     */
+    getSpace<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * Delete a Space by it's Name.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space to delete
+     * @returns 204 No Content on success
+     */
+    deleteSpace<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Rename a Space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param newName New name for the Space
+     * @returns The updated Space
+     */
+    renameSpace<R extends boolean = false>(orgName: string, spaceName: string, newName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * Link a high5 space to a cosmo space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @param high5SpaceInfo Information about the high5 space
+     * @returns The updated Cosmo Space
+     */
+    linkSpace<R extends boolean = false>(orgName: string, spaceName: string, high5SpaceInfo: High5SpaceInfo, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * Link a high5 space to a cosmo space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @param high5SpaceInfo Information about the high5 space
+     * @returns The updated Cosmo Space
+     */
+    unlinkSpace<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * List all users with access to the given Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @returns The SpaceUser array
+     */
+    listSpaceUsers<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, SpaceUser[]>>;
+    /**
+     * Updates the avatar of the specified Cosmo space
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param file Image as Javascript File
+     * @returns Space details with updated avatar
+     */
+    updateAvatar<R extends boolean = false>(orgName: string, spaceName: string, file: File, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+    /**
+     * Permanently deletes all items in the trash of the specified Cosmo space
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @returns 204 No Content on success
+     */
+    emptyTrash(orgName: string, spaceName: string): Promise<void>;
+    /**
+     * Updates the trashbin auto-delete policy for the specified Cosmo space.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param policy Trash policy to apply. When `enabled` is `true`, `ttlDays` (1–365) must be provided. When `enabled` is `false`, `ttlDays` must be omitted.
+     * @returns The updated Space
+     */
+    updateTrashbinPolicy<R extends boolean = false>(orgName: string, spaceName: string, policy: TrashPolicy, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoSpace>>;
+}

package/lib/service/cosmo/space/index.js

@@ -0,0 +1,190 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosmoSpace = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+/**
+ * @class Space
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Space resource in Cosmo, providing methods to interact with the Space API.
+ */
+class CosmoSpace extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * Create a new Space in the specified Organization.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param noAvatar Optional flag to create the Space without an avatar
+     * @returns The created Space
+     */
+    createSpace(orgName, spaceName, noAvatar, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces?noAvatar=${noAvatar ? "true" : "false"}`), {
+                name: spaceName,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * List spaces of an Organization.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param limit Maximum number of Spaces to return
+     * @param page Page number for pagination
+     * @returns A list of Spaces in the Organization
+     */
+    listSpaces(orgName, limit, page, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces?limit=${limit}&page=${page}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Fetch a single space by its Name.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space to fetch
+     * @returns The requested Space
+     */
+    getSpace(orgName, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Delete a Space by it's Name.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space to delete
+     * @returns 204 No Content on success
+     */
+    deleteSpace(orgName, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Rename a Space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param newName New name for the Space
+     * @returns The updated Space
+     */
+    renameSpace(orgName, spaceName, newName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/name`), {
+                name: newName,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Link a high5 space to a cosmo space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @param high5SpaceInfo Information about the high5 space
+     * @returns The updated Cosmo Space
+     */
+    linkSpace(orgName, spaceName, high5SpaceInfo, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/high5/link/space`), high5SpaceInfo);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Link a high5 space to a cosmo space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @param high5SpaceInfo Information about the high5 space
+     * @returns The updated Cosmo Space
+     */
+    unlinkSpace(orgName, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/high5/unlink/space`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * List all users with access to the given Space.
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Cosmo Space
+     * @returns The SpaceUser array
+     */
+    listSpaceUsers(orgName, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/users`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Updates the avatar of the specified Cosmo space
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param file Image as Javascript File
+     * @returns Space details with updated avatar
+     */
+    updateAvatar(orgName, spaceName, file, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const data = new FormData();
+            data.append("avatar", file);
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/avatar`), data, {
+                headers: { "Content-Type": "multipart/form-data" },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Permanently deletes all items in the trash of the specified Cosmo space
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @returns 204 No Content on success
+     */
+    emptyTrash(orgName, spaceName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/trash`));
+        });
+    }
+    /**
+     * Updates the trashbin auto-delete policy for the specified Cosmo space.
+     * @param orgName Name of the organization
+     * @param spaceName Name of the space
+     * @param policy Trash policy to apply. When `enabled` is `true`, `ttlDays` (1–365) must be provided. When `enabled` is `false`, `ttlDays` must be omitted.
+     * @returns The updated Space
+     */
+    updateTrashbinPolicy(orgName, spaceName, policy, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/trash/policy`), policy);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+}
+exports.CosmoSpace = CosmoSpace;

package/lib/service/cosmo/stats/index.d.ts

@@ -0,0 +1,35 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { ICosmoStats } from "../../../interfaces/cosmo/stats";
+/**
+ * @class Space
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Stats resource in Cosmo, providing get methods to retrieve statistics with the Stats API.
+ */
+export declare class CosmoStats extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Fetch org related stats
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @returns The requested org stats
+     */
+    getOrgStats<R extends boolean = false>(orgName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoStats>>;
+    /**
+     * Fetch space related stats
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @returns The requested space stats
+     */
+    getSpaceStats<R extends boolean = false>(orgName: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoStats>>;
+}

package/lib/service/cosmo/stats/index.js

@@ -0,0 +1,58 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CosmoStats = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+/**
+ * @class Space
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Stats resource in Cosmo, providing get methods to retrieve statistics with the Stats API.
+ */
+class CosmoStats extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * Fetch org related stats
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @returns The requested org stats
+     */
+    getOrgStats(orgName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Fetch space related stats
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @returns The requested space stats
+     */
+    getSpaceStats(orgName, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+}
+exports.CosmoStats = CosmoStats;