Conjuntos de dados

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

export interface Dataset {
    /**
     * O ID do conjunto de dados.
     */
    id: string;

    /**
     * O nome do conjunto de dados.
     */
    name: string;

    /**
     * O site onde o conjunto de dados está disponível.
     */
    website: string;

    /**
     * O endereço URL onde se pode encontrar a licença do conjunto de dados.
     */
    licenseUrl: string;

    /**
     * O nome em inglês para o conjunto de dados.
     */
    englishName: string;

    /**
     * A etiqueta de idioma de 3 letras ISO 639 na qual o conjunto de dados se encontra principalmente.
     */
    language: string;

    /**
     * A direção em que a língua é escrita.
     * "ltr" indica que o texto é escrito da esquerda para a direita na página.
     * "rtl" indica que o texto é escrito da direita para a esquerda na página.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * O link da API para a lista de livros disponíveis para este conjunto de dados.
     */
    listOfBooksApiLink: string;

    /**
     * Lista de formatos disponíveis.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * O número de livros contidos neste conjunto de dados.
     */
    numberOfBooks: number;

    /**
     * O número total de capítulos contidos neste conjunto de dados.
     */
    totalNumberOfChapters: number;

    /**
     * O número total de versículos contidos neste conjunto de dados.
     */
    totalNumberOfVerses: number;

    /**
     * O número total de referências cruzadas contidas neste conjunto de dados.
     */
    totalNumberOfReferences: number;

    /**
     * Obtém o nome do idioma em que o conjunto de dados está contido.
     * Nulo ou indefinido se o nome do idioma for desconhecido.
     */
    languageName?: string;

    /**
     * Obtém o nome do idioma em inglês.
     * Nulo ou indefinido se o idioma não tiver um nome em inglês.
     */
    languageEnglishName?: string;

    /**
     * Os links da API para as listas de entidades no conjunto de dados.
     * Omitido se o conjunto de dados não contiver as entidades correspondentes.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * O número total de entidades contidas no conjunto de dados.
     * Omitido se o conjunto de dados não contiver as entidades correspondentes.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Informações do conjunto de dados referentes aos livros.
     */
    dataset: Dataset;

    /**
     * Lista dos livros disponíveis para o conjunto de dados.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * A identificação do livro.
     * Corresponde ao ID do livro correspondente na Bíblia (Gênesis, Êxodo, etc.).
     */
    id: string;

    /**
     * A ordem dos livros na Bíblia.
     */
    order: number;

    /**
     * O número do primeiro capítulo do livro.
     */
    firstChapterNumber: number;

    /**
     * O link para o primeiro capítulo do livro.
     */
    firstChapterApiLink: string | null;

    /**
     * O número do último capítulo do livro.
     */
    lastChapterNumber: number | null;

    /**
     * O link para o último capítulo do livro.
     */
    lastChapterApiLink: string | null;

    /**
     * O número de capítulos que o livro contém.
     */
    numberOfChapters: number;

    /**
     * O número de versículos que o livro contém.
     */
    totalNumberOfVerses: number;

    /**
     * O número total de referências cruzadas que este livro contém.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Informações do conjunto de dados para o capítulo do livro.
     */
    dataset: Dataset;

    /**
     * Informações sobre o capítulo do livro.
     */
    book: DatasetBook;

    /**
     * O link para este capítulo.
     */
    thisChapterLink: string;

    /**
     * O link para o próximo capítulo.
     * Nulo se este for o último capítulo do conjunto de dados.
     */
    nextChapterApiLink: string | null;

    /**
     * O link para o capítulo anterior.
     * Nulo se este for o primeiro capítulo do conjunto de dados.
     */
    previousChapterApiLink: string | null;

    /**
     * O número de versículos que o capítulo contém.
     */
    numberOfVerses: number;

    /**
     * As informações para o capítulo.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * O número do capítulo.
     */
    number: number;

