Наборы данных

export interface AvailableDatasets {
    /**
     * Список наборов данных.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * Идентификатор набора данных.
     */
    id: string;

    /**
     * Название набора данных.
     */
    name: string;

    /**
     * Веб-сайт, на котором размещен набор данных.
     */
    website: string;

    /**
     * URL-адрес, по которому можно найти лицензию на набор данных.
     */
    licenseUrl: string;

    /**
     * Английское название набора данных.
     */
    englishName: string;

    /**
     * Языковой тег ISO 639, состоящий из трех букв, на котором преимущественно представлен набор данных.
     */
    language: string;

    /**
     * Направление, в котором пишется язык.
     * "ltr" означает, что текст пишется слева направо.
     * "rtl" означает, что текст пишется справа налево по странице.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Ссылка на API для получения списка доступных книг для этого набора данных.
     */
    listOfBooksApiLink: string;

    /**
     * Доступный список форматов.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Количество книг, содержащихся в этом наборе данных.
     */
    numberOfBooks: number;

    /**
     * Общее количество глав, содержащихся в этом наборе данных.
     */
    totalNumberOfChapters: number;

    /**
     * Общее количество стихов, содержащихся в этом наборе данных.
     */
    totalNumberOfVerses: number;

    /**
     * Общее количество перекрестных ссылок, содержащихся в этом наборе данных.
     */
    totalNumberOfReferences: number;

    /**
     * Получает название языка, на котором представлен набор данных.
     * Если название языка неизвестно, оно должно быть равно null или undefined.
     */
    languageName?: string;

    /**
     * Получает название языка на английском языке.
     * Если язык не имеет английского названия, значение равно null или undefined.
     */
    languageEnglishName?: string;

    /**
     * Ссылки на API для получения списков сущностей в наборе данных.
     * Опускается, если набор данных не содержит соответствующих сущностей.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Общее количество объектов, содержащихся в наборе данных.
     * Опускается, если набор данных не содержит соответствующих сущностей.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Информация о наборе данных для книг.
     */
    dataset: Dataset;

    /**
     * Список книг, доступных для включения в набор данных.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * Идентификатор книги.
     * Соответствует идентификатору соответствующей книги Библии (Бытие, Исход и т. д.).
     */
    id: string;

    /**
     * Порядок книг в Библии.
     */
    order: number;

    /**
     * Номер первой главы книги.
     */
    firstChapterNumber: number;

    /**
     * Ссылка на первую главу книги.
     */
    firstChapterApiLink: string | null;

    /**
     * Номер последней главы книги.
     */
    lastChapterNumber: number | null;

    /**
     * Ссылка на последнюю главу книги.
     */
    lastChapterApiLink: string | null;

    /**
     * Количество глав в книге.
     */
    numberOfChapters: number;

    /**
     * Количество стихов, содержащихся в книге.
     */
    totalNumberOfVerses: number;

    /**
     * Общее количество перекрестных ссылок, содержащихся в этой книге.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Информация о наборе данных для главы книги.
     */
    dataset: Dataset;

    /**
     * Информация о книге, относящаяся к данной главе.
     */
    book: DatasetBook;

    /**
     * Ссылка на эту главу.
     */
    thisChapterLink: string;

    /**
     * Ссылка на следующую главу.
     * Значение null указывает на то, что это последняя глава в наборе данных.
     */
    nextChapterApiLink: string | null;

    /**
     * Ссылка на предыдущую главу.
     * Если это первая глава в наборе данных, значение должно быть равно нулю.
     */
    previousChapterApiLink: string | null;

    /**
     * Количество стихов, содержащихся в главе.
     */
    numberOfVerses: number;

    /**
     * Информация для данной главы.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Номер главы.
     */
    number: number;

    /**
     * Содержание главы.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Номер стиха.
     */
    verse: number;

    /**
     * Перекрестные ссылки на стих.
     *
     * Отсортировано по баллам, в порядке убывания.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * Идентификатор книги, на которую делается ссылка.
     */
    book: string;

    /**
     * Номер главы.
     */
    chapter: number;

    /**
     * Номер стиха.
     * Если присутствует `endVerse` , то это стих, с которого начинается ссылка.
     */
    verse: number;

    /**
     * Стих, на котором заканчивается отсылка.
     */
    endVerse?: number;

    /**
     * Показатель релевантности ссылки.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * Идентификатор объекта, на который делается ссылка.
     */
    id: string;

    /**
     * Тип сущности, на которую делается ссылка.
     * Соответствует сегменту коллекции API-ссылки сущности, поэтому ссылку можно сформировать как `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Название объекта, на который делается ссылка.
     */
    name?: string;

