frameio 4.1.1 → 4.2.1

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

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

package/dist/cjs/api/types/FieldDefinitionSort.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.FieldDefinitionSort = void 0;
+/** Sort by query parameter for field definitions */
+exports.FieldDefinitionSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

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

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

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

@@ -1,5 +1,7 @@
 import type * as Frameio from "../index.js";
 export interface FileWithIncludes extends Frameio.AssetCommonWithIncludes {
+    /** Version identifier of the Adobe cloud storage asset associated with this file, when available. A version identifier is a string that often resembles an integer but should be treated as an opaque string. */
+    adobe_version_id?: string | undefined;
     /** File size in bytes */
     file_size: number;
     media_links?: Frameio.MediaLinksCollection | undefined;

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

@@ -9,7 +9,6 @@ export declare const FileWithMediaLinksInclude: {
     readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
     readonly Creator: "creator";
     readonly Project: "project";
-    readonly ProjectOwner: "project.owner";
     readonly Metadata: "metadata";
 };
 export type FileWithMediaLinksInclude = (typeof FileWithMediaLinksInclude)[keyof typeof FileWithMediaLinksInclude];

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

@@ -13,6 +13,5 @@ exports.FileWithMediaLinksInclude = {
     MediaLinksScrubSheet: "media_links.scrub_sheet",
     Creator: "creator",
     Project: "project",
-    ProjectOwner: "project.owner",
     Metadata: "metadata",
 };

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

@@ -3,11 +3,15 @@ export interface File_ {
     id?: string | undefined;
     /** File Name */
     name?: string | undefined;
+    /** Version identifier of the Adobe cloud storage asset associated with this file, when available. A version identifier is a string that often resembles an integer but should be treated as an opaque string. */
+    adobe_version_id?: string | undefined;
     /** File size in bytes */
     file_size: number;
     /** File media type */
     media_type: string;
     status: File_.Status;
+    /** Adobe cloud storage asset identifier, when available. */
+    adobe_id?: string | undefined;
     /** Creation timestamp */
     created_at: string;
     /** Parent Folder or Version Stack ID */

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

@@ -0,0 +1,7 @@
+/**
+ * The result's file size is a match for the search query
+ */
+export interface FilesizeMatch {
+    /** The file size of the result in bytes */
+    filesize: number;
+}

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

@@ -89,6 +89,7 @@ export declare namespace Filters {
         readonly BulkEmailsUpdated: "bulk_emails_updated";
         readonly BulkProjectsActivated: "bulk_projects_activated";
         readonly BulkProjectsDeactivated: "bulk_projects_deactivated";
+        readonly BulkProjectsMountedStorageStatusUpdated: "bulk_projects_mounted_storage_status_updated";
         readonly BulkUsersRemoved: "bulk_users_removed";
         readonly CollaboratorAdded: "collaborator_added";
         readonly CollaboratorDeleted: "collaborator_deleted";
@@ -99,6 +100,9 @@ export declare namespace Filters {
         readonly CommentLiked: "comment_liked";
         readonly CommentUncompleted: "comment_uncompleted";
         readonly CommentUpdated: "comment_updated";
+        readonly ControlledDomainCreated: "controlled_domain_created";
+        readonly ControlledDomainUpdated: "controlled_domain_updated";
+        readonly EmailAddressChangeFailure: "email_address_change_failure";
         readonly EmailAddressChanged: "email_address_changed";
         readonly EmailChangeConfirmationRequested: "email_change_confirmation_requested";
         readonly EmailConfirmed: "email_confirmed";
@@ -252,6 +256,7 @@ export declare namespace Filters {
         readonly Collection: "collection";
         readonly Comment: "comment";
         readonly CommentImpression: "comment_impression";
+        readonly ControlledDomain: "controlled_domain";
         readonly Folder: "folder";
         readonly JoinRequest: "join_request";
         readonly LoginFactor: "login_factor";

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

@@ -71,6 +71,7 @@ var Filters;
         BulkEmailsUpdated: "bulk_emails_updated",
         BulkProjectsActivated: "bulk_projects_activated",
         BulkProjectsDeactivated: "bulk_projects_deactivated",
+        BulkProjectsMountedStorageStatusUpdated: "bulk_projects_mounted_storage_status_updated",
         BulkUsersRemoved: "bulk_users_removed",
         CollaboratorAdded: "collaborator_added",
         CollaboratorDeleted: "collaborator_deleted",
@@ -81,6 +82,9 @@ var Filters;
         CommentLiked: "comment_liked",
         CommentUncompleted: "comment_uncompleted",
         CommentUpdated: "comment_updated",
+        ControlledDomainCreated: "controlled_domain_created",
+        ControlledDomainUpdated: "controlled_domain_updated",
+        EmailAddressChangeFailure: "email_address_change_failure",
         EmailAddressChanged: "email_address_changed",
         EmailChangeConfirmationRequested: "email_change_confirmation_requested",
         EmailConfirmed: "email_confirmed",
@@ -233,6 +237,7 @@ var Filters;
         Collection: "collection",
         Comment: "comment",
         CommentImpression: "comment_impression",
+        ControlledDomain: "controlled_domain",
         Folder: "folder",
         JoinRequest: "join_request",
         LoginFactor: "login_factor",

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

@@ -4,6 +4,8 @@ export interface FolderWithIncludes {
     cover_file_id?: string | 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/FormatMatch.d.ts

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

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

@@ -0,0 +1,4 @@
+/**
+ * A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).
+ */
+export type FrameOrAdobeId = string;

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

@@ -0,0 +1,7 @@
+/**
+ * The result's frame rate is a match for the search query
+ */
+export interface FrameRateMatch {
+    /** The frame rate of the result in fps */
+    frame_rate: number;
+}

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

@@ -0,0 +1,16 @@
+export interface GroupCommon {
+    /** Creation timestamp */
+    created_at: string;
+    /** ID of group creator */
+    creator_id?: string | undefined;
+    /** Group emoji for UI display */
+    emoji: string;
+    /** Group ID */
+    id: string;
+    /** Number of members in group */
+    member_count: number;
+    /** Group name */
+    name: string;
+    /** Update timestamp */
+    updated_at: string;
+}

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

@@ -0,0 +1,4 @@
+import type * as Frameio from "../index.js";
+export interface GroupCommonWithIncludes extends Frameio.GroupCommon {
+    creator?: Frameio.User | undefined;
+}

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

@@ -0,0 +1,4 @@
+import type * as Frameio from "../index.js";
+export interface GroupResponse {
+    data: Frameio.GroupCommon;
+}

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

@@ -0,0 +1,13 @@
+import type * as Frameio from "../index.js";
+export type GroupWithIncludes = Frameio.GroupWithIncludes.Adobe | Frameio.GroupWithIncludes.Frame | Frameio.GroupWithIncludes.Workfront;
+export declare namespace GroupWithIncludes {
+    interface Adobe extends Frameio.SyncGroupWithIncludes {
+        source: "adobe";
+    }
+    interface Frame extends Frameio.GroupCommonWithIncludes {
+        source: "frame";
+    }
+    interface Workfront extends Frameio.GroupCommonWithIncludes {
+        source: "workfront";
+    }
+}

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

@@ -0,0 +1,4 @@
+import type * as Frameio from "../index.js";
+export interface GroupWithIncludesResponse {
+    data: Frameio.GroupWithIncludes;
+}

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

@@ -0,0 +1,4 @@
+/**
+ * Include query parameter for groups
+ */
+export type GroupsInclude = "creator";

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

@@ -0,0 +1,10 @@
+/** Sort query parameter for Groups. */
+export declare const GroupsSort: {
+    readonly CreatorAsc: "creator_asc";
+    readonly CreatorDesc: "creator_desc";
+    readonly NameAsc: "name_asc";
+    readonly NameDesc: "name_desc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type GroupsSort = (typeof GroupsSort)[keyof typeof GroupsSort];

package/dist/cjs/api/types/GroupsSort.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.GroupsSort = void 0;
+/** Sort query parameter for Groups. */
+exports.GroupsSort = {
+    CreatorAsc: "creator_asc",
+    CreatorDesc: "creator_desc",
+    NameAsc: "name_asc",
+    NameDesc: "name_desc",
+    CreatedAtAsc: "created_at_asc",
+    CreatedAtDesc: "created_at_desc",
+};

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

@@ -0,0 +1,8 @@
+import type * as Frameio from "../index.js";
+export interface GroupsWithIncludesResponse {
+    /** Groups */
+    data: Frameio.GroupWithIncludes[];
+    links: Frameio.Links;
+    /** Total count */
+    total_count?: number | undefined;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * The result's alpha channel presence is a match for the search query
+ */
+export interface HasAlphaChannelMatch {
+    /** Whether the result has an alpha channel */
+    has_alpha_channel: boolean;
+}

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's keywords are a match for the search query
+ */
+export interface KeywordsMatch {
+    /** The keywords of the result that are relevant to the search */
+    keywords: string[];
+}

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

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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's page count is a match for the search query
+ */
+export interface PageCountMatch {
+    /** The page count of the result */
+    page_count: number;
+}

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

@@ -2,6 +2,8 @@
  * Frame.io Project
  */
 export interface Project {
+    /** Adobe cloud storage directory ID associated with the project, when available. */
+    adobe_id?: string | undefined;
     /** Created Timestamp */
     created_at: string;
     /** Project ID */

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

@@ -0,0 +1,20 @@
+/**
+ * The asset's project name is a match for the search query
+ */
+export interface ProjectMatch {
+    /** Project information for a project match */
+    project: ProjectMatch.Project;
+    /** The terms in the search query that matched the project name */
+    terms: string[];
+}
+export declare namespace ProjectMatch {
+    /**
+     * Project information for a project match
+     */
+    interface Project {
+        /** The project ID */
+        id: string;
+        /** The project name */
+        name: string;
+    }
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Project information for a project match
+ */
+export interface ProjectMatchInfo {
+    /** The project ID */
+    id: string;
+    /** The project name */
+    name: string;
+}

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

@@ -0,0 +1,10 @@
+import type * as Frameio from "../index.js";
+/**
+ * A search result containing a project
+ */
+export interface ProjectSearchResult {
+    /** Matches explaining why this result was returned */
+    matches: Frameio.SearchMatch[];
+    result: Frameio.Project;
+    type: "project_result";
+}

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

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

package/dist/cjs/api/types/ProjectSort.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.ProjectSort = void 0;
+/** Sort query parameter for projects */
+exports.ProjectSort = {
+    NameAsc: "name_asc",
+    CreatedAtAsc: "created_at_asc",
+    NameDesc: "name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

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

@@ -0,0 +1,13 @@
+/**
+ * The result's rating is a match for the search query
+ */
+export interface RatingMatch {
+    /** The color of the rating field */
+    color?: string | undefined;
+    /** The maximum rating of the rating field for the result */
+    max_value?: number | undefined;
+    /** The rating of the result */
+    rating: number;
+    /** The style of the rating field */
+    style?: string | undefined;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * The result's resolution height is a match for the search query
+ */
+export interface ResolutionHeightMatch {
+    /** The resolution height of the result in pixels */
+    resolution_height: number;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * The result's resolution width is a match for the search query
+ */
+export interface ResolutionWidthMatch {
+    /** The resolution width of the result in pixels */
+    resolution_width: number;
+}

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

@@ -0,0 +1,8 @@
+/** Sort by query parameter for share reviewers */
+export declare const ReviewersSort: {
+    readonly NameAsc: "name_asc";
+    readonly Active: "active";
+    readonly NameDesc: "name_desc";
+    readonly Inactive: "inactive";
+};
+export type ReviewersSort = (typeof ReviewersSort)[keyof typeof ReviewersSort];

package/dist/cjs/api/types/ReviewersSort.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.ReviewersSort = void 0;
+/** Sort by query parameter for share reviewers */
+exports.ReviewersSort = {
+    NameAsc: "name_asc",
+    Active: "active",
+    NameDesc: "name_desc",
+    Inactive: "inactive",
+};