frameio 4.1.1 → 4.2.1

package/dist/cjs/api/types/SearchMatch.d.ts

@@ -0,0 +1,106 @@
+import type * as Frameio from "../index.js";
+/**
+ * A match explaining why a result was returned
+ */
+export type SearchMatch = Frameio.SearchMatch.NameMatch | Frameio.SearchMatch.SourceFilenameMatch | Frameio.SearchMatch.ProjectMatch | Frameio.SearchMatch.CreatorMatch | Frameio.SearchMatch.AssigneeMatch | Frameio.SearchMatch.FormatMatch | Frameio.SearchMatch.KeywordsMatch | Frameio.SearchMatch.StatusMatch | Frameio.SearchMatch.VisualMatch | Frameio.SearchMatch.TranscriptionMatch | Frameio.SearchMatch.CommentMatch | Frameio.SearchMatch.RatingMatch | Frameio.SearchMatch.CommentCountMatch | Frameio.SearchMatch.PageCountMatch | Frameio.SearchMatch.DurationMatch | Frameio.SearchMatch.FilesizeMatch | Frameio.SearchMatch.AudioSampleRateMatch | Frameio.SearchMatch.NotesMatch | Frameio.SearchMatch.UploadedAtMatch | Frameio.SearchMatch.UpdatedAtMatch | Frameio.SearchMatch.DeletedAtMatch | Frameio.SearchMatch.InsertedAtMatch | Frameio.SearchMatch.FileTypeMatch | Frameio.SearchMatch.BitDepthMatch | Frameio.SearchMatch.BitRateMatch | Frameio.SearchMatch.CodecMatch | Frameio.SearchMatch.ChannelsMatch | Frameio.SearchMatch.FrameRateMatch | Frameio.SearchMatch.HasAlphaChannelMatch | Frameio.SearchMatch.ColorSpaceMatch | Frameio.SearchMatch.ResolutionWidthMatch | Frameio.SearchMatch.ResolutionHeightMatch | Frameio.SearchMatch.DynamicRangeMatch;
+export declare namespace SearchMatch {
+    interface NameMatch extends Frameio.NameMatch {
+        type: "name_match";
+    }
+    interface SourceFilenameMatch extends Frameio.SourceFilenameMatch {
+        type: "source_filename_match";
+    }
+    interface ProjectMatch extends Frameio.ProjectMatch {
+        type: "project_match";
+    }
+    interface CreatorMatch extends Frameio.CreatorMatch {
+        type: "creator_match";
+    }
+    interface AssigneeMatch extends Frameio.AssigneeMatch {
+        type: "assignee_match";
+    }
+    interface FormatMatch extends Frameio.FormatMatch {
+        type: "format_match";
+    }
+    interface KeywordsMatch extends Frameio.KeywordsMatch {
+        type: "keywords_match";
+    }
+    interface StatusMatch extends Frameio.StatusMatch {
+        type: "status_match";
+    }
+    interface VisualMatch extends Frameio.VisualMatch {
+        type: "visual_match";
+    }
+    interface TranscriptionMatch extends Frameio.TranscriptionMatch {
+        type: "transcription_match";
+    }
+    interface CommentMatch extends Frameio.CommentMatch {
+        type: "comment_match";
+    }
+    interface RatingMatch extends Frameio.RatingMatch {
+        type: "rating_match";
+    }
+    interface CommentCountMatch extends Frameio.CommentCountMatch {
+        type: "comment_count_match";
+    }
+    interface PageCountMatch extends Frameio.PageCountMatch {
+        type: "page_count_match";
+    }
+    interface DurationMatch extends Frameio.DurationMatch {
+        type: "duration_match";
+    }
+    interface FilesizeMatch extends Frameio.FilesizeMatch {
+        type: "filesize_match";
+    }
+    interface AudioSampleRateMatch extends Frameio.AudioSampleRateMatch {
+        type: "audio_sample_rate_match";
+    }
+    interface NotesMatch extends Frameio.NotesMatch {
+        type: "notes_match";
+    }
+    interface UploadedAtMatch extends Frameio.UploadedAtMatch {
+        type: "uploaded_at_match";
+    }
+    interface UpdatedAtMatch extends Frameio.UpdatedAtMatch {
+        type: "updated_at_match";
+    }
+    interface DeletedAtMatch extends Frameio.DeletedAtMatch {
+        type: "deleted_at_match";
+    }
+    interface InsertedAtMatch extends Frameio.InsertedAtMatch {
+        type: "inserted_at_match";
+    }
+    interface FileTypeMatch extends Frameio.FileTypeMatch {
+        type: "file_type_match";
+    }
+    interface BitDepthMatch extends Frameio.BitDepthMatch {
+        type: "bit_depth_match";
+    }
+    interface BitRateMatch extends Frameio.BitRateMatch {
+        type: "bit_rate_match";
+    }
+    interface CodecMatch extends Frameio.CodecMatch {
+        type: "codec_match";
+    }
+    interface ChannelsMatch extends Frameio.ChannelsMatch {
+        type: "channels_match";
+    }
+    interface FrameRateMatch extends Frameio.FrameRateMatch {
+        type: "frame_rate_match";
+    }
+    interface HasAlphaChannelMatch extends Frameio.HasAlphaChannelMatch {
+        type: "has_alpha_channel_match";
+    }
+    interface ColorSpaceMatch extends Frameio.ColorSpaceMatch {
+        type: "color_space_match";
+    }
+    interface ResolutionWidthMatch extends Frameio.ResolutionWidthMatch {
+        type: "resolution_width_match";
+    }
+    interface ResolutionHeightMatch extends Frameio.ResolutionHeightMatch {
+        type: "resolution_height_match";
+    }
+    interface DynamicRangeMatch extends Frameio.DynamicRangeMatch {
+        type: "dynamic_range_match";
+    }
+}

