conjuntos de datos

export interface AvailableDatasets {
    /**
     * La lista de conjuntos de datos.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * El ID del conjunto de datos.
     */
    id: string;

    /**
     * El nombre del conjunto de datos.
     */
    name: string;

    /**
     * El sitio web del conjunto de datos.
     */
    website: string;

    /**
     * La URL donde se puede encontrar la licencia del conjunto de datos.
     */
    licenseUrl: string;

    /**
     * El nombre en inglés del conjunto de datos.
     */
    englishName: string;

    /**
     * La etiqueta de idioma de 3 letras ISO 639 en la que se encuentra principalmente el conjunto de datos.
     */
    language: string;

    /**
     * La dirección en la que está escrito el idioma.
     * "ltr" indica que el texto se escribe desde el lado izquierdo de la página hacia la derecha.
     * "rtl" indica que el texto se escribe desde el lado derecho de la página hacia la izquierda.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Enlace a la API para la lista de libros disponibles para este conjunto de datos.
     */
    listOfBooksApiLink: string;

    /**
     * La lista de formatos disponibles.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * El número de libros que contiene este conjunto de datos.
     */
    numberOfBooks: number;

    /**
     * El número total de capítulos que contiene este conjunto de datos.
     */
    totalNumberOfChapters: number;

    /**
     * El número total de versículos que contiene este conjunto de datos.
     */
    totalNumberOfVerses: number;

    /**
     * El número total de referencias cruzadas que contiene este conjunto de datos.
     */
    totalNumberOfReferences: number;

    /**
     * Obtiene el nombre del idioma en el que se encuentra el conjunto de datos.
     * Nulo o indefinido si se desconoce el nombre del idioma.
     */
    languageName?: string;

    /**
     * Obtiene el nombre del idioma en inglés.
     * Nulo o indefinido si el idioma no tiene un nombre en inglés.
     */
    languageEnglishName?: string;

    /**
     * Los enlaces API para las listas de entidades en el conjunto de datos.
     * Se omite si el conjunto de datos no contiene las entidades correspondientes.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * El número total de entidades que contiene el conjunto de datos.
     * Se omite si el conjunto de datos no contiene las entidades correspondientes.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * La información del conjunto de datos para los libros.
     */
    dataset: Dataset;

    /**
     * La lista de libros disponibles para el conjunto de datos.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * La identificación del libro.
     * Coincide con el ID del libro correspondiente en la Biblia (GEN, EXO, etc.).
     */
    id: string;

    /**
     * El orden de los libros en la Biblia.
     */
    order: number;

    /**
     * El número del primer capítulo del libro.
     */
    firstChapterNumber: number;

    /**
     * Enlace al primer capítulo del libro.
     */
    firstChapterApiLink: string | null;

    /**
     * El número del último capítulo del libro.
     */
    lastChapterNumber: number | null;

    /**
     * El enlace al último capítulo del libro.
     */
    lastChapterApiLink: string | null;

    /**
     * El número de capítulos que contiene el libro.
     */
    numberOfChapters: number;

    /**
     * El número de versículos que contiene el libro.
     */
    totalNumberOfVerses: number;

    /**
     * El número total de referencias cruzadas que contiene este libro.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Información del conjunto de datos para el capítulo del libro.
     */
    dataset: Dataset;

    /**
     * La información del libro correspondiente al capítulo del libro.
     */
    book: DatasetBook;

    /**
     * El enlace a este capítulo.
     */
    thisChapterLink: string;

    /**
     * El enlace al siguiente capítulo.
     * Nulo si este es el último capítulo del conjunto de datos.
     */
    nextChapterApiLink: string | null;

    /**
     * El enlace al capítulo anterior.
     * Nulo si este es el primer capítulo del conjunto de datos.
     */
    previousChapterApiLink: string | null;

    /**
     * El número de versículos que contiene el capítulo.
     */
    numberOfVerses: number;

    /**
     * La información del capítulo.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * El número del capítulo.
     */
    number: number;

    /**
     * El contenido del capítulo.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * El número del versículo.
     */
    verse: number;

    /**
     * Las referencias cruzadas del versículo.
     *
     * Ordenado por puntuación, descendente.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * El ID del libro al que se hace referencia.
     */
    book: string;

    /**
     * El número del capítulo.
     */
    chapter: number;

    /**
     * El número del versículo.
     * Si aparece `endVerse` , entonces este es el versículo donde comienza la referencia.
     */
    verse: number;

    /**
     * El versículo donde termina la referencia.
     */
    endVerse?: number;

    /**
     * La puntuación de relevancia para la referencia.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * El ID de la entidad a la que se hace referencia.
     */
    id: string;

    /**
     * El tipo de entidad a la que se hace referencia.
     * Coincide con el segmento de colección del enlace API de la entidad, por lo que el enlace se puede construir como `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * El nombre de la entidad a la que se hace referencia.
     */
    name?: string;

    /**
     * El enlace API de la entidad a la que se hace referencia.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * La identificación del libro (GEN, EXO, etc.).
     */
    book: string;

