invinite-data-api 0.3.0__tar.gz → 0.4.0__tar.gz

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invinite_data_api
-Version: 0.3.0
+Version: 0.4.0
 Summary: Typed Python client for the Invinite Data API
 Home-page: 
 Author: OpenAPI Generator community

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 # Define package exports
 __all__ = [
@@ -94,6 +94,7 @@ __all__ = [
     "EarningsCallsAudio200Response",
     "EarningsCallsCalendar200Response",
     "EarningsCallsCalendar200ResponseEventsInner",
+    "EarningsCallsCalendar200ResponseEventsInnerVideo",
     "EarningsCallsCompanyDocument200Response",
     "EarningsCallsCompanyDocuments200Response",
     "EarningsCallsCompanyDocuments200ResponseCompany",
@@ -152,6 +153,7 @@ __all__ = [
     "EarningsCallsSlides200Response",
     "EarningsCallsSlides200ResponseDeck",
     "EarningsCallsSlides200ResponseSlidesInner",
+    "EarningsCallsSlides200ResponseTimelineInner",
     "EarningsCallsTranscript200Response",
     "EarningsCallsTranscript404Response",
     "EarningsCallsTranscriptDiff200Response",
@@ -175,6 +177,7 @@ __all__ = [
     "FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner",
     "ForbiddenError",
     "HealthGet200Response",
+    "HitMatch",
     "InsiderTradesList200Response",
     "InsiderTradesList200ResponseTransactionsInner",
     "InstitutionalOwnershipHoldingsByCompany200Response",
@@ -189,6 +192,7 @@ __all__ = [
     "IposList200ResponseIposInner",
     "MarketHolidays200Response",
     "MarketHolidays200ResponseHolidaysInner",
+    "MatchSpan",
     "MetadataAvailableMetrics200Response",
     "MetadataAvailableMetrics200ResponseMetricsInner",
     "MetadataAvailableSectionIds200Response",
@@ -196,6 +200,8 @@ __all__ = [
     "MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner",
     "NotFoundError",
     "PresentationFact",
+    "SearchCoverage",
+    "SearchCoverageLeg",
     "SecFilingsAvailableFormTypes200Response",
     "SecFilingsList200Response",
     "SecFilingsList200ResponseCompaniesInner",
@@ -353,6 +359,7 @@ from invinite_data_api.models.earnings_calls_analysts200_response_analysts_inner
 from invinite_data_api.models.earnings_calls_audio200_response import EarningsCallsAudio200Response as EarningsCallsAudio200Response
 from invinite_data_api.models.earnings_calls_calendar200_response import EarningsCallsCalendar200Response as EarningsCallsCalendar200Response
 from invinite_data_api.models.earnings_calls_calendar200_response_events_inner import EarningsCallsCalendar200ResponseEventsInner as EarningsCallsCalendar200ResponseEventsInner
+from invinite_data_api.models.earnings_calls_calendar200_response_events_inner_video import EarningsCallsCalendar200ResponseEventsInnerVideo as EarningsCallsCalendar200ResponseEventsInnerVideo
 from invinite_data_api.models.earnings_calls_company_document200_response import EarningsCallsCompanyDocument200Response as EarningsCallsCompanyDocument200Response
 from invinite_data_api.models.earnings_calls_company_documents200_response import EarningsCallsCompanyDocuments200Response as EarningsCallsCompanyDocuments200Response
 from invinite_data_api.models.earnings_calls_company_documents200_response_company import EarningsCallsCompanyDocuments200ResponseCompany as EarningsCallsCompanyDocuments200ResponseCompany
@@ -411,6 +418,7 @@ from invinite_data_api.models.earnings_calls_search200_response_hits_inner_slide
 from invinite_data_api.models.earnings_calls_slides200_response import EarningsCallsSlides200Response as EarningsCallsSlides200Response
 from invinite_data_api.models.earnings_calls_slides200_response_deck import EarningsCallsSlides200ResponseDeck as EarningsCallsSlides200ResponseDeck
 from invinite_data_api.models.earnings_calls_slides200_response_slides_inner import EarningsCallsSlides200ResponseSlidesInner as EarningsCallsSlides200ResponseSlidesInner
+from invinite_data_api.models.earnings_calls_slides200_response_timeline_inner import EarningsCallsSlides200ResponseTimelineInner as EarningsCallsSlides200ResponseTimelineInner
 from invinite_data_api.models.earnings_calls_transcript200_response import EarningsCallsTranscript200Response as EarningsCallsTranscript200Response
 from invinite_data_api.models.earnings_calls_transcript404_response import EarningsCallsTranscript404Response as EarningsCallsTranscript404Response
 from invinite_data_api.models.earnings_calls_transcript_diff200_response import EarningsCallsTranscriptDiff200Response as EarningsCallsTranscriptDiff200Response
@@ -434,6 +442,7 @@ from invinite_data_api.models.financial_metrics_ratios200_response_companies_inn
 from invinite_data_api.models.financial_metrics_ratios200_response_companies_inner_periods_inner import FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner as FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner
 from invinite_data_api.models.forbidden_error import ForbiddenError as ForbiddenError
 from invinite_data_api.models.health_get200_response import HealthGet200Response as HealthGet200Response
+from invinite_data_api.models.hit_match import HitMatch as HitMatch
 from invinite_data_api.models.insider_trades_list200_response import InsiderTradesList200Response as InsiderTradesList200Response
 from invinite_data_api.models.insider_trades_list200_response_transactions_inner import InsiderTradesList200ResponseTransactionsInner as InsiderTradesList200ResponseTransactionsInner
 from invinite_data_api.models.institutional_ownership_holdings_by_company200_response import InstitutionalOwnershipHoldingsByCompany200Response as InstitutionalOwnershipHoldingsByCompany200Response
@@ -448,6 +457,7 @@ from invinite_data_api.models.ipos_list200_response import IposList200Response a
 from invinite_data_api.models.ipos_list200_response_ipos_inner import IposList200ResponseIposInner as IposList200ResponseIposInner
 from invinite_data_api.models.market_holidays200_response import MarketHolidays200Response as MarketHolidays200Response
 from invinite_data_api.models.market_holidays200_response_holidays_inner import MarketHolidays200ResponseHolidaysInner as MarketHolidays200ResponseHolidaysInner
+from invinite_data_api.models.match_span import MatchSpan as MatchSpan
 from invinite_data_api.models.metadata_available_metrics200_response import MetadataAvailableMetrics200Response as MetadataAvailableMetrics200Response
 from invinite_data_api.models.metadata_available_metrics200_response_metrics_inner import MetadataAvailableMetrics200ResponseMetricsInner as MetadataAvailableMetrics200ResponseMetricsInner
 from invinite_data_api.models.metadata_available_section_ids200_response import MetadataAvailableSectionIds200Response as MetadataAvailableSectionIds200Response
@@ -455,6 +465,8 @@ from invinite_data_api.models.metadata_available_section_ids200_response_form_ty
 from invinite_data_api.models.metadata_available_section_ids200_response_form_types_inner_sections_inner import MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner as MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner
 from invinite_data_api.models.not_found_error import NotFoundError as NotFoundError
 from invinite_data_api.models.presentation_fact import PresentationFact as PresentationFact
+from invinite_data_api.models.search_coverage import SearchCoverage as SearchCoverage
+from invinite_data_api.models.search_coverage_leg import SearchCoverageLeg as SearchCoverageLeg
 from invinite_data_api.models.sec_filings_available_form_types200_response import SecFilingsAvailableFormTypes200Response as SecFilingsAvailableFormTypes200Response
 from invinite_data_api.models.sec_filings_list200_response import SecFilingsList200Response as SecFilingsList200Response
 from invinite_data_api.models.sec_filings_list200_response_companies_inner import SecFilingsList200ResponseCompaniesInner as SecFilingsList200ResponseCompaniesInner

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/api/earnings_calls_api.py

@@ -2353,7 +2353,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_document_search(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's documents (ticker or CIK, US only)")] = None,
         kind: Annotated[Optional[List[StrictStr]], Field(description="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")] = None,
         section: Annotated[Optional[List[StrictStr]], Field(description="Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other")] = None,
@@ -2375,10 +2377,14 @@ class EarningsCallsApi:
     ) -> EarningsCallsDocumentSearch200Response:
         """Search investor documents
 
-        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.
+        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.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param identifier: Search one company's documents (ticker or CIK, US only)
         :type identifier: str
         :param kind: 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
@@ -2415,6 +2421,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_document_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             identifier=identifier,
             kind=kind,
             section=section,
@@ -2450,7 +2458,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_document_search_with_http_info(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's documents (ticker or CIK, US only)")] = None,
         kind: Annotated[Optional[List[StrictStr]], Field(description="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")] = None,
         section: Annotated[Optional[List[StrictStr]], Field(description="Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other")] = None,
@@ -2472,10 +2482,14 @@ class EarningsCallsApi:
     ) -> ApiResponse[EarningsCallsDocumentSearch200Response]:
         """Search investor documents
 
-        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.
+        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.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param identifier: Search one company's documents (ticker or CIK, US only)
         :type identifier: str
         :param kind: 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
@@ -2512,6 +2526,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_document_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             identifier=identifier,
             kind=kind,
             section=section,
@@ -2547,7 +2563,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_document_search_without_preload_content(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's documents (ticker or CIK, US only)")] = None,
         kind: Annotated[Optional[List[StrictStr]], Field(description="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")] = None,
         section: Annotated[Optional[List[StrictStr]], Field(description="Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other")] = None,
@@ -2569,10 +2587,14 @@ class EarningsCallsApi:
     ) -> RESTResponseType:
         """Search investor documents
 
-        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.
+        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.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param identifier: Search one company's documents (ticker or CIK, US only)
         :type identifier: str
         :param kind: 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
@@ -2609,6 +2631,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_document_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             identifier=identifier,
             kind=kind,
             section=section,
@@ -2640,6 +2664,8 @@ class EarningsCallsApi:
     def _earnings_calls_document_search_serialize(
         self,
         q,
+        mode,
+        case_sensitive,
         identifier,
         kind,
         section,
@@ -2674,6 +2700,14 @@ class EarningsCallsApi:
             
             _query_params.append(('q', q))
             
+        if mode is not None:
+            
+            _query_params.append(('mode', mode))
+            
+        if case_sensitive is not None:
+            
+            _query_params.append(('case_sensitive', case_sensitive))
+            
         if identifier is not None:
             
             _query_params.append(('identifier', identifier))
@@ -7957,7 +7991,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_search(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         event_id: Annotated[Optional[UUID], Field(description="Search one call")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's calls (ticker or CIK, US only)")] = None,
         var_from: Annotated[Optional[date], Field(description="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")] = None,
@@ -7980,10 +8016,14 @@ class EarningsCallsApi:
     ) -> EarningsCallsSearch200Response:
         """Search earnings calls
 
-        \"Ask this call\": semantic search over earnings-call transcripts and slide text — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`. Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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 rag: STANDARD.
+        \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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` or `event_id`. 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 rag: STANDARD.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param event_id: Search one call
         :type event_id: UUID
         :param identifier: Search one company's calls (ticker or CIK, US only)
@@ -8022,6 +8062,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             event_id=event_id,
             identifier=identifier,
             var_from=var_from,
@@ -8058,7 +8100,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_search_with_http_info(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         event_id: Annotated[Optional[UUID], Field(description="Search one call")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's calls (ticker or CIK, US only)")] = None,
         var_from: Annotated[Optional[date], Field(description="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")] = None,
@@ -8081,10 +8125,14 @@ class EarningsCallsApi:
     ) -> ApiResponse[EarningsCallsSearch200Response]:
         """Search earnings calls
 
-        \"Ask this call\": semantic search over earnings-call transcripts and slide text — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`. Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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 rag: STANDARD.
+        \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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` or `event_id`. 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 rag: STANDARD.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param event_id: Search one call
         :type event_id: UUID
         :param identifier: Search one company's calls (ticker or CIK, US only)
@@ -8123,6 +8171,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             event_id=event_id,
             identifier=identifier,
             var_from=var_from,
@@ -8159,7 +8209,9 @@ class EarningsCallsApi:
     @validate_call
     def earnings_calls_search_without_preload_content(
         self,
-        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The question or phrase to search for")],
+        q: Annotated[str, Field(min_length=2, strict=True, max_length=500, description="The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for")],
+        mode: Annotated[Optional[StrictStr], Field(description="lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)")] = None,
+        case_sensitive: Annotated[Optional[StrictStr], Field(description="mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)")] = None,
         event_id: Annotated[Optional[UUID], Field(description="Search one call")] = None,
         identifier: Annotated[Optional[StrictStr], Field(description="Search one company's calls (ticker or CIK, US only)")] = None,
         var_from: Annotated[Optional[date], Field(description="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")] = None,
@@ -8182,10 +8234,14 @@ class EarningsCallsApi:
     ) -> RESTResponseType:
         """Search earnings calls
 
-        \"Ask this call\": semantic search over earnings-call transcripts and slide text — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`. Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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 rag: STANDARD.
+        \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days).  ### What you get  - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`.  - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording's permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide.  ### Event types  - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too.  ### 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` or `event_id`. 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 rag: STANDARD.
 
-        :param q: The question or phrase to search for (required)
+        :param q: The keywords, exact text (mode=literal) or question (semantic / hybrid) to search for (required)
         :type q: str
+        :param mode: lexical (keywords, default), literal (exact characters), semantic (meaning) or hybrid (lexical + semantic, fused)
+        :type mode: str
+        :param case_sensitive: mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive)
+        :type case_sensitive: str
         :param event_id: Search one call
         :type event_id: UUID
         :param identifier: Search one company's calls (ticker or CIK, US only)
@@ -8224,6 +8280,8 @@ class EarningsCallsApi:
 
         _param = self._earnings_calls_search_serialize(
             q=q,
+            mode=mode,
+            case_sensitive=case_sensitive,
             event_id=event_id,
             identifier=identifier,
             var_from=var_from,
@@ -8256,6 +8314,8 @@ class EarningsCallsApi:
     def _earnings_calls_search_serialize(
         self,
         q,
+        mode,
+        case_sensitive,
         event_id,
         identifier,
         var_from,
@@ -8289,6 +8349,14 @@ class EarningsCallsApi:
             
             _query_params.append(('q', q))
             
+        if mode is not None:
+            
+            _query_params.append(('mode', mode))
+            
+        if case_sensitive is not None:
+            
+            _query_params.append(('case_sensitive', case_sensitive))
+            
         if event_id is not None:
             
             _query_params.append(('event_id', event_id))
@@ -8398,7 +8466,7 @@ class EarningsCallsApi:
     ) -> EarningsCallsSlides200Response:
         """Earnings call slides
 
-        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
+        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks).  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
 
         :param event_id: Event identifier (event_id of any earnings-calls response); wins over the other selectors
         :type event_id: UUID
@@ -8498,7 +8566,7 @@ class EarningsCallsApi:
     ) -> ApiResponse[EarningsCallsSlides200Response]:
         """Earnings call slides
 
-        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
+        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks).  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
 
         :param event_id: Event identifier (event_id of any earnings-calls response); wins over the other selectors
         :type event_id: UUID
@@ -8598,7 +8666,7 @@ class EarningsCallsApi:
     ) -> RESTResponseType:
         """Earnings call slides
 
-        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
+        The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page's text.  ### Files  - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry.  - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks).  ### Errors  - `404 slides_unavailable` when no deck is available.  - `503 media_unavailable` while media signing is not configured.  ### Choose the call  - By `event_id`, or  - by `identifier` with `year` + `quarter` (fiscal), or  - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) 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.
 
         :param event_id: Event identifier (event_id of any earnings-calls response); wins over the other selectors
         :type event_id: UUID

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.3.0/python'
+        self.user_agent = 'OpenAPI-Generator/0.4.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/configuration.py

@@ -533,7 +533,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 0.3.0".\
+               "SDK Package Version: 0.4.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/models/__init__.py

@@ -59,6 +59,7 @@ from invinite_data_api.models.earnings_calls_analysts200_response_analysts_inner
 from invinite_data_api.models.earnings_calls_audio200_response import EarningsCallsAudio200Response
 from invinite_data_api.models.earnings_calls_calendar200_response import EarningsCallsCalendar200Response
 from invinite_data_api.models.earnings_calls_calendar200_response_events_inner import EarningsCallsCalendar200ResponseEventsInner
+from invinite_data_api.models.earnings_calls_calendar200_response_events_inner_video import EarningsCallsCalendar200ResponseEventsInnerVideo
 from invinite_data_api.models.earnings_calls_company_document200_response import EarningsCallsCompanyDocument200Response
 from invinite_data_api.models.earnings_calls_company_documents200_response import EarningsCallsCompanyDocuments200Response
 from invinite_data_api.models.earnings_calls_company_documents200_response_company import EarningsCallsCompanyDocuments200ResponseCompany
@@ -117,6 +118,7 @@ from invinite_data_api.models.earnings_calls_search200_response_hits_inner_slide
 from invinite_data_api.models.earnings_calls_slides200_response import EarningsCallsSlides200Response
 from invinite_data_api.models.earnings_calls_slides200_response_deck import EarningsCallsSlides200ResponseDeck
 from invinite_data_api.models.earnings_calls_slides200_response_slides_inner import EarningsCallsSlides200ResponseSlidesInner
+from invinite_data_api.models.earnings_calls_slides200_response_timeline_inner import EarningsCallsSlides200ResponseTimelineInner
 from invinite_data_api.models.earnings_calls_transcript200_response import EarningsCallsTranscript200Response
 from invinite_data_api.models.earnings_calls_transcript404_response import EarningsCallsTranscript404Response
 from invinite_data_api.models.earnings_calls_transcript_diff200_response import EarningsCallsTranscriptDiff200Response
@@ -140,6 +142,7 @@ from invinite_data_api.models.financial_metrics_ratios200_response_companies_inn
 from invinite_data_api.models.financial_metrics_ratios200_response_companies_inner_periods_inner import FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner
 from invinite_data_api.models.forbidden_error import ForbiddenError
 from invinite_data_api.models.health_get200_response import HealthGet200Response
+from invinite_data_api.models.hit_match import HitMatch
 from invinite_data_api.models.insider_trades_list200_response import InsiderTradesList200Response
 from invinite_data_api.models.insider_trades_list200_response_transactions_inner import InsiderTradesList200ResponseTransactionsInner
 from invinite_data_api.models.institutional_ownership_holdings_by_company200_response import InstitutionalOwnershipHoldingsByCompany200Response
@@ -154,6 +157,7 @@ from invinite_data_api.models.ipos_list200_response import IposList200Response
 from invinite_data_api.models.ipos_list200_response_ipos_inner import IposList200ResponseIposInner
 from invinite_data_api.models.market_holidays200_response import MarketHolidays200Response
 from invinite_data_api.models.market_holidays200_response_holidays_inner import MarketHolidays200ResponseHolidaysInner
+from invinite_data_api.models.match_span import MatchSpan
 from invinite_data_api.models.metadata_available_metrics200_response import MetadataAvailableMetrics200Response
 from invinite_data_api.models.metadata_available_metrics200_response_metrics_inner import MetadataAvailableMetrics200ResponseMetricsInner
 from invinite_data_api.models.metadata_available_section_ids200_response import MetadataAvailableSectionIds200Response
@@ -161,6 +165,8 @@ from invinite_data_api.models.metadata_available_section_ids200_response_form_ty
 from invinite_data_api.models.metadata_available_section_ids200_response_form_types_inner_sections_inner import MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner
 from invinite_data_api.models.not_found_error import NotFoundError
 from invinite_data_api.models.presentation_fact import PresentationFact
+from invinite_data_api.models.search_coverage import SearchCoverage
+from invinite_data_api.models.search_coverage_leg import SearchCoverageLeg
 from invinite_data_api.models.sec_filings_available_form_types200_response import SecFilingsAvailableFormTypes200Response
 from invinite_data_api.models.sec_filings_list200_response import SecFilingsList200Response
 from invinite_data_api.models.sec_filings_list200_response_companies_inner import SecFilingsList200ResponseCompaniesInner

{invinite_data_api-0.3.0 → invinite_data_api-0.4.0}/invinite_data_api/models/earnings_calls_calendar200_response_events_inner.py

@@ -21,6 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from uuid import UUID
+from invinite_data_api.models.earnings_calls_calendar200_response_events_inner_video import EarningsCallsCalendar200ResponseEventsInnerVideo
 from typing import Optional, Set
 from typing_extensions import Self
 from pydantic_core import to_jsonable_python
@@ -56,7 +57,8 @@ class EarningsCallsCalendar200ResponseEventsInner(BaseModel):
     has_press_release: StrictBool = Field(description="The results press release is available")
     has_documents: StrictBool = Field(description="Further event documents are available")
     webcast_url: Optional[StrictStr] = Field(description="Webcast page of an upcoming dated call; null once published")
-    __properties: ClassVar[List[str]] = ["event_id", "source", "cik", "symbol", "company_name", "exchange", "event_type", "event_title", "fiscal_year", "fiscal_quarter", "scheduled_at", "tz", "date_status", "call_time_source", "call_time_confidence", "session", "started_at", "ended_at", "results_released_at", "capture_status", "reschedule_count", "has_transcript", "has_audio", "has_slides", "has_press_release", "has_documents", "webcast_url"]
+    video: Optional[EarningsCallsCalendar200ResponseEventsInnerVideo]
+    __properties: ClassVar[List[str]] = ["event_id", "source", "cik", "symbol", "company_name", "exchange", "event_type", "event_title", "fiscal_year", "fiscal_quarter", "scheduled_at", "tz", "date_status", "call_time_source", "call_time_confidence", "session", "started_at", "ended_at", "results_released_at", "capture_status", "reschedule_count", "has_transcript", "has_audio", "has_slides", "has_press_release", "has_documents", "webcast_url", "video"]
 
     @field_validator('source')
     def source_validate_enum(cls, value):
@@ -128,6 +130,9 @@ class EarningsCallsCalendar200ResponseEventsInner(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of video
+        if self.video:
+            _dict['video'] = self.video.to_dict()
         # set to None if exchange (nullable) is None
         # and model_fields_set contains the field
         if self.exchange is None and "exchange" in self.model_fields_set:
@@ -183,6 +188,11 @@ class EarningsCallsCalendar200ResponseEventsInner(BaseModel):
         if self.webcast_url is None and "webcast_url" in self.model_fields_set:
             _dict['webcast_url'] = None
 
+        # set to None if video (nullable) is None
+        # and model_fields_set contains the field
+        if self.video is None and "video" in self.model_fields_set:
+            _dict['video'] = None
+
         return _dict
 
     @classmethod
@@ -221,7 +231,8 @@ class EarningsCallsCalendar200ResponseEventsInner(BaseModel):
             "has_slides": obj.get("has_slides"),
             "has_press_release": obj.get("has_press_release"),
             "has_documents": obj.get("has_documents"),
-            "webcast_url": obj.get("webcast_url")
+            "webcast_url": obj.get("webcast_url"),
+            "video": EarningsCallsCalendar200ResponseEventsInnerVideo.from_dict(obj["video"]) if obj.get("video") is not None else None
         })
         return _obj