import type { BooleanField, ByteField, DateField, MediaTypeField, NumberField } from '@internetarchive/iaux-item-metadata'; import { StringField } from '@internetarchive/iaux-item-metadata'; import { SearchMetadata } from '../search-metadata'; /** * A model that describes a TV clip hit from a TV search via the PPS endpoint. * * The fields in here are cast to their respective field types. See `metadata-fields/field-type`. * * Add additional fields as needed. * * @export * @class TvClipHit */ export declare class TvClipHit { /** * This is the raw hit response; useful for inspecting the raw data * returned from the server. */ readonly rawMetadata: Readonly>; readonly fields: Readonly; constructor(json: Record); /** * The item identifier. * * _Note_: This is a plain string instead of a `MetadataField` since it's * the primary key of the item. */ get identifier(): string | undefined; /** * Synthesized in processing of TVS API hit; TBD * Optional. */ get highlight(): StringField | undefined; /** Optional. */ get addeddate(): DateField | undefined; /** Optional. */ get ad_id(): StringField | undefined; /** Optional. */ get avg_rating(): NumberField | undefined; /** Multivalued. */ get collection(): StringField | undefined; get created_on(): DateField | undefined; /** * Optional. * Multivalued. */ get creator(): StringField | undefined; /** Optional. */ get date(): DateField | undefined; /** * Contents of description in TVS API hit, TBD * Optional. * Multivalued. */ get description(): StringField | undefined; /** * Total views over ITEM (not text) lifetime, updated by audit consultation with Views API. * Optional. */ get downloads(): NumberField | undefined; /** Optional. */ get factcheck(): StringField | undefined; get filename(): StringField | undefined; get file_basename(): StringField | undefined; get file_creation_mtime(): NumberField | undefined; /** * Computed during document construction. */ get files_count(): NumberField | undefined; /** * Whether this hit represents a "clip" of a longer TV item. */ get is_clip(): BooleanField | undefined; /** * Format varies. * Optional. */ get issue(): StringField | undefined; /** * Computed during document construction. * Optional (appears on TV sub-collections). */ get item_count(): NumberField | undefined; /** * In bytes; computed during document construction. */ get item_size(): ByteField | undefined; /** * Optional. * Multivalued. */ get language(): StringField | undefined; get mediatype(): MediaTypeField | undefined; get num_clips(): NumberField | undefined; /** * Computed during document construction. * Optional. */ get num_favorites(): NumberField | undefined; /** Optional. */ get publicdate(): DateField | undefined; /** * Computed in processing of FTS API hit. * Potentially irrelevant for TVS hit. */ get result_in_subfile(): BooleanField | undefined; /** Optional. */ get reviewdate(): DateField | undefined; /** * Format varies. * Optional. */ get source(): StringField | undefined; /** * Optional. * Multivalued. */ get subject(): StringField | undefined; /** Optional. */ get title(): StringField | undefined; get updated_on(): DateField | undefined; /** * Views over a seven-day period, updated by audit consultation with Views API. * Optional. */ get week(): NumberField | undefined; /** * Computed from date. * Optional. */ get year(): NumberField | undefined; /** * Optional. * Start time for TV hit. */ get start(): StringField | undefined; /** * Synthesized in processing of TVS API hit; TBD * Optional. */ get __href__(): StringField | undefined; /** * Derived in annotation of raw hits; TBD * Optional. */ get __img__(): StringField | undefined; }