package/dist/cjs/api/types/SearchMatch.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/types/SearchResponse.d.ts

@@ -0,0 +1,17 @@
+import type * as Frameio from "../index.js";
+/**
+ * Response containing search results
+ */
+export interface SearchResponse {
+    /** List of search results */
+    data: SearchResponse.Data.Item[];
+    links: Frameio.Links;
+    /** Total number of matching results */
+    total_count?: number | undefined;
+}
+export declare namespace SearchResponse {
+    type Data = Data.Item[];
+    namespace Data {
+        type Item = Frameio.AssetSearchResult | Frameio.ProjectSearchResult;
+    }
+}

package/dist/cjs/api/types/SearchResponse.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/types/Share.d.ts

@@ -2,12 +2,15 @@ export interface Share {
     access: Share.Access;
     /** Collection ID */
     collection_id: string;
+    /** Whether commenting is enabled on the share */
     commenting_enabled: boolean;
     /** Creation timestamp */
     created_at: string;
     /** Share description */
     description?: string | undefined;
+    /** Whether downloading is enabled on the share */
     downloading_enabled: boolean;
+    /** Whether the share link is active */
     enabled: boolean;
     /** Expiration timestamp */
     expiration?: string | undefined;

package/dist/cjs/api/types/ShareSort.d.ts

@@ -0,0 +1,8 @@
+/** Sort query parameter for shares */
+export declare const ShareSort: {
+    readonly NameAsc: "name_asc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly NameDesc: "name_desc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type ShareSort = (typeof ShareSort)[keyof typeof ShareSort];

package/dist/cjs/api/types/ShareSort.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShareSort = void 0;
+/** Sort query parameter for shares */
+exports.ShareSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

package/dist/cjs/api/types/SingleUserValue.d.ts

@@ -1,6 +1,6 @@
 import type * as Frameio from "../index.js";
 export interface SingleUserValue extends Frameio.FieldValueCommon {
-    /** Populated with costum member options only if `member_options_type` is set to 'custom'. */
+    /** Populated with custom member options only if `member_options_type` is set to 'custom'. */
     custom_members?: Frameio.UserValue[] | undefined;
     member_options_type?: SingleUserValue.MemberOptionsType | undefined;
     value: Frameio.UserValue[];

package/dist/cjs/api/types/SourceFilenameMatch.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The result's original file name is a match for the search query
+ */
+export interface SourceFilenameMatch {
+    /** The original file name of the result */
+    source_filename: string;
+    /** The terms in the search query that matched the result's original file name */
+    terms: string[];
+}

package/dist/cjs/api/types/SourceFilenameMatch.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/types/StatusMatch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The result's status is a match for the search query
+ */
+export interface StatusMatch {
+    /** The status of the result */
+    status: string;
+}

package/dist/cjs/api/types/StatusMatch.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/types/SyncGroupWithIncludes.d.ts

@@ -0,0 +1,15 @@
+import type * as Frameio from "../index.js";
+export interface SyncGroupWithIncludes extends Frameio.GroupCommonWithIncludes {
+    /** Imported group sync status */
+    sync_status: SyncGroupWithIncludes.SyncStatus;
+}
+export declare namespace SyncGroupWithIncludes {
+    /** Imported group sync status */
+    const SyncStatus: {
+        readonly NotStarted: "not_started";
+        readonly InProgress: "in_progress";
+        readonly Completed: "completed";
+        readonly Error: "error";
+    };
+    type SyncStatus = (typeof SyncStatus)[keyof typeof SyncStatus];
+}

package/dist/cjs/api/types/SyncGroupWithIncludes.js

@@ -0,0 +1,14 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncGroupWithIncludes = void 0;
+var SyncGroupWithIncludes;
+(function (SyncGroupWithIncludes) {
+    /** Imported group sync status */
+    SyncGroupWithIncludes.SyncStatus = {
+        NotStarted: "not_started",
+        InProgress: "in_progress",
+        Completed: "completed",
+        Error: "error",
+    };
+})(SyncGroupWithIncludes || (exports.SyncGroupWithIncludes = SyncGroupWithIncludes = {}));

package/dist/cjs/api/types/TranscriptionMatch.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The result's transcription is a match for the search query
+ */
+export interface TranscriptionMatch {
+    /** The transcriptions that match */
+    matches: TranscriptionMatch.Matches.Item[];
+}
+export declare namespace TranscriptionMatch {
+    type Matches = Matches.Item[];
+    namespace Matches {
+        /**
+         * A transcription segment that is a match for the search query
+         */
+        interface Item {
+            /** Transcription segment ID */
+            id: string;
+            /** The small portion of the transcription that is a match for the search query */
+            snippets: string[];
+            /** The terms in the search query that are a match for the result's transcription */
+            terms: string[];
+        }
+    }
+}

package/dist/cjs/api/types/TranscriptionMatch.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/types/UpdateWorkspaceRoleResponse.d.ts

@@ -0,0 +1,9 @@
+import type * as Frameio from "../index.js";
+export interface UpdateWorkspaceRoleResponse {
+    data: UpdateWorkspaceRoleResponse.Data;
+}
+export declare namespace UpdateWorkspaceRoleResponse {
+    interface Data {
+        role?: Frameio.WorkspaceRole | undefined;
+    }
+}

package/dist/cjs/api/types/UpdateWorkspaceRoleResponse.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/types/UpdatedAtMatch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The result's updated at timestamp is a match for the search query
+ */
+export interface UpdatedAtMatch {
+    /** The updated at timestamp of the result */
+    updated_at: string;
+}

package/dist/cjs/api/types/UpdatedAtMatch.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/types/UploadedAtMatch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The result's uploaded at timestamp is a match for the search query
+ */
+export interface UploadedAtMatch {
+    /** The uploaded at timestamp of the result */
+    uploaded_at: string;
+}

package/dist/cjs/api/types/UploadedAtMatch.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/types/UserRole.d.ts

@@ -8,6 +8,7 @@ export interface UserRole {
 }
 export declare namespace UserRole {
     const Role: {
+        readonly WorkspaceAdmin: "workspace_admin";
         readonly FullAccess: "full_access";
         readonly Editor: "editor";
         readonly EditOnly: "edit_only";

package/dist/cjs/api/types/UserRole.js

@@ -5,6 +5,7 @@ exports.UserRole = void 0;
 var UserRole;
 (function (UserRole) {
     UserRole.Role = {
+        WorkspaceAdmin: "workspace_admin",
         FullAccess: "full_access",
         Editor: "editor",
         EditOnly: "edit_only",

package/dist/cjs/api/types/UserRoleSort.d.ts

@@ -0,0 +1,10 @@
+/** Sort query parameter for users */
+export declare const UserRoleSort: {
+    readonly RoleAsc: "role_asc";
+    readonly RoleDesc: "role_desc";
+    readonly NameAsc: "name_asc";
+    readonly NameDesc: "name_desc";
+    readonly EmailAsc: "email_asc";
+    readonly EmailDesc: "email_desc";
+};
+export type UserRoleSort = (typeof UserRoleSort)[keyof typeof UserRoleSort];

package/dist/cjs/api/types/UserRoleSort.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.UserRoleSort = void 0;
+/** Sort query parameter for users */
+exports.UserRoleSort = {
+    RoleAsc: "role_asc",
+    RoleDesc: "role_desc",
+    NameAsc: "name_asc",
+    NameDesc: "name_desc",
+    EmailAsc: "email_asc",
+    EmailDesc: "email_desc",
+};

package/dist/cjs/api/types/UserRolesResponse.d.ts

@@ -0,0 +1,11 @@
+import type * as Frameio from "../index.js";
+/**
+ * Frame.io user role details
+ */
+export interface UserRolesResponse {
+    /** User Roles */
+    data: Frameio.UserRole[];
+    links: Frameio.Links;
+    /** Total count */
+    total_count?: number | undefined;
+}

package/dist/cjs/api/types/UserRolesResponse.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/types/Uuid.d.ts

@@ -1,4 +1,4 @@
 /**
- * A UUID String
+ * A UUID string that uniquely identifies a Frame.io entity.
  */
 export type Uuid = string;

package/dist/cjs/api/types/VersionStack.d.ts

@@ -3,6 +3,8 @@ export interface VersionStack {
     head_version: Frameio.File_;
     /** Parent Folder ID */
     parent_id?: string | undefined;
+    /** Adobe cloud storage asset identifier, when available. */
+    adobe_id?: string | undefined;
     /** Creation timestamp */
     created_at: string;
     /** File, Folder, or Version Stack ID */

package/dist/cjs/api/types/VersionStackWithIncludes.d.ts

@@ -3,6 +3,8 @@ export interface VersionStackWithIncludes {
     head_version?: Frameio.FileWithIncludes | undefined;
     /** Parent Folder ID */
     parent_id?: string | undefined;
+    /** Adobe cloud storage asset identifier, when available. */
+    adobe_id?: string | undefined;
     /** Creation timestamp */
     created_at: string;
     creator?: Frameio.User | undefined;

package/dist/cjs/api/types/VisualMatch.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The result's content vector embedding is a match for the search query
+ */
+export interface VisualMatch {
+    /** The list of subclips matching the query */
+    clips: VisualMatch.Clips.Item[];
+}
+export declare namespace VisualMatch {
+    type Clips = Clips.Item[];
+    namespace Clips {
+        /**
+         * A subclip within a video that is a match for the search query
+         */
+        interface Item {
+            /** Best matching frame time in milliseconds */
+            best_frame_time: number;
+            /** End time in milliseconds */
+            end_time: number;
+            /** Chronological index of this clip */
+            index: number;
+            /** Index ordered by relevancy score */
+            relevancy_index: number;
+            /** Start time in milliseconds */
+            start_time: number;
+        }
+    }
+}

package/dist/cjs/api/types/VisualMatch.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/types/VisualMatchClip.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A subclip within a video that is a match for the search query
+ */
+export interface VisualMatchClip {
+    /** Best matching frame time in milliseconds */
+    best_frame_time: number;
+    /** End time in milliseconds */
+    end_time: number;
+    /** Chronological index of this clip */
+    index: number;
+    /** Index ordered by relevancy score */
+    relevancy_index: number;
+    /** Start time in milliseconds */
+    start_time: number;
+}

package/dist/cjs/api/types/VisualMatchClip.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/types/WorkspaceRole.d.ts

@@ -0,0 +1,10 @@
+/** A workspace role. */
+export declare const WorkspaceRole: {
+    readonly WorkspaceAdmin: "workspace_admin";
+    readonly FullAccess: "full_access";
+    readonly Editor: "editor";
+    readonly EditOnly: "edit_only";
+    readonly Commenter: "commenter";
+    readonly Viewer: "viewer";
+};
+export type WorkspaceRole = (typeof WorkspaceRole)[keyof typeof WorkspaceRole];

package/dist/cjs/api/types/WorkspaceRole.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.WorkspaceRole = void 0;
+/** A workspace role. */
+exports.WorkspaceRole = {
+    WorkspaceAdmin: "workspace_admin",
+    FullAccess: "full_access",
+    Editor: "editor",
+    EditOnly: "edit_only",
+    Commenter: "commenter",
+    Viewer: "viewer",
+};

package/dist/cjs/api/types/WorkspaceSort.d.ts

@@ -0,0 +1,8 @@
+/** Sort query parameter for workspaces */
+export declare const WorkspaceSort: {
+    readonly NameAsc: "name_asc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly NameDesc: "name_desc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type WorkspaceSort = (typeof WorkspaceSort)[keyof typeof WorkspaceSort];

package/dist/cjs/api/types/WorkspaceSort.js

@@ -0,0 +1,11 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceSort = void 0;
+/** Sort query parameter for workspaces */
+exports.WorkspaceSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

package/dist/cjs/api/types/WorkspaceUserRole.d.ts

@@ -0,0 +1,21 @@
+import type * as Frameio from "../index.js";
+/**
+ * Frame.io Workspace User Role
+ */
+export interface WorkspaceUserRole {
+    role: WorkspaceUserRole.Role;
+    user: Frameio.User;
+}
+export declare namespace WorkspaceUserRole {
+    const Role: {
+        readonly FullAccess: "full_access";
+        readonly Editor: "editor";
+        readonly EditOnly: "edit_only";
+        readonly Commenter: "commenter";
+        readonly Viewer: "viewer";
+        readonly Admin: "admin";
+        readonly Owner: "owner";
+        readonly WorkspaceAdmin: "workspace_admin";
+    };
+    type Role = (typeof Role)[keyof typeof Role];
+}

package/dist/cjs/api/types/WorkspaceUserRole.js

@@ -0,0 +1,17 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkspaceUserRole = void 0;
+var WorkspaceUserRole;
+(function (WorkspaceUserRole) {
+    WorkspaceUserRole.Role = {
+        FullAccess: "full_access",
+        Editor: "editor",
+        EditOnly: "edit_only",
+        Commenter: "commenter",
+        Viewer: "viewer",
+        Admin: "admin",
+        Owner: "owner",
+        WorkspaceAdmin: "workspace_admin",
+    };
+})(WorkspaceUserRole || (exports.WorkspaceUserRole = WorkspaceUserRole = {}));

package/dist/cjs/api/types/WorkspaceUserRolesResponse.d.ts

@@ -1,10 +1,10 @@
 import type * as Frameio from "../index.js";
 /**
- * Frame.io user role details
+ * Frame.io workspace user role details
  */
 export interface WorkspaceUserRolesResponse {
     /** User Roles */
-    data: Frameio.UserRole[];
+    data: Frameio.WorkspaceUserRole[];
     links: Frameio.Links;
     /** Total count */
     total_count?: number | undefined;