    /**
     * Ссылка на API для сущности, на которую делается ссылка.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * Идентификатор книги (GEN, EXO и т. д.).
     */
    book: string;

    /**
     * Номер главы, с которой начинается ссылка.
     */
    chapter: number;

    /**
     * Номер стиха, с которого начинается ссылка.
     */
    verse: number;

    /**
     * Стих, на котором заканчивается отсылка.
     * Последовательные стихи в одной главе объединены в одну ссылку.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Информация о наборе данных для главы книги.
     */
    dataset: Dataset;

    /**
     * Информация о книге, относящаяся к данной главе.
     */
    book: DatasetBook;

    /**
     * Данные об объектах, относящихся к данной главе.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Ссылка на эту главу.
     */
    thisChapterLink: string;

    /**
     * Ссылка на следующую главу.
     * Значение null указывает на то, что это последняя глава в наборе данных.
     */
    nextChapterApiLink: string | null;

    /**
     * Ссылка на предыдущую главу.
     * Если это первая глава в наборе данных, значение должно быть равно нулю.
     */
    previousChapterApiLink: string | null;

    /**
     * Количество людей, мест и событий, упоминаемых в главе.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Номер главы.
     */
    number: number;

    /**
     * Люди, которые появляются в этой главе.
     * Отсортировано по первому куплету, в котором они появляются.
     */
    people: ChapterPerson[];

    /**
     * Места, упомянутые в главе.
     * Отсортировано по первому куплету, в котором они появляются.
     */
    places: ChapterPlace[];

    /**
     * События, описанные в этой главе.
     * Отсортировано по первому куплету, в котором они появляются.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * Идентификационный номер человека.
     */
    id: string;

    /**
     * Имя человека.
     */
    name: string;

    /**
     * Является ли имя человека собственным именем.
     */
    isProperName?: boolean;

    /**
     * Пол человека.
     */
    gender?: string;

    /**
     * Год рождения человека и год его смерти.
     * Отрицательные числа обозначают годы до нашей эры. Положительные числа обозначают годы нашей эры.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Ссылка на API для данного человека.
     */
    apiLink: string;

    /**
     * Номера стихов в главе, в которых упоминается данный человек.
     * Отсортировано в порядке возрастания.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * Идентификатор места.
     */
    id: string;

    /**
     * Название места.
     */
    name: string;

    /**
     * Тип географического объекта, к которому относится данное место.
     */
    featureType?: string;

    /**
     * Широта и долгота этого места.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Ссылка на API этого места.
     */
    apiLink: string;

    /**
     * Номера стихов в главе, в которых упоминается это место.
     * Отсортировано в порядке возрастания.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * Идентификатор события.
     */
    id: string;

    /**
     * Название мероприятия.
     */
    name: string;

    /**
     * Дата начала мероприятия.
     */
    startDate?: string;

    /**
     * Ссылка на API мероприятия.
     */
    apiLink: string;

    /**
     * Номера стихов в главе, описывающих данное событие.
     * Отсортировано в порядке возрастания.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Информация из набора данных предназначена для людей.
     */
    dataset: Dataset;

    /**
     * Список людей, доступных для включения в набор данных.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * Идентификационный номер человека.
     */
    id: string;

    /**
     * Имя человека.
     */
    name: string;

    /**
     * Является ли имя человека собственным именем.
     */
    isProperName?: boolean;

    /**
     * Пол человека.
     */
    gender?: string;

    /**
     * Количество упоминаний данного человека в Библии.
     */
    numberOfReferences: number;

    /**
     * Ссылка на API для данного человека.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Информация о человеке, содержащаяся в наборе данных.
     */
    dataset: Dataset;

    /**
     * Информация о человеке.
     */
    person: DatasetPerson;

    /**
     * Ссылка на API для этого человека.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * Идентификационный номер человека.
     */
    id: string;

    /**
     * Имя человека.
     */
    name: string;

    /**
     * Другие имена, которыми называют этого человека.
     */
    alsoCalled?: string[];

    /**
     * Является ли имя человека собственным именем.
     */
    isProperName?: boolean;

    /**
     * Пол человека.
     */
    gender?: string;

    /**
     * Описание человека. Каждая строка представляет собой абзац текста.
     */
    description?: string[];

    /**
     * Год рождения человека и год его смерти.
     * Отрицательные числа обозначают годы до нашей эры. Положительные числа обозначают годы нашей эры.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Годы, когда упоминается данный человек (самый ранний и самый поздний).
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Место, где человек родился и умер.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Семейные отношения человека.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Группы людей, к которым принадлежит данный человек.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * События, в которых участвовал данный человек.
     */
    events?: DatasetEntityRef[];

