free-use-bible-api 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +139 -0
- package/dist/cjs/index.cjs +27 -0
- package/dist/esm/apis/DefaultApi.js +416 -0
- package/dist/esm/apis/DefaultApi.js.map +7 -0
- package/dist/esm/apis/FreeUseBibleApi.js +61 -0
- package/dist/esm/apis/FreeUseBibleApi.js.map +7 -0
- package/dist/esm/apis/index.js +4 -0
- package/dist/esm/apis/index.js.map +7 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/index.js.map +7 -0
- package/dist/esm/models/ApiAvailableCommentaries.js +32 -0
- package/dist/esm/models/ApiAvailableCommentaries.js.map +7 -0
- package/dist/esm/models/ApiAvailableDatasets.js +32 -0
- package/dist/esm/models/ApiAvailableDatasets.js.map +7 -0
- package/dist/esm/models/ApiAvailableTranslations.js +32 -0
- package/dist/esm/models/ApiAvailableTranslations.js.map +7 -0
- package/dist/esm/models/ApiCommentary.js +81 -0
- package/dist/esm/models/ApiCommentary.js.map +7 -0
- package/dist/esm/models/ApiCommentaryBook.js +63 -0
- package/dist/esm/models/ApiCommentaryBook.js.map +7 -0
- package/dist/esm/models/ApiCommentaryBookChapter.js +58 -0
- package/dist/esm/models/ApiCommentaryBookChapter.js.map +7 -0
- package/dist/esm/models/ApiCommentaryBookChapterChapter.js +37 -0
- package/dist/esm/models/ApiCommentaryBookChapterChapter.js.map +7 -0
- package/dist/esm/models/ApiCommentaryBooks.js +39 -0
- package/dist/esm/models/ApiCommentaryBooks.js.map +7 -0
- package/dist/esm/models/ApiDataset.js +77 -0
- package/dist/esm/models/ApiDataset.js.map +7 -0
- package/dist/esm/models/ApiDatasetBook.js +56 -0
- package/dist/esm/models/ApiDatasetBook.js.map +7 -0
- package/dist/esm/models/ApiDatasetBookChapter.js +61 -0
- package/dist/esm/models/ApiDatasetBookChapter.js.map +7 -0
- package/dist/esm/models/ApiDatasetBooks.js +39 -0
- package/dist/esm/models/ApiDatasetBooks.js.map +7 -0
- package/dist/esm/models/ApiTranslation.js +87 -0
- package/dist/esm/models/ApiTranslation.js.map +7 -0
- package/dist/esm/models/ApiTranslationBook.js +64 -0
- package/dist/esm/models/ApiTranslationBook.js.map +7 -0
- package/dist/esm/models/ApiTranslationBookChapter.js +67 -0
- package/dist/esm/models/ApiTranslationBookChapter.js.map +7 -0
- package/dist/esm/models/ApiTranslationBookChapterChapter.js +42 -0
- package/dist/esm/models/ApiTranslationBookChapterChapter.js.map +7 -0
- package/dist/esm/models/ApiTranslationBooks.js +39 -0
- package/dist/esm/models/ApiTranslationBooks.js.map +7 -0
- package/dist/esm/models/ApiTranslationComplete.js +39 -0
- package/dist/esm/models/ApiTranslationComplete.js.map +7 -0
- package/dist/esm/models/ApiTranslationCompleteBook.js +59 -0
- package/dist/esm/models/ApiTranslationCompleteBook.js.map +7 -0
- package/dist/esm/models/BookId.js +127 -0
- package/dist/esm/models/BookId.js.map +7 -0
- package/dist/esm/models/ChapterContent.js +58 -0
- package/dist/esm/models/ChapterContent.js.map +7 -0
- package/dist/esm/models/ChapterFootnote.js +44 -0
- package/dist/esm/models/ChapterFootnote.js.map +7 -0
- package/dist/esm/models/ChapterFootnoteCaller.js +17 -0
- package/dist/esm/models/ChapterFootnoteCaller.js.map +7 -0
- package/dist/esm/models/ChapterFootnoteReference.js +31 -0
- package/dist/esm/models/ChapterFootnoteReference.js.map +7 -0
- package/dist/esm/models/ChapterHeading.js +34 -0
- package/dist/esm/models/ChapterHeading.js.map +7 -0
- package/dist/esm/models/ChapterHebrewSubtitle.js +38 -0
- package/dist/esm/models/ChapterHebrewSubtitle.js.map +7 -0
- package/dist/esm/models/ChapterHebrewSubtitleContentInner.js +35 -0
- package/dist/esm/models/ChapterHebrewSubtitleContentInner.js.map +7 -0
- package/dist/esm/models/ChapterLineBreak.js +31 -0
- package/dist/esm/models/ChapterLineBreak.js.map +7 -0
- package/dist/esm/models/ChapterVerse.js +41 -0
- package/dist/esm/models/ChapterVerse.js.map +7 -0
- package/dist/esm/models/ChapterVerseContentInner.js +44 -0
- package/dist/esm/models/ChapterVerseContentInner.js.map +7 -0
- package/dist/esm/models/DatasetChapterData.js +35 -0
- package/dist/esm/models/DatasetChapterData.js.map +7 -0
- package/dist/esm/models/DatasetChapterVerseContent.js +35 -0
- package/dist/esm/models/DatasetChapterVerseContent.js.map +7 -0
- package/dist/esm/models/FormattedText.js +32 -0
- package/dist/esm/models/FormattedText.js.map +7 -0
- package/dist/esm/models/InlineHeading.js +28 -0
- package/dist/esm/models/InlineHeading.js.map +7 -0
- package/dist/esm/models/InlineLineBreak.js +31 -0
- package/dist/esm/models/InlineLineBreak.js.map +7 -0
- package/dist/esm/models/ScoredVerseRef.js +47 -0
- package/dist/esm/models/ScoredVerseRef.js.map +7 -0
- package/dist/esm/models/TranslationBookChapter.js +35 -0
- package/dist/esm/models/TranslationBookChapter.js.map +7 -0
- package/dist/esm/models/VerseFootnoteReference.js +28 -0
- package/dist/esm/models/VerseFootnoteReference.js.map +7 -0
- package/dist/esm/models/index.js +40 -0
- package/dist/esm/models/index.js.map +7 -0
- package/dist/esm/runtime.js +304 -0
- package/dist/esm/runtime.js.map +7 -0
- package/dist/types/apis/DefaultApi.d.ts +176 -0
- package/dist/types/apis/FreeUseBibleApi.d.ts +34 -0
- package/dist/types/apis/index.d.ts +3 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/models/ApiAvailableCommentaries.d.ts +34 -0
- package/dist/types/models/ApiAvailableDatasets.d.ts +34 -0
- package/dist/types/models/ApiAvailableTranslations.d.ts +34 -0
- package/dist/types/models/ApiCommentary.d.ts +145 -0
- package/dist/types/models/ApiCommentaryBook.d.ts +100 -0
- package/dist/types/models/ApiCommentaryBookChapter.d.ts +72 -0
- package/dist/types/models/ApiCommentaryBookChapterChapter.d.ts +46 -0
- package/dist/types/models/ApiCommentaryBooks.d.ts +41 -0
- package/dist/types/models/ApiDataset.d.ts +138 -0
- package/dist/types/models/ApiDatasetBook.d.ts +82 -0
- package/dist/types/models/ApiDatasetBookChapter.d.ts +78 -0
- package/dist/types/models/ApiDatasetBooks.d.ts +41 -0
- package/dist/types/models/ApiTranslation.d.ts +169 -0
- package/dist/types/models/ApiTranslationBook.d.ts +100 -0
- package/dist/types/models/ApiTranslationBookChapter.d.ts +96 -0
- package/dist/types/models/ApiTranslationBookChapterChapter.d.ts +47 -0
- package/dist/types/models/ApiTranslationBooks.d.ts +41 -0
- package/dist/types/models/ApiTranslationComplete.d.ts +41 -0
- package/dist/types/models/ApiTranslationCompleteBook.d.ts +83 -0
- package/dist/types/models/BookId.d.ts +125 -0
- package/dist/types/models/ChapterContent.d.ts +34 -0
- package/dist/types/models/ChapterFootnote.d.ts +53 -0
- package/dist/types/models/ChapterFootnoteCaller.d.ts +27 -0
- package/dist/types/models/ChapterFootnoteReference.d.ts +39 -0
- package/dist/types/models/ChapterHeading.d.ts +46 -0
- package/dist/types/models/ChapterHebrewSubtitle.d.ts +47 -0
- package/dist/types/models/ChapterHebrewSubtitleContentInner.d.ts +51 -0
- package/dist/types/models/ChapterLineBreak.d.ts +40 -0
- package/dist/types/models/ChapterVerse.d.ts +53 -0
- package/dist/types/models/ChapterVerseContentInner.d.ts +70 -0
- package/dist/types/models/DatasetChapterData.d.ts +40 -0
- package/dist/types/models/DatasetChapterVerseContent.d.ts +40 -0
- package/dist/types/models/FormattedText.d.ts +45 -0
- package/dist/types/models/InlineHeading.d.ts +33 -0
- package/dist/types/models/InlineLineBreak.d.ts +40 -0
- package/dist/types/models/ScoredVerseRef.d.ts +70 -0
- package/dist/types/models/TranslationBookChapter.d.ts +42 -0
- package/dist/types/models/VerseFootnoteReference.d.ts +33 -0
- package/dist/types/models/index.d.ts +39 -0
- package/dist/types/runtime.d.ts +185 -0
- package/package.json +31 -0
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ApiCommentary } from './ApiCommentary';
|
|
13
|
+
import type { ApiCommentaryBook } from './ApiCommentaryBook';
|
|
14
|
+
import type { ApiCommentaryBookChapterChapter } from './ApiCommentaryBookChapterChapter';
|
|
15
|
+
/**
|
|
16
|
+
* Defines a schema that contains information about a book chapter in a commentary.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface ApiCommentaryBookChapter
|
|
19
|
+
*/
|
|
20
|
+
export interface ApiCommentaryBookChapter {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {ApiCommentaryBookChapterChapter}
|
|
24
|
+
* @memberof ApiCommentaryBookChapter
|
|
25
|
+
*/
|
|
26
|
+
chapter: ApiCommentaryBookChapterChapter;
|
|
27
|
+
/**
|
|
28
|
+
* The commentary information for the book chapter.
|
|
29
|
+
* @type {ApiCommentary}
|
|
30
|
+
* @memberof ApiCommentaryBookChapter
|
|
31
|
+
*/
|
|
32
|
+
commentary: ApiCommentary;
|
|
33
|
+
/**
|
|
34
|
+
* The book information for the book chapter.
|
|
35
|
+
* @type {ApiCommentaryBook}
|
|
36
|
+
* @memberof ApiCommentaryBookChapter
|
|
37
|
+
*/
|
|
38
|
+
book: ApiCommentaryBook;
|
|
39
|
+
/**
|
|
40
|
+
* The API link for this chapter. Relative to the API origin.
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof ApiCommentaryBookChapter
|
|
43
|
+
*/
|
|
44
|
+
thisChapterLink: string;
|
|
45
|
+
/**
|
|
46
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the commentary.
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof ApiCommentaryBookChapter
|
|
49
|
+
*/
|
|
50
|
+
nextChapterApiLink: string | null;
|
|
51
|
+
/**
|
|
52
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the commentary.
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof ApiCommentaryBookChapter
|
|
55
|
+
*/
|
|
56
|
+
previousChapterApiLink: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* The number of verses that the chapter contains.
|
|
59
|
+
* @type {number}
|
|
60
|
+
* @memberof ApiCommentaryBookChapter
|
|
61
|
+
*/
|
|
62
|
+
numberOfVerses: number;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the ApiCommentaryBookChapter interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfApiCommentaryBookChapter(value: object): value is ApiCommentaryBookChapter;
|
|
68
|
+
export declare function ApiCommentaryBookChapterFromJSON(json: any): ApiCommentaryBookChapter;
|
|
69
|
+
export declare function ApiCommentaryBookChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiCommentaryBookChapter;
|
|
70
|
+
export declare function ApiCommentaryBookChapterToJSON(json: any): ApiCommentaryBookChapter;
|
|
71
|
+
export declare function ApiCommentaryBookChapterToJSONTyped(value?: ApiCommentaryBookChapter | null, ignoreDiscriminator?: boolean): any;
|
|
72
|
+
//# sourceMappingURL=ApiCommentaryBookChapter.d.ts.map
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ChapterVerse } from './ChapterVerse';
|
|
13
|
+
/**
|
|
14
|
+
* The information for the chapter.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ApiCommentaryBookChapterChapter
|
|
17
|
+
*/
|
|
18
|
+
export interface ApiCommentaryBookChapterChapter {
|
|
19
|
+
/**
|
|
20
|
+
* The number of the chapter.
|
|
21
|
+
* @type {number}
|
|
22
|
+
* @memberof ApiCommentaryBookChapterChapter
|
|
23
|
+
*/
|
|
24
|
+
number: number;
|
|
25
|
+
/**
|
|
26
|
+
* The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ApiCommentaryBookChapterChapter
|
|
29
|
+
*/
|
|
30
|
+
introduction?: string;
|
|
31
|
+
/**
|
|
32
|
+
* The content of the chapter.
|
|
33
|
+
* @type {Array<ChapterVerse>}
|
|
34
|
+
* @memberof ApiCommentaryBookChapterChapter
|
|
35
|
+
*/
|
|
36
|
+
content: Array<ChapterVerse>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the ApiCommentaryBookChapterChapter interface.
|
|
40
|
+
*/
|
|
41
|
+
export declare function instanceOfApiCommentaryBookChapterChapter(value: object): value is ApiCommentaryBookChapterChapter;
|
|
42
|
+
export declare function ApiCommentaryBookChapterChapterFromJSON(json: any): ApiCommentaryBookChapterChapter;
|
|
43
|
+
export declare function ApiCommentaryBookChapterChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiCommentaryBookChapterChapter;
|
|
44
|
+
export declare function ApiCommentaryBookChapterChapterToJSON(json: any): ApiCommentaryBookChapterChapter;
|
|
45
|
+
export declare function ApiCommentaryBookChapterChapterToJSONTyped(value?: ApiCommentaryBookChapterChapter | null, ignoreDiscriminator?: boolean): any;
|
|
46
|
+
//# sourceMappingURL=ApiCommentaryBookChapterChapter.d.ts.map
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ApiCommentary } from './ApiCommentary';
|
|
13
|
+
import type { ApiCommentaryBook } from './ApiCommentaryBook';
|
|
14
|
+
/**
|
|
15
|
+
* Defines an interface that contains information about the books that are available for a commentary.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ApiCommentaryBooks
|
|
18
|
+
*/
|
|
19
|
+
export interface ApiCommentaryBooks {
|
|
20
|
+
/**
|
|
21
|
+
* The commentary information for the books.
|
|
22
|
+
* @type {ApiCommentary}
|
|
23
|
+
* @memberof ApiCommentaryBooks
|
|
24
|
+
*/
|
|
25
|
+
commentary: ApiCommentary;
|
|
26
|
+
/**
|
|
27
|
+
* The list of books that are available for the commentary.
|
|
28
|
+
* @type {Array<ApiCommentaryBook>}
|
|
29
|
+
* @memberof ApiCommentaryBooks
|
|
30
|
+
*/
|
|
31
|
+
books: Array<ApiCommentaryBook>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the ApiCommentaryBooks interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfApiCommentaryBooks(value: object): value is ApiCommentaryBooks;
|
|
37
|
+
export declare function ApiCommentaryBooksFromJSON(json: any): ApiCommentaryBooks;
|
|
38
|
+
export declare function ApiCommentaryBooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiCommentaryBooks;
|
|
39
|
+
export declare function ApiCommentaryBooksToJSON(json: any): ApiCommentaryBooks;
|
|
40
|
+
export declare function ApiCommentaryBooksToJSONTyped(value?: ApiCommentaryBooks | null, ignoreDiscriminator?: boolean): any;
|
|
41
|
+
//# sourceMappingURL=ApiCommentaryBooks.d.ts.map
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Defines a dataset that is used in the API.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ApiDataset
|
|
16
|
+
*/
|
|
17
|
+
export interface ApiDataset {
|
|
18
|
+
/**
|
|
19
|
+
* The ID of the dataset.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ApiDataset
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The name of the dataset.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ApiDataset
|
|
28
|
+
*/
|
|
29
|
+
name: string;
|
|
30
|
+
/**
|
|
31
|
+
* The website for the dataset.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ApiDataset
|
|
34
|
+
*/
|
|
35
|
+
website: string;
|
|
36
|
+
/**
|
|
37
|
+
* The URL that the license for the dataset can be found.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ApiDataset
|
|
40
|
+
*/
|
|
41
|
+
licenseUrl: string;
|
|
42
|
+
/**
|
|
43
|
+
* The API-added notes for the license.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ApiDataset
|
|
46
|
+
*/
|
|
47
|
+
licenseNotes?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* The English name for the dataset.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ApiDataset
|
|
52
|
+
*/
|
|
53
|
+
englishName: string;
|
|
54
|
+
/**
|
|
55
|
+
* The ISO 639 3-letter language tag that the dataset is primarily in.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ApiDataset
|
|
58
|
+
*/
|
|
59
|
+
language: string;
|
|
60
|
+
/**
|
|
61
|
+
* The direction that the language is written in.
|
|
62
|
+
* @type {ApiDatasetTextDirectionEnum}
|
|
63
|
+
* @memberof ApiDataset
|
|
64
|
+
*/
|
|
65
|
+
textDirection: ApiDatasetTextDirectionEnum;
|
|
66
|
+
/**
|
|
67
|
+
* The API link for the list of books for this dataset. Relative to the API origin.
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof ApiDataset
|
|
70
|
+
*/
|
|
71
|
+
listOfBooksApiLink: string;
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @type {Array<ApiDatasetAvailableFormatsEnum>}
|
|
75
|
+
* @memberof ApiDataset
|
|
76
|
+
*/
|
|
77
|
+
availableFormats: Array<ApiDatasetAvailableFormatsEnum>;
|
|
78
|
+
/**
|
|
79
|
+
* The number of books that are contained in this dataset.
|
|
80
|
+
* @type {number}
|
|
81
|
+
* @memberof ApiDataset
|
|
82
|
+
*/
|
|
83
|
+
numberOfBooks: number;
|
|
84
|
+
/**
|
|
85
|
+
* The total number of chapters that are contained in this dataset.
|
|
86
|
+
* @type {number}
|
|
87
|
+
* @memberof ApiDataset
|
|
88
|
+
*/
|
|
89
|
+
totalNumberOfChapters: number;
|
|
90
|
+
/**
|
|
91
|
+
* The total number of verses that are contained in this dataset.
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof ApiDataset
|
|
94
|
+
*/
|
|
95
|
+
totalNumberOfVerses: number;
|
|
96
|
+
/**
|
|
97
|
+
* The total number of references that are contained in this dataset.
|
|
98
|
+
* @type {number}
|
|
99
|
+
* @memberof ApiDataset
|
|
100
|
+
*/
|
|
101
|
+
totalNumberOfReferences: number;
|
|
102
|
+
/**
|
|
103
|
+
* Gets the name of the language that the dataset is in. Null or undefined if the name of the language is not known.
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof ApiDataset
|
|
106
|
+
*/
|
|
107
|
+
languageName?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Gets the name of the language in English. Null or undefined if the language doesn't have an english name.
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof ApiDataset
|
|
112
|
+
*/
|
|
113
|
+
languageEnglishName?: string;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* @export
|
|
117
|
+
*/
|
|
118
|
+
export declare const ApiDatasetTextDirectionEnum: {
|
|
119
|
+
readonly Ltr: "ltr";
|
|
120
|
+
readonly Rtl: "rtl";
|
|
121
|
+
};
|
|
122
|
+
export type ApiDatasetTextDirectionEnum = typeof ApiDatasetTextDirectionEnum[keyof typeof ApiDatasetTextDirectionEnum];
|
|
123
|
+
/**
|
|
124
|
+
* @export
|
|
125
|
+
*/
|
|
126
|
+
export declare const ApiDatasetAvailableFormatsEnum: {
|
|
127
|
+
readonly Json: "json";
|
|
128
|
+
};
|
|
129
|
+
export type ApiDatasetAvailableFormatsEnum = typeof ApiDatasetAvailableFormatsEnum[keyof typeof ApiDatasetAvailableFormatsEnum];
|
|
130
|
+
/**
|
|
131
|
+
* Check if a given object implements the ApiDataset interface.
|
|
132
|
+
*/
|
|
133
|
+
export declare function instanceOfApiDataset(value: object): value is ApiDataset;
|
|
134
|
+
export declare function ApiDatasetFromJSON(json: any): ApiDataset;
|
|
135
|
+
export declare function ApiDatasetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDataset;
|
|
136
|
+
export declare function ApiDatasetToJSON(json: any): ApiDataset;
|
|
137
|
+
export declare function ApiDatasetToJSONTyped(value?: ApiDataset | null, ignoreDiscriminator?: boolean): any;
|
|
138
|
+
//# sourceMappingURL=ApiDataset.d.ts.map
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { BookId } from './BookId';
|
|
13
|
+
/**
|
|
14
|
+
* Defines a schema that contains information about a book in a dataset.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ApiDatasetBook
|
|
17
|
+
*/
|
|
18
|
+
export interface ApiDatasetBook {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {BookId}
|
|
22
|
+
* @memberof ApiDatasetBook
|
|
23
|
+
*/
|
|
24
|
+
id: BookId;
|
|
25
|
+
/**
|
|
26
|
+
* The order of the book in the Bible.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof ApiDatasetBook
|
|
29
|
+
*/
|
|
30
|
+
order: number;
|
|
31
|
+
/**
|
|
32
|
+
* The number of the first chapter in the book.
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof ApiDatasetBook
|
|
35
|
+
*/
|
|
36
|
+
firstChapterNumber: number;
|
|
37
|
+
/**
|
|
38
|
+
* The link to the first chapter of the book.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof ApiDatasetBook
|
|
41
|
+
*/
|
|
42
|
+
firstChapterApiLink: string;
|
|
43
|
+
/**
|
|
44
|
+
* The number of the last chapter in the book.
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof ApiDatasetBook
|
|
47
|
+
*/
|
|
48
|
+
lastChapterNumber: number;
|
|
49
|
+
/**
|
|
50
|
+
* The link to the last chapter of the book.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof ApiDatasetBook
|
|
53
|
+
*/
|
|
54
|
+
lastChapterApiLink: string;
|
|
55
|
+
/**
|
|
56
|
+
* The number of chapters that the book contains.
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof ApiDatasetBook
|
|
59
|
+
*/
|
|
60
|
+
numberOfChapters: number;
|
|
61
|
+
/**
|
|
62
|
+
* The number of verses that the book contains.
|
|
63
|
+
* @type {number}
|
|
64
|
+
* @memberof ApiDatasetBook
|
|
65
|
+
*/
|
|
66
|
+
totalNumberOfVerses: number;
|
|
67
|
+
/**
|
|
68
|
+
* The number of references that the book contains.
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof ApiDatasetBook
|
|
71
|
+
*/
|
|
72
|
+
totalNumberOfReferences: number;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Check if a given object implements the ApiDatasetBook interface.
|
|
76
|
+
*/
|
|
77
|
+
export declare function instanceOfApiDatasetBook(value: object): value is ApiDatasetBook;
|
|
78
|
+
export declare function ApiDatasetBookFromJSON(json: any): ApiDatasetBook;
|
|
79
|
+
export declare function ApiDatasetBookFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBook;
|
|
80
|
+
export declare function ApiDatasetBookToJSON(json: any): ApiDatasetBook;
|
|
81
|
+
export declare function ApiDatasetBookToJSONTyped(value?: ApiDatasetBook | null, ignoreDiscriminator?: boolean): any;
|
|
82
|
+
//# sourceMappingURL=ApiDatasetBook.d.ts.map
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ApiDataset } from './ApiDataset';
|
|
13
|
+
import type { ApiDatasetBook } from './ApiDatasetBook';
|
|
14
|
+
import type { DatasetChapterData } from './DatasetChapterData';
|
|
15
|
+
/**
|
|
16
|
+
* Defines a schema that contains information about a book chapter in a dataset.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface ApiDatasetBookChapter
|
|
19
|
+
*/
|
|
20
|
+
export interface ApiDatasetBookChapter {
|
|
21
|
+
/**
|
|
22
|
+
* The data for the chapter.
|
|
23
|
+
* @type {DatasetChapterData}
|
|
24
|
+
* @memberof ApiDatasetBookChapter
|
|
25
|
+
*/
|
|
26
|
+
chapter: DatasetChapterData;
|
|
27
|
+
/**
|
|
28
|
+
* The dataset information for the book chapter.
|
|
29
|
+
* @type {ApiDataset}
|
|
30
|
+
* @memberof ApiDatasetBookChapter
|
|
31
|
+
*/
|
|
32
|
+
dataset: ApiDataset;
|
|
33
|
+
/**
|
|
34
|
+
* The book information for the book chapter.
|
|
35
|
+
* @type {ApiDatasetBook}
|
|
36
|
+
* @memberof ApiDatasetBookChapter
|
|
37
|
+
*/
|
|
38
|
+
book: ApiDatasetBook;
|
|
39
|
+
/**
|
|
40
|
+
* The API link for this chapter. Relative to the API origin.
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof ApiDatasetBookChapter
|
|
43
|
+
*/
|
|
44
|
+
thisChapterLink: string;
|
|
45
|
+
/**
|
|
46
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset.
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof ApiDatasetBookChapter
|
|
49
|
+
*/
|
|
50
|
+
nextChapterApiLink: string | null;
|
|
51
|
+
/**
|
|
52
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset.
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof ApiDatasetBookChapter
|
|
55
|
+
*/
|
|
56
|
+
previousChapterApiLink: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* The number of verses that the chapter contains.
|
|
59
|
+
* @type {number}
|
|
60
|
+
* @memberof ApiDatasetBookChapter
|
|
61
|
+
*/
|
|
62
|
+
numberOfVerses: number;
|
|
63
|
+
/**
|
|
64
|
+
* The number of references that the chapter contains.
|
|
65
|
+
* @type {number}
|
|
66
|
+
* @memberof ApiDatasetBookChapter
|
|
67
|
+
*/
|
|
68
|
+
numberOfReferences: number;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Check if a given object implements the ApiDatasetBookChapter interface.
|
|
72
|
+
*/
|
|
73
|
+
export declare function instanceOfApiDatasetBookChapter(value: object): value is ApiDatasetBookChapter;
|
|
74
|
+
export declare function ApiDatasetBookChapterFromJSON(json: any): ApiDatasetBookChapter;
|
|
75
|
+
export declare function ApiDatasetBookChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBookChapter;
|
|
76
|
+
export declare function ApiDatasetBookChapterToJSON(json: any): ApiDatasetBookChapter;
|
|
77
|
+
export declare function ApiDatasetBookChapterToJSONTyped(value?: ApiDatasetBookChapter | null, ignoreDiscriminator?: boolean): any;
|
|
78
|
+
//# sourceMappingURL=ApiDatasetBookChapter.d.ts.map
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { ApiDataset } from './ApiDataset';
|
|
13
|
+
import type { ApiDatasetBook } from './ApiDatasetBook';
|
|
14
|
+
/**
|
|
15
|
+
* Defines an interface that contains information about the books that are available for a dataset.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ApiDatasetBooks
|
|
18
|
+
*/
|
|
19
|
+
export interface ApiDatasetBooks {
|
|
20
|
+
/**
|
|
21
|
+
* The dataset information for the books.
|
|
22
|
+
* @type {ApiDataset}
|
|
23
|
+
* @memberof ApiDatasetBooks
|
|
24
|
+
*/
|
|
25
|
+
dataset: ApiDataset;
|
|
26
|
+
/**
|
|
27
|
+
* The list of books that are available for the dataset.
|
|
28
|
+
* @type {Array<ApiDatasetBook>}
|
|
29
|
+
* @memberof ApiDatasetBooks
|
|
30
|
+
*/
|
|
31
|
+
books: Array<ApiDatasetBook>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the ApiDatasetBooks interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfApiDatasetBooks(value: object): value is ApiDatasetBooks;
|
|
37
|
+
export declare function ApiDatasetBooksFromJSON(json: any): ApiDatasetBooks;
|
|
38
|
+
export declare function ApiDatasetBooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiDatasetBooks;
|
|
39
|
+
export declare function ApiDatasetBooksToJSON(json: any): ApiDatasetBooks;
|
|
40
|
+
export declare function ApiDatasetBooksToJSONTyped(value?: ApiDatasetBooks | null, ignoreDiscriminator?: boolean): any;
|
|
41
|
+
//# sourceMappingURL=ApiDatasetBooks.d.ts.map
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Free Use Bible API
|
|
3
|
+
* An API for accessing over 1000 different Bible translations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
* Contact: hello@helloao.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Defines a translation that is used in the API.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ApiTranslation
|
|
16
|
+
*/
|
|
17
|
+
export interface ApiTranslation {
|
|
18
|
+
/**
|
|
19
|
+
* The ID of the translation.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ApiTranslation
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
* The name of the translation.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ApiTranslation
|
|
28
|
+
*/
|
|
29
|
+
name: string;
|
|
30
|
+
/**
|
|
31
|
+
* The website for the translation.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ApiTranslation
|
|
34
|
+
*/
|
|
35
|
+
website: string;
|
|
36
|
+
/**
|
|
37
|
+
* The URL that the license for the translation can be found.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ApiTranslation
|
|
40
|
+
*/
|
|
41
|
+
licenseUrl: string;
|
|
42
|
+
/**
|
|
43
|
+
* The API-added notes for the license.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ApiTranslation
|
|
46
|
+
*/
|
|
47
|
+
licenseNotes?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* The notice that should be displayed when displaying content from the translation.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ApiTranslation
|
|
52
|
+
*/
|
|
53
|
+
licenseNotice?: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* The short name for the translation.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ApiTranslation
|
|
58
|
+
*/
|
|
59
|
+
shortName?: string;
|
|
60
|
+
/**
|
|
61
|
+
* The English name for the translation.
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof ApiTranslation
|
|
64
|
+
*/
|
|
65
|
+
englishName: string;
|
|
66
|
+
/**
|
|
67
|
+
* The ISO 639 3-letter language tag that the translation is primarily in.
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof ApiTranslation
|
|
70
|
+
*/
|
|
71
|
+
language: string;
|
|
72
|
+
/**
|
|
73
|
+
* 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.
|
|
74
|
+
* @type {ApiTranslationTextDirectionEnum}
|
|
75
|
+
* @memberof ApiTranslation
|
|
76
|
+
*/
|
|
77
|
+
textDirection: ApiTranslationTextDirectionEnum;
|
|
78
|
+
/**
|
|
79
|
+
* The API link for the list of books for this translation. Relative to the API origin.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof ApiTranslation
|
|
82
|
+
*/
|
|
83
|
+
listOfBooksApiLink: string;
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
* @type {Array<ApiTranslationAvailableFormatsEnum>}
|
|
87
|
+
* @memberof ApiTranslation
|
|
88
|
+
*/
|
|
89
|
+
availableFormats: Array<ApiTranslationAvailableFormatsEnum>;
|
|
90
|
+
/**
|
|
91
|
+
* The number of books that are contained in this translation. Complete translations should have the same number of books as the Bible (66).
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof ApiTranslation
|
|
94
|
+
*/
|
|
95
|
+
numberOfBooks: number;
|
|
96
|
+
/**
|
|
97
|
+
* 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).
|
|
98
|
+
* @type {number}
|
|
99
|
+
* @memberof ApiTranslation
|
|
100
|
+
*/
|
|
101
|
+
totalNumberOfChapters: number;
|
|
102
|
+
/**
|
|
103
|
+
* 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).
|
|
104
|
+
* @type {number}
|
|
105
|
+
* @memberof ApiTranslation
|
|
106
|
+
*/
|
|
107
|
+
totalNumberOfVerses: number;
|
|
108
|
+
/**
|
|
109
|
+
* The total number of apocryphal books that are contained in this translation.
|
|
110
|
+
* @type {number}
|
|
111
|
+
* @memberof ApiTranslation
|
|
112
|
+
*/
|
|
113
|
+
numberOfApocryphalBooks?: number;
|
|
114
|
+
/**
|
|
115
|
+
* The total number of apocryphal chapters that are contained in this translation.
|
|
116
|
+
* @type {number}
|
|
117
|
+
* @memberof ApiTranslation
|
|
118
|
+
*/
|
|
119
|
+
totalNumberOfApocryphalChapters?: number;
|
|
120
|
+
/**
|
|
121
|
+
* The total number of apocryphal verses that are contained in this translation.
|
|
122
|
+
* @type {number}
|
|
123
|
+
* @memberof ApiTranslation
|
|
124
|
+
*/
|
|
125
|
+
totalNumberOfApocryphalVerses?: number;
|
|
126
|
+
/**
|
|
127
|
+
* Gets the name of the language that the translation is in. Null or undefined if the name of the language is not known.
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof ApiTranslation
|
|
130
|
+
*/
|
|
131
|
+
languageName?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Gets the name of the language in English. Null or undefined if the language doesn't have an english name.
|
|
134
|
+
* @type {string}
|
|
135
|
+
* @memberof ApiTranslation
|
|
136
|
+
*/
|
|
137
|
+
languageEnglishName?: string;
|
|
138
|
+
/**
|
|
139
|
+
* 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.
|
|
140
|
+
* @type {string}
|
|
141
|
+
* @memberof ApiTranslation
|
|
142
|
+
*/
|
|
143
|
+
completeTranslationApiLink?: string;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* @export
|
|
147
|
+
*/
|
|
148
|
+
export declare const ApiTranslationTextDirectionEnum: {
|
|
149
|
+
readonly Ltr: "ltr";
|
|
150
|
+
readonly Rtl: "rtl";
|
|
151
|
+
};
|
|
152
|
+
export type ApiTranslationTextDirectionEnum = typeof ApiTranslationTextDirectionEnum[keyof typeof ApiTranslationTextDirectionEnum];
|
|
153
|
+
/**
|
|
154
|
+
* @export
|
|
155
|
+
*/
|
|
156
|
+
export declare const ApiTranslationAvailableFormatsEnum: {
|
|
157
|
+
readonly Json: "json";
|
|
158
|
+
readonly Usfm: "usfm";
|
|
159
|
+
};
|
|
160
|
+
export type ApiTranslationAvailableFormatsEnum = typeof ApiTranslationAvailableFormatsEnum[keyof typeof ApiTranslationAvailableFormatsEnum];
|
|
161
|
+
/**
|
|
162
|
+
* Check if a given object implements the ApiTranslation interface.
|
|
163
|
+
*/
|
|
164
|
+
export declare function instanceOfApiTranslation(value: object): value is ApiTranslation;
|
|
165
|
+
export declare function ApiTranslationFromJSON(json: any): ApiTranslation;
|
|
166
|
+
export declare function ApiTranslationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslation;
|
|
167
|
+
export declare function ApiTranslationToJSON(json: any): ApiTranslation;
|
|
168
|
+
export declare function ApiTranslationToJSONTyped(value?: ApiTranslation | null, ignoreDiscriminator?: boolean): any;
|
|
169
|
+
//# sourceMappingURL=ApiTranslation.d.ts.map
|