    /**
     * El número de capítulo donde comienza la referencia.
     */
    chapter: number;

    /**
     * El número de versículo donde comienza la referencia.
     */
    verse: number;

    /**
     * El versículo donde termina la referencia.
     * Los versículos consecutivos del mismo capítulo se agrupan en una sola referencia.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Información del conjunto de datos para el capítulo del libro.
     */
    dataset: Dataset;

    /**
     * La información del libro correspondiente al capítulo del libro.
     */
    book: DatasetBook;

    /**
     * Los datos de la entidad para el capítulo.
     */
    chapter: DatasetEntityChapterData;

    /**
     * El enlace a este capítulo.
     */
    thisChapterLink: string;

    /**
     * El enlace al siguiente capítulo.
     * Nulo si este es el último capítulo del conjunto de datos.
     */
    nextChapterApiLink: string | null;

    /**
     * El enlace al capítulo anterior.
     * Nulo si este es el primer capítulo del conjunto de datos.
     */
    previousChapterApiLink: string | null;

    /**
     * El número de personas, lugares y eventos que aparecen en el capítulo.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * El número del capítulo.
     */
    number: number;

    /**
     * Las personas que aparecen en el capítulo.
     * Ordenados según el primer verso en el que aparecen.
     */
    people: ChapterPerson[];

    /**
     * Los lugares que aparecen en el capítulo.
     * Ordenados según el primer verso en el que aparecen.
     */
    places: ChapterPlace[];

    /**
     * Los acontecimientos que aparecen en el capítulo.
     * Ordenados según el primer verso en el que aparecen.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * El documento de identidad de la persona.
     */
    id: string;

    /**
     * El nombre de la persona.
     */
    name: string;

    /**
     * Si el nombre de la persona es un nombre propio.
     */
    isProperName?: boolean;

    /**
     * El género de la persona.
     */
    gender?: string;

    /**
     * El año en que nació la persona y el año en que murió.
     * Los números negativos representan los años antes de Cristo. Los números positivos representan los años después de Cristo.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * El enlace API para la persona.
     */
    apiLink: string;

    /**
     * Los números de los versículos del capítulo que mencionan a la persona.
     * Ordenados en orden ascendente.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * La identificación del lugar.
     */
    id: string;

    /**
     * El nombre del lugar.
     */
    name: string;

    /**
     * El tipo de accidente geográfico que es el lugar.
     */
    featureType?: string;

    /**
     * La latitud y longitud del lugar.
     */
    latitude?: number;
    longitude?: number;

    /**
     * El enlace API del lugar.
     */
    apiLink: string;

    /**
     * Los números de los versículos del capítulo que mencionan el lugar.
     * Ordenados en orden ascendente.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * El ID del evento.
     */
    id: string;

    /**
     * El nombre del evento.
     */
    name: string;

    /**
     * La fecha en que comenzó el evento.
     */
    startDate?: string;

    /**
     * El enlace de la API para el evento.
     */
    apiLink: string;

    /**
     * Los números de los versículos del capítulo que describen el evento.
     * Ordenados en orden ascendente.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * La información del conjunto de datos para las personas.
     */
    dataset: Dataset;

    /**
     * La lista de personas disponibles para el conjunto de datos.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * El documento de identidad de la persona.
     */
    id: string;

    /**
     * El nombre de la persona.
     */
    name: string;

    /**
     * Si el nombre de la persona es un nombre propio.
     */
    isProperName?: boolean;

    /**
     * El género de la persona.
     */
    gender?: string;

    /**
     * El número de referencias bíblicas que mencionan a la persona.
     */
    numberOfReferences: number;

    /**
     * El enlace API para la persona.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * La información del conjunto de datos para la persona.
     */
    dataset: Dataset;

    /**
     * La información sobre la persona.
     */
    person: DatasetPerson;

    /**
     * El enlace API para esta persona.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * El documento de identidad de la persona.
     */
    id: string;

    /**
     * El nombre de la persona.
     */
    name: string;

    /**
     * Otros nombres con los que se conoce a la persona.
     */
    alsoCalled?: string[];

    /**
     * Si el nombre de la persona es un nombre propio.
     */
    isProperName?: boolean;

    /**
     * El género de la persona.
     */
    gender?: string;

    /**
     * La descripción de la persona. Cada cadena es un párrafo.
     */
    description?: string[];

    /**
     * El año en que nació la persona y el año en que murió.
     * Los números negativos representan los años antes de Cristo. Los números positivos representan los años después de Cristo.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Los primeros y últimos años en los que se menciona a la persona.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * El lugar donde la persona nació y murió.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Las relaciones familiares de la persona.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Los grupos de personas a los que pertenece la persona.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Los eventos en los que participó la persona.
     */
    events?: DatasetEntityRef[];

    /**
     * La lista de referencias bíblicas que mencionan a la persona.
     * Ordenados por orden del libro, capítulo y versículo.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * La información del conjunto de datos para los lugares.
     */
    dataset: Dataset;