    /**
     * Список библейских источников, в которых упоминается данный человек.
     * Отсортировано по порядку книг, глав и стихов.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Информация о наборе данных по этим местам.
     */
    dataset: Dataset;

    /**
     * Список мест, доступных для размещения набора данных.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * Идентификатор места.
     */
    id: string;

    /**
     * Название места.
     */
    name: string;

    /**
     * Тип географического объекта, к которому относится данное место.
     * Например, «Город», «Регион», «Гора», «Вода» и т. д.
     */
    featureType?: string;

    /**
     * Широта и долгота этого места.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Количество упоминаний этого места в Библии.
     */
    numberOfReferences: number;

    /**
     * Ссылка на API этого места.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Информация о данном месте в виде набора данных.
     */
    dataset: Dataset;

    /**
     * Информация об этом месте.
     */
    place: DatasetPlace;

    /**
     * Ссылка на API для этого места.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * Идентификатор места.
     */
    id: string;

    /**
     * Название места.
     */
    name: string;

    /**
     * Название места, как оно указано в Библии короля Якова и в Английской стандартной версии.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Другие названия, под которыми это место известно.
     */
    aliases?: string[];

    /**
     * Тип географического объекта, к которому относится данное место.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * Широта и долгота данного места, и насколько они точны.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Описание места. Каждая строка представляет собой абзац текста.
     */
    description?: string[];

    /**
     * Комментарий авторов набора данных об этом месте.
     */
    comment?: string;

    /**
     * Корневое место этого места.
     * Разные названия одного и того же географического места имеют общий корень.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * Место, копией которого является это место.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Люди, которые там побывали, родились или умерли в этом месте.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * События, произошедшие в этом месте.
     */
    events?: DatasetEntityRef[];

    /**
     * Список библейских источников, в которых упоминается это место.
     * Отсортировано по порядку книг, глав и стихов.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Информация о наборе данных, относящаяся к событиям.
     */
    dataset: Dataset;

    /**
     * Список событий, доступных для данного набора данных.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * Идентификатор события.
     */
    id: string;

    /**
     * Название мероприятия.
     */
    name: string;

    /**
     * Дата начала мероприятия.
     * Отрицательные числа обозначают годы до нашей эры. Положительные числа обозначают годы нашей эры.
     * Для более точных дат используется формат `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * Количество библейских ссылок, описывающих это событие.
     */
    numberOfReferences: number;

    /**
     * Ссылка на API мероприятия.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Информация о наборе данных, относящихся к мероприятию.
     */
    dataset: Dataset;

    /**
     * Информация о мероприятии.
     */
    event: DatasetEvent;

    /**
     * Ссылка на API для этого мероприятия.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * Идентификатор события.
     */
    id: string;

    /**
     * Название мероприятия.
     */
    name: string;

    /**
     * Дата начала мероприятия.
     */
    startDate?: string;

    /**
     * Продолжительность мероприятия.
     * Например, "1D" означает один день, а "40Y" — сорок лет.
     */
    duration?: string;

    /**
     * Люди, принявшие участие в мероприятии.
     */
    participants?: DatasetEntityRef[];

    /**
     * Места, где произошло это событие.
     */
    locations?: DatasetEntityRef[];

    /**
     * Группы населения, принявшие участие в мероприятии.
     */
    groups?: DatasetEntityRef[];

    /**
     * Мероприятие, частью которого является данное мероприятие.
     */
    partOf?: DatasetEntityRef;

    /**
     * Событие, которое произошло до этого события.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Список библейских источников, описывающих это событие.
     * Отсортировано по порядку книг, глав и стихов.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Информация о наборе данных по группам населения.
     */
    dataset: Dataset;

    /**
     * Список групп людей, доступных для данного набора данных.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * Идентификатор группы людей.
     */
    id: string;

    /**
     * Название группы людей.
     */
    name: string;

    /**
     * Количество людей, входящих в данную этническую группу.
     */
    numberOfMembers: number;

    /**
     * Ссылка на API для группы пользователей.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Информация о наборе данных для данной группы людей.
     */
    dataset: Dataset;

    /**
     * Информация о группе людей.
     */
    group: DatasetPeopleGroup;

    /**
     * Ссылка на API для этой группы людей.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * Идентификатор группы людей.
     */
    id: string;

    /**
     * Название группы людей.
     */
    name: string;

    /**
     * Люди, являющиеся членами данной этнической группы.
     */
    members?: DatasetEntityRef[];

    /**
     * Мероприятия, в которых участвовала эта группа людей.
     */
    events?: DatasetEntityRef[];

    /**
     * Список библейских источников, в которых упоминается эта группа людей.
     * Отсортировано по порядку книг, глав и стихов.
     */
    references: VerseRef[];
}