frameio 3.0.0 → 3.2.0

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "frameio",
-        "X-Fern-SDK-Version": "3.0.0",
-        "User-Agent": "frameio/3.0.0",
+        "X-Fern-SDK-Version": "3.2.0",
+        "User-Agent": "frameio/3.2.0",
         "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/Client.d.ts

@@ -28,8 +28,8 @@ export declare class FrameioClient {
     protected _folders: FoldersClient | undefined;
     protected _versionStacks: VersionStacksClient | undefined;
     protected _accountPermissions: AccountPermissionsClient | undefined;
-    protected _accounts: AccountsClient | undefined;
     protected _comments: CommentsClient | undefined;
+    protected _accounts: AccountsClient | undefined;
     protected _webhooks: WebhooksClient | undefined;
     protected _workspacePermissions: WorkspacePermissionsClient | undefined;
     protected _shares: SharesClient | undefined;
@@ -44,8 +44,8 @@ export declare class FrameioClient {
     get folders(): FoldersClient;
     get versionStacks(): VersionStacksClient;
     get accountPermissions(): AccountPermissionsClient;
-    get accounts(): AccountsClient;
     get comments(): CommentsClient;
+    get accounts(): AccountsClient;
     get webhooks(): WebhooksClient;
     get workspacePermissions(): WorkspacePermissionsClient;
     get shares(): SharesClient;

package/dist/cjs/Client.js

@@ -85,14 +85,14 @@ class FrameioClient {
         var _a;
         return ((_a = this._accountPermissions) !== null && _a !== void 0 ? _a : (this._accountPermissions = new Client_js_1.AccountPermissionsClient(this._options)));
     }
-    get accounts() {
-        var _a;
-        return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new Client_js_2.AccountsClient(this._options)));
-    }
     get comments() {
         var _a;
         return ((_a = this._comments) !== null && _a !== void 0 ? _a : (this._comments = new Client_js_3.CommentsClient(this._options)));
     }
+    get accounts() {
+        var _a;
+        return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new Client_js_2.AccountsClient(this._options)));
+    }
     get webhooks() {
         var _a;
         return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_13.WebhooksClient(this._options)));

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

