ڈیٹاسیٹس

export interface AvailableDatasets {
    /**
     * ڈیٹا سیٹس کی فہرست۔
     */
    datasets: Dataset[];
}

export interface Dataset {
    /**
     * ڈیٹا سیٹ کی ID۔
     */
    id: string;

    /**
     * ڈیٹا سیٹ کا نام۔
     */
    name: string;

    /**
     * ڈیٹا سیٹ کے لیے ویب سائٹ۔
     */
    website: string;

    /**
     * وہ URL جو ڈیٹاسیٹ کا لائسنس پایا جا سکتا ہے۔
     */
    licenseUrl: string;

    /**
     * ڈیٹاسیٹ کا انگریزی نام۔
     */
    englishName: string;

    /**
     * ISO 639 3 حرفی زبان کا ٹیگ جس میں ڈیٹاسیٹ بنیادی طور پر ہے۔
     */
    language: string;

    /**
     * زبان جس سمت میں لکھی جاتی ہے۔
     * "ltr" اشارہ کرتا ہے کہ متن صفحہ کے بائیں جانب سے دائیں طرف لکھا گیا ہے۔
     * "rtl" اشارہ کرتا ہے کہ متن صفحہ کے دائیں جانب سے بائیں طرف لکھا گیا ہے۔
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * اس ڈیٹاسیٹ کے لیے دستیاب کتابوں کی فہرست کا API لنک۔
     */
    listOfBooksApiLink: string;

    /**
     * فارمیٹس کی دستیاب فہرست۔
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * اس ڈیٹاسیٹ میں موجود کتابوں کی تعداد۔
     */
    numberOfBooks: number;

    /**
     * اس ڈیٹاسیٹ میں موجود ابواب کی کل تعداد۔
     */
    totalNumberOfChapters: number;

    /**
     * اس ڈیٹاسیٹ میں موجود آیات کی کل تعداد۔
     */
    totalNumberOfVerses: number;

    /**
     * کراس حوالہ جات کی کل تعداد جو اس ڈیٹاسیٹ میں موجود ہیں۔
     */
    totalNumberOfReferences: number;

    /**
     * اس زبان کا نام حاصل کرتا ہے جس میں ڈیٹاسیٹ ہے۔
     * اگر زبان کا نام معلوم نہ ہو تو کالعدم یا غیر متعینہ۔
     */
    languageName?: string;

    /**
     * انگریزی میں زبان کا نام حاصل کرتا ہے۔
     * اگر زبان کا انگریزی نام نہ ہو تو کالعدم یا غیر متعینہ۔
     */
    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 سے میل کھاتا ہے (GEN، EXO، وغیرہ)۔
     */
    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 {
    /**
     * جس کتاب کا حوالہ دیا جا رہا ہے اس کی ID۔
     */
    book: string;

    /**
     * باب نمبر۔
     */
    chapter: number;

    /**
     * آیت نمبر۔
     * اگر `endVerse` موجود ہے تو یہ وہ آیت ہے جس سے حوالہ شروع ہوتا ہے۔
     */
    verse: number;

    /**
     * وہ آیت جس پر حوالہ ختم ہوتا ہے۔
     */
    endVerse?: number;

    /**
     * حوالہ کے لیے متعلقہ سکور۔
     */
    score?: number;
}

export interface DatasetEntityRef {
    /**
     * اس ہستی کی ID جس کا حوالہ دیا جا رہا ہے۔
     */
    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;

    /**
     * اگلے باب کا لنک۔
     * اگر یہ ڈیٹاسیٹ کا آخری باب ہے تو کالعدم۔
     */
    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;

    /**
     * جس سال وہ شخص پیدا ہوا اور جس سال وہ فوت ہوا۔
     * منفی نمبر سال BC ہیں۔ مثبت اعداد سال AD ہیں۔
     */
    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[];

    /**
     * جس سال وہ شخص پیدا ہوا اور جس سال وہ فوت ہوا۔
     * منفی نمبر سال BC ہیں۔ مثبت اعداد سال AD ہیں۔
     */
    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;

    /**
     * جس تاریخ کو ایونٹ شروع ہوا۔
     * منفی نمبر سال BC ہیں۔ مثبت اعداد سال AD ہیں۔
     * مزید مخصوص تاریخیں `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[];
}