finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/transcriptresponse.py

@@ -0,0 +1,162 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 8f6535906971
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class ParticipantTypedDict(TypedDict):
+    description: NotRequired[str]
+    r"""Description of the participant, such as their title or affiliation."""
+    name: NotRequired[str]
+    r"""Name of the participant."""
+    role: NotRequired[str]
+    r"""Role of the participant in the call."""
+
+
+class Participant(BaseModel):
+    description: Optional[str] = None
+    r"""Description of the participant, such as their title or affiliation."""
+
+    name: Optional[str] = None
+    r"""Name of the participant."""
+
+    role: Optional[str] = None
+    r"""Role of the participant in the call."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["description", "name", "role"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class TranscriptResponseTranscriptTypedDict(TypedDict):
+    name: NotRequired[str]
+    r"""Name of the speaker."""
+    session: NotRequired[str]
+    r"""Session of the call the segment belongs to."""
+    speech: NotRequired[List[str]]
+    r"""Spoken paragraphs by the speaker."""
+
+
+class TranscriptResponseTranscript(BaseModel):
+    name: Optional[str] = None
+    r"""Name of the speaker."""
+
+    session: Optional[str] = None
+    r"""Session of the call the segment belongs to."""
+
+    speech: Optional[List[str]] = None
+    r"""Spoken paragraphs by the speaker."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["name", "session", "speech"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class TranscriptResponseTypedDict(TypedDict):
+    r"""Full earnings call transcript with participants and speech segments."""
+
+    audio: NotRequired[str]
+    r"""URL of the earnings call audio recording."""
+    id: NotRequired[str]
+    r"""Transcript identifier."""
+    participant: NotRequired[List[ParticipantTypedDict]]
+    r"""Participants in the earnings call."""
+    quarter: NotRequired[int]
+    r"""Fiscal quarter of the earnings call."""
+    symbol: NotRequired[str]
+    r"""Ticker symbol of the company."""
+    time: NotRequired[str]
+    r"""Timestamp of the earnings call as provided by the data vendor."""
+    title: NotRequired[str]
+    r"""Title of the earnings call transcript."""
+    transcript: NotRequired[List[TranscriptResponseTranscriptTypedDict]]
+    r"""Speech segments of the call in order."""
+    year: NotRequired[int]
+    r"""Fiscal year of the earnings call."""
+
+
+class TranscriptResponse(BaseModel):
+    r"""Full earnings call transcript with participants and speech segments."""
+
+    audio: Optional[str] = None
+    r"""URL of the earnings call audio recording."""
+
+    id: Optional[str] = None
+    r"""Transcript identifier."""
+
+    participant: Optional[List[Participant]] = None
+    r"""Participants in the earnings call."""
+
+    quarter: Optional[int] = None
+    r"""Fiscal quarter of the earnings call."""
+
+    symbol: Optional[str] = None
+    r"""Ticker symbol of the company."""
+
+    time: Optional[str] = None
+    r"""Timestamp of the earnings call as provided by the data vendor."""
+
+    title: Optional[str] = None
+    r"""Title of the earnings call transcript."""
+
+    transcript: Optional[List[TranscriptResponseTranscript]] = None
+    r"""Speech segments of the call in order."""
+
+    year: Optional[int] = None
+    r"""Fiscal year of the earnings call."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "audio",
+                "id",
+                "participant",
+                "quarter",
+                "symbol",
+                "time",
+                "title",
+                "transcript",
+                "year",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

finance_dev/models/transcriptsresponse.py

@@ -0,0 +1,89 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 8ed4f5912f14
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class TranscriptsResponseTranscriptTypedDict(TypedDict):
+    id: NotRequired[str]
+    r"""Transcript identifier, used to fetch the full transcript."""
+    quarter: NotRequired[int]
+    r"""Fiscal quarter of the earnings call."""
+    time: NotRequired[str]
+    r"""Timestamp of the earnings call as provided by the data vendor."""
+    title: NotRequired[str]
+    r"""Title of the earnings call transcript."""
+    year: NotRequired[int]
+    r"""Fiscal year of the earnings call."""
+
+
+class TranscriptsResponseTranscript(BaseModel):
+    id: Optional[str] = None
+    r"""Transcript identifier, used to fetch the full transcript."""
+
+    quarter: Optional[int] = None
+    r"""Fiscal quarter of the earnings call."""
+
+    time: Optional[str] = None
+    r"""Timestamp of the earnings call as provided by the data vendor."""
+
+    title: Optional[str] = None
+    r"""Title of the earnings call transcript."""
+
+    year: Optional[int] = None
+    r"""Fiscal year of the earnings call."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["id", "quarter", "time", "title", "year"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class TranscriptsResponseTypedDict(TypedDict):
+    r"""List of available earnings call transcripts for a company."""
+
+    symbol: NotRequired[str]
+    r"""Ticker symbol of the company."""
+    transcripts: NotRequired[List[TranscriptsResponseTranscriptTypedDict]]
+    r"""Available earnings call transcripts."""
+
+
+class TranscriptsResponse(BaseModel):
+    r"""List of available earnings call transcripts for a company."""
+
+    symbol: Optional[str] = None
+    r"""Ticker symbol of the company."""
+
+    transcripts: Optional[List[TranscriptsResponseTranscript]] = None
+    r"""Available earnings call transcripts."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["symbol", "transcripts"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m

finance_dev/models/treasuryyieldsresponse.py

@@ -0,0 +1,160 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 4d972f1bedc8
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class TreasuryYieldsResponseResultTypedDict(TypedDict):
+    date_: NotRequired[str]
+    r"""Reference date (YYYY-MM-DD)"""
+    yield10_year: NotRequired[float]
+    r"""Treasury yield for the 10-year maturity on the reference date, as reported by the upstream provider"""
+    yield1_month: NotRequired[float]
+    r"""Treasury yield for the 1-month maturity on the reference date, as reported by the upstream provider"""
+    yield1_year: NotRequired[float]
+    r"""Treasury yield for the 1-year maturity on the reference date, as reported by the upstream provider"""
+    yield20_year: NotRequired[float]
+    r"""Treasury yield for the 20-year maturity on the reference date, as reported by the upstream provider"""
+    yield2_year: NotRequired[float]
+    r"""Treasury yield for the 2-year maturity on the reference date, as reported by the upstream provider"""
+    yield30_year: NotRequired[float]
+    r"""Treasury yield for the 30-year maturity on the reference date, as reported by the upstream provider"""
+    yield3_month: NotRequired[float]
+    r"""Treasury yield for the 3-month maturity on the reference date, as reported by the upstream provider"""
+    yield3_year: NotRequired[float]
+    r"""Treasury yield for the 3-year maturity on the reference date, as reported by the upstream provider"""
+    yield5_year: NotRequired[float]
+    r"""Treasury yield for the 5-year maturity on the reference date, as reported by the upstream provider"""
+    yield6_month: NotRequired[float]
+    r"""Treasury yield for the 6-month maturity on the reference date, as reported by the upstream provider"""
+    yield7_year: NotRequired[float]
+    r"""Treasury yield for the 7-year maturity on the reference date, as reported by the upstream provider"""
+
+
+class TreasuryYieldsResponseResult(BaseModel):
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Reference date (YYYY-MM-DD)"""
+
+    yield10_year: Annotated[Optional[float], pydantic.Field(alias="yield10Year")] = None
+    r"""Treasury yield for the 10-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield1_month: Annotated[Optional[float], pydantic.Field(alias="yield1Month")] = None
+    r"""Treasury yield for the 1-month maturity on the reference date, as reported by the upstream provider"""
+
+    yield1_year: Annotated[Optional[float], pydantic.Field(alias="yield1Year")] = None
+    r"""Treasury yield for the 1-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield20_year: Annotated[Optional[float], pydantic.Field(alias="yield20Year")] = None
+    r"""Treasury yield for the 20-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield2_year: Annotated[Optional[float], pydantic.Field(alias="yield2Year")] = None
+    r"""Treasury yield for the 2-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield30_year: Annotated[Optional[float], pydantic.Field(alias="yield30Year")] = None
+    r"""Treasury yield for the 30-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield3_month: Annotated[Optional[float], pydantic.Field(alias="yield3Month")] = None
+    r"""Treasury yield for the 3-month maturity on the reference date, as reported by the upstream provider"""
+
+    yield3_year: Annotated[Optional[float], pydantic.Field(alias="yield3Year")] = None
+    r"""Treasury yield for the 3-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield5_year: Annotated[Optional[float], pydantic.Field(alias="yield5Year")] = None
+    r"""Treasury yield for the 5-year maturity on the reference date, as reported by the upstream provider"""
+
+    yield6_month: Annotated[Optional[float], pydantic.Field(alias="yield6Month")] = None
+    r"""Treasury yield for the 6-month maturity on the reference date, as reported by the upstream provider"""
+
+    yield7_year: Annotated[Optional[float], pydantic.Field(alias="yield7Year")] = None
+    r"""Treasury yield for the 7-year maturity on the reference date, as reported by the upstream provider"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "date",
+                "yield10Year",
+                "yield1Month",
+                "yield1Year",
+                "yield20Year",
+                "yield2Year",
+                "yield30Year",
+                "yield3Month",
+                "yield3Year",
+                "yield5Year",
+                "yield6Month",
+                "yield7Year",
+            ]
+        )
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+class TreasuryYieldsResponseTypedDict(TypedDict):
+    r"""U.S. Treasury yield curve observations by maturity for each reference date, sourced from Polygon."""
+
+    next_url: NotRequired[str]
+    r"""URL for next page of results"""
+    request_id: NotRequired[str]
+    r"""Request identifier returned by the upstream data provider"""
+    results: NotRequired[List[TreasuryYieldsResponseResultTypedDict]]
+    r"""Daily treasury yield observations from the upstream provider"""
+    status: NotRequired[str]
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+
+class TreasuryYieldsResponse(BaseModel):
+    r"""U.S. Treasury yield curve observations by maturity for each reference date, sourced from Polygon."""
+
+    next_url: Annotated[Optional[str], pydantic.Field(alias="nextUrl")] = None
+    r"""URL for next page of results"""
+
+    request_id: Annotated[Optional[str], pydantic.Field(alias="requestId")] = None
+    r"""Request identifier returned by the upstream data provider"""
+
+    results: Optional[List[TreasuryYieldsResponseResult]] = None
+    r"""Daily treasury yield observations from the upstream provider"""
+
+    status: Optional[str] = None
+    r"""Status string from the upstream data provider — typically `OK` for a successful response. Treat any other value as an error indicator alongside the HTTP status code."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["nextUrl", "requestId", "results", "status"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+
+            if val != UNSET_SENTINEL:
+                if val is not None or k not in optional_fields:
+                    m[k] = val
+
+        return m
+
+
+try:
+    TreasuryYieldsResponseResult.model_rebuild()
+except NameError:
+    pass
+try:
+    TreasuryYieldsResponse.model_rebuild()
+except NameError:
+    pass