frameio 3.0.0 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +2 -2
- package/dist/cjs/Client.js +4 -4
- package/dist/cjs/api/resources/comments/client/Client.d.ts +92 -2
- package/dist/cjs/api/resources/comments/client/Client.js +189 -2
- package/dist/cjs/api/resources/comments/client/requests/CommentsIndexRequest.d.ts +3 -0
- package/dist/cjs/api/resources/comments/client/requests/CreateAttachmentParams.d.ts +14 -0
- package/dist/cjs/api/resources/comments/client/requests/CreateAttachmentParams.js +3 -0
- package/dist/cjs/api/resources/comments/client/requests/CreateCommentParams.d.ts +37 -1
- package/dist/cjs/api/resources/comments/client/requests/UpdateCommentParams.d.ts +23 -1
- package/dist/cjs/api/resources/comments/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/comments/types/CommentsIndexRequestSort.d.ts +10 -0
- package/dist/cjs/api/resources/comments/types/CommentsIndexRequestSort.js +13 -0
- package/dist/cjs/api/resources/comments/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/comments/types/index.js +1 -0
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.js +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/types/Anchor.d.ts +6 -0
- package/dist/cjs/api/types/Anchor.js +3 -0
- package/dist/cjs/api/types/AttachmentInput.d.ts +11 -0
- package/dist/cjs/api/types/AttachmentInput.js +3 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +1 -1
- package/dist/cjs/api/types/Comment.d.ts +12 -0
- package/dist/cjs/api/types/CommentAttachment.d.ts +14 -0
- package/dist/cjs/api/types/CommentAttachment.js +3 -0
- package/dist/cjs/api/types/CommentAttachmentResponse.d.ts +4 -0
- package/dist/cjs/api/types/CommentAttachmentResponse.js +3 -0
- package/dist/cjs/api/types/CommentSort.d.ts +10 -0
- package/dist/cjs/api/types/CommentSort.js +13 -0
- package/dist/cjs/api/types/Link.d.ts +10 -0
- package/dist/cjs/api/types/Link.js +3 -0
- package/dist/cjs/api/types/LinkParams.d.ts +8 -0
- package/dist/cjs/api/types/LinkParams.js +3 -0
- package/dist/cjs/api/types/Mention.d.ts +10 -0
- package/dist/cjs/api/types/Mention.js +3 -0
- package/dist/cjs/api/types/TextReviewAnnotation.d.ts +21 -0
- package/dist/cjs/api/types/TextReviewAnnotation.js +14 -0
- package/dist/cjs/api/types/TextReviewAnnotationBounds.d.ts +10 -0
- package/dist/cjs/api/types/TextReviewAnnotationBounds.js +3 -0
- package/dist/cjs/api/types/TextReviewAnnotationUpdate.d.ts +24 -0
- package/dist/cjs/api/types/TextReviewAnnotationUpdate.js +14 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +2 -2
- package/dist/esm/Client.mjs +4 -4
- package/dist/esm/api/resources/comments/client/Client.d.mts +92 -2
- package/dist/esm/api/resources/comments/client/Client.mjs +189 -2
- package/dist/esm/api/resources/comments/client/requests/CommentsIndexRequest.d.mts +3 -0
- package/dist/esm/api/resources/comments/client/requests/CreateAttachmentParams.d.mts +14 -0
- package/dist/esm/api/resources/comments/client/requests/CreateAttachmentParams.mjs +2 -0
- package/dist/esm/api/resources/comments/client/requests/CreateCommentParams.d.mts +37 -1
- package/dist/esm/api/resources/comments/client/requests/UpdateCommentParams.d.mts +23 -1
- package/dist/esm/api/resources/comments/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/comments/types/CommentsIndexRequestSort.d.mts +10 -0
- package/dist/esm/api/resources/comments/types/CommentsIndexRequestSort.mjs +10 -0
- package/dist/esm/api/resources/comments/types/index.d.mts +1 -0
- package/dist/esm/api/resources/comments/types/index.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/types/Anchor.d.mts +6 -0
- package/dist/esm/api/types/Anchor.mjs +2 -0
- package/dist/esm/api/types/AttachmentInput.d.mts +11 -0
- package/dist/esm/api/types/AttachmentInput.mjs +2 -0
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +1 -1
- package/dist/esm/api/types/Comment.d.mts +12 -0
- package/dist/esm/api/types/CommentAttachment.d.mts +14 -0
- package/dist/esm/api/types/CommentAttachment.mjs +2 -0
- package/dist/esm/api/types/CommentAttachmentResponse.d.mts +4 -0
- package/dist/esm/api/types/CommentAttachmentResponse.mjs +2 -0
- package/dist/esm/api/types/CommentSort.d.mts +10 -0
- package/dist/esm/api/types/CommentSort.mjs +10 -0
- package/dist/esm/api/types/Link.d.mts +10 -0
- package/dist/esm/api/types/Link.mjs +2 -0
- package/dist/esm/api/types/LinkParams.d.mts +8 -0
- package/dist/esm/api/types/LinkParams.mjs +2 -0
- package/dist/esm/api/types/Mention.d.mts +10 -0
- package/dist/esm/api/types/Mention.mjs +2 -0
- package/dist/esm/api/types/TextReviewAnnotation.d.mts +21 -0
- package/dist/esm/api/types/TextReviewAnnotation.mjs +11 -0
- package/dist/esm/api/types/TextReviewAnnotationBounds.d.mts +10 -0
- package/dist/esm/api/types/TextReviewAnnotationBounds.mjs +2 -0
- package/dist/esm/api/types/TextReviewAnnotationUpdate.d.mts +24 -0
- package/dist/esm/api/types/TextReviewAnnotationUpdate.mjs +11 -0
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -12
- package/reference.md +246 -39
|
@@ -11,7 +11,7 @@ export interface AuditLogwithIncludes {
|
|
|
11
11
|
resource_id: string;
|
|
12
12
|
resource_type: AuditLogwithIncludes.ResourceType;
|
|
13
13
|
user?: Frameio.User | undefined;
|
|
14
|
-
user_id
|
|
14
|
+
user_id?: string | undefined;
|
|
15
15
|
workspace_id?: string | undefined;
|
|
16
16
|
}
|
|
17
17
|
export declare namespace AuditLogwithIncludes {
|
|
@@ -1,22 +1,34 @@
|
|
|
1
1
|
import type * as Frameio from "../index.js";
|
|
2
2
|
export interface Comment {
|
|
3
|
+
/** Comment anchor location. {(x, y) | 0 <= x <= 1, 0 <= y <= 1}. */
|
|
4
|
+
anchor?: Frameio.Anchor | undefined;
|
|
3
5
|
annotation?: string | undefined;
|
|
6
|
+
/** Attachments associated with this comment (0-6 attachments allowed) */
|
|
7
|
+
attachments?: Frameio.CommentAttachment[] | undefined;
|
|
4
8
|
/** Completion timestamp */
|
|
5
9
|
completed_at?: string | undefined;
|
|
6
10
|
/** ID of user who marked the comment as completed */
|
|
7
11
|
completer_id?: string | undefined;
|
|
8
12
|
/** Creation timestamp */
|
|
9
13
|
created_at: string;
|
|
14
|
+
/** Duration of comment in frames. Requires presence of timestamp parameter */
|
|
15
|
+
duration?: number | undefined;
|
|
10
16
|
/** File ID */
|
|
11
17
|
file_id: string;
|
|
12
18
|
/** Comment ID */
|
|
13
19
|
id: string;
|
|
20
|
+
/** Links */
|
|
21
|
+
links: Frameio.Link[];
|
|
22
|
+
/** Mentions */
|
|
23
|
+
mentions: Frameio.Mention[];
|
|
14
24
|
/** Document page */
|
|
15
25
|
page?: number | undefined;
|
|
16
26
|
/** Comment text */
|
|
17
27
|
text: string;
|
|
18
28
|
/** Text edited timestamp */
|
|
19
29
|
text_edited_at?: string | undefined;
|
|
30
|
+
/** Text review annotation details for comments left on text documents. */
|
|
31
|
+
text_review_annotation?: Frameio.TextReviewAnnotation | undefined;
|
|
20
32
|
timestamp: Frameio.TimeStamp;
|
|
21
33
|
/** Update timestamp */
|
|
22
34
|
updated_at: string;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface CommentAttachment {
|
|
2
|
+
/** Creation timestamp */
|
|
3
|
+
created_at: string;
|
|
4
|
+
/** Attachment file size in bytes (up to 5TB) */
|
|
5
|
+
file_size: number;
|
|
6
|
+
/** Comment attachment ID */
|
|
7
|
+
id: string;
|
|
8
|
+
/** File media type */
|
|
9
|
+
media_type?: string | undefined;
|
|
10
|
+
/** File name for the attachment */
|
|
11
|
+
name: string;
|
|
12
|
+
/** Comment attachment upload URLs. Number of URLs returned will vary depending on the file size. */
|
|
13
|
+
upload_urls?: string[] | undefined;
|
|
14
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/** Sort query parameter for comments. Include query params for owner is required when sorting by owner. */
|
|
2
|
+
export declare const CommentSort: {
|
|
3
|
+
readonly OwnerAsc: "owner_asc";
|
|
4
|
+
readonly OwnerDesc: "owner_desc";
|
|
5
|
+
readonly CompletedAtAsc: "completed_at_asc";
|
|
6
|
+
readonly CompletedAtDesc: "completed_at_desc";
|
|
7
|
+
readonly CreatedAtAsc: "created_at_asc";
|
|
8
|
+
readonly CreatedAtDesc: "created_at_desc";
|
|
9
|
+
};
|
|
10
|
+
export type CommentSort = (typeof CommentSort)[keyof typeof CommentSort];
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.CommentSort = void 0;
|
|
5
|
+
/** Sort query parameter for comments. Include query params for owner is required when sorting by owner. */
|
|
6
|
+
exports.CommentSort = {
|
|
7
|
+
OwnerAsc: "owner_asc",
|
|
8
|
+
OwnerDesc: "owner_desc",
|
|
9
|
+
CompletedAtAsc: "completed_at_asc",
|
|
10
|
+
CompletedAtDesc: "completed_at_desc",
|
|
11
|
+
CreatedAtAsc: "created_at_asc",
|
|
12
|
+
CreatedAtDesc: "created_at_desc",
|
|
13
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type * as Frameio from "../index.js";
|
|
2
|
+
export interface TextReviewAnnotation {
|
|
3
|
+
/** An array of bounds representing a multiline selection origin at the lower-left corner. */
|
|
4
|
+
bounds: Frameio.TextReviewAnnotationBounds[];
|
|
5
|
+
/** Selected text from the document. */
|
|
6
|
+
selection_text?: string | undefined;
|
|
7
|
+
/** Suggested replacement or insertion text. */
|
|
8
|
+
suggested_text?: string | undefined;
|
|
9
|
+
/** The type of text review annotation. */
|
|
10
|
+
text_review_annotation_type: TextReviewAnnotation.TextReviewAnnotationType;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace TextReviewAnnotation {
|
|
13
|
+
/** The type of text review annotation. */
|
|
14
|
+
const TextReviewAnnotationType: {
|
|
15
|
+
readonly Highlight: "highlight";
|
|
16
|
+
readonly Insert: "insert";
|
|
17
|
+
readonly Remove: "remove";
|
|
18
|
+
readonly Replace: "replace";
|
|
19
|
+
};
|
|
20
|
+
type TextReviewAnnotationType = (typeof TextReviewAnnotationType)[keyof typeof TextReviewAnnotationType];
|
|
21
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.TextReviewAnnotation = void 0;
|
|
5
|
+
var TextReviewAnnotation;
|
|
6
|
+
(function (TextReviewAnnotation) {
|
|
7
|
+
/** The type of text review annotation. */
|
|
8
|
+
TextReviewAnnotation.TextReviewAnnotationType = {
|
|
9
|
+
Highlight: "highlight",
|
|
10
|
+
Insert: "insert",
|
|
11
|
+
Remove: "remove",
|
|
12
|
+
Replace: "replace",
|
|
13
|
+
};
|
|
14
|
+
})(TextReviewAnnotation || (exports.TextReviewAnnotation = TextReviewAnnotation = {}));
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type * as Frameio from "../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* Payload for updating an existing text review annotation.
|
|
4
|
+
*/
|
|
5
|
+
export interface TextReviewAnnotationUpdate {
|
|
6
|
+
/** Optional bounds array. When omitted, previously stored bounds are preserved. */
|
|
7
|
+
bounds?: Frameio.TextReviewAnnotationBounds[] | undefined;
|
|
8
|
+
/** Optional selection text override. */
|
|
9
|
+
selection_text?: string | undefined;
|
|
10
|
+
/** Optional suggestion override. */
|
|
11
|
+
suggested_text?: string | undefined;
|
|
12
|
+
/** Optional annotation type override. */
|
|
13
|
+
text_review_annotation_type?: TextReviewAnnotationUpdate.TextReviewAnnotationType | undefined;
|
|
14
|
+
}
|
|
15
|
+
export declare namespace TextReviewAnnotationUpdate {
|
|
16
|
+
/** Optional annotation type override. */
|
|
17
|
+
const TextReviewAnnotationType: {
|
|
18
|
+
readonly Highlight: "highlight";
|
|
19
|
+
readonly Insert: "insert";
|
|
20
|
+
readonly Remove: "remove";
|
|
21
|
+
readonly Replace: "replace";
|
|
22
|
+
};
|
|
23
|
+
type TextReviewAnnotationType = (typeof TextReviewAnnotationType)[keyof typeof TextReviewAnnotationType];
|
|
24
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.TextReviewAnnotationUpdate = void 0;
|
|
5
|
+
var TextReviewAnnotationUpdate;
|
|
6
|
+
(function (TextReviewAnnotationUpdate) {
|
|
7
|
+
/** Optional annotation type override. */
|
|
8
|
+
TextReviewAnnotationUpdate.TextReviewAnnotationType = {
|
|
9
|
+
Highlight: "highlight",
|
|
10
|
+
Insert: "insert",
|
|
11
|
+
Remove: "remove",
|
|
12
|
+
Replace: "replace",
|
|
13
|
+
};
|
|
14
|
+
})(TextReviewAnnotationUpdate || (exports.TextReviewAnnotationUpdate = TextReviewAnnotationUpdate = {}));
|
|
@@ -3,11 +3,13 @@ export * from "./AccountsResponse.js";
|
|
|
3
3
|
export * from "./AccountUserRole.js";
|
|
4
4
|
export * from "./AccountUserRolesResponse.js";
|
|
5
5
|
export * from "./AddAssetResponse.js";
|
|
6
|
+
export * from "./Anchor.js";
|
|
6
7
|
export * from "./AssetCommon.js";
|
|
7
8
|
export * from "./AssetCommonWithIncludes.js";
|
|
8
9
|
export * from "./AssetInclude.js";
|
|
9
10
|
export * from "./AssetShareParams.js";
|
|
10
11
|
export * from "./AssetWithIncludes.js";
|
|
12
|
+
export * from "./AttachmentInput.js";
|
|
11
13
|
export * from "./AuditLogsInclude.js";
|
|
12
14
|
export * from "./AuditLogsWithIncludesResponse.js";
|
|
13
15
|
export * from "./AuditLogwithIncludes.js";
|
|
@@ -15,8 +17,11 @@ export * from "./BadRequest.js";
|
|
|
15
17
|
export * from "./BooleanValue.js";
|
|
16
18
|
export * from "./ChildrenType.js";
|
|
17
19
|
export * from "./Comment.js";
|
|
20
|
+
export * from "./CommentAttachment.js";
|
|
21
|
+
export * from "./CommentAttachmentResponse.js";
|
|
18
22
|
export * from "./CommentInclude.js";
|
|
19
23
|
export * from "./CommentResponse.js";
|
|
24
|
+
export * from "./CommentSort.js";
|
|
20
25
|
export * from "./CommentsWithIncludesResponse.js";
|
|
21
26
|
export * from "./CommentWithIncludes.js";
|
|
22
27
|
export * from "./CommentWithIncludesResponse.js";
|
|
@@ -59,12 +64,15 @@ export * from "./Include.js";
|
|
|
59
64
|
export * from "./IncludeTotalCount.js";
|
|
60
65
|
export * from "./IntegerValue.js";
|
|
61
66
|
export * from "./JsonErrorResponse.js";
|
|
67
|
+
export * from "./Link.js";
|
|
68
|
+
export * from "./LinkParams.js";
|
|
62
69
|
export * from "./Links.js";
|
|
63
70
|
export * from "./LongTextDefinition.js";
|
|
64
71
|
export * from "./LongTextDefinitionParams.js";
|
|
65
72
|
export * from "./LongTextDefinitionWithIncludes.js";
|
|
66
73
|
export * from "./MediaLinkCommon.js";
|
|
67
74
|
export * from "./MediaLinksCollection.js";
|
|
75
|
+
export * from "./Mention.js";
|
|
68
76
|
export * from "./MetadataField.js";
|
|
69
77
|
export * from "./MetadataResponse.js";
|
|
70
78
|
export * from "./MetadataWithDefinition.js";
|
|
@@ -109,6 +117,9 @@ export * from "./SingleUserValue.js";
|
|
|
109
117
|
export * from "./TextDefinition.js";
|
|
110
118
|
export * from "./TextDefinitionParams.js";
|
|
111
119
|
export * from "./TextDefinitionWithIncludes.js";
|
|
120
|
+
export * from "./TextReviewAnnotation.js";
|
|
121
|
+
export * from "./TextReviewAnnotationBounds.js";
|
|
122
|
+
export * from "./TextReviewAnnotationUpdate.js";
|
|
112
123
|
export * from "./TextValue.js";
|
|
113
124
|
export * from "./TimeStamp.js";
|
|
114
125
|
export * from "./ToggleDefinition.js";
|
|
@@ -19,11 +19,13 @@ __exportStar(require("./AccountsResponse.js"), exports);
|
|
|
19
19
|
__exportStar(require("./AccountUserRole.js"), exports);
|
|
20
20
|
__exportStar(require("./AccountUserRolesResponse.js"), exports);
|
|
21
21
|
__exportStar(require("./AddAssetResponse.js"), exports);
|
|
22
|
+
__exportStar(require("./Anchor.js"), exports);
|
|
22
23
|
__exportStar(require("./AssetCommon.js"), exports);
|
|
23
24
|
__exportStar(require("./AssetCommonWithIncludes.js"), exports);
|
|
24
25
|
__exportStar(require("./AssetInclude.js"), exports);
|
|
25
26
|
__exportStar(require("./AssetShareParams.js"), exports);
|
|
26
27
|
__exportStar(require("./AssetWithIncludes.js"), exports);
|
|
28
|
+
__exportStar(require("./AttachmentInput.js"), exports);
|
|
27
29
|
__exportStar(require("./AuditLogsInclude.js"), exports);
|
|
28
30
|
__exportStar(require("./AuditLogsWithIncludesResponse.js"), exports);
|
|
29
31
|
__exportStar(require("./AuditLogwithIncludes.js"), exports);
|
|
@@ -31,8 +33,11 @@ __exportStar(require("./BadRequest.js"), exports);
|
|
|
31
33
|
__exportStar(require("./BooleanValue.js"), exports);
|
|
32
34
|
__exportStar(require("./ChildrenType.js"), exports);
|
|
33
35
|
__exportStar(require("./Comment.js"), exports);
|
|
36
|
+
__exportStar(require("./CommentAttachment.js"), exports);
|
|
37
|
+
__exportStar(require("./CommentAttachmentResponse.js"), exports);
|
|
34
38
|
__exportStar(require("./CommentInclude.js"), exports);
|
|
35
39
|
__exportStar(require("./CommentResponse.js"), exports);
|
|
40
|
+
__exportStar(require("./CommentSort.js"), exports);
|
|
36
41
|
__exportStar(require("./CommentsWithIncludesResponse.js"), exports);
|
|
37
42
|
__exportStar(require("./CommentWithIncludes.js"), exports);
|
|
38
43
|
__exportStar(require("./CommentWithIncludesResponse.js"), exports);
|
|
@@ -75,12 +80,15 @@ __exportStar(require("./Include.js"), exports);
|
|
|
75
80
|
__exportStar(require("./IncludeTotalCount.js"), exports);
|
|
76
81
|
__exportStar(require("./IntegerValue.js"), exports);
|
|
77
82
|
__exportStar(require("./JsonErrorResponse.js"), exports);
|
|
83
|
+
__exportStar(require("./Link.js"), exports);
|
|
84
|
+
__exportStar(require("./LinkParams.js"), exports);
|
|
78
85
|
__exportStar(require("./Links.js"), exports);
|
|
79
86
|
__exportStar(require("./LongTextDefinition.js"), exports);
|
|
80
87
|
__exportStar(require("./LongTextDefinitionParams.js"), exports);
|
|
81
88
|
__exportStar(require("./LongTextDefinitionWithIncludes.js"), exports);
|
|
82
89
|
__exportStar(require("./MediaLinkCommon.js"), exports);
|
|
83
90
|
__exportStar(require("./MediaLinksCollection.js"), exports);
|
|
91
|
+
__exportStar(require("./Mention.js"), exports);
|
|
84
92
|
__exportStar(require("./MetadataField.js"), exports);
|
|
85
93
|
__exportStar(require("./MetadataResponse.js"), exports);
|
|
86
94
|
__exportStar(require("./MetadataWithDefinition.js"), exports);
|
|
@@ -125,6 +133,9 @@ __exportStar(require("./SingleUserValue.js"), exports);
|
|
|
125
133
|
__exportStar(require("./TextDefinition.js"), exports);
|
|
126
134
|
__exportStar(require("./TextDefinitionParams.js"), exports);
|
|
127
135
|
__exportStar(require("./TextDefinitionWithIncludes.js"), exports);
|
|
136
|
+
__exportStar(require("./TextReviewAnnotation.js"), exports);
|
|
137
|
+
__exportStar(require("./TextReviewAnnotationBounds.js"), exports);
|
|
138
|
+
__exportStar(require("./TextReviewAnnotationUpdate.js"), exports);
|
|
128
139
|
__exportStar(require("./TextValue.js"), exports);
|
|
129
140
|
__exportStar(require("./TimeStamp.js"), exports);
|
|
130
141
|
__exportStar(require("./ToggleDefinition.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "3.
|
|
1
|
+
export declare const SDK_VERSION = "3.2.0";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
|
|
|
6
6
|
const headers = mergeHeaders({
|
|
7
7
|
"X-Fern-Language": "JavaScript",
|
|
8
8
|
"X-Fern-SDK-Name": "frameio",
|
|
9
|
-
"X-Fern-SDK-Version": "3.
|
|
10
|
-
"User-Agent": "frameio/3.
|
|
9
|
+
"X-Fern-SDK-Version": "3.2.0",
|
|
10
|
+
"User-Agent": "frameio/3.2.0",
|
|
11
11
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
12
12
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
13
13
|
}, options === null || options === void 0 ? void 0 : options.headers);
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -28,8 +28,8 @@ export declare class FrameioClient {
|
|
|
28
28
|
protected _folders: FoldersClient | undefined;
|
|
29
29
|
protected _versionStacks: VersionStacksClient | undefined;
|
|
30
30
|
protected _accountPermissions: AccountPermissionsClient | undefined;
|
|
31
|
-
protected _accounts: AccountsClient | undefined;
|
|
32
31
|
protected _comments: CommentsClient | undefined;
|
|
32
|
+
protected _accounts: AccountsClient | undefined;
|
|
33
33
|
protected _webhooks: WebhooksClient | undefined;
|
|
34
34
|
protected _workspacePermissions: WorkspacePermissionsClient | undefined;
|
|
35
35
|
protected _shares: SharesClient | undefined;
|
|
@@ -44,8 +44,8 @@ export declare class FrameioClient {
|
|
|
44
44
|
get folders(): FoldersClient;
|
|
45
45
|
get versionStacks(): VersionStacksClient;
|
|
46
46
|
get accountPermissions(): AccountPermissionsClient;
|
|
47
|
-
get accounts(): AccountsClient;
|
|
48
47
|
get comments(): CommentsClient;
|
|
48
|
+
get accounts(): AccountsClient;
|
|
49
49
|
get webhooks(): WebhooksClient;
|
|
50
50
|
get workspacePermissions(): WorkspacePermissionsClient;
|
|
51
51
|
get shares(): SharesClient;
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -49,14 +49,14 @@ export class FrameioClient {
|
|
|
49
49
|
var _a;
|
|
50
50
|
return ((_a = this._accountPermissions) !== null && _a !== void 0 ? _a : (this._accountPermissions = new AccountPermissionsClient(this._options)));
|
|
51
51
|
}
|
|
52
|
-
get accounts() {
|
|
53
|
-
var _a;
|
|
54
|
-
return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new AccountsClient(this._options)));
|
|
55
|
-
}
|
|
56
52
|
get comments() {
|
|
57
53
|
var _a;
|
|
58
54
|
return ((_a = this._comments) !== null && _a !== void 0 ? _a : (this._comments = new CommentsClient(this._options)));
|
|
59
55
|
}
|
|
56
|
+
get accounts() {
|
|
57
|
+
var _a;
|
|
58
|
+
return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new AccountsClient(this._options)));
|
|
59
|
+
}
|
|
60
60
|
get webhooks() {
|
|
61
61
|
var _a;
|
|
62
62
|
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient(this._options)));
|
|
@@ -13,6 +13,54 @@ export declare namespace CommentsClient {
|
|
|
13
13
|
export declare class CommentsClient {
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<CommentsClient.Options>;
|
|
15
15
|
constructor(options: CommentsClient.Options);
|
|
16
|
+
/**
|
|
17
|
+
* Delete an attachment from a comment. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
18
|
+
*
|
|
19
|
+
* @param {Frameio.Uuid} account_id
|
|
20
|
+
* @param {Frameio.Uuid} comment_id
|
|
21
|
+
* @param {Frameio.Uuid} attachment_id
|
|
22
|
+
* @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
23
|
+
*
|
|
24
|
+
* @throws {@link Frameio.BadRequestError}
|
|
25
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
26
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
27
|
+
* @throws {@link Frameio.NotFoundError}
|
|
28
|
+
* @throws {@link Frameio.ConflictError}
|
|
29
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
30
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* await client.comments.deleteAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
34
|
+
*/
|
|
35
|
+
deleteAttachment(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, attachment_id: Frameio.Uuid, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
36
|
+
private __deleteAttachment;
|
|
37
|
+
/**
|
|
38
|
+
* Create an attachment for an existing comment. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
39
|
+
*
|
|
40
|
+
* @param {Frameio.Uuid} account_id
|
|
41
|
+
* @param {Frameio.Uuid} comment_id
|
|
42
|
+
* @param {Frameio.CreateAttachmentParams} request
|
|
43
|
+
* @param {CommentsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link Frameio.BadRequestError}
|
|
46
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
47
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
48
|
+
* @throws {@link Frameio.NotFoundError}
|
|
49
|
+
* @throws {@link Frameio.ConflictError}
|
|
50
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
51
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* await client.comments.createAttachment("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
55
|
+
* data: {
|
|
56
|
+
* file_size: 1024000,
|
|
57
|
+
* media_type: "image/png",
|
|
58
|
+
* name: "screenshot.png"
|
|
59
|
+
* }
|
|
60
|
+
* })
|
|
61
|
+
*/
|
|
62
|
+
createAttachment(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, request: Frameio.CreateAttachmentParams, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<Frameio.CommentAttachmentResponse>;
|
|
63
|
+
private __createAttachment;
|
|
16
64
|
/**
|
|
17
65
|
* Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
18
66
|
*
|
|
@@ -58,7 +106,7 @@ export declare class CommentsClient {
|
|
|
58
106
|
delete(account_id: Frameio.Uuid, comment_id: Frameio.Uuid, requestOptions?: CommentsClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
59
107
|
private __delete;
|
|
60
108
|
/**
|
|
61
|
-
* Update comment on given asset
|
|
109
|
+
* Update comment on given asset.<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
62
110
|
*
|
|
63
111
|
* @param {Frameio.Uuid} account_id
|
|
64
112
|
* @param {Frameio.Uuid} comment_id
|
|
@@ -77,10 +125,25 @@ export declare class CommentsClient {
|
|
|
77
125
|
* await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
78
126
|
* timestamp_as_timecode: true,
|
|
79
127
|
* data: {
|
|
128
|
+
* anchor: {
|
|
129
|
+
* x: 0.5,
|
|
130
|
+
* y: 0.5
|
|
131
|
+
* },
|
|
80
132
|
* 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}]",
|
|
81
133
|
* completed: false,
|
|
134
|
+
* duration: 10,
|
|
135
|
+
* links: [{
|
|
136
|
+
* end_index: 13,
|
|
137
|
+
* start_index: 5,
|
|
138
|
+
* url: "https://www.example.com"
|
|
139
|
+
* }],
|
|
82
140
|
* page: 4,
|
|
83
|
-
* text: "This is great!"
|
|
141
|
+
* text: "This is great!",
|
|
142
|
+
* text_review_annotation: {
|
|
143
|
+
* selection_text: "existing copy",
|
|
144
|
+
* suggested_text: "updated copy"
|
|
145
|
+
* },
|
|
146
|
+
* timestamp: 100
|
|
84
147
|
* }
|
|
85
148
|
* })
|
|
86
149
|
*/
|
|
@@ -106,6 +169,7 @@ export declare class CommentsClient {
|
|
|
106
169
|
* await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
107
170
|
* timestamp_as_timecode: true,
|
|
108
171
|
* include: "owner",
|
|
172
|
+
* sort: "owner_asc",
|
|
109
173
|
* after: "<opaque_cursor>",
|
|
110
174
|
* page_size: 10,
|
|
111
175
|
* include_total_count: false
|
|
@@ -132,10 +196,36 @@ export declare class CommentsClient {
|
|
|
132
196
|
* await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
133
197
|
* timestamp_as_timecode: true,
|
|
134
198
|
* data: {
|
|
199
|
+
* anchor: {
|
|
200
|
+
* x: 0.5,
|
|
201
|
+
* y: 0.5
|
|
202
|
+
* },
|
|
135
203
|
* 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}]",
|
|
204
|
+
* attachments: [{
|
|
205
|
+
* file_size: 1024000,
|
|
206
|
+
* media_type: "image/png",
|
|
207
|
+
* name: "screenshot.png"
|
|
208
|
+
* }],
|
|
136
209
|
* completed: false,
|
|
210
|
+
* duration: 10,
|
|
211
|
+
* links: [{
|
|
212
|
+
* end_index: 13,
|
|
213
|
+
* start_index: 5,
|
|
214
|
+
* url: "https://www.example.com"
|
|
215
|
+
* }],
|
|
137
216
|
* page: 4,
|
|
138
217
|
* text: "This is great!",
|
|
218
|
+
* text_review_annotation: {
|
|
219
|
+
* bounds: [{
|
|
220
|
+
* height: 42,
|
|
221
|
+
* width: 130,
|
|
222
|
+
* x: 12.5,
|
|
223
|
+
* y: 24
|
|
224
|
+
* }],
|
|
225
|
+
* selection_text: "existing copy",
|
|
226
|
+
* suggested_text: "updated copy",
|
|
227
|
+
* text_review_annotation_type: "replace"
|
|
228
|
+
* },
|
|
139
229
|
* timestamp: "00:00:02:12"
|
|
140
230
|
* }
|
|
141
231
|
* })
|