डेटासेट

export interface AvailableDatasets {
    /**
     * डेटासेट की सूची।
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * डेटासेट की आईडी।
     */
    id: string;

    /**
     * डेटासेट का नाम।
     */
    name: string;

    /**
     * डेटासेट की वेबसाइट।
     */
    website: string;

    /**
     * वह यूआरएल जहां डेटासेट के लाइसेंस का पता लगाया जा सकता है।
     */
    licenseUrl: string;

    /**
     * डेटासेट का अंग्रेजी नाम।
     */
    englishName: string;

    /**
     * डेटासेट मुख्य रूप से ISO 639 3-अक्षर भाषा टैग में है।
     */
    language: string;

    /**
     * जिस दिशा में भाषा लिखी जाती है।
     * "ltr" का अर्थ है कि पाठ पृष्ठ के बाईं ओर से दाईं ओर लिखा गया है।
     * "rtl" का अर्थ है कि पाठ पृष्ठ के दाहिने भाग से बाएं भाग की ओर लिखा गया है।
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * इस डेटासेट के लिए उपलब्ध पुस्तकों की सूची का एपीआई लिंक।
     */
    listOfBooksApiLink: string;

    /**
     * उपलब्ध प्रारूपों की सूची।
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * इस डेटासेट में शामिल पुस्तकों की संख्या।
     */
    numberOfBooks: number;

    /**
     * इस डेटासेट में शामिल अध्यायों की कुल संख्या।
     */
    totalNumberOfChapters: number;

    /**
     * इस डेटासेट में शामिल छंदों की कुल संख्या।
     */
    totalNumberOfVerses: number;

    /**
     * इस डेटासेट में मौजूद क्रॉस रेफरेंस की कुल संख्या।
     */
    totalNumberOfReferences: number;

    /**
     * यह उस भाषा का नाम प्राप्त करता है जिसमें डेटासेट मौजूद है।
     * यदि भाषा का नाम ज्ञात नहीं है तो मान शून्य या अपरिभाषित होगा।
     */
    languageName?: string;

    /**
     * यह भाषा का नाम अंग्रेजी में प्राप्त करता है।
     * यदि भाषा का कोई अंग्रेजी नाम नहीं है तो मान शून्य या अपरिभाषित होगा।
     */
    languageEnglishName?: string;

    /**
     * डेटासेट में मौजूद संस्थाओं की सूचियों के लिए एपीआई लिंक।
     * यदि डेटासेट में संबंधित इकाइयाँ मौजूद नहीं हैं तो इसे छोड़ दिया जाएगा।
     */
    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;

