invinite-data-api 5.0.0__tar.gz → 5.5.0__tar.gz

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: invinite_data_api
-Version: 5.0.0
+Version: 5.5.0
 Summary: Typed Python client for the Invinite Data API
 Home-page: 
 Author: OpenAPI Generator community
@@ -82,6 +82,25 @@ and a Python keyword gets a `var_` prefix. The company is always a filter: `comp
 takes a ticker or a CIK, or a comma list of up to 50. Date parameters take a
 `datetime.date`.
 
+## An earnings event and its filings
+
+Every event names its two SEC filings: `results_filing` (the earnings 8-K / 6-K) and
+`periodic_report` (the 10-Q / 10-K of the event's fiscal period), each with
+`edgar_index_url`, or `None` while unknown:
+
+```python
+from invinite_data_api import EventsApi
+
+with invinite_data_api.ApiClient(config) as client:
+    api = EventsApi(client)
+    page = api.list_events(company="AAPL", fiscal_year=2026, fiscal_quarter=4)
+    event = api.get_event(event_id=str(page.data[0].event_id))  # event_id is a UUID
+    if event.results_filing:
+        print(event.results_filing.accession, event.results_filing.form)
+    if event.periodic_report:
+        print(event.periodic_report.form, event.periodic_report.period_end, event.periodic_report.edgar_index_url)
+```
+
 ## Lists, cursors and the pager
 
 Every list answers ONE envelope: `data`, `has_more`, `next_cursor`, `meta`. Pass
@@ -123,18 +142,25 @@ page = response.data
 
 On a non-2xx response the client raises `ApiException` (with per-status subclasses).
 The body is an RFC 9457 `application/problem+json` document with a stable `code`
-(`not_covered`, `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …) and a
-`request_id`. On `429` and `503`, wait for the `Retry-After` header before retrying.
+(`not_covered`, `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …), a `detail`
+(what happened), a `remedy` (what to do next, one sentence) and a `request_id`.
+`as_api_error` turns the exception into an `InviniteApiError` (an `ApiException`) with
+`status`, `code`, `detail`, `remedy`, `param`, `errors`, `request_id`, `docs_url`,
+`retry_after_ms` (the `Retry-After` header of a `429` / `503`) and the parsed `problem`;
+it returns `None` for anything that is not a problem answer.
 
 ```python
-import json
 from invinite_data_api.exceptions import ApiException
+from invinite_data_api.errors import as_api_error
 
 try:
-    api.list_filings(company="NOPE")
-except ApiException as error:
-    problem = json.loads(error.body) if error.body else {}
-    print(error.status, problem.get("code"), problem.get("detail"), problem.get("request_id"))
+    api.list_filings(company="AAPL", limit=500)
+except ApiException as exc:
+    problem = as_api_error(exc)
+    if problem is None:
+        raise
+    print(problem.detail)  # limit: must be <= 200.
+    print(problem.remedy)  # Pass a limit of at most 200, or walk the pages with next_cursor.
 ```
 
 ## Upgrading from 4.x

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/README.md

@@ -63,6 +63,25 @@ and a Python keyword gets a `var_` prefix. The company is always a filter: `comp
 takes a ticker or a CIK, or a comma list of up to 50. Date parameters take a
 `datetime.date`.
 
+## An earnings event and its filings
+
+Every event names its two SEC filings: `results_filing` (the earnings 8-K / 6-K) and
+`periodic_report` (the 10-Q / 10-K of the event's fiscal period), each with
+`edgar_index_url`, or `None` while unknown:
+
+```python
+from invinite_data_api import EventsApi
+
+with invinite_data_api.ApiClient(config) as client:
+    api = EventsApi(client)
+    page = api.list_events(company="AAPL", fiscal_year=2026, fiscal_quarter=4)
+    event = api.get_event(event_id=str(page.data[0].event_id))  # event_id is a UUID
+    if event.results_filing:
+        print(event.results_filing.accession, event.results_filing.form)
+    if event.periodic_report:
+        print(event.periodic_report.form, event.periodic_report.period_end, event.periodic_report.edgar_index_url)
+```
+
 ## Lists, cursors and the pager
 
 Every list answers ONE envelope: `data`, `has_more`, `next_cursor`, `meta`. Pass
@@ -104,18 +123,25 @@ page = response.data
 
 On a non-2xx response the client raises `ApiException` (with per-status subclasses).
 The body is an RFC 9457 `application/problem+json` document with a stable `code`
-(`not_covered`, `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …) and a
-`request_id`. On `429` and `503`, wait for the `Retry-After` header before retrying.
+(`not_covered`, `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …), a `detail`
+(what happened), a `remedy` (what to do next, one sentence) and a `request_id`.
+`as_api_error` turns the exception into an `InviniteApiError` (an `ApiException`) with
+`status`, `code`, `detail`, `remedy`, `param`, `errors`, `request_id`, `docs_url`,
+`retry_after_ms` (the `Retry-After` header of a `429` / `503`) and the parsed `problem`;
+it returns `None` for anything that is not a problem answer.
 
 ```python
-import json
 from invinite_data_api.exceptions import ApiException
+from invinite_data_api.errors import as_api_error
 
 try:
-    api.list_filings(company="NOPE")
-except ApiException as error:
-    problem = json.loads(error.body) if error.body else {}
-    print(error.status, problem.get("code"), problem.get("detail"), problem.get("request_id"))
+    api.list_filings(company="AAPL", limit=500)
+except ApiException as exc:
+    problem = as_api_error(exc)
+    if problem is None:
+        raise
+    print(problem.detail)  # limit: must be <= 200.
+    print(problem.remedy)  # Pass a limit of at most 200, or walk the pages with next_cursor.
 ```
 
 ## Upgrading from 4.x

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/invinite_data_api/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "5.0.0"
+__version__ = "5.5.0"
 
 # Define package exports
 __all__ = [
@@ -89,7 +89,9 @@ __all__ = [
     "EventComparisonPriorEvent",
     "EventComparisonSlideDiff",
     "EventObservationsInner",
+    "EventPeriodicReport",
     "EventRef",
+    "EventResultsFiling",
     "EventStats",
     "EventStatsEvent",
     "EventTypeCatalogEntry",
@@ -363,7 +365,9 @@ from invinite_data_api.models.event_comparison_new_topics_inner import EventComp
 from invinite_data_api.models.event_comparison_prior_event import EventComparisonPriorEvent as EventComparisonPriorEvent
 from invinite_data_api.models.event_comparison_slide_diff import EventComparisonSlideDiff as EventComparisonSlideDiff
 from invinite_data_api.models.event_observations_inner import EventObservationsInner as EventObservationsInner
+from invinite_data_api.models.event_periodic_report import EventPeriodicReport as EventPeriodicReport
 from invinite_data_api.models.event_ref import EventRef as EventRef
+from invinite_data_api.models.event_results_filing import EventResultsFiling as EventResultsFiling
 from invinite_data_api.models.event_stats import EventStats as EventStats
 from invinite_data_api.models.event_stats_event import EventStatsEvent as EventStatsEvent
 from invinite_data_api.models.event_type_catalog_entry import EventTypeCatalogEntry as EventTypeCatalogEntry

{invinite_data_api-5.0.0 → invinite_data_api-5.5.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/5.0.0/python'
+        self.user_agent = 'OpenAPI-Generator/5.5.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/invinite_data_api/configuration.py

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

invinite_data_api-5.5.0/invinite_data_api/errors.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+"""Typed problem errors: every 4xx / 5xx answer of the Data API is an RFC 9457 ``application/problem+json`` body
+``{type, title, status, detail, code, param?, errors?, remedy, request_id, docs_url}``.
+
+Hand-written, not generated from the spec: ``sdks/data/templates/python/errors.mustache`` in
+outraday-org/invinite-data-api.
+
+    from invinite_data_api import ApiException
+    from invinite_data_api.errors import as_api_error
+
+    try:
+        filings.list_filings(company="AAPL", limit=500)
+    except ApiException as exc:
+        problem = as_api_error(exc)
+        if problem is None:
+            raise
+        print(problem.detail)
+        print(problem.remedy)
+"""
+
+import json
+from typing import Any, Dict, List, Optional
+
+from invinite_data_api.exceptions import ApiException
+
+__all__ = ["InviniteApiError", "as_api_error"]
+
+
+def _text(problem: Dict[str, Any], key: str) -> Optional[str]:
+    value = problem.get(key)
+    return value if isinstance(value, str) else None
+
+
+def _header(headers: Any, name: str) -> Optional[str]:
+    if not headers:
+        return None
+    try:
+        value = headers.get(name)
+    except AttributeError:
+        return None
+    return value if isinstance(value, str) else None
+
+
+class InviniteApiError(ApiException):
+    """A problem answer of the Data API.
+
+    Attributes: ``status``, ``code``, ``detail``, ``remedy`` (what to do next), ``param``, ``errors``,
+    ``request_id``, ``docs_url``, ``retry_after_ms`` (the ``Retry-After`` header in milliseconds) and ``problem`` (the
+    parsed body). ``body`` and ``headers`` stay as ``ApiException`` has them (``body`` is the raw text).
+    """
+
+    def __init__(self, exc: ApiException, problem: Dict[str, Any]) -> None:
+        super().__init__(status=exc.status, reason=exc.reason, body=exc.body, data=exc.data)
+        self.headers = exc.headers
+        self.problem: Dict[str, Any] = problem
+        status = problem.get("status")
+        if isinstance(status, int):
+            self.status = status
+        self.code: str = _text(problem, "code") or ""
+        self.detail: str = _text(problem, "detail") or _text(problem, "title") or "HTTP {0}".format(self.status)
+        self.remedy: Optional[str] = _text(problem, "remedy")
+        self.param: Optional[str] = _text(problem, "param")
+        errors = problem.get("errors")
+        self.errors: Optional[List[Dict[str, Any]]] = errors if isinstance(errors, list) else None
+        self.request_id: str = _text(problem, "request_id") or _header(exc.headers, "X-Request-Id") or ""
+        self.docs_url: str = _text(problem, "docs_url") or ""
+        self.retry_after_ms: Optional[int] = None
+        retry_after = _header(exc.headers, "Retry-After")
+        if retry_after is not None:
+            try:
+                seconds = float(retry_after)
+            except ValueError:
+                seconds = -1.0
+            if seconds >= 0:
+                self.retry_after_ms = int(seconds * 1000)
+
+    def __str__(self) -> str:
+        lines = ["({0}) {1}: {2}".format(self.status, self.code, self.detail)]
+        if self.remedy:
+            lines.append(self.remedy)
+        if self.request_id:
+            lines.append("request_id: " + self.request_id)
+        return "\n".join(lines)
+
+
+def as_api_error(exc: BaseException) -> Optional[InviniteApiError]:
+    """The problem behind an exception a generated method raised.
+
+    An ``InviniteApiError`` for an ``ApiException`` whose body is a problem, ``None`` for anything else (a network
+    error, a non-problem body).
+    """
+    if isinstance(exc, InviniteApiError):
+        return exc
+    if not isinstance(exc, ApiException):
+        return None
+    raw = exc.body
+    if isinstance(raw, (bytes, bytearray)):
+        raw = raw.decode("utf-8", errors="replace")
+    if not isinstance(raw, str) or raw == "":
+        return None
+    try:
+        problem = json.loads(raw)
+    except ValueError:
+        return None
+    if not isinstance(problem, dict) or not isinstance(problem.get("code"), str):
+        return None
+    return InviniteApiError(exc, problem)

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/invinite_data_api/models/__init__.py

@@ -57,7 +57,9 @@ from invinite_data_api.models.event_comparison_new_topics_inner import EventComp
 from invinite_data_api.models.event_comparison_prior_event import EventComparisonPriorEvent
 from invinite_data_api.models.event_comparison_slide_diff import EventComparisonSlideDiff
 from invinite_data_api.models.event_observations_inner import EventObservationsInner
+from invinite_data_api.models.event_periodic_report import EventPeriodicReport
 from invinite_data_api.models.event_ref import EventRef
+from invinite_data_api.models.event_results_filing import EventResultsFiling
 from invinite_data_api.models.event_stats import EventStats
 from invinite_data_api.models.event_stats_event import EventStatsEvent
 from invinite_data_api.models.event_type_catalog_entry import EventTypeCatalogEntry

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/invinite_data_api/models/event.py

@@ -23,6 +23,8 @@ from typing import Any, ClassVar, Dict, List, Optional
 from uuid import UUID
 from invinite_data_api.models.event_calendar import EventCalendar
 from invinite_data_api.models.event_observations_inner import EventObservationsInner
+from invinite_data_api.models.event_periodic_report import EventPeriodicReport
+from invinite_data_api.models.event_results_filing import EventResultsFiling
 from invinite_data_api.models.event_video import EventVideo
 from typing import Optional, Set
 from typing_extensions import Self
@@ -61,9 +63,11 @@ class Event(BaseModel):
     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")
     video: Optional[EventVideo]
+    results_filing: Optional[EventResultsFiling] = None
+    periodic_report: Optional[EventPeriodicReport] = None
     observations: Optional[List[EventObservationsInner]] = Field(default=None, description="Date / time observations, oldest first (at most 50)")
     calendar: Optional[EventCalendar] = None
-    __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", "expired_reason", "reschedule_count", "has_transcript", "has_audio", "has_slides", "has_press_release", "has_documents", "webcast_url", "video", "observations", "calendar"]
+    __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", "expired_reason", "reschedule_count", "has_transcript", "has_audio", "has_slides", "has_press_release", "has_documents", "webcast_url", "video", "results_filing", "periodic_report", "observations", "calendar"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -107,6 +111,12 @@ class Event(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of video
         if self.video:
             _dict['video'] = self.video.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of results_filing
+        if self.results_filing:
+            _dict['results_filing'] = self.results_filing.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of periodic_report
+        if self.periodic_report:
+            _dict['periodic_report'] = self.periodic_report.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in observations (list)
         _items = []
         if self.observations:
@@ -182,6 +192,16 @@ class Event(BaseModel):
         if self.video is None and "video" in self.model_fields_set:
             _dict['video'] = None
 
+        # set to None if results_filing (nullable) is None
+        # and model_fields_set contains the field
+        if self.results_filing is None and "results_filing" in self.model_fields_set:
+            _dict['results_filing'] = None
+
+        # set to None if periodic_report (nullable) is None
+        # and model_fields_set contains the field
+        if self.periodic_report is None and "periodic_report" in self.model_fields_set:
+            _dict['periodic_report'] = None
+
         # set to None if observations (nullable) is None
         # and model_fields_set contains the field
         if self.observations is None and "observations" in self.model_fields_set:
@@ -233,6 +253,8 @@ class Event(BaseModel):
             "has_documents": obj.get("has_documents"),
             "webcast_url": obj.get("webcast_url"),
             "video": EventVideo.from_dict(obj["video"]) if obj.get("video") is not None else None,
+            "results_filing": EventResultsFiling.from_dict(obj["results_filing"]) if obj.get("results_filing") is not None else None,
+            "periodic_report": EventPeriodicReport.from_dict(obj["periodic_report"]) if obj.get("periodic_report") is not None else None,
             "observations": [EventObservationsInner.from_dict(_item) for _item in obj["observations"]] if obj.get("observations") is not None else None,
             "calendar": EventCalendar.from_dict(obj["calendar"]) if obj.get("calendar") is not None else None
         })

invinite_data_api-5.5.0/invinite_data_api/models/event_periodic_report.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan's included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account's usage by day, product family and key (it costs no credits).  **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan's limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription):  | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) |  Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`.  ## Licensing  | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – |  Invinite data may be shown and, from PRO, redistributed inside the licensee's own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee's own data, at any tier, under any contract.  Policy version: 2026-10-draft. Draft — pending counsel sign-off.  Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  News: News text is Invinite's own summary of the issuer's or the SEC's publication (the publisher's text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies.  PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite's summary of the issuer's or the SEC's publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source's reuse is denied.  Every `/v1/*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none.  ## Status  [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API.  Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours.  Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
+
+    The version of the OpenAPI document: 2026-11-11
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import date, datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class EventPeriodicReport(BaseModel):
+    """
+    The periodic report of the event's fiscal period: the 10-Q (10-QT) for a fiscal Q1–Q3, the 10-K (10-KT, 20-F, 40-F) for a fiscal Q4. null until it is filed and attributed; never an amendment. A foreign filer has none for Q1–Q3 (no quarterly form). Appended 2026-11
+    """ # noqa: E501
+    accession: StrictStr = Field(description="SEC accession number (0000320193-26-000024)")
+    form: StrictStr = Field(description="Form type (10-Q, 10-QT, 10-K, 10-KT, 20-F, 40-F)")
+    period_end: Optional[date] = Field(description="Period end the filing reports (YYYY-MM-DD)")
+    filing_date: Optional[date] = Field(description="SEC filing date (YYYY-MM-DD)")
+    accepted_at: Optional[datetime] = Field(description="EDGAR acceptance time (ISO 8601 UTC)")
+    edgar_index_url: Optional[StrictStr] = Field(description="The filing's EDGAR index page; null when the CIK is unknown")
+    __properties: ClassVar[List[str]] = ["accession", "form", "period_end", "filing_date", "accepted_at", "edgar_index_url"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventPeriodicReport from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if period_end (nullable) is None
+        # and model_fields_set contains the field
+        if self.period_end is None and "period_end" in self.model_fields_set:
+            _dict['period_end'] = None
+
+        # set to None if filing_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.filing_date is None and "filing_date" in self.model_fields_set:
+            _dict['filing_date'] = None
+
+        # set to None if accepted_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.accepted_at is None and "accepted_at" in self.model_fields_set:
+            _dict['accepted_at'] = None
+
+        # set to None if edgar_index_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.edgar_index_url is None and "edgar_index_url" in self.model_fields_set:
+            _dict['edgar_index_url'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventPeriodicReport from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accession": obj.get("accession"),
+            "form": obj.get("form"),
+            "period_end": obj.get("period_end"),
+            "filing_date": obj.get("filing_date"),
+            "accepted_at": obj.get("accepted_at"),
+            "edgar_index_url": obj.get("edgar_index_url")
+        })
+        return _obj
+
+

invinite_data_api-5.5.0/invinite_data_api/models/event_results_filing.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan's included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account's usage by day, product family and key (it costs no credits).  **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan's limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription):  | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) |  Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`.  ## Licensing  | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – |  Invinite data may be shown and, from PRO, redistributed inside the licensee's own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee's own data, at any tier, under any contract.  Policy version: 2026-10-draft. Draft — pending counsel sign-off.  Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  News: News text is Invinite's own summary of the issuer's or the SEC's publication (the publisher's text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies.  PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite's summary of the issuer's or the SEC's publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source's reuse is denied.  Every `/v1/*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none.  ## Status  [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API.  Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours.  Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
+
+    The version of the OpenAPI document: 2026-11-11
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class EventResultsFiling(BaseModel):
+    """
+    The results filing: the earnings 8-K / 6-K (or its first attributed filing) whose EDGAR acceptance stamped `results_released_at`. Read the document with the SEC filing operations by `accession`. null before the results are filed. Appended 2026-11
+    """ # noqa: E501
+    accession: StrictStr = Field(description="SEC accession number (0000320193-26-000024)")
+    form: StrictStr = Field(description="Form type (8-K, 8-K/A, 6-K, 6-K/A)")
+    accepted_at: Optional[datetime] = Field(description="EDGAR acceptance time (ISO 8601 UTC)")
+    edgar_index_url: Optional[StrictStr] = Field(description="The filing's EDGAR index page; null when the CIK is unknown")
+    __properties: ClassVar[List[str]] = ["accession", "form", "accepted_at", "edgar_index_url"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EventResultsFiling from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if accepted_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.accepted_at is None and "accepted_at" in self.model_fields_set:
+            _dict['accepted_at'] = None
+
+        # set to None if edgar_index_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.edgar_index_url is None and "edgar_index_url" in self.model_fields_set:
+            _dict['edgar_index_url'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EventResultsFiling from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accession": obj.get("accession"),
+            "form": obj.get("form"),
+            "accepted_at": obj.get("accepted_at"),
+            "edgar_index_url": obj.get("edgar_index_url")
+        })
+        return _obj
+
+

{invinite_data_api-5.0.0 → invinite_data_api-5.5.0}/invinite_data_api/models/problem.py

@@ -35,9 +35,10 @@ class Problem(BaseModel):
     code: StrictStr = Field(description="Stable machine-readable code (lower_snake)", json_schema_extra={"examples": ["invalid_parameter"]})
     param: Optional[StrictStr] = Field(default=None, description="The query parameter the problem is about", json_schema_extra={"examples": ["limit"]})
     errors: Optional[List[ProblemErrorsInner]] = Field(default=None, description="Every parameter problem of a 400 (invalid_parameter / unknown_parameter)")
+    remedy: StrictStr = Field(description="What to do next: one imperative sentence ending with a period, surface neutral (no CLI command, no HTTP status number). A per-code default when the operation gives none", json_schema_extra={"examples": ["Pass a limit of at most 200, or walk the pages with next_cursor."]})
     request_id: StrictStr = Field(description="The `X-Request-Id` of this response", json_schema_extra={"examples": ["req_01JCX3V7Q9W2N8M4K6T0B5R1YZ"]})
     docs_url: StrictStr = Field(description="Documentation of the code", json_schema_extra={"examples": ["https://data.invinite.com/docs/errors#invalid_parameter"]})
-    __properties: ClassVar[List[str]] = ["type", "title", "status", "detail", "code", "param", "errors", "request_id", "docs_url"]
+    __properties: ClassVar[List[str]] = ["type", "title", "status", "detail", "code", "param", "errors", "remedy", "request_id", "docs_url"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -109,6 +110,7 @@ class Problem(BaseModel):
             "code": obj.get("code"),
             "param": obj.get("param"),
             "errors": [ProblemErrorsInner.from_dict(_item) for _item in obj["errors"]] if obj.get("errors") is not None else None,
+            "remedy": obj.get("remedy"),
             "request_id": obj.get("request_id"),
             "docs_url": obj.get("docs_url")
         })