Saitunan Bayanai

export interface AvailableDatasets {
    /**
     * Jerin bayanan bayanai.
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * ID na bayanan.
     */
    id: string;

    /**
     * Sunan bayanan.
     */
    name: string;

    /**
     * Shafin yanar gizo don adana bayanai.
     */
    website: string;

    /**
     * Ana iya samun URL ɗin da lasisin bayanan ke bayarwa.
     */
    licenseUrl: string;

    /**
     * Sunan Ingilishi don bayanan.
     */
    englishName: string;

    /**
     * Alamar harshen ISO 639 mai haruffa 3 da aka fi amfani da ita a cikin bayanan.
     */
    language: string;

    /**
     * Alkiblar da aka rubuta harshen a ciki.
     * "ltr" yana nuna cewa an rubuta rubutun daga gefen hagu na shafin zuwa dama.
     * "rtl" yana nuna cewa an rubuta rubutun daga gefen dama na shafin zuwa hagu.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Hanyar API don jerin littattafan da ake da su don wannan tarin bayanai.
     */
    listOfBooksApiLink: string;

    /**
     * Jerin tsare-tsare da ake da su.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Adadin littattafan da ke cikin wannan tarin bayanai.
     */
    numberOfBooks: number;

    /**
     * Jimillar surori da ke cikin wannan bayanai.
     */
    totalNumberOfChapters: number;

    /**
     * Jimillar ayoyin da ke cikin wannan bayanai.
     */
    totalNumberOfVerses: number;

    /**
     * Jimillar adadin nassoshi da ke cikin wannan bayanan.
     */
    totalNumberOfReferences: number;

    /**
     * Yana samun sunan harshen da bayanan ke ciki.
     * Ba a san ko an bayyana sunan harshen ba.
     */
    languageName?: string;

    /**
     * Yana samun sunan harshen a cikin Turanci.
     * Ba a fayyace ko ba a fayyace ba idan harshen ba shi da sunan Turanci.
     */
    languageEnglishName?: string;

    /**
     * Haɗin API don jerin abubuwan da ke cikin bayanan.
     * An cire shi idan bayanan ba su ƙunshi abubuwan da suka dace ba.
     */
    listOfPeopleApiLink?: string;
    listOfPlacesApiLink?: string;
    listOfEventsApiLink?: string;
    listOfPeopleGroupsApiLink?: string;

    /**
     * Jimlar adadin abubuwan da ke cikin bayanan.
     * An cire shi idan bayanan ba su ƙunshi abubuwan da suka dace ba.
     */
    totalNumberOfPeople?: number;
    totalNumberOfPlaces?: number;
    totalNumberOfEvents?: number;
    totalNumberOfPeopleGroups?: number;
}

export interface DatasetBooks {
    /**
     * Cikakken bayani game da littafin da aka yi amfani da shi.
     */
    dataset: Dataset;

    /**
     * Jerin littattafan da ake da su don adana bayanai.
     */
    books: DatasetBook[];
}

interface DatasetBook {
    /**
     * ID na littafin.
     * Ya dace da ID na littafin da ya dace a cikin Littafi Mai Tsarki (GEN, EXO, da sauransu).
     */
    id: string;

    /**
     * Tsarin littafin a cikin Littafi Mai Tsarki.
     */
    order: number;

    /**
     * Adadin babi na farko a cikin littafin.
     */
    firstChapterNumber: number;

    /**
     * Hanyar haɗi zuwa babi na farko na littafin.
     */
    firstChapterApiLink: string | null;

    /**
     * Adadin babi na ƙarshe a cikin littafin.
     */
    lastChapterNumber: number | null;

    /**
     * Hanyar haɗi zuwa babi na ƙarshe na littafin.
     */
    lastChapterApiLink: string | null;

    /**
     * Adadin surori da littafin ya ƙunsa.
     */
    numberOfChapters: number;

    /**
     * Adadin ayoyin da littafin ya kunsa.
     */
    totalNumberOfVerses: number;

