free-use-bible-api 0.1.2 → 0.2.0

package/dist/types/models/ApiDatasetBook.d.ts

@@ -1,82 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { BookId } from './BookId';
-/**
- * Defines a schema that contains information about a book in a dataset.
- * @export
- * @interface ApiDatasetBook
- */
-export interface ApiDatasetBook {
-    /**
-     *
-     * @type {BookId}
-     * @memberof ApiDatasetBook
-     */
-    id: BookId;
-    /**
-     * The order of the book in the Bible.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    order: number;
-    /**
-     * The number of the first chapter in the book.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    firstChapterNumber: number;
-    /**
-     * The link to the first chapter of the book.
-     * @type {string}
-     * @memberof ApiDatasetBook
-     */
-    firstChapterApiLink: string;
-    /**
-     * The number of the last chapter in the book.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    lastChapterNumber: number;
-    /**
-     * The link to the last chapter of the book.
-     * @type {string}
-     * @memberof ApiDatasetBook
-     */
-    lastChapterApiLink: string;
-    /**
-     * The number of chapters that the book contains.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    numberOfChapters: number;
-    /**
-     * The number of verses that the book contains.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    totalNumberOfVerses: number;
-    /**
-     * The number of references that the book contains.
-     * @type {number}
-     * @memberof ApiDatasetBook
-     */
-    totalNumberOfReferences: number;
-}
-/**
- * Check if a given object implements the ApiDatasetBook interface.
- */
-export declare function instanceOfApiDatasetBook(value: object): value is ApiDatasetBook;
-export declare function ApiDatasetBookFromJSON(json: any): ApiDatasetBook;
-export declare function ApiDatasetBookFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBook;
-export declare function ApiDatasetBookToJSON(json: any): ApiDatasetBook;
-export declare function ApiDatasetBookToJSONTyped(value?: ApiDatasetBook | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiDatasetBook.d.ts.map

package/dist/types/models/ApiDatasetBookChapter.d.ts

@@ -1,78 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ApiDataset } from './ApiDataset';
-import type { ApiDatasetBook } from './ApiDatasetBook';
-import type { DatasetChapterData } from './DatasetChapterData';
-/**
- * Defines a schema that contains information about a book chapter in a dataset.
- * @export
- * @interface ApiDatasetBookChapter
- */
-export interface ApiDatasetBookChapter {
-    /**
-     * The data for the chapter.
-     * @type {DatasetChapterData}
-     * @memberof ApiDatasetBookChapter
-     */
-    chapter: DatasetChapterData;
-    /**
-     * The dataset information for the book chapter.
-     * @type {ApiDataset}
-     * @memberof ApiDatasetBookChapter
-     */
-    dataset: ApiDataset;
-    /**
-     * The book information for the book chapter.
-     * @type {ApiDatasetBook}
-     * @memberof ApiDatasetBookChapter
-     */
-    book: ApiDatasetBook;
-    /**
-     * The API link for this chapter. Relative to the API origin.
-     * @type {string}
-     * @memberof ApiDatasetBookChapter
-     */
-    thisChapterLink: string;
-    /**
-     * The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset.
-     * @type {string}
-     * @memberof ApiDatasetBookChapter
-     */
-    nextChapterApiLink: string | null;
-    /**
-     * The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset.
-     * @type {string}
-     * @memberof ApiDatasetBookChapter
-     */
-    previousChapterApiLink: string | null;
-    /**
-     * The number of verses that the chapter contains.
-     * @type {number}
-     * @memberof ApiDatasetBookChapter
-     */
-    numberOfVerses: number;
-    /**
-     * The number of references that the chapter contains.
-     * @type {number}
-     * @memberof ApiDatasetBookChapter
-     */
-    numberOfReferences: number;
-}
-/**
- * Check if a given object implements the ApiDatasetBookChapter interface.
- */
-export declare function instanceOfApiDatasetBookChapter(value: object): value is ApiDatasetBookChapter;
-export declare function ApiDatasetBookChapterFromJSON(json: any): ApiDatasetBookChapter;
-export declare function ApiDatasetBookChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBookChapter;
-export declare function ApiDatasetBookChapterToJSON(json: any): ApiDatasetBookChapter;
-export declare function ApiDatasetBookChapterToJSONTyped(value?: ApiDatasetBookChapter | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiDatasetBookChapter.d.ts.map

package/dist/types/models/ApiDatasetBooks.d.ts

@@ -1,41 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ApiDataset } from './ApiDataset';
-import type { ApiDatasetBook } from './ApiDatasetBook';
-/**
- * Defines an interface that contains information about the books that are available for a dataset.
- * @export
- * @interface ApiDatasetBooks
- */
-export interface ApiDatasetBooks {
-    /**
-     * The dataset information for the books.
-     * @type {ApiDataset}
-     * @memberof ApiDatasetBooks
-     */
-    dataset: ApiDataset;
-    /**
-     * The list of books that are available for the dataset.
-     * @type {Array<ApiDatasetBook>}
-     * @memberof ApiDatasetBooks
-     */
-    books: Array<ApiDatasetBook>;
-}
-/**
- * Check if a given object implements the ApiDatasetBooks interface.
- */
-export declare function instanceOfApiDatasetBooks(value: object): value is ApiDatasetBooks;
-export declare function ApiDatasetBooksFromJSON(json: any): ApiDatasetBooks;
-export declare function ApiDatasetBooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBooks;
-export declare function ApiDatasetBooksToJSON(json: any): ApiDatasetBooks;
-export declare function ApiDatasetBooksToJSONTyped(value?: ApiDatasetBooks | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiDatasetBooks.d.ts.map

package/dist/types/models/ApiTranslation.d.ts

@@ -1,169 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Defines a translation that is used in the API.
- * @export
- * @interface ApiTranslation
- */
-export interface ApiTranslation {
-    /**
-     * The ID of the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    id: string;
-    /**
-     * The name of the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    name: string;
-    /**
-     * The website for the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    website: string;
-    /**
-     * The URL that the license for the translation can be found.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    licenseUrl: string;
-    /**
-     * The API-added notes for the license.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    licenseNotes?: string | null;
-    /**
-     * The notice that should be displayed when displaying content from the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    licenseNotice?: string | null;
-    /**
-     * The short name for the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    shortName?: string;
-    /**
-     * The English name for the translation.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    englishName: string;
-    /**
-     * The ISO 639 3-letter language tag that the translation is primarily in.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    language: string;
-    /**
-     * The direction that the language is written in. `ltr` indicates that the text is written from the left side of the page to the right. `rtl` indicates that the text is written from the right side of the page to the left.
-     * @type {ApiTranslationTextDirectionEnum}
-     * @memberof ApiTranslation
-     */
-    textDirection: ApiTranslationTextDirectionEnum;
-    /**
-     * The API link for the list of books for this translation. Relative to the API origin.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    listOfBooksApiLink: string;
-    /**
-     *
-     * @type {Array<ApiTranslationAvailableFormatsEnum>}
-     * @memberof ApiTranslation
-     */
-    availableFormats: Array<ApiTranslationAvailableFormatsEnum>;
-    /**
-     * The number of books that are contained in this translation. Complete translations should have the same number of books as the Bible (66).
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    numberOfBooks: number;
-    /**
-     * The total number of chapters that are contained in this translation. Complete translations should have the same number of chapters as the Bible (1,189).
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    totalNumberOfChapters: number;
-    /**
-     * The total number of verses that are contained in this translation. Complete translations should have the same number of verses as the Bible (around 31,102 - some translations exclude verses based on the aparent likelyhood of existing in the original source texts).
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    totalNumberOfVerses: number;
-    /**
-     * The total number of apocryphal books that are contained in this translation.
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    numberOfApocryphalBooks?: number;
-    /**
-     * The total number of apocryphal chapters that are contained in this translation.
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    totalNumberOfApocryphalChapters?: number;
-    /**
-     * The total number of apocryphal verses that are contained in this translation.
-     * @type {number}
-     * @memberof ApiTranslation
-     */
-    totalNumberOfApocryphalVerses?: number;
-    /**
-     * Gets the name of the language that the translation is in. Null or undefined if the name of the language is not known.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    languageName?: string;
-    /**
-     * Gets the name of the language in English. Null or undefined if the language doesn't have an english name.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    languageEnglishName?: string;
-    /**
-     * The API link for downloading the complete translation as a single JSON file. Relative to the API origin. Undefined if complete translation files are not available.
-     * @type {string}
-     * @memberof ApiTranslation
-     */
-    completeTranslationApiLink?: string;
-}
-/**
- * @export
- */
-export declare const ApiTranslationTextDirectionEnum: {
-    readonly Ltr: "ltr";
-    readonly Rtl: "rtl";
-};
-export type ApiTranslationTextDirectionEnum = typeof ApiTranslationTextDirectionEnum[keyof typeof ApiTranslationTextDirectionEnum];
-/**
- * @export
- */
-export declare const ApiTranslationAvailableFormatsEnum: {
-    readonly Json: "json";
-    readonly Usfm: "usfm";
-};
-export type ApiTranslationAvailableFormatsEnum = typeof ApiTranslationAvailableFormatsEnum[keyof typeof ApiTranslationAvailableFormatsEnum];
-/**
- * Check if a given object implements the ApiTranslation interface.
- */
-export declare function instanceOfApiTranslation(value: object): value is ApiTranslation;
-export declare function ApiTranslationFromJSON(json: any): ApiTranslation;
-export declare function ApiTranslationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslation;
-export declare function ApiTranslationToJSON(json: any): ApiTranslation;
-export declare function ApiTranslationToJSONTyped(value?: ApiTranslation | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiTranslation.d.ts.map

package/dist/types/models/ApiTranslationBook.d.ts

@@ -1,100 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { BookId } from './BookId';
-/**
- * Defines a schema that contains information about a translation book.
- * @export
- * @interface ApiTranslationBook
- */
-export interface ApiTranslationBook {
-    /**
-     *
-     * @type {BookId}
-     * @memberof ApiTranslationBook
-     */
-    id: BookId;
-    /**
-     * The name that the translation provided for the book.
-     * @type {string}
-     * @memberof ApiTranslationBook
-     */
-    name: string;
-    /**
-     * The common name for the book.
-     * @type {string}
-     * @memberof ApiTranslationBook
-     */
-    commonName: string;
-    /**
-     * The title of the book. This is usually a more descriptive version of the book name. If not available, then one was not provided by the translation.
-     * @type {string}
-     * @memberof ApiTranslationBook
-     */
-    title: string | null;
-    /**
-     * The numerical order of the book in the translation.
-     * @type {number}
-     * @memberof ApiTranslationBook
-     */
-    order: number;
-    /**
-     * Whether the book is an apocryphal book.
-     * @type {boolean}
-     * @memberof ApiTranslationBook
-     */
-    isApocryphal?: boolean;
-    /**
-     * The number of the first chapter in the book.
-     * @type {number}
-     * @memberof ApiTranslationBook
-     */
-    firstChapterNumber: number;
-    /**
-     * The link to the first chapter of the book.
-     * @type {string}
-     * @memberof ApiTranslationBook
-     */
-    firstChapterApiLink: string;
-    /**
-     * The number of the last chapter in the book.
-     * @type {number}
-     * @memberof ApiTranslationBook
-     */
-    lastChapterNumber: number;
-    /**
-     * The link to the last chapter of the book.
-     * @type {string}
-     * @memberof ApiTranslationBook
-     */
-    lastChapterApiLink: string;
-    /**
-     * The number of chapters that the book contains.
-     * @type {number}
-     * @memberof ApiTranslationBook
-     */
-    numberOfChapters: number;
-    /**
-     * The number of verses that the book contains.
-     * @type {number}
-     * @memberof ApiTranslationBook
-     */
-    totalNumberOfVerses: number;
-}
-/**
- * Check if a given object implements the ApiTranslationBook interface.
- */
-export declare function instanceOfApiTranslationBook(value: object): value is ApiTranslationBook;
-export declare function ApiTranslationBookFromJSON(json: any): ApiTranslationBook;
-export declare function ApiTranslationBookFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBook;
-export declare function ApiTranslationBookToJSON(json: any): ApiTranslationBook;
-export declare function ApiTranslationBookToJSONTyped(value?: ApiTranslationBook | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiTranslationBook.d.ts.map

package/dist/types/models/ApiTranslationBookChapter.d.ts

@@ -1,96 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ApiTranslationBook } from './ApiTranslationBook';
-import type { ApiTranslation } from './ApiTranslation';
-import type { ApiTranslationBookChapterChapter } from './ApiTranslationBookChapterChapter';
-/**
- * Defines an interface that contains information about a book chapter in a translation.
- * @export
- * @interface ApiTranslationBookChapter
- */
-export interface ApiTranslationBookChapter {
-    /**
-     *
-     * @type {ApiTranslationBookChapterChapter}
-     * @memberof ApiTranslationBookChapter
-     */
-    chapter: ApiTranslationBookChapterChapter;
-    /**
-     * The links to different audio versions for the chapter.
-     * @type {{ [key: string]: string; }}
-     * @memberof ApiTranslationBookChapter
-     */
-    thisChapterAudioLinks: {
-        [key: string]: string;
-    };
-    /**
-     * The translation information for the book chapter.
-     * @type {ApiTranslation}
-     * @memberof ApiTranslationBookChapter
-     */
-    translation: ApiTranslation;
-    /**
-     * The book information for the book chapter.
-     * @type {ApiTranslationBook}
-     * @memberof ApiTranslationBookChapter
-     */
-    book: ApiTranslationBook;
-    /**
-     * The API link for this chapter. Relative to the API origin.
-     * @type {string}
-     * @memberof ApiTranslationBookChapter
-     */
-    thisChapterLink: string;
-    /**
-     * The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
-     * @type {string}
-     * @memberof ApiTranslationBookChapter
-     */
-    nextChapterApiLink: string | null;
-    /**
-     * The links to the audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
-     * @type {{ [key: string]: string; }}
-     * @memberof ApiTranslationBookChapter
-     */
-    nextChapterAudioLinks: {
-        [key: string]: string;
-    } | null;
-    /**
-     * The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
-     * @type {string}
-     * @memberof ApiTranslationBookChapter
-     */
-    previousChapterApiLink: string | null;
-    /**
-     * The links to the audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
-     * @type {{ [key: string]: string; }}
-     * @memberof ApiTranslationBookChapter
-     */
-    previousChapterAudioLinks: {
-        [key: string]: string;
-    } | null;
-    /**
-     * The number of verses that the chapter contains.
-     * @type {number}
-     * @memberof ApiTranslationBookChapter
-     */
-    numberOfVerses: number;
-}
-/**
- * Check if a given object implements the ApiTranslationBookChapter interface.
- */
-export declare function instanceOfApiTranslationBookChapter(value: object): value is ApiTranslationBookChapter;
-export declare function ApiTranslationBookChapterFromJSON(json: any): ApiTranslationBookChapter;
-export declare function ApiTranslationBookChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBookChapter;
-export declare function ApiTranslationBookChapterToJSON(json: any): ApiTranslationBookChapter;
-export declare function ApiTranslationBookChapterToJSONTyped(value?: ApiTranslationBookChapter | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiTranslationBookChapter.d.ts.map

package/dist/types/models/ApiTranslationBookChapterChapter.d.ts

@@ -1,47 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ChapterFootnote } from './ChapterFootnote';
-import type { ChapterContent } from './ChapterContent';
-/**
- * The information for the chapter.
- * @export
- * @interface ApiTranslationBookChapterChapter
- */
-export interface ApiTranslationBookChapterChapter {
-    /**
-     * The number of the chapter.
-     * @type {number}
-     * @memberof ApiTranslationBookChapterChapter
-     */
-    number: number;
-    /**
-     * The content of the chapter.
-     * @type {Array<ChapterContent>}
-     * @memberof ApiTranslationBookChapterChapter
-     */
-    content: Array<ChapterContent>;
-    /**
-     * The list of footnotes for the chapter.
-     * @type {Array<ChapterFootnote>}
-     * @memberof ApiTranslationBookChapterChapter
-     */
-    footnotes: Array<ChapterFootnote>;
-}
-/**
- * Check if a given object implements the ApiTranslationBookChapterChapter interface.
- */
-export declare function instanceOfApiTranslationBookChapterChapter(value: object): value is ApiTranslationBookChapterChapter;
-export declare function ApiTranslationBookChapterChapterFromJSON(json: any): ApiTranslationBookChapterChapter;
-export declare function ApiTranslationBookChapterChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBookChapterChapter;
-export declare function ApiTranslationBookChapterChapterToJSON(json: any): ApiTranslationBookChapterChapter;
-export declare function ApiTranslationBookChapterChapterToJSONTyped(value?: ApiTranslationBookChapterChapter | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiTranslationBookChapterChapter.d.ts.map

package/dist/types/models/ApiTranslationBooks.d.ts

@@ -1,41 +0,0 @@
-/**
- * Free Use Bible API
- * An API for accessing over 1000 different Bible translations.
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: hello@helloao.org
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { ApiTranslationBook } from './ApiTranslationBook';
-import type { ApiTranslation } from './ApiTranslation';
-/**
- * Defines an interface that contains information about the books that are available for a translation.
- * @export
- * @interface ApiTranslationBooks
- */
-export interface ApiTranslationBooks {
-    /**
-     * The translation information for the books.
-     * @type {ApiTranslation}
-     * @memberof ApiTranslationBooks
-     */
-    translation: ApiTranslation;
-    /**
-     * The list of books that are available for the translation.
-     * @type {Array<ApiTranslationBook>}
-     * @memberof ApiTranslationBooks
-     */
-    books: Array<ApiTranslationBook>;
-}
-/**
- * Check if a given object implements the ApiTranslationBooks interface.
- */
-export declare function instanceOfApiTranslationBooks(value: object): value is ApiTranslationBooks;
-export declare function ApiTranslationBooksFromJSON(json: any): ApiTranslationBooks;
-export declare function ApiTranslationBooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBooks;
-export declare function ApiTranslationBooksToJSON(json: any): ApiTranslationBooks;
-export declare function ApiTranslationBooksToJSONTyped(value?: ApiTranslationBooks | null, ignoreDiscriminator?: boolean): any;
-//# sourceMappingURL=ApiTranslationBooks.d.ts.map