acquia-dam-sdk/dist/apis/assets/responses.d.ts

Interact with the Acquia DAM API

import { MetadataFieldType } from '../metadata/requests.js';

interface CompleteChunkedUploadResult {
    file_id: string;
}
interface CreatedAsset {
    _links: {
        self: string;
    };
}
interface CreateAssetResult extends CreatedAsset {
    id: string | null;
}
interface GetAssetResult {
    _links: {
        download?: string;
    };
    asset_properties: AssetPropertiesExpand | null;
    created_date: Date;
    current_version: boolean;
    deleted_date: Date | null;
    embeds: EmbedsExpand | null;
    expanded: {
        asset_properties: boolean;
        download_link?: boolean;
        embeds: boolean;
        file_properties: boolean;
        metadata: boolean;
        metadata_info: boolean;
        metadata_vocabulary: boolean;
        security: boolean;
        thumbnails: boolean;
    };
    external_id: string;
    file_properties: FilePropertiesExpand | null;
    file_upload_date: Date;
    filename: string;
    id: string;
    last_update_date: Date;
    metadata: MetadataExpand | null;
    metadata_info: MetadataInfoExpand | null;
    released_and_not_expired: boolean;
    security: SecurityExpand | null;
    status: StatusExpand | null;
    thumbnails: ThumbnailsExpand | null;
    version_id: string;
}
interface GetMetadataResult {
    fields: Record<string, string[]>;
}
interface GetSecurityResult {
    asset_groups: string[];
    expiration_date: Date | null;
    release_date: Date | null;
}
interface ListAssetGroupsResult {
    item_type: string;
    items: {
        name: string;
        uuid: string;
    }[];
    total_count: number;
}
interface ListIntegrationLinksResult {
    integrationLinks: {
        assetUuid: string;
        description: string;
        updatedDate: Date;
        url: string | null;
        uuid: string;
    }[];
}
interface UploadProfile {
    asset_groups: string[];
    immediate_release: boolean;
    metadata_type: string;
    name: string;
    release_date: Date | null;
}
interface ListFileFormatsResult {
    count: number;
    formats: {
        description: string;
        name: string;
    }[];
}
interface ListVersionsResult {
    numResults: number;
    uuid: string;
    versions: {
        dateAdded: Date;
        dateLastEdited: Date;
        externalId: string;
        fileFormat: string;
        finalized: boolean;
        name: string;
        previews: {
            preview125: string;
            preview160: string;
            preview300: string;
            preview600: string;
            preview2048: string;
            templated: string;
        };
        size: string;
        type: string;
        uuid: string;
        versionNumber: number;
    }[];
}
interface RegisterIntegrationLinkResult {
    assetUuid: string;
    description: string;
    updatedDate: Date;
    url: string | null;
    uuid: string;
}
interface SearchAssetsResult {
    facets: {
        categories?: CategoryFacet[];
        file_types?: FileTypeFacet[];
        metadata?: MetadataFacet[];
    } | null;
    include_archived: boolean;
    include_deleted: boolean;
    item_type: string;
    items: Asset[];
    limit: number;
    offset: number;
    query: string | null;
    query_explained: string;
    query_syntax_ok: boolean;
    scroll_id: string | null;
    scroll_timeout: string | null;
    sort: string;
    sort_explained: string;
    total_count: number;
}
interface CategoryFacet {
    count: number;
    id: string;
    name: string;
    path: string;
    search_query: string;
}
interface FileTypeFacet {
    count: number;
    name: string;
    search_query: string;
}
interface MetadataFacet {
    display_key: string;
    display_name: string;
    values: {
        count: number;
        search_query: string;
        value?: string;
        values?: string[];
    }[];
}
interface AssetPropertiesExpand {
    cutline_caption: string;
    favorite: boolean;
    popularity: number;
}
type EmbedsExpand = Record<string, {
    apps: string[];
    html: string;
    share: string;
    url: string;
}>;
interface FilePropertiesExpand {
    format: string;
    format_type: string;
    image_properties: {
        aspect_ratio: number;
        height: number | null;
        width: number | null;
    } | null;
    size_in_bytes: number;
    size_in_kbytes: number;
    video_properties: {
        aspect_ratio: number | null;
        duration: number | null;
        height: number | null;
        width: number | null;
    } | null;
}
interface MetadataInfoExpand {
    field_set: string;
    field_set_fields: {
        controlled_vocabulary: boolean;
        editable: boolean;
        field_type: MetadataFieldType;
        key: string;
        label: string;
        required: boolean;
        type: MetadataFieldType;
        vocabulary: string[] | null;
    }[];
}
interface StatusExpand {
    upload_progress: 'pending' | 'verifying' | 'complete';
}
interface Thumbnail {
    url: string;
    valid_until: Date;
}
interface StartChunkedUploadResult {
    session_id: string;
}
interface UploadChunkResult {
    tag: string;
}
interface ThumbnailsExpand {
    '125px': Thumbnail;
    '160px': Thumbnail;
    '300px': Thumbnail;
    '600px': Thumbnail;
    '2048px': Thumbnail;
}
type ListUploadProfilesResult = UploadProfile[];
type Asset = GetAssetResult;
type MetadataExpand = GetMetadataResult;
type SecurityExpand = GetSecurityResult;

export type { Asset, AssetPropertiesExpand, CategoryFacet, CompleteChunkedUploadResult, CreateAssetResult, CreatedAsset, EmbedsExpand, FilePropertiesExpand, FileTypeFacet, GetAssetResult, GetMetadataResult, GetSecurityResult, ListAssetGroupsResult, ListFileFormatsResult, ListIntegrationLinksResult, ListUploadProfilesResult, ListVersionsResult, MetadataExpand, MetadataFacet, MetadataInfoExpand, RegisterIntegrationLinkResult, SearchAssetsResult, SecurityExpand, StartChunkedUploadResult, StatusExpand, Thumbnail, ThumbnailsExpand, UploadChunkResult, UploadProfile };