finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/usaspendingresponse.py

@@ -0,0 +1,222 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: acef56f46f01
+
+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 UsaSpendingResponseDataTypedDict(TypedDict):
+    action_date: NotRequired[str]
+    r"""Date of the award action, as returned by the provider."""
+    award_description: NotRequired[str]
+    r"""Description of the award."""
+    awarding_agency_name: NotRequired[str]
+    r"""Name of the awarding agency."""
+    awarding_office_name: NotRequired[str]
+    r"""Name of the awarding office."""
+    awarding_sub_agency_name: NotRequired[str]
+    r"""Name of the awarding sub-agency."""
+    country: NotRequired[str]
+    r"""Recipient's country."""
+    naics_code: NotRequired[str]
+    r"""North American Industry Classification System (NAICS) code of the award."""
+    performance_city: NotRequired[str]
+    r"""City where the work is performed."""
+    performance_congressional_district: NotRequired[str]
+    r"""Congressional district where the work is performed."""
+    performance_country: NotRequired[str]
+    r"""Country where the work is performed."""
+    performance_county: NotRequired[str]
+    r"""County where the work is performed."""
+    performance_end_date: NotRequired[str]
+    r"""End date of the performance period, as returned by the provider."""
+    performance_start_date: NotRequired[str]
+    r"""Start date of the performance period, as returned by the provider."""
+    performance_state: NotRequired[str]
+    r"""State where the work is performed."""
+    performance_zip_code: NotRequired[str]
+    r"""Zip code where the work is performed."""
+    permalink: NotRequired[str]
+    r"""Permalink to the award record."""
+    recipient_name: NotRequired[str]
+    r"""Name of the award recipient company."""
+    recipient_parent_name: NotRequired[str]
+    r"""Name of the recipient's parent company."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+    total_value: NotRequired[float]
+    r"""Total value of the award."""
+
+
+class UsaSpendingResponseData(BaseModel):
+    action_date: Annotated[Optional[str], pydantic.Field(alias="actionDate")] = None
+    r"""Date of the award action, as returned by the provider."""
+
+    award_description: Annotated[
+        Optional[str], pydantic.Field(alias="awardDescription")
+    ] = None
+    r"""Description of the award."""
+
+    awarding_agency_name: Annotated[
+        Optional[str], pydantic.Field(alias="awardingAgencyName")
+    ] = None
+    r"""Name of the awarding agency."""
+
+    awarding_office_name: Annotated[
+        Optional[str], pydantic.Field(alias="awardingOfficeName")
+    ] = None
+    r"""Name of the awarding office."""
+
+    awarding_sub_agency_name: Annotated[
+        Optional[str], pydantic.Field(alias="awardingSubAgencyName")
+    ] = None
+    r"""Name of the awarding sub-agency."""
+
+    country: Optional[str] = None
+    r"""Recipient's country."""
+
+    naics_code: Annotated[Optional[str], pydantic.Field(alias="naicsCode")] = None
+    r"""North American Industry Classification System (NAICS) code of the award."""
+
+    performance_city: Annotated[
+        Optional[str], pydantic.Field(alias="performanceCity")
+    ] = None
+    r"""City where the work is performed."""
+
+    performance_congressional_district: Annotated[
+        Optional[str], pydantic.Field(alias="performanceCongressionalDistrict")
+    ] = None
+    r"""Congressional district where the work is performed."""
+
+    performance_country: Annotated[
+        Optional[str], pydantic.Field(alias="performanceCountry")
+    ] = None
+    r"""Country where the work is performed."""
+
+    performance_county: Annotated[
+        Optional[str], pydantic.Field(alias="performanceCounty")
+    ] = None
+    r"""County where the work is performed."""
+
+    performance_end_date: Annotated[
+        Optional[str], pydantic.Field(alias="performanceEndDate")
+    ] = None
+    r"""End date of the performance period, as returned by the provider."""
+
+    performance_start_date: Annotated[
+        Optional[str], pydantic.Field(alias="performanceStartDate")
+    ] = None
+    r"""Start date of the performance period, as returned by the provider."""
+
+    performance_state: Annotated[
+        Optional[str], pydantic.Field(alias="performanceState")
+    ] = None
+    r"""State where the work is performed."""
+
+    performance_zip_code: Annotated[
+        Optional[str], pydantic.Field(alias="performanceZipCode")
+    ] = None
+    r"""Zip code where the work is performed."""
+
+    permalink: Optional[str] = None
+    r"""Permalink to the award record."""
+
+    recipient_name: Annotated[Optional[str], pydantic.Field(alias="recipientName")] = (
+        None
+    )
+    r"""Name of the award recipient company."""
+
+    recipient_parent_name: Annotated[
+        Optional[str], pydantic.Field(alias="recipientParentName")
+    ] = None
+    r"""Name of the recipient's parent company."""
+
+    symbol: Optional[str] = None
+    r"""Company ticker symbol."""
+
+    total_value: Annotated[Optional[float], pydantic.Field(alias="totalValue")] = None
+    r"""Total value of the award."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "actionDate",
+                "awardDescription",
+                "awardingAgencyName",
+                "awardingOfficeName",
+                "awardingSubAgencyName",
+                "country",
+                "naicsCode",
+                "performanceCity",
+                "performanceCongressionalDistrict",
+                "performanceCountry",
+                "performanceCounty",
+                "performanceEndDate",
+                "performanceStartDate",
+                "performanceState",
+                "performanceZipCode",
+                "permalink",
+                "recipientName",
+                "recipientParentName",
+                "symbol",
+                "totalValue",
+            ]
+        )
+        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 UsaSpendingResponseTypedDict(TypedDict):
+    r"""US government contract awards to a company, as provided by Finnhub."""
+
+    data: NotRequired[List[UsaSpendingResponseDataTypedDict]]
+    r"""Government spending (award) records for the symbol."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+
+
+class UsaSpendingResponse(BaseModel):
+    r"""US government contract awards to a company, as provided by Finnhub."""
+
+    data: Optional[List[UsaSpendingResponseData]] = None
+    r"""Government spending (award) records 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:
+    UsaSpendingResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/usptopatentsresponse.py

@@ -0,0 +1,134 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: d777f4de7105
+
+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 UsptoPatentsResponseDataTypedDict(TypedDict):
+    application_number: NotRequired[str]
+    r"""Patent application number."""
+    company_filing_name: NotRequired[List[str]]
+    r"""Names of the companies listed on the patent."""
+    description: NotRequired[str]
+    r"""Description of the patent."""
+    filing_date: NotRequired[str]
+    r"""Date the patent was filed, as returned by the provider."""
+    filing_status: NotRequired[str]
+    r"""Filing status of the patent."""
+    patent_number: NotRequired[str]
+    r"""Patent number."""
+    patent_type: NotRequired[str]
+    r"""Type of patent."""
+    publication_date: NotRequired[str]
+    r"""Date the patent was published, as returned by the provider."""
+    url: NotRequired[str]
+    r"""URL of the original patent document."""
+
+
+class UsptoPatentsResponseData(BaseModel):
+    application_number: Annotated[
+        Optional[str], pydantic.Field(alias="applicationNumber")
+    ] = None
+    r"""Patent application number."""
+
+    company_filing_name: Annotated[
+        Optional[List[str]], pydantic.Field(alias="companyFilingName")
+    ] = None
+    r"""Names of the companies listed on the patent."""
+
+    description: Optional[str] = None
+    r"""Description of the patent."""
+
+    filing_date: Annotated[Optional[str], pydantic.Field(alias="filingDate")] = None
+    r"""Date the patent was filed, as returned by the provider."""
+
+    filing_status: Annotated[Optional[str], pydantic.Field(alias="filingStatus")] = None
+    r"""Filing status of the patent."""
+
+    patent_number: Annotated[Optional[str], pydantic.Field(alias="patentNumber")] = None
+    r"""Patent number."""
+
+    patent_type: Annotated[Optional[str], pydantic.Field(alias="patentType")] = None
+    r"""Type of patent."""
+
+    publication_date: Annotated[
+        Optional[str], pydantic.Field(alias="publicationDate")
+    ] = None
+    r"""Date the patent was published, as returned by the provider."""
+
+    url: Optional[str] = None
+    r"""URL of the original patent document."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "applicationNumber",
+                "companyFilingName",
+                "description",
+                "filingDate",
+                "filingStatus",
+                "patentNumber",
+                "patentType",
+                "publicationDate",
+                "url",
+            ]
+        )
+        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 UsptoPatentsResponseTypedDict(TypedDict):
+    r"""USPTO patent filings associated with a company, as provided by Finnhub."""
+
+    data: NotRequired[List[UsptoPatentsResponseDataTypedDict]]
+    r"""Patent records for the symbol."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+
+
+class UsptoPatentsResponse(BaseModel):
+    r"""USPTO patent filings associated with a company, as provided by Finnhub."""
+
+    data: Optional[List[UsptoPatentsResponseData]] = None
+    r"""Patent records 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:
+    UsptoPatentsResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/visaapplicationsresponse.py