    /**
     * O conteúdo do capítulo.
     */
    content: DatasetVerse[];
}

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

    /**
     * As referências cruzadas para o versículo.
     *
     * Ordenado por pontuação, em ordem decrescente.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * O ID do livro ao qual se faz referência.
     */
    book: string;

    /**
     * O número do capítulo.
     */
    chapter: number;

    /**
     * O número do versículo.
     * Se `endVerse` estiver presente, então este é o versículo em que a referência começa.
     */
    verse: number;

    /**
     * O versículo em que a referência termina.
     */
    endVerse?: number;

    /**
     * A pontuação de relevância para a referência.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * O ID da entidade que está sendo referenciada.
     */
    id: string;

    /**
     * O tipo da entidade à qual se faz referência.
     * Corresponde ao segmento de coleção do link da API da entidade, portanto o link pode ser construído como `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * O nome da entidade à qual se faz referência.
     */
    name?: string;

    /**
     * O link da API para a entidade que está sendo referenciada.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * O ID do livro (GEN, EXO, etc.).
     */
    book: string;

    /**
     * O número do capítulo em que a referência começa.
     */
    chapter: number;

    /**
     * O número do versículo em que a referência começa.
     */
    verse: number;

    /**
     * O versículo em que a referência termina.
     * Versículos consecutivos no mesmo capítulo são agrupados em uma única referência.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Informações do conjunto de dados para o capítulo do livro.
     */
    dataset: Dataset;

    /**
     * Informações sobre o capítulo do livro.
     */
    book: DatasetBook;

    /**
     * Os dados da entidade para o capítulo.
     */
    chapter: DatasetEntityChapterData;

    /**
     * O link para este capítulo.
     */
    thisChapterLink: string;

    /**
     * O link para o próximo capítulo.
     * Nulo se este for o último capítulo do conjunto de dados.
     */
    nextChapterApiLink: string | null;

    /**
     * O link para o capítulo anterior.
     * Nulo se este for o primeiro capítulo do conjunto de dados.
     */
    previousChapterApiLink: string | null;

    /**
     * O número de pessoas, lugares e eventos que aparecem no capítulo.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * O número do capítulo.
     */
    number: number;

    /**
     * As pessoas que aparecem no capítulo.
     * Ordenados pelo primeiro versículo em que aparecem.
     */
    people: ChapterPerson[];

    /**
     * Os lugares que aparecem no capítulo.
     * Ordenados pelo primeiro versículo em que aparecem.
     */
    places: ChapterPlace[];

    /**
     * Os eventos que aparecem no capítulo.
     * Ordenados pelo primeiro versículo em que aparecem.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * A identificação da pessoa.
     */
    id: string;

    /**
     * O nome da pessoa.
     */
    name: string;

    /**
     * Se o nome da pessoa é um nome próprio.
     */
    isProperName?: boolean;

    /**
     * O gênero da pessoa.
     */
    gender?: string;

    /**
     * O ano em que a pessoa nasceu e o ano em que morreu.
     * Números negativos representam anos a.C. Números positivos representam anos d.C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * O link da API para a pessoa.
     */
    apiLink: string;

    /**
     * Os números dos versículos do capítulo que mencionam a pessoa.
     * Ordenados em ordem crescente.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * A identificação do local.
     */
    id: string;

    /**
     * O nome do lugar.
     */
    name: string;

    /**
     * O tipo de acidente geográfico que o local representa.
     */
    featureType?: string;

    /**
     * A latitude e a longitude do local.
     */
    latitude?: number;
    longitude?: number;

    /**
     * O link da API para o local.
     */
    apiLink: string;

    /**
     * Os números dos versículos do capítulo que mencionam o lugar.
     * Ordenados em ordem crescente.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * O ID do evento.
     */
    id: string;

    /**
     * O nome do evento.
     */
    name: string;

    /**
     * A data em que o evento começou.
     */
    startDate?: string;

    /**
     * O link da API para o evento.
     */
    apiLink: string;

    /**
     * Os números dos versículos do capítulo que descrevem o evento.
     * Ordenados em ordem crescente.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * As informações do conjunto de dados são referentes às pessoas.
     */
    dataset: Dataset;

    /**
     * Lista de pessoas disponíveis para o conjunto de dados.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * A identificação da pessoa.
     */
    id: string;

    /**
     * O nome da pessoa.
     */
    name: string;

    /**
     * Se o nome da pessoa é um nome próprio.
     */
    isProperName?: boolean;

    /**
     * O gênero da pessoa.
     */
    gender?: string;

    /**
     * O número de referências bíblicas que mencionam a pessoa.
     */
    numberOfReferences: number;

    /**
     * O link da API para a pessoa.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Informações do conjunto de dados referentes à pessoa.
     */
    dataset: Dataset;

    /**
     * As informações sobre a pessoa.
     */
    person: DatasetPerson;

    /**
     * O link da API para esta pessoa.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * A identificação da pessoa.
     */
    id: string;

    /**
     * O nome da pessoa.
     */
    name: string;

    /**
     * Outros nomes pelos quais a pessoa é chamada.
     */
    alsoCalled?: string[];

    /**
     * Se o nome da pessoa é um nome próprio.
     */
    isProperName?: boolean;

    /**
     * O gênero da pessoa.
     */
    gender?: string;

    /**
     * A descrição da pessoa. Cada linha de código representa um parágrafo.
     */
    description?: string[];

    /**
     * O ano em que a pessoa nasceu e o ano em que morreu.
     * Números negativos representam anos a.C. Números positivos representam anos d.C.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Os anos mais antigos e mais recentes em que a pessoa é mencionada.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * O local onde a pessoa nasceu e morreu.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * As relações familiares da pessoa.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Os grupos étnicos aos quais a pessoa pertence.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Os eventos em que a pessoa participou.
     */
    events?: DatasetEntityRef[];

    /**
     * Lista de referências bíblicas que mencionam a pessoa.
     * Organizado por ordem do livro, capítulo e versículo.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Informações do conjunto de dados referentes aos locais.
     */
    dataset: Dataset;

    /**
     * Lista de locais disponíveis para o conjunto de dados.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * A identificação do local.
     */
    id: string;

    /**
     * O nome do lugar.
     */
    name: string;

    /**
     * O tipo de acidente geográfico que o local representa.
     * Por exemplo, "Cidade", "Região", "Montanha", "Água", etc.
     */
    featureType?: string;

    /**
     * A latitude e a longitude do local.
     */
    latitude?: number;
    longitude?: number;

    /**
     * O número de referências bíblicas que mencionam o local.
     */
    numberOfReferences: number;

    /**
     * O link da API para o local.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Informações do conjunto de dados para o local.
     */
    dataset: Dataset;

    /**
     * Informações sobre o local.
     */
    place: DatasetPlace;

    /**
     * O link da API para este local.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * A identificação do local.
     */
    id: string;

    /**
     * O nome do lugar.
     */
    name: string;

    /**
     * O nome do local, conforme aparece na versão King James e na versão English Standard.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Outros nomes pelos quais o lugar é conhecido.
     */
    aliases?: string[];

    /**
     * O tipo de acidente geográfico que o local representa.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * A latitude e a longitude do local, e qual a sua precisão.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Descrição do local. Cada linha de código representa um parágrafo.
     */
    description?: string[];

    /**
     * O comentário sobre o local, feito pelos autores do conjunto de dados.
     */
    comment?: string;

    /**
     * O lugar raiz deste lugar.
     * Nomes diferentes para o mesmo local geográfico compartilham a mesma origem.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * O lugar do qual este lugar é uma duplicata.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * As pessoas que estiveram naquele lugar, nasceram naquele lugar ou morreram naquele lugar.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Os eventos que aconteceram no local.
     */
    events?: DatasetEntityRef[];

    /**
     * Lista de referências bíblicas que mencionam o local.
     * Organizado por ordem do livro, capítulo e versículo.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Informações do conjunto de dados referentes aos eventos.
     */
    dataset: Dataset;

    /**
     * Lista de eventos disponíveis para o conjunto de dados.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * O ID do evento.
     */
    id: string;

    /**
     * O nome do evento.
     */
    name: string;

    /**
     * A data em que o evento começou.
     * Números negativos representam anos a.C. Números positivos representam anos d.C.
     * Datas mais específicas utilizam o formato `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * O número de referências bíblicas que descrevem o evento.
     */
    numberOfReferences: number;

    /**
     * O link da API para o evento.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Informações do conjunto de dados para o evento.
     */
    dataset: Dataset;

    /**
     * Informações sobre o evento.
     */
    event: DatasetEvent;

    /**
     * O link da API para este evento.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * O ID do evento.
     */
    id: string;

    /**
     * O nome do evento.
     */
    name: string;

    /**
     * A data em que o evento começou.
     */
    startDate?: string;

    /**
     * A duração do evento.
     * Por exemplo, "1D" significa um dia e "40Y" significa quarenta anos.
     */
    duration?: string;

    /**
     * As pessoas que participaram do evento.
     */
    participants?: DatasetEntityRef[];

    /**
     * Os locais onde o evento ocorreu.
     */
    locations?: DatasetEntityRef[];

    /**
     * Os grupos étnicos que participaram do evento.
     */
    groups?: DatasetEntityRef[];

    /**
     * O evento do qual este evento faz parte.
     */
    partOf?: DatasetEntityRef;

    /**
     * O evento que ocorreu antes deste evento.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Lista de referências bíblicas que descrevem o evento.
     * Organizado por ordem do livro, capítulo e versículo.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Informações do conjunto de dados para os grupos de pessoas.
     */
    dataset: Dataset;

    /**
     * Lista dos grupos populacionais disponíveis no conjunto de dados.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * A identificação do grupo étnico.
     */
    id: string;

    /**
     * O nome do grupo étnico.
     */
    name: string;

    /**
     * O número de pessoas que são membros do grupo étnico.
     */
    numberOfMembers: number;

    /**
     * O link da API para o grupo de pessoas.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Informações do conjunto de dados para o grupo de pessoas.
     */
    dataset: Dataset;

    /**
     * Informações sobre o grupo étnico.
     */
    group: DatasetPeopleGroup;

    /**
     * O link da API para este grupo de pessoas.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * A identificação do grupo étnico.
     */
    id: string;

    /**
     * O nome do grupo étnico.
     */
    name: string;

    /**
     * As pessoas que são membros do grupo étnico.
     */
    members?: DatasetEntityRef[];

    /**
     * Os eventos em que o grupo étnico participou.
     */
    events?: DatasetEntityRef[];

    /**
     * Lista de referências bíblicas que mencionam esse grupo étnico.
     * Organizado por ordem do livro, capítulo e versículo.
     */
    references: VerseRef[];
}