    /**
     * Jimillar adadin nassoshi da wannan littafin ya ƙunsa.
     */
    totalNumberOfReferences: number;
}

export interface DatasetBookChapter {
    /**
     * Cikakken bayani game da littafin da aka yi amfani da shi don adana bayanai.
     */
    dataset: Dataset;

    /**
     * Bayanin littafin don babin littafin.
     */
    book: DatasetBook;

    /**
     * Hanyar haɗi zuwa wannan babi.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a cikin bayanan.
     */
    nextChapterApiLink: string | null;

    /**
     * Hanyar haɗi zuwa babi na baya.
     * Babu komai idan wannan shine babi na farko a cikin bayanan.
     */
    previousChapterApiLink: string | null;

    /**
     * Adadin ayoyin da surar ta kunsa.
     */
    numberOfVerses: number;

    /**
     * Bayanin da aka bayar don babi.
     */
    chapter: DatasetChapterData;
}

interface DatasetChapterData {
    /**
     * Adadin babin.
     */
    number: number;

    /**
     * Abubuwan da ke cikin babin.
     */
    content: DatasetVerse[];
}

interface DatasetVerse {
    /**
     * Adadin ayar.
     */
    verse: number;

    /**
     * Nassoshi game da ayar.
     *
     * An tsara ta hanyar maki, ƙasa.
     */
    references: DatasetReference[];
}

interface DatasetReference {
    /**
     * ID na littafin da ake nuni da shi.
     */
    book: string;

    /**
     * Lambar babi.
     */
    chapter: number;

    /**
     * Lambar ayar.
     * Idan `endVerse` ya kasance, to wannan ita ce ayar da aka fara amfani da ita a nan.
     */
    verse: number;

    /**
     * Ayar da aka ambata ta ƙare a kai.
     */
    endVerse?: number;

    /**
     * Makin da ya dace don nassoshi.
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * ID na kamfanin da ake nuni da shi.
     */
    id: string;

    /**
     * Nau'in abin da ake magana a kai.
     * Yana daidaita ɓangaren tattarawa na hanyar haɗin API na ƙungiyar, don haka za a iya gina hanyar haɗin kamar `/api/d/{dataset}/{type}/{id}.json` .
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * Sunan mahaɗan da ake ambatonsa.
     */
    name?: string;

    /**
     * Hanyar API don abin da ake magana a kai.
     */
    apiLink?: string;
}

export interface VerseRef {
    /**
     * ID na littafin (GEN, EXO, da sauransu).
     */
    book: string;

    /**
     * Lambar babi da aka fara amfani da ita a kai.
     */
    chapter: number;

    /**
     * Lambar ayar da aka fara amfani da ita a kai.
     */
    verse: number;

    /**
     * Ayar da aka ambata ta ƙare a kai.
     * An tattara ayoyi masu jere a cikin sura ɗaya zuwa nassoshi guda ɗaya.
     */
    endVerse?: number;
}

export interface DatasetEntityBookChapter {
    /**
     * Cikakken bayani game da littafin da aka yi amfani da shi don adana bayanai.
     */
    dataset: Dataset;

    /**
     * Bayanin littafin don babin littafin.
     */
    book: DatasetBook;

    /**
     * Bayanan mahalli na babi.
     */
    chapter: DatasetEntityChapterData;

    /**
     * Hanyar haɗi zuwa wannan babi.
     */
    thisChapterLink: string;

    /**
     * Hanyar haɗi zuwa babi na gaba.
     * Babu komai idan wannan shine babi na ƙarshe a cikin bayanan.
     */
    nextChapterApiLink: string | null;

    /**
     * Hanyar haɗi zuwa babi na baya.
     * Babu komai idan wannan shine babi na farko a cikin bayanan.
     */
    previousChapterApiLink: string | null;

    /**
     * Adadin mutane, wurare, da abubuwan da suka faru da suka bayyana a cikin babin.
     */
    numberOfPeople: number;
    numberOfPlaces: number;
    numberOfEvents: number;
}

interface DatasetEntityChapterData {
    /**
     * Adadin babin.
     */
    number: number;

