frameio 3.0.0 → 3.2.0

package/dist/esm/api/types/TextReviewAnnotation.d.mts

@@ -0,0 +1,21 @@
+import type * as Frameio from "../index.mjs";
+export interface TextReviewAnnotation {
+    /** An array of bounds representing a multiline selection origin at the lower-left corner. */
+    bounds: Frameio.TextReviewAnnotationBounds[];
+    /** Selected text from the document. */
+    selection_text?: string | undefined;
+    /** Suggested replacement or insertion text. */
+    suggested_text?: string | undefined;
+    /** The type of text review annotation. */
+    text_review_annotation_type: TextReviewAnnotation.TextReviewAnnotationType;
+}
+export declare namespace TextReviewAnnotation {
+    /** The type of text review annotation. */
+    const TextReviewAnnotationType: {
+        readonly Highlight: "highlight";
+        readonly Insert: "insert";
+        readonly Remove: "remove";
+        readonly Replace: "replace";
+    };
+    type TextReviewAnnotationType = (typeof TextReviewAnnotationType)[keyof typeof TextReviewAnnotationType];
+}

package/dist/esm/api/types/TextReviewAnnotation.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var TextReviewAnnotation;
+(function (TextReviewAnnotation) {
+    /** The type of text review annotation. */
+    TextReviewAnnotation.TextReviewAnnotationType = {
+        Highlight: "highlight",
+        Insert: "insert",
+        Remove: "remove",
+        Replace: "replace",
+    };
+})(TextReviewAnnotation || (TextReviewAnnotation = {}));

package/dist/esm/api/types/TextReviewAnnotationBounds.d.mts

@@ -0,0 +1,10 @@
+export interface TextReviewAnnotationBounds {
+    /** Height of the rectangle */
+    height: number;
+    /** Width of the rectangle */
+    width: number;
+    /** Left corner position. */
+    x: number;
+    /** Bottom corner position. */
+    y: number;
+}

package/dist/esm/api/types/TextReviewAnnotationBounds.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/TextReviewAnnotationUpdate.d.mts

@@ -0,0 +1,24 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * Payload for updating an existing text review annotation.
+ */
+export interface TextReviewAnnotationUpdate {
+    /** Optional bounds array. When omitted, previously stored bounds are preserved. */
+    bounds?: Frameio.TextReviewAnnotationBounds[] | undefined;
+    /** Optional selection text override. */
+    selection_text?: string | undefined;
+    /** Optional suggestion override. */
+    suggested_text?: string | undefined;
+    /** Optional annotation type override. */
+    text_review_annotation_type?: TextReviewAnnotationUpdate.TextReviewAnnotationType | undefined;
+}
+export declare namespace TextReviewAnnotationUpdate {
+    /** Optional annotation type override. */
+    const TextReviewAnnotationType: {
+        readonly Highlight: "highlight";
+        readonly Insert: "insert";
+        readonly Remove: "remove";
+        readonly Replace: "replace";
+    };
+    type TextReviewAnnotationType = (typeof TextReviewAnnotationType)[keyof typeof TextReviewAnnotationType];
+}

package/dist/esm/api/types/TextReviewAnnotationUpdate.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var TextReviewAnnotationUpdate;
+(function (TextReviewAnnotationUpdate) {
+    /** Optional annotation type override. */
+    TextReviewAnnotationUpdate.TextReviewAnnotationType = {
+        Highlight: "highlight",
+        Insert: "insert",
+        Remove: "remove",
+        Replace: "replace",
+    };
+})(TextReviewAnnotationUpdate || (TextReviewAnnotationUpdate = {}));

package/dist/esm/api/types/index.d.mts

@@ -3,11 +3,13 @@ export * from "./AccountsResponse.mjs";
 export * from "./AccountUserRole.mjs";
 export * from "./AccountUserRolesResponse.mjs";
 export * from "./AddAssetResponse.mjs";
