invinite-data-api 0.1.0__py3-none-any.whl

invinite_data_api/models/earnings_calls_extractions200_response_guidance_inner.py

@@ -0,0 +1,187 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan's included credits. `GET /v1/account/usage` returns your account's usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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 are forensically watermarked per customer. Audio is served through signed URLs, is subject to per-company takedown and may not be re-hosted; every delivered file carries a per-account forensic watermark: a copy found elsewhere is traced to the account that received it.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
+
+    The version of the OpenAPI document: 1.0.0
+    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 pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from uuid import UUID
+from invinite_data_api.models.earnings_calls_extractions200_response_guidance_inner_sources_inner import EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class EarningsCallsExtractions200ResponseGuidanceInner(BaseModel):
+    """
+    EarningsCallsExtractions200ResponseGuidanceInner
+    """ # noqa: E501
+    id: UUID = Field(description="Guidance item identifier")
+    metric: StrictStr = Field(description="Metric as stated")
+    metric_normalized: StrictStr = Field(description="Normalized metric (guidance/history vocabulary)")
+    period_label: StrictStr = Field(description="Guided period (e.g. Q1 FY2027, FY2027)")
+    period_kind: StrictStr = Field(description="Kind of period")
+    low: Optional[Union[StrictFloat, StrictInt]] = Field(description="Low end, base units")
+    high: Optional[Union[StrictFloat, StrictInt]] = Field(description="High end, base units")
+    midpoint: Optional[Union[StrictFloat, StrictInt]] = Field(description="Midpoint (or point guidance), base units")
+    unit: Optional[StrictStr] = Field(description="usd, pct, shares, ratio or other")
+    currency: Optional[StrictStr] = Field(description="ISO currency")
+    basis: StrictStr = Field(description="Accounting basis")
+    direction: StrictStr = Field(description="Versus the prior call's guidance")
+    prior_item_id: Optional[UUID] = Field(description="The prior call's item")
+    confidence: Union[StrictFloat, StrictInt] = Field(description="Calibrated confidence 0..1 (not a probability)")
+    cross_validated: StrictBool = Field(description="Call and press release agree")
+    review_status: StrictStr = Field(description="Review state")
+    sources: List[EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner] = Field(description="Citations")
+    __properties: ClassVar[List[str]] = ["id", "metric", "metric_normalized", "period_label", "period_kind", "low", "high", "midpoint", "unit", "currency", "basis", "direction", "prior_item_id", "confidence", "cross_validated", "review_status", "sources"]
+
+    @field_validator('period_kind')
+    def period_kind_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['quarter', 'fiscal_year', 'half', 'other']):
+            raise ValueError("must be one of enum values ('quarter', 'fiscal_year', 'half', 'other')")
+        return value
+
+    @field_validator('basis')
+    def basis_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['gaap', 'non_gaap', 'unknown']):
+            raise ValueError("must be one of enum values ('gaap', 'non_gaap', 'unknown')")
+        return value
+
+    @field_validator('direction')
+    def direction_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['raised', 'lowered', 'maintained', 'withdrawn', 'new', 'unknown']):
+            raise ValueError("must be one of enum values ('raised', 'lowered', 'maintained', 'withdrawn', 'new', 'unknown')")
+        return value
+
+    @field_validator('review_status')
+    def review_status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['auto', 'needs_review', 'approved']):
+            raise ValueError("must be one of enum values ('auto', 'needs_review', 'approved')")
+        return value
+
+    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 EarningsCallsExtractions200ResponseGuidanceInner 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        # set to None if low (nullable) is None
+        # and model_fields_set contains the field
+        if self.low is None and "low" in self.model_fields_set:
+            _dict['low'] = None
+
+        # set to None if high (nullable) is None
+        # and model_fields_set contains the field
+        if self.high is None and "high" in self.model_fields_set:
+            _dict['high'] = None
+
+        # set to None if midpoint (nullable) is None
+        # and model_fields_set contains the field
+        if self.midpoint is None and "midpoint" in self.model_fields_set:
+            _dict['midpoint'] = None
+
+        # set to None if unit (nullable) is None
+        # and model_fields_set contains the field
+        if self.unit is None and "unit" in self.model_fields_set:
+            _dict['unit'] = None
+
+        # set to None if currency (nullable) is None
+        # and model_fields_set contains the field
+        if self.currency is None and "currency" in self.model_fields_set:
+            _dict['currency'] = None
+
+        # set to None if prior_item_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.prior_item_id is None and "prior_item_id" in self.model_fields_set:
+            _dict['prior_item_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EarningsCallsExtractions200ResponseGuidanceInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "metric": obj.get("metric"),
+            "metric_normalized": obj.get("metric_normalized"),
+            "period_label": obj.get("period_label"),
+            "period_kind": obj.get("period_kind"),
+            "low": obj.get("low"),
+            "high": obj.get("high"),
+            "midpoint": obj.get("midpoint"),
+            "unit": obj.get("unit"),
+            "currency": obj.get("currency"),
+            "basis": obj.get("basis"),
+            "direction": obj.get("direction"),
+            "prior_item_id": obj.get("prior_item_id"),
+            "confidence": obj.get("confidence"),
+            "cross_validated": obj.get("cross_validated"),
+            "review_status": obj.get("review_status"),
+            "sources": [EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None
+        })
+        return _obj
+
+

