hcloud-sdk 17.0.0 → 18.0.0

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

@@ -0,0 +1,131 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { DetailedRole, Permission, PermissionDiscovery, Role } from "../../../interfaces/cosmo/permissions";
+import { SearchFilter, Sorting } from "../../../interfaces/global";
+export declare class CosmoPermissions extends Base {
+    /**
+     * Fetches a list of all available permissions that can be assigned to roles.
+     *
+     * @returns A promise resolving to the permission discovery metadata.
+     */
+    listAllPermissions<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PermissionDiscovery>>;
+    /**
+     * Creates a new role within a specified organization and space.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleName - The name of the new role.
+     * @param permissions - A record of resource keys to arrays of permission names.
+     * @returns A promise resolving to the created role object.
+     */
+    createRole<R extends boolean = false>(orgName: string, spaceName: string, roleName: string, permissions: Record<string, Permission["name"][]>, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Role>>;
+    /**
+     * Searches for roles within a space based on filters, sorting, and pagination.
+     *
+     * @param options - An object containing search parameters.
+     * @param options.orgName - The name of the organization.
+     * @param options.spaceName - The name of the space.
+     * @param options.filters - Optional array of search filters.
+     * @param options.sorting - Optional sorting criteria.
+     * @param options.limit - Optional limit for pagination.
+     * @param options.page - Optional page number for pagination.
+     * @returns A promise resolving to a list of matching role objects.
+     */
+    searchRoles<R extends boolean = false>({ orgName, spaceName, filters, sorting, limit, page, }: {
+        orgName: string;
+        spaceName: string;
+        filters?: SearchFilter[];
+        sorting?: Sorting;
+        limit?: number;
+        page?: number;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Role[]>>;
+    /**
+     * Updates an existing role's name and permissions.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to update.
+     * @param newName - The new name for the role.
+     * @param permissions - The updated permissions mapping.
+     * @returns A promise resolving to the updated role.
+     */
+    updateRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, newName: string, permissions: Record<string, Permission["name"][]>, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Role>>;
+    /**
+     * Fetches detailed information about a specific role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to retrieve.
+     * @returns A promise resolving to the detailed role object.
+     */
+    fetchRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, DetailedRole>>;
+    /**
+     * Deletes a role by its ID.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to delete.
+     * @returns A promise that resolves when the role is deleted.
+     */
+    deleteRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, DetailedRole>>;
+    /**
+     * Assigns a user to a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param userId - The ID of the user to assign.
+     * @returns A promise that resolves when the assignment is complete.
+     */
+    assignUserToRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, userId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Unassigns a user from a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param userId - The ID of the user to unassign.
+     * @returns A promise that resolves when the user is removed.
+     */
+    unassignUserFromRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, userId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Assigns a team to a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param teamName - The name of the team to assign.
+     * @returns A promise that resolves when the assignment is complete.
+     */
+    assignTeamToRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, teamName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Unassigns a team from a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param teamName - The name of the team to unassign.
+     * @returns A promise that resolves when the team is removed.
+     */
+    unassignTeamFromRole<R extends boolean = false>(orgName: string, spaceName: string, roleId: string, teamName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,181 @@
+"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.CosmoPermissions = void 0;
+const Base_1 = require("../../../Base");
+class CosmoPermissions extends Base_1.default {
+    /**
+     * Fetches a list of all available permissions that can be assigned to roles.
+     *
+     * @returns A promise resolving to the permission discovery metadata.
+     */
+    listAllPermissions(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.get(`/v1/permissions/discovery`);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Creates a new role within a specified organization and space.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleName - The name of the new role.
+     * @param permissions - A record of resource keys to arrays of permission names.
+     * @returns A promise resolving to the created role object.
+     */
+    createRole(orgName, spaceName, roleName, permissions, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles`), {
+                name: roleName,
+                permissions,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Searches for roles within a space based on filters, sorting, and pagination.
+     *
+     * @param options - An object containing search parameters.
+     * @param options.orgName - The name of the organization.
+     * @param options.spaceName - The name of the space.
+     * @param options.filters - Optional array of search filters.
+     * @param options.sorting - Optional sorting criteria.
+     * @param options.limit - Optional limit for pagination.
+     * @param options.page - Optional page number for pagination.
+     * @returns A promise resolving to a list of matching role objects.
+     */
+    searchRoles(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ orgName, spaceName, filters, sorting, limit, page, }, raw) {
+            const res = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/search`), {
+                filters,
+                sorting,
+            }, {
+                params: {
+                    limit,
+                    page,
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Updates an existing role's name and permissions.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to update.
+     * @param newName - The new name for the role.
+     * @param permissions - The updated permissions mapping.
+     * @returns A promise resolving to the updated role.
+     */
+    updateRole(orgName, spaceName, roleId, newName, permissions, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}`), {
+                name: newName,
+                permissions,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Fetches detailed information about a specific role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to retrieve.
+     * @returns A promise resolving to the detailed role object.
+     */
+    fetchRole(orgName, spaceName, roleId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
+        });
+    }
+    /**
+     * Deletes a role by its ID.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role to delete.
+     * @returns A promise that resolves when the role is deleted.
+     */
+    deleteRole(orgName, spaceName, roleId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Assigns a user to a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param userId - The ID of the user to assign.
+     * @returns A promise that resolves when the assignment is complete.
+     */
+    assignUserToRole(orgName, spaceName, roleId, userId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}/user`), { userId });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Unassigns a user from a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param userId - The ID of the user to unassign.
+     * @returns A promise that resolves when the user is removed.
+     */
+    unassignUserFromRole(orgName, spaceName, roleId, userId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}/user/${userId}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Assigns a team to a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param teamName - The name of the team to assign.
+     * @returns A promise that resolves when the assignment is complete.
+     */
+    assignTeamToRole(orgName, spaceName, roleId, teamName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}/team`), { teamName });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Unassigns a team from a role.
+     *
+     * @param orgName - The name of the organization.
+     * @param spaceName - The name of the space.
+     * @param roleId - The ID of the role.
+     * @param teamName - The name of the team to unassign.
+     * @returns A promise that resolves when the team is removed.
+     */
+    unassignTeamFromRole(orgName, spaceName, roleId, teamName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/roles/${roleId}/team/${teamName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+}
+exports.CosmoPermissions = CosmoPermissions;

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

@@ -0,0 +1,26 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { Asset } from "../../../interfaces/cosmo/asset";
+/**
+ * @class Production
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Production resource in Cosmo, providing methods to interact with the Production API.
+ */
+export declare class CosmoProduction extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Create a new Production 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 productionName Name of the Production to create
+     * @returns The created Production
+     */
+    createProduction<R extends boolean = false>(orgName: string, spaceName: string, productionName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+}

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

@@ -0,0 +1,45 @@
+"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.CosmoProduction = void 0;
+const Base_1 = require("../../../Base");
+/**
+ * @class Production
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Production resource in Cosmo, providing methods to interact with the Production API.
+ */
+class CosmoProduction extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * Create a new Production 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 productionName Name of the Production to create
+     * @returns The created Production
+     */
+    createProduction(orgName, spaceName, productionName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/productions`), {
+                name: productionName,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+}
+exports.CosmoProduction = CosmoProduction;

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

@@ -0,0 +1,161 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { Asset } from "../../../interfaces/cosmo/asset";
+import { Share, ShareCreate, SharePatch, ShareWithUsers } from "../../../interfaces/cosmo/share";
+import { SearchFilter, Sorting } from "../../../interfaces/global";
+/**
+ * @class Share
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Share resource in Cosmo, providing methods to interact with the Share API.
+ */
+export declare class CosmoShare extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, createShare: ShareCreate, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, password?: string, shareIdHMAC?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share>>;
+    /**
+     * Fetch shared Assets.
+     * @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
+     * @param limit The number of assets to return
+     * @param page The page number to return
+     * @param namespace The namespace to filter by
+     *
+     * @returns The created Share
+     */
+    fetchSharedAssets<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, limit: number, page: number, namespace: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset[]>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareIds: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, search: {
+        sorting?: Sorting;
+        filters?: SearchFilter[];
+    }, limit: number, page: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ShareWithUsers[]>>;
+    /**
+     * 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<R extends boolean = false>(search: {
+        sorting?: Sorting;
+        filters?: SearchFilter[];
+    }, limit: number, page: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share[]>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, userId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Links one or more users (by email) to 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 link to.
+     * @param {string[]} emails - An array of email addresses to link to the share.
+     * @returns {Promise<Share>} A promise that resolves to the updated share object.
+     */
+    linkOther<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, emails: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, shareId: string, patchObject: SharePatch, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Share>>;
+}