    /**
     * Mutanen da suka bayyana a cikin babi.
     * An tsara ta da ayar farko da suka bayyana a ciki.
     */
    people: ChapterPerson[];

    /**
     * Wuraren da suka bayyana a cikin babin.
     * An tsara ta da ayar farko da suka bayyana a ciki.
     */
    places: ChapterPlace[];

    /**
     * Abubuwan da suka bayyana a cikin babin.
     * An tsara ta da ayar farko da suka bayyana a ciki.
     */
    events: ChapterEvent[];
}

interface ChapterPerson {
    /**
     * ID na mutumin.
     */
    id: string;

    /**
     * Sunan mutumin.
     */
    name: string;

    /**
     * Ko sunan mutumin sunan da aka saba amfani da shi ne.
     */
    isProperName?: boolean;

    /**
     * Jinsin mutum.
     */
    gender?: string;

    /**
     * Shekarar da aka haifi mutumin da kuma shekarar da ya mutu.
     * Lambobin da ba su da kyau sune shekaru BC. Lambobin da ba su da kyau sune shekaru AD.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Hanyar API ga mutumin.
     */
    apiLink: string;

    /**
     * Lambobin ayoyin da ke cikin babin da suka ambaci mutumin.
     * An tsara shi a cikin tsari mai hawa.
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * ID na wurin.
     */
    id: string;

    /**
     * Sunan wurin.
     */
    name: string;

    /**
     * Nau'in yanayin ƙasa da wurin yake.
     */
    featureType?: string;

    /**
     * Latitude da tsawon wurin.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Hanyar API don wurin.
     */
    apiLink: string;

    /**
     * Lambobin ayoyin da ke cikin babin da suka ambaci wurin.
     * An tsara shi a cikin tsari mai hawa.
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * ID na taron.
     */
    id: string;

    /**
     * Sunan taron.
     */
    name: string;

    /**
     * Ranar da taron ya fara a.
     */
    startDate?: string;

    /**
     * Haɗin API don taron.
     */
    apiLink: string;

    /**
     * Lambobin ayoyin da ke cikin babin da ke bayanin abin da ya faru.
     * An tsara shi a cikin tsari mai hawa.
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * Tsarin bayanai don mutane.
     */
    dataset: Dataset;

    /**
     * Jerin mutanen da ake da su don samun bayanai.
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * ID na mutumin.
     */
    id: string;

    /**
     * Sunan mutumin.
     */
    name: string;

    /**
     * Ko sunan mutumin sunan da aka saba amfani da shi ne.
     */
    isProperName?: boolean;

    /**
     * Jinsin mutum.
     */
    gender?: string;

    /**
     * Adadin nassoshin Littafi Mai Tsarki da suka ambaci mutumin.
     */
    numberOfReferences: number;

    /**
     * Hanyar API ga mutumin.
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * Bayanin bayanai na mutum.
     */
    dataset: Dataset;

    /**
     * Bayanin mutum.
     */
    person: DatasetPerson;

    /**
     * Hanyar API ta wannan mutumin.
     */
    thisPersonApiLink: string;
}

interface DatasetPerson {
    /**
     * ID na mutumin.
     */
    id: string;

    /**
     * Sunan mutumin.
     */
    name: string;

    /**
     * Wasu sunaye da ake kiran mutumin da su.
     */
    alsoCalled?: string[];

    /**
     * Ko sunan mutumin sunan da aka saba amfani da shi ne.
     */
    isProperName?: boolean;

    /**
     * Jinsin mutum.
     */
    gender?: string;

    /**
     * Bayanin mutumin. Kowace layi sakin layi ne.
     */
    description?: string[];

    /**
     * Shekarar da aka haifi mutumin da kuma shekarar da ya mutu.
     * Lambobin da ba su da kyau sune shekaru BC. Lambobin da ba su da kyau sune shekaru AD.
     */
    birthYear?: number;
    deathYear?: number;

    /**
     * Shekarun farko da na baya-bayan nan da aka ambaci mutumin a ciki.
     */
    minYear?: number;
    maxYear?: number;