    /**
     * अगले अध्याय का लिंक।
     * यदि यह डेटासेट का अंतिम अध्याय है तो मान शून्य होगा।
     */
    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/d/{dataset}/{type}/{id}.json` के रूप में निर्मित किया जा सकता है।
     */
    type: 'people' | 'places' | 'events' | 'groups';

    /**
     * जिस संस्था का संदर्भ दिया जा रहा है, उसका नाम।
     */
    name?: string;

    /**
     * संदर्भित इकाई के लिए एपीआई लिंक।
     */
    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;

    /**
     * अगले अध्याय का लिंक।
     * यदि यह डेटासेट का अंतिम अध्याय है तो मान शून्य होगा।
     */
    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;

    /**
     * उस व्यक्ति के लिए एपीआई लिंक।
     */
    apiLink: string;

    /**
     * अध्याय में उन श्लोकों की संख्या जिनमें उस व्यक्ति का उल्लेख है।
     * आरोही क्रम में व्यवस्थित।
     */
    verses: number[];
}

interface ChapterPlace {
    /**
     * उस स्थान की आईडी।
     */
    id: string;

    /**
     * उस स्थान का नाम।
     */
    name: string;

    /**
     * वह स्थान किस प्रकार की भौगोलिक विशेषता का है।
     */
    featureType?: string;

    /**
     * उस स्थान का अक्षांश और देशांतर।
     */
    latitude?: number;
    longitude?: number;

    /**
     * उस स्थान का एपीआई लिंक।
     */
    apiLink: string;

    /**
     * अध्याय में उन श्लोकों की संख्या जिनमें उस स्थान का उल्लेख है।
     * आरोही क्रम में व्यवस्थित।
     */
    verses: number[];
}

interface ChapterEvent {
    /**
     * इवेंट की आईडी।
     */
    id: string;

    /**
     * आयोजन का नाम।
     */
    name: string;

    /**
     * जिस तारीख को यह कार्यक्रम शुरू हुआ था।
     */
    startDate?: string;

    /**
     * इवेंट का एपीआई लिंक।
     */
    apiLink: string;

    /**
     * अध्याय में घटना का वर्णन करने वाले श्लोकों की संख्या।
     * आरोही क्रम में व्यवस्थित।
     */
    verses: number[];
}

export interface DatasetPeople {
    /**
     * लोगों के लिए डेटासेट की जानकारी।
     */
    dataset: Dataset;

    /**
     * डेटासेट के लिए उपलब्ध लोगों की सूची।
     */
    people: DatasetPersonSummary[];
}

interface DatasetPersonSummary {
    /**
     * उस व्यक्ति की पहचान।
     */
    id: string;

    /**
     * उस व्यक्ति का नाम।
     */
    name: string;

    /**
     * क्या उस व्यक्ति का नाम उचित नाम है?
     */
    isProperName?: boolean;

    /**
     * व्यक्ति का लिंग।
     */
    gender?: string;

    /**
     * बाइबल में उस व्यक्ति का उल्लेख करने वाले संदर्भों की संख्या।
     */
    numberOfReferences: number;

    /**
     * उस व्यक्ति के लिए एपीआई लिंक।
     */
    thisPersonApiLink: string;
}

export interface DatasetPersonResponse {
    /**
     * उस व्यक्ति से संबंधित डेटासेट की जानकारी।
     */
    dataset: Dataset;

    /**
     * उस व्यक्ति के बारे में जानकारी।
     */
    person: DatasetPerson;

    /**
     * इस व्यक्ति का एपीआई लिंक।
     */
    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;

    /**
     * उस स्थान का एपीआई लिंक।
     */
    thisPlaceApiLink: string;
}

export interface DatasetPlaceResponse {
    /**
     * उस स्थान से संबंधित डेटासेट की जानकारी।
     */
    dataset: Dataset;

    /**
     * उस स्थान के बारे में जानकारी।
     */
    place: DatasetPlace;

    /**
     * इस स्थान का एपीआई लिंक।
     */
    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;

    /**
     * इवेंट का एपीआई लिंक।
     */
    thisEventApiLink: string;
}

export interface DatasetEventResponse {
    /**
     * इस घटना से संबंधित डेटासेट की जानकारी।
     */
    dataset: Dataset;

    /**
     * इस आयोजन से संबंधित जानकारी।
     */
    event: DatasetEvent;

    /**
     * इस इवेंट का एपीआई लिंक।
     */
    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;

    /**
     * लोगों के समूह के लिए एपीआई लिंक।
     */
    thisPeopleGroupApiLink: string;
}

export interface DatasetPeopleGroupResponse {
    /**
     * लोगों के समूह के लिए डेटासेट की जानकारी।
     */
    dataset: Dataset;

    /**
     * उस जनसमूह के बारे में जानकारी।
     */
    group: DatasetPeopleGroup;

    /**
     * इस समूह के लिए एपीआई लिंक।
     */
    thisPeopleGroupApiLink: string;
}

interface DatasetPeopleGroup {
    /**
     * लोगों के समूह की आईडी।
     */
    id: string;

    /**
     * उस जनसमूह का नाम।
     */
    name: string;

    /**
     * वे लोग जो उस जनसमूह के सदस्य हैं।
     */
    members?: DatasetEntityRef[];

    /**
     * वे आयोजन जिनमें उस जनसमूह ने भाग लिया था।
     */
    events?: DatasetEntityRef[];

    /**
     * बाइबल में इस जनसमूह का उल्लेख करने वाले संदर्भों की सूची।
     * पुस्तक क्रम, अध्याय और श्लोक के अनुसार क्रमबद्ध।
     */
    references: VerseRef[];
}