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.
Files changed (136) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +139 -0
  3. package/dist/cjs/index.cjs +27 -0
  4. package/dist/esm/apis/DefaultApi.js +416 -0
  5. package/dist/esm/apis/DefaultApi.js.map +7 -0
  6. package/dist/esm/apis/FreeUseBibleApi.js +61 -0
  7. package/dist/esm/apis/FreeUseBibleApi.js.map +7 -0
  8. package/dist/esm/apis/index.js +4 -0
  9. package/dist/esm/apis/index.js.map +7 -0
  10. package/dist/esm/index.js +5 -0
  11. package/dist/esm/index.js.map +7 -0
  12. package/dist/esm/models/ApiAvailableCommentaries.js +32 -0
  13. package/dist/esm/models/ApiAvailableCommentaries.js.map +7 -0
  14. package/dist/esm/models/ApiAvailableDatasets.js +32 -0
  15. package/dist/esm/models/ApiAvailableDatasets.js.map +7 -0
  16. package/dist/esm/models/ApiAvailableTranslations.js +32 -0
  17. package/dist/esm/models/ApiAvailableTranslations.js.map +7 -0
  18. package/dist/esm/models/ApiCommentary.js +81 -0
  19. package/dist/esm/models/ApiCommentary.js.map +7 -0
  20. package/dist/esm/models/ApiCommentaryBook.js +63 -0
  21. package/dist/esm/models/ApiCommentaryBook.js.map +7 -0
  22. package/dist/esm/models/ApiCommentaryBookChapter.js +58 -0
  23. package/dist/esm/models/ApiCommentaryBookChapter.js.map +7 -0
  24. package/dist/esm/models/ApiCommentaryBookChapterChapter.js +37 -0
  25. package/dist/esm/models/ApiCommentaryBookChapterChapter.js.map +7 -0
  26. package/dist/esm/models/ApiCommentaryBooks.js +39 -0
  27. package/dist/esm/models/ApiCommentaryBooks.js.map +7 -0
  28. package/dist/esm/models/ApiDataset.js +77 -0
  29. package/dist/esm/models/ApiDataset.js.map +7 -0
  30. package/dist/esm/models/ApiDatasetBook.js +56 -0
  31. package/dist/esm/models/ApiDatasetBook.js.map +7 -0
  32. package/dist/esm/models/ApiDatasetBookChapter.js +61 -0
  33. package/dist/esm/models/ApiDatasetBookChapter.js.map +7 -0
  34. package/dist/esm/models/ApiDatasetBooks.js +39 -0
  35. package/dist/esm/models/ApiDatasetBooks.js.map +7 -0
  36. package/dist/esm/models/ApiTranslation.js +87 -0
  37. package/dist/esm/models/ApiTranslation.js.map +7 -0
  38. package/dist/esm/models/ApiTranslationBook.js +64 -0
  39. package/dist/esm/models/ApiTranslationBook.js.map +7 -0
  40. package/dist/esm/models/ApiTranslationBookChapter.js +67 -0
  41. package/dist/esm/models/ApiTranslationBookChapter.js.map +7 -0
  42. package/dist/esm/models/ApiTranslationBookChapterChapter.js +42 -0
  43. package/dist/esm/models/ApiTranslationBookChapterChapter.js.map +7 -0
  44. package/dist/esm/models/ApiTranslationBooks.js +39 -0
  45. package/dist/esm/models/ApiTranslationBooks.js.map +7 -0
  46. package/dist/esm/models/ApiTranslationComplete.js +39 -0
  47. package/dist/esm/models/ApiTranslationComplete.js.map +7 -0
  48. package/dist/esm/models/ApiTranslationCompleteBook.js +59 -0
  49. package/dist/esm/models/ApiTranslationCompleteBook.js.map +7 -0
  50. package/dist/esm/models/BookId.js +127 -0
  51. package/dist/esm/models/BookId.js.map +7 -0
  52. package/dist/esm/models/ChapterContent.js +58 -0
  53. package/dist/esm/models/ChapterContent.js.map +7 -0
  54. package/dist/esm/models/ChapterFootnote.js +44 -0
  55. package/dist/esm/models/ChapterFootnote.js.map +7 -0
  56. package/dist/esm/models/ChapterFootnoteCaller.js +17 -0
  57. package/dist/esm/models/ChapterFootnoteCaller.js.map +7 -0
  58. package/dist/esm/models/ChapterFootnoteReference.js +31 -0
  59. package/dist/esm/models/ChapterFootnoteReference.js.map +7 -0
  60. package/dist/esm/models/ChapterHeading.js +34 -0
  61. package/dist/esm/models/ChapterHeading.js.map +7 -0
  62. package/dist/esm/models/ChapterHebrewSubtitle.js +38 -0
  63. package/dist/esm/models/ChapterHebrewSubtitle.js.map +7 -0
  64. package/dist/esm/models/ChapterHebrewSubtitleContentInner.js +35 -0
  65. package/dist/esm/models/ChapterHebrewSubtitleContentInner.js.map +7 -0
  66. package/dist/esm/models/ChapterLineBreak.js +31 -0
  67. package/dist/esm/models/ChapterLineBreak.js.map +7 -0
  68. package/dist/esm/models/ChapterVerse.js +41 -0
  69. package/dist/esm/models/ChapterVerse.js.map +7 -0
  70. package/dist/esm/models/ChapterVerseContentInner.js +44 -0
  71. package/dist/esm/models/ChapterVerseContentInner.js.map +7 -0
  72. package/dist/esm/models/DatasetChapterData.js +35 -0
  73. package/dist/esm/models/DatasetChapterData.js.map +7 -0
  74. package/dist/esm/models/DatasetChapterVerseContent.js +35 -0
  75. package/dist/esm/models/DatasetChapterVerseContent.js.map +7 -0
  76. package/dist/esm/models/FormattedText.js +32 -0
  77. package/dist/esm/models/FormattedText.js.map +7 -0
  78. package/dist/esm/models/InlineHeading.js +28 -0
  79. package/dist/esm/models/InlineHeading.js.map +7 -0
  80. package/dist/esm/models/InlineLineBreak.js +31 -0
  81. package/dist/esm/models/InlineLineBreak.js.map +7 -0
  82. package/dist/esm/models/ScoredVerseRef.js +47 -0
  83. package/dist/esm/models/ScoredVerseRef.js.map +7 -0
  84. package/dist/esm/models/TranslationBookChapter.js +35 -0
  85. package/dist/esm/models/TranslationBookChapter.js.map +7 -0
  86. package/dist/esm/models/VerseFootnoteReference.js +28 -0
  87. package/dist/esm/models/VerseFootnoteReference.js.map +7 -0
  88. package/dist/esm/models/index.js +40 -0
  89. package/dist/esm/models/index.js.map +7 -0
  90. package/dist/esm/runtime.js +304 -0
  91. package/dist/esm/runtime.js.map +7 -0
  92. package/dist/types/apis/DefaultApi.d.ts +176 -0
  93. package/dist/types/apis/FreeUseBibleApi.d.ts +34 -0
  94. package/dist/types/apis/index.d.ts +3 -0
  95. package/dist/types/index.d.ts +4 -0
  96. package/dist/types/models/ApiAvailableCommentaries.d.ts +34 -0
  97. package/dist/types/models/ApiAvailableDatasets.d.ts +34 -0
  98. package/dist/types/models/ApiAvailableTranslations.d.ts +34 -0
  99. package/dist/types/models/ApiCommentary.d.ts +145 -0
  100. package/dist/types/models/ApiCommentaryBook.d.ts +100 -0
  101. package/dist/types/models/ApiCommentaryBookChapter.d.ts +72 -0
  102. package/dist/types/models/ApiCommentaryBookChapterChapter.d.ts +46 -0
  103. package/dist/types/models/ApiCommentaryBooks.d.ts +41 -0
  104. package/dist/types/models/ApiDataset.d.ts +138 -0
  105. package/dist/types/models/ApiDatasetBook.d.ts +82 -0
  106. package/dist/types/models/ApiDatasetBookChapter.d.ts +78 -0
  107. package/dist/types/models/ApiDatasetBooks.d.ts +41 -0
  108. package/dist/types/models/ApiTranslation.d.ts +169 -0
  109. package/dist/types/models/ApiTranslationBook.d.ts +100 -0
  110. package/dist/types/models/ApiTranslationBookChapter.d.ts +96 -0
  111. package/dist/types/models/ApiTranslationBookChapterChapter.d.ts +47 -0
  112. package/dist/types/models/ApiTranslationBooks.d.ts +41 -0
  113. package/dist/types/models/ApiTranslationComplete.d.ts +41 -0
  114. package/dist/types/models/ApiTranslationCompleteBook.d.ts +83 -0
  115. package/dist/types/models/BookId.d.ts +125 -0
  116. package/dist/types/models/ChapterContent.d.ts +34 -0
  117. package/dist/types/models/ChapterFootnote.d.ts +53 -0
  118. package/dist/types/models/ChapterFootnoteCaller.d.ts +27 -0
  119. package/dist/types/models/ChapterFootnoteReference.d.ts +39 -0
  120. package/dist/types/models/ChapterHeading.d.ts +46 -0
  121. package/dist/types/models/ChapterHebrewSubtitle.d.ts +47 -0
  122. package/dist/types/models/ChapterHebrewSubtitleContentInner.d.ts +51 -0
  123. package/dist/types/models/ChapterLineBreak.d.ts +40 -0
  124. package/dist/types/models/ChapterVerse.d.ts +53 -0
  125. package/dist/types/models/ChapterVerseContentInner.d.ts +70 -0
  126. package/dist/types/models/DatasetChapterData.d.ts +40 -0
  127. package/dist/types/models/DatasetChapterVerseContent.d.ts +40 -0
  128. package/dist/types/models/FormattedText.d.ts +45 -0
  129. package/dist/types/models/InlineHeading.d.ts +33 -0
  130. package/dist/types/models/InlineLineBreak.d.ts +40 -0
  131. package/dist/types/models/ScoredVerseRef.d.ts +70 -0
  132. package/dist/types/models/TranslationBookChapter.d.ts +42 -0
  133. package/dist/types/models/VerseFootnoteReference.d.ts +33 -0
  134. package/dist/types/models/index.d.ts +39 -0
  135. package/dist/types/runtime.d.ts +185 -0
  136. package/package.json +31 -0