invinite_data_api/models/earnings_calls_extractions200_response_guidance_inner_sources_inner.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan's included credits. `GET /v1/account/usage` returns your account's usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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 are forensically watermarked per customer. Audio is served through signed URLs, is subject to per-company takedown and may not be re-hosted; every delivered file carries a per-account forensic watermark: a copy found elsewhere is traced to the account that received it.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
+
+    The version of the OpenAPI document: 1.0.0
+    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 pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from invinite_data_api.models.earnings_calls_extractions200_response_guidance_inner_sources_inner_speaker import EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner(BaseModel):
+    """
+    EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner
+    """ # noqa: E501
+    origin: StrictStr = Field(description="Where the sentence comes from")
+    sentence: StrictStr = Field(description="The verbatim source sentence")
+    start_ms: Optional[StrictInt] = Field(description="Where it was spoken (ms into the call)")
+    speaker: EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker
+    __properties: ClassVar[List[str]] = ["origin", "sentence", "start_ms", "speaker"]
+
+    @field_validator('origin')
+    def origin_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['transcript', 'press_release']):
+            raise ValueError("must be one of enum values ('transcript', 'press_release')")
+        return value
+
+    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 EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of speaker
+        if self.speaker:
+            _dict['speaker'] = self.speaker.to_dict()
+        # set to None if start_ms (nullable) is None
+        # and model_fields_set contains the field
+        if self.start_ms is None and "start_ms" in self.model_fields_set:
+            _dict['start_ms'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "origin": obj.get("origin"),
+            "sentence": obj.get("sentence"),
+            "start_ms": obj.get("start_ms"),
+            "speaker": EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.from_dict(obj["speaker"]) if obj.get("speaker") is not None else None
+        })
+        return _obj
+
+

invinite_data_api/models/earnings_calls_extractions200_response_guidance_inner_sources_inner_speaker.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan's included credits. `GET /v1/account/usage` returns your account's usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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 are forensically watermarked per customer. Audio is served through signed URLs, is subject to per-company takedown and may not be re-hosted; every delivered file carries a per-account forensic watermark: a copy found elsewhere is traced to the account that received it.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
+
+    The version of the OpenAPI document: 1.0.0
+    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 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 EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker(BaseModel):
+    """
+    EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker
+    """ # noqa: E501
+    label: Optional[StrictStr] = Field(description="Speaker label of the transcript (A, B, …); null for press-release text")
+    name: Optional[StrictStr] = Field(description="Speaker name (participants route)")
+    title: Optional[StrictStr] = Field(description="Speaker title")
+    __properties: ClassVar[List[str]] = ["label", "name", "title"]
+
+    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 EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker 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 label (nullable) is None
+        # and model_fields_set contains the field
+        if self.label is None and "label" in self.model_fields_set:
+            _dict['label'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if title (nullable) is None
+        # and model_fields_set contains the field
+        if self.title is None and "title" in self.model_fields_set:
+            _dict['title'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "label": obj.get("label"),
+            "name": obj.get("name"),
+            "title": obj.get("title")
+        })
+        return _obj
+
+

