free-use-bible-api 0.2.0 → 0.4.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/README.md +104 -5
- package/dist/cjs/FreeUseBibleApi.cjs +306 -2
- package/dist/cjs/FreeUseBibleApi.cjs.map +2 -2
- package/dist/cjs/types.gen.cjs.map +1 -1
- package/dist/esm/FreeUseBibleApi.js +306 -2
- package/dist/esm/FreeUseBibleApi.js.map +2 -2
- package/dist/types/FreeUseBibleApi.d.ts +238 -2
- package/dist/types/types.gen.d.ts +2095 -300
- package/package.json +2 -1
|
@@ -99,6 +99,10 @@ export type ApiTranslation = {
|
|
|
99
99
|
* 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.
|
|
100
100
|
*/
|
|
101
101
|
completeTranslationApiLink?: string;
|
|
102
|
+
/**
|
|
103
|
+
* The API link for downloading the complete translation as a single JSON file, using the simplified chapter format. Relative to the API origin. Undefined if complete translation files are not available.
|
|
104
|
+
*/
|
|
105
|
+
simpleCompleteTranslationApiLink?: string;
|
|
102
106
|
};
|
|
103
107
|
/**
|
|
104
108
|
* Defines an interface that contains information about the books that are available for a translation.
|
|
@@ -204,6 +208,12 @@ export type ApiTranslationBookChapter = {
|
|
|
204
208
|
* The links to different audio versions for the chapter.
|
|
205
209
|
*/
|
|
206
210
|
thisChapterAudioLinks: TranslationBookChapterAudioLinks;
|
|
211
|
+
/**
|
|
212
|
+
* The links to the audio timings for different audio versions for the chapter. Relative to the API origin.
|
|
213
|
+
*/
|
|
214
|
+
thisChapterAudioTimings: {
|
|
215
|
+
[key: string]: string;
|
|
216
|
+
};
|
|
207
217
|
/**
|
|
208
218
|
* The translation information for the book chapter.
|
|
209
219
|
*/
|
|
@@ -231,6 +241,18 @@ export type ApiTranslationBookChapter = {
|
|
|
231
241
|
nextChapterAudioLinks: {
|
|
232
242
|
[key: string]: string;
|
|
233
243
|
} | null;
|
|
244
|
+
/**
|
|
245
|
+
* The links to the audio timings for different audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
|
|
246
|
+
*/
|
|
247
|
+
nextChapterAudioTimings: {
|
|
248
|
+
[key: string]: string;
|
|
249
|
+
} | null;
|
|
250
|
+
/**
|
|
251
|
+
* The links to the audio timings for different audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
|
|
252
|
+
*/
|
|
253
|
+
previousChapterAudioTimings: {
|
|
254
|
+
[key: string]: string;
|
|
255
|
+
} | null;
|
|
234
256
|
/**
|
|
235
257
|
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
|
|
236
258
|
*/
|
|
@@ -245,10 +267,26 @@ export type ApiTranslationBookChapter = {
|
|
|
245
267
|
previousChapterAudioLinks: {
|
|
246
268
|
[key: string]: string;
|
|
247
269
|
} | null;
|
|
270
|
+
/**
|
|
271
|
+
* The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.
|
|
272
|
+
*/
|
|
273
|
+
thisChapterWordsLink?: string;
|
|
274
|
+
/**
|
|
275
|
+
* The link to the word-level annotations for the next chapter. Relative to the API origin. Omitted if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.
|
|
276
|
+
*/
|
|
277
|
+
nextChapterWordsLink?: string;
|
|
278
|
+
/**
|
|
279
|
+
* The link to the word-level annotations for the previous chapter. Relative to the API origin. Omitted if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.
|
|
280
|
+
*/
|
|
281
|
+
previousChapterWordsLink?: string;
|
|
248
282
|
/**
|
|
249
283
|
* The number of verses that the chapter contains.
|
|
250
284
|
*/
|
|
251
285
|
numberOfVerses: number;
|
|
286
|
+
/**
|
|
287
|
+
* The API link to the simplified version of this chapter. Relative to the API origin. Omitted if simplified chapters are not available.
|
|
288
|
+
*/
|
|
289
|
+
simpleChapterApiLink?: string;
|
|
252
290
|
};
|
|
253
291
|
/**
|
|
254
292
|
* 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.
|
|
@@ -374,583 +412,2076 @@ export type TranslationBookChapterAudioLinks = {
|
|
|
374
412
|
[key: string]: string;
|
|
375
413
|
};
|
|
376
414
|
/**
|
|
377
|
-
* Defines
|
|
415
|
+
* Defines an interface that contains information about a book chapter in a translation, using the simplified chapter format.
|
|
378
416
|
*/
|
|
379
|
-
export type
|
|
417
|
+
export type ApiSimpleTranslationBookChapter = {
|
|
380
418
|
/**
|
|
381
|
-
* The
|
|
419
|
+
* The links to different audio versions for the chapter.
|
|
420
|
+
*/
|
|
421
|
+
thisChapterAudioLinks: TranslationBookChapterAudioLinks;
|
|
422
|
+
/**
|
|
423
|
+
* The links to the audio timings for different audio versions for the chapter. Relative to the API origin.
|
|
424
|
+
*/
|
|
425
|
+
thisChapterAudioTimings: {
|
|
426
|
+
[key: string]: string;
|
|
427
|
+
};
|
|
428
|
+
/**
|
|
429
|
+
* The translation information for the book chapter.
|
|
382
430
|
*/
|
|
383
431
|
translation: ApiTranslation;
|
|
384
432
|
/**
|
|
385
|
-
* The
|
|
433
|
+
* The book information for the book chapter.
|
|
386
434
|
*/
|
|
387
|
-
|
|
388
|
-
};
|
|
389
|
-
/**
|
|
390
|
-
* A book in the complete translation download.
|
|
391
|
-
*/
|
|
392
|
-
export type ApiTranslationCompleteBook = {
|
|
393
|
-
id: BookId;
|
|
435
|
+
book: ApiTranslationBook;
|
|
394
436
|
/**
|
|
395
|
-
* The
|
|
437
|
+
* The API link for this chapter. Relative to the API origin.
|
|
396
438
|
*/
|
|
397
|
-
|
|
439
|
+
thisChapterLink: string;
|
|
440
|
+
thisChapterReference: TranslationChapterReference;
|
|
398
441
|
/**
|
|
399
|
-
* The
|
|
442
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
|
|
400
443
|
*/
|
|
401
|
-
|
|
444
|
+
nextChapterApiLink: string | null;
|
|
402
445
|
/**
|
|
403
|
-
* The
|
|
446
|
+
* The reference for the next chapter. Null if this is the last chapter in the translation.
|
|
404
447
|
*/
|
|
405
|
-
|
|
448
|
+
nextChapterReference: TranslationChapterReference | null;
|
|
406
449
|
/**
|
|
407
|
-
* The
|
|
450
|
+
* 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.
|
|
408
451
|
*/
|
|
409
|
-
|
|
452
|
+
nextChapterAudioLinks: {
|
|
453
|
+
[key: string]: string;
|
|
454
|
+
} | null;
|
|
410
455
|
/**
|
|
411
|
-
*
|
|
456
|
+
* The links to the audio timings for different audio versions for the next chapter. Relative to the API origin. Null if this is the last chapter in the translation.
|
|
412
457
|
*/
|
|
413
|
-
|
|
458
|
+
nextChapterAudioTimings: {
|
|
459
|
+
[key: string]: string;
|
|
460
|
+
} | null;
|
|
414
461
|
/**
|
|
415
|
-
* The
|
|
462
|
+
* The links to the audio timings for different audio versions for the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
|
|
416
463
|
*/
|
|
417
|
-
|
|
464
|
+
previousChapterAudioTimings: {
|
|
465
|
+
[key: string]: string;
|
|
466
|
+
} | null;
|
|
418
467
|
/**
|
|
419
|
-
* The
|
|
468
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the translation.
|
|
420
469
|
*/
|
|
421
|
-
|
|
470
|
+
previousChapterApiLink: string | null;
|
|
422
471
|
/**
|
|
423
|
-
* The
|
|
472
|
+
* The reference for the previous chapter. Null if this is the first chapter in the translation.
|
|
473
|
+
*/
|
|
474
|
+
previousChapterReference: TranslationChapterReference | null;
|
|
475
|
+
/**
|
|
476
|
+
* 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.
|
|
477
|
+
*/
|
|
478
|
+
previousChapterAudioLinks: {
|
|
479
|
+
[key: string]: string;
|
|
480
|
+
} | null;
|
|
481
|
+
/**
|
|
482
|
+
* The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.
|
|
483
|
+
*/
|
|
484
|
+
thisChapterWordsLink?: string;
|
|
485
|
+
/**
|
|
486
|
+
* The link to the word-level annotations for the next chapter. Relative to the API origin. Omitted if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.
|
|
487
|
+
*/
|
|
488
|
+
nextChapterWordsLink?: string;
|
|
489
|
+
/**
|
|
490
|
+
* The link to the word-level annotations for the previous chapter. Relative to the API origin. Omitted if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.
|
|
491
|
+
*/
|
|
492
|
+
previousChapterWordsLink?: string;
|
|
493
|
+
/**
|
|
494
|
+
* The number of verses that the chapter contains.
|
|
495
|
+
*/
|
|
496
|
+
numberOfVerses: number;
|
|
497
|
+
/**
|
|
498
|
+
* The simplified information for the chapter. Each verse contains a single text string, and the footnotes and formatting are represented by offsets into that string.
|
|
424
499
|
*/
|
|
425
|
-
|
|
500
|
+
chapter: SimpleChapterData;
|
|
501
|
+
/**
|
|
502
|
+
* The API link to the regular (non-simplified) version of this chapter. Relative to the API origin.
|
|
503
|
+
*/
|
|
504
|
+
fullChapterApiLink: string;
|
|
426
505
|
};
|
|
427
506
|
/**
|
|
428
|
-
* Defines the schema for
|
|
507
|
+
* Defines the schema for the data in a simplified chapter. Unlike the regular chapter format, each verse contains a single text string and the footnotes/formatting are represented by offsets into that string.
|
|
429
508
|
*/
|
|
430
|
-
export type
|
|
509
|
+
export type SimpleChapterData = {
|
|
431
510
|
/**
|
|
432
|
-
* The
|
|
511
|
+
* The number of the chapter.
|
|
433
512
|
*/
|
|
434
|
-
|
|
435
|
-
/**
|
|
436
|
-
* The number of the chapter.
|
|
437
|
-
*/
|
|
438
|
-
number: number;
|
|
439
|
-
/**
|
|
440
|
-
* The content of the chapter.
|
|
441
|
-
*/
|
|
442
|
-
content: Array<ChapterContent>;
|
|
443
|
-
/**
|
|
444
|
-
* The list of footnotes for the chapter.
|
|
445
|
-
*/
|
|
446
|
-
footnotes: Array<ChapterFootnote>;
|
|
447
|
-
};
|
|
513
|
+
number: number;
|
|
448
514
|
/**
|
|
449
|
-
* The
|
|
515
|
+
* The content of the chapter.
|
|
450
516
|
*/
|
|
451
|
-
|
|
517
|
+
content: Array<SimpleChapterContent>;
|
|
518
|
+
/**
|
|
519
|
+
* The list of footnotes that could not be associated with a verse. Footnotes that belong to a verse are included on the verse itself, so this list is usually empty.
|
|
520
|
+
*/
|
|
521
|
+
footnotes: Array<ChapterFootnote>;
|
|
452
522
|
};
|
|
453
523
|
/**
|
|
454
|
-
*
|
|
524
|
+
* Defines a union type that represents a single piece of content in a simplified chapter. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle.
|
|
455
525
|
*/
|
|
456
|
-
export type
|
|
526
|
+
export type SimpleChapterContent = ({
|
|
527
|
+
type: 'heading';
|
|
528
|
+
} & SimpleChapterHeading) | ({
|
|
529
|
+
type: 'line_break';
|
|
530
|
+
} & ChapterLineBreak) | ({
|
|
531
|
+
type: 'verse';
|
|
532
|
+
} & SimpleChapterVerse) | ({
|
|
533
|
+
type: 'hebrew_subtitle';
|
|
534
|
+
} & SimpleChapterHebrewSubtitle);
|
|
535
|
+
/**
|
|
536
|
+
* Defines the schema for a heading in a simplified chapter.
|
|
537
|
+
*/
|
|
538
|
+
export type SimpleChapterHeading = {
|
|
539
|
+
type: 'heading';
|
|
457
540
|
/**
|
|
458
|
-
* The
|
|
541
|
+
* The text of the heading.
|
|
459
542
|
*/
|
|
460
|
-
|
|
543
|
+
text: string;
|
|
461
544
|
};
|
|
462
545
|
/**
|
|
463
|
-
* Defines
|
|
546
|
+
* Defines the schema for a verse in a simplified chapter.
|
|
464
547
|
*/
|
|
465
|
-
export type
|
|
548
|
+
export type SimpleChapterVerse = {
|
|
549
|
+
type: 'verse';
|
|
466
550
|
/**
|
|
467
|
-
* The
|
|
551
|
+
* The number of the verse.
|
|
468
552
|
*/
|
|
469
|
-
|
|
553
|
+
number: number;
|
|
470
554
|
/**
|
|
471
|
-
* The
|
|
555
|
+
* The text of the verse. Lines of poetry and line breaks are separated by newline (\n) characters.
|
|
472
556
|
*/
|
|
473
|
-
|
|
557
|
+
text: string;
|
|
474
558
|
/**
|
|
475
|
-
* The
|
|
559
|
+
* The footnotes that occur in the verse.
|
|
476
560
|
*/
|
|
477
|
-
|
|
561
|
+
footnotes: Array<SimpleVerseFootnote>;
|
|
478
562
|
/**
|
|
479
|
-
* The
|
|
563
|
+
* The headings that occur in the middle of the verse. Omitted if the verse contains no inline headings.
|
|
480
564
|
*/
|
|
481
|
-
|
|
565
|
+
headings?: Array<SimpleInlineHeading>;
|
|
482
566
|
/**
|
|
483
|
-
* The
|
|
567
|
+
* The ranges of the verse text that represent the Words of Jesus. Omitted if the verse contains none.
|
|
484
568
|
*/
|
|
485
|
-
|
|
569
|
+
wordsOfJesus?: Array<SimpleTextRange>;
|
|
486
570
|
/**
|
|
487
|
-
* The
|
|
571
|
+
* The ranges of the verse text that represent lines of poetry. Omitted if the verse contains none.
|
|
488
572
|
*/
|
|
489
|
-
|
|
573
|
+
poem?: Array<SimplePoemRange>;
|
|
574
|
+
};
|
|
575
|
+
/**
|
|
576
|
+
* Defines the schema for a footnote in a simplified verse. Unlike the footnotes in the regular chapter format, simplified footnotes include the position that they occur at in the verse text.
|
|
577
|
+
*/
|
|
578
|
+
export type SimpleVerseFootnote = {
|
|
490
579
|
/**
|
|
491
|
-
* The
|
|
580
|
+
* The ID of the note.
|
|
492
581
|
*/
|
|
493
|
-
|
|
582
|
+
noteId: number;
|
|
494
583
|
/**
|
|
495
|
-
* The
|
|
584
|
+
* The index in the verse text that the footnote caller should be inserted at. Measured in UTF-16 code units.
|
|
496
585
|
*/
|
|
497
|
-
|
|
586
|
+
offset: number;
|
|
498
587
|
/**
|
|
499
|
-
* The
|
|
588
|
+
* The text of the footnote.
|
|
500
589
|
*/
|
|
501
|
-
|
|
590
|
+
text: string;
|
|
502
591
|
/**
|
|
503
|
-
* The
|
|
592
|
+
* The caller that should be used for the footnote. 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.
|
|
504
593
|
*/
|
|
505
|
-
|
|
506
|
-
|
|
594
|
+
caller: '+' | string | null;
|
|
595
|
+
};
|
|
596
|
+
/**
|
|
597
|
+
* Defines the schema for a heading that is embedded in a simplified verse.
|
|
598
|
+
*/
|
|
599
|
+
export type SimpleInlineHeading = {
|
|
507
600
|
/**
|
|
508
|
-
* The
|
|
601
|
+
* The index in the verse text that the heading occurs at. Measured in UTF-16 code units.
|
|
509
602
|
*/
|
|
510
|
-
|
|
603
|
+
offset: number;
|
|
511
604
|
/**
|
|
512
|
-
* The
|
|
605
|
+
* The text of the heading.
|
|
513
606
|
*/
|
|
514
|
-
|
|
607
|
+
text: string;
|
|
608
|
+
};
|
|
609
|
+
/**
|
|
610
|
+
* Defines the schema for a range of text inside a simplified verse. Ranges are expressed as offsets into the text of the verse that contains them, measured in UTF-16 code units.
|
|
611
|
+
*/
|
|
612
|
+
export type SimpleTextRange = {
|
|
515
613
|
/**
|
|
516
|
-
* The
|
|
614
|
+
* The index of the first character of the range in the verse text. Measured in UTF-16 code units.
|
|
517
615
|
*/
|
|
518
|
-
|
|
616
|
+
start: number;
|
|
519
617
|
/**
|
|
520
|
-
* The
|
|
618
|
+
* The index after the last character of the range in the verse text. Measured in UTF-16 code units.
|
|
521
619
|
*/
|
|
522
|
-
|
|
620
|
+
end: number;
|
|
621
|
+
};
|
|
622
|
+
/**
|
|
623
|
+
* Defines the schema for a range of text inside a simplified verse that represents a line of poetry.
|
|
624
|
+
*/
|
|
625
|
+
export type SimplePoemRange = {
|
|
523
626
|
/**
|
|
524
|
-
*
|
|
627
|
+
* The index of the first character of the range in the verse text. Measured in UTF-16 code units.
|
|
525
628
|
*/
|
|
526
|
-
|
|
629
|
+
start: number;
|
|
527
630
|
/**
|
|
528
|
-
*
|
|
631
|
+
* The index after the last character of the range in the verse text. Measured in UTF-16 code units.
|
|
529
632
|
*/
|
|
530
|
-
|
|
633
|
+
end: number;
|
|
634
|
+
/**
|
|
635
|
+
* The level of indent that the line of poetry should be displayed with.
|
|
636
|
+
*/
|
|
637
|
+
level: number;
|
|
531
638
|
};
|
|
532
639
|
/**
|
|
533
|
-
* Defines
|
|
640
|
+
* Defines the schema for a Hebrew Subtitle in a simplified chapter.
|
|
534
641
|
*/
|
|
535
|
-
export type
|
|
642
|
+
export type SimpleChapterHebrewSubtitle = {
|
|
536
643
|
/**
|
|
537
|
-
* The
|
|
644
|
+
* The text of the verse. Lines of poetry and line breaks are separated by newline (\n) characters.
|
|
538
645
|
*/
|
|
539
|
-
|
|
646
|
+
text: string;
|
|
540
647
|
/**
|
|
541
|
-
* The
|
|
648
|
+
* The footnotes that occur in the verse.
|
|
542
649
|
*/
|
|
543
|
-
|
|
544
|
-
};
|
|
545
|
-
/**
|
|
546
|
-
* Defines a schema that contains information about a commentary book.
|
|
547
|
-
*/
|
|
548
|
-
export type ApiCommentaryBook = {
|
|
549
|
-
id: BookId;
|
|
650
|
+
footnotes: Array<SimpleVerseFootnote>;
|
|
550
651
|
/**
|
|
551
|
-
* The
|
|
652
|
+
* The headings that occur in the middle of the verse. Omitted if the verse contains no inline headings.
|
|
552
653
|
*/
|
|
553
|
-
|
|
654
|
+
headings?: Array<SimpleInlineHeading>;
|
|
554
655
|
/**
|
|
555
|
-
* The
|
|
656
|
+
* The ranges of the verse text that represent the Words of Jesus. Omitted if the verse contains none.
|
|
556
657
|
*/
|
|
557
|
-
|
|
658
|
+
wordsOfJesus?: Array<SimpleTextRange>;
|
|
558
659
|
/**
|
|
559
|
-
* The
|
|
660
|
+
* The ranges of the verse text that represent lines of poetry. Omitted if the verse contains none.
|
|
560
661
|
*/
|
|
561
|
-
|
|
662
|
+
poem?: Array<SimplePoemRange>;
|
|
663
|
+
type: 'hebrew_subtitle';
|
|
664
|
+
};
|
|
665
|
+
/**
|
|
666
|
+
* Defines an interface that contains the audio timings for a book chapter, for a specific reader.
|
|
667
|
+
*/
|
|
668
|
+
export type ApiTranslationBookChapterAudioTimings = {
|
|
562
669
|
/**
|
|
563
|
-
* The
|
|
670
|
+
* The ID of the translation.
|
|
564
671
|
*/
|
|
565
|
-
|
|
672
|
+
translationId: string;
|
|
566
673
|
/**
|
|
567
|
-
* The
|
|
674
|
+
* The ID of the book.
|
|
568
675
|
*/
|
|
569
|
-
|
|
676
|
+
bookId: string;
|
|
570
677
|
/**
|
|
571
|
-
* The number of the
|
|
678
|
+
* The number of the chapter.
|
|
572
679
|
*/
|
|
573
|
-
|
|
680
|
+
chapterNumber: number;
|
|
574
681
|
/**
|
|
575
|
-
* The
|
|
682
|
+
* The reader for the chapter.
|
|
576
683
|
*/
|
|
577
|
-
|
|
684
|
+
reader: string;
|
|
578
685
|
/**
|
|
579
|
-
* The
|
|
686
|
+
* The link to the audio for these timings.
|
|
580
687
|
*/
|
|
581
|
-
|
|
688
|
+
audioLink: string;
|
|
582
689
|
/**
|
|
583
|
-
* The
|
|
690
|
+
* The link to the information for this chapter.
|
|
584
691
|
*/
|
|
585
|
-
|
|
692
|
+
thisChapterLink: string;
|
|
586
693
|
/**
|
|
587
|
-
* The link to the
|
|
694
|
+
* The link to the information for the next chapter. Null if this is the last chapter in the translation.
|
|
588
695
|
*/
|
|
589
|
-
|
|
696
|
+
nextChapterLink: string | null;
|
|
590
697
|
/**
|
|
591
|
-
* The
|
|
698
|
+
* The link to the information for the previous chapter. Null if this is the first chapter in the translation.
|
|
592
699
|
*/
|
|
593
|
-
|
|
700
|
+
previousChapterLink: string | null;
|
|
594
701
|
/**
|
|
595
|
-
* The
|
|
702
|
+
* The link to this audio timings file.
|
|
596
703
|
*/
|
|
597
|
-
|
|
704
|
+
thisChapterAudioTimingsLink: string;
|
|
598
705
|
/**
|
|
599
|
-
* The
|
|
706
|
+
* The link to the timings for the next chapter. Null if this is the last chapter in the translation.
|
|
600
707
|
*/
|
|
601
|
-
|
|
602
|
-
};
|
|
603
|
-
/**
|
|
604
|
-
* Defines a reference to a chapter in a commentary.
|
|
605
|
-
*/
|
|
606
|
-
export type CommentaryChapterReference = {
|
|
708
|
+
nextChapterAudioTimingsLink: string | null;
|
|
607
709
|
/**
|
|
608
|
-
* The
|
|
710
|
+
* The link to the timings for the previous chapter. Null if this is the first chapter in the translation.
|
|
609
711
|
*/
|
|
610
|
-
|
|
611
|
-
book: BookId;
|
|
712
|
+
previousChapterAudioTimingsLink: string | null;
|
|
612
713
|
/**
|
|
613
|
-
* The
|
|
714
|
+
* The times in seconds at which each verse starts, in order. The first number (index 0) is the time in the recording at which the first verse starts.
|
|
614
715
|
*/
|
|
615
|
-
|
|
716
|
+
verses: Array<number>;
|
|
616
717
|
};
|
|
617
718
|
/**
|
|
618
|
-
* Defines
|
|
719
|
+
* Defines an interface that contains the word-level annotations for a book chapter.
|
|
619
720
|
*/
|
|
620
|
-
export type
|
|
721
|
+
export type ApiTranslationBookChapterWords = {
|
|
621
722
|
/**
|
|
622
|
-
* The
|
|
723
|
+
* The ID of the translation.
|
|
623
724
|
*/
|
|
624
|
-
|
|
725
|
+
translationId: string;
|
|
726
|
+
/**
|
|
727
|
+
* The ID of the book.
|
|
728
|
+
*/
|
|
729
|
+
bookId: string;
|
|
730
|
+
/**
|
|
731
|
+
* The number of the chapter.
|
|
732
|
+
*/
|
|
733
|
+
chapterNumber: number;
|
|
734
|
+
/**
|
|
735
|
+
* The link to the information for this chapter.
|
|
736
|
+
*/
|
|
737
|
+
thisChapterLink: string;
|
|
738
|
+
/**
|
|
739
|
+
* The link to the information for the next chapter. Null if this is the last chapter in the translation.
|
|
740
|
+
*/
|
|
741
|
+
nextChapterLink: string | null;
|
|
742
|
+
/**
|
|
743
|
+
* The link to the information for the previous chapter. Null if this is the first chapter in the translation.
|
|
744
|
+
*/
|
|
745
|
+
previousChapterLink: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* The link to this words file.
|
|
748
|
+
*/
|
|
749
|
+
thisChapterWordsLink: string;
|
|
750
|
+
/**
|
|
751
|
+
* The link to the words for the next chapter. Null if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.
|
|
752
|
+
*/
|
|
753
|
+
nextChapterWordsLink: string | null;
|
|
754
|
+
/**
|
|
755
|
+
* The link to the words for the previous chapter. Null if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.
|
|
756
|
+
*/
|
|
757
|
+
previousChapterWordsLink: string | null;
|
|
758
|
+
/**
|
|
759
|
+
* The annotated words for each verse in the chapter, keyed by verse number. Each list is in the order that the words occur in the verse.
|
|
760
|
+
*/
|
|
761
|
+
verses: {
|
|
762
|
+
[key: string]: Array<ChapterWord>;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* Defines the schema for a word-level annotation in a chapter. The annotation is anchored to a range of characters in a single item of a verse's content.
|
|
767
|
+
*/
|
|
768
|
+
export type ChapterWord = {
|
|
769
|
+
/**
|
|
770
|
+
* The index of the item in the verse's content array that the annotation applies to.
|
|
771
|
+
*/
|
|
772
|
+
contentIndex: number;
|
|
773
|
+
/**
|
|
774
|
+
* The index of the first character of the annotated word in the content item's text.
|
|
775
|
+
*/
|
|
776
|
+
start: number;
|
|
777
|
+
/**
|
|
778
|
+
* The index after the last character of the annotated word in the content item's text. That is, text.slice(start, end) is the annotated word.
|
|
779
|
+
*/
|
|
780
|
+
end: number;
|
|
781
|
+
/**
|
|
782
|
+
* The Strong's number(s) for the word. Omitted if the translation only provided other annotations for the word.
|
|
783
|
+
*/
|
|
784
|
+
strongs?: Array<string>;
|
|
785
|
+
/**
|
|
786
|
+
* The dictionary (citation) form of the word. Omitted if the translation did not provide one.
|
|
787
|
+
*/
|
|
788
|
+
lemma?: string;
|
|
789
|
+
/**
|
|
790
|
+
* The morphology parse code for the word. Omitted if the translation did not provide one.
|
|
791
|
+
*/
|
|
792
|
+
morph?: string;
|
|
793
|
+
/**
|
|
794
|
+
* The pointer to the word in the source text, in the <sourceName>:<location> format. Omitted if the translation did not provide one.
|
|
795
|
+
*/
|
|
796
|
+
srcloc?: string;
|
|
797
|
+
/**
|
|
798
|
+
* Which occurrence of the source word this word is. 1-based. Omitted if the translation did not provide one.
|
|
799
|
+
*/
|
|
800
|
+
occurrence?: number;
|
|
801
|
+
/**
|
|
802
|
+
* The total number of times that the source word occurs. Omitted if the translation did not provide one.
|
|
803
|
+
*/
|
|
804
|
+
occurrences?: number;
|
|
805
|
+
};
|
|
806
|
+
/**
|
|
807
|
+
* Defines an interface that contains the word-level annotations for a book chapter, with their offsets remapped onto the text of each simplified verse.
|
|
808
|
+
*/
|
|
809
|
+
export type ApiSimpleTranslationBookChapterWords = {
|
|
810
|
+
/**
|
|
811
|
+
* The ID of the translation.
|
|
812
|
+
*/
|
|
813
|
+
translationId: string;
|
|
814
|
+
/**
|
|
815
|
+
* The ID of the book.
|
|
816
|
+
*/
|
|
817
|
+
bookId: string;
|
|
818
|
+
/**
|
|
819
|
+
* The number of the chapter.
|
|
820
|
+
*/
|
|
821
|
+
chapterNumber: number;
|
|
822
|
+
/**
|
|
823
|
+
* The link to the information for this chapter.
|
|
824
|
+
*/
|
|
825
|
+
thisChapterLink: string;
|
|
826
|
+
/**
|
|
827
|
+
* The link to the information for the next chapter. Null if this is the last chapter in the translation.
|
|
828
|
+
*/
|
|
829
|
+
nextChapterLink: string | null;
|
|
830
|
+
/**
|
|
831
|
+
* The link to the information for the previous chapter. Null if this is the first chapter in the translation.
|
|
832
|
+
*/
|
|
833
|
+
previousChapterLink: string | null;
|
|
834
|
+
/**
|
|
835
|
+
* The link to this words file.
|
|
836
|
+
*/
|
|
837
|
+
thisChapterWordsLink: string;
|
|
838
|
+
/**
|
|
839
|
+
* The link to the words for the next chapter. Null if this is the last chapter in the translation, or if the next chapter doesn't have any word-level annotations.
|
|
840
|
+
*/
|
|
841
|
+
nextChapterWordsLink: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* The link to the words for the previous chapter. Null if this is the first chapter in the translation, or if the previous chapter doesn't have any word-level annotations.
|
|
844
|
+
*/
|
|
845
|
+
previousChapterWordsLink: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* The annotated words for each verse in the chapter, keyed by verse number. Each list is in the order that the words occur in the verse. The offsets are into the text of the simplified verse.
|
|
848
|
+
*/
|
|
849
|
+
verses: {
|
|
850
|
+
[key: string]: Array<SimpleChapterWord>;
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
/**
|
|
854
|
+
* Defines the schema for a word-level annotation in a simplified chapter. The annotation is anchored to a range of characters in the verse's text.
|
|
855
|
+
*/
|
|
856
|
+
export type SimpleChapterWord = {
|
|
857
|
+
/**
|
|
858
|
+
* The index of the first character of the annotated word in the content item's text.
|
|
859
|
+
*/
|
|
860
|
+
start: number;
|
|
861
|
+
/**
|
|
862
|
+
* The index after the last character of the annotated word in the content item's text. That is, text.slice(start, end) is the annotated word.
|
|
863
|
+
*/
|
|
864
|
+
end: number;
|
|
865
|
+
/**
|
|
866
|
+
* The Strong's number(s) for the word. Omitted if the translation only provided other annotations for the word.
|
|
867
|
+
*/
|
|
868
|
+
strongs?: Array<string>;
|
|
869
|
+
/**
|
|
870
|
+
* The dictionary (citation) form of the word. Omitted if the translation did not provide one.
|
|
871
|
+
*/
|
|
872
|
+
lemma?: string;
|
|
873
|
+
/**
|
|
874
|
+
* The morphology parse code for the word. Omitted if the translation did not provide one.
|
|
875
|
+
*/
|
|
876
|
+
morph?: string;
|
|
877
|
+
/**
|
|
878
|
+
* The pointer to the word in the source text, in the <sourceName>:<location> format. Omitted if the translation did not provide one.
|
|
879
|
+
*/
|
|
880
|
+
srcloc?: string;
|
|
881
|
+
/**
|
|
882
|
+
* Which occurrence of the source word this word is. 1-based. Omitted if the translation did not provide one.
|
|
883
|
+
*/
|
|
884
|
+
occurrence?: number;
|
|
885
|
+
/**
|
|
886
|
+
* The total number of times that the source word occurs. Omitted if the translation did not provide one.
|
|
887
|
+
*/
|
|
888
|
+
occurrences?: number;
|
|
889
|
+
};
|
|
890
|
+
/**
|
|
891
|
+
* Defines the complete translation download data. Maps to the /api/:translationId/complete.json endpoint.
|
|
892
|
+
*/
|
|
893
|
+
export type ApiTranslationComplete = {
|
|
894
|
+
/**
|
|
895
|
+
* The translation metadata.
|
|
896
|
+
*/
|
|
897
|
+
translation: ApiTranslation;
|
|
898
|
+
/**
|
|
899
|
+
* The complete list of books with all their chapters.
|
|
900
|
+
*/
|
|
901
|
+
books: Array<ApiTranslationCompleteBook>;
|
|
902
|
+
};
|
|
903
|
+
/**
|
|
904
|
+
* A book in the complete translation download.
|
|
905
|
+
*/
|
|
906
|
+
export type ApiTranslationCompleteBook = {
|
|
907
|
+
id: BookId;
|
|
908
|
+
/**
|
|
909
|
+
* The name that the translation provided for the book.
|
|
910
|
+
*/
|
|
911
|
+
name: string;
|
|
912
|
+
/**
|
|
913
|
+
* The common name for the book.
|
|
914
|
+
*/
|
|
915
|
+
commonName: string;
|
|
916
|
+
/**
|
|
917
|
+
* 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.
|
|
918
|
+
*/
|
|
919
|
+
title: string | null;
|
|
920
|
+
/**
|
|
921
|
+
* The numerical order of the book in the translation.
|
|
922
|
+
*/
|
|
923
|
+
order: number;
|
|
924
|
+
/**
|
|
925
|
+
* Whether the book is an apocryphal book.
|
|
926
|
+
*/
|
|
927
|
+
isApocryphal?: boolean;
|
|
928
|
+
/**
|
|
929
|
+
* The number of chapters in the book.
|
|
930
|
+
*/
|
|
931
|
+
numberOfChapters: number;
|
|
932
|
+
/**
|
|
933
|
+
* The total number of verses in the book.
|
|
934
|
+
*/
|
|
935
|
+
totalNumberOfVerses: number;
|
|
936
|
+
/**
|
|
937
|
+
* The complete list of chapters with all content.
|
|
938
|
+
*/
|
|
939
|
+
chapters: Array<TranslationCompleteChapter>;
|
|
940
|
+
};
|
|
941
|
+
/**
|
|
942
|
+
* A chapter in the complete translation download.
|
|
943
|
+
*/
|
|
944
|
+
export type TranslationCompleteChapter = {
|
|
945
|
+
/**
|
|
946
|
+
* The information for the chapter.
|
|
947
|
+
*/
|
|
948
|
+
chapter: {
|
|
625
949
|
/**
|
|
626
950
|
* The number of the chapter.
|
|
627
951
|
*/
|
|
628
952
|
number: number;
|
|
629
953
|
/**
|
|
630
|
-
* The
|
|
954
|
+
* The content of the chapter.
|
|
631
955
|
*/
|
|
632
|
-
|
|
956
|
+
content: Array<ChapterContent>;
|
|
633
957
|
/**
|
|
634
|
-
* The
|
|
958
|
+
* The list of footnotes for the chapter.
|
|
635
959
|
*/
|
|
636
|
-
|
|
960
|
+
footnotes: Array<ChapterFootnote>;
|
|
637
961
|
};
|
|
638
962
|
/**
|
|
639
|
-
* The
|
|
963
|
+
* The links to different audio versions for the chapter.
|
|
964
|
+
*/
|
|
965
|
+
thisChapterAudioLinks: TranslationBookChapterAudioLinks;
|
|
966
|
+
/**
|
|
967
|
+
* The audio timings (per-verse start times, in seconds) for different audio versions for the chapter.
|
|
968
|
+
*/
|
|
969
|
+
thisChapterAudioTimings: TranslationBookChapterAudioTimings;
|
|
970
|
+
/**
|
|
971
|
+
* The number of verses that the chapter contains.
|
|
972
|
+
*/
|
|
973
|
+
numberOfVerses: number;
|
|
974
|
+
/**
|
|
975
|
+
* The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.
|
|
976
|
+
*/
|
|
977
|
+
thisChapterWordsLink?: string;
|
|
978
|
+
};
|
|
979
|
+
/**
|
|
980
|
+
* Defines the schema for the audio timings for a book chapter. Maps a reader ID to the list of times (in seconds) that each verse starts, in verse order.
|
|
981
|
+
*/
|
|
982
|
+
export type TranslationBookChapterAudioTimings = {
|
|
983
|
+
[key: string]: Array<number>;
|
|
984
|
+
};
|
|
985
|
+
/**
|
|
986
|
+
* Defines the complete translation download data, using the simplified chapter format. Maps to the /api/:translationId/complete.simple.json endpoint.
|
|
987
|
+
*/
|
|
988
|
+
export type ApiSimpleTranslationComplete = {
|
|
989
|
+
/**
|
|
990
|
+
* The translation metadata.
|
|
991
|
+
*/
|
|
992
|
+
translation: ApiTranslation;
|
|
993
|
+
/**
|
|
994
|
+
* The complete list of books with all their chapters.
|
|
995
|
+
*/
|
|
996
|
+
books: Array<ApiSimpleTranslationCompleteBook>;
|
|
997
|
+
};
|
|
998
|
+
/**
|
|
999
|
+
* A book in the complete translation download, using the simplified chapter format.
|
|
1000
|
+
*/
|
|
1001
|
+
export type ApiSimpleTranslationCompleteBook = {
|
|
1002
|
+
id: BookId;
|
|
1003
|
+
/**
|
|
1004
|
+
* The name that the translation provided for the book.
|
|
1005
|
+
*/
|
|
1006
|
+
name: string;
|
|
1007
|
+
/**
|
|
1008
|
+
* The common name for the book.
|
|
1009
|
+
*/
|
|
1010
|
+
commonName: string;
|
|
1011
|
+
/**
|
|
1012
|
+
* 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.
|
|
1013
|
+
*/
|
|
1014
|
+
title: string | null;
|
|
1015
|
+
/**
|
|
1016
|
+
* The numerical order of the book in the translation.
|
|
1017
|
+
*/
|
|
1018
|
+
order: number;
|
|
1019
|
+
/**
|
|
1020
|
+
* Whether the book is an apocryphal book.
|
|
1021
|
+
*/
|
|
1022
|
+
isApocryphal?: boolean;
|
|
1023
|
+
/**
|
|
1024
|
+
* The number of chapters in the book.
|
|
1025
|
+
*/
|
|
1026
|
+
numberOfChapters: number;
|
|
1027
|
+
/**
|
|
1028
|
+
* The total number of verses in the book.
|
|
1029
|
+
*/
|
|
1030
|
+
totalNumberOfVerses: number;
|
|
1031
|
+
/**
|
|
1032
|
+
* The complete list of chapters with all content.
|
|
1033
|
+
*/
|
|
1034
|
+
chapters: Array<SimpleTranslationCompleteChapter>;
|
|
1035
|
+
};
|
|
1036
|
+
/**
|
|
1037
|
+
* A chapter in the complete translation download, using the simplified chapter format.
|
|
1038
|
+
*/
|
|
1039
|
+
export type SimpleTranslationCompleteChapter = {
|
|
1040
|
+
/**
|
|
1041
|
+
* The simplified information for the chapter.
|
|
1042
|
+
*/
|
|
1043
|
+
chapter: SimpleChapterData;
|
|
1044
|
+
/**
|
|
1045
|
+
* The links to different audio versions for the chapter.
|
|
1046
|
+
*/
|
|
1047
|
+
thisChapterAudioLinks: TranslationBookChapterAudioLinks;
|
|
1048
|
+
/**
|
|
1049
|
+
* The audio timings (per-verse start times, in seconds) for different audio versions for the chapter.
|
|
1050
|
+
*/
|
|
1051
|
+
thisChapterAudioTimings: TranslationBookChapterAudioTimings;
|
|
1052
|
+
/**
|
|
1053
|
+
* The number of verses that the chapter contains.
|
|
1054
|
+
*/
|
|
1055
|
+
numberOfVerses: number;
|
|
1056
|
+
/**
|
|
1057
|
+
* The link to the word-level annotations for this chapter. Relative to the API origin. Omitted if the chapter doesn't have any word-level annotations.
|
|
1058
|
+
*/
|
|
1059
|
+
thisChapterWordsLink?: string;
|
|
1060
|
+
};
|
|
1061
|
+
/**
|
|
1062
|
+
* The list of available commentaries. Maps to the /api/available-commentaries.json endpoint.
|
|
1063
|
+
*/
|
|
1064
|
+
export type ApiAvailableCommentaries = {
|
|
1065
|
+
/**
|
|
1066
|
+
* The list of commentaries that are available in the API.
|
|
1067
|
+
*/
|
|
1068
|
+
commentaries: Array<ApiCommentary>;
|
|
1069
|
+
};
|
|
1070
|
+
/**
|
|
1071
|
+
* Defines a commentary that is used in the API.
|
|
1072
|
+
*/
|
|
1073
|
+
export type ApiCommentary = {
|
|
1074
|
+
/**
|
|
1075
|
+
* The ID of the commentary.
|
|
1076
|
+
*/
|
|
1077
|
+
id: string;
|
|
1078
|
+
/**
|
|
1079
|
+
* The name of the commentary.
|
|
1080
|
+
*/
|
|
1081
|
+
name: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* The website for the commentary.
|
|
1084
|
+
*/
|
|
1085
|
+
website: string;
|
|
1086
|
+
/**
|
|
1087
|
+
* The URL that the license for the commentary can be found.
|
|
1088
|
+
*/
|
|
1089
|
+
licenseUrl: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* The API-added notes for the license.
|
|
1092
|
+
*/
|
|
1093
|
+
licenseNotes?: string | null;
|
|
1094
|
+
/**
|
|
1095
|
+
* The English name for the commentary.
|
|
1096
|
+
*/
|
|
1097
|
+
englishName: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* The ISO 639 3-letter language tag that the translation is primarily in.
|
|
1100
|
+
*/
|
|
1101
|
+
language: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* 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.
|
|
1104
|
+
*/
|
|
1105
|
+
textDirection: 'ltr' | 'rtl';
|
|
1106
|
+
/**
|
|
1107
|
+
* The API link for the list of books for this commentary. Relative to the API origin.
|
|
1108
|
+
*/
|
|
1109
|
+
listOfBooksApiLink: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* The API link for the list of profiles for this commentary. Relative to the API origin.
|
|
1112
|
+
*/
|
|
1113
|
+
listOfProfilesApiLink: string;
|
|
1114
|
+
availableFormats: Array<'json' | 'usfm'>;
|
|
1115
|
+
/**
|
|
1116
|
+
* The number of books that are contained in this commentary. Complete commentaries should have the same number of books as the Bible (66).
|
|
1117
|
+
*/
|
|
1118
|
+
numberOfBooks: number;
|
|
1119
|
+
/**
|
|
1120
|
+
* The total number of chapters that are contained in this commentary. Complete commentaries should have the same number of chapters as the Bible (1,189).
|
|
1121
|
+
*/
|
|
1122
|
+
totalNumberOfChapters: number;
|
|
1123
|
+
/**
|
|
1124
|
+
* The total number of verses that are contained in this commentary. Complete commentaries should have the same number of verses as the Bible (around 31,102 - some commentaries exclude verses based on the aparent likelyhood of existing in the original source texts).
|
|
1125
|
+
*/
|
|
1126
|
+
totalNumberOfVerses: number;
|
|
1127
|
+
/**
|
|
1128
|
+
* The total number of profiles that are contained in this commentary. Profiles are used to provide additional information about people and people groups that are mentioned in the Bible.
|
|
1129
|
+
*/
|
|
1130
|
+
totalNumberOfProfiles: number;
|
|
1131
|
+
/**
|
|
1132
|
+
* Gets the name of the language that the commentary is in. Null or undefined if the name of the language is not known.
|
|
1133
|
+
*/
|
|
1134
|
+
languageName?: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* Gets the name of the language in English. Null or undefined if the language doesn't have an english name.
|
|
1137
|
+
*/
|
|
1138
|
+
languageEnglishName?: string;
|
|
1139
|
+
};
|
|
1140
|
+
/**
|
|
1141
|
+
* Defines an interface that contains information about the books that are available for a commentary.
|
|
1142
|
+
*/
|
|
1143
|
+
export type ApiCommentaryBooks = {
|
|
1144
|
+
/**
|
|
1145
|
+
* The commentary information for the books.
|
|
1146
|
+
*/
|
|
1147
|
+
commentary: ApiCommentary;
|
|
1148
|
+
/**
|
|
1149
|
+
* The list of books that are available for the commentary.
|
|
1150
|
+
*/
|
|
1151
|
+
books: Array<ApiCommentaryBook>;
|
|
1152
|
+
};
|
|
1153
|
+
/**
|
|
1154
|
+
* Defines a schema that contains information about a commentary book.
|
|
1155
|
+
*/
|
|
1156
|
+
export type ApiCommentaryBook = {
|
|
1157
|
+
id: BookId;
|
|
1158
|
+
/**
|
|
1159
|
+
* The name that the commentary provided for the book.
|
|
1160
|
+
*/
|
|
1161
|
+
name: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* The common name for the book.
|
|
1164
|
+
*/
|
|
1165
|
+
commonName: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* The commentary's introduction for the book. Undefined if the commentary didn't provide an introduction for the book.
|
|
1168
|
+
*/
|
|
1169
|
+
introduction?: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* The summary of the commentary's introduction for the book. Undefined if the commentary didn't provide a summary for the book.
|
|
1172
|
+
*/
|
|
1173
|
+
introductionSummary?: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* The order of the book in the Bible.
|
|
1176
|
+
*/
|
|
1177
|
+
order: number;
|
|
1178
|
+
/**
|
|
1179
|
+
* The number of the first chapter in the book. Null if the comentary book has no chapters.
|
|
1180
|
+
*/
|
|
1181
|
+
firstChapterNumber: number | null;
|
|
1182
|
+
/**
|
|
1183
|
+
* The link to the first chapter of the book. Null if the comentary book has no chapters.
|
|
1184
|
+
*/
|
|
1185
|
+
firstChapterApiLink: string | null;
|
|
1186
|
+
/**
|
|
1187
|
+
* The reference for the first chapter in the book. Null if the comentary book has no chapters.
|
|
1188
|
+
*/
|
|
1189
|
+
firstChapterReference: CommentaryChapterReference | null;
|
|
1190
|
+
/**
|
|
1191
|
+
* The number of the last chapter in the book. Null if the comentary book has no chapters.
|
|
1192
|
+
*/
|
|
1193
|
+
lastChapterNumber: number | null;
|
|
1194
|
+
/**
|
|
1195
|
+
* The link to the last chapter of the book. Null if the comentary book has no chapters.
|
|
1196
|
+
*/
|
|
1197
|
+
lastChapterApiLink: string | null;
|
|
1198
|
+
/**
|
|
1199
|
+
* The reference for the last chapter in the book. Null if the comentary book has no chapters.
|
|
1200
|
+
*/
|
|
1201
|
+
lastChapterReference: CommentaryChapterReference | null;
|
|
1202
|
+
/**
|
|
1203
|
+
* The number of chapters that the book contains.
|
|
1204
|
+
*/
|
|
1205
|
+
numberOfChapters: number;
|
|
1206
|
+
/**
|
|
1207
|
+
* The number of verses that the book contains.
|
|
1208
|
+
*/
|
|
1209
|
+
totalNumberOfVerses: number;
|
|
1210
|
+
};
|
|
1211
|
+
/**
|
|
1212
|
+
* Defines a reference to a chapter in a commentary.
|
|
1213
|
+
*/
|
|
1214
|
+
export type CommentaryChapterReference = {
|
|
1215
|
+
/**
|
|
1216
|
+
* The ID of the commentary that the chapter reference is for.
|
|
1217
|
+
*/
|
|
1218
|
+
commentaryId: string;
|
|
1219
|
+
book: BookId;
|
|
1220
|
+
/**
|
|
1221
|
+
* The chapter number of the chapter reference.
|
|
1222
|
+
*/
|
|
1223
|
+
chapter: number;
|
|
1224
|
+
};
|
|
1225
|
+
/**
|
|
1226
|
+
* Defines a schema that contains information about a book chapter in a commentary.
|
|
1227
|
+
*/
|
|
1228
|
+
export type ApiCommentaryBookChapter = {
|
|
1229
|
+
/**
|
|
1230
|
+
* The information for the chapter.
|
|
1231
|
+
*/
|
|
1232
|
+
chapter: {
|
|
1233
|
+
/**
|
|
1234
|
+
* The number of the chapter.
|
|
1235
|
+
*/
|
|
1236
|
+
number: number;
|
|
1237
|
+
/**
|
|
1238
|
+
* The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter.
|
|
1239
|
+
*/
|
|
1240
|
+
introduction?: string;
|
|
1241
|
+
/**
|
|
1242
|
+
* The content of the chapter.
|
|
1243
|
+
*/
|
|
1244
|
+
content: Array<ChapterVerse>;
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* The commentary information for the book chapter.
|
|
1248
|
+
*/
|
|
1249
|
+
commentary: ApiCommentary;
|
|
1250
|
+
/**
|
|
1251
|
+
* The book information for the book chapter.
|
|
1252
|
+
*/
|
|
1253
|
+
book: ApiCommentaryBook;
|
|
1254
|
+
/**
|
|
1255
|
+
* The API link for this chapter. Relative to the API origin.
|
|
1256
|
+
*/
|
|
1257
|
+
thisChapterLink: string;
|
|
1258
|
+
thisChapterReference: CommentaryChapterReference;
|
|
1259
|
+
/**
|
|
1260
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the commentary.
|
|
1261
|
+
*/
|
|
1262
|
+
nextChapterApiLink: string | null;
|
|
1263
|
+
/**
|
|
1264
|
+
* The reference for the next chapter. Null if this is the last chapter in the commentary.
|
|
1265
|
+
*/
|
|
1266
|
+
nextChapterReference: CommentaryChapterReference | null;
|
|
1267
|
+
/**
|
|
1268
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the commentary.
|
|
1269
|
+
*/
|
|
1270
|
+
previousChapterApiLink: string | null;
|
|
1271
|
+
/**
|
|
1272
|
+
* The reference for the previous chapter. Null if this is the first chapter in the commentary.
|
|
1273
|
+
*/
|
|
1274
|
+
previousChapterReference: CommentaryChapterReference | null;
|
|
1275
|
+
/**
|
|
1276
|
+
* The number of verses that the chapter contains.
|
|
1277
|
+
*/
|
|
1278
|
+
numberOfVerses: number;
|
|
1279
|
+
/**
|
|
1280
|
+
* The API link to the simplified version of this chapter. Relative to the API origin. Omitted if simplified chapters are not available.
|
|
1281
|
+
*/
|
|
1282
|
+
simpleChapterApiLink?: string;
|
|
1283
|
+
};
|
|
1284
|
+
/**
|
|
1285
|
+
* Defines a schema that contains information about a book chapter in a commentary, using the simplified chapter format.
|
|
1286
|
+
*/
|
|
1287
|
+
export type ApiSimpleCommentaryBookChapter = {
|
|
1288
|
+
/**
|
|
1289
|
+
* The commentary information for the book chapter.
|
|
1290
|
+
*/
|
|
1291
|
+
commentary: ApiCommentary;
|
|
1292
|
+
/**
|
|
1293
|
+
* The book information for the book chapter.
|
|
1294
|
+
*/
|
|
1295
|
+
book: ApiCommentaryBook;
|
|
1296
|
+
/**
|
|
1297
|
+
* The API link for this chapter. Relative to the API origin.
|
|
1298
|
+
*/
|
|
1299
|
+
thisChapterLink: string;
|
|
1300
|
+
thisChapterReference: CommentaryChapterReference;
|
|
1301
|
+
/**
|
|
1302
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the commentary.
|
|
1303
|
+
*/
|
|
1304
|
+
nextChapterApiLink: string | null;
|
|
1305
|
+
/**
|
|
1306
|
+
* The reference for the next chapter. Null if this is the last chapter in the commentary.
|
|
1307
|
+
*/
|
|
1308
|
+
nextChapterReference: CommentaryChapterReference | null;
|
|
1309
|
+
/**
|
|
1310
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the commentary.
|
|
1311
|
+
*/
|
|
1312
|
+
previousChapterApiLink: string | null;
|
|
1313
|
+
/**
|
|
1314
|
+
* The reference for the previous chapter. Null if this is the first chapter in the commentary.
|
|
1315
|
+
*/
|
|
1316
|
+
previousChapterReference: CommentaryChapterReference | null;
|
|
1317
|
+
/**
|
|
1318
|
+
* The number of verses that the chapter contains.
|
|
1319
|
+
*/
|
|
1320
|
+
numberOfVerses: number;
|
|
1321
|
+
/**
|
|
1322
|
+
* The simplified information for the chapter. Each verse contains a single text string, and the footnotes and formatting are represented by offsets into that string.
|
|
1323
|
+
*/
|
|
1324
|
+
chapter: SimpleCommentaryChapterData;
|
|
1325
|
+
/**
|
|
1326
|
+
* The API link to the regular (non-simplified) version of this chapter. Relative to the API origin.
|
|
1327
|
+
*/
|
|
1328
|
+
fullChapterApiLink: string;
|
|
1329
|
+
};
|
|
1330
|
+
/**
|
|
1331
|
+
* Defines the schema for the data in a simplified commentary chapter.
|
|
1332
|
+
*/
|
|
1333
|
+
export type SimpleCommentaryChapterData = {
|
|
1334
|
+
/**
|
|
1335
|
+
* The number of the chapter.
|
|
1336
|
+
*/
|
|
1337
|
+
number: number;
|
|
1338
|
+
/**
|
|
1339
|
+
* The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter.
|
|
1340
|
+
*/
|
|
1341
|
+
introduction?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* The content of the chapter.
|
|
1344
|
+
*/
|
|
1345
|
+
content: Array<SimpleChapterVerse>;
|
|
1346
|
+
};
|
|
1347
|
+
/**
|
|
1348
|
+
* The list of available datasets. Maps to the /api/available-datasets.json endpoint.
|
|
1349
|
+
*/
|
|
1350
|
+
export type ApiAvailableDatasets = {
|
|
1351
|
+
/**
|
|
1352
|
+
* The list of datasets that are available in the API.
|
|
1353
|
+
*/
|
|
1354
|
+
datasets: Array<ApiDataset>;
|
|
1355
|
+
};
|
|
1356
|
+
/**
|
|
1357
|
+
* Defines a dataset that is used in the API.
|
|
1358
|
+
*/
|
|
1359
|
+
export type ApiDataset = {
|
|
1360
|
+
/**
|
|
1361
|
+
* The ID of the dataset.
|
|
1362
|
+
*/
|
|
1363
|
+
id: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* The name of the dataset.
|
|
1366
|
+
*/
|
|
1367
|
+
name: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* The website for the dataset.
|
|
1370
|
+
*/
|
|
1371
|
+
website: string;
|
|
1372
|
+
/**
|
|
1373
|
+
* The URL that the license for the dataset can be found.
|
|
1374
|
+
*/
|
|
1375
|
+
licenseUrl: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* The API-added notes for the license.
|
|
1378
|
+
*/
|
|
1379
|
+
licenseNotes?: string | null;
|
|
1380
|
+
/**
|
|
1381
|
+
* The English name for the dataset.
|
|
1382
|
+
*/
|
|
1383
|
+
englishName: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* The ISO 639 3-letter language tag that the dataset is primarily in.
|
|
1386
|
+
*/
|
|
1387
|
+
language: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* The direction that the language is written in.
|
|
1390
|
+
*/
|
|
1391
|
+
textDirection: 'ltr' | 'rtl';
|
|
1392
|
+
/**
|
|
1393
|
+
* The API link for the list of books for this dataset. Relative to the API origin.
|
|
1394
|
+
*/
|
|
1395
|
+
listOfBooksApiLink: string;
|
|
1396
|
+
availableFormats: Array<'json'>;
|
|
1397
|
+
/**
|
|
1398
|
+
* The number of books that are contained in this dataset.
|
|
1399
|
+
*/
|
|
1400
|
+
numberOfBooks: number;
|
|
1401
|
+
/**
|
|
1402
|
+
* The total number of chapters that are contained in this dataset.
|
|
1403
|
+
*/
|
|
1404
|
+
totalNumberOfChapters: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* The total number of verses that are contained in this dataset.
|
|
1407
|
+
*/
|
|
1408
|
+
totalNumberOfVerses: number;
|
|
1409
|
+
/**
|
|
1410
|
+
* The total number of references that are contained in this dataset.
|
|
1411
|
+
*/
|
|
1412
|
+
totalNumberOfReferences: number;
|
|
1413
|
+
/**
|
|
1414
|
+
* Gets the name of the language that the dataset is in. Null or undefined if the name of the language is not known.
|
|
1415
|
+
*/
|
|
1416
|
+
languageName?: string;
|
|
1417
|
+
/**
|
|
1418
|
+
* Gets the name of the language in English. Null or undefined if the language doesn't have an english name.
|
|
1419
|
+
*/
|
|
1420
|
+
languageEnglishName?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* The API link for the list of people for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain people.
|
|
1423
|
+
*/
|
|
1424
|
+
listOfPeopleApiLink?: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* The API link for the list of places for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain places.
|
|
1427
|
+
*/
|
|
1428
|
+
listOfPlacesApiLink?: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* The API link for the list of events for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain events.
|
|
1431
|
+
*/
|
|
1432
|
+
listOfEventsApiLink?: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* The API link for the list of people groups for this dataset. Relative to the API origin. Omitted if the dataset doesn't contain people groups.
|
|
1435
|
+
*/
|
|
1436
|
+
listOfPeopleGroupsApiLink?: string;
|
|
1437
|
+
/**
|
|
1438
|
+
* The total number of people that are contained in this dataset. Omitted if the dataset doesn't contain people.
|
|
1439
|
+
*/
|
|
1440
|
+
totalNumberOfPeople?: number;
|
|
1441
|
+
/**
|
|
1442
|
+
* The total number of places that are contained in this dataset. Omitted if the dataset doesn't contain places.
|
|
1443
|
+
*/
|
|
1444
|
+
totalNumberOfPlaces?: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* The total number of events that are contained in this dataset. Omitted if the dataset doesn't contain events.
|
|
1447
|
+
*/
|
|
1448
|
+
totalNumberOfEvents?: number;
|
|
1449
|
+
/**
|
|
1450
|
+
* The total number of people groups that are contained in this dataset. Omitted if the dataset doesn't contain people groups.
|
|
1451
|
+
*/
|
|
1452
|
+
totalNumberOfPeopleGroups?: number;
|
|
1453
|
+
};
|
|
1454
|
+
/**
|
|
1455
|
+
* Defines an interface that contains information about the books that are available for a dataset.
|
|
1456
|
+
*/
|
|
1457
|
+
export type ApiDatasetBooks = {
|
|
1458
|
+
/**
|
|
1459
|
+
* The dataset information for the books.
|
|
1460
|
+
*/
|
|
1461
|
+
dataset: ApiDataset;
|
|
1462
|
+
/**
|
|
1463
|
+
* The list of books that are available for the dataset.
|
|
1464
|
+
*/
|
|
1465
|
+
books: Array<ApiDatasetBook>;
|
|
1466
|
+
};
|
|
1467
|
+
/**
|
|
1468
|
+
* Defines a schema that contains information about a book in a dataset.
|
|
1469
|
+
*/
|
|
1470
|
+
export type ApiDatasetBook = {
|
|
1471
|
+
id: BookId;
|
|
1472
|
+
/**
|
|
1473
|
+
* The order of the book in the Bible.
|
|
1474
|
+
*/
|
|
1475
|
+
order: number;
|
|
1476
|
+
/**
|
|
1477
|
+
* The number of the first chapter in the book.
|
|
1478
|
+
*/
|
|
1479
|
+
firstChapterNumber: number;
|
|
1480
|
+
/**
|
|
1481
|
+
* The link to the first chapter of the book.
|
|
1482
|
+
*/
|
|
1483
|
+
firstChapterApiLink: string;
|
|
1484
|
+
firstChapterReference: DatasetChapterReference;
|
|
1485
|
+
/**
|
|
1486
|
+
* The number of the last chapter in the book.
|
|
1487
|
+
*/
|
|
1488
|
+
lastChapterNumber: number;
|
|
1489
|
+
/**
|
|
1490
|
+
* The link to the last chapter of the book.
|
|
1491
|
+
*/
|
|
1492
|
+
lastChapterApiLink: string;
|
|
1493
|
+
lastChapterReference: DatasetChapterReference;
|
|
1494
|
+
/**
|
|
1495
|
+
* The number of chapters that the book contains.
|
|
1496
|
+
*/
|
|
1497
|
+
numberOfChapters: number;
|
|
1498
|
+
/**
|
|
1499
|
+
* The number of verses that the book contains.
|
|
1500
|
+
*/
|
|
1501
|
+
totalNumberOfVerses: number;
|
|
1502
|
+
/**
|
|
1503
|
+
* The number of references that the book contains.
|
|
1504
|
+
*/
|
|
1505
|
+
totalNumberOfReferences: number;
|
|
1506
|
+
};
|
|
1507
|
+
/**
|
|
1508
|
+
* Defines a reference to a chapter in a dataset.
|
|
1509
|
+
*/
|
|
1510
|
+
export type DatasetChapterReference = {
|
|
1511
|
+
/**
|
|
1512
|
+
* The ID of the dataset that the chapter reference is for.
|
|
1513
|
+
*/
|
|
1514
|
+
datasetId: string;
|
|
1515
|
+
book: BookId;
|
|
1516
|
+
/**
|
|
1517
|
+
* The chapter number of the chapter reference.
|
|
1518
|
+
*/
|
|
1519
|
+
chapter: number;
|
|
1520
|
+
};
|
|
1521
|
+
/**
|
|
1522
|
+
* Defines a schema that contains information about a book chapter in a dataset.
|
|
1523
|
+
*/
|
|
1524
|
+
export type ApiDatasetBookChapter = {
|
|
1525
|
+
/**
|
|
1526
|
+
* The data for the chapter.
|
|
1527
|
+
*/
|
|
1528
|
+
chapter: DatasetChapterData;
|
|
1529
|
+
/**
|
|
1530
|
+
* The dataset information for the book chapter.
|
|
1531
|
+
*/
|
|
1532
|
+
dataset: ApiDataset;
|
|
1533
|
+
/**
|
|
1534
|
+
* The book information for the book chapter.
|
|
1535
|
+
*/
|
|
1536
|
+
book: ApiDatasetBook;
|
|
1537
|
+
/**
|
|
1538
|
+
* The API link for this chapter. Relative to the API origin.
|
|
1539
|
+
*/
|
|
1540
|
+
thisChapterLink: string;
|
|
1541
|
+
thisChapterReference: DatasetChapterReference;
|
|
1542
|
+
/**
|
|
1543
|
+
* The API link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset.
|
|
1544
|
+
*/
|
|
1545
|
+
nextChapterApiLink: string | null;
|
|
1546
|
+
/**
|
|
1547
|
+
* The reference for the next chapter. Null if this is the last chapter in the dataset.
|
|
1548
|
+
*/
|
|
1549
|
+
nextChapterReference: DatasetChapterReference | null;
|
|
1550
|
+
/**
|
|
1551
|
+
* The API link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset.
|
|
1552
|
+
*/
|
|
1553
|
+
previousChapterApiLink: string | null;
|
|
1554
|
+
/**
|
|
1555
|
+
* The reference for the previous chapter. Null if this is the first chapter in the dataset.
|
|
1556
|
+
*/
|
|
1557
|
+
previousChapterReference: DatasetChapterReference | null;
|
|
1558
|
+
/**
|
|
1559
|
+
* The number of verses that the chapter contains.
|
|
1560
|
+
*/
|
|
1561
|
+
numberOfVerses: number;
|
|
1562
|
+
/**
|
|
1563
|
+
* The number of references that the chapter contains.
|
|
1564
|
+
*/
|
|
1565
|
+
numberOfReferences: number;
|
|
1566
|
+
};
|
|
1567
|
+
/**
|
|
1568
|
+
* Defines the schema for information about a chapter in a dataset.
|
|
1569
|
+
*/
|
|
1570
|
+
export type DatasetChapterData = {
|
|
1571
|
+
/**
|
|
1572
|
+
* The number of the chapter.
|
|
1573
|
+
*/
|
|
1574
|
+
number: number;
|
|
1575
|
+
/**
|
|
1576
|
+
* The content of the chapter.
|
|
1577
|
+
*/
|
|
1578
|
+
content: Array<DatasetChapterVerseContent>;
|
|
1579
|
+
};
|
|
1580
|
+
/**
|
|
1581
|
+
* Defines the schema for information about a verse in a dataset chapter.
|
|
1582
|
+
*/
|
|
1583
|
+
export type DatasetChapterVerseContent = {
|
|
1584
|
+
/**
|
|
1585
|
+
* The number of the verse.
|
|
1586
|
+
*/
|
|
1587
|
+
verse: number;
|
|
1588
|
+
/**
|
|
1589
|
+
* The list of references for the verse.
|
|
1590
|
+
*/
|
|
1591
|
+
references: Array<ScoredVerseRef>;
|
|
1592
|
+
};
|
|
1593
|
+
/**
|
|
1594
|
+
* Defines the schema for information about a verse reference that has an arbitrary score attached to it.
|
|
1595
|
+
*/
|
|
1596
|
+
export type ScoredVerseRef = {
|
|
1597
|
+
book: BookId;
|
|
1598
|
+
/**
|
|
1599
|
+
* The chapter number that the reference starts at.
|
|
1600
|
+
*/
|
|
1601
|
+
chapter: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* The verse number that the reference starts at.
|
|
1604
|
+
*/
|
|
1605
|
+
verse: number;
|
|
1606
|
+
/**
|
|
1607
|
+
* The rest of the content of the verse reference. This is the part of the string that comes after the verse reference. For example, in "GEN 1:1 In the beginning, God created the Heavens and the Earth.", the content would be "In the beginning, God created the Heavens and the Earth."
|
|
1608
|
+
*/
|
|
1609
|
+
content?: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* The chapter that the verse reference ends at. This is used for references that span multiple chapters, such as "GEN 1:1-2:3". In this case, the endChapter would be 2.
|
|
1612
|
+
*/
|
|
1613
|
+
endChapter?: number;
|
|
1614
|
+
/**
|
|
1615
|
+
* The verse that the verse reference ends at. This is used for references that span multiple verses, such as "GEN 1:1-1:3". In this case, the endVerse would be 3.
|
|
1616
|
+
*/
|
|
1617
|
+
endVerse?: number;
|
|
1618
|
+
/**
|
|
1619
|
+
* The score for the verse reference. The meaning of the score is arbitrary and is determined by the dataset.
|
|
1620
|
+
*/
|
|
1621
|
+
score: number;
|
|
1622
|
+
};
|
|
1623
|
+
/**
|
|
1624
|
+
* The entities (people, places, and events) that appear in a chapter of a book for a dataset. Maps to the /api/d/:datasetId/:bookId/:chapterNumber.json endpoint for datasets that contain entities.
|
|
1625
|
+
*/
|
|
1626
|
+
export type ApiDatasetEntityBookChapter = {
|
|
1627
|
+
/**
|
|
1628
|
+
* The dataset information for the book chapter.
|
|
1629
|
+
*/
|
|
1630
|
+
dataset: ApiDataset;
|
|
1631
|
+
/**
|
|
1632
|
+
* The book information for the book chapter.
|
|
1633
|
+
*/
|
|
1634
|
+
book: ApiDatasetBook;
|
|
1635
|
+
/**
|
|
1636
|
+
* The entity data for the chapter.
|
|
1637
|
+
*/
|
|
1638
|
+
chapter: ApiDatasetEntityChapterData;
|
|
1639
|
+
/**
|
|
1640
|
+
* The link to this chapter. Relative to the API origin.
|
|
1641
|
+
*/
|
|
1642
|
+
thisChapterLink: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* The reference for this chapter.
|
|
1645
|
+
*/
|
|
1646
|
+
thisChapterReference: DatasetChapterReference;
|
|
1647
|
+
/**
|
|
1648
|
+
* The link to the next chapter. Relative to the API origin. Null if this is the last chapter in the dataset.
|
|
1649
|
+
*/
|
|
1650
|
+
nextChapterApiLink: string | null;
|
|
1651
|
+
/**
|
|
1652
|
+
* The reference for the next chapter. Null if this is the last chapter in the dataset.
|
|
1653
|
+
*/
|
|
1654
|
+
nextChapterReference: DatasetChapterReference | null;
|
|
1655
|
+
/**
|
|
1656
|
+
* The link to the previous chapter. Relative to the API origin. Null if this is the first chapter in the dataset.
|
|
1657
|
+
*/
|
|
1658
|
+
previousChapterApiLink: string | null;
|
|
1659
|
+
/**
|
|
1660
|
+
* The reference for the previous chapter. Null if this is the first chapter in the dataset.
|
|
1661
|
+
*/
|
|
1662
|
+
previousChapterReference: DatasetChapterReference | null;
|
|
1663
|
+
/**
|
|
1664
|
+
* The number of people that appear in the chapter.
|
|
1665
|
+
*/
|
|
1666
|
+
numberOfPeople: number;
|
|
1667
|
+
/**
|
|
1668
|
+
* The number of places that appear in the chapter.
|
|
1669
|
+
*/
|
|
1670
|
+
numberOfPlaces: number;
|
|
1671
|
+
/**
|
|
1672
|
+
* The number of events that appear in the chapter.
|
|
1673
|
+
*/
|
|
1674
|
+
numberOfEvents: number;
|
|
1675
|
+
};
|
|
1676
|
+
/**
|
|
1677
|
+
* Defines a person that appears in a chapter of a dataset.
|
|
1678
|
+
*/
|
|
1679
|
+
export type ApiDatasetChapterPerson = {
|
|
1680
|
+
/**
|
|
1681
|
+
* The ID of the person.
|
|
1682
|
+
*/
|
|
1683
|
+
id: string;
|
|
1684
|
+
/**
|
|
1685
|
+
* The name of the person.
|
|
1686
|
+
*/
|
|
1687
|
+
name: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* Whether the name of the person is a proper name.
|
|
1690
|
+
*/
|
|
1691
|
+
isProperName?: boolean;
|
|
1692
|
+
/**
|
|
1693
|
+
* The gender of the person.
|
|
1694
|
+
*/
|
|
1695
|
+
gender?: string;
|
|
1696
|
+
/**
|
|
1697
|
+
* The year that the person was born. Negative numbers are years BC. Positive numbers are years AD.
|
|
1698
|
+
*/
|
|
1699
|
+
birthYear?: number;
|
|
1700
|
+
/**
|
|
1701
|
+
* The year that the person died. Negative numbers are years BC. Positive numbers are years AD.
|
|
1702
|
+
*/
|
|
1703
|
+
deathYear?: number;
|
|
1704
|
+
/**
|
|
1705
|
+
* The API link for the person. Relative to the API origin.
|
|
1706
|
+
*/
|
|
1707
|
+
apiLink: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* The numbers of the verses in the chapter that mention the person. Sorted in ascending order.
|
|
1710
|
+
*/
|
|
1711
|
+
verses: Array<number>;
|
|
1712
|
+
};
|
|
1713
|
+
/**
|
|
1714
|
+
* Defines a place that appears in a chapter of a dataset.
|
|
1715
|
+
*/
|
|
1716
|
+
export type ApiDatasetChapterPlace = {
|
|
1717
|
+
/**
|
|
1718
|
+
* The ID of the place.
|
|
1719
|
+
*/
|
|
1720
|
+
id: string;
|
|
1721
|
+
/**
|
|
1722
|
+
* The name of the place.
|
|
1723
|
+
*/
|
|
1724
|
+
name: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* The type of geographical feature that the place is. For example, "City", "Region", "Mountain", "Water", etc.
|
|
1727
|
+
*/
|
|
1728
|
+
featureType?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* The latitude of the place.
|
|
1731
|
+
*/
|
|
1732
|
+
latitude?: number;
|
|
1733
|
+
/**
|
|
1734
|
+
* The longitude of the place.
|
|
1735
|
+
*/
|
|
1736
|
+
longitude?: number;
|
|
1737
|
+
/**
|
|
1738
|
+
* The API link for the place. Relative to the API origin.
|
|
1739
|
+
*/
|
|
1740
|
+
apiLink: string;
|
|
1741
|
+
/**
|
|
1742
|
+
* The numbers of the verses in the chapter that mention the place. Sorted in ascending order.
|
|
1743
|
+
*/
|
|
1744
|
+
verses: Array<number>;
|
|
1745
|
+
};
|
|
1746
|
+
/**
|
|
1747
|
+
* Defines an event that appears in a chapter of a dataset.
|
|
1748
|
+
*/
|
|
1749
|
+
export type ApiDatasetChapterEvent = {
|
|
1750
|
+
/**
|
|
1751
|
+
* The ID of the event.
|
|
1752
|
+
*/
|
|
1753
|
+
id: string;
|
|
1754
|
+
/**
|
|
1755
|
+
* The name of the event.
|
|
1756
|
+
*/
|
|
1757
|
+
name: string;
|
|
1758
|
+
/**
|
|
1759
|
+
* The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.
|
|
1760
|
+
*/
|
|
1761
|
+
startDate?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* The API link for the event. Relative to the API origin.
|
|
1764
|
+
*/
|
|
1765
|
+
apiLink: string;
|
|
1766
|
+
/**
|
|
1767
|
+
* The numbers of the verses in the chapter that describe the event. Sorted in ascending order.
|
|
1768
|
+
*/
|
|
1769
|
+
verses: Array<number>;
|
|
1770
|
+
};
|
|
1771
|
+
/**
|
|
1772
|
+
* Defines the entity data for a chapter in a dataset. Contains the people, places, and events that appear in the chapter.
|
|
1773
|
+
*/
|
|
1774
|
+
export type ApiDatasetEntityChapterData = {
|
|
1775
|
+
/**
|
|
1776
|
+
* The number of the chapter.
|
|
1777
|
+
*/
|
|
1778
|
+
number: number;
|
|
1779
|
+
/**
|
|
1780
|
+
* The people that appear in the chapter. Sorted by the first verse that they appear in.
|
|
1781
|
+
*/
|
|
1782
|
+
people: Array<ApiDatasetChapterPerson>;
|
|
1783
|
+
/**
|
|
1784
|
+
* The places that appear in the chapter. Sorted by the first verse that they appear in.
|
|
1785
|
+
*/
|
|
1786
|
+
places: Array<ApiDatasetChapterPlace>;
|
|
1787
|
+
/**
|
|
1788
|
+
* The events that appear in the chapter. Sorted by the first verse that they appear in.
|
|
1789
|
+
*/
|
|
1790
|
+
events: Array<ApiDatasetChapterEvent>;
|
|
1791
|
+
};
|
|
1792
|
+
/**
|
|
1793
|
+
* The list of people in a dataset. Maps to the /api/d/:datasetId/people.json endpoint.
|
|
1794
|
+
*/
|
|
1795
|
+
export type ApiDatasetPeople = {
|
|
1796
|
+
/**
|
|
1797
|
+
* The dataset information for the people.
|
|
1798
|
+
*/
|
|
1799
|
+
dataset: ApiDataset;
|
|
1800
|
+
/**
|
|
1801
|
+
* The list of people that are available for the dataset.
|
|
1802
|
+
*/
|
|
1803
|
+
people: Array<ApiDatasetPersonSummary>;
|
|
1804
|
+
};
|
|
1805
|
+
/**
|
|
1806
|
+
* Defines a summary of a person in a dataset.
|
|
1807
|
+
*/
|
|
1808
|
+
export type ApiDatasetPersonSummary = {
|
|
1809
|
+
/**
|
|
1810
|
+
* The ID of the person.
|
|
1811
|
+
*/
|
|
1812
|
+
id: string;
|
|
1813
|
+
/**
|
|
1814
|
+
* The name of the person.
|
|
1815
|
+
*/
|
|
1816
|
+
name: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Whether the name of the person is a proper name.
|
|
1819
|
+
*/
|
|
1820
|
+
isProperName?: boolean;
|
|
1821
|
+
/**
|
|
1822
|
+
* The gender of the person.
|
|
1823
|
+
*/
|
|
1824
|
+
gender?: string;
|
|
1825
|
+
/**
|
|
1826
|
+
* The number of Bible references that mention the person.
|
|
1827
|
+
*/
|
|
1828
|
+
numberOfReferences: number;
|
|
1829
|
+
/**
|
|
1830
|
+
* The API link for the person. Relative to the API origin.
|
|
1831
|
+
*/
|
|
1832
|
+
thisPersonApiLink: string;
|
|
1833
|
+
};
|
|
1834
|
+
/**
|
|
1835
|
+
* The information about a person in a dataset. Maps to the /api/d/:datasetId/people/:personId.json endpoint.
|
|
1836
|
+
*/
|
|
1837
|
+
export type ApiDatasetPerson = {
|
|
1838
|
+
/**
|
|
1839
|
+
* The dataset information for the person.
|
|
1840
|
+
*/
|
|
1841
|
+
dataset: ApiDataset;
|
|
1842
|
+
/**
|
|
1843
|
+
* The information about the person.
|
|
1844
|
+
*/
|
|
1845
|
+
person: DatasetPerson;
|
|
1846
|
+
/**
|
|
1847
|
+
* The API link for this person. Relative to the API origin.
|
|
1848
|
+
*/
|
|
1849
|
+
thisPersonApiLink: string;
|
|
1850
|
+
};
|
|
1851
|
+
/**
|
|
1852
|
+
* Defines the schema for a reference to another entity (person, place, event, or people group) in a dataset.
|
|
1853
|
+
*/
|
|
1854
|
+
export type DatasetEntityRef = {
|
|
1855
|
+
/**
|
|
1856
|
+
* The ID of the entity that is being referenced.
|
|
1857
|
+
*/
|
|
1858
|
+
id: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* The type of the entity that is being referenced. Matches the collection segment of the entity's API link, so the link can be constructed as `/api/d/{dataset}/{type}/{id}.json`.
|
|
1861
|
+
*/
|
|
1862
|
+
type: DatasetEntityType;
|
|
1863
|
+
/**
|
|
1864
|
+
* The name of the entity that is being referenced.
|
|
1865
|
+
*/
|
|
1866
|
+
name?: string;
|
|
1867
|
+
/**
|
|
1868
|
+
* The API link for the entity that is being referenced. Relative to the API origin. Only present in API responses.
|
|
1869
|
+
*/
|
|
1870
|
+
apiLink?: string;
|
|
1871
|
+
};
|
|
1872
|
+
/**
|
|
1873
|
+
* The type of an entity in a dataset. Matches the collection segment of the entity API paths, so the API link for an entity can be constructed as `/api/d/{dataset}/{type}/{id}.json`.
|
|
1874
|
+
*/
|
|
1875
|
+
export type DatasetEntityType = 'people' | 'places' | 'events' | 'groups';
|
|
1876
|
+
/**
|
|
1877
|
+
* Defines a schema for verse references. A verse reference is a string that contains a book ID, chapter number, and verse number, such as "GEN 1:1". It can also contain an optional content part that comes after the verse reference, such as "GEN 1:1 In the beginning, God created the Heavens and the Earth." It can also contain optional endChapter and endVerse fields for references that span multiple chapters or verses, such as "GEN 1:1-2:3".
|
|
1878
|
+
*/
|
|
1879
|
+
export type VerseRef = {
|
|
1880
|
+
book: BookId;
|
|
1881
|
+
/**
|
|
1882
|
+
* The chapter number that the reference starts at.
|
|
1883
|
+
*/
|
|
1884
|
+
chapter: number;
|
|
1885
|
+
/**
|
|
1886
|
+
* The verse number that the reference starts at.
|
|
1887
|
+
*/
|
|
1888
|
+
verse: number;
|
|
1889
|
+
/**
|
|
1890
|
+
* The rest of the content of the verse reference. This is the part of the string that comes after the verse reference. For example, in "GEN 1:1 In the beginning, God created the Heavens and the Earth.", the content would be "In the beginning, God created the Heavens and the Earth."
|
|
1891
|
+
*/
|
|
1892
|
+
content?: string;
|
|
1893
|
+
/**
|
|
1894
|
+
* The chapter that the verse reference ends at. This is used for references that span multiple chapters, such as "GEN 1:1-2:3". In this case, the endChapter would be 2.
|
|
1895
|
+
*/
|
|
1896
|
+
endChapter?: number;
|
|
1897
|
+
/**
|
|
1898
|
+
* The verse that the verse reference ends at. This is used for references that span multiple verses, such as "GEN 1:1-1:3". In this case, the endVerse would be 3.
|
|
1899
|
+
*/
|
|
1900
|
+
endVerse?: number;
|
|
1901
|
+
};
|
|
1902
|
+
/**
|
|
1903
|
+
* Defines the schema for information about a person in a dataset.
|
|
1904
|
+
*/
|
|
1905
|
+
export type DatasetPerson = {
|
|
1906
|
+
/**
|
|
1907
|
+
* The ID of the person.
|
|
1908
|
+
*/
|
|
1909
|
+
id: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* The name of the person.
|
|
1912
|
+
*/
|
|
1913
|
+
name: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* Other names that the person is called by.
|
|
1916
|
+
*/
|
|
1917
|
+
alsoCalled?: Array<string>;
|
|
1918
|
+
/**
|
|
1919
|
+
* Whether the name of the person is a proper name.
|
|
1920
|
+
*/
|
|
1921
|
+
isProperName?: boolean;
|
|
1922
|
+
/**
|
|
1923
|
+
* The gender of the person.
|
|
1924
|
+
*/
|
|
1925
|
+
gender?: string;
|
|
1926
|
+
/**
|
|
1927
|
+
* The description of the person. Each string is a paragraph.
|
|
1928
|
+
*/
|
|
1929
|
+
description?: Array<string>;
|
|
1930
|
+
/**
|
|
1931
|
+
* The year that the person was born. Negative numbers are years BC. Positive numbers are years AD.
|
|
1932
|
+
*/
|
|
1933
|
+
birthYear?: number;
|
|
1934
|
+
/**
|
|
1935
|
+
* The year that the person died. Negative numbers are years BC. Positive numbers are years AD.
|
|
1936
|
+
*/
|
|
1937
|
+
deathYear?: number;
|
|
1938
|
+
/**
|
|
1939
|
+
* The earliest year that the person is mentioned in. Negative numbers are years BC. Positive numbers are years AD.
|
|
1940
|
+
*/
|
|
1941
|
+
minYear?: number;
|
|
1942
|
+
/**
|
|
1943
|
+
* The latest year that the person is mentioned in. Negative numbers are years BC. Positive numbers are years AD.
|
|
1944
|
+
*/
|
|
1945
|
+
maxYear?: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* The place that the person was born in.
|
|
1948
|
+
*/
|
|
1949
|
+
birthPlace?: DatasetEntityRef;
|
|
1950
|
+
/**
|
|
1951
|
+
* The place that the person died in.
|
|
1952
|
+
*/
|
|
1953
|
+
deathPlace?: DatasetEntityRef;
|
|
1954
|
+
/**
|
|
1955
|
+
* The father(s) of the person.
|
|
1956
|
+
*/
|
|
1957
|
+
father?: Array<DatasetEntityRef>;
|
|
1958
|
+
/**
|
|
1959
|
+
* The mother(s) of the person.
|
|
1960
|
+
*/
|
|
1961
|
+
mother?: Array<DatasetEntityRef>;
|
|
1962
|
+
/**
|
|
1963
|
+
* The partners (spouses) of the person.
|
|
1964
|
+
*/
|
|
1965
|
+
partners?: Array<DatasetEntityRef>;
|
|
1966
|
+
/**
|
|
1967
|
+
* The children of the person.
|
|
1968
|
+
*/
|
|
1969
|
+
children?: Array<DatasetEntityRef>;
|
|
1970
|
+
/**
|
|
1971
|
+
* The siblings of the person.
|
|
1972
|
+
*/
|
|
1973
|
+
siblings?: Array<DatasetEntityRef>;
|
|
1974
|
+
/**
|
|
1975
|
+
* The half-siblings of the person that share the same mother.
|
|
1976
|
+
*/
|
|
1977
|
+
halfSiblingsSameMother?: Array<DatasetEntityRef>;
|
|
1978
|
+
/**
|
|
1979
|
+
* The half-siblings of the person that share the same father.
|
|
1980
|
+
*/
|
|
1981
|
+
halfSiblingsSameFather?: Array<DatasetEntityRef>;
|
|
1982
|
+
/**
|
|
1983
|
+
* The people groups that the person is a member of.
|
|
1984
|
+
*/
|
|
1985
|
+
memberOf?: Array<DatasetEntityRef>;
|
|
1986
|
+
/**
|
|
1987
|
+
* The events that the person participated in.
|
|
1988
|
+
*/
|
|
1989
|
+
events?: Array<DatasetEntityRef>;
|
|
1990
|
+
/**
|
|
1991
|
+
* The list of Bible references that mention the person. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`.
|
|
1992
|
+
*/
|
|
1993
|
+
references: Array<VerseRef>;
|
|
1994
|
+
};
|
|
1995
|
+
/**
|
|
1996
|
+
* The list of places in a dataset. Maps to the /api/d/:datasetId/places.json endpoint.
|
|
1997
|
+
*/
|
|
1998
|
+
export type ApiDatasetPlaces = {
|
|
1999
|
+
/**
|
|
2000
|
+
* The dataset information for the places.
|
|
2001
|
+
*/
|
|
2002
|
+
dataset: ApiDataset;
|
|
2003
|
+
/**
|
|
2004
|
+
* The list of places that are available for the dataset.
|
|
640
2005
|
*/
|
|
641
|
-
|
|
2006
|
+
places: Array<ApiDatasetPlaceSummary>;
|
|
2007
|
+
};
|
|
2008
|
+
/**
|
|
2009
|
+
* Defines a summary of a place in a dataset.
|
|
2010
|
+
*/
|
|
2011
|
+
export type ApiDatasetPlaceSummary = {
|
|
642
2012
|
/**
|
|
643
|
-
* The
|
|
2013
|
+
* The ID of the place.
|
|
644
2014
|
*/
|
|
645
|
-
|
|
2015
|
+
id: string;
|
|
646
2016
|
/**
|
|
647
|
-
* The
|
|
2017
|
+
* The name of the place.
|
|
648
2018
|
*/
|
|
649
|
-
|
|
650
|
-
thisChapterReference: CommentaryChapterReference;
|
|
2019
|
+
name: string;
|
|
651
2020
|
/**
|
|
652
|
-
* The
|
|
2021
|
+
* The type of geographical feature that the place is. For example, "City", "Region", "Mountain", "Water", etc.
|
|
653
2022
|
*/
|
|
654
|
-
|
|
2023
|
+
featureType?: string;
|
|
655
2024
|
/**
|
|
656
|
-
* The
|
|
2025
|
+
* The latitude of the place.
|
|
657
2026
|
*/
|
|
658
|
-
|
|
2027
|
+
latitude?: number;
|
|
659
2028
|
/**
|
|
660
|
-
* The
|
|
2029
|
+
* The longitude of the place.
|
|
661
2030
|
*/
|
|
662
|
-
|
|
2031
|
+
longitude?: number;
|
|
663
2032
|
/**
|
|
664
|
-
* The
|
|
2033
|
+
* The number of Bible references that mention the place.
|
|
665
2034
|
*/
|
|
666
|
-
|
|
2035
|
+
numberOfReferences: number;
|
|
667
2036
|
/**
|
|
668
|
-
* The
|
|
2037
|
+
* The API link for the place. Relative to the API origin.
|
|
669
2038
|
*/
|
|
670
|
-
|
|
2039
|
+
thisPlaceApiLink: string;
|
|
671
2040
|
};
|
|
672
2041
|
/**
|
|
673
|
-
* The
|
|
2042
|
+
* The information about a place in a dataset. Maps to the /api/d/:datasetId/places/:placeId.json endpoint.
|
|
674
2043
|
*/
|
|
675
|
-
export type
|
|
2044
|
+
export type ApiDatasetPlace = {
|
|
676
2045
|
/**
|
|
677
|
-
* The
|
|
2046
|
+
* The dataset information for the place.
|
|
678
2047
|
*/
|
|
679
|
-
|
|
2048
|
+
dataset: ApiDataset;
|
|
2049
|
+
/**
|
|
2050
|
+
* The information about the place.
|
|
2051
|
+
*/
|
|
2052
|
+
place: DatasetPlace;
|
|
2053
|
+
/**
|
|
2054
|
+
* The API link for this place. Relative to the API origin.
|
|
2055
|
+
*/
|
|
2056
|
+
thisPlaceApiLink: string;
|
|
680
2057
|
};
|
|
681
2058
|
/**
|
|
682
|
-
* Defines
|
|
2059
|
+
* Defines the schema for information about a place in a dataset.
|
|
683
2060
|
*/
|
|
684
|
-
export type
|
|
2061
|
+
export type DatasetPlace = {
|
|
685
2062
|
/**
|
|
686
|
-
* The ID of the
|
|
2063
|
+
* The ID of the place.
|
|
687
2064
|
*/
|
|
688
2065
|
id: string;
|
|
689
2066
|
/**
|
|
690
|
-
* The name of the
|
|
2067
|
+
* The name of the place.
|
|
691
2068
|
*/
|
|
692
2069
|
name: string;
|
|
693
2070
|
/**
|
|
694
|
-
* The
|
|
2071
|
+
* The name of the place as it appears in the King James Version.
|
|
695
2072
|
*/
|
|
696
|
-
|
|
2073
|
+
kjvName?: string;
|
|
697
2074
|
/**
|
|
698
|
-
* The
|
|
2075
|
+
* The name of the place as it appears in the English Standard Version.
|
|
699
2076
|
*/
|
|
700
|
-
|
|
2077
|
+
esvName?: string;
|
|
701
2078
|
/**
|
|
702
|
-
*
|
|
2079
|
+
* Other names that the place is called by.
|
|
703
2080
|
*/
|
|
704
|
-
|
|
2081
|
+
aliases?: Array<string>;
|
|
705
2082
|
/**
|
|
706
|
-
* The
|
|
2083
|
+
* The type of geographical feature that the place is. For example, "City", "Region", "Mountain", "Water", etc.
|
|
707
2084
|
*/
|
|
708
|
-
|
|
2085
|
+
featureType?: string;
|
|
709
2086
|
/**
|
|
710
|
-
* The
|
|
2087
|
+
* The sub-type of geographical feature that the place is.
|
|
711
2088
|
*/
|
|
712
|
-
|
|
2089
|
+
featureSubType?: string;
|
|
713
2090
|
/**
|
|
714
|
-
* The
|
|
2091
|
+
* The latitude of the place.
|
|
715
2092
|
*/
|
|
716
|
-
|
|
2093
|
+
latitude?: number;
|
|
717
2094
|
/**
|
|
718
|
-
* The
|
|
2095
|
+
* The longitude of the place.
|
|
719
2096
|
*/
|
|
720
|
-
|
|
721
|
-
availableFormats: Array<'json'>;
|
|
2097
|
+
longitude?: number;
|
|
722
2098
|
/**
|
|
723
|
-
*
|
|
2099
|
+
* How precise the latitude and longitude of the place are.
|
|
724
2100
|
*/
|
|
725
|
-
|
|
2101
|
+
precision?: string;
|
|
726
2102
|
/**
|
|
727
|
-
* The
|
|
2103
|
+
* The description of the place. Each string is a paragraph.
|
|
728
2104
|
*/
|
|
729
|
-
|
|
2105
|
+
description?: Array<string>;
|
|
730
2106
|
/**
|
|
731
|
-
* The
|
|
2107
|
+
* The comment on the place from the dataset authors.
|
|
732
2108
|
*/
|
|
733
|
-
|
|
2109
|
+
comment?: string;
|
|
734
2110
|
/**
|
|
735
|
-
* The
|
|
2111
|
+
* The root place for this place. Different names for the same geographical location share the same root place.
|
|
736
2112
|
*/
|
|
737
|
-
|
|
2113
|
+
rootPlace?: DatasetEntityRef;
|
|
738
2114
|
/**
|
|
739
|
-
*
|
|
2115
|
+
* The place that this place is a duplicate of.
|
|
740
2116
|
*/
|
|
741
|
-
|
|
2117
|
+
duplicateOf?: DatasetEntityRef;
|
|
742
2118
|
/**
|
|
743
|
-
*
|
|
2119
|
+
* The people that have been at the place.
|
|
744
2120
|
*/
|
|
745
|
-
|
|
2121
|
+
people?: Array<DatasetEntityRef>;
|
|
2122
|
+
/**
|
|
2123
|
+
* The people that were born at the place.
|
|
2124
|
+
*/
|
|
2125
|
+
peopleBorn?: Array<DatasetEntityRef>;
|
|
2126
|
+
/**
|
|
2127
|
+
* The people that died at the place.
|
|
2128
|
+
*/
|
|
2129
|
+
peopleDied?: Array<DatasetEntityRef>;
|
|
2130
|
+
/**
|
|
2131
|
+
* The events that happened at the place.
|
|
2132
|
+
*/
|
|
2133
|
+
events?: Array<DatasetEntityRef>;
|
|
2134
|
+
/**
|
|
2135
|
+
* The list of Bible references that mention the place. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`.
|
|
2136
|
+
*/
|
|
2137
|
+
references: Array<VerseRef>;
|
|
746
2138
|
};
|
|
747
2139
|
/**
|
|
748
|
-
*
|
|
2140
|
+
* The list of events in a dataset. Maps to the /api/d/:datasetId/events.json endpoint.
|
|
749
2141
|
*/
|
|
750
|
-
export type
|
|
2142
|
+
export type ApiDatasetEvents = {
|
|
751
2143
|
/**
|
|
752
|
-
* The dataset information for the
|
|
2144
|
+
* The dataset information for the events.
|
|
753
2145
|
*/
|
|
754
2146
|
dataset: ApiDataset;
|
|
755
2147
|
/**
|
|
756
|
-
* The list of
|
|
2148
|
+
* The list of events that are available for the dataset.
|
|
757
2149
|
*/
|
|
758
|
-
|
|
2150
|
+
events: Array<ApiDatasetEventSummary>;
|
|
759
2151
|
};
|
|
760
2152
|
/**
|
|
761
|
-
* Defines a
|
|
2153
|
+
* Defines a summary of an event in a dataset.
|
|
762
2154
|
*/
|
|
763
|
-
export type
|
|
764
|
-
id: BookId;
|
|
2155
|
+
export type ApiDatasetEventSummary = {
|
|
765
2156
|
/**
|
|
766
|
-
* The
|
|
2157
|
+
* The ID of the event.
|
|
767
2158
|
*/
|
|
768
|
-
|
|
2159
|
+
id: string;
|
|
769
2160
|
/**
|
|
770
|
-
* The
|
|
2161
|
+
* The name of the event.
|
|
771
2162
|
*/
|
|
772
|
-
|
|
2163
|
+
name: string;
|
|
773
2164
|
/**
|
|
774
|
-
* The
|
|
2165
|
+
* The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.
|
|
775
2166
|
*/
|
|
776
|
-
|
|
777
|
-
firstChapterReference: DatasetChapterReference;
|
|
2167
|
+
startDate?: string;
|
|
778
2168
|
/**
|
|
779
|
-
* The number of
|
|
2169
|
+
* The number of Bible references that describe the event.
|
|
780
2170
|
*/
|
|
781
|
-
|
|
2171
|
+
numberOfReferences: number;
|
|
782
2172
|
/**
|
|
783
|
-
* The link
|
|
2173
|
+
* The API link for the event. Relative to the API origin.
|
|
784
2174
|
*/
|
|
785
|
-
|
|
786
|
-
|
|
2175
|
+
thisEventApiLink: string;
|
|
2176
|
+
};
|
|
2177
|
+
/**
|
|
2178
|
+
* The information about an event in a dataset. Maps to the /api/d/:datasetId/events/:eventId.json endpoint.
|
|
2179
|
+
*/
|
|
2180
|
+
export type ApiDatasetEvent = {
|
|
787
2181
|
/**
|
|
788
|
-
* The
|
|
2182
|
+
* The dataset information for the event.
|
|
789
2183
|
*/
|
|
790
|
-
|
|
2184
|
+
dataset: ApiDataset;
|
|
791
2185
|
/**
|
|
792
|
-
* The
|
|
2186
|
+
* The information about the event.
|
|
793
2187
|
*/
|
|
794
|
-
|
|
2188
|
+
event: DatasetEvent;
|
|
795
2189
|
/**
|
|
796
|
-
* The
|
|
2190
|
+
* The API link for this event. Relative to the API origin.
|
|
797
2191
|
*/
|
|
798
|
-
|
|
2192
|
+
thisEventApiLink: string;
|
|
799
2193
|
};
|
|
800
2194
|
/**
|
|
801
|
-
* Defines
|
|
2195
|
+
* Defines the schema for information about an event in a dataset.
|
|
802
2196
|
*/
|
|
803
|
-
export type
|
|
2197
|
+
export type DatasetEvent = {
|
|
804
2198
|
/**
|
|
805
|
-
* The ID of the
|
|
2199
|
+
* The ID of the event.
|
|
806
2200
|
*/
|
|
807
|
-
|
|
808
|
-
book: BookId;
|
|
2201
|
+
id: string;
|
|
809
2202
|
/**
|
|
810
|
-
* The
|
|
2203
|
+
* The name of the event.
|
|
811
2204
|
*/
|
|
812
|
-
|
|
813
|
-
};
|
|
814
|
-
/**
|
|
815
|
-
* Defines a schema that contains information about a book chapter in a dataset.
|
|
816
|
-
*/
|
|
817
|
-
export type ApiDatasetBookChapter = {
|
|
2205
|
+
name: string;
|
|
818
2206
|
/**
|
|
819
|
-
* The
|
|
2207
|
+
* The date that the event started at. Negative numbers are years BC. Positive numbers are years AD. More specific dates use the `YYYY-MM-DD` format.
|
|
820
2208
|
*/
|
|
821
|
-
|
|
2209
|
+
startDate?: string;
|
|
822
2210
|
/**
|
|
823
|
-
* The
|
|
2211
|
+
* The duration of the event. For example, "1D" is one day and "40Y" is fourty years.
|
|
824
2212
|
*/
|
|
825
|
-
|
|
2213
|
+
duration?: string;
|
|
826
2214
|
/**
|
|
827
|
-
* The
|
|
2215
|
+
* The people that participated in the event.
|
|
828
2216
|
*/
|
|
829
|
-
|
|
2217
|
+
participants?: Array<DatasetEntityRef>;
|
|
830
2218
|
/**
|
|
831
|
-
* The
|
|
2219
|
+
* The places that the event happened at.
|
|
832
2220
|
*/
|
|
833
|
-
|
|
834
|
-
thisChapterReference: DatasetChapterReference;
|
|
2221
|
+
locations?: Array<DatasetEntityRef>;
|
|
835
2222
|
/**
|
|
836
|
-
* The
|
|
2223
|
+
* The people groups that participated in the event.
|
|
837
2224
|
*/
|
|
838
|
-
|
|
2225
|
+
groups?: Array<DatasetEntityRef>;
|
|
839
2226
|
/**
|
|
840
|
-
* The
|
|
2227
|
+
* The event that this event is a part of.
|
|
841
2228
|
*/
|
|
842
|
-
|
|
2229
|
+
partOf?: DatasetEntityRef;
|
|
843
2230
|
/**
|
|
844
|
-
* The
|
|
2231
|
+
* The event that happened before this event.
|
|
845
2232
|
*/
|
|
846
|
-
|
|
2233
|
+
predecessor?: DatasetEntityRef;
|
|
847
2234
|
/**
|
|
848
|
-
* The
|
|
2235
|
+
* The list of Bible references that describe the event. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`.
|
|
849
2236
|
*/
|
|
850
|
-
|
|
2237
|
+
references: Array<VerseRef>;
|
|
2238
|
+
};
|
|
2239
|
+
/**
|
|
2240
|
+
* The list of people groups in a dataset. Maps to the /api/d/:datasetId/groups.json endpoint.
|
|
2241
|
+
*/
|
|
2242
|
+
export type ApiDatasetPeopleGroups = {
|
|
851
2243
|
/**
|
|
852
|
-
* The
|
|
2244
|
+
* The dataset information for the people groups.
|
|
853
2245
|
*/
|
|
854
|
-
|
|
2246
|
+
dataset: ApiDataset;
|
|
855
2247
|
/**
|
|
856
|
-
* The
|
|
2248
|
+
* The list of people groups that are available for the dataset.
|
|
857
2249
|
*/
|
|
858
|
-
|
|
2250
|
+
groups: Array<ApiDatasetPeopleGroupSummary>;
|
|
859
2251
|
};
|
|
860
2252
|
/**
|
|
861
|
-
* Defines
|
|
2253
|
+
* Defines a summary of a people group in a dataset.
|
|
862
2254
|
*/
|
|
863
|
-
export type
|
|
2255
|
+
export type ApiDatasetPeopleGroupSummary = {
|
|
864
2256
|
/**
|
|
865
|
-
* The
|
|
2257
|
+
* The ID of the people group.
|
|
866
2258
|
*/
|
|
867
|
-
|
|
2259
|
+
id: string;
|
|
868
2260
|
/**
|
|
869
|
-
* The
|
|
2261
|
+
* The name of the people group.
|
|
870
2262
|
*/
|
|
871
|
-
|
|
2263
|
+
name: string;
|
|
2264
|
+
/**
|
|
2265
|
+
* The number of people that are members of the people group.
|
|
2266
|
+
*/
|
|
2267
|
+
numberOfMembers: number;
|
|
2268
|
+
/**
|
|
2269
|
+
* The API link for the people group. Relative to the API origin.
|
|
2270
|
+
*/
|
|
2271
|
+
thisPeopleGroupApiLink: string;
|
|
872
2272
|
};
|
|
873
2273
|
/**
|
|
874
|
-
*
|
|
2274
|
+
* The information about a people group in a dataset. Maps to the /api/d/:datasetId/groups/:groupId.json endpoint.
|
|
875
2275
|
*/
|
|
876
|
-
export type
|
|
2276
|
+
export type ApiDatasetPeopleGroup = {
|
|
877
2277
|
/**
|
|
878
|
-
* The
|
|
2278
|
+
* The dataset information for the people group.
|
|
879
2279
|
*/
|
|
880
|
-
|
|
2280
|
+
dataset: ApiDataset;
|
|
881
2281
|
/**
|
|
882
|
-
* The
|
|
2282
|
+
* The information about the people group.
|
|
883
2283
|
*/
|
|
884
|
-
|
|
2284
|
+
group: DatasetPeopleGroup;
|
|
2285
|
+
/**
|
|
2286
|
+
* The API link for this people group. Relative to the API origin.
|
|
2287
|
+
*/
|
|
2288
|
+
thisPeopleGroupApiLink: string;
|
|
885
2289
|
};
|
|
886
2290
|
/**
|
|
887
|
-
* Defines the schema for information about a
|
|
2291
|
+
* Defines the schema for information about a people group in a dataset.
|
|
888
2292
|
*/
|
|
889
|
-
export type
|
|
890
|
-
book: BookId;
|
|
2293
|
+
export type DatasetPeopleGroup = {
|
|
891
2294
|
/**
|
|
892
|
-
* The
|
|
2295
|
+
* The ID of the people group.
|
|
893
2296
|
*/
|
|
894
|
-
|
|
2297
|
+
id: string;
|
|
895
2298
|
/**
|
|
896
|
-
* The
|
|
2299
|
+
* The name of the people group.
|
|
897
2300
|
*/
|
|
898
|
-
|
|
2301
|
+
name: string;
|
|
899
2302
|
/**
|
|
900
|
-
* The
|
|
2303
|
+
* The people that are members of the people group.
|
|
901
2304
|
*/
|
|
902
|
-
|
|
2305
|
+
members?: Array<DatasetEntityRef>;
|
|
903
2306
|
/**
|
|
904
|
-
* The
|
|
2307
|
+
* The events that the people group participated in.
|
|
905
2308
|
*/
|
|
906
|
-
|
|
2309
|
+
events?: Array<DatasetEntityRef>;
|
|
2310
|
+
/**
|
|
2311
|
+
* The list of Bible references that mention the people group. Sorted by book order, chapter, and verse. Consecutive verses in the same chapter are collapsed into a single reference using `endVerse`.
|
|
2312
|
+
*/
|
|
2313
|
+
references: Array<VerseRef>;
|
|
2314
|
+
};
|
|
2315
|
+
export type GetAvailableTranslationsData = {
|
|
2316
|
+
body?: never;
|
|
2317
|
+
path?: never;
|
|
2318
|
+
query?: never;
|
|
2319
|
+
url: '/api/available_translations.json';
|
|
2320
|
+
};
|
|
2321
|
+
export type GetAvailableTranslationsResponses = {
|
|
2322
|
+
/**
|
|
2323
|
+
* 200 OK
|
|
2324
|
+
*/
|
|
2325
|
+
200: ApiAvailableTranslations;
|
|
2326
|
+
};
|
|
2327
|
+
export type GetAvailableTranslationsResponse = GetAvailableTranslationsResponses[keyof GetAvailableTranslationsResponses];
|
|
2328
|
+
export type GetTranslationBooksData = {
|
|
2329
|
+
body?: never;
|
|
2330
|
+
path: {
|
|
2331
|
+
/**
|
|
2332
|
+
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
2333
|
+
*/
|
|
2334
|
+
translation: string;
|
|
2335
|
+
};
|
|
2336
|
+
query?: never;
|
|
2337
|
+
url: '/api/{translation}/books.json';
|
|
2338
|
+
};
|
|
2339
|
+
export type GetTranslationBooksErrors = {
|
|
2340
|
+
/**
|
|
2341
|
+
* 404 Not Found - The specified translation was not found.
|
|
2342
|
+
*/
|
|
2343
|
+
404: unknown;
|
|
2344
|
+
};
|
|
2345
|
+
export type GetTranslationBooksResponses = {
|
|
2346
|
+
/**
|
|
2347
|
+
* 200 OK
|
|
2348
|
+
*/
|
|
2349
|
+
200: ApiTranslationBooks;
|
|
2350
|
+
};
|
|
2351
|
+
export type GetTranslationBooksResponse = GetTranslationBooksResponses[keyof GetTranslationBooksResponses];
|
|
2352
|
+
export type GetTranslationBookChapterData = {
|
|
2353
|
+
body?: never;
|
|
2354
|
+
path: {
|
|
2355
|
+
/**
|
|
2356
|
+
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
2357
|
+
*/
|
|
2358
|
+
translation: string;
|
|
2359
|
+
/**
|
|
2360
|
+
* IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
|
|
2361
|
+
*/
|
|
2362
|
+
book: BookId;
|
|
2363
|
+
/**
|
|
2364
|
+
* The chapter number to get the content for. This should be a positive integer.
|
|
2365
|
+
*/
|
|
2366
|
+
chapter: number;
|
|
2367
|
+
};
|
|
2368
|
+
query?: never;
|
|
2369
|
+
url: '/api/{translation}/{book}/{chapter}.json';
|
|
2370
|
+
};
|
|
2371
|
+
export type GetTranslationBookChapterErrors = {
|
|
2372
|
+
/**
|
|
2373
|
+
* 404 Not Found - The specified translation, book, or chapter was not found.
|
|
2374
|
+
*/
|
|
2375
|
+
404: unknown;
|
|
2376
|
+
};
|
|
2377
|
+
export type GetTranslationBookChapterResponses = {
|
|
2378
|
+
/**
|
|
2379
|
+
* 200 OK
|
|
2380
|
+
*/
|
|
2381
|
+
200: ApiTranslationBookChapter;
|
|
2382
|
+
};
|
|
2383
|
+
export type GetTranslationBookChapterResponse = GetTranslationBookChapterResponses[keyof GetTranslationBookChapterResponses];
|
|
2384
|
+
export type GetSimpleTranslationBookChapterData = {
|
|
2385
|
+
body?: never;
|
|
2386
|
+
path: {
|
|
2387
|
+
/**
|
|
2388
|
+
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
2389
|
+
*/
|
|
2390
|
+
translation: string;
|
|
2391
|
+
/**
|
|
2392
|
+
* IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
|
|
2393
|
+
*/
|
|
2394
|
+
book: BookId;
|
|
2395
|
+
/**
|
|
2396
|
+
* The chapter number to get the content for. This should be a positive integer.
|
|
2397
|
+
*/
|
|
2398
|
+
chapter: number;
|
|
2399
|
+
};
|
|
2400
|
+
query?: never;
|
|
2401
|
+
url: '/api/{translation}/{book}/{chapter}.simple.json';
|
|
2402
|
+
};
|
|
2403
|
+
export type GetSimpleTranslationBookChapterErrors = {
|
|
907
2404
|
/**
|
|
908
|
-
*
|
|
2405
|
+
* 404 Not Found - The specified translation, book, or chapter was not found.
|
|
909
2406
|
*/
|
|
910
|
-
|
|
2407
|
+
404: unknown;
|
|
2408
|
+
};
|
|
2409
|
+
export type GetSimpleTranslationBookChapterResponses = {
|
|
911
2410
|
/**
|
|
912
|
-
*
|
|
2411
|
+
* 200 OK
|
|
913
2412
|
*/
|
|
914
|
-
|
|
2413
|
+
200: ApiSimpleTranslationBookChapter;
|
|
915
2414
|
};
|
|
916
|
-
export type
|
|
2415
|
+
export type GetSimpleTranslationBookChapterResponse = GetSimpleTranslationBookChapterResponses[keyof GetSimpleTranslationBookChapterResponses];
|
|
2416
|
+
export type GetTranslationBookChapterAudioTimingsData = {
|
|
917
2417
|
body?: never;
|
|
918
|
-
path
|
|
2418
|
+
path: {
|
|
2419
|
+
/**
|
|
2420
|
+
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
2421
|
+
*/
|
|
2422
|
+
translation: string;
|
|
2423
|
+
/**
|
|
2424
|
+
* IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
|
|
2425
|
+
*/
|
|
2426
|
+
book: BookId;
|
|
2427
|
+
/**
|
|
2428
|
+
* The chapter number to get the content for. This should be a positive integer.
|
|
2429
|
+
*/
|
|
2430
|
+
chapter: number;
|
|
2431
|
+
/**
|
|
2432
|
+
* The ID of the reader to get the audio timings for. For example, "hays" for the Hays reading of the Berean Standard Bible.
|
|
2433
|
+
*/
|
|
2434
|
+
reader: string;
|
|
2435
|
+
};
|
|
919
2436
|
query?: never;
|
|
920
|
-
url: '/api/
|
|
2437
|
+
url: '/api/{translation}/{book}/{chapter}.{reader}.audioTimings.json';
|
|
921
2438
|
};
|
|
922
|
-
export type
|
|
2439
|
+
export type GetTranslationBookChapterAudioTimingsErrors = {
|
|
2440
|
+
/**
|
|
2441
|
+
* 404 Not Found - The specified translation, book, chapter, or reader was not found.
|
|
2442
|
+
*/
|
|
2443
|
+
404: unknown;
|
|
2444
|
+
};
|
|
2445
|
+
export type GetTranslationBookChapterAudioTimingsResponses = {
|
|
923
2446
|
/**
|
|
924
2447
|
* 200 OK
|
|
925
2448
|
*/
|
|
926
|
-
200:
|
|
2449
|
+
200: ApiTranslationBookChapterAudioTimings;
|
|
927
2450
|
};
|
|
928
|
-
export type
|
|
929
|
-
export type
|
|
2451
|
+
export type GetTranslationBookChapterAudioTimingsResponse = GetTranslationBookChapterAudioTimingsResponses[keyof GetTranslationBookChapterAudioTimingsResponses];
|
|
2452
|
+
export type GetTranslationBookChapterWordsData = {
|
|
930
2453
|
body?: never;
|
|
931
2454
|
path: {
|
|
932
2455
|
/**
|
|
933
2456
|
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
934
2457
|
*/
|
|
935
2458
|
translation: string;
|
|
2459
|
+
/**
|
|
2460
|
+
* IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
|
|
2461
|
+
*/
|
|
2462
|
+
book: BookId;
|
|
2463
|
+
/**
|
|
2464
|
+
* The chapter number to get the content for. This should be a positive integer.
|
|
2465
|
+
*/
|
|
2466
|
+
chapter: number;
|
|
936
2467
|
};
|
|
937
2468
|
query?: never;
|
|
938
|
-
url: '/api/{translation}/
|
|
2469
|
+
url: '/api/{translation}/{book}/{chapter}.words.json';
|
|
939
2470
|
};
|
|
940
|
-
export type
|
|
2471
|
+
export type GetTranslationBookChapterWordsErrors = {
|
|
941
2472
|
/**
|
|
942
|
-
* 404 Not Found - The specified translation was not found.
|
|
2473
|
+
* 404 Not Found - The specified translation, book, or chapter was not found, or the chapter does not have any word-level annotations.
|
|
943
2474
|
*/
|
|
944
2475
|
404: unknown;
|
|
945
2476
|
};
|
|
946
|
-
export type
|
|
2477
|
+
export type GetTranslationBookChapterWordsResponses = {
|
|
947
2478
|
/**
|
|
948
2479
|
* 200 OK
|
|
949
2480
|
*/
|
|
950
|
-
200:
|
|
2481
|
+
200: ApiTranslationBookChapterWords;
|
|
951
2482
|
};
|
|
952
|
-
export type
|
|
953
|
-
export type
|
|
2483
|
+
export type GetTranslationBookChapterWordsResponse = GetTranslationBookChapterWordsResponses[keyof GetTranslationBookChapterWordsResponses];
|
|
2484
|
+
export type GetSimpleTranslationBookChapterWordsData = {
|
|
954
2485
|
body?: never;
|
|
955
2486
|
path: {
|
|
956
2487
|
/**
|
|
@@ -967,21 +2498,21 @@ export type GetTranslationBookChapterData = {
|
|
|
967
2498
|
chapter: number;
|
|
968
2499
|
};
|
|
969
2500
|
query?: never;
|
|
970
|
-
url: '/api/{translation}/{book}/{chapter}.json';
|
|
2501
|
+
url: '/api/{translation}/{book}/{chapter}.words.simple.json';
|
|
971
2502
|
};
|
|
972
|
-
export type
|
|
2503
|
+
export type GetSimpleTranslationBookChapterWordsErrors = {
|
|
973
2504
|
/**
|
|
974
|
-
* 404 Not Found - The specified translation, book, or chapter was not found.
|
|
2505
|
+
* 404 Not Found - The specified translation, book, or chapter was not found, or the chapter does not have any word-level annotations.
|
|
975
2506
|
*/
|
|
976
2507
|
404: unknown;
|
|
977
2508
|
};
|
|
978
|
-
export type
|
|
2509
|
+
export type GetSimpleTranslationBookChapterWordsResponses = {
|
|
979
2510
|
/**
|
|
980
2511
|
* 200 OK
|
|
981
2512
|
*/
|
|
982
|
-
200:
|
|
2513
|
+
200: ApiSimpleTranslationBookChapterWords;
|
|
983
2514
|
};
|
|
984
|
-
export type
|
|
2515
|
+
export type GetSimpleTranslationBookChapterWordsResponse = GetSimpleTranslationBookChapterWordsResponses[keyof GetSimpleTranslationBookChapterWordsResponses];
|
|
985
2516
|
export type GetTranslationCompleteData = {
|
|
986
2517
|
body?: never;
|
|
987
2518
|
path: {
|
|
@@ -1006,6 +2537,30 @@ export type GetTranslationCompleteResponses = {
|
|
|
1006
2537
|
200: ApiTranslationComplete;
|
|
1007
2538
|
};
|
|
1008
2539
|
export type GetTranslationCompleteResponse = GetTranslationCompleteResponses[keyof GetTranslationCompleteResponses];
|
|
2540
|
+
export type GetSimpleTranslationCompleteData = {
|
|
2541
|
+
body?: never;
|
|
2542
|
+
path: {
|
|
2543
|
+
/**
|
|
2544
|
+
* The translation ID of the Bible translation to get the books for. For example, "eng_kjv" for the King James Version.
|
|
2545
|
+
*/
|
|
2546
|
+
translation: string;
|
|
2547
|
+
};
|
|
2548
|
+
query?: never;
|
|
2549
|
+
url: '/api/{translation}/complete.simple.json';
|
|
2550
|
+
};
|
|
2551
|
+
export type GetSimpleTranslationCompleteErrors = {
|
|
2552
|
+
/**
|
|
2553
|
+
* 404 Not Found - The specified translation was not found, or complete translations are not available.
|
|
2554
|
+
*/
|
|
2555
|
+
404: unknown;
|
|
2556
|
+
};
|
|
2557
|
+
export type GetSimpleTranslationCompleteResponses = {
|
|
2558
|
+
/**
|
|
2559
|
+
* 200 OK
|
|
2560
|
+
*/
|
|
2561
|
+
200: ApiSimpleTranslationComplete;
|
|
2562
|
+
};
|
|
2563
|
+
export type GetSimpleTranslationCompleteResponse = GetSimpleTranslationCompleteResponses[keyof GetSimpleTranslationCompleteResponses];
|
|
1009
2564
|
export type GetAvailableCommentariesData = {
|
|
1010
2565
|
body?: never;
|
|
1011
2566
|
path?: never;
|
|
@@ -1075,6 +2630,38 @@ export type GetCommentaryBookChapterResponses = {
|
|
|
1075
2630
|
200: ApiCommentaryBookChapter;
|
|
1076
2631
|
};
|
|
1077
2632
|
export type GetCommentaryBookChapterResponse = GetCommentaryBookChapterResponses[keyof GetCommentaryBookChapterResponses];
|
|
2633
|
+
export type GetSimpleCommentaryBookChapterData = {
|
|
2634
|
+
body?: never;
|
|
2635
|
+
path: {
|
|
2636
|
+
/**
|
|
2637
|
+
* The commentary ID of the commentary to get the books or chapter content for.
|
|
2638
|
+
*/
|
|
2639
|
+
commentary: string;
|
|
2640
|
+
/**
|
|
2641
|
+
* IDs for books. Follows the USFM standard (https://ubsicap.github.io/usfm/identification/books.html)
|
|
2642
|
+
*/
|
|
2643
|
+
book: BookId;
|
|
2644
|
+
/**
|
|
2645
|
+
* The chapter number to get the content for. This should be a positive integer.
|
|
2646
|
+
*/
|
|
2647
|
+
chapter: number;
|
|
2648
|
+
};
|
|
2649
|
+
query?: never;
|
|
2650
|
+
url: '/api/c/{commentary}/{book}/{chapter}.simple.json';
|
|
2651
|
+
};
|
|
2652
|
+
export type GetSimpleCommentaryBookChapterErrors = {
|
|
2653
|
+
/**
|
|
2654
|
+
* 404 Not Found - The specified commentary, book, or chapter was not found.
|
|
2655
|
+
*/
|
|
2656
|
+
404: unknown;
|
|
2657
|
+
};
|
|
2658
|
+
export type GetSimpleCommentaryBookChapterResponses = {
|
|
2659
|
+
/**
|
|
2660
|
+
* 200 OK
|
|
2661
|
+
*/
|
|
2662
|
+
200: ApiSimpleCommentaryBookChapter;
|
|
2663
|
+
};
|
|
2664
|
+
export type GetSimpleCommentaryBookChapterResponse = GetSimpleCommentaryBookChapterResponses[keyof GetSimpleCommentaryBookChapterResponses];
|
|
1078
2665
|
export type GetAvailableDatasetsData = {
|
|
1079
2666
|
body?: never;
|
|
1080
2667
|
path?: never;
|
|
@@ -1141,7 +2728,215 @@ export type GetDatasetBookChapterResponses = {
|
|
|
1141
2728
|
/**
|
|
1142
2729
|
* 200 OK
|
|
1143
2730
|
*/
|
|
1144
|
-
200: ApiDatasetBookChapter;
|
|
2731
|
+
200: ApiDatasetBookChapter | ApiDatasetEntityBookChapter;
|
|
1145
2732
|
};
|
|
1146
2733
|
export type GetDatasetBookChapterResponse = GetDatasetBookChapterResponses[keyof GetDatasetBookChapterResponses];
|
|
2734
|
+
export type GetDatasetPeopleData = {
|
|
2735
|
+
body?: never;
|
|
2736
|
+
path: {
|
|
2737
|
+
/**
|
|
2738
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2739
|
+
*/
|
|
2740
|
+
dataset: string;
|
|
2741
|
+
};
|
|
2742
|
+
query?: never;
|
|
2743
|
+
url: '/api/d/{dataset}/people.json';
|
|
2744
|
+
};
|
|
2745
|
+
export type GetDatasetPeopleErrors = {
|
|
2746
|
+
/**
|
|
2747
|
+
* 404 Not Found - The specified dataset was not found or doesn't contain people.
|
|
2748
|
+
*/
|
|
2749
|
+
404: unknown;
|
|
2750
|
+
};
|
|
2751
|
+
export type GetDatasetPeopleResponses = {
|
|
2752
|
+
/**
|
|
2753
|
+
* 200 OK
|
|
2754
|
+
*/
|
|
2755
|
+
200: ApiDatasetPeople;
|
|
2756
|
+
};
|
|
2757
|
+
export type GetDatasetPeopleResponse = GetDatasetPeopleResponses[keyof GetDatasetPeopleResponses];
|
|
2758
|
+
export type GetDatasetPersonData = {
|
|
2759
|
+
body?: never;
|
|
2760
|
+
path: {
|
|
2761
|
+
/**
|
|
2762
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2763
|
+
*/
|
|
2764
|
+
dataset: string;
|
|
2765
|
+
/**
|
|
2766
|
+
* The ID of the person to get the information for. For example, "paul_2479" for the apostle Paul.
|
|
2767
|
+
*/
|
|
2768
|
+
person: string;
|
|
2769
|
+
};
|
|
2770
|
+
query?: never;
|
|
2771
|
+
url: '/api/d/{dataset}/people/{person}.json';
|
|
2772
|
+
};
|
|
2773
|
+
export type GetDatasetPersonErrors = {
|
|
2774
|
+
/**
|
|
2775
|
+
* 404 Not Found - The specified dataset or person was not found.
|
|
2776
|
+
*/
|
|
2777
|
+
404: unknown;
|
|
2778
|
+
};
|
|
2779
|
+
export type GetDatasetPersonResponses = {
|
|
2780
|
+
/**
|
|
2781
|
+
* 200 OK
|
|
2782
|
+
*/
|
|
2783
|
+
200: ApiDatasetPerson;
|
|
2784
|
+
};
|
|
2785
|
+
export type GetDatasetPersonResponse = GetDatasetPersonResponses[keyof GetDatasetPersonResponses];
|
|
2786
|
+
export type GetDatasetPlacesData = {
|
|
2787
|
+
body?: never;
|
|
2788
|
+
path: {
|
|
2789
|
+
/**
|
|
2790
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2791
|
+
*/
|
|
2792
|
+
dataset: string;
|
|
2793
|
+
};
|
|
2794
|
+
query?: never;
|
|
2795
|
+
url: '/api/d/{dataset}/places.json';
|
|
2796
|
+
};
|
|
2797
|
+
export type GetDatasetPlacesErrors = {
|
|
2798
|
+
/**
|
|
2799
|
+
* 404 Not Found - The specified dataset was not found or doesn't contain places.
|
|
2800
|
+
*/
|
|
2801
|
+
404: unknown;
|
|
2802
|
+
};
|
|
2803
|
+
export type GetDatasetPlacesResponses = {
|
|
2804
|
+
/**
|
|
2805
|
+
* 200 OK
|
|
2806
|
+
*/
|
|
2807
|
+
200: ApiDatasetPlaces;
|
|
2808
|
+
};
|
|
2809
|
+
export type GetDatasetPlacesResponse = GetDatasetPlacesResponses[keyof GetDatasetPlacesResponses];
|
|
2810
|
+
export type GetDatasetPlaceData = {
|
|
2811
|
+
body?: never;
|
|
2812
|
+
path: {
|
|
2813
|
+
/**
|
|
2814
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2815
|
+
*/
|
|
2816
|
+
dataset: string;
|
|
2817
|
+
/**
|
|
2818
|
+
* The ID of the place to get the information for. For example, "jerusalem_636" for Jerusalem.
|
|
2819
|
+
*/
|
|
2820
|
+
place: string;
|
|
2821
|
+
};
|
|
2822
|
+
query?: never;
|
|
2823
|
+
url: '/api/d/{dataset}/places/{place}.json';
|
|
2824
|
+
};
|
|
2825
|
+
export type GetDatasetPlaceErrors = {
|
|
2826
|
+
/**
|
|
2827
|
+
* 404 Not Found - The specified dataset or place was not found.
|
|
2828
|
+
*/
|
|
2829
|
+
404: unknown;
|
|
2830
|
+
};
|
|
2831
|
+
export type GetDatasetPlaceResponses = {
|
|
2832
|
+
/**
|
|
2833
|
+
* 200 OK
|
|
2834
|
+
*/
|
|
2835
|
+
200: ApiDatasetPlace;
|
|
2836
|
+
};
|
|
2837
|
+
export type GetDatasetPlaceResponse = GetDatasetPlaceResponses[keyof GetDatasetPlaceResponses];
|
|
2838
|
+
export type GetDatasetEventsData = {
|
|
2839
|
+
body?: never;
|
|
2840
|
+
path: {
|
|
2841
|
+
/**
|
|
2842
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2843
|
+
*/
|
|
2844
|
+
dataset: string;
|
|
2845
|
+
};
|
|
2846
|
+
query?: never;
|
|
2847
|
+
url: '/api/d/{dataset}/events.json';
|
|
2848
|
+
};
|
|
2849
|
+
export type GetDatasetEventsErrors = {
|
|
2850
|
+
/**
|
|
2851
|
+
* 404 Not Found - The specified dataset was not found or doesn't contain events.
|
|
2852
|
+
*/
|
|
2853
|
+
404: unknown;
|
|
2854
|
+
};
|
|
2855
|
+
export type GetDatasetEventsResponses = {
|
|
2856
|
+
/**
|
|
2857
|
+
* 200 OK
|
|
2858
|
+
*/
|
|
2859
|
+
200: ApiDatasetEvents;
|
|
2860
|
+
};
|
|
2861
|
+
export type GetDatasetEventsResponse = GetDatasetEventsResponses[keyof GetDatasetEventsResponses];
|
|
2862
|
+
export type GetDatasetEventData = {
|
|
2863
|
+
body?: never;
|
|
2864
|
+
path: {
|
|
2865
|
+
/**
|
|
2866
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2867
|
+
*/
|
|
2868
|
+
dataset: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* The ID of the event to get the information for. For example, "saul-is-converted_326" for the conversion of Saul.
|
|
2871
|
+
*/
|
|
2872
|
+
event: string;
|
|
2873
|
+
};
|
|
2874
|
+
query?: never;
|
|
2875
|
+
url: '/api/d/{dataset}/events/{event}.json';
|
|
2876
|
+
};
|
|
2877
|
+
export type GetDatasetEventErrors = {
|
|
2878
|
+
/**
|
|
2879
|
+
* 404 Not Found - The specified dataset or event was not found.
|
|
2880
|
+
*/
|
|
2881
|
+
404: unknown;
|
|
2882
|
+
};
|
|
2883
|
+
export type GetDatasetEventResponses = {
|
|
2884
|
+
/**
|
|
2885
|
+
* 200 OK
|
|
2886
|
+
*/
|
|
2887
|
+
200: ApiDatasetEvent;
|
|
2888
|
+
};
|
|
2889
|
+
export type GetDatasetEventResponse = GetDatasetEventResponses[keyof GetDatasetEventResponses];
|
|
2890
|
+
export type GetDatasetPeopleGroupsData = {
|
|
2891
|
+
body?: never;
|
|
2892
|
+
path: {
|
|
2893
|
+
/**
|
|
2894
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2895
|
+
*/
|
|
2896
|
+
dataset: string;
|
|
2897
|
+
};
|
|
2898
|
+
query?: never;
|
|
2899
|
+
url: '/api/d/{dataset}/groups.json';
|
|
2900
|
+
};
|
|
2901
|
+
export type GetDatasetPeopleGroupsErrors = {
|
|
2902
|
+
/**
|
|
2903
|
+
* 404 Not Found - The specified dataset was not found or doesn't contain people groups.
|
|
2904
|
+
*/
|
|
2905
|
+
404: unknown;
|
|
2906
|
+
};
|
|
2907
|
+
export type GetDatasetPeopleGroupsResponses = {
|
|
2908
|
+
/**
|
|
2909
|
+
* 200 OK
|
|
2910
|
+
*/
|
|
2911
|
+
200: ApiDatasetPeopleGroups;
|
|
2912
|
+
};
|
|
2913
|
+
export type GetDatasetPeopleGroupsResponse = GetDatasetPeopleGroupsResponses[keyof GetDatasetPeopleGroupsResponses];
|
|
2914
|
+
export type GetDatasetPeopleGroupData = {
|
|
2915
|
+
body?: never;
|
|
2916
|
+
path: {
|
|
2917
|
+
/**
|
|
2918
|
+
* The dataset ID of the dataset to get the books or chapter content for.
|
|
2919
|
+
*/
|
|
2920
|
+
dataset: string;
|
|
2921
|
+
/**
|
|
2922
|
+
* The ID of the people group to get the information for. For example, "tribe-of-benjamin" for the tribe of Benjamin.
|
|
2923
|
+
*/
|
|
2924
|
+
group: string;
|
|
2925
|
+
};
|
|
2926
|
+
query?: never;
|
|
2927
|
+
url: '/api/d/{dataset}/groups/{group}.json';
|
|
2928
|
+
};
|
|
2929
|
+
export type GetDatasetPeopleGroupErrors = {
|
|
2930
|
+
/**
|
|
2931
|
+
* 404 Not Found - The specified dataset or people group was not found.
|
|
2932
|
+
*/
|
|
2933
|
+
404: unknown;
|
|
2934
|
+
};
|
|
2935
|
+
export type GetDatasetPeopleGroupResponses = {
|
|
2936
|
+
/**
|
|
2937
|
+
* 200 OK
|
|
2938
|
+
*/
|
|
2939
|
+
200: ApiDatasetPeopleGroup;
|
|
2940
|
+
};
|
|
2941
|
+
export type GetDatasetPeopleGroupResponse = GetDatasetPeopleGroupResponses[keyof GetDatasetPeopleGroupResponses];
|
|
1147
2942
|
//# sourceMappingURL=types.gen.d.ts.map
|