@@ -0,0 +1,100 @@
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 translation book.
15
+ * @export
16
+ * @interface ApiTranslationBook
17
+ */
18
+ export interface ApiTranslationBook {
19
+ /**
20
+ *
21
+ * @type {BookId}
22
+ * @memberof ApiTranslationBook
23
+ */
24
+ id: BookId;
25
+ /**
26
+ * The name that the translation provided for the book.
27
+ * @type {string}
28
+ * @memberof ApiTranslationBook
29
+ */
30
+ name: string;
31
+ /**
32
+ * The common name for the book.
33
+ * @type {string}
34
+ * @memberof ApiTranslationBook
35
+ */
36
+ commonName: string;
37
+ /**
38
+ * 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.
39
+ * @type {string}
40
+ * @memberof ApiTranslationBook
41
+ */
42
+ title: string | null;
43
+ /**
44
+ * The numerical order of the book in the translation.
45
+ * @type {number}
46
+ * @memberof ApiTranslationBook
47
+ */
48
+ order: number;
49
+ /**
50
+ * Whether the book is an apocryphal book.
51
+ * @type {boolean}
52
+ * @memberof ApiTranslationBook
53
+ */
54
+ isApocryphal?: boolean;
55
+ /**
56
+ * The number of the first chapter in the book.
57
+ * @type {number}
58
+ * @memberof ApiTranslationBook
59
+ */
60
+ firstChapterNumber: number;
61
+ /**
62
+ * The link to the first chapter of the book.
63
+ * @type {string}
64
+ * @memberof ApiTranslationBook
65
+ */
66
+ firstChapterApiLink: string;
67
+ /**
68
+ * The number of the last chapter in the book.
69
+ * @type {number}
70
+ * @memberof ApiTranslationBook
71
+ */
72
+ lastChapterNumber: number;
73
+ /**
74
+ * The link to the last chapter of the book.
75
+ * @type {string}
76
+ * @memberof ApiTranslationBook
77
+ */
78
+ lastChapterApiLink: string;
79
+ /**
80
+ * The number of chapters that the book contains.
81
+ * @type {number}
82
+ * @memberof ApiTranslationBook
83
+ */
84
+ numberOfChapters: number;
85
+ /**
86
+ * The number of verses that the book contains.
87
+ * @type {number}
88
+ * @memberof ApiTranslationBook
89
+ */
90
+ totalNumberOfVerses: number;
91
+ }
92
+ /**
93
+ * Check if a given object implements the ApiTranslationBook interface.
94
+ */
95
+ export declare function instanceOfApiTranslationBook(value: object): value is ApiTranslationBook;
96
+ export declare function ApiTranslationBookFromJSON(json: any): ApiTranslationBook;
97
+ export declare function ApiTranslationBookFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBook;
98
+ export declare function ApiTranslationBookToJSON(json: any): ApiTranslationBook;
99
+ export declare function ApiTranslationBookToJSONTyped(value?: ApiTranslationBook | null, ignoreDiscriminator?: boolean): any;
100
+ //# sourceMappingURL=ApiTranslationBook.d.ts.map
@@ -0,0 +1,96 @@
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 { ApiTranslationBook } from './ApiTranslationBook';
13
+ import type { ApiTranslation } from './ApiTranslation';
14
+ import type { ApiTranslationBookChapterChapter } from './ApiTranslationBookChapterChapter';
15
+ /**
16
+ * Defines an interface that contains information about a book chapter in a translation.
17
+ * @export
18
+ * @interface ApiTranslationBookChapter
19
+ */
20
+ export interface ApiTranslationBookChapter {
21
+ /**
22
+ *
23
+ * @type {ApiTranslationBookChapterChapter}
24
+ * @memberof ApiTranslationBookChapter
25
+ */
26
+ chapter: ApiTranslationBookChapterChapter;
27
+ /**
28
+ * The links to different audio versions for the chapter.
29
+ * @type {{ [key: string]: string; }}
30
+ * @memberof ApiTranslationBookChapter
31
+ */
32
+ thisChapterAudioLinks: {
33
+ [key: string]: string;
34
+ };
35
+ /**
36
+ * The translation information for the book chapter.
37
+ * @type {ApiTranslation}
38
+ * @memberof ApiTranslationBookChapter
39
+ */
40
+ translation: ApiTranslation;
41
+ /**
42
+ * The book information for the book chapter.
43
+ * @type {ApiTranslationBook}
44
+ * @memberof ApiTranslationBookChapter
45
+ */
46
+ book: ApiTranslationBook;
47
+ /**
48
+ * The API link for this chapter. Relative to the API origin.
49
+ * @type {string}
50
+ * @memberof ApiTranslationBookChapter
51
+ */
52
+ thisChapterLink: string;
53
+ /**
54
+ * The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
55
+ * @type {string}
56
+ * @memberof ApiTranslationBookChapter
57
+ */
58
+ nextChapterApiLink: string | null;
59
+ /**
60
+ * 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.
61
+ * @type {{ [key: string]: string; }}
62
+ * @memberof ApiTranslationBookChapter
63
+ */
64
+ nextChapterAudioLinks: {
65
+ [key: string]: string;
66
+ } | null;
67
+ /**
68
+ * The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
69
+ * @type {string}
70
+ * @memberof ApiTranslationBookChapter
71
+ */
72
+ previousChapterApiLink: string | null;
73
+ /**
74
+ * 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.
75
+ * @type {{ [key: string]: string; }}
76
+ * @memberof ApiTranslationBookChapter
77
+ */
78
+ previousChapterAudioLinks: {
79
+ [key: string]: string;
80
+ } | null;
81
+ /**
82
+ * The number of verses that the chapter contains.
83
+ * @type {number}
84
+ * @memberof ApiTranslationBookChapter
85
+ */
86
+ numberOfVerses: number;
87
+ }
88
+ /**
89
+ * Check if a given object implements the ApiTranslationBookChapter interface.
90
+ */
91
+ export declare function instanceOfApiTranslationBookChapter(value: object): value is ApiTranslationBookChapter;
92
+ export declare function ApiTranslationBookChapterFromJSON(json: any): ApiTranslationBookChapter;
93
+ export declare function ApiTranslationBookChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBookChapter;
94
+ export declare function ApiTranslationBookChapterToJSON(json: any): ApiTranslationBookChapter;
95
+ export declare function ApiTranslationBookChapterToJSONTyped(value?: ApiTranslationBookChapter | null, ignoreDiscriminator?: boolean): any;
96
+ //# sourceMappingURL=ApiTranslationBookChapter.d.ts.map
@@ -0,0 +1,47 @@
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 { ChapterFootnote } from './ChapterFootnote';
13
+ import type { ChapterContent } from './ChapterContent';
14
+ /**
15
+ * The information for the chapter.
16
+ * @export
17
+ * @interface ApiTranslationBookChapterChapter
18
+ */
19
+ export interface ApiTranslationBookChapterChapter {
20
+ /**
21
+ * The number of the chapter.
22
+ * @type {number}
23
+ * @memberof ApiTranslationBookChapterChapter
24
+ */
25
+ number: number;
26
+ /**
27
+ * The content of the chapter.
28
+ * @type {Array<ChapterContent>}
29
+ * @memberof ApiTranslationBookChapterChapter
30
+ */
31
+ content: Array<ChapterContent>;
32
+ /**
33
+ * The list of footnotes for the chapter.
34
+ * @type {Array<ChapterFootnote>}
35
+ * @memberof ApiTranslationBookChapterChapter
36
+ */
37
+ footnotes: Array<ChapterFootnote>;
38
+ }
39
+ /**
40
+ * Check if a given object implements the ApiTranslationBookChapterChapter interface.
41
+ */
42
+ export declare function instanceOfApiTranslationBookChapterChapter(value: object): value is ApiTranslationBookChapterChapter;
43
+ export declare function ApiTranslationBookChapterChapterFromJSON(json: any): ApiTranslationBookChapterChapter;
44
+ export declare function ApiTranslationBookChapterChapterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBookChapterChapter;
45
+ export declare function ApiTranslationBookChapterChapterToJSON(json: any): ApiTranslationBookChapterChapter;
46
+ export declare function ApiTranslationBookChapterChapterToJSONTyped(value?: ApiTranslationBookChapterChapter | null, ignoreDiscriminator?: boolean): any;
47
+ //# sourceMappingURL=ApiTranslationBookChapterChapter.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 { ApiTranslationBook } from './ApiTranslationBook';
13
+ import type { ApiTranslation } from './ApiTranslation';
14
+ /**
15
+ * Defines an interface that contains information about the books that are available for a translation.
16
+ * @export
17
+ * @interface ApiTranslationBooks
18
+ */
19
+ export interface ApiTranslationBooks {
20
+ /**
21
+ * The translation information for the books.
22
+ * @type {ApiTranslation}
23
+ * @memberof ApiTranslationBooks
24
+ */
25
+ translation: ApiTranslation;
26
+ /**
27
+ * The list of books that are available for the translation.
28
+ * @type {Array<ApiTranslationBook>}
29
+ * @memberof ApiTranslationBooks
30
+ */
31
+ books: Array<ApiTranslationBook>;
32
+ }
33
+ /**
34
+ * Check if a given object implements the ApiTranslationBooks interface.
35
+ */
36
+ export declare function instanceOfApiTranslationBooks(value: object): value is ApiTranslationBooks;
37
+ export declare function ApiTranslationBooksFromJSON(json: any): ApiTranslationBooks;
38
+ export declare function ApiTranslationBooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationBooks;
39
+ export declare function ApiTranslationBooksToJSON(json: any): ApiTranslationBooks;
40
+ export declare function ApiTranslationBooksToJSONTyped(value?: ApiTranslationBooks | null, ignoreDiscriminator?: boolean): any;
41
+ //# sourceMappingURL=ApiTranslationBooks.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 { ApiTranslationCompleteBook } from './ApiTranslationCompleteBook';
13
+ import type { ApiTranslation } from './ApiTranslation';
14
+ /**
15
+ * Defines the complete translation download data. Maps to the /api/:translationId/complete.json endpoint.
16
+ * @export
17
+ * @interface ApiTranslationComplete
18
+ */
19
+ export interface ApiTranslationComplete {
20
+ /**
21
+ * The translation metadata.
22
+ * @type {ApiTranslation}
23
+ * @memberof ApiTranslationComplete
24
+ */
25
+ translation: ApiTranslation;
26
+ /**
27
+ * The complete list of books with all their chapters.
28
+ * @type {Array<ApiTranslationCompleteBook>}
29
+ * @memberof ApiTranslationComplete
30
+ */
31
+ books: Array<ApiTranslationCompleteBook>;
32
+ }
33
+ /**
34
+ * Check if a given object implements the ApiTranslationComplete interface.
35
+ */
36
+ export declare function instanceOfApiTranslationComplete(value: object): value is ApiTranslationComplete;
37
+ export declare function ApiTranslationCompleteFromJSON(json: any): ApiTranslationComplete;
38
+ export declare function ApiTranslationCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationComplete;
39
+ export declare function ApiTranslationCompleteToJSON(json: any): ApiTranslationComplete;
40
+ export declare function ApiTranslationCompleteToJSONTyped(value?: ApiTranslationComplete | null, ignoreDiscriminator?: boolean): any;
41
+ //# sourceMappingURL=ApiTranslationComplete.d.ts.map
@@ -0,0 +1,83 @@
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 { TranslationBookChapter } from './TranslationBookChapter';
13
+ import type { BookId } from './BookId';
14
+ /**
15
+ * A book in the complete translation download.
16
+ * @export
17
+ * @interface ApiTranslationCompleteBook
18
+ */
19
+ export interface ApiTranslationCompleteBook {
20
+ /**
21
+ *
22
+ * @type {BookId}
23
+ * @memberof ApiTranslationCompleteBook
24
+ */
25
+ id: BookId;
26
+ /**
27
+ * The name that the translation provided for the book.
28
+ * @type {string}
29
+ * @memberof ApiTranslationCompleteBook
30
+ */
31
+ name: string;
32
+ /**
33
+ * The common name for the book.
34
+ * @type {string}
35
+ * @memberof ApiTranslationCompleteBook
36
+ */
37
+ commonName: string;
38
+ /**
39
+ * 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.
40
+ * @type {string}
41
+ * @memberof ApiTranslationCompleteBook
42
+ */
43
+ title: string | null;
44
+ /**
45
+ * The numerical order of the book in the translation.
46
+ * @type {number}
47
+ * @memberof ApiTranslationCompleteBook
48
+ */
49
+ order: number;
50
+ /**
51
+ * Whether the book is an apocryphal book.
52
+ * @type {boolean}
53
+ * @memberof ApiTranslationCompleteBook
54
+ */
55
+ isApocryphal?: boolean;
56
+ /**
57
+ * The number of chapters in the book.
58
+ * @type {number}
59
+ * @memberof ApiTranslationCompleteBook
60
+ */
61
+ numberOfChapters: number;
62
+ /**
63
+ * The total number of verses in the book.
64
+ * @type {number}
65
+ * @memberof ApiTranslationCompleteBook
66
+ */
67
+ totalNumberOfVerses: number;
68
+ /**
69
+ * The complete list of chapters with all content.
70
+ * @type {Array<TranslationBookChapter>}
71
+ * @memberof ApiTranslationCompleteBook
72
+ */
73
+ chapters: Array<TranslationBookChapter>;
74
+ }
75
+ /**
76
+ * Check if a given object implements the ApiTranslationCompleteBook interface.
77
+ */
78
+ export declare function instanceOfApiTranslationCompleteBook(value: object): value is ApiTranslationCompleteBook;
79
+ export declare function ApiTranslationCompleteBookFromJSON(json: any): ApiTranslationCompleteBook;
80
+ export declare function ApiTranslationCompleteBookFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiTranslationCompleteBook;
81
+ export declare function ApiTranslationCompleteBookToJSON(json: any): ApiTranslationCompleteBook;
82
+ export declare function ApiTranslationCompleteBookToJSONTyped(value?: ApiTranslationCompleteBook | null, ignoreDiscriminator?: boolean): any;
83
+ //# sourceMappingURL=ApiTranslationCompleteBook.d.ts.map
@@ -0,0 +1,125 @@
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
+ * IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
14
+ * @export
15
+ */
16
+ export declare const BookId: {
17
+ readonly Gen: "GEN";
18
+ readonly Exo: "EXO";
19
+ readonly Lev: "LEV";
20
+ readonly Num: "NUM";
21
+ readonly Deu: "DEU";
22
+ readonly Jos: "JOS";
23
+ readonly Jdg: "JDG";
24
+ readonly Rut: "RUT";
25
+ readonly _1Sa: "1SA";
26
+ readonly _2Sa: "2SA";
27
+ readonly _1Ki: "1KI";
28
+ readonly _2Ki: "2KI";
29
+ readonly _1Ch: "1CH";
30
+ readonly _2Ch: "2CH";
31
+ readonly Ezr: "EZR";
32
+ readonly Neh: "NEH";
33
+ readonly Est: "EST";
34
+ readonly Job: "JOB";
35
+ readonly Psa: "PSA";
36
+ readonly Pro: "PRO";
37
+ readonly Ecc: "ECC";
38
+ readonly Sng: "SNG";
39
+ readonly Isa: "ISA";
40
+ readonly Jer: "JER";
41
+ readonly Lam: "LAM";
42
+ readonly Ezk: "EZK";
43
+ readonly Dan: "DAN";
44
+ readonly Hos: "HOS";
45
+ readonly Jol: "JOL";
46
+ readonly Amo: "AMO";
47
+ readonly Oba: "OBA";
48
+ readonly Jon: "JON";
49
+ readonly Mic: "MIC";
50
+ readonly Nam: "NAM";
51
+ readonly Hab: "HAB";
52
+ readonly Zep: "ZEP";
53
+ readonly Hag: "HAG";
54
+ readonly Zec: "ZEC";
55
+ readonly Mal: "MAL";
56
+ readonly Mat: "MAT";
57
+ readonly Mrk: "MRK";
58
+ readonly Luk: "LUK";
59
+ readonly Jhn: "JHN";
60
+ readonly Act: "ACT";
61
+ readonly Rom: "ROM";
62
+ readonly _1Co: "1CO";
63
+ readonly _2Co: "2CO";
64
+ readonly Gal: "GAL";
65
+ readonly Eph: "EPH";
66
+ readonly Php: "PHP";
67
+ readonly Col: "COL";
68
+ readonly _1Th: "1TH";
69
+ readonly _2Th: "2TH";
70
+ readonly _1Ti: "1TI";
71
+ readonly _2Ti: "2TI";
72
+ readonly Tit: "TIT";
73
+ readonly Phm: "PHM";
74
+ readonly Heb: "HEB";
75
+ readonly Jas: "JAS";
76
+ readonly _1Pe: "1PE";
77
+ readonly _2Pe: "2PE";
78
+ readonly _1Jn: "1JN";
79
+ readonly _2Jn: "2JN";
80
+ readonly _3Jn: "3JN";
81
+ readonly Jud: "JUD";
82
+ readonly Rev: "REV";
83
+ readonly Tob: "TOB";
84
+ readonly Jdt: "JDT";
85
+ readonly Esg: "ESG";
86
+ readonly Wis: "WIS";
87
+ readonly Sir: "SIR";
88
+ readonly Bar: "BAR";
89
+ readonly Lje: "LJE";
90
+ readonly S3Y: "S3Y";
91
+ readonly Sus: "SUS";
92
+ readonly Bel: "BEL";
93
+ readonly _1Ma: "1MA";
94
+ readonly _2Ma: "2MA";
95
+ readonly _3Ma: "3MA";
96
+ readonly _4Ma: "4MA";
97
+ readonly _1Es: "1ES";
98
+ readonly _2Es: "2ES";
99
+ readonly Man: "MAN";
100
+ readonly Ps2: "PS2";
101
+ readonly Oda: "ODA";
102
+ readonly Pss: "PSS";
103
+ readonly Eza: "EZA";
104
+ readonly _5Ez: "5EZ";
105
+ readonly _6Ez: "6EZ";
106
+ readonly Dag: "DAG";
107
+ readonly Ps3: "PS3";
108
+ readonly _2Ba: "2BA";
109
+ readonly Lba: "LBA";
110
+ readonly Jub: "JUB";
111
+ readonly Eno: "ENO";
112
+ readonly _1Mq: "1MQ";
113
+ readonly _2Mq: "2MQ";
114
+ readonly _3Mq: "3MQ";
115
+ readonly Rep: "REP";
116
+ readonly _4Ba: "4BA";
117
+ readonly Lao: "LAO";
118
+ };
119
+ export type BookId = typeof BookId[keyof typeof BookId];
120
+ export declare function instanceOfBookId(value: any): boolean;
121
+ export declare function BookIdFromJSON(json: any): BookId;
122
+ export declare function BookIdFromJSONTyped(json: any, ignoreDiscriminator: boolean): BookId;
123
+ export declare function BookIdToJSON(value?: BookId | null): any;
124
+ export declare function BookIdToJSONTyped(value: any, ignoreDiscriminator: boolean): BookId;
125
+ //# sourceMappingURL=BookId.d.ts.map
@@ -0,0 +1,34 @@
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 { ChapterHeading } from './ChapterHeading';
13
+ import type { ChapterHebrewSubtitle } from './ChapterHebrewSubtitle';
14
+ import type { ChapterLineBreak } from './ChapterLineBreak';
15
+ import type { ChapterVerse } from './ChapterVerse';
16
+ /**
17
+ * @type ChapterContent
18
+ * Defines a union type that represents a single piece of chapter content. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle.
19
+ * @export
20
+ */
21
+ export type ChapterContent = {
22
+ type: 'heading';
23
+ } & ChapterHeading | {
24
+ type: 'hebrew_subtitle';
25
+ } & ChapterHebrewSubtitle | {
26
+ type: 'line_break';
27
+ } & ChapterLineBreak | {
28
+ type: 'verse';
29
+ } & ChapterVerse;
30
+ export declare function ChapterContentFromJSON(json: any): ChapterContent;
31
+ export declare function ChapterContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChapterContent;
32
+ export declare function ChapterContentToJSON(json: any): any;
33
+ export declare function ChapterContentToJSONTyped(value?: ChapterContent | null, ignoreDiscriminator?: boolean): any;
34
+ //# sourceMappingURL=ChapterContent.d.ts.map
@@ -0,0 +1,53 @@
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 { ChapterFootnoteReference } from './ChapterFootnoteReference';
13
+ import type { ChapterFootnoteCaller } from './ChapterFootnoteCaller';
14
+ /**
15
+ * Defines the schema for information about a footnote.
16
+ * @export
17
+ * @interface ChapterFootnote
18
+ */
19
+ export interface ChapterFootnote {
20
+ /**
21
+ * The ID of the note that is referenced.
22
+ * @type {number}
23
+ * @memberof ChapterFootnote
24
+ */
25
+ noteId: number;
26
+ /**
27
+ * The text of the footnote.
28
+ * @type {string}
29
+ * @memberof ChapterFootnote
30
+ */
31
+ text: string;
32
+ /**
33
+ *
34
+ * @type {ChapterFootnoteReference}
35
+ * @memberof ChapterFootnote
36
+ */
37
+ reference?: ChapterFootnoteReference;
38
+ /**
39
+ *
40
+ * @type {ChapterFootnoteCaller}
41
+ * @memberof ChapterFootnote
42
+ */
43
+ caller: ChapterFootnoteCaller | null;
44
+ }
45
+ /**
46
+ * Check if a given object implements the ChapterFootnote interface.
47
+ */
48
+ export declare function instanceOfChapterFootnote(value: object): value is ChapterFootnote;
49
+ export declare function ChapterFootnoteFromJSON(json: any): ChapterFootnote;
50
+ export declare function ChapterFootnoteFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChapterFootnote;
51
+ export declare function ChapterFootnoteToJSON(json: any): ChapterFootnote;
52
+ export declare function ChapterFootnoteToJSONTyped(value?: ChapterFootnote | null, ignoreDiscriminator?: boolean): any;
53
+ //# sourceMappingURL=ChapterFootnote.d.ts.map
@@ -0,0 +1,27 @@
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
+ * The caller that should be used for the footnote. For footnotes, a "caller" is the character that is used in the text to reference to footnote. For example, in the text: Hello (a) World ---- (a) This is a footnote. The "(a)" is the caller. If "+", then the caller should be autogenerated. If null, then the caller should be empty. If a string, then the caller should be that string.
14
+ * @export
15
+ * @interface ChapterFootnoteCaller
16
+ */
17
+ export interface ChapterFootnoteCaller {
18
+ }
19
+ /**
20
+ * Check if a given object implements the ChapterFootnoteCaller interface.
21
+ */
22
+ export declare function instanceOfChapterFootnoteCaller(value: object): value is ChapterFootnoteCaller;
23
+ export declare function ChapterFootnoteCallerFromJSON(json: any): ChapterFootnoteCaller;
24
+ export declare function ChapterFootnoteCallerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChapterFootnoteCaller;
25
+ export declare function ChapterFootnoteCallerToJSON(json: any): ChapterFootnoteCaller;
26
+ export declare function ChapterFootnoteCallerToJSONTyped(value?: ChapterFootnoteCaller | null, ignoreDiscriminator?: boolean): any;
27
+ //# sourceMappingURL=ChapterFootnoteCaller.d.ts.map