invinite_data_api/models/earnings_calls_extractions200_response_kpis_inner.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+"""
+    Invinite API
+
+    Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan's included credits. `GET /v1/account/usage` returns your account's usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost.  ## Webhooks  Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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 are forensically watermarked per customer. Audio is served through signed URLs, is subject to per-company takedown and may not be re-hosted; every delivered file carries a per-account forensic watermark: a copy found elsewhere is traced to the account that received it.  SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite's.  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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
+
+    The version of the OpenAPI document: 1.0.0
+    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 pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from invinite_data_api.models.earnings_calls_extractions200_response_guidance_inner_sources_inner_speaker import EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker
+from invinite_data_api.models.earnings_calls_extractions200_response_kpis_inner_filing_link import EarningsCallsExtractions200ResponseKpisInnerFilingLink
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class EarningsCallsExtractions200ResponseKpisInner(BaseModel):
+    """
+    EarningsCallsExtractions200ResponseKpisInner
+    """ # noqa: E501
+    seq: StrictInt = Field(description="Order in the call / release")
+    metric: StrictStr = Field(description="Metric as stated")
+    metric_normalized: Optional[StrictStr] = Field(description="Normalized metric; null = outside the dictionary")
+    value: Optional[Union[StrictFloat, StrictInt]] = Field(description="Value, base units")
+    value_text: StrictStr = Field(description="As spoken ('$1.2 billion', '14%')")
+    unit: Optional[StrictStr] = Field(description="Unit")
+    period_label: Optional[StrictStr] = Field(description="Reported period")
+    source_sentence: StrictStr = Field(description="The verbatim source sentence")
+    start_ms: Optional[StrictInt] = Field(description="Where it was spoken (ms into the call)")
+    speaker: EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker
+    origin: StrictStr = Field(description="transcript or press_release")
+    filing_link: Optional[EarningsCallsExtractions200ResponseKpisInnerFilingLink]
+    __properties: ClassVar[List[str]] = ["seq", "metric", "metric_normalized", "value", "value_text", "unit", "period_label", "source_sentence", "start_ms", "speaker", "origin", "filing_link"]
+
+    @field_validator('origin')
+    def origin_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['transcript', 'press_release']):
+            raise ValueError("must be one of enum values ('transcript', 'press_release')")
+        return value
+
+    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 EarningsCallsExtractions200ResponseKpisInner 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of speaker
+        if self.speaker:
+            _dict['speaker'] = self.speaker.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of filing_link
+        if self.filing_link:
+            _dict['filing_link'] = self.filing_link.to_dict()
+        # set to None if metric_normalized (nullable) is None
+        # and model_fields_set contains the field
+        if self.metric_normalized is None and "metric_normalized" in self.model_fields_set:
+            _dict['metric_normalized'] = None
+
+        # set to None if value (nullable) is None
+        # and model_fields_set contains the field
+        if self.value is None and "value" in self.model_fields_set:
+            _dict['value'] = None
+
+        # set to None if unit (nullable) is None
+        # and model_fields_set contains the field
+        if self.unit is None and "unit" in self.model_fields_set:
+            _dict['unit'] = None
+
+        # set to None if period_label (nullable) is None
+        # and model_fields_set contains the field
+        if self.period_label is None and "period_label" in self.model_fields_set:
+            _dict['period_label'] = None
+
+        # set to None if start_ms (nullable) is None
+        # and model_fields_set contains the field
+        if self.start_ms is None and "start_ms" in self.model_fields_set:
+            _dict['start_ms'] = None
+
+        # set to None if filing_link (nullable) is None
+        # and model_fields_set contains the field
+        if self.filing_link is None and "filing_link" in self.model_fields_set:
+            _dict['filing_link'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EarningsCallsExtractions200ResponseKpisInner from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "seq": obj.get("seq"),
+            "metric": obj.get("metric"),
+            "metric_normalized": obj.get("metric_normalized"),
+            "value": obj.get("value"),
+            "value_text": obj.get("value_text"),
+            "unit": obj.get("unit"),
+            "period_label": obj.get("period_label"),
+            "source_sentence": obj.get("source_sentence"),
+            "start_ms": obj.get("start_ms"),
+            "speaker": EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.from_dict(obj["speaker"]) if obj.get("speaker") is not None else None,
+            "origin": obj.get("origin"),
+            "filing_link": EarningsCallsExtractions200ResponseKpisInnerFilingLink.from_dict(obj["filing_link"]) if obj.get("filing_link") is not None else None
+        })
+        return _obj
+
+