    /**
     * Wurin da aka haifi mutumin kuma ya mutu a ciki.
     */
    birthPlace?: DatasetEntityRef;
    deathPlace?: DatasetEntityRef;

    /**
     * Dangantakar iyali ta mutum.
     */
    father?: DatasetEntityRef[];
    mother?: DatasetEntityRef[];
    partners?: DatasetEntityRef[];
    children?: DatasetEntityRef[];
    siblings?: DatasetEntityRef[];
    halfSiblingsSameMother?: DatasetEntityRef[];
    halfSiblingsSameFather?: DatasetEntityRef[];

    /**
     * Ƙungiyoyin mutane da mutumin yake memba a cikinsu.
     */
    memberOf?: DatasetEntityRef[];

    /**
     * Abubuwan da mutumin ya shiga ciki.
     */
    events?: DatasetEntityRef[];

    /**
     * Jerin nassoshin Littafi Mai Tsarki da suka ambaci mutumin.
     * An tsara shi ta hanyar tsari na littafi, babi, da aya.
     */
    references: VerseRef[];
}

export interface DatasetPlaces {
    /**
     * Bayanin bayanai na wurare.
     */
    dataset: Dataset;

    /**
     * Jerin wuraren da ake da su don tattara bayanai.
     */
    places: DatasetPlaceSummary[];
}

interface DatasetPlaceSummary {
    /**
     * ID na wurin.
     */
    id: string;

    /**
     * Sunan wurin.
     */
    name: string;

    /**
     * Nau'in yanayin ƙasa da wurin yake.
     * Misali, "Birni", "Yanki", "Dutse", "Ruwa", da sauransu.
     */
    featureType?: string;

    /**
     * Latitude da tsawon wurin.
     */
    latitude?: number;
    longitude?: number;

    /**
     * Adadin nassoshin Littafi Mai Tsarki da suka ambaci wurin.
     */
    numberOfReferences: number;

    /**
     * Hanyar API don wurin.
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * Bayanin bayanai na wurin.
     */
    dataset: Dataset;

    /**
     * Bayanin wurin.
     */
    place: DatasetPlace;

    /**
     * Hanyar API ta wannan wuri.
     */
    thisPlaceApiLink: string;
}

interface DatasetPlace {
    /**
     * ID na wurin.
     */
    id: string;

    /**
     * Sunan wurin.
     */
    name: string;

    /**
     * Sunan wurin kamar yadda ya bayyana a cikin King James Version da kuma Turanci Standard Version.
     */
    kjvName?: string;
    esvName?: string;

    /**
     * Wasu sunaye da ake kiran wurin da su.
     */
    aliases?: string[];

    /**
     * Nau'in yanayin ƙasa da wurin yake.
     */
    featureType?: string;
    featureSubType?: string;

    /**
     * Tsarin latitude da tsawon wurin, da kuma yadda suke daidai.
     */
    latitude?: number;
    longitude?: number;
    precision?: string;

    /**
     * Bayanin wurin. Kowace layi sakin layi ne.
     */
    description?: string[];

    /**
     * Sharhin da aka yi kan wurin daga marubutan bayanai.
     */
    comment?: string;

    /**
     * Asalin wurin wannan wuri.
     * Sunaye daban-daban na wurin ƙasa ɗaya suna da tushe iri ɗaya.
     */
    rootPlace?: DatasetEntityRef;

    /**
     * Wurin da wannan wuri ya kasance iri ɗaya ne.
     */
    duplicateOf?: DatasetEntityRef;

    /**
     * Mutanen da suka kasance a wurin, an haife su a wurin, ko kuma sun mutu a wurin.
     */
    people?: DatasetEntityRef[];
    peopleBorn?: DatasetEntityRef[];
    peopleDied?: DatasetEntityRef[];

    /**
     * Abubuwan da suka faru a wurin.
     */
    events?: DatasetEntityRef[];

    /**
     * Jerin nassoshin Littafi Mai Tsarki da suka ambaci wurin.
     * An tsara shi ta hanyar tsari na littafi, babi, da aya.
     */
    references: VerseRef[];
}