    /**
     * La lista de lugares disponibles para el conjunto de datos.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * La identificación del lugar.
     */
    id: string;

    /**
     * El nombre del lugar.
     */
    name: string;

    /**
     * El tipo de accidente geográfico que es el lugar.
     * Por ejemplo, "Ciudad", "Región", "Montaña", "Agua", etc.
     */
    featureType?: string;

    /**
     * La latitud y longitud del lugar.
     */
    latitude?: number;
    longitude?: number;

    /**
     * El número de referencias bíblicas que mencionan el lugar.
     */
    numberOfReferences: number;

    /**
     * El enlace API del lugar.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * La información del conjunto de datos para el lugar.
     */
    dataset: Dataset;

    /**
     * La información sobre el lugar.
     */
    place: DatasetPlace;

    /**
     * El enlace API para este lugar.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * La identificación del lugar.
     */
    id: string;

    /**
     * El nombre del lugar.
     */
    name: string;

    /**
     * El nombre del lugar tal como aparece en la versión King James y en la versión English Standard Version.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Otros nombres con los que se conoce el lugar.
     */
    aliases?: string[];

    /**
     * El tipo de accidente geográfico que es el lugar.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * La latitud y la longitud del lugar, y su precisión.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * La descripción del lugar. Cada cadena es un párrafo.
     */
    description?: string[];

    /**
     * El comentario sobre el lugar por parte de los autores del conjunto de datos.
     */
    comment?: string;

    /**
     * El origen de este lugar.
     * Los diferentes nombres para una misma ubicación geográfica comparten el mismo origen.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * El lugar del que este lugar es una copia.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Las personas que han estado en el lugar, que nacieron en él o que murieron allí.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Los acontecimientos que tuvieron lugar allí.
     */
    events?: DatasetEntityRef[];

    /**
     * La lista de referencias bíblicas que mencionan el lugar.
     * Ordenados por orden del libro, capítulo y versículo.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * La información del conjunto de datos para los eventos.
     */
    dataset: Dataset;

    /**
     * La lista de eventos disponibles para el conjunto de datos.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * El ID del evento.
     */
    id: string;

    /**
     * El nombre del evento.
     */
    name: string;

    /**
     * La fecha en que comenzó el evento.
     * Los números negativos representan los años antes de Cristo. Los números positivos representan los años después de Cristo.
     * Para fechas más específicas, utilice el formato `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * El número de referencias bíblicas que describen el evento.
     */
    numberOfReferences: number;

    /**
     * El enlace de la API para el evento.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * La información del conjunto de datos para el evento.
     */
    dataset: Dataset;

    /**
     * La información sobre el evento.
     */
    event: DatasetEvent;

    /**
     * El enlace de la API para este evento.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * El ID del evento.
     */
    id: string;

    /**
     * El nombre del evento.
     */
    name: string;

    /**
     * La fecha en que comenzó el evento.
     */
    startDate?: string;

    /**
     * La duración del evento.
     * Por ejemplo, "1D" significa un día y "40Y" significa cuarenta años.
     */
    duration?: string;

    /**
     * Las personas que participaron en el evento.
     */
    participants?: DatasetEntityRef[];

    /**
     * Los lugares donde tuvo lugar el evento.
     */
    locations?: DatasetEntityRef[];

    /**
     * Los grupos de personas que participaron en el evento.
     */
    groups?: DatasetEntityRef[];

    /**
     * El evento del que forma parte este evento.
     */
    partOf?: DatasetEntityRef;

    /**
     * El evento que ocurrió antes de este evento.
     */
    predecessor?: DatasetEntityRef;

    /**
     * La lista de referencias bíblicas que describen el evento.
     * Ordenados por orden del libro, capítulo y versículo.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * La información del conjunto de datos para los grupos de personas.
     */
    dataset: Dataset;

    /**
     * La lista de grupos de personas disponibles para el conjunto de datos.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * La identificación del grupo de personas.
     */
    id: string;

    /**
     * El nombre del grupo étnico.
     */
    name: string;

    /**
     * El número de personas que son miembros del grupo étnico.
     */
    numberOfMembers: number;

    /**
     * El enlace API para el grupo de personas.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Información del conjunto de datos para el grupo de personas.
     */
    dataset: Dataset;

    /**
     * La información sobre el grupo de personas.
     */
    group: DatasetPeopleGroup;

    /**
     * El enlace API para este grupo de personas.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * La identificación del grupo de personas.
     */
    id: string;

    /**
     * El nombre del grupo étnico.
     */
    name: string;

    /**
     * Las personas que son miembros del grupo étnico.
     */
    members?: DatasetEntityRef[];

    /**
     * Los eventos en los que participó el grupo de personas.
     */
    events?: DatasetEntityRef[];

    /**
     * La lista de referencias bíblicas que mencionan a este grupo étnico.
     * Ordenados por orden del libro, capítulo y versículo.
     */
    references: VerseRef[];
}