@@ -0,0 +1,228 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 6e5956a7ab1c
+
+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 VisaApplicationsResponseDataTypedDict(TypedDict):
+    begin_date: NotRequired[str]
+    r"""Job start date, as returned by the provider."""
+    case_number: NotRequired[str]
+    r"""Case number of the application."""
+    case_status: NotRequired[str]
+    r"""Status of the case."""
+    employer_name: NotRequired[str]
+    r"""Name of the employer."""
+    end_date: NotRequired[str]
+    r"""Job end date, as returned by the provider."""
+    full_time_position: NotRequired[str]
+    r"""Flag indicating whether the position is full-time, as returned by the provider."""
+    h1b_dependent: NotRequired[str]
+    r"""Flag indicating whether the employer is H-1B dependent, as returned by the provider."""
+    job_title: NotRequired[str]
+    r"""Job title of the position."""
+    quarter: NotRequired[int]
+    r"""Quarter of the application."""
+    received_date: NotRequired[str]
+    r"""Date the application was received, as returned by the provider."""
+    soc_code: NotRequired[str]
+    r"""Standard Occupational Classification (SOC) code of the position."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+    visa_class: NotRequired[str]
+    r"""Visa class."""
+    wage_level: NotRequired[str]
+    r"""Wage level of the position."""
+    wage_range_from: NotRequired[float]
+    r"""Lower bound of the offered wage range."""
+    wage_range_to: NotRequired[float]
+    r"""Upper bound of the offered wage range."""
+    wage_unit_of_pay: NotRequired[str]
+    r"""Unit of pay that the wage range is expressed in."""
+    worksite_address: NotRequired[str]
+    r"""Worksite street address."""
+    worksite_city: NotRequired[str]
+    r"""Worksite city."""
+    worksite_county: NotRequired[str]
+    r"""Worksite county."""
+    worksite_postal_code: NotRequired[str]
+    r"""Worksite postal code."""
+    worksite_state: NotRequired[str]
+    r"""Worksite state."""
+    year: NotRequired[int]
+    r"""Year of the application."""
+
+
+class VisaApplicationsResponseData(BaseModel):
+    begin_date: Annotated[Optional[str], pydantic.Field(alias="beginDate")] = None
+    r"""Job start date, as returned by the provider."""
+
+    case_number: Annotated[Optional[str], pydantic.Field(alias="caseNumber")] = None
+    r"""Case number of the application."""
+
+    case_status: Annotated[Optional[str], pydantic.Field(alias="caseStatus")] = None
+    r"""Status of the case."""
+
+    employer_name: Annotated[Optional[str], pydantic.Field(alias="employerName")] = None
+    r"""Name of the employer."""
+
+    end_date: Annotated[Optional[str], pydantic.Field(alias="endDate")] = None
+    r"""Job end date, as returned by the provider."""
+
+    full_time_position: Annotated[
+        Optional[str], pydantic.Field(alias="fullTimePosition")
+    ] = None
+    r"""Flag indicating whether the position is full-time, as returned by the provider."""
+
+    h1b_dependent: Annotated[Optional[str], pydantic.Field(alias="h1bDependent")] = None
+    r"""Flag indicating whether the employer is H-1B dependent, as returned by the provider."""
+
+    job_title: Annotated[Optional[str], pydantic.Field(alias="jobTitle")] = None
+    r"""Job title of the position."""
+
+    quarter: Optional[int] = None
+    r"""Quarter of the application."""
+
+    received_date: Annotated[Optional[str], pydantic.Field(alias="receivedDate")] = None
+    r"""Date the application was received, as returned by the provider."""
+
+    soc_code: Annotated[Optional[str], pydantic.Field(alias="socCode")] = None
+    r"""Standard Occupational Classification (SOC) code of the position."""
+
+    symbol: Optional[str] = None
+    r"""Company ticker symbol."""
+
+    visa_class: Annotated[Optional[str], pydantic.Field(alias="visaClass")] = None
+    r"""Visa class."""
+
+    wage_level: Annotated[Optional[str], pydantic.Field(alias="wageLevel")] = None
+    r"""Wage level of the position."""
+
+    wage_range_from: Annotated[
+        Optional[float], pydantic.Field(alias="wageRangeFrom")
+    ] = None
+    r"""Lower bound of the offered wage range."""
+
+    wage_range_to: Annotated[Optional[float], pydantic.Field(alias="wageRangeTo")] = (
+        None
+    )
+    r"""Upper bound of the offered wage range."""
+
+    wage_unit_of_pay: Annotated[
+        Optional[str], pydantic.Field(alias="wageUnitOfPay")
+    ] = None
+    r"""Unit of pay that the wage range is expressed in."""
+
+    worksite_address: Annotated[
+        Optional[str], pydantic.Field(alias="worksiteAddress")
+    ] = None
+    r"""Worksite street address."""
+
+    worksite_city: Annotated[Optional[str], pydantic.Field(alias="worksiteCity")] = None
+    r"""Worksite city."""
+
+    worksite_county: Annotated[
+        Optional[str], pydantic.Field(alias="worksiteCounty")
+    ] = None
+    r"""Worksite county."""
+
+    worksite_postal_code: Annotated[
+        Optional[str], pydantic.Field(alias="worksitePostalCode")
+    ] = None
+    r"""Worksite postal code."""
+
+    worksite_state: Annotated[Optional[str], pydantic.Field(alias="worksiteState")] = (
+        None
+    )
+    r"""Worksite state."""
+
+    year: Optional[int] = None
+    r"""Year of the application."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "beginDate",
+                "caseNumber",
+                "caseStatus",
+                "employerName",
+                "endDate",
+                "fullTimePosition",
+                "h1bDependent",
+                "jobTitle",
+                "quarter",
+                "receivedDate",
+                "socCode",
+                "symbol",
+                "visaClass",
+                "wageLevel",
+                "wageRangeFrom",
+                "wageRangeTo",
+                "wageUnitOfPay",
+                "worksiteAddress",
+                "worksiteCity",
+                "worksiteCounty",
+                "worksitePostalCode",
+                "worksiteState",
+                "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 VisaApplicationsResponseTypedDict(TypedDict):
+    r"""H-1B and permanent visa applications filed by a company, as provided by Finnhub."""
+
+    data: NotRequired[List[VisaApplicationsResponseDataTypedDict]]
+    r"""Visa application records for the symbol."""
+    symbol: NotRequired[str]
+    r"""Company ticker symbol."""
+
+
+class VisaApplicationsResponse(BaseModel):
+    r"""H-1B and permanent visa applications filed by a company, as provided by Finnhub."""
+
+    data: Optional[List[VisaApplicationsResponseData]] = None
+    r"""Visa application records 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:
+    VisaApplicationsResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/watchlist.py

@@ -0,0 +1,68 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 8e3de726d672
+
+from __future__ import annotations
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import NotRequired, TypedDict
+
+
+class WatchlistTypedDict(TypedDict):
+    r"""Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders."""
+
+    id: NotRequired[int]
+    r"""Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist."""
+    invalid_symbols: NotRequired[List[str]]
+    r"""Symbols from the request that could not be resolved and were dropped from `symbols`. Only present on create and update responses when at least one submitted symbol failed resolution."""
+    name: NotRequired[str]
+    r"""User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app."""
+    symbols: NotRequired[Nullable[List[str]]]
+    r"""Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search. May be `null` for a watchlist saved through Replace All Watchlists without `symbols`."""
+
+
+class Watchlist(BaseModel):
+    r"""Saved list of symbols a user wants to monitor. Watchlists are read-only from a trading-risk perspective and do not place orders."""
+
+    id: Optional[int] = None
+    r"""Watchlist identifier. Use this value when reading, updating, or deleting a specific watchlist."""
+
+    invalid_symbols: Optional[List[str]] = None
+    r"""Symbols from the request that could not be resolved and were dropped from `symbols`. Only present on create and update responses when at least one submitted symbol failed resolution."""
+
+    name: Optional[str] = None
+    r"""User-facing watchlist name, such as Tech Stocks or Dividend Ideas. Show this as the list label in your app."""
+
+    symbols: OptionalNullable[List[str]] = UNSET
+    r"""Symbols saved in the watchlist. Use exact uppercase ticker symbols and confirm unfamiliar symbols with symbol search. May be `null` for a watchlist saved through Replace All Watchlists without `symbols`."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["id", "invalid_symbols", "name", "symbols"])
+        nullable_fields = set(["symbols"])
+        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))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m