+export * from "./Anchor.mjs";
 export * from "./AssetCommon.mjs";
 export * from "./AssetCommonWithIncludes.mjs";
 export * from "./AssetInclude.mjs";
 export * from "./AssetShareParams.mjs";
 export * from "./AssetWithIncludes.mjs";
+export * from "./AttachmentInput.mjs";
 export * from "./AuditLogsInclude.mjs";
 export * from "./AuditLogsWithIncludesResponse.mjs";
 export * from "./AuditLogwithIncludes.mjs";
@@ -15,8 +17,11 @@ export * from "./BadRequest.mjs";
 export * from "./BooleanValue.mjs";
 export * from "./ChildrenType.mjs";
 export * from "./Comment.mjs";
+export * from "./CommentAttachment.mjs";
+export * from "./CommentAttachmentResponse.mjs";
 export * from "./CommentInclude.mjs";
 export * from "./CommentResponse.mjs";
+export * from "./CommentSort.mjs";
 export * from "./CommentsWithIncludesResponse.mjs";
 export * from "./CommentWithIncludes.mjs";
 export * from "./CommentWithIncludesResponse.mjs";
@@ -59,12 +64,15 @@ export * from "./Include.mjs";
 export * from "./IncludeTotalCount.mjs";
 export * from "./IntegerValue.mjs";
 export * from "./JsonErrorResponse.mjs";
+export * from "./Link.mjs";
+export * from "./LinkParams.mjs";
 export * from "./Links.mjs";
 export * from "./LongTextDefinition.mjs";
 export * from "./LongTextDefinitionParams.mjs";
 export * from "./LongTextDefinitionWithIncludes.mjs";
 export * from "./MediaLinkCommon.mjs";
 export * from "./MediaLinksCollection.mjs";
+export * from "./Mention.mjs";
 export * from "./MetadataField.mjs";
 export * from "./MetadataResponse.mjs";
 export * from "./MetadataWithDefinition.mjs";
@@ -109,6 +117,9 @@ export * from "./SingleUserValue.mjs";
 export * from "./TextDefinition.mjs";
 export * from "./TextDefinitionParams.mjs";
 export * from "./TextDefinitionWithIncludes.mjs";
+export * from "./TextReviewAnnotation.mjs";
+export * from "./TextReviewAnnotationBounds.mjs";
+export * from "./TextReviewAnnotationUpdate.mjs";
 export * from "./TextValue.mjs";
 export * from "./TimeStamp.mjs";
 export * from "./ToggleDefinition.mjs";

package/dist/esm/api/types/index.mjs

@@ -3,11 +3,13 @@ export * from "./AccountsResponse.mjs";
 export * from "./AccountUserRole.mjs";
 export * from "./AccountUserRolesResponse.mjs";
 export * from "./AddAssetResponse.mjs";
+export * from "./Anchor.mjs";
 export * from "./AssetCommon.mjs";
 export * from "./AssetCommonWithIncludes.mjs";
 export * from "./AssetInclude.mjs";
 export * from "./AssetShareParams.mjs";
 export * from "./AssetWithIncludes.mjs";
+export * from "./AttachmentInput.mjs";
 export * from "./AuditLogsInclude.mjs";
 export * from "./AuditLogsWithIncludesResponse.mjs";
 export * from "./AuditLogwithIncludes.mjs";
@@ -15,8 +17,11 @@ export * from "./BadRequest.mjs";
 export * from "./BooleanValue.mjs";
 export * from "./ChildrenType.mjs";
 export * from "./Comment.mjs";
+export * from "./CommentAttachment.mjs";
+export * from "./CommentAttachmentResponse.mjs";
 export * from "./CommentInclude.mjs";
 export * from "./CommentResponse.mjs";
+export * from "./CommentSort.mjs";
 export * from "./CommentsWithIncludesResponse.mjs";
 export * from "./CommentWithIncludes.mjs";
 export * from "./CommentWithIncludesResponse.mjs";
@@ -59,12 +64,15 @@ export * from "./Include.mjs";
 export * from "./IncludeTotalCount.mjs";
 export * from "./IntegerValue.mjs";
 export * from "./JsonErrorResponse.mjs";
