Interface FileModel

interface FileModel {
    access_type?: AccessTypeEnum;
    app_metadata?: Record<string, any>;
    content_extension: null | string;
    content_length: null | number;
    content_thumbnails: string[];
    content_type: FileContentTypeEnum;
    content_url: null | string;
    created_at: string;
    created_by: MiniUser;
    download_type?: DownloadTypeEnum;
    expires_at?: null | string;
    folder: MiniFolder;
    folder_id?: string;
    global_id: string;
    id: string;
    instance_id: string;
    isDeleted: boolean;
    metadata?: Record<string, any>;
    modified_at: string;
    modified_by: MiniUser;
    name?: string;
    original_extension: null | string;
    original_url: null | string;
    owned_by: MiniUser;
    permissions?: FilePermission;
    pspdfkit_auth_payload: null | Record<string, any>;
    pspdfkit_document_id: null | string;
    pspdfkit_server_url: null | string;
    published_at: null | string;
    role: CollaborationRoleEnum;
    search: null | string;
    shared_link: MiniSharedLink;
    size: null | number;
    status: FileStatusEnum;
    tags?: string[];
    thumbnail_url: null | string;
    transcript?: string;
    type: FileTypeEnum;
    version: FileVersion;
    zip_size: null | number;
    zip_url: null | string;
}

Hierarchy (View Summary)

Properties

access_type?: AccessTypeEnum
app_metadata?: Record<string, any>
content_extension: null | string
content_length: null | number
content_thumbnails: string[]
content_type: FileContentTypeEnum
content_url: null | string
created_at: string
created_by: MiniUser
download_type?: DownloadTypeEnum
expires_at?: null | string
folder: MiniFolder
folder_id?: string
global_id: string
id: string
instance_id: string
isDeleted: boolean
metadata?: Record<string, any>
modified_at: string
modified_by: MiniUser
name?: string
original_extension: null | string
original_url: null | string
owned_by: MiniUser
permissions?: FilePermission
pspdfkit_auth_payload: null | Record<string, any>
pspdfkit_document_id: null | string
pspdfkit_server_url: null | string
published_at: null | string

Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.

search: null | string
shared_link: MiniSharedLink
size: null | number
tags?: string[]
thumbnail_url: null | string
transcript?: string
version: FileVersion
zip_size: null | number
zip_url: null | string