export interface DatasetEvents {
    /**
     * Bayanin bayanai don abubuwan da suka faru.
     */
    dataset: Dataset;

    /**
     * Jerin abubuwan da suka faru da ake da su don tattara bayanai.
     */
    events: DatasetEventSummary[];
}

interface DatasetEventSummary {
    /**
     * ID na taron.
     */
    id: string;

    /**
     * Sunan taron.
     */
    name: string;

    /**
     * Ranar da taron ya fara a.
     * Lambobin da ba su da kyau sune shekaru BC. Lambobin da ba su da kyau sune shekaru AD.
     * Wasu takamaiman ranaku suna amfani da tsarin `YYYY-MM-DD` .
     */
    startDate?: string;

    /**
     * Adadin nassoshi na Littafi Mai Tsarki da suka bayyana abin da ya faru.
     */
    numberOfReferences: number;

    /**
     * Haɗin API don taron.
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * Bayanin bayanai don taron.
     */
    dataset: Dataset;

    /**
     * Bayanin da ya shafi taron.
     */
    event: DatasetEvent;

    /**
     * Haɗin API na wannan taron.
     */
    thisEventApiLink: string;
}

interface DatasetEvent {
    /**
     * ID na taron.
     */
    id: string;

    /**
     * Sunan taron.
     */
    name: string;

    /**
     * Ranar da taron ya fara a.
     */
    startDate?: string;

    /**
     * Tsawon lokacin taron.
     * Misali, "1D" rana ɗaya ce, kuma "40Y" shekara arba'in ce.
     */
    duration?: string;

    /**
     * Mutanen da suka halarci taron.
     */
    participants?: DatasetEntityRef[];

    /**
     * Wuraren da abin ya faru a wurin.
     */
    locations?: DatasetEntityRef[];

    /**
     * Ƙungiyoyin jama'a da suka halarci taron.
     */
    groups?: DatasetEntityRef[];

    /**
     * Taron da wannan taron ya kasance wani ɓangare nasa.
     */
    partOf?: DatasetEntityRef;

    /**
     * Abin da ya faru kafin wannan lamari.
     */
    predecessor?: DatasetEntityRef;

    /**
     * Jerin nassoshin Littafi Mai Tsarki da suka bayyana abin da ya faru.
     * An tsara shi ta hanyar tsari na littafi, babi, da aya.
     */
    references: VerseRef[];
}

export interface DatasetPeopleGroups {
    /**
     * Bayanin bayanai na ƙungiyoyin mutane.
     */
    dataset: Dataset;

    /**
     * Jerin ƙungiyoyin mutane da ake da su don tattara bayanai.
     */
    groups: DatasetPeopleGroupSummary[];
}

interface DatasetPeopleGroupSummary {
    /**
     * ID na ƙungiyar mutane.
     */
    id: string;

    /**
     * Sunan ƙungiyar mutane.
     */
    name: string;

    /**
     * Adadin mutanen da ke cikin ƙungiyar mutane.
     */
    numberOfMembers: number;

    /**
     * Haɗin API don rukunin mutane.
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * Bayanin bayanai na ƙungiyar mutane.
     */
    dataset: Dataset;

    /**
     * Cikakken bayani game da rukunin mutane.
     */
    group: DatasetPeopleGroup;

    /**
     * Haɗin API na wannan rukunin mutane.
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * ID na ƙungiyar mutane.
     */
    id: string;

    /**
     * Sunan ƙungiyar mutane.
     */
    name: string;

    /**
     * Mutane da ke cikin ƙungiyar mutane.
     */
    members?: DatasetEntityRef[];

    /**
     * Abubuwan da ƙungiyar mutane ta shiga ciki.
     */
    events?: DatasetEntityRef[];

    /**
     * Jerin nassoshin Littafi Mai Tsarki da suka ambaci ƙungiyar mutane.
     * An tsara shi ta hanyar tsari na littafi, babi, da aya.
     */
    references: VerseRef[];
}