hcloud-sdk 17.0.0 → 19.0.0

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

@@ -0,0 +1,420 @@
+"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.CosmoAsset = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+const axios_1 = require("../../../interfaces/axios");
+/**
+ * @class Asset
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents an Asset resource in Cosmo, providing methods to interact with the Asset API.
+ */
+class CosmoAsset extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * 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(orgName, spaceName, createAsset, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets`), createAsset);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName_1, spaceName_1, assetIdList_1, newParentId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, assetIdList, newParentId, copy = false, raw) {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/bulk-move-copy`), {
+                assetIds: assetIdList,
+                parentId: newParentId,
+                copy: copy,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetId, locationId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/location`), {
+                locationId: locationId,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetId, patchAsset, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}`), patchAsset);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName_1, spaceName_1, assetId_1, namespace_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, assetId, namespace, includePermissions = false, raw) {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}`), {
+                params: {
+                    namespace,
+                    permissions: includePermissions ? "true" : "false",
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetIds, force, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets`), {
+                data: { assetIds },
+                params: { force },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetIdList, resolution, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/downloadUrls`), {
+                assetIds: assetIdList,
+                resolution: resolution,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(token, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/assets/upload?${token}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetIdList, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/trash`), {
+                assetIds: assetIdList,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetIdList, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/permissions`), {
+                assetIds: assetIdList,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetId, limit, page, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/activity`), {
+                params: {
+                    limit,
+                    page,
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Fetches an assets VTT file and parses it to return an array of VTTThumbnail objects.
+     *
+     * @param {string} url - The URL of the VTT file to fetch and parse.
+     * @returns {Promise<VTTThumbnail[]>} A promise that resolves to an array of `VTTThumbnail` objects representing the asset’s thumbnails.
+     */
+    fetchAndParseAssetVTT(url, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const resp = yield this.axios.get(url, {
+                headers: Object.assign(Object.assign({}, axios_1.disableCacheHeaders), { Authorization: undefined }),
+            });
+            const parseTimestamp = (ts) => {
+                const parts = ts.split(":").map(Number);
+                if (parts.length === 3) {
+                    return parts[0] * 3600 + parts[1] * 60 + parts[2];
+                }
+                return parts[0] * 60 + parts[1];
+            };
+            const lines = resp.data.split(/\r?\n/);
+            const thumbnails = [];
+            for (let i = 0; i < lines.length; i++) {
+                const timeMatch = lines[i].match(/(\d{2}:\d{2}:\d{2}\.\d{3})\s-->\s(\d{2}:\d{2}:\d{2}\.\d{3})/);
+                if (timeMatch) {
+                    const start = parseTimestamp(timeMatch[1]);
+                    const end = parseTimestamp(timeMatch[2]);
+                    const imageLine = (_a = lines[i + 1]) === null || _a === void 0 ? void 0 : _a.trim();
+                    if (!imageLine)
+                        continue;
+                    const [url, fragment] = imageLine.split("#");
+                    let xywh = undefined;
+                    if (fragment === null || fragment === void 0 ? void 0 : fragment.startsWith("xywh=")) {
+                        const [x, y, w, h] = fragment.replace("xywh=", "").split(",").map(Number);
+                        xywh = { x, y, w, h };
+                    }
+                    thumbnails.push({
+                        start,
+                        end,
+                        url,
+                        xywh,
+                    });
+                }
+            }
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : thumbnails);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetId, newName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/name`), {
+                name: newName,
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetIdList, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/trash`), {
+                data: {
+                    assetIds: assetIdList,
+                },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, namespaceName, assetId, tagName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/assets/${assetId}/tags/${tagName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, namespaceName, assetId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/assets/${assetId}/tags`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * 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(orgName, spaceName, assetId, limit, page, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/users`), {
+                params: { limit, page },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Clone one or more assets within a space.
+     *
+     * This operation creates copies of the specified assets in the same organization and space.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetIds List of Asset IDs to be cloned. If folder IDs are specified, they will be recursively cloned.
+     * @param parentId (optional) Id of parent asset of the newly cloned asset. If undefined will default to space as parent.
+     * @returns The cloned assets
+     */
+    cloneAsset(orgName, spaceName, assetIds, parentId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/clone`), { assetIds, parentId });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Subscribe to notifications for a specific asset or all assets in a space.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId (optional) ID of the Asset to subscribe to. If not provided, subscribes to the space.
+     * @param filters (optional) Subscription configuration. If 'filters' is omitted or empty, all notification types will be sent.
+     * @param raw
+     * @returns 204 No Content if successful
+     */
+    subscribe(orgName, spaceName, assetId, filters, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let resp;
+            if (assetId) {
+                resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/subscribe`), { filters });
+            }
+            else {
+                resp = yield this.axios.put(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/subscribe`), { filters });
+            }
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Unsubscribe from notifications for a specific asset or all assets in a space.
+     *
+     * @param orgName Name of the Organization
+     * @param spaceName Name of the Space
+     * @param assetId (optional) ID of the Asset to unsubscribe from. If not provided, unsubscribes from the space.
+     * @returns 204 No Content if successful
+     */
+    unsubscribe(orgName, spaceName, assetId, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let resp;
+            if (assetId) {
+                resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/${assetId}/subscribe`));
+            }
+            else {
+                resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/assets/subscribe`));
+            }
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+}
+exports.CosmoAsset = CosmoAsset;

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

@@ -0,0 +1,93 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { Comment, CreateComment, EditComment, Reply } from "../../../interfaces/cosmo/comment";
+/**
+ * @class Comment
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Comment resource in Cosmo, providing methods to interact with the Comment API.
+ */
+export declare class CosmoComment extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Create a new Comment in the specified Organization, Space and Namespace for a specific Asset Reference.
+     * @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 comment Content of the Comment to create
+     * @param annotation Whether to include annotations in the response
+     * @returns The created Comment
+     */
+    createComment<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, comment: CreateComment, annotation?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Comment | Reply>>;
+    /**
+     * List Comments
+     * @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 limit Maximum number of comments to return, user -1 for no limit
+     * @param page Page number for pagination
+     * @param annotation Whether to include annotations in the response
+     * @param replySample Amount of replies to load
+     * @param accept The Accept header value, either "application/json" (comments response as json)
+     *                  or "application/mediacomposer+xml" (comments response as media composer xml as download)
+     *                  or "application/fcp+xml" (comments response as fcp xml as download => i.e. for Adobe Premiere Pro)
+     *                  or "text/edl" (comments response as edl as download => i.e. for Davinci Resolve)
+     * @returns A list of Comments
+     */
+    listComments<R extends boolean = false, A extends string = "application/json">(orgName: string, spaceName: string, namespaceName: string, refId: string, limit?: number, page?: number, annotation?: boolean, replySample?: number, accept?: A, raw?: {
+        raw: R;
+    }): Promise<A extends "application/mediacomposer+xml" | "application/fcp+xml" | "text/edl" ? ArrayBuffer : MaybeRaw<R, Comment[]>>;
+    /**
+     * Edit a Comment
+     * @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 commentId ID of the Comment to edit
+     * @param editComment Content of the Comment to edit
+     * @param annotation Whether to include annotations in the response
+     *
+     * @returns The edited Comment
+     */
+    editComment<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentId: string, editComment: EditComment, annotation?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Comment | Reply>>;
+    /**
+     * Get a single Comment by ID
+     * @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 commentId ID of the Comment to edit
+     * @param annotation Whether to include annotations in the response
+     *
+     * @returns The requested Comment
+     */
+    getComment<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentId: string, annotation?: boolean, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Comment | Reply>>;
+    /**
+     * Delete Comments by ID
+     * @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 commentIds IDs of the Comments to delete
+     *
+     * @returns 204 No Content on success
+     */
+    deleteComment<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentIds: string[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+}

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

@@ -0,0 +1,136 @@
+"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.CosmoComment = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+/**
+ * @class Comment
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Comment resource in Cosmo, providing methods to interact with the Comment API.
+ */
+class CosmoComment extends Base_1.default {
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/cosmo${endpoint}`;
+    }
+    /**
+     * Create a new Comment in the specified Organization, Space and Namespace for a specific Asset Reference.
+     * @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 comment Content of the Comment to create
+     * @param annotation Whether to include annotations in the response
+     * @returns The created Comment
+     */
+    createComment(orgName_1, spaceName_1, namespaceName_1, comment_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, comment, annotation = false, raw) {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments?annotation=${annotation}`), comment);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * List Comments
+     * @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 limit Maximum number of comments to return, user -1 for no limit
+     * @param page Page number for pagination
+     * @param annotation Whether to include annotations in the response
+     * @param replySample Amount of replies to load
+     * @param accept The Accept header value, either "application/json" (comments response as json)
+     *                  or "application/mediacomposer+xml" (comments response as media composer xml as download)
+     *                  or "application/fcp+xml" (comments response as fcp xml as download => i.e. for Adobe Premiere Pro)
+     *                  or "text/edl" (comments response as edl as download => i.e. for Davinci Resolve)
+     * @returns A list of Comments
+     */
+    listComments(orgName_1, spaceName_1, namespaceName_1, refId_1, limit_1, page_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, refId, limit, page, annotation = false, replySample = 0, accept, raw) {
+            limit = limit !== null && limit !== void 0 ? limit : 100;
+            page = page !== null && page !== void 0 ? page : 0;
+            const fileDownloadTypes = new Set(["application/mediacomposer+xml", "application/fcp+xml", "text/edl"]);
+            const isFileDownload = accept !== undefined && fileDownloadTypes.has(accept);
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments?limit=${limit}&page=${page}&annotation=${annotation}&refId=${refId}&replySample=${replySample}`), Object.assign({ headers: {
+                    Accept: accept !== null && accept !== void 0 ? accept : "application/json",
+                } }, (isFileDownload && { responseType: "arraybuffer" })));
+            if (isFileDownload) {
+                return resp.data;
+            }
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Edit a Comment
+     * @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 commentId ID of the Comment to edit
+     * @param editComment Content of the Comment to edit
+     * @param annotation Whether to include annotations in the response
+     *
+     * @returns The edited Comment
+     */
+    editComment(orgName_1, spaceName_1, namespaceName_1, commentId_1, editComment_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, commentId, editComment, annotation = false, raw) {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments/${commentId}?annotation=${annotation}`), editComment);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Get a single Comment by ID
+     * @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 commentId ID of the Comment to edit
+     * @param annotation Whether to include annotations in the response
+     *
+     * @returns The requested Comment
+     */
+    getComment(orgName_1, spaceName_1, namespaceName_1, commentId_1) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, commentId, annotation = false, raw) {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments/${commentId}?annotation=${annotation}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Delete Comments by ID
+     * @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 commentIds IDs of the Comments to delete
+     *
+     * @returns 204 No Content on success
+     */
+    deleteComment(orgName, spaceName, namespaceName, commentIds, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments`), {
+                data: { commentIds },
+            });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
+        });
+    }
+}
+exports.CosmoComment = CosmoComment;

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

@@ -0,0 +1,23 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { CosmoEvents as ICosmoEvents } from "../../../interfaces/cosmo/event";
+/**
+ * @class Event
+ * @extends Base
+ *
+ * @remarks
+ * **Under development, breaking changes possible**
+ *
+ * Represents a Event resource in Cosmo, providing methods to interact with the Event API.
+ */
+export declare class CosmoEvent extends Base {
+    protected getEndpoint(endpoint: string): string;
+    /**
+     * Get a list of Events available in Cosmo
+     * @remarks
+     * ** Under development, breaking changes possible**
+     * @returns An Object holding all cosmo events sorted
+     */
+    getCosmoEvents<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ICosmoEvents>>;
+}