finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/companyprofile.py

@@ -0,0 +1,255 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 3872219d566d
+
+from __future__ import annotations
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CompanyProfileTypedDict(TypedDict):
+    r"""Company profile data for research pages. Use it to explain what the company does, where it is listed, and how it is classified."""
+
+    address: NotRequired[str]
+    r"""Company headquarters street address. Use it for company profile and issuer detail pages."""
+    alias: NotRequired[str]
+    r"""Comma-separated list of alternative names or aliases for the company"""
+    city: NotRequired[str]
+    r"""City where the company is headquartered"""
+    country: NotRequired[str]
+    r"""Country where the company is headquartered"""
+    currency: NotRequired[str]
+    r"""Currency used for financial reporting (e.g., USD, EUR)"""
+    cusip: NotRequired[str]
+    r"""CUSIP security identifier used in U.S. settlement and reference-data workflows."""
+    description: NotRequired[str]
+    r"""Detailed business description"""
+    employee_total: NotRequired[int]
+    r"""Total number of employees"""
+    estimate_currency: NotRequired[str]
+    r"""Currency for earnings estimates"""
+    exchange: NotRequired[str]
+    r"""Exchange name returned by the company profile provider, such as NASDAQ NMS - GLOBAL MARKET."""
+    ggroup: NotRequired[str]
+    r"""GICS group classification"""
+    gind: NotRequired[str]
+    r"""GICS industry classification"""
+    gsector: NotRequired[str]
+    r"""GICS sector classification"""
+    gsubind: NotRequired[str]
+    r"""GICS sub-industry classification"""
+    ipo: NotRequired[str]
+    r"""Initial public offering date in YYYY-MM-DD format"""
+    ir_url: NotRequired[str]
+    r"""Investor relations website URL"""
+    isin: NotRequired[str]
+    r"""International Securities Identification Number. Use it for global security identification and reconciliation."""
+    lei: NotRequired[str]
+    r"""Legal Entity Identifier for the company. Use it for institutional reference-data and compliance workflows."""
+    logo: NotRequired[str]
+    r"""URL to the company's logo image (proxied through Aries API)"""
+    market_cap_currency: NotRequired[str]
+    r"""Currency for market capitalization"""
+    market_capitalization: NotRequired[float]
+    r"""Current market capitalization"""
+    naics: NotRequired[str]
+    r"""NAICS industry classification code. Use it for industry screening or peer grouping."""
+    naics_national_industry: NotRequired[str]
+    r"""NAICS national industry classification"""
+    naics_sector: NotRequired[str]
+    r"""NAICS sector classification"""
+    naics_subsector: NotRequired[str]
+    r"""NAICS subsector classification"""
+    name: NotRequired[str]
+    r"""Official company name. Show this beside the ticker so users can confirm the company."""
+    phone: NotRequired[str]
+    r"""Company's primary contact phone number"""
+    sector: NotRequired[str]
+    r"""Industry sector classification"""
+    sedol: NotRequired[str]
+    r"""SEDOL security identifier used in global market reference data."""
+    share_outstanding: NotRequired[float]
+    r"""Total number of outstanding shares"""
+    state: NotRequired[str]
+    r"""State where the company is headquartered"""
+    ticker: NotRequired[str]
+    r"""Primary stock ticker symbol for the company. Use it to connect profile data to quotes, filings, and financials."""
+    weburl: NotRequired[str]
+    r"""Company's official website URL"""
+
+
+class CompanyProfile(BaseModel):
+    r"""Company profile data for research pages. Use it to explain what the company does, where it is listed, and how it is classified."""
+
+    address: Optional[str] = None
+    r"""Company headquarters street address. Use it for company profile and issuer detail pages."""
+
+    alias: Optional[str] = None
+    r"""Comma-separated list of alternative names or aliases for the company"""
+
+    city: Optional[str] = None
+    r"""City where the company is headquartered"""
+
+    country: Optional[str] = None
+    r"""Country where the company is headquartered"""
+
+    currency: Optional[str] = None
+    r"""Currency used for financial reporting (e.g., USD, EUR)"""
+
+    cusip: Optional[str] = None
+    r"""CUSIP security identifier used in U.S. settlement and reference-data workflows."""
+
+    description: Optional[str] = None
+    r"""Detailed business description"""
+
+    employee_total: Annotated[Optional[int], pydantic.Field(alias="employeeTotal")] = (
+        None
+    )
+    r"""Total number of employees"""
+
+    estimate_currency: Annotated[
+        Optional[str], pydantic.Field(alias="estimateCurrency")
+    ] = None
+    r"""Currency for earnings estimates"""
+
+    exchange: Optional[str] = None
+    r"""Exchange name returned by the company profile provider, such as NASDAQ NMS - GLOBAL MARKET."""
+
+    ggroup: Optional[str] = None
+    r"""GICS group classification"""
+
+    gind: Optional[str] = None
+    r"""GICS industry classification"""
+
+    gsector: Optional[str] = None
+    r"""GICS sector classification"""
+
+    gsubind: Optional[str] = None
+    r"""GICS sub-industry classification"""
+
+    ipo: Optional[str] = None
+    r"""Initial public offering date in YYYY-MM-DD format"""
+
+    ir_url: Annotated[Optional[str], pydantic.Field(alias="irUrl")] = None
+    r"""Investor relations website URL"""
+
+    isin: Optional[str] = None
+    r"""International Securities Identification Number. Use it for global security identification and reconciliation."""
+
+    lei: Optional[str] = None
+    r"""Legal Entity Identifier for the company. Use it for institutional reference-data and compliance workflows."""
+
+    logo: Optional[str] = None
+    r"""URL to the company's logo image (proxied through Aries API)"""
+
+    market_cap_currency: Annotated[
+        Optional[str], pydantic.Field(alias="marketCapCurrency")
+    ] = None
+    r"""Currency for market capitalization"""
+
+    market_capitalization: Annotated[
+        Optional[float], pydantic.Field(alias="marketCapitalization")
+    ] = None
+    r"""Current market capitalization"""
+
+    naics: Optional[str] = None
+    r"""NAICS industry classification code. Use it for industry screening or peer grouping."""
+
+    naics_national_industry: Annotated[
+        Optional[str], pydantic.Field(alias="naicsNationalIndustry")
+    ] = None
+    r"""NAICS national industry classification"""
+
+    naics_sector: Annotated[Optional[str], pydantic.Field(alias="naicsSector")] = None
+    r"""NAICS sector classification"""
+
+    naics_subsector: Annotated[
+        Optional[str], pydantic.Field(alias="naicsSubsector")
+    ] = None
+    r"""NAICS subsector classification"""
+
+    name: Optional[str] = None
+    r"""Official company name. Show this beside the ticker so users can confirm the company."""
+
+    phone: Optional[str] = None
+    r"""Company's primary contact phone number"""
+
+    sector: Optional[str] = None
+    r"""Industry sector classification"""
+
+    sedol: Optional[str] = None
+    r"""SEDOL security identifier used in global market reference data."""
+
+    share_outstanding: Annotated[
+        Optional[float], pydantic.Field(alias="shareOutstanding")
+    ] = None
+    r"""Total number of outstanding shares"""
+
+    state: Optional[str] = None
+    r"""State where the company is headquartered"""
+
+    ticker: Optional[str] = None
+    r"""Primary stock ticker symbol for the company. Use it to connect profile data to quotes, filings, and financials."""
+
+    weburl: Optional[str] = None
+    r"""Company's official website URL"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "address",
+                "alias",
+                "city",
+                "country",
+                "currency",
+                "cusip",
+                "description",
+                "employeeTotal",
+                "estimateCurrency",
+                "exchange",
+                "ggroup",
+                "gind",
+                "gsector",
+                "gsubind",
+                "ipo",
+                "irUrl",
+                "isin",
+                "lei",
+                "logo",
+                "marketCapCurrency",
+                "marketCapitalization",
+                "naics",
+                "naicsNationalIndustry",
+                "naicsSector",
+                "naicsSubsector",
+                "name",
+                "phone",
+                "sector",
+                "sedol",
+                "shareOutstanding",
+                "state",
+                "ticker",
+                "weburl",
+            ]
+        )
+        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:
+    CompanyProfile.model_rebuild()
+except NameError:
+    pass

finance_dev/models/conferencecallsresponse.py

@@ -0,0 +1,169 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 96b2ed3e02c3
+
+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 ConferenceCallTypedDict(TypedDict):
+    access_code: NotRequired[str]
+    r"""Access code for the conference call"""
+    date_: NotRequired[str]
+    r"""Conference call date in YYYY-MM-DD format"""
+    exchange: NotRequired[str]
+    r"""Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code."""
+    id: NotRequired[str]
+    r"""Unique identifier for the conference call"""
+    importance: NotRequired[int]
+    r"""Importance rating of the event (1-5, where 5 is most important)"""
+    international_num: NotRequired[str]
+    r"""International dial-in phone number"""
+    name: NotRequired[str]
+    r"""Company name"""
+    notes: NotRequired[str]
+    r"""Additional notes about the conference call"""
+    phone_num: NotRequired[str]
+    r"""Domestic dial-in phone number"""
+    reservation_num: NotRequired[str]
+    r"""Reservation number for the conference call"""
+    start_time: NotRequired[str]
+    r"""Human-readable start time with timezone"""
+    ticker: NotRequired[str]
+    r"""Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research."""
+    time: NotRequired[str]
+    r"""Conference call time in HH:MM:SS format"""
+    updated: NotRequired[int]
+    r"""Unix timestamp when the record was last updated"""
+    webcast_url: NotRequired[str]
+    r"""URL for live webcast of the conference call"""
+
+
+class ConferenceCall(BaseModel):
+    access_code: Annotated[Optional[str], pydantic.Field(alias="accessCode")] = None
+    r"""Access code for the conference call"""
+
+    date_: Annotated[Optional[str], pydantic.Field(alias="date")] = None
+    r"""Conference call date in YYYY-MM-DD format"""
+
+    exchange: Optional[str] = None
+    r"""Exchange code where the data originates. Format depends on the upstream data source and may use MIC, ISO 10383, or a vendor-specific code."""
+
+    id: Optional[str] = None
+    r"""Unique identifier for the conference call"""
+
+    importance: Optional[int] = None
+    r"""Importance rating of the event (1-5, where 5 is most important)"""
+
+    international_num: Annotated[
+        Optional[str], pydantic.Field(alias="internationalNum")
+    ] = None
+    r"""International dial-in phone number"""
+
+    name: Optional[str] = None
+    r"""Company name"""
+
+    notes: Optional[str] = None
+    r"""Additional notes about the conference call"""
+
+    phone_num: Annotated[Optional[str], pydantic.Field(alias="phoneNum")] = None
+    r"""Domestic dial-in phone number"""
+
+    reservation_num: Annotated[
+        Optional[str], pydantic.Field(alias="reservationNum")
+    ] = None
+    r"""Reservation number for the conference call"""
+
+    start_time: Annotated[Optional[str], pydantic.Field(alias="startTime")] = None
+    r"""Human-readable start time with timezone"""
+
+    ticker: Optional[str] = None
+    r"""Stock ticker symbol, such as AAPL. Use the exact ticker for the company you want to research."""
+
+    time: Optional[str] = None
+    r"""Conference call time in HH:MM:SS format"""
+
+    updated: Optional[int] = None
+    r"""Unix timestamp when the record was last updated"""
+
+    webcast_url: Annotated[Optional[str], pydantic.Field(alias="webcastUrl")] = None
+    r"""URL for live webcast of the conference call"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "accessCode",
+                "date",
+                "exchange",
+                "id",
+                "importance",
+                "internationalNum",
+                "name",
+                "notes",
+                "phoneNum",
+                "reservationNum",
+                "startTime",
+                "ticker",
+                "time",
+                "updated",
+                "webcastUrl",
+            ]
+        )
+        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 ConferenceCallsResponseTypedDict(TypedDict):
+    r"""Response containing conference call calendar events."""
+
+    conference_calls: NotRequired[List[ConferenceCallTypedDict]]
+    r"""Array of conference call events"""
+
+
+class ConferenceCallsResponse(BaseModel):
+    r"""Response containing conference call calendar events."""
+
+    conference_calls: Annotated[
+        Optional[List[ConferenceCall]], pydantic.Field(alias="conferenceCalls")
+    ] = None
+    r"""Array of conference call events"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["conferenceCalls"])
+        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:
+    ConferenceCall.model_rebuild()
+except NameError:
+    pass
+try:
+    ConferenceCallsResponse.model_rebuild()
+except NameError:
+    pass

finance_dev/models/congressionaltradingresponse.py

@@ -0,0 +1,138 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 2c8b8fc5ef5b
+
+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 CongressionalTradingResponseDataTypedDict(TypedDict):
+    amount_from: NotRequired[float]
+    r"""Lower bound of the reported transaction amount."""
+    amount_to: NotRequired[float]
+    r"""Upper bound of the reported transaction amount."""
+    asset_name: NotRequired[str]
+    r"""Name of the asset."""
+    filing_date: NotRequired[str]
+    r"""Date the disclosure was filed, as returned by the provider."""
+    name: NotRequired[str]
+    r"""Name of the representative."""
+    owner_type: NotRequired[str]
+    r"""Type of owner of the asset."""
+    position: NotRequired[str]
+    r"""Position of the representative."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+    transaction_date: NotRequired[str]
+    r"""Date of the transaction, as returned by the provider."""
+    transaction_type: NotRequired[str]
+    r"""Type of transaction, such as Sale or Purchase."""
+
+
+class CongressionalTradingResponseData(BaseModel):
+    amount_from: Annotated[Optional[float], pydantic.Field(alias="amountFrom")] = None
+    r"""Lower bound of the reported transaction amount."""
+
+    amount_to: Annotated[Optional[float], pydantic.Field(alias="amountTo")] = None
+    r"""Upper bound of the reported transaction amount."""
+
+    asset_name: Annotated[Optional[str], pydantic.Field(alias="assetName")] = None
+    r"""Name of the asset."""
+
+    filing_date: Annotated[Optional[str], pydantic.Field(alias="filingDate")] = None
+    r"""Date the disclosure was filed, as returned by the provider."""
+
+    name: Optional[str] = None
+    r"""Name of the representative."""
+
+    owner_type: Annotated[Optional[str], pydantic.Field(alias="ownerType")] = None
+    r"""Type of owner of the asset."""
+
+    position: Optional[str] = None
+    r"""Position of the representative."""
+
+    symbol: Optional[str] = None
+    r"""Company ticker symbol."""
+
+    transaction_date: Annotated[
+        Optional[str], pydantic.Field(alias="transactionDate")
+    ] = None
+    r"""Date of the transaction, as returned by the provider."""
+
+    transaction_type: Annotated[
+        Optional[str], pydantic.Field(alias="transactionType")
+    ] = None
+    r"""Type of transaction, such as Sale or Purchase."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "amountFrom",
+                "amountTo",
+                "assetName",
+                "filingDate",
+                "name",
+                "ownerType",
+                "position",
+                "symbol",
+                "transactionDate",
+                "transactionType",
+            ]
+        )
+        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 CongressionalTradingResponseTypedDict(TypedDict):
+    r"""Stock transactions disclosed by members of US Congress for a company, as provided by Finnhub."""
+
+    data: NotRequired[List[CongressionalTradingResponseDataTypedDict]]
+    r"""Congressional transaction disclosures for the symbol."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+
+
+class CongressionalTradingResponse(BaseModel):
+    r"""Stock transactions disclosed by members of US Congress for a company, as provided by Finnhub."""
+
+    data: Optional[List[CongressionalTradingResponseData]] = None
+    r"""Congressional transaction disclosures for the symbol."""
+
+    symbol: Optional[str] = None
+    r"""Company ticker symbol."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data", "symbol"])
+        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:
+    CongressionalTradingResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/covid19uscasesresponse.py

@@ -0,0 +1,79 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: ef1e4a2165d7
+
+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 Covid19UsCasesResponseDataTypedDict(TypedDict):
+    case: NotRequired[float]
+    r"""Number of confirmed cases."""
+    death: NotRequired[float]
+    r"""Number of confirmed deaths."""
+    state: NotRequired[str]
+    r"""US state name."""
+    updated: NotRequired[str]
+    r"""Time the record was last updated, as returned by the provider."""
+
+
+class Covid19UsCasesResponseData(BaseModel):
+    case: Optional[float] = None
+    r"""Number of confirmed cases."""
+
+    death: Optional[float] = None
+    r"""Number of confirmed deaths."""
+
+    state: Optional[str] = None
+    r"""US state name."""
+
+    updated: Optional[str] = None
+    r"""Time the record was last updated, as returned by the provider."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["case", "death", "state", "updated"])
+        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 Covid19UsCasesResponseTypedDict(TypedDict):
+    r"""COVID-19 case and death counts for US states, as provided by Finnhub."""
+
+    data: NotRequired[List[Covid19UsCasesResponseDataTypedDict]]
+    r"""COVID-19 statistics, one entry per US state."""
+
+
+class Covid19UsCasesResponse(BaseModel):
+    r"""COVID-19 case and death counts for US states, as provided by Finnhub."""
+
+    data: Optional[List[Covid19UsCasesResponseData]] = None
+    r"""COVID-19 statistics, one entry per US state."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["data"])
+        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/createconfigwatchlistop.py

@@ -0,0 +1,40 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 32006dfe241a
+
+from __future__ import annotations
+from .httpmetadata import HTTPMetadata, HTTPMetadataTypedDict
+from .watchlist import Watchlist, WatchlistTypedDict
+from finance_dev.types import BaseModel, UNSET_SENTINEL
+import pydantic
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CreateConfigWatchlistResponseTypedDict(TypedDict):
+    http_meta: HTTPMetadataTypedDict
+    watchlist: NotRequired[WatchlistTypedDict]
+    r"""Watchlist created. The response contains the saved watchlist; check `invalid_symbols` for any submitted symbols that were dropped."""
+
+
+class CreateConfigWatchlistResponse(BaseModel):
+    http_meta: Annotated[Optional[HTTPMetadata], pydantic.Field(exclude=True)] = None
+
+    watchlist: Optional[Watchlist] = None
+    r"""Watchlist created. The response contains the saved watchlist; check `invalid_symbols` for any submitted symbols that were dropped."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["Watchlist"])
+        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