hcloud-sdk 17.0.0 → 18.0.0

package/lib/service/agent/context/index.js

@@ -16,17 +16,17 @@ class AgentContext extends Base_1.default {
      * Retrieves all contexts.
      * @returns The requested contexts
      */
-    getContexts() {
+    getContexts(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint(`/v1/context`));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Add a new context.
      * @returns The newly created context
      */
-    addContext(server, email, token, enabled) {
+    addContext(server, email, token, enabled, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/context`), {
                 server,
@@ -34,28 +34,28 @@ class AgentContext extends Base_1.default {
                 token,
                 enabled,
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Add a new context by using a service accounts PAT token.
      * @returns The newly created context
      */
-    addServiceAccountContext(server, token, enabled) {
+    addServiceAccountContext(server, token, enabled, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.post(this.getEndpoint(`/v1/context`), {
                 server,
                 token: token.toLowerCase().startsWith("bearer") ? token : `Bearer ${token}`,
                 enabled,
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Update an existing context.
      * @returns The updated context
      */
-    updateContext(uuid, server, email, token, enabled) {
+    updateContext(uuid, server, email, token, enabled, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.patch(this.getEndpoint(`/v1/context/${uuid}`), {
                 server,
@@ -63,38 +63,39 @@ class AgentContext extends Base_1.default {
                 token,
                 enabled,
             });
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Get an existing context.
      * @returns The requested context
      */
-    getContext(uuid) {
+    getContext(uuid, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint(`/v1/context/${uuid}`));
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Delete a context.
      * @returns void
      */
-    deleteContext(uuid) {
+    deleteContext(uuid, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/context/${uuid}`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/context/${uuid}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
      * Patch the enabled property of a Context.
      * @returns Updated Context
      */
-    patchContextEnabled(uuid, enabled) {
+    patchContextEnabled(uuid, enabled, raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const res = yield this.axios.patch(this.getEndpoint(`/v1/context/${uuid}/enabled`), {
                 enabled,
             });
-            return res.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? res : res.data);
         });
     }
     getEndpoint(endpoint) {

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

@@ -1,4 +1,4 @@
-import Base from "../../Base";
+import Base, { MaybeRaw } from "../../Base";
 import { AuditLog } from "../../interfaces/auditor";
 import { PaginatedResponse, SearchParams, Version } from "../../interfaces/global";
 import { AuditorInternal } from "./internal";
@@ -8,7 +8,9 @@ export default class Auditor extends Base {
     /**
      * @returns An object containing the endpoint version as a string
      */
-    version(): Promise<Version>;
+    version<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Version>>;
     /**
      * Returns all audit logs for an organization which match the search filter
      * @param organizationName Name of the organization
@@ -18,8 +20,10 @@ export default class Auditor extends Base {
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
      * @returns Object containing an array of audit logs and the total number of results found in the database (independent of limit and page)
      */
-    searchAuditLogs({ organizationName, filters, sorting, limit, page, }: SearchParams & {
+    searchAuditLogs<R extends boolean = false>({ organizationName, filters, sorting, limit, page }: SearchParams & {
         organizationName: string;
-    }): Promise<PaginatedResponse<AuditLog>>;
+    }, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, PaginatedResponse<AuditLog>>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/auditor/index.js

@@ -23,10 +23,10 @@ class Auditor extends Base_1.default {
     /**
      * @returns An object containing the endpoint version as a string
      */
-    version() {
+    version(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint("/v1/version"), {});
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     /**
@@ -38,14 +38,14 @@ class Auditor extends Base_1.default {
      * @param page (optional) Page number: Skip the first (page * limit) results (defaults to 0)
      * @returns Object containing an array of audit logs and the total number of results found in the database (independent of limit and page)
      */
-    searchAuditLogs(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ organizationName, filters, sorting, limit = 25, page = 0, }) {
+    searchAuditLogs(_a, raw_1) {
+        return __awaiter(this, arguments, void 0, function* ({ organizationName, 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/${organizationName}/logs/search?page=${page}&limit=${limit}`), {
                 filters: filtersDTO,
                 sorting: sorting,
             });
-            return (0, paginatedResponseHelper_1.createPaginatedResponse)(resp);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? Object.assign(Object.assign({}, resp), { data: (0, paginatedResponseHelper_1.createPaginatedResponse)(resp) }) : (0, paginatedResponseHelper_1.createPaginatedResponse)(resp));
         });
     }
     getEndpoint(endpoint) {

package/lib/service/auditor/internal/index.d.ts

@@ -1,9 +1,9 @@
-import Base from "../../../Base";
+import Base, { MaybeRaw } from "../../../Base";
 import { AuditLogCreate } from "../../../interfaces/auditor";
 export declare class AuditorInternal extends Base {
     private queueExecutionInterval;
     private logQueue;
-    private logQueueTimer;
+    private logQueueInterval;
     /**
      * Adds log entries to a queue that will be processed periodically.
      *
@@ -22,6 +22,30 @@ export declare class AuditorInternal extends Base {
      * @param orgId the organizations's ID
      * @returns void
      */
-    deleteAllAuditLogsOfOrganization(orgId: string): Promise<void>;
+    deleteAllAuditLogsOfOrganization<R extends boolean = false>(orgId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Deletes all audit logs of an Asset by space
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgId the organizations's ID
+     * @param spaceName the Space's name
+     * @returns void
+     */
+    deleteAllAuditLogsOfSpace<R extends boolean = false>(orgId: string, spaceName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Deletes all audit logs of an Asset
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgId the organizations's ID
+     * @param assetId the Asset's ID
+     * @returns void
+     */
+    deleteAllAuditLogsOfAsset<R extends boolean = false>(orgId: string, assetId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/auditor/internal/index.js

@@ -29,15 +29,15 @@ class AuditorInternal extends Base_1.default {
      */
     queueAuditLogs(logs) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.logQueueTimer) {
+            if (!this.logQueueInterval) {
                 this.startQueue();
             }
             this.logQueue = this.logQueue.concat(logs);
         });
     }
     startQueue() {
-        if (!this.logQueueTimer) {
-            this.logQueueTimer = setTimeout(() => {
+        if (!this.logQueueInterval) {
+            this.logQueueInterval = setInterval(() => {
                 if (this.logQueue.length > 0) {
                     // DO NOT REMOVE THE IGNORE CATCH AS IT WOULD LEAD TO UNHANDLED PROMISE REJECTION IN OTHER ENDPOINTS AND THEIR CRASH
                     this.axios.post(this.getEndpoint("/v1/logs"), this.logQueue).catch(ignored => ignored);
@@ -53,9 +53,38 @@ class AuditorInternal extends Base_1.default {
      * @param orgId the organizations's ID
      * @returns void
      */
-    deleteAllAuditLogsOfOrganization(orgId) {
+    deleteAllAuditLogsOfOrganization(orgId, raw) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.axios.delete(this.getEndpoint(`/v1/org/${orgId}/logs`));
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgId}/logs`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Deletes all audit logs of an Asset by space
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgId the organizations's ID
+     * @param spaceName the Space's name
+     * @returns void
+     */
+    deleteAllAuditLogsOfSpace(orgId, spaceName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgId}/spaces/${spaceName}/logs`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * Deletes all audit logs of an Asset
+     *
+     * THIS IS AN INTERNAL ENDPOINT AND CAN ONLY BE USED FROM BACKENDS WITHIN THE HCLOUD DEPLOYMENT
+     * @param orgId the organizations's ID
+     * @param assetId the Asset's ID
+     * @returns void
+     */
+    deleteAllAuditLogsOfAsset(orgId, assetId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgId}/assets/${assetId}/logs`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
     getEndpoint(endpoint) {

package/lib/service/bouncer/features/index.d.ts

@@ -1,8 +1,10 @@
 import { AxiosInstance } from "axios";
-import Base, { Options } from "../../../Base";
+import Base, { MaybeRaw, Options } from "../../../Base";
 import { HcloudFeature } from "../../../interfaces/bouncer";
 export default class BouncerFeatures extends Base {
     constructor(options: Options, axios: AxiosInstance);
-    getHcloudFeatures(): Promise<HcloudFeature[]>;
+    getHcloudFeatures<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, HcloudFeature[]>>;
     protected getEndpoint(endpoint: string): string;
 }

package/lib/service/bouncer/features/index.js

@@ -14,10 +14,10 @@ class BouncerFeatures extends Base_1.default {
     constructor(options, axios) {
         super(options, axios);
     }
-    getHcloudFeatures() {
+    getHcloudFeatures(raw) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.axios.get(this.getEndpoint("/default.json"), {});
-            return resp.data;
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
         });
     }
     getEndpoint(endpoint) {

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

@@ -0,0 +1,219 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { AuditLog } from "../../../interfaces/auditor";
+import { Asset, AssetPermission, CreateAsset, PatchAsset, Resolution, Upload } from "../../../interfaces/cosmo/asset";
+import { ReducedUser } from "../../../interfaces/idp/user";
+/**
+ * @class Asset
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents an Asset resource in Cosmo, providing methods to interact with the Asset API.
+ */
+export declare class CosmoAsset extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Create a new Asset in Cosmo inside the specified Organization and Space.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param createAsset The Asset to be created
+     * @returns The created asset
+     */
+    createAsset<R extends boolean = false>(orgName: string, spaceName: string, createAsset: CreateAsset, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset & {
+        upload: Upload;
+    }>>;
+    /**
+     * Bulk move or copy multiple assets to a new parent.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param newParentId (optional) ID of the new parent Asset to which the assets will be moved. Assets will be moved to the root if not provided.
+     * @param assetIdList List of Asset IDs to be moved to trash
+     * @param copy Whether to copy (true) or move (false) the assets
+     * @returns The moved assets
+     */
+    bulkMove<R extends boolean = false>(orgName: string, spaceName: string, assetIdList: string[], newParentId?: string, copy?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset[]>>;
+    /**
+     * Attach an asset to a location.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId ID of the Asset to be attached
+     * @param locationId ID of the Location to which the Asset will be attached to
+     * @returns 204 No Content if successful
+     */
+    attachAssetToLocation<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, locationId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Patch an asset.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId ID of the Asset to be attached
+     * @param patchAsset The Asset to be patched
+     * @returns The patched asset
+     */
+    patchAsset<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, patchAsset: PatchAsset, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * Get an asset by its ID.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId ID of the Asset to be attached
+     * @param namespace Optional Namespaces of which information should be included in the returned object
+     * @param includePermissions Whether to include permissions in the result or not
+     * @returns The requested asset
+     */
+    getAsset<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, namespace?: string | string[], includePermissions?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * Delete multiple assets permanently by their IDs.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIds IDs of the Assets to delete
+     * @param force If asset is folder and force is set to false, it will only succeed if the folder is empty. If set to true, it will always succeed, but delete all children in the process
+     * @returns 204 No Content if successful
+     */
+    deleteAssets<R extends boolean = false>(orgName: string, spaceName: string, assetIds: string[], force?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * Request download URLs for multiple assets.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIdList List of Asset IDs for which download URLs are requested
+     * @param resolution The desired resolution for the download URLs
+     * @returns A map of Asset IDs to their download URLs
+     */
+    requestDownloadUrls<R extends boolean = false>(orgName: string, spaceName: string, assetIdList: string[], resolution: Resolution, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Record<string, string>>>;
+    /**
+     * Upload an asset.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * ** Check this endpoint for currency as it looks outdated.**
+     * @param token An upload token for the asset
+     * @returns The uploaded asset
+     */
+    uploadAsset<R extends boolean = false>(token: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * Move assets to the trash bin.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIdList List of Asset IDs to be moved to trash
+     * @returns The moved assets
+     */
+    moveAssetsToTrash<R extends boolean = false>(orgName: string, spaceName: string, assetIdList: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset[]>>;
+    /**
+     * Fetch permissions for a group of assets.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIdList List of Asset IDs to be moved to trash
+     * @returns A map of Asset IDs to their permissions
+     */
+    fetchAssetPermissions<R extends boolean = false>(orgName: string, spaceName: string, assetIdList: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Record<string, AssetPermission[]>>>;
+    /**
+     * Fetches the activity log for a specific asset within a given organization and space.
+     *
+     * @param {string} orgName - The name of the organization that owns the space.
+     * @param {string} spaceName - The name of the space containing the asset.
+     * @param {string} assetId - The unique identifier of the asset whose activity is being fetched.
+     * @param {number} limit - The maximum number of audit log entries to retrieve per page.
+     * @param {number} page - The page number to retrieve (for pagination).
+     * @returns {Promise<AuditLog[]>} A promise that resolves to an array of `AuditLog` objects representing the asset’s activity history.
+     */
+    fetchAssetActivity<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, limit: number, page: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, AuditLog[]>>;
+    /**
+     * Rename an asset.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId ID of the Asset to be renamed
+     * @returns The renamed asset
+     */
+    renameAsset<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, newName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * Move assets out of trash and therewith recover them.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIdList List of Asset IDs to be moved out of trash
+     * @returns The moved assets
+     */
+    moveAssetsOutOfTrash<R extends boolean = false>(orgName: string, spaceName: string, assetIdList: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset[]>>;
+    /**
+     * Attach a tag to an asset or replace an existing one.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param namespaceName Name of the namespace
+     * @param assetId ID of the Asset to be attached
+     * @param tagName Name of the tag
+     * @returns The updated asset
+     */
+    attachTagToAsset<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, assetId: string, tagName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * Remove a tag from an asset.
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param namespaceName Name of the Namespace
+     * @param assetId ID of the Asset to be attached
+     * @returns The updated asset
+     */
+    removeTagFromAsset<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, assetId: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset>>;
+    /**
+     * List users allowed to be mentioned in a comment of an asset.
+     * @param assetId ID of the Asset
+     * @param limit Maximum number of users to return
+     * @param page Page number for pagination
+     * @returns A list of users allowed to be mentioned in a comment of the asset
+     */
+    listUsersAllowedToMention<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, limit?: number, page?: number, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ReducedUser[]>>;
+}