frameio 4.1.1 → 4.2.1

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

@@ -2,6 +2,8 @@
  * Account details
  */
 export interface Account {
+    /** Adobe IMS Organization ID associated with the account, when available. */
+    adobe_id?: string | undefined;
     /** Created Timestamp */
     created_at: string;
     /** Account Name */

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

@@ -0,0 +1,8 @@
+/** Sort by query parameter for accounts */
+export declare const AccountSort: {
+    readonly DisplayNameAsc: "display_name_asc";
+    readonly CreatedAtAsc: "created_at_asc";
+    readonly DisplayNameDesc: "display_name_desc";
+    readonly CreatedAtDesc: "created_at_desc";
+};
+export type AccountSort = (typeof AccountSort)[keyof typeof AccountSort];

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Sort by query parameter for accounts */
+export const AccountSort = {
+    DisplayNameAsc: "display_name_asc",
+    CreatedAtAsc: "created_at_asc",
+    DisplayNameDesc: "display_name_desc",
+    CreatedAtDesc: "created_at_desc",
+};

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

@@ -0,0 +1,10 @@
+/** Sort by query parameter for account users */
+export declare const AccountUserSort: {
+    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 AccountUserSort = (typeof AccountUserSort)[keyof typeof AccountUserSort];

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

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

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

@@ -0,0 +1,25 @@
+export interface Action {
+    /** Active Status */
+    active: boolean;
+    created_at: string;
+    /** Creator ID */
+    creator_id: string;
+    deleted_at?: string | undefined;
+    /** Action Description */
+    description: string;
+    /** Event Name */
+    event: string;
+    /** Action ID */
+    id: string;
+    /** Manages action trigger on multiple assets */
+    multi_asset?: boolean | undefined;
+    /** Action Name */
+    name: string;
+    /** Timeout for the action requests in seconds */
+    timeout?: number | undefined;
+    updated_at: string;
+    /** Action URL */
+    url: string;
+    /** Workspace ID */
+    workspace_id: string;
+}

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

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

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

@@ -0,0 +1,13 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * Returns a single custom action with secret.
+ */
+export interface ActionCreateResponse {
+    data: ActionCreateResponse.Data;
+}
+export declare namespace ActionCreateResponse {
+    interface Data extends Frameio.Action {
+        /** Secret used to validate underlying webhook requests. Make sure to store your secret. You won't be able to see it again! */
+        secret: string;
+    }
+}

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * Include query parameter for custom actions
+ */
+export type ActionInclude = "creator";

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

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

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

@@ -0,0 +1,7 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * Action details
+ */
+export interface ActionResponse {
+    data: Frameio.Action;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * Frame.io action details
+ */
+export interface ActionWithIncludesResponse {
+    data: Frameio.ActionWithIncludes;
+}

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

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

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

@@ -0,0 +1,11 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * Frame.io actions
+ */
+export interface ActionsWithIncludesResponse {
+    /** Actions */
+    data: Frameio.ActionWithIncludes[];
+    links: Frameio.Links;
+    /** Total count */
+    total_count?: number | undefined;
+}

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

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

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

@@ -1,4 +1,6 @@
 export interface AssetCommon {
+    /** 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/AssetCommonWithIncludes.d.mts

@@ -1,5 +1,7 @@
 import type * as Frameio from "../index.mjs";
 export interface AssetCommonWithIncludes {
+    /** 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/AssetInclude.d.mts

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

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

@@ -3,6 +3,5 @@
 export const AssetInclude = {
     Creator: "creator",
     Project: "project",
-    ProjectOwner: "project.owner",
     Metadata: "metadata",
 };

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

@@ -0,0 +1,18 @@
+import type * as Frameio from "../index.mjs";
+/**
+ * A search result containing an asset (file, folder, or version stack)
+ */
+export interface AssetSearchResult {
+    /** Matches explaining why this result was returned */
+    matches: Frameio.SearchMatch[];
+    result: Frameio.AssetCommon;
+    type: AssetSearchResult.Type;
+}
+export declare namespace AssetSearchResult {
+    const Type: {
+        readonly FileResult: "file_result";
+        readonly FolderResult: "folder_result";
+        readonly VersionStackResult: "version_stack_result";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+}

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

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export var AssetSearchResult;
+(function (AssetSearchResult) {
+    AssetSearchResult.Type = {
+        FileResult: "file_result",
+        FolderResult: "folder_result",
+        VersionStackResult: "version_stack_result",
+    };
+})(AssetSearchResult || (AssetSearchResult = {}));

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

@@ -1,9 +1,11 @@
+import type * as Frameio from "../index.mjs";
 export interface AssetShareParams {
     access: AssetShareParams.Access;
-    /** Asset IDs (File, folder, and/or version stack IDs) */
-    asset_ids?: string[] | undefined;
+    /** Asset IDs (File, folder, and/or version stack IDs). */
+    asset_ids?: Frameio.FrameOrAdobeId[] | undefined;
     /** Share description - NOTE: Requires feature custom_branded_shares */
     description?: string | undefined;
+    /** Whether downloading is enabled on the share */
     downloading_enabled?: boolean | undefined;
     /** Expiration timestamp */
     expiration?: string | undefined;

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

@@ -0,0 +1,7 @@
+/**
+ * The result's assignee is a match for the search query
+ */
+export interface AssigneeMatch {
+    /** The ID of the user who the result is assigned to */
+    assignee_id: string;
+}

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's audio sample rate is a match for the search query
+ */
+export interface AudioSampleRateMatch {
+    /** The audio sample rate of the result in Hz */
+    audio_sample_rate: number;
+}

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

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

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

@@ -81,6 +81,7 @@ export declare namespace AuditLogwithIncludes {
         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";
@@ -91,6 +92,9 @@ export declare namespace AuditLogwithIncludes {
         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";
@@ -243,6 +247,7 @@ export declare namespace AuditLogwithIncludes {
         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/esm/api/types/AuditLogwithIncludes.mjs

@@ -67,6 +67,7 @@ export var AuditLogwithIncludes;
         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",
@@ -77,6 +78,9 @@ export var AuditLogwithIncludes;
         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",
@@ -228,6 +232,7 @@ export var AuditLogwithIncludes;
         Collection: "collection",
         Comment: "comment",
         CommentImpression: "comment_impression",
+        ControlledDomain: "controlled_domain",
         Folder: "folder",
         JoinRequest: "join_request",
         LoginFactor: "login_factor",

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

@@ -0,0 +1,7 @@
+/**
+ * The result's bit depth is a match for the search query
+ */
+export interface BitDepthMatch {
+    /** The bit depth of the result */
+    bit_depth: number;
+}

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's bit rate is a match for the search query
+ */
+export interface BitRateMatch {
+    /** The bit rate of the result in bps */
+    bit_rate: number;
+}

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,31 @@
+import type * as Frameio from "../index.mjs";
+export interface Collection {
+    aggregation_mode: Collection.AggregationMode;
+    auto_generated: boolean;
+    /** Creation timestamp */
+    created_at: string;
+    creator?: Frameio.User | undefined;
+    /** Collection description */
+    description?: string | undefined;
+    /** Collection ID */
+    id: string;
+    /** Collection name */
+    name?: string | undefined;
+    private: boolean;
+    project?: Frameio.Project | undefined;
+    /** Project ID */
+    project_id: string;
+    /** Root folder ID */
+    root_folder_id?: string | undefined;
+    /** Shares */
+    shares?: Frameio.Share[] | undefined;
+    /** Update timestamp */
+    updated_at: string;
+}
+export declare namespace Collection {
+    const AggregationMode: {
+        readonly Static: "static";
+        readonly Dynamic: "dynamic";
+    };
+    type AggregationMode = (typeof AggregationMode)[keyof typeof AggregationMode];
+}

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

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Collection;
+(function (Collection) {
+    Collection.AggregationMode = {
+        Static: "static",
+        Dynamic: "dynamic",
+    };
+})(Collection || (Collection = {}));

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

@@ -0,0 +1,4 @@
+/**
+ * Include query parameter for collections
+ */
+export type CollectionInclude = string;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * The result's comment is a match for the search query
+ */
+export interface CommentMatch {
+    /** The ID of the comment that matched the query */
+    comment_id: string;
+    /** The small portion of the comment that matched the search query */
+    snippet: string;
+    /** The terms in the search query that matched the result's comment */
+    terms: string[];
+}

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's creator is a match for the search query
+ */
+export interface CreatorMatch {
+    /** The ID of the user who created the result */
+    creator_id: string;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * The result's duration is a match for the search query
+ */
+export interface DurationMatch {
+    /** The duration of the result in seconds */
+    duration: number;
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -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 */