hcloud-sdk 18.0.0 → 19.1.0

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

@@ -0,0 +1,117 @@
+"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.AgentLogging = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+class AgentLogging extends Base_1.default {
+    /**
+     * Retrieves a list of all currently registered and connected external logging destinations.
+     * @returns List of active external log collector configurations
+     */
+    getLogCollectors(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/log/collectors`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Registers a new external destination and initializes a persistent Winston HTTP transport for log forwarding.
+     * @param collector - The configuration for the new log collector
+     * @returns The newly created log collector details
+     */
+    addLogCollector(collector, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/log/collectors`), collector);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Retrieves configuration and status information for a specific external log collector by its name.
+     * @param name - Unique identifier of the external log collector
+     * @returns The requested log collector details
+     */
+    getLogCollector(name, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/log/collectors/${name}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Removes an external log destination and immediately terminates the associated Winston transport.
+     * @param name - Unique identifier of the external log collector to be deleted
+     * @returns void (or raw response)
+     */
+    deleteLogCollector(name, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/log/collectors/${name}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Updates the activation status of a specific log collector,
+     * this toggles log forwarding to the destination without removing its configuration.
+     * @param name - Unique identifier of the external log collector
+     * @param enabled - Flag to enable or disable the collector
+     * @returns The updated log collector details
+     */
+    patchLogCollectorEnabled(name, enabled, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.patch(this.getEndpoint(`/v1/log/collectors/${name}/enabled`), { enabled });
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Registers and initializes a new Amazon CloudWatch transport for log forwarding
+     * @param options - AWS credentials and CloudWatch group/stream configuration
+     * @returns The registered CloudWatch collector details
+     */
+    addCloudWatch(options, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/log/cloudwatch`), options);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Removes the Amazon CloudWatch logging destination and terminates its Winston transport
+     * @returns void (or raw response)
+     */
+    deleteCloudWatch(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/log/cloudwatch`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Establishes a persistent Server-Sent Events (SSE) connection to stream logs in real-time.
+     * Note: This method returns the raw Axios response because SSE requires stream handling.
+     * @param level - Optional filter by severity level
+     * @param entity - Optional filter by originating component
+     * @returns Raw response with the event stream
+     */
+    streamLogs(level, entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.axios.get(this.getEndpoint(`/v1/logs`), {
+                params: { level, entity },
+                responseType: "stream",
+                headers: {
+                    Accept: "text/event-stream",
+                },
+            });
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/agent${endpoint}`;
+    }
+}
+exports.AgentLogging = AgentLogging;

package/lib/service/agent/module/index.d.ts

@@ -0,0 +1,36 @@
+import Base, { MaybeRaw } from "../../../Base";
+import { ModuleDto } from "../../../interfaces/agent/module";
+export declare class AgentModule extends Base {
+    /**
+     * Retrieves a list of all loaded modules available in the agent.
+     * @returns A list of modules metadata
+     */
+    listModules<R extends boolean = false>(raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ModuleDto[]>>;
+    /**
+     * Creates a new module template based on the received metadata.
+     * @param module - Metadata for the new module template
+     * @returns Newly created module data
+     */
+    addModule<R extends boolean = false>(module: ModuleDto, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ModuleDto>>;
+    /**
+     * Retrieves detailed information about a specific module by its name.
+     * @param modName - Unique name identifier of the module
+     * @returns Requested module details
+     */
+    getModule<R extends boolean = false>(modName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, ModuleDto>>;
+    /**
+     * Removes the module from the agent by its name.
+     * @param modName - Unique name identifier of the module to be deleted
+     * @returns void (or raw response)
+     */
+    deleteModule<R extends boolean = false>(modName: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    protected getEndpoint(endpoint: string): string;
+}

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

@@ -0,0 +1,65 @@
+"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.AgentModule = void 0;
+const Base_1 = __importDefault(require("../../../Base"));
+class AgentModule extends Base_1.default {
+    /**
+     * Retrieves a list of all loaded modules available in the agent.
+     * @returns A list of modules metadata
+     */
+    listModules(raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/management/modules`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Creates a new module template based on the received metadata.
+     * @param module - Metadata for the new module template
+     * @returns Newly created module data
+     */
+    addModule(module, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.post(this.getEndpoint(`/v1/management/modules`), module);
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Retrieves detailed information about a specific module by its name.
+     * @param modName - Unique name identifier of the module
+     * @returns Requested module details
+     */
+    getModule(modName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.get(this.getEndpoint(`/v1/management/modules/${modName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    /**
+     * Removes the module from the agent by its name.
+     * @param modName - Unique name identifier of the module to be deleted
+     * @returns void (or raw response)
+     */
+    deleteModule(modName, raw) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.delete(this.getEndpoint(`/v1/management/modules/${modName}`));
+            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
+        });
+    }
+    getEndpoint(endpoint) {
+        return `${this.options.server}/api/agent${endpoint}`;
+    }
+}
+exports.AgentModule = AgentModule;

package/lib/service/auditor/index.js

@@ -8,8 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 });
-const Base_1 = require("../../Base");
+const Base_1 = __importDefault(require("../../Base"));
 const paginatedResponseHelper_1 = require("../../helper/paginatedResponseHelper");
 const searchFilter_1 = require("../../helper/searchFilter");
 const internal_1 = require("./internal");

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

@@ -8,9 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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.AuditorInternal = void 0;
-const Base_1 = require("../../../Base");
+const Base_1 = __importDefault(require("../../../Base"));
 class AuditorInternal extends Base_1.default {
     constructor() {
         var _a, _b;

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

@@ -8,8 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 });
-const Base_1 = require("../../../Base");
+const Base_1 = __importDefault(require("../../../Base"));
 class BouncerFeatures extends Base_1.default {
     constructor(options, axios) {
         super(options, axios);

package/lib/service/bouncer/index.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Base_1 = require("../../Base");
-const features_1 = require("./features");
+const Base_1 = __importDefault(require("../../Base"));
+const features_1 = __importDefault(require("./features"));
 class Bouncer extends Base_1.default {
     get features() {
         if (this._features === undefined) {

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

@@ -1,7 +1,6 @@
 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";
+import { Asset, AssetPermission, CreateAsset, Mentionable, PatchAsset, Resolution, SubscriptionFilter, Upload, VTTThumbnail } from "../../../interfaces/cosmo/asset";
 /**
  * @class Asset
  * @extends Base
@@ -155,6 +154,15 @@ export declare class CosmoAsset extends Base {
     fetchAssetActivity<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, limit: number, page: number, raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, AuditLog[]>>;
+    /**
+     * 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<R extends boolean = false>(url: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, VTTThumbnail[]>>;
     /**
      * Rename an asset.
      * @remarks
@@ -215,5 +223,43 @@ export declare class CosmoAsset extends Base {
      */
     listUsersAllowedToMention<R extends boolean = false>(orgName: string, spaceName: string, assetId: string, limit?: number, page?: number, raw?: {
         raw: R;
-    }): Promise<MaybeRaw<R, ReducedUser[]>>;
+    }): Promise<MaybeRaw<R, Mentionable[]>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, assetIds: string[], parentId?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, Asset[]>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, assetId?: string, filters?: SubscriptionFilter[], raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
+    /**
+     * 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<R extends boolean = false>(orgName: string, spaceName: string, assetId?: string, raw?: {
+        raw: R;
+    }): Promise<MaybeRaw<R, void>>;
 }

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

@@ -8,9 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 = require("../../../Base");
+const Base_1 = __importDefault(require("../../../Base"));
+const axios_1 = require("../../../interfaces/axios");
 /**
  * @class Asset
  * @extends Base
@@ -223,6 +227,52 @@ class CosmoAsset extends Base_1.default {
             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
@@ -302,13 +352,69 @@ class CosmoAsset extends Base_1.default {
     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,
-                },
+                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

@@ -1,5 +1,5 @@
 import Base, { MaybeRaw } from "../../../Base";
-import { Comment, CreateComment, EditComment, Reply } from "../../../interfaces/cosmo/comment";
+import { Comment, CommentSortDirection, CommentSortField, CreateComment, EditComment, Reply } from "../../../interfaces/cosmo/comment";
 /**
  * @class Comment
  * @extends Base
@@ -32,16 +32,21 @@ export declare class CosmoComment extends Base {
      * @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
+     * @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 sortField Field to sort comments by
+     * @param sortDirection Sort direction for comments
+     * @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>(orgName: string, spaceName: string, namespaceName: string, refId: string, limit?: number, page?: number, annotation?: boolean, replySample?: number, raw?: {
+    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, sortField?: CommentSortField, sortDirection?: CommentSortDirection, accept?: A, raw?: {
         raw: R;
-    }): Promise<MaybeRaw<R, Comment[]>>;
+    }): Promise<A extends "application/mediacomposer+xml" | "application/fcp+xml" | "text/edl" ? ArrayBuffer : MaybeRaw<R, Comment[]>>;
     /**
      * Edit a Comment
      * @remarks
@@ -87,36 +92,4 @@ export declare class CosmoComment extends Base {
     deleteComment<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentIds: string[], raw?: {
         raw: R;
     }): Promise<MaybeRaw<R, void>>;
-    /**
-     * Edit a Comments text
-     * @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 text New text for the Comment
-     * @param annotation Whether to include annotations in the response
-     *
-     * @returns The edited Comment
-     */
-    editCommentText<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentId: string, text: string, annotation?: boolean, raw?: {
-        raw: R;
-    }): Promise<MaybeRaw<R, Comment | Reply>>;
-    /**
-     * Edit a Comments annotation
-     * @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 newAnnotationContent New annotation for the Comment
-     * @param annotation Whether to include annotations in the response
-     *
-     * @returns The edited Comment
-     */
-    editCommentAnnotation<R extends boolean = false>(orgName: string, spaceName: string, namespaceName: string, commentId: string, newAnnotationContent: string, annotation?: boolean, raw?: {
-        raw: R;
-    }): Promise<MaybeRaw<R, Comment | Reply>>;
 }

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

@@ -8,9 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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 = require("../../../Base");
+const Base_1 = __importDefault(require("../../../Base"));
 /**
  * @class Comment
  * @extends Base
@@ -48,18 +51,30 @@ class CosmoComment extends Base_1.default {
      * @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
+     * @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 sortField Field to sort comments by
+     * @param sortDirection Sort direction for comments
+     * @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, raw) {
+        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, refId, limit, page, annotation = false, replySample = 0, sortField, sortDirection, accept, raw) {
             limit = limit !== null && limit !== void 0 ? limit : 100;
             page = page !== null && page !== void 0 ? page : 0;
-            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}`));
+            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}${sortField !== undefined ? `&sort_field=${sortField}` : ""}${sortDirection !== undefined ? `&sort_direction=${sortDirection}` : ""}`), 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);
         });
     }
@@ -119,43 +134,5 @@ class CosmoComment extends Base_1.default {
             return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : undefined);
         });
     }
-    /**
-     * Edit a Comments text
-     * @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 text New text for the Comment
-     * @param annotation Whether to include annotations in the response
-     *
-     * @returns The edited Comment
-     */
-    editCommentText(orgName_1, spaceName_1, namespaceName_1, commentId_1, text_1) {
-        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, commentId, text, annotation = false, raw) {
-            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments/${commentId}?annotation=${annotation}`), { text: text });
-            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
-        });
-    }
-    /**
-     * Edit a Comments annotation
-     * @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 newAnnotationContent New annotation for the Comment
-     * @param annotation Whether to include annotations in the response
-     *
-     * @returns The edited Comment
-     */
-    editCommentAnnotation(orgName_1, spaceName_1, namespaceName_1, commentId_1, newAnnotationContent_1) {
-        return __awaiter(this, arguments, void 0, function* (orgName, spaceName, namespaceName, commentId, newAnnotationContent, annotation = false, raw) {
-            const resp = yield this.axios.patch(this.getEndpoint(`/v1/org/${orgName}/spaces/${spaceName}/namespaces/${namespaceName}/comments/${commentId}?annotation=${annotation}`), { annotation: newAnnotationContent });
-            return ((raw === null || raw === void 0 ? void 0 : raw.raw) ? resp : resp.data);
-        });
-    }
 }
 exports.CosmoComment = CosmoComment;