+export * from "./Link.mjs";
+export * from "./LinkParams.mjs";
 export * from "./Links.mjs";
 export * from "./LongTextDefinition.mjs";
 export * from "./LongTextDefinitionParams.mjs";
 export * from "./LongTextDefinitionWithIncludes.mjs";
 export * from "./MediaLinkCommon.mjs";
 export * from "./MediaLinksCollection.mjs";
+export * from "./Mention.mjs";
 export * from "./MetadataField.mjs";
 export * from "./MetadataResponse.mjs";
 export * from "./MetadataWithDefinition.mjs";
@@ -109,6 +117,9 @@ export * from "./SingleUserValue.mjs";
 export * from "./TextDefinition.mjs";
 export * from "./TextDefinitionParams.mjs";
 export * from "./TextDefinitionWithIncludes.mjs";
+export * from "./TextReviewAnnotation.mjs";
+export * from "./TextReviewAnnotationBounds.mjs";
+export * from "./TextReviewAnnotationUpdate.mjs";
 export * from "./TextValue.mjs";
 export * from "./TimeStamp.mjs";
 export * from "./ToggleDefinition.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.0.0";
+export declare const SDK_VERSION = "3.2.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "3.0.0";
+export const SDK_VERSION = "3.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "frameio",
-    "version": "3.0.0",
+    "version": "3.2.0",
     "private": false,
     "repository": {
         "type": "git",
@@ -77,17 +77,6 @@
             },
             "default": "./dist/cjs/api/resources/accountPermissions/exports.js"
         },
-        "./accounts": {
-            "import": {
-                "types": "./dist/esm/api/resources/accounts/exports.d.mts",
-                "default": "./dist/esm/api/resources/accounts/exports.mjs"
-            },
-            "require": {
-                "types": "./dist/cjs/api/resources/accounts/exports.d.ts",
-                "default": "./dist/cjs/api/resources/accounts/exports.js"
-            },
-            "default": "./dist/cjs/api/resources/accounts/exports.js"
-        },
         "./comments": {
             "import": {
                 "types": "./dist/esm/api/resources/comments/exports.d.mts",
@@ -99,6 +88,17 @@
             },
             "default": "./dist/cjs/api/resources/comments/exports.js"
         },
