frameio 4.1.1 → 4.2.1

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

@@ -1,6 +1,6 @@
 import type * as Frameio from "../index.mjs";
 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/esm/api/types/SourceFilenameMatch.d.mts

@@ -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/esm/api/types/SourceFilenameMatch.mjs

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

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

@@ -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/esm/api/types/StatusMatch.mjs

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

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

@@ -0,0 +1,15 @@
+import type * as Frameio from "../index.mjs";
+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/esm/api/types/SyncGroupWithIncludes.mjs

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+export var SyncGroupWithIncludes;
+(function (SyncGroupWithIncludes) {
+    /** Imported group sync status */
+    SyncGroupWithIncludes.SyncStatus = {
+        NotStarted: "not_started",
+        InProgress: "in_progress",
+        Completed: "completed",
+        Error: "error",
+    };
+})(SyncGroupWithIncludes || (SyncGroupWithIncludes = {}));

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

@@ -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/esm/api/types/TranscriptionMatch.mjs

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

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

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

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

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

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

@@ -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/esm/api/types/UpdatedAtMatch.mjs

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

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

@@ -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/esm/api/types/UploadedAtMatch.mjs

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

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

@@ -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/esm/api/types/UserRole.mjs

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

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

@@ -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/esm/api/types/UserRoleSort.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Sort query parameter for users */
+export const UserRoleSort = {
+    RoleAsc: "role_asc",
+    RoleDesc: "role_desc",
+    NameAsc: "name_asc",
+    NameDesc: "name_desc",
+    EmailAsc: "email_asc",
+    EmailDesc: "email_desc",
+};

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

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

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

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

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

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

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

@@ -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/esm/api/types/VersionStackWithIncludes.d.mts

@@ -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/esm/api/types/VisualMatch.d.mts

@@ -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/esm/api/types/VisualMatch.mjs

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

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

@@ -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/esm/api/types/VisualMatchClip.mjs

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

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

@@ -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/esm/api/types/WorkspaceRole.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+/** A workspace role. */
+export const WorkspaceRole = {
+    WorkspaceAdmin: "workspace_admin",
+    FullAccess: "full_access",
+    Editor: "editor",
+    EditOnly: "edit_only",
+    Commenter: "commenter",
+    Viewer: "viewer",
+};

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

@@ -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/esm/api/types/WorkspaceSort.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Sort query parameter for workspaces */
+export const WorkspaceSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

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

@@ -0,0 +1,21 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * 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/esm/api/types/WorkspaceUserRole.mjs

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+export 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 || (WorkspaceUserRole = {}));

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