@@ -13,6 +13,54 @@ export declare namespace CommentsClient {
 export declare class CommentsClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CommentsClient.Options>;
     constructor(options: CommentsClient.Options);
+    /**
+     * Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} comment_id
+     * @param {Frameio.Uuid} attachment_id
+     * @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
+     */
+    deleteAttachment(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, attachment_id: Frameio.Uuid, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteAttachment;
+    /**
+     * Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} comment_id
+     * @param {Frameio.CreateAttachmentParams} request
+     * @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             file_size: 1024000,
+     *             media_type: "image/png",
+     *             name: "screenshot.png"
+     *         }
+     *     })
+     */
+    createAttachment(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, request: Frameio.CreateAttachmentParams, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<Frameio.CommentAttachmentResponse>;
+    private __createAttachment;
     /**
      * Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
@@ -58,7 +106,7 @@ export declare class CommentsClient {
     delete(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
-     * Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     * Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
      * @param {Frameio.Uuid} comment_id
@@ -77,10 +125,25 @@ export declare class CommentsClient {
      *     await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         data: {
+     *             anchor: {
+     *                 x: 0.5,
+     *                 y: 0.5
+     *             },
      *             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,
+     *             duration: 10,
+     *             links: [{
+     *                     end_index: 13,
+     *                     start_index: 5,
+     *                     url: "https://www.example.com"
+     *                 }],
      *             page: 4,
-     *             text: "This is great!"
+     *             text: "This is great!",
+     *             text_review_annotation: {
+     *                 selection_text: "existing copy",
+     *                 suggested_text: "updated copy"
+     *             },
+     *             timestamp: 100
      *         }
      *     })
      */
@@ -106,6 +169,7 @@ export declare class CommentsClient {
      *     await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         include: "owner",
+     *         sort: "owner_asc",
      *         after: "<opaque_cursor>",
      *         page_size: 10,
      *         include_total_count: false
@@ -132,10 +196,36 @@ export declare class CommentsClient {
      *     await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         data: {
+     *             anchor: {
+     *                 x: 0.5,
+     *                 y: 0.5
+     *             },
      *             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}]",
+     *             attachments: [{
+     *                     file_size: 1024000,
+     *                     media_type: "image/png",
+     *                     name: "screenshot.png"
+     *                 }],
      *             completed: false,
+     *             duration: 10,
+     *             links: [{
+     *                     end_index: 13,
+     *                     start_index: 5,
+     *                     url: "https://www.example.com"
+     *                 }],
      *             page: 4,
      *             text: "This is great!",
+     *             text_review_annotation: {
+     *                 bounds: [{
+     *                         height: 42,
+     *                         width: 130,
+     *                         x: 12.5,
+     *                         y: 24
+     *                     }],
+     *                 selection_text: "existing copy",
+     *                 suggested_text: "updated copy",
+     *                 text_review_annotation_type: "replace"
+     *             },
      *             timestamp: "00:00:02:12"
      *         }
      *     })

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

@@ -69,6 +69,151 @@ class CommentsClient {
     constructor(options) {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
+    /**
+     * Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} comment_id
+     * @param {Frameio.Uuid} attachment_id
+     * @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
+     */
+    deleteAttachment(account_id, comment_id, attachment_id, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deleteAttachment(account_id, comment_id, attachment_id, requestOptions));
+    }
+    __deleteAttachment(account_id, comment_id, attachment_id, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/comments/${core.url.encodePathParam(comment_id)}/attachments/${core.url.encodePathParam(attachment_id)}`),
+                method: "DELETE",
+                headers: _headers,
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.FrameioError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v4/accounts/{account_id}/comments/{comment_id}/attachments/{attachment_id}");
+        });
+    }
+    /**
+     * Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     *
+     * @param {Frameio.Uuid} account_id
+     * @param {Frameio.Uuid} comment_id
+     * @param {Frameio.CreateAttachmentParams} request
+     * @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Frameio.BadRequestError}
+     * @throws {@link Frameio.UnauthorizedError}
+     * @throws {@link Frameio.ForbiddenError}
+     * @throws {@link Frameio.NotFoundError}
+     * @throws {@link Frameio.ConflictError}
+     * @throws {@link Frameio.UnprocessableEntityError}
+     * @throws {@link Frameio.TooManyRequestsError}
+     *
+     * @example
+     *     await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+     *         data: {
+     *             file_size: 1024000,
+     *             media_type: "image/png",
+     *             name: "screenshot.png"
+     *         }
+     *     })
+     */
+    createAttachment(account_id, comment_id, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__createAttachment(account_id, comment_id, request, requestOptions));
+    }
+    __createAttachment(account_id, comment_id, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/comments/${core.url.encodePathParam(comment_id)}/attachments`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 409:
+                        throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.FrameioError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/comments/{comment_id}/attachments");
+        });
+    }
     /**
      * Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
      *
@@ -213,7 +358,7 @@ class CommentsClient {
         });
     }
     /**
-     * Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
+     * Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
      *
      * @param {Frameio.Uuid} account_id
      * @param {Frameio.Uuid} comment_id
@@ -232,10 +377,25 @@ class CommentsClient {
      *     await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         data: {
+     *             anchor: {
+     *                 x: 0.5,
+     *                 y: 0.5
+     *             },
      *             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,
+     *             duration: 10,
+     *             links: [{
+     *                     end_index: 13,
+     *                     start_index: 5,
+     *                     url: "https://www.example.com"
+     *                 }],
      *             page: 4,
-     *             text: "This is great!"
+     *             text: "This is great!",
+     *             text_review_annotation: {
+     *                 selection_text: "existing copy",
+     *                 suggested_text: "updated copy"
+     *             },
+     *             timestamp: 100
      *         }
      *     })
      */
@@ -315,6 +475,7 @@ class CommentsClient {
      *     await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         include: "owner",
+     *         sort: "owner_asc",
      *         after: "<opaque_cursor>",
      *         page_size: 10,
      *         include_total_count: false
@@ -402,10 +563,36 @@ class CommentsClient {
      *     await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         timestamp_as_timecode: true,
      *         data: {
+     *             anchor: {
+     *                 x: 0.5,
+     *                 y: 0.5
+     *             },
      *             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}]",
+     *             attachments: [{
+     *                     file_size: 1024000,
+     *                     media_type: "image/png",
+     *                     name: "screenshot.png"
+     *                 }],
      *             completed: false,
+     *             duration: 10,
+     *             links: [{
+     *                     end_index: 13,
+     *                     start_index: 5,
+     *                     url: "https://www.example.com"
+     *                 }],
      *             page: 4,
      *             text: "This is great!",
+     *             text_review_annotation: {
+     *                 bounds: [{
+     *                         height: 42,
+     *                         width: 130,
+     *                         x: 12.5,
+     *                         y: 24
+     *                     }],
+     *                 selection_text: "existing copy",
+     *                 suggested_text: "updated copy",
+     *                 text_review_annotation_type: "replace"
+     *             },
      *             timestamp: "00:00:02:12"
      *         }
      *     })

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