+        "./accounts": {
+            "import": {
+                "types": "./dist/esm/api/resources/accounts/exports.d.mts",
+                "default": "./dist/esm/api/resources/accounts/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/accounts/exports.d.ts",
+                "default": "./dist/cjs/api/resources/accounts/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/accounts/exports.js"
+        },
         "./webhooks": {
             "import": {
                 "types": "./dist/esm/api/resources/webhooks/exports.d.mts",

package/reference.md

@@ -1638,7 +1638,7 @@ Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls p
 ```typescript
 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"]
     }
 });
 
@@ -1869,8 +1869,8 @@ const response = page.response;
 </dl>
 </details>
 
-## Accounts
-<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">index</a>({ ...params }) -> core.Page&lt;Frameio.Account, Frameio.AccountsResponse&gt;</code></summary>
+## Comments
+<details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">deleteAttachment</a>(account_id, comment_id, attachment_id) -> void</code></summary>
 <dl>
 <dd>
 
@@ -1882,7 +1882,7 @@ const response = page.response;
 <dl>
 <dd>
 
-List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
 </dd>
 </dl>
 </dd>
@@ -1897,27 +1897,7 @@ List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(
 <dd>
 
 ```typescript
-const pageableResponse = await client.accounts.index({
-    after: "<opaque_cursor>",
-    page_size: 10,
-    include_total_count: false
-});
-for await (const item of pageableResponse) {
-    console.log(item);
-}
-
-// Or you can manually iterate page-by-page
-let page = await client.accounts.index({
-    after: "<opaque_cursor>",
-    page_size: 10,
-    include_total_count: false
-});
-while (page.hasNextPage()) {
-    page = page.getNextPage();
-}
-
-// You can also access the underlying response
-const response = page.response;
+await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b");
 
 ```
 </dd>
@@ -1933,7 +1913,7 @@ const response = page.response;
 <dl>
 <dd>
 
-**request:** `Frameio.AccountsIndexRequest` 
+**account_id:** `Frameio.Uuid` — 
     
 </dd>
 </dl>
@@ -1941,7 +1921,23 @@ const response = page.response;
 <dl>
 <dd>
 
-**requestOptions:** `AccountsClient.RequestOptions` 
+**comment_id:** `Frameio.Uuid` — 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**attachment_id:** `Frameio.Uuid` — 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CommentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -1953,7 +1949,7 @@ const response = page.response;
 </dl>
 </details>
 
-<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">auditlogIndex</a>(account_id, { ...params }) -> Frameio.AuditLogsWithIncludesResponse</code></summary>
+<details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">createAttachment</a>(account_id, comment_id, { ...params }) -> Frameio.CommentAttachmentResponse</code></summary>
 <dl>
 <dd>
 
@@ -1965,7 +1961,7 @@ const response = page.response;
 <dl>
 <dd>
 
-List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
 </dd>
 </dl>
 </dd>
@@ -1980,11 +1976,12 @@ List audit logs with filtering capabilities via query params. <br/>Rate Limits:
 <dd>
 
 ```typescript
-await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
-    include: "user",
-    after: "<opaque_cursor>",
-    page_size: 10,
-    include_total_count: false
+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"
+    }
 });
 
 ```
@@ -2009,7 +2006,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
 <dl>
 <dd>
 
-**request:** `Frameio.AuditlogIndexRequest` 
+**comment_id:** `Frameio.Uuid` — 
     
 </dd>
 </dl>
@@ -2017,7 +2014,15 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
 <dl>
 <dd>
 
-**requestOptions:** `AccountsClient.RequestOptions` 
+**request:** `Frameio.CreateAttachmentParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `CommentsClient.RequestOptions` 
     
 </dd>
 </dl>
@@ -2029,7 +2034,6 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
 </dl>
 </details>
 
-## Comments
 <details><summary><code>client.comments.<a href="/src/api/resources/comments/client/Client.ts">show</a>(account_id, comment_id, { ...params }) -> Frameio.CommentWithIncludesResponse</code></summary>
 <dl>
 <dd>
@@ -2195,7 +2199,7 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
 <dl>
 <dd>
 
-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
 </dd>
 </dl>
 </dd>
@@ -2213,10 +2217,25 @@ Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per
 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
     }
 });
 
@@ -2300,6 +2319,7 @@ List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) p
 const pageableResponse = 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
@@ -2312,6 +2332,7 @@ for await (const item of pageableResponse) {
 let page = 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
@@ -2403,10 +2424,36 @@ Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per a
 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"
     }
 });
@@ -2457,6 +2504,166 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Accounts
+<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">index</a>({ ...params }) -> core.Page&lt;Frameio.Account, Frameio.AccountsResponse&gt;</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const pageableResponse = await client.accounts.index({
+    after: "<opaque_cursor>",
+    page_size: 10,
+    include_total_count: false
+});
+for await (const item of pageableResponse) {
+    console.log(item);
+}
+
+// Or you can manually iterate page-by-page
+let page = await client.accounts.index({
+    after: "<opaque_cursor>",
+    page_size: 10,
+    include_total_count: false
+});
+while (page.hasNextPage()) {
+    page = page.getNextPage();
+}
+
+// You can also access the underlying response
+const response = page.response;
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Frameio.AccountsIndexRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.accounts.<a href="/src/api/resources/accounts/client/Client.ts">auditlogIndex</a>(account_id, { ...params }) -> Frameio.AuditLogsWithIncludesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
+    include: "user",
+    after: "<opaque_cursor>",
+    page_size: 10,
+    include_total_count: false
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**account_id:** `Frameio.Uuid` — 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Frameio.AuditlogIndexRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AccountsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>