@@ -1,10 +1,10 @@
 import type * as Frameio from "../index.mjs";
 /**
- * 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;

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

@@ -1,40 +1,68 @@
 export * from "./Account.mjs";
+export * from "./AccountSort.mjs";
 export * from "./AccountsResponse.mjs";
 export * from "./AccountUserRole.mjs";
 export * from "./AccountUserRolesResponse.mjs";
+export * from "./AccountUserSort.mjs";
+export * from "./Action.mjs";
+export * from "./ActionCreateResponse.mjs";
+export * from "./ActionInclude.mjs";
+export * from "./ActionResponse.mjs";
+export * from "./ActionsWithIncludesResponse.mjs";
+export * from "./ActionWithIncludes.mjs";
+export * from "./ActionWithIncludesResponse.mjs";
 export * from "./AddAssetResponse.mjs";
 export * from "./Anchor.mjs";
 export * from "./AssetCommon.mjs";
 export * from "./AssetCommonWithIncludes.mjs";
 export * from "./AssetInclude.mjs";
+export * from "./AssetSearchResult.mjs";
 export * from "./AssetShareParams.mjs";
 export * from "./AssetWithIncludes.mjs";
+export * from "./AssigneeMatch.mjs";
 export * from "./AttachmentInput.mjs";
+export * from "./AudioSampleRateMatch.mjs";
 export * from "./AuditLogsInclude.mjs";
 export * from "./AuditLogsWithIncludesResponse.mjs";
 export * from "./AuditLogwithIncludes.mjs";
 export * from "./BadRequest.mjs";
+export * from "./BitDepthMatch.mjs";
+export * from "./BitRateMatch.mjs";
 export * from "./BooleanValue.mjs";
+export * from "./ChannelsMatch.mjs";
 export * from "./ChildrenType.mjs";
+export * from "./CodecMatch.mjs";
+export * from "./Collection.mjs";
+export * from "./CollectionInclude.mjs";
+export * from "./CollectionResponse.mjs";
+export * from "./CollectionsResponse.mjs";
+export * from "./ColorSpaceMatch.mjs";
 export * from "./Comment.mjs";
 export * from "./CommentAttachment.mjs";
 export * from "./CommentAttachmentResponse.mjs";
+export * from "./CommentCountMatch.mjs";
 export * from "./CommentInclude.mjs";
+export * from "./CommentMatch.mjs";
 export * from "./CommentResponse.mjs";
 export * from "./CommentSort.mjs";
 export * from "./CommentsWithIncludesResponse.mjs";
 export * from "./CommentWithIncludes.mjs";
 export * from "./CommentWithIncludesResponse.mjs";
 export * from "./Conflict.mjs";
+export * from "./CreatorMatch.mjs";
 export * from "./DateDefinition.mjs";
 export * from "./DateDefinitionParams.mjs";
 export * from "./DateDefinitionWithIncludes.mjs";
 export * from "./DateValue.mjs";
+export * from "./DeletedAtMatch.mjs";
+export * from "./DurationMatch.mjs";
+export * from "./DynamicRangeMatch.mjs";
 export * from "./Email.mjs";
 export * from "./EmptyJson.mjs";
 export * from "./FieldDefinition.mjs";
 export * from "./FieldDefinitionInclude.mjs";
 export * from "./FieldDefinitionResponse.mjs";
+export * from "./FieldDefinitionSort.mjs";
 export * from "./FieldDefinitionsWithIncludesResponse.mjs";
 export * from "./FieldDefinitionWithIncludes.mjs";
 export * from "./FieldValueCommon.mjs";
@@ -44,6 +72,8 @@ export * from "./FileCopyResponse.mjs";
 export * from "./FileRemoteUploadResponse.mjs";
 export * from "./FileResponse.mjs";
 export * from "./FileSort.mjs";
+export * from "./FilesizeMatch.mjs";
+export * from "./FileTypeMatch.mjs";
 export * from "./FileUploadStatus.mjs";
 export * from "./FileUploadStatusResponse.mjs";
 export * from "./FileWithIncludes.mjs";
@@ -60,10 +90,24 @@ export * from "./FoldersWithIncludesResponse.mjs";
 export * from "./FolderWithIncludes.mjs";
 export * from "./FolderWithIncludesResponse.mjs";
 export * from "./Forbidden.mjs";
+export * from "./FormatMatch.mjs";
+export * from "./FrameOrAdobeId.mjs";
+export * from "./FrameRateMatch.mjs";
+export * from "./GroupCommon.mjs";
+export * from "./GroupCommonWithIncludes.mjs";
+export * from "./GroupResponse.mjs";
+export * from "./GroupsInclude.mjs";
+export * from "./GroupsSort.mjs";
+export * from "./GroupsWithIncludesResponse.mjs";
+export * from "./GroupWithIncludes.mjs";
+export * from "./GroupWithIncludesResponse.mjs";
+export * from "./HasAlphaChannelMatch.mjs";
 export * from "./Include.mjs";
 export * from "./IncludeTotalCount.mjs";
+export * from "./InsertedAtMatch.mjs";
 export * from "./IntegerValue.mjs";
 export * from "./JsonErrorResponse.mjs";
+export * from "./KeywordsMatch.mjs";
 export * from "./Link.mjs";
 export * from "./LinkParams.mjs";
 export * from "./Links.mjs";
@@ -78,18 +122,25 @@ export * from "./MetadataResponse.mjs";
 export * from "./MetadataWithDefinition.mjs";
 export * from "./MultiSelectValue.mjs";
 export * from "./MultiUserValue.mjs";
+export * from "./NameMatch.mjs";
 export * from "./NoContent.mjs";
+export * from "./NotesMatch.mjs";
 export * from "./NotFound.mjs";
 export * from "./NumberDefinition.mjs";
 export * from "./NumberDefinitionParams.mjs";
 export * from "./NumberDefinitionWithIncludes.mjs";
 export * from "./NumberValue.mjs";
 export * from "./OriginalMediaLink.mjs";
+export * from "./PageCountMatch.mjs";
 export * from "./Profile.mjs";
 export * from "./ProfileResponse.mjs";
 export * from "./Project.mjs";
 export * from "./ProjectInclude.mjs";
+export * from "./ProjectMatch.mjs";
+export * from "./ProjectMatchInfo.mjs";
 export * from "./ProjectResponse.mjs";
+export * from "./ProjectSearchResult.mjs";
+export * from "./ProjectSort.mjs";
 export * from "./ProjectsWithIncludesResponse.mjs";
 export * from "./ProjectUserRolesResponse.mjs";
 export * from "./ProjectWithIncludes.mjs";
@@ -97,10 +148,16 @@ export * from "./ProjectWithIncludesResponse.mjs";
 export * from "./RatingDefinition.mjs";
 export * from "./RatingDefinitionParams.mjs";
 export * from "./RatingDefinitionWithIncludes.mjs";
+export * from "./RatingMatch.mjs";
 export * from "./RemoveAssetResponse.mjs";
 export * from "./RenditionMediaLink.mjs";
 export * from "./RequestAfterOpaqueCursor.mjs";
 export * from "./RequestPageSize.mjs";
+export * from "./ResolutionHeightMatch.mjs";
+export * from "./ResolutionWidthMatch.mjs";
+export * from "./ReviewersSort.mjs";
+export * from "./SearchMatch.mjs";
+export * from "./SearchResponse.mjs";
 export * from "./SelectDefinition.mjs";
 export * from "./SelectDefinitionParams.mjs";
 export * from "./SelectDefinitionWithIncludes.mjs";
@@ -112,8 +169,12 @@ export * from "./SelectValue.mjs";
 export * from "./Share.mjs";
 export * from "./ShareResponse.mjs";
 export * from "./ShareReviewersResponse.mjs";
+export * from "./ShareSort.mjs";
 export * from "./SharesResponse.mjs";
 export * from "./SingleUserValue.mjs";
+export * from "./SourceFilenameMatch.mjs";
+export * from "./StatusMatch.mjs";
+export * from "./SyncGroupWithIncludes.mjs";
 export * from "./TextDefinition.mjs";
 export * from "./TextDefinitionParams.mjs";
 export * from "./TextDefinitionWithIncludes.mjs";
@@ -126,9 +187,11 @@ export * from "./ToggleDefinition.mjs";
 export * from "./ToggleDefinitionParams.mjs";
 export * from "./ToggleDefinitionWithIncludes.mjs";
 export * from "./TooManyRequests.mjs";
+export * from "./TranscriptionMatch.mjs";
 export * from "./Unauthorized.mjs";
 export * from "./UnprocessableContent.mjs";
 export * from "./UpdateDateDefinitionParams.mjs";
+export * from "./UpdatedAtMatch.mjs";
 export * from "./UpdateLongTextDefinitionParams.mjs";
 export * from "./UpdateNumberDefinitionParams.mjs";
 export * from "./UpdateRatingDefinitionParams.mjs";
@@ -140,12 +203,16 @@ export * from "./UpdateUserMultiDefinitionParams.mjs";
 export * from "./UpdateUserRolesParams.mjs";
 export * from "./UpdateUserRolesResponse.mjs";
 export * from "./UpdateUserSingleDefinitionParams.mjs";
+export * from "./UpdateWorkspaceRoleResponse.mjs";
+export * from "./UploadedAtMatch.mjs";
 export * from "./UploadUrl.mjs";
 export * from "./User.mjs";
 export * from "./UserMultiDefinition.mjs";
 export * from "./UserMultiDefinitionParams.mjs";
 export * from "./UserMultiDefinitionWithIncludes.mjs";
 export * from "./UserRole.mjs";
+export * from "./UserRoleSort.mjs";
+export * from "./UserRolesResponse.mjs";
 export * from "./UserSingleDefinition.mjs";
 export * from "./UserSingleDefinitionParams.mjs";
 export * from "./UserSingleDefinitionWithIncludes.mjs";
@@ -158,6 +225,8 @@ export * from "./VersionStackResponse.mjs";
 export * from "./VersionStacksWithIncludesResponse.mjs";
 export * from "./VersionStackWithIncludes.mjs";
 export * from "./VersionStackWithIncludesResponse.mjs";
+export * from "./VisualMatch.mjs";
+export * from "./VisualMatchClip.mjs";
 export * from "./Webhook.mjs";
 export * from "./WebhookCreateResponse.mjs";
 export * from "./WebhookEvents.mjs";
@@ -169,7 +238,10 @@ export * from "./Workspace.mjs";
 export * from "./WorkspaceInclude.mjs";
 export * from "./WorkspaceParams.mjs";
 export * from "./WorkspaceResponse.mjs";
+export * from "./WorkspaceRole.mjs";
+export * from "./WorkspaceSort.mjs";
 export * from "./WorkspacesWithIncludesResponse.mjs";
+export * from "./WorkspaceUserRole.mjs";
 export * from "./WorkspaceUserRolesResponse.mjs";
 export * from "./WorkspaceWithIncludes.mjs";
 export * from "./WorkspaceWithIncludesResponse.mjs";