@@ -4,6 +4,7 @@ import type * as Frameio from "../../../../index.js";
  *     {
  *         timestamp_as_timecode: true,
  *         include: "owner",
+ *         sort: "owner_asc",
  *         after: "<opaque_cursor>",
  *         page_size: 10,
  *         include_total_count: false
@@ -12,6 +13,8 @@ import type * as Frameio from "../../../../index.js";
 export interface CommentsIndexRequest {
     timestamp_as_timecode?: boolean;
     include?: Frameio.CommentsIndexRequestInclude;
+    /** Sort comments by query params */
+    sort?: Frameio.CommentsIndexRequestSort;
     /**
      * Opaque Cursor query param for requests returning paginated results.
      * <br/>

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

@@ -0,0 +1,14 @@
+import type * as Frameio from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         data: {
+ *             file_size: 1024000,
+ *             media_type: "image/png",
+ *             name: "screenshot.png"
+ *         }
+ *     }
+ */
+export interface CreateAttachmentParams {
+    data: Frameio.AttachmentInput;
+}

package/dist/cjs/api/resources/comments/client/requests/CreateAttachmentParams.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -4,10 +4,36 @@ import type * as Frameio from "../../../../index.js";
  *     {
  *         timestamp_as_timecode: true,
  *         data: {
+ *             anchor: {
+ *                 x: 0.5,
+ *                 y: 0.5
+ *             },
  *             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}]",
+ *             attachments: [{
+ *                     file_size: 1024000,
+ *                     media_type: "image/png",
+ *                     name: "screenshot.png"
+ *                 }],
  *             completed: false,
+ *             duration: 10,
+ *             links: [{
+ *                     end_index: 13,
+ *                     start_index: 5,
+ *                     url: "https://www.example.com"
+ *                 }],
  *             page: 4,
  *             text: "This is great!",
+ *             text_review_annotation: {
+ *                 bounds: [{
+ *                         height: 42,
+ *                         width: 130,
+ *                         x: 12.5,
+ *                         y: 24
+ *                     }],
+ *                 selection_text: "existing copy",
+ *                 suggested_text: "updated copy",
+ *                 text_review_annotation_type: "replace"
+ *             },
  *             timestamp: "00:00:02:12"
  *         }
  *     }
@@ -18,14 +44,24 @@ export interface CreateCommentParams {
 }
 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. */
+        /** Comment anchor location. {(x, y) | 0 <= x <= 1, 0 <= y <= 1}. */
+        anchor?: Frameio.Anchor | undefined;
+        /** JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified */
         annotation?: string | undefined;
+        /** Optional attachments to create with the comment (max 6 attachments) */
+        attachments?: Frameio.AttachmentInput[] | undefined;
         /** Comment completion status */
         completed?: boolean | undefined;
+        /** Duration of comment in frames. Requires presence of timestamp parameter */
+        duration?: number | undefined;
+        /** Comment text links. */
+        links?: Frameio.LinkParams[] | undefined;
         /** Document page. Only allowed when file type is a pdf document */
         page?: number | undefined;
         /** Comment text (required) */
         text: string;
+        /** Text review annotation details for comments left on text documents. */
+        text_review_annotation?: Frameio.TextReviewAnnotation | undefined;
         timestamp?: Frameio.TimeStamp | undefined;
     }
 }

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

@@ -4,10 +4,25 @@ import type * as Frameio from "../../../../index.js";
  *     {
  *         timestamp_as_timecode: true,
  *         data: {
+ *             anchor: {
+ *                 x: 0.5,
+ *                 y: 0.5
+ *             },
  *             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,
+ *             duration: 10,
+ *             links: [{
+ *                     end_index: 13,
+ *                     start_index: 5,
+ *                     url: "https://www.example.com"
+ *                 }],
  *             page: 4,
- *             text: "This is great!"
+ *             text: "This is great!",
+ *             text_review_annotation: {
+ *                 selection_text: "existing copy",
+ *                 suggested_text: "updated copy"
+ *             },
+ *             timestamp: 100
  *         }
  *     }
  */
