@invinite-org/data-api-client 0.3.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.
Files changed (97) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/EarningsCallsApi.d.ts +46 -6
  3. package/dist/apis/EarningsCallsApi.js +51 -7
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +46 -6
  5. package/dist/esm/apis/EarningsCallsApi.js +50 -6
  6. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  7. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  8. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  9. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
  10. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
  11. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +18 -0
  12. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  13. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  14. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  15. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  16. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  17. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  18. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +23 -0
  19. package/dist/esm/models/EarningsCallsSearch200Response.js +18 -0
  20. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  21. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  22. package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
  23. package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
  24. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  25. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
  26. package/dist/esm/models/HitMatch.d.ts +61 -0
  27. package/dist/esm/models/HitMatch.js +65 -0
  28. package/dist/esm/models/MatchSpan.d.ts +38 -0
  29. package/dist/esm/models/MatchSpan.js +47 -0
  30. package/dist/esm/models/SearchCoverage.d.ts +73 -0
  31. package/dist/esm/models/SearchCoverage.js +76 -0
  32. package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
  33. package/dist/esm/models/SearchCoverageLeg.js +63 -0
  34. package/dist/esm/models/index.d.ts +6 -0
  35. package/dist/esm/models/index.js +6 -0
  36. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  37. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  38. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  39. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
  40. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
  41. package/dist/models/EarningsCallsDocumentSearch200Response.js +19 -0
  42. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  43. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  44. package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  45. package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  46. package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  47. package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  48. package/dist/models/EarningsCallsSearch200Response.d.ts +23 -0
  49. package/dist/models/EarningsCallsSearch200Response.js +19 -0
  50. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  51. package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  52. package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
  53. package/dist/models/EarningsCallsSlides200Response.js +5 -0
  54. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  55. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
  56. package/dist/models/HitMatch.d.ts +61 -0
  57. package/dist/models/HitMatch.js +73 -0
  58. package/dist/models/MatchSpan.d.ts +38 -0
  59. package/dist/models/MatchSpan.js +54 -0
  60. package/dist/models/SearchCoverage.d.ts +73 -0
  61. package/dist/models/SearchCoverage.js +84 -0
  62. package/dist/models/SearchCoverageLeg.d.ts +59 -0
  63. package/dist/models/SearchCoverageLeg.js +71 -0
  64. package/dist/models/index.d.ts +6 -0
  65. package/dist/models/index.js +6 -0
  66. package/docs/EarningsCallsApi.md +22 -10
  67. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  68. package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
  69. package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
  70. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  71. package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
  72. package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
  73. package/docs/EarningsCallsSearch200Response.md +4 -0
  74. package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
  75. package/docs/EarningsCallsSlides200Response.md +2 -0
  76. package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
  77. package/docs/HitMatch.md +41 -0
  78. package/docs/MatchSpan.md +36 -0
  79. package/docs/SearchCoverage.md +41 -0
  80. package/docs/SearchCoverageLeg.md +41 -0
  81. package/package.json +1 -1
  82. package/src/apis/EarningsCallsApi.ts +62 -6
  83. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
  84. package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
  85. package/src/models/EarningsCallsDocumentSearch200Response.ts +38 -0
  86. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
  87. package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
  88. package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
  89. package/src/models/EarningsCallsSearch200Response.ts +38 -0
  90. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
  91. package/src/models/EarningsCallsSlides200Response.ts +16 -0
  92. package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
  93. package/src/models/HitMatch.ts +114 -0
  94. package/src/models/MatchSpan.ts +75 -0
  95. package/src/models/SearchCoverage.ts +127 -0
  96. package/src/models/SearchCoverageLeg.ts +105 -0
  97. package/src/models/index.ts +6 -0
@@ -44,6 +44,7 @@ export * from './EarningsCallsAnalysts200ResponseAnalystsInner';
44
44
  export * from './EarningsCallsAudio200Response';
45
45
  export * from './EarningsCallsCalendar200Response';
46
46
  export * from './EarningsCallsCalendar200ResponseEventsInner';
47
+ export * from './EarningsCallsCalendar200ResponseEventsInnerVideo';
47
48
  export * from './EarningsCallsCompanyDocument200Response';
48
49
  export * from './EarningsCallsCompanyDocuments200Response';
