frameio 0.1.0 → 1.1.4

package/README.md

@@ -3,7 +3,11 @@
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FFrameio%2Ftypescript-sdk)
 [![npm shield](https://img.shields.io/npm/v/frameio)](https://www.npmjs.com/package/frameio)
 
-The Frameio TypeScript library provides convenient access to the Frameio APIs from TypeScript.
+
+<img width="1644" alt="artboard_small" src="https://user-images.githubusercontent.com/19295862/66240171-ba8dd280-e6b0-11e9-9ccf-573a4fc5961f.png">
+
+Frame.io is a cloud-based collaboration hub that allows video professionals to share files, comment on clips real-time, and compare different versions and edits of a clip. 
+
 
 ## Installation
 

package/dist/cjs/Client.d.ts

@@ -20,7 +20,7 @@ export declare namespace FrameioClient {
         environment?: core.Supplier<environments.FrameioEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -54,7 +54,7 @@ export declare class FrameioClient {
     protected _users: Users | undefined;
     protected _projects: Projects | undefined;
     protected _workspaces: Workspaces | undefined;
-    constructor(_options?: FrameioClient.Options);
+    constructor(_options: FrameioClient.Options);
     get metadataFields(): MetadataFields;
     get projectPermissions(): ProjectPermissions;
     get folders(): Folders;

package/dist/cjs/Client.js

@@ -53,12 +53,12 @@ const Client_js_13 = require("./api/resources/users/client/Client.js");
 const Client_js_14 = require("./api/resources/projects/client/Client.js");
 const Client_js_15 = require("./api/resources/workspaces/client/Client.js");
 class FrameioClient {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "frameio",
-                "X-Fern-SDK-Version": "0.1.0",
-                "User-Agent": "frameio/0.1.0",
+                "X-Fern-SDK-Version": "1.1.4",
+                "User-Agent": "frameio/1.1.4",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/accountPermissions/client/Client.d.ts

@@ -6,7 +6,7 @@ export declare namespace AccountPermissions {
         environment?: core.Supplier<environments.FrameioEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace AccountPermissions {
  */
 export declare class AccountPermissions {
     protected readonly _options: AccountPermissions.Options;
-    constructor(_options?: AccountPermissions.Options);
+    constructor(_options: AccountPermissions.Options);
     /**
-     * List user roles for a given account. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.AccountPermissionsIndexRequest} request
@@ -52,5 +52,5 @@ export declare class AccountPermissions {
      *     })
      */
     index(accountId: Frameio.Uuid, request?: Frameio.AccountPermissionsIndexRequest, requestOptions?: AccountPermissions.RequestOptions): Promise<core.Page<Frameio.AccountUserRole>>;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/cjs/api/resources/accountPermissions/client/Client.js

@@ -53,11 +53,11 @@ const errors = __importStar(require("../../../../errors/index.js"));
  * Manage Account Permissions and related operations.
  */
 class AccountPermissions {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
-     * List user roles for a given account. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List user roles for a given account. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.AccountPermissionsIndexRequest} request
@@ -165,11 +165,7 @@ class AccountPermissions {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
+            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
         });
     }
 }

package/dist/cjs/api/resources/accounts/client/Client.d.ts

@@ -6,7 +6,7 @@ export declare namespace Accounts {
         environment?: core.Supplier<environments.FrameioEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace Accounts {
  */
 export declare class Accounts {
     protected readonly _options: Accounts.Options;
-    constructor(_options?: Accounts.Options);
+    constructor(_options: Accounts.Options);
     /**
-     * List accounts for the current user. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List accounts for the current user. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.AccountsIndexRequest} request
      * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,5 +50,5 @@ export declare class Accounts {
      *     })
      */
     index(request?: Frameio.AccountsIndexRequest, requestOptions?: Accounts.RequestOptions): Promise<core.Page<Frameio.Account>>;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/cjs/api/resources/accounts/client/Client.js

@@ -53,11 +53,11 @@ const errors = __importStar(require("../../../../errors/index.js"));
  * Manage Accounts and related operations.
  */
 class Accounts {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
-     * List accounts for the current user. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List accounts for the current user. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.AccountsIndexRequest} request
      * @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
@@ -157,11 +157,7 @@ class Accounts {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
+            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
         });
     }
 }

package/dist/cjs/api/resources/comments/client/Client.d.ts

@@ -6,7 +6,7 @@ export declare namespace Comments {
         environment?: core.Supplier<environments.FrameioEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace Comments {
  */
 export declare class Comments {
     protected readonly _options: Comments.Options;
-    constructor(_options?: Comments.Options);
+    constructor(_options: Comments.Options);
     /**
-     * Show a single comment on a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * Show a single comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -52,7 +52,7 @@ export declare class Comments {
     show(accountId: Frameio.Uuid, commentId: Frameio.Uuid, request?: Frameio.CommentsShowRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentWithIncludesResponse>;
     private __show;
     /**
-     * Delete comment from an asset. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
+     * Delete comment from an asset. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -71,7 +71,7 @@ export declare class Comments {
     delete(accountId: Frameio.Uuid, commentId: Frameio.Uuid, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
-     * Update comment on given asset. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+     * Update comment on given asset. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -87,7 +87,10 @@ export declare class Comments {
      *
      * @example
      *     await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         timestamp_as_timecode: true,
      *         data: {
+     *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+     *             completed: false,
      *             page: 4,
      *             text: "This is great!"
      *         }
@@ -96,7 +99,7 @@ export declare class Comments {
     update(accountId: Frameio.Uuid, commentId: Frameio.Uuid, request: Frameio.UpdateCommentParams, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentResponse>;
     private __update;
     /**
-     * List comments on a given asset. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List comments on a given asset. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} fileId -
@@ -120,7 +123,7 @@ export declare class Comments {
      */
     index(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.CommentsIndexRequest, requestOptions?: Comments.RequestOptions): Promise<core.Page<Frameio.CommentWithIncludes>>;
     /**
-     * Create a comment on a file. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+     * Create a comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} fileId -
@@ -136,13 +139,17 @@ export declare class Comments {
      *
      * @example
      *     await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         timestamp_as_timecode: true,
      *         data: {
+     *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+     *             completed: false,
      *             page: 4,
-     *             text: "This is great!"
+     *             text: "This is great!",
+     *             timestamp: "00:00:02:12"
      *         }
      *     })
      */
     create(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.CreateCommentParams, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentResponse>;
     private __create;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/cjs/api/resources/comments/client/Client.js

@@ -42,6 +42,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Comments = void 0;
 const environments = __importStar(require("../../../../environments.js"));
@@ -53,11 +64,11 @@ const errors = __importStar(require("../../../../errors/index.js"));
  * Manage Comments and related operations.
  */
 class Comments {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
-     * Show a single comment on a file. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * Show a single comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -140,7 +151,7 @@ class Comments {
         });
     }
     /**
-     * Delete comment from an asset. <br><br>Rate Limits: 60 calls per 1.00 minute(s) per account
+     * Delete comment from an asset. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -215,7 +226,7 @@ class Comments {
         });
     }
     /**
-     * Update comment on given asset. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+     * Update comment on given asset. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} commentId -
@@ -231,7 +242,10 @@ class Comments {
      *
      * @example
      *     await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         timestamp_as_timecode: true,
      *         data: {
+     *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+     *             completed: false,
      *             page: 4,
      *             text: "This is great!"
      *         }
@@ -243,15 +257,20 @@ class Comments {
     __update(accountId, commentId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
+            const { timestamp_as_timecode: timestampAsTimecode } = request, _body = __rest(request, ["timestamp_as_timecode"]);
+            const _queryParams = {};
+            if (timestampAsTimecode != null) {
+                _queryParams["timestamp_as_timecode"] = timestampAsTimecode.toString();
+            }
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/comments/${encodeURIComponent(commentId)}`),
                 method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 requestType: "json",
-                body: request,
+                body: _body,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -299,7 +318,7 @@ class Comments {
         });
     }
     /**
-     * List comments on a given asset. <br><br>Rate Limits: 100 calls per 1.00 minute(s) per account
+     * List comments on a given asset. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} fileId -
@@ -407,7 +426,7 @@ class Comments {
         });
     }
     /**
-     * Create a comment on a file. <br><br>Rate Limits: 10 calls per 1.00 minute(s) per account
+     * Create a comment on a file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} accountId -
      * @param {Frameio.Uuid} fileId -
@@ -423,9 +442,13 @@ class Comments {
      *
      * @example
      *     await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         timestamp_as_timecode: true,
      *         data: {
+     *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+     *             completed: false,
      *             page: 4,
-     *             text: "This is great!"
+     *             text: "This is great!",
+     *             timestamp: "00:00:02:12"
      *         }
      *     })
      */
@@ -435,15 +458,20 @@ class Comments {
     __create(accountId, fileId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
+            const { timestamp_as_timecode: timestampAsTimecode } = request, _body = __rest(request, ["timestamp_as_timecode"]);
+            const _queryParams = {};
+            if (timestampAsTimecode != null) {
+                _queryParams["timestamp_as_timecode"] = timestampAsTimecode.toString();
+            }
             let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/files/${encodeURIComponent(fileId)}/comments`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 requestType: "json",
-                body: request,
+                body: _body,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -492,11 +520,7 @@ class Comments {
     }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            const bearer = yield core.Supplier.get(this._options.token);
-            if (bearer != null) {
-                return `Bearer ${bearer}`;
-            }
-            return undefined;
+            return `Bearer ${yield core.Supplier.get(this._options.token)}`;
         });
     }
 }

package/dist/cjs/api/resources/comments/client/requests/CommentsShowRequest.d.ts

@@ -7,5 +7,5 @@ import * as Frameio from "../../../../index.js";
  */
 export interface CommentsShowRequest {
     /** */
-    include?: Frameio.CommentInclude;
+    include?: Frameio.CommentsShowRequestInclude;
 }

package/dist/cjs/api/resources/comments/client/requests/CreateCommentParams.d.ts

@@ -1,22 +1,32 @@
+import * as Frameio from "../../../../index.js";
 /**
  * @example
  *     {
+ *         timestamp_as_timecode: true,
  *         data: {
+ *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+ *             completed: false,
  *             page: 4,
- *             text: "This is great!"
+ *             text: "This is great!",
+ *             timestamp: "00:00:02:12"
  *         }
  *     }
  */
 export interface CreateCommentParams {
+    /** */
+    timestamp_as_timecode?: boolean;
     data: CreateCommentParams.Data;
 }
 export declare namespace CreateCommentParams {
     interface Data {
+        /** JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified. */
+        annotation?: string;
+        /** Comment completion status */
+        completed?: boolean;
         /** Document page. Only allowed when file type is a pdf document */
         page?: number;
         /** Comment text (required) */
         text: string;
-        /** Comment frame number in media. Only allowed when file type is 'audio', 'stream', or 'video'. */
-        timestamp?: number;
+        timestamp?: Frameio.TimeStamp;
     }
 }

package/dist/cjs/api/resources/comments/client/requests/UpdateCommentParams.d.ts

@@ -1,22 +1,31 @@
+import * as Frameio from "../../../../index.js";
 /**
  * @example
  *     {
+ *         timestamp_as_timecode: true,
  *         data: {
+ *             annotation: "[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
+ *             completed: false,
  *             page: 4,
  *             text: "This is great!"
  *         }
  *     }
  */
 export interface UpdateCommentParams {
+    /** */
+    timestamp_as_timecode?: boolean;
     data: UpdateCommentParams.Data;
 }
 export declare namespace UpdateCommentParams {
     interface Data {
+        /** JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified. */
+        annotation?: string;
+        /** Comment completion status */
+        completed?: boolean;
         /** Document page. Only allowed when file type is a pdf document */
         page?: number;
         /** Comment text */
         text?: string;
-        /** Comment frame number in media. Only allowed when file type is 'audio', 'stream', or 'video'. */
-        timestamp?: number;
+        timestamp?: Frameio.TimeStamp;
     }
 }

package/dist/cjs/api/resources/comments/index.d.ts

@@ -1 +1,2 @@
+export * from "./types/index.js";
 export * from "./client/index.js";

package/dist/cjs/api/resources/comments/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.d.ts

@@ -0,0 +1,6 @@
+/** Include query parameter for comments */
+export declare const CommentsShowRequestInclude: {
+    readonly Owner: "owner";
+    readonly Replies: "replies";
+};
+export type CommentsShowRequestInclude = (typeof CommentsShowRequestInclude)[keyof typeof CommentsShowRequestInclude];

package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsShowRequestInclude = void 0;
+/** Include query parameter for comments */
+exports.CommentsShowRequestInclude = {
+    Owner: "owner",
+    Replies: "replies",
+};

package/dist/cjs/api/resources/comments/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./CommentsShowRequestInclude.js";

package/dist/cjs/api/resources/comments/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CommentsShowRequestInclude.js"), exports);