@@ -17,14 +32,21 @@ export interface UpdateCommentParams {
 }
 export declare namespace UpdateCommentParams {
     interface Data {
+        /** Comment anchor location. {(x, y) | 0 <= x <= 1, 0 <= y <= 1}. */
+        anchor?: Frameio.Anchor | undefined;
         /** JSON geometry for on-screen drawings. Allowed for document, image, video, or stream file types. JSON must be stringified. */
         annotation?: string | undefined;
         /** Comment completion status */
         completed?: boolean | undefined;
+        /** Duration of comment in frames. Requires presence of timestamp parameter */
+        duration?: number | undefined;
+        /** Comment text links. */
+        links?: Frameio.LinkParams[] | undefined;
         /** Document page. Only allowed when file type is a pdf document */
         page?: number | undefined;
         /** Comment text */
         text?: string | undefined;
+        text_review_annotation?: Frameio.TextReviewAnnotationUpdate | undefined;
         timestamp?: Frameio.TimeStamp | undefined;
     }
 }

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

@@ -1,4 +1,5 @@
 export type { CommentsIndexRequest } from "./CommentsIndexRequest.js";
 export type { CommentsShowRequest } from "./CommentsShowRequest.js";
+export type { CreateAttachmentParams } from "./CreateAttachmentParams.js";
 export type { CreateCommentParams } from "./CreateCommentParams.js";
 export type { UpdateCommentParams } from "./UpdateCommentParams.js";

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

@@ -0,0 +1,10 @@
+/** Sort query parameter for comments. Include query params for owner is required when sorting by owner. */
+export declare const CommentsIndexRequestSort: {
+    readonly OwnerAsc: "owner_asc";
+    readonly OwnerDesc: "owner_desc";
+    readonly CompletedAtAsc: "completed_at_asc";
+    readonly CompletedAtDesc: "completed_at_desc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type CommentsIndexRequestSort = (typeof CommentsIndexRequestSort)[keyof typeof CommentsIndexRequestSort];

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

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsIndexRequestSort = void 0;
+/** Sort query parameter for comments. Include query params for owner is required when sorting by owner. */
+exports.CommentsIndexRequestSort = {
+    OwnerAsc: "owner_asc",
+    OwnerDesc: "owner_desc",
+    CompletedAtAsc: "completed_at_asc",
+    CompletedAtDesc: "completed_at_desc",
+    CreatedAtAsc: "created_at_asc",
+    CreatedAtDesc: "created_at_desc",
+};

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

@@ -1,2 +1,3 @@
 export * from "./CommentsIndexRequestInclude.js";
+export * from "./CommentsIndexRequestSort.js";
 export * from "./CommentsShowRequestInclude.js";

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

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CommentsIndexRequestInclude.js"), exports);
+__exportStar(require("./CommentsIndexRequestSort.js"), exports);
 __exportStar(require("./CommentsShowRequestInclude.js"), exports);

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

@@ -145,7 +145,7 @@ export declare class VersionStacksClient {
      * @example
      *     await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             file_ids: ["5ac6ed03-061e-401c-b7c1-ce726dd863de", "1ede5e45-07f7-4f55-8bac-28b6fa786908"]
+     *             file_ids: ["5cbe22e2-fa8e-4279-9ce7-64ec188e059a", "cf7dec74-6d90-4c8b-829c-3e5bb7baa37a"]
      *         }
      *     })
      */

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

@@ -423,7 +423,7 @@ class VersionStacksClient {
      * @example
      *     await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
      *         data: {
-     *             file_ids: ["5ac6ed03-061e-401c-b7c1-ce726dd863de", "1ede5e45-07f7-4f55-8bac-28b6fa786908"]
+     *             file_ids: ["5cbe22e2-fa8e-4279-9ce7-64ec188e059a", "cf7dec74-6d90-4c8b-829c-3e5bb7baa37a"]
      *         }
      *     })
      */

package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts

@@ -2,7 +2,7 @@
  * @example
  *     {
  *         data: {
- *             file_ids: ["5ac6ed03-061e-401c-b7c1-ce726dd863de", "1ede5e45-07f7-4f55-8bac-28b6fa786908"]
+ *             file_ids: ["5cbe22e2-fa8e-4279-9ce7-64ec188e059a", "cf7dec74-6d90-4c8b-829c-3e5bb7baa37a"]
  *         }
  *     }
  */