Vertalings, Boeke en Hoofstukke

export interface AvailableTranslations {
    /**
     * Die lys van vertalings.
     */
    translations: Translation[];
}

interface Translation {
    /**
     * Die ID van die vertaling.
     */
    id: string;

    /**
     * Die naam van die vertaling.
     * Dit is gewoonlik die naam van die vertaling in die vertaling se taal.
     */
    name: string;

    /**
     * Die Engelse naam van die vertaling.
     */
    englishName: string;

    /**
     * Die webwerf vir die vertaling.
     */
    website: string;

    /**
     * Die URL waar die lisensie vir die vertaling gevind kan word.
     */
    licenseUrl: string;

    /**
     * Die kort naam vir die vertaling.
     */
    shortName: string;

    /**
     * Die ISO 639 3-letter taaletiket waarin die vertaling hoofsaaklik is.
     */
    language: string;

    /**
     * Kry die naam van die taal waarin die vertaling is.
     * Nul of ongedefinieerd indien die naam van die taal nie bekend is nie.
     */
    languageName?: string;

    /**
     * Kry die naam van die taal in Engels.
     * Nul of ongedefinieerd as die taal nie 'n Engelse naam het nie.
     */
    languageEnglishName?: string;

    /**
     * Die rigting waarin die taal geskryf is.
     * "ltr" dui aan dat die teks van die linkerkant van die bladsy na regs geskryf is.
     * "rtl" dui aan dat die teks van die regterkant van die bladsy na links geskryf is.
     */
    textDirection: 'ltr' | 'rtl';

    /**
     * Die beskikbare lys van formate.
     */
    availableFormats: ('json' | 'usfm')[];

    /**
     * Die API-skakel vir die lys van beskikbare boeke vir hierdie vertaling.
     */
    listOfBooksApiLink: string;

    /**
     * Die aantal boeke wat in hierdie vertaling vervat is.
     *
     * Volledige vertalings behoort dieselfde aantal boeke as die Bybel te hê (66).
     */
    numberOfBooks: number;

    /**
     * Die totale aantal hoofstukke wat in hierdie vertaling vervat is.
     *
     * Volledige vertalings moet dieselfde aantal hoofstukke hê as die Bybel (1 189).
     */
    totalNumberOfChapters: number;

    /**
     * Die totale aantal verse wat in hierdie vertaling vervat is.
     *
     * Volledige vertalings behoort dieselfde aantal verse as die Bybel te hê (ongeveer 31 102 - sommige vertalings sluit verse uit gebaseer op die oënskynlike waarskynlikheid dat hulle in die oorspronklike brontekste bestaan).
     */
    totalNumberOfVerses: number;

    /**
     * Die totale aantal apokriewe boeke wat in hierdie vertaling vervat is.
     * Weglaat indien die vertaling nie apokriewe insluit nie.
     */
    numberOfApocryphalBooks?: number;

    /**
     * Die totale aantal apokriewe hoofstukke wat in hierdie vertaling vervat is.
     * Weglaat indien die vertaling nie apokriewe insluit nie.
     */
    totalNumberOfApocryphalChapters?: number;

    /**
     * die totale aantal apokriewe verse wat in hierdie vertaling vervat is.
     * Weglaat indien die vertaling nie apokriewe insluit nie.
     */
    totalNumberOfApocryphalVerses?: number;
}

export interface TranslationBooks {
    /**
     * Die vertaalinligting vir die boeke.
     */
    translation: Translation;

    /**
     * Die lys van boeke wat beskikbaar is vir vertaling.
     */
    books: TranslationBook[];
}

interface TranslationBook {
    /**
     * Die ID van die boek.
     */
    id: string;

    /**
     * Die naam wat die vertaling vir die boek verskaf het.
     */
    name: string;

    /**
     * Die algemene naam vir die boek.
     */
    commonName: string;

    /**
     * Die titel van die boek.
     * Dit is gewoonlik 'n meer beskrywende weergawe van die boeknaam.
     * Indien nie beskikbaar nie, dan is een nie deur die vertaling verskaf nie.
     */
    title: string | null;

    /**
     * Die numeriese volgorde van die boek in die vertaling.
     */
    order: number;

    /**
     * Die aantal hoofstukke wat die boek bevat.
     */
    numberOfChapters: number;

    /**
     * Die nommer van die eerste hoofstuk in die boek.
     */
    firstChapterNumber: number;

    /**
     * Die skakel na die eerste hoofstuk van die boek.
     */
    firstChapterApiLink: string;

    /**
     * Die nommer van die laaste hoofstuk in die boek.
     */
    lastChapterNumber: number;

    /**
     * Die skakel na die laaste hoofstuk van die boek.
     */
    lastChapterApiLink: string;

    /**
     * Die aantal verse wat die boek bevat.
     */
    totalNumberOfVerses: number;

    /**
     * Of die boek 'n apokriewe boek is.
     * Weglaat indien die vertaling kanoniek is.
     */
    isApocryphal?: boolean;
}