49
50
  export * from './EarningsCallsCompanyDocuments200ResponseCompany';
@@ -102,6 +103,7 @@ export * from './EarningsCallsSearch200ResponseHitsInnerSlide';
102
103
  export * from './EarningsCallsSlides200Response';
103
104
  export * from './EarningsCallsSlides200ResponseDeck';
104
105
  export * from './EarningsCallsSlides200ResponseSlidesInner';
106
+ export * from './EarningsCallsSlides200ResponseTimelineInner';
105
107
  export * from './EarningsCallsTranscript200Response';
106
108
  export * from './EarningsCallsTranscript404Response';
107
109
  export * from './EarningsCallsTranscriptDiff200Response';
@@ -125,6 +127,7 @@ export * from './FinancialMetricsRatios200ResponseCompaniesInner';
125
127
  export * from './FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner';
126
128
  export * from './ForbiddenError';
127
129
  export * from './HealthGet200Response';
130
+ export * from './HitMatch';
128
131
  export * from './InsiderTradesList200Response';
129
132
  export * from './InsiderTradesList200ResponseTransactionsInner';
130
133
  export * from './InstitutionalOwnershipHoldingsByCompany200Response';
@@ -139,6 +142,7 @@ export * from './IposList200Response';
139
142
  export * from './IposList200ResponseIposInner';
140
143
  export * from './MarketHolidays200Response';
141
144
  export * from './MarketHolidays200ResponseHolidaysInner';
145
+ export * from './MatchSpan';
142
146
  export * from './MetadataAvailableMetrics200Response';
143
147
  export * from './MetadataAvailableMetrics200ResponseMetricsInner';
144
148
  export * from './MetadataAvailableSectionIds200Response';
@@ -146,6 +150,8 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
146
150
  export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
147
151
  export * from './NotFoundError';
148
152
  export * from './PresentationFact';
153
+ export * from './SearchCoverage';
154
+ export * from './SearchCoverageLeg';
149
155
  export * from './SecFilingsAvailableFormTypes200Response';
150
156
  export * from './SecFilingsList200Response';
151
157
  export * from './SecFilingsList200ResponseCompaniesInner';
@@ -62,6 +62,7 @@ __exportStar(require("./EarningsCallsAnalysts200ResponseAnalystsInner"), exports
62
62
  __exportStar(require("./EarningsCallsAudio200Response"), exports);
63
63
  __exportStar(require("./EarningsCallsCalendar200Response"), exports);
64
64
  __exportStar(require("./EarningsCallsCalendar200ResponseEventsInner"), exports);
65
+ __exportStar(require("./EarningsCallsCalendar200ResponseEventsInnerVideo"), exports);
65
66
  __exportStar(require("./EarningsCallsCompanyDocument200Response"), exports);
66
67
  __exportStar(require("./EarningsCallsCompanyDocuments200Response"), exports);
67
68
  __exportStar(require("./EarningsCallsCompanyDocuments200ResponseCompany"), exports);
@@ -120,6 +121,7 @@ __exportStar(require("./EarningsCallsSearch200ResponseHitsInnerSlide"), exports)
120
121
  __exportStar(require("./EarningsCallsSlides200Response"), exports);
121
122
  __exportStar(require("./EarningsCallsSlides200ResponseDeck"), exports);
122
123
  __exportStar(require("./EarningsCallsSlides200ResponseSlidesInner"), exports);
124
+ __exportStar(require("./EarningsCallsSlides200ResponseTimelineInner"), exports);
123
125
  __exportStar(require("./EarningsCallsTranscript200Response"), exports);
124
126
  __exportStar(require("./EarningsCallsTranscript404Response"), exports);
125
127
  __exportStar(require("./EarningsCallsTranscriptDiff200Response"), exports);
@@ -143,6 +145,7 @@ __exportStar(require("./FinancialMetricsRatios200ResponseCompaniesInner"), expor
143
145
  __exportStar(require("./FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner"), exports);
144
146
  __exportStar(require("./ForbiddenError"), exports);
145
147
  __exportStar(require("./HealthGet200Response"), exports);
148
+ __exportStar(require("./HitMatch"), exports);
146
149
  __exportStar(require("./InsiderTradesList200Response"), exports);
147
150
  __exportStar(require("./InsiderTradesList200ResponseTransactionsInner"), exports);
148
151
  __exportStar(require("./InstitutionalOwnershipHoldingsByCompany200Response"), exports);
@@ -157,6 +160,7 @@ __exportStar(require("./IposList200Response"), exports);
157
160
  __exportStar(require("./IposList200ResponseIposInner"), exports);
158
161
  __exportStar(require("./MarketHolidays200Response"), exports);
159
162
  __exportStar(require("./MarketHolidays200ResponseHolidaysInner"), exports);
163
+ __exportStar(require("./MatchSpan"), exports);
160
164
  __exportStar(require("./MetadataAvailableMetrics200Response"), exports);
161
165
  __exportStar(require("./MetadataAvailableMetrics200ResponseMetricsInner"), exports);
162
166
  __exportStar(require("./MetadataAvailableSectionIds200Response"), exports);
@@ -164,6 +168,8 @@ __exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInner"),
164
168
  __exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner"), exports);
165
169
  __exportStar(require("./NotFoundError"), exports);
166
170
  __exportStar(require("./PresentationFact"), exports);
171
+ __exportStar(require("./SearchCoverage"), exports);
172
+ __exportStar(require("./SearchCoverageLeg"), exports);
167
173
  __exportStar(require("./SecFilingsAvailableFormTypes200Response"), exports);
168
174
  __exportStar(require("./SecFilingsList200Response"), exports);
169
175
  __exportStar(require("./SecFilingsList200ResponseCompaniesInner"), exports);
@@ -597,11 +597,11 @@ example().catch(console.error);
597
597
 
598
598
  ## earningsCallsDocumentSearch
599
599
 
600
- > EarningsCallsDocumentSearch200Response earningsCallsDocumentSearch(q, identifier, kind, section, year, table, limit)
600
+ > EarningsCallsDocumentSearch200Response earningsCallsDocumentSearch(q, mode, caseSensitive, identifier, kind, section, year, table, limit)
601
601
 
602
602
  Search investor documents
603
603
 
604
- Semantic search over the page text of investor documents: the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
604
+ Search the page text of investor documents by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
605
605
 
606
606
  ### Example
607
607
 
@@ -621,8 +621,12 @@ async function example() {
621
621
  const api = new EarningsCallsApi(config);
622
622
 
623
623
  const body = {
624
- // string | The question or phrase to search for
624
+ // string | The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for
625
625
  q: Azure growth,
626
+ // 'lexical' | 'literal' | 'semantic' | 'hybrid' | lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused) (optional)
627
+ mode: hybrid,
628
+ // 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
629
+ caseSensitive: false,
626
630
  // string | Search one company\'s documents (ticker or CIK, US only) (optional)
627
631
  identifier: MSFT,
628
632
  // Array<string> | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing (optional)
@@ -654,7 +658,9 @@ example().catch(console.error);
654
658
 
655
659
  | Name | Type | Description | Notes |
656
660
  |------------- | ------------- | ------------- | -------------|
657
- | **q** | `string` | The question or phrase to search for | [Defaults to `undefined`] |
661
+ | **q** | `string` | The keywords, exact text (mode&#x3D;literal) or question (semantic / hybrid) to search for | [Defaults to `undefined`] |
662
+ | **mode** | `lexical`, `literal`, `semantic`, `hybrid` | lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused) | [Optional] [Defaults to `&#39;lexical&#39;`] [Enum: lexical, literal, semantic, hybrid] |
663
+ | **caseSensitive** | `true`, `false` | mode&#x3D;literal only: \&quot;false\&quot; matches regardless of case (default \&quot;true\&quot;: case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
658
664
  | **identifier** | `string` | Search one company\&#39;s documents (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
659
665
  | **kind** | `Array<string>` | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing | [Optional] |
660
666
  | **section** | `Array<string>` | Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other | [Optional] |
@@ -826,7 +832,7 @@ async function example() {
826
832
 
827
833
  const body = {
828
834
  // string | Event identifier (event_id of any earnings-calls response)
829
- eventId: cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c,
835
+ eventId: 9655a5db-8968-40be-8c79-7cd1a8aed8e9,
830
836
  // Array<'observations'> | Extra data (repeatable): `observations` = the date / time observations behind the call time (optional)
831
837
  include: ["observations"],
832
838
  } satisfies EarningsCallsEventRequest;
@@ -1962,11 +1968,11 @@ example().catch(console.error);
1962
1968
 
1963
1969
  ## earningsCallsSearch
1964
1970
 
1965
- > EarningsCallsSearch200Response earningsCallsSearch(q, eventId, identifier, from, to, type, eventType, limit)
1971
+ > EarningsCallsSearch200Response earningsCallsSearch(q, mode, caseSensitive, eventId, identifier, from, to, type, eventType, limit)
1966
1972
 
1967
1973
  Search earnings calls
1968
1974
 
1969
- \&quot;Ask this call\&quot;: semantic search over earnings-call transcripts and slide text — one call (&#x60;event_id&#x60;), one company (&#x60;identifier&#x60;) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and &#x60;start_ms&#x60;. Cite &#x60;event_id&#x60; and &#x60;start_ms&#x60;. - On plans that include the audio and slides routes (PRO): &#x60;audio_url&#x60; opens the recording\&#39;s permanent URL at the passage (&#x60;#t&#x3D;&lt;seconds&gt;&#x60;; null while no recording is available) and &#x60;slide.image_url&#x60; (a signed URL) shows the slide. ### Event types - &#x60;event_type&#x60; (default &#x60;earnings_call&#x60;; &#x60;all&#x60; &#x3D; every type) selects investor days, conferences or shareholder meetings too. ### Errors - &#x60;429 upstream_rate_limited&#x60; and &#x60;503 search_unavailable&#x60; carry &#x60;Retry-After&#x60;. - &#x60;503 search_disabled&#x60; while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
1975
+ \&quot;Ask this call\&quot;: search earnings-call transcripts and slide text by keywords (default &#x60;mode&#x3D;lexical&#x60;), exact text (&#x60;literal&#x60;), meaning (&#x60;semantic&#x60;) or both (&#x60;hybrid&#x60;) — one call (&#x60;event_id&#x60;), one company (&#x60;identifier&#x60;) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and &#x60;start_ms&#x60;, how each matched (&#x60;match&#x60;) and the index coverage of the search (&#x60;coverage&#x60;). Cite &#x60;event_id&#x60; and &#x60;start_ms&#x60;. - On plans that include the audio and slides routes (PRO): &#x60;audio_url&#x60; opens the recording\&#39;s permanent URL at the passage (&#x60;#t&#x3D;&lt;seconds&gt;&#x60;; null while no recording is available) and &#x60;slide.image_url&#x60; (a signed URL) shows the slide. ### Event types - &#x60;event_type&#x60; (default &#x60;earnings_call&#x60;; &#x60;all&#x60; &#x3D; every type) selects investor days, conferences or shareholder meetings too. ### Search modes - &#x60;lexical&#x60; (default): keyword search — English full text with stemming; quoted phrases, &#x60;OR&#x60; and &#x60;-word&#x60; work (&#x60;websearch_to_tsquery&#x60;); ranked by &#x60;ts_rank_cd&#x60;. Finance tokens such as &#x60;FY2027&#x60;, &#x60;10-K&#x60;, &#x60;Q3&#x60; or &#x60;EBITDA&#x60; match as written. - &#x60;literal&#x60;: the exact characters of the passage — no stemming, no fuzzy matching, &#x60;%&#x60; / &#x60;_&#x60; / &#x60;\\&#x60; match themselves; case-sensitive unless &#x60;case_sensitive&#x3D;false&#x60; (only allowed with &#x60;mode&#x3D;literal&#x60;; default &#x60;true&#x60;). A pattern under 3 characters needs &#x60;identifier&#x60; or &#x60;event_id&#x60;. Newest first; &#x60;score&#x60; is 0. - &#x60;semantic&#x60;: meaning-based search (multilingual sentence embeddings); &#x60;score&#x60; is the cosine similarity. - &#x60;hybrid&#x60;: &#x60;lexical&#x60; and &#x60;semantic&#x60; fused by reciprocal rank (&#x60;score &#x3D; Σ 1 / (60 + rank)&#x60;, equal weights, ties by passage); &#x60;match.lexical_rank&#x60; / &#x60;match.semantic_rank&#x60; give each leg\&#39;s rank. Best for natural-language questions. - &#x60;match.spans&#x60; mark the matched characters in &#x60;text&#x60; (zero-based, end-exclusive Unicode code-point offsets); &#x60;text&#x60; is cut around the first match (&#x60;text_truncated&#x60;). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - &#x60;coverage.completeness&#x60; &#x3D; &#x60;complete&#x60; (every searched passage is indexed: no hits is a genuine no-result), &#x60;partial&#x60; (some passages are still being indexed or failed, or a hybrid leg was unavailable) or &#x60;unknown&#x60; (a mode\&#39;s index is not built for the searched scope, e.g. &#x60;semantic_index_missing&#x60;) — read it before treating an empty list as \&quot;not found\&quot;. - &#x60;coverage.lexical&#x60; / &#x60;coverage.semantic&#x60; count the searched transcripts or documents per index (&#x60;indexed&#x60;, &#x60;pending&#x60;, &#x60;failed&#x60;); null for a leg the mode did not use. &#x60;reasons&#x60; lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as &#x60;pending&#x60;; when they cannot be read, the hits are still returned with &#x60;completeness: unknown&#x60;, both legs null and &#x60;coverage_unavailable&#x60;. ### Changelog - 2026-10: modes added and the default mode changed from semantic to &#x60;lexical&#x60;; pass &#x60;mode&#x3D;semantic&#x60; for the previous behaviour (or &#x60;mode&#x3D;hybrid&#x60; for natural-language questions). ### Errors - &#x60;400&#x60; for a &#x60;mode&#x3D;lexical&#x60; query of stopwords only (no searchable words), for &#x60;case_sensitive&#x60; with any mode but &#x60;literal&#x60;, and for a &#x60;mode&#x3D;literal&#x60; pattern under 3 characters without a scope (see Search modes). - &#x60;429 upstream_rate_limited&#x60; and &#x60;503 search_unavailable&#x60; carry &#x60;Retry-After&#x60; (&#x60;503&#x60; also when a keyword search runs over its time limit — never an empty answer). - &#x60;503 search_disabled&#x60; while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
1970
1976
 
1971
1977
  ### Example
1972
1978
 
@@ -1986,8 +1992,12 @@ async function example() {
1986
1992
  const api = new EarningsCallsApi(config);
1987
1993
 
1988
1994
  const body = {
1989
- // string | The question or phrase to search for
1995
+ // string | The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for
1990
1996
  q: Azure growth,
1997
+ // 'lexical' | 'literal' | 'semantic' | 'hybrid' | lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused) (optional)
1998
+ mode: semantic,
1999
+ // 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
2000
+ caseSensitive: false,
1991
2001
  // string | Search one call (optional)
1992
2002
  eventId: cfbcf4f8-6d4d-41ef-9197-1c91ff2aef8c,
1993
2003
  // string | Search one company\'s calls (ticker or CIK, US only) (optional)
@@ -2021,7 +2031,9 @@ example().catch(console.error);
2021
2031
 
2022
2032
  | Name | Type | Description | Notes |
2023
2033
  |------------- | ------------- | ------------- | -------------|
2024
- | **q** | `string` | The question or phrase to search for | [Defaults to `undefined`] |
2034
+ | **q** | `string` | The keywords, exact text (mode&#x3D;literal) or question (semantic / hybrid) to search for | [Defaults to `undefined`] |
2035
+ | **mode** | `lexical`, `literal`, `semantic`, `hybrid` | lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused) | [Optional] [Defaults to `&#39;lexical&#39;`] [Enum: lexical, literal, semantic, hybrid] |
2036
+ | **caseSensitive** | `true`, `false` | mode&#x3D;literal only: \&quot;false\&quot; matches regardless of case (default \&quot;true\&quot;: case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
2025
2037
  | **eventId** | `string` | Search one call | [Optional] [Defaults to `undefined`] |
2026
2038
  | **identifier** | `string` | Search one company\&#39;s calls (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
2027
2039
  | **from** | `Date` | First call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. An unscoped search defaults to 365 days back | [Optional] [Defaults to `undefined`] |
@@ -2064,7 +2076,7 @@ example().catch(console.error);
2064
2076
 
2065
2077
  Earnings call slides
2066
2078
 
2067
- The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with &#x60;include&#x3D;markdown&#x60;, each page\&#39;s text. ### Files - Files are served as short-lived signed URLs (see &#x60;expires_at&#x60;), never proxied; request a fresh response after expiry. ### Errors - &#x60;404 slides_unavailable&#x60; when no deck is available. - &#x60;503 media_unavailable&#x60; while media signing is not configured. ### Choose the call - By &#x60;event_id&#x60;, or - by &#x60;identifier&#x60; with &#x60;year&#x60; + &#x60;quarter&#x60; (fiscal), or - by &#x60;identifier&#x60; with &#x60;date&#x60; (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With &#x60;date&#x60;, &#x60;event_type&#x60; (default &#x60;earnings_call&#x60;) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
2079
+ The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with &#x60;include&#x3D;markdown&#x60;, each page\&#39;s text. ### Files - Files are served as short-lived signed URLs (see &#x60;expires_at&#x60;), never proxied; request a fresh response after expiry. - &#x60;timeline&#x60;: the slides shown in the webcast player, keyed to the call audio (&#x60;at_ms&#x60; from the start of the recording the audio route serves; the whole call, whatever &#x60;pages&#x60; asks). ### Errors - &#x60;404 slides_unavailable&#x60; when no deck is available. - &#x60;503 media_unavailable&#x60; while media signing is not configured. ### Choose the call - By &#x60;event_id&#x60;, or - by &#x60;identifier&#x60; with &#x60;year&#x60; + &#x60;quarter&#x60; (fiscal), or - by &#x60;identifier&#x60; with &#x60;date&#x60; (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With &#x60;date&#x60;, &#x60;event_type&#x60; (default &#x60;earnings_call&#x60;) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
2068
2080
 
2069
2081
  ### Example
2070
2082
 
@@ -33,6 +33,7 @@ Name | Type
33
33
  `has_press_release` | boolean
34
34
  `has_documents` | boolean
35
35
  `webcast_url` | string
36
+ `video` | [EarningsCallsCalendar200ResponseEventsInnerVideo](EarningsCallsCalendar200ResponseEventsInnerVideo.md)
36
37
 
37
38
  ## Example
38
39
 
@@ -68,6 +69,7 @@ const example = {
68
69
  "has_press_release": null,
69
70
  "has_documents": null,
70
71
  "webcast_url": null,
72
+ "video": null,
71
73
  } satisfies EarningsCallsCalendar200ResponseEventsInner
72
74
 
73
75
  console.log(example)
@@ -0,0 +1,49 @@
1
+
2
+ # EarningsCallsCalendar200ResponseEventsInnerVideo
3
+
4
+ The company\'s public broadcast on a video platform (YouTube, Vimeo). Embed `embed_url` when `embeddable` is not false; otherwise link `url`. Present before, during and after the event; null = none known.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `provider` | string
11
+ `video_id` | string
12
+ `url` | string
13
+ `embed_url` | string
14
+ `title` | string
15
+ `channel` | string
16
+ `thumbnail_url` | string
17
+ `embeddable` | boolean
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from '@invinite-org/data-api-client'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "provider": null,
27
+ "video_id": null,
28
+ "url": null,
29
+ "embed_url": null,
30
+ "title": null,
31
+ "channel": null,
32
+ "thumbnail_url": null,
33
+ "embeddable": null,
34
+ } satisfies EarningsCallsCalendar200ResponseEventsInnerVideo
35
+
36
+ console.log(example)
37
+
38
+ // Convert the instance to a JSON string
39
+ const exampleJSON: string = JSON.stringify(example)
40
+ console.log(exampleJSON)
41
+
42
+ // Parse the JSON string back to an object
43
+ const exampleParsed = JSON.parse(exampleJSON) as EarningsCallsCalendar200ResponseEventsInnerVideo
44
+ console.log(exampleParsed)
45
+ ```
46
+
47
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
48
+
49
+
@@ -7,6 +7,8 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `query` | string
10
+ `mode` | string
11
+ `coverage` | [SearchCoverage](SearchCoverage.md)
10
12
  `hits` | [Array&lt;EarningsCallsDocumentSearch200ResponseHitsInner&gt;](EarningsCallsDocumentSearch200ResponseHitsInner.md)
11
13
 
12
14
  ## Example
@@ -17,6 +19,8 @@ import type { EarningsCallsDocumentSearch200Response } from '@invinite-org/data-
17
19
  // TODO: Update the object below with actual values
18
20
  const example = {
19
21
  "query": null,
22
+ "mode": null,
23
+ "coverage": null,
20
24
  "hits": null,
21
25
  } satisfies EarningsCallsDocumentSearch200Response
22
26
 
@@ -7,6 +7,7 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `score` | number
10
+ `match` | [HitMatch](HitMatch.md)
10
11
  `document_id` | string
11
12
  `table` | string
12
13
  `event_id` | string
@@ -18,7 +19,9 @@ Name | Type
18
19
  `period` | string
19
20
  `page` | number
20
21
  `heading` | string
22
+ `chunk_index` | number
21
23
  `text` | string
24
+ `text_truncated` | boolean
22
25
  `title` | string
23
26
  `group` | string
24
27
  `group_label` | string
@@ -34,6 +37,7 @@ import type { EarningsCallsDocumentSearch200ResponseHitsInner } from '@invinite-
34
37
  // TODO: Update the object below with actual values
35
38
  const example = {
36
39
  "score": null,
40
+ "match": null,
37
41
  "document_id": null,
38
42
  "table": null,
39
43
  "event_id": null,
@@ -45,7 +49,9 @@ const example = {
45
49
  "period": null,
46
50
  "page": null,
47
51
  "heading": null,
52
+ "chunk_index": null,
48
53
  "text": null,
54
+ "text_truncated": null,
49
55
  "title": null,
50
56
  "group": null,
51
57
  "group_label": null,
@@ -33,6 +33,7 @@ Name | Type
33
33
  `has_press_release` | boolean
34
34
  `has_documents` | boolean
35
35
  `webcast_url` | string
36
+ `video` | [EarningsCallsCalendar200ResponseEventsInnerVideo](EarningsCallsCalendar200ResponseEventsInnerVideo.md)
36
37
  `observations` | [Array&lt;EarningsCallsEvents200ResponseEventsInnerObservationsInner&gt;](EarningsCallsEvents200ResponseEventsInnerObservationsInner.md)
37
38
 
38
39
  ## Example
@@ -69,6 +70,7 @@ const example = {
69
70
  "has_press_release": null,
70
71
  "has_documents": null,
71
72
  "webcast_url": null,
73
+ "video": null,
72
74
  "observations": null,
73
75
  } satisfies EarningsCallsEvents200ResponseEventsInner
74
76
 
@@ -33,6 +33,7 @@ Name | Type
33
33
  `has_press_release` | boolean
34
34
  `has_documents` | boolean
35
35
  `webcast_url` | string
36
+ `video` | [EarningsCallsCalendar200ResponseEventsInnerVideo](EarningsCallsCalendar200ResponseEventsInnerVideo.md)
36
37
  `live_channel` | string
37
38
  `live_audio` | boolean
38
39
  `live_prices` | boolean
@@ -71,6 +72,7 @@ const example = {
71
72
  "has_press_release": null,
72
73
  "has_documents": null,
73
74
  "webcast_url": null,
75
+ "video": null,
74
76
  "live_channel": null,
75
77
  "live_audio": null,
76
78
  "live_prices": null,
@@ -7,6 +7,8 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `query` | string
10
+ `mode` | string
11
+ `coverage` | [SearchCoverage](SearchCoverage.md)
10
12
  `hits` | [Array&lt;EarningsCallsSearch200ResponseHitsInner&gt;](EarningsCallsSearch200ResponseHitsInner.md)
11
13
 
12
14
  ## Example
@@ -17,6 +19,8 @@ import type { EarningsCallsSearch200Response } from '@invinite-org/data-api-clie
17
19
  // TODO: Update the object below with actual values
18
20
  const example = {
19
21
  "query": null,
22
+ "mode": null,
23
+ "coverage": null,
20
24
  "hits": null,
21
25
  } satisfies EarningsCallsSearch200Response
22
26
 
@@ -16,8 +16,11 @@ Name | Type
16
16
  `speaker` | [EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker](EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.md)
17
17
  `start_ms` | number
18
18
  `end_ms` | number
19
+ `chunk_index` | number
19
20
  `text` | string
21
+ `text_truncated` | boolean
20
22
  `score` | number
23
+ `match` | [HitMatch](HitMatch.md)
21
24
  `audio_url` | string
22
25
  `slide` | [EarningsCallsSearch200ResponseHitsInnerSlide](EarningsCallsSearch200ResponseHitsInnerSlide.md)
23
26
 
@@ -38,8 +41,11 @@ const example = {
38
41
  "speaker": null,
39
42
  "start_ms": null,
40
43
  "end_ms": null,
44
+ "chunk_index": null,
41
45
  "text": null,
46
+ "text_truncated": null,
42
47
  "score": null,
48
+ "match": null,
43
49
  "audio_url": null,
44
50
  "slide": null,
45
51
  } satisfies EarningsCallsSearch200ResponseHitsInner
@@ -9,6 +9,7 @@ Name | Type
9
9
  `event` | [EarningsCallsLiveStream200ResponseEvent](EarningsCallsLiveStream200ResponseEvent.md)
10
10
  `deck` | [EarningsCallsSlides200ResponseDeck](EarningsCallsSlides200ResponseDeck.md)
11
11
  `slides` | [Array&lt;EarningsCallsSlides200ResponseSlidesInner&gt;](EarningsCallsSlides200ResponseSlidesInner.md)
12
+ `timeline` | [Array&lt;EarningsCallsSlides200ResponseTimelineInner&gt;](EarningsCallsSlides200ResponseTimelineInner.md)
12
13
 
13
14
  ## Example
14
15
 
@@ -20,6 +21,7 @@ const example = {
20
21
  "event": null,
21
22
  "deck": null,
22
23
  "slides": null,
24
+ "timeline": null,
23
25
  } satisfies EarningsCallsSlides200Response
24
26
 
25
27
  console.log(example)
@@ -0,0 +1,36 @@
1
+
2
+ # EarningsCallsSlides200ResponseTimelineInner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `at_ms` | number
10
+ `image_url` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { EarningsCallsSlides200ResponseTimelineInner } from '@invinite-org/data-api-client'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "at_ms": null,
20
+ "image_url": null,
21
+ } satisfies EarningsCallsSlides200ResponseTimelineInner
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as EarningsCallsSlides200ResponseTimelineInner
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,41 @@
1
+
2
+ # HitMatch
3
+
4
+ How the passage matched
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `type` | string
11
+ `lexical_rank` | number
12
+ `semantic_rank` | number
13
+ `spans` | [Array&lt;MatchSpan&gt;](MatchSpan.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { HitMatch } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "type": null,
23
+ "lexical_rank": null,
24
+ "semantic_rank": null,
25
+ "spans": null,
26
+ } satisfies HitMatch
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as HitMatch
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,36 @@
1
+
2
+ # MatchSpan
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `start` | number
10
+ `end` | number
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { MatchSpan } from '@invinite-org/data-api-client'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "start": null,
20
+ "end": null,
21
+ } satisfies MatchSpan
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as MatchSpan
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,41 @@
1
+
2
+ # SearchCoverage
3
+
4
+ How much of the searched scope the mode\'s indexes cover
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `completeness` | string
11
+ `lexical` | [SearchCoverageLeg](SearchCoverageLeg.md)
12
+ `semantic` | [SearchCoverageLeg](SearchCoverageLeg.md)
13
+ `reasons` | Array&lt;string&gt;
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { SearchCoverage } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "completeness": null,
23
+ "lexical": null,
24
+ "semantic": null,
25
+ "reasons": null,
26
+ } satisfies SearchCoverage
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as SearchCoverage
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # SearchCoverageLeg
3
+
4
+ The keyword index (lexical / literal / hybrid); null when the mode did not use it
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `state` | string
11
+ `indexed` | number
12
+ `pending` | number
13
+ `failed` | number
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { SearchCoverageLeg } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "state": null,
23
+ "indexed": null,
24
+ "pending": null,
25
+ "failed": null,
26
+ } satisfies SearchCoverageLeg
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as SearchCoverageLeg
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {