finance_dev 0.9.0__py3-none-any.whl

finance_dev/models/historicalesgresponse.py

@@ -0,0 +1,439 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: 6ef6399051c7
+
+from __future__ import annotations
+from finance_dev.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+import pydantic
+from pydantic import model_serializer
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class HistoricalEsgResponseDataDataTypedDict(TypedDict):
+    r"""Detailed ESG disclosures and metrics for the period."""
+
+    adult_content: NotRequired[bool]
+    r"""Whether the company has involvement in adult content."""
+    alcoholic: NotRequired[bool]
+    r"""Whether the company has involvement in alcoholic beverages."""
+    animal_testing: NotRequired[bool]
+    r"""Whether the company is involved in animal testing."""
+    antitrust: NotRequired[str]
+    r"""Antitrust-related disclosure for the company, as free text."""
+    asian_employee_percentage: NotRequired[float]
+    r"""Percentage of the company workforce that is Asian."""
+    asian_management_percentage: NotRequired[float]
+    r"""Percentage of company management that is Asian."""
+    black_employee_percentage: NotRequired[float]
+    r"""Percentage of the company workforce that is Black."""
+    black_management_percentage: NotRequired[float]
+    r"""Percentage of company management that is Black."""
+    carbon_reduction_policy: NotRequired[str]
+    r"""Description of the company carbon reduction policy."""
+    catholic: NotRequired[bool]
+    r"""Whether the company is flagged as conflicting with Catholic values screens."""
+    co2_emission_scope1: NotRequired[int]
+    r"""Reported direct (Scope 1) CO2 emissions."""
+    co2_emission_scope2: NotRequired[int]
+    r"""Reported indirect (Scope 2) CO2 emissions from purchased energy."""
+    co2_emission_scope3: NotRequired[int]
+    r"""Reported other indirect (Scope 3) CO2 emissions."""
+    co2_emission_total: NotRequired[int]
+    r"""Reported total CO2 emissions."""
+    coal_energy: NotRequired[bool]
+    r"""Whether the company has involvement in coal energy."""
+    ecofriendly_packaging: NotRequired[bool]
+    r"""Whether the company uses eco-friendly packaging."""
+    environmental_reporting: NotRequired[bool]
+    r"""Whether the company publishes environmental reporting."""
+    firearms: NotRequired[bool]
+    r"""Whether the company has involvement in firearms."""
+    fuel_efficiency_consumption: NotRequired[bool]
+    r"""Whether the company reports fuel efficiency or consumption measures."""
+    gambling: NotRequired[bool]
+    r"""Whether the company has involvement in gambling."""
+    gmo: NotRequired[bool]
+    r"""Whether the company has involvement in genetically modified organisms."""
+    hazardous_substances: NotRequired[bool]
+    r"""Whether the company handles hazardous substances."""
+    hispanic_latino_employee_percentage: NotRequired[float]
+    r"""Percentage of the company workforce that is Hispanic or Latino."""
+    hispanic_latino_management_percentage: NotRequired[float]
+    r"""Percentage of company management that is Hispanic or Latino."""
+    human_rights_policy: NotRequired[bool]
+    r"""Whether the company has a human rights policy."""
+    military_contract: NotRequired[bool]
+    r"""Whether the company holds military contracts."""
+    nuclear: NotRequired[bool]
+    r"""Whether the company has involvement in nuclear energy."""
+    pesticides: NotRequired[Nullable[str]]
+    r"""Pesticide-related disclosure for the company, or null when not available."""
+    recall_policy_safety: NotRequired[bool]
+    r"""Whether the company has a product recall and safety policy."""
+    recycling_policy: NotRequired[bool]
+    r"""Whether the company has a recycling policy."""
+    stakeholder_engagement: NotRequired[bool]
+    r"""Whether the company reports stakeholder engagement."""
+    tobacco: NotRequired[bool]
+    r"""Whether the company has involvement in tobacco."""
+    total_women_percentage: NotRequired[int]
+    r"""Percentage of the company workforce that is women."""
+    water_efficiency_consumption: NotRequired[bool]
+    r"""Whether the company reports water efficiency or consumption measures."""
+    white_employee_percentage: NotRequired[float]
+    r"""Percentage of the company workforce that is White."""
+    white_management_percentage: NotRequired[float]
+    r"""Percentage of company management that is White."""
+    workplace_health_safety: NotRequired[bool]
+    r"""Whether the company has a workplace health and safety policy."""
+
+
+class HistoricalEsgResponseDataData(BaseModel):
+    r"""Detailed ESG disclosures and metrics for the period."""
+
+    adult_content: Annotated[Optional[bool], pydantic.Field(alias="adultContent")] = (
+        None
+    )
+    r"""Whether the company has involvement in adult content."""
+
+    alcoholic: Optional[bool] = None
+    r"""Whether the company has involvement in alcoholic beverages."""
+
+    animal_testing: Annotated[Optional[bool], pydantic.Field(alias="animalTesting")] = (
+        None
+    )
+    r"""Whether the company is involved in animal testing."""
+
+    antitrust: Optional[str] = None
+    r"""Antitrust-related disclosure for the company, as free text."""
+
+    asian_employee_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="asianEmployeePercentage")
+    ] = None
+    r"""Percentage of the company workforce that is Asian."""
+
+    asian_management_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="asianManagementPercentage")
+    ] = None
+    r"""Percentage of company management that is Asian."""
+
+    black_employee_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="blackEmployeePercentage")
+    ] = None
+    r"""Percentage of the company workforce that is Black."""
+
+    black_management_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="blackManagementPercentage")
+    ] = None
+    r"""Percentage of company management that is Black."""
+
+    carbon_reduction_policy: Annotated[
+        Optional[str], pydantic.Field(alias="carbonReductionPolicy")
+    ] = None
+    r"""Description of the company carbon reduction policy."""
+
+    catholic: Optional[bool] = None
+    r"""Whether the company is flagged as conflicting with Catholic values screens."""
+
+    co2_emission_scope1: Annotated[
+        Optional[int], pydantic.Field(alias="co2EmissionScope1")
+    ] = None
+    r"""Reported direct (Scope 1) CO2 emissions."""
+
+    co2_emission_scope2: Annotated[
+        Optional[int], pydantic.Field(alias="co2EmissionScope2")
+    ] = None
+    r"""Reported indirect (Scope 2) CO2 emissions from purchased energy."""
+
+    co2_emission_scope3: Annotated[
+        Optional[int], pydantic.Field(alias="co2EmissionScope3")
+    ] = None
+    r"""Reported other indirect (Scope 3) CO2 emissions."""
+
+    co2_emission_total: Annotated[
+        Optional[int], pydantic.Field(alias="co2EmissionTotal")
+    ] = None
+    r"""Reported total CO2 emissions."""
+
+    coal_energy: Annotated[Optional[bool], pydantic.Field(alias="coalEnergy")] = None
+    r"""Whether the company has involvement in coal energy."""
+
+    ecofriendly_packaging: Annotated[
+        Optional[bool], pydantic.Field(alias="ecofriendlyPackaging")
+    ] = None
+    r"""Whether the company uses eco-friendly packaging."""
+
+    environmental_reporting: Annotated[
+        Optional[bool], pydantic.Field(alias="environmentalReporting")
+    ] = None
+    r"""Whether the company publishes environmental reporting."""
+
+    firearms: Optional[bool] = None
+    r"""Whether the company has involvement in firearms."""
+
+    fuel_efficiency_consumption: Annotated[
+        Optional[bool], pydantic.Field(alias="fuelEfficiencyConsumption")
+    ] = None
+    r"""Whether the company reports fuel efficiency or consumption measures."""
+
+    gambling: Optional[bool] = None
+    r"""Whether the company has involvement in gambling."""
+
+    gmo: Optional[bool] = None
+    r"""Whether the company has involvement in genetically modified organisms."""
+
+    hazardous_substances: Annotated[
+        Optional[bool], pydantic.Field(alias="hazardousSubstances")
+    ] = None
+    r"""Whether the company handles hazardous substances."""
+
+    hispanic_latino_employee_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="hispanicLatinoEmployeePercentage")
+    ] = None
+    r"""Percentage of the company workforce that is Hispanic or Latino."""
+
+    hispanic_latino_management_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="hispanicLatinoManagementPercentage")
+    ] = None
+    r"""Percentage of company management that is Hispanic or Latino."""
+
+    human_rights_policy: Annotated[
+        Optional[bool], pydantic.Field(alias="humanRightsPolicy")
+    ] = None
+    r"""Whether the company has a human rights policy."""
+
+    military_contract: Annotated[
+        Optional[bool], pydantic.Field(alias="militaryContract")
+    ] = None
+    r"""Whether the company holds military contracts."""
+
+    nuclear: Optional[bool] = None
+    r"""Whether the company has involvement in nuclear energy."""
+
+    pesticides: OptionalNullable[str] = UNSET
+    r"""Pesticide-related disclosure for the company, or null when not available."""
+
+    recall_policy_safety: Annotated[
+        Optional[bool], pydantic.Field(alias="recallPolicySafety")
+    ] = None
+    r"""Whether the company has a product recall and safety policy."""
+
+    recycling_policy: Annotated[
+        Optional[bool], pydantic.Field(alias="recyclingPolicy")
+    ] = None
+    r"""Whether the company has a recycling policy."""
+
+    stakeholder_engagement: Annotated[
+        Optional[bool], pydantic.Field(alias="stakeholderEngagement")
+    ] = None
+    r"""Whether the company reports stakeholder engagement."""
+
+    tobacco: Optional[bool] = None
+    r"""Whether the company has involvement in tobacco."""
+
+    total_women_percentage: Annotated[
+        Optional[int], pydantic.Field(alias="totalWomenPercentage")
+    ] = None
+    r"""Percentage of the company workforce that is women."""
+
+    water_efficiency_consumption: Annotated[
+        Optional[bool], pydantic.Field(alias="waterEfficiencyConsumption")
+    ] = None
+    r"""Whether the company reports water efficiency or consumption measures."""
+
+    white_employee_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="whiteEmployeePercentage")
+    ] = None
+    r"""Percentage of the company workforce that is White."""
+
+    white_management_percentage: Annotated[
+        Optional[float], pydantic.Field(alias="whiteManagementPercentage")
+    ] = None
+    r"""Percentage of company management that is White."""
+
+    workplace_health_safety: Annotated[
+        Optional[bool], pydantic.Field(alias="workplaceHealthSafety")
+    ] = None
+    r"""Whether the company has a workplace health and safety policy."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "adultContent",
+                "alcoholic",
+                "animalTesting",
+                "antitrust",
+                "asianEmployeePercentage",
+                "asianManagementPercentage",
+                "blackEmployeePercentage",
+                "blackManagementPercentage",
+                "carbonReductionPolicy",
+                "catholic",
+                "co2EmissionScope1",
+                "co2EmissionScope2",
+                "co2EmissionScope3",
+                "co2EmissionTotal",
+                "coalEnergy",
+                "ecofriendlyPackaging",
+                "environmentalReporting",
+                "firearms",
+                "fuelEfficiencyConsumption",
+                "gambling",
+                "gmo",
+                "hazardousSubstances",
+                "hispanicLatinoEmployeePercentage",
+                "hispanicLatinoManagementPercentage",
+                "humanRightsPolicy",
+                "militaryContract",
+                "nuclear",
+                "pesticides",
+                "recallPolicySafety",
+                "recyclingPolicy",
+                "stakeholderEngagement",
+                "tobacco",
+                "totalWomenPercentage",
+                "waterEfficiencyConsumption",
+                "whiteEmployeePercentage",
+                "whiteManagementPercentage",
+                "workplaceHealthSafety",
+            ]
+        )
+        nullable_fields = set(["pesticides"])
+        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
+
+
+class HistoricalEsgResponseDataTypedDict(TypedDict):
+    data: NotRequired[HistoricalEsgResponseDataDataTypedDict]
+    r"""Detailed ESG disclosures and metrics for the period."""
+    environment_score: NotRequired[float]
+    r"""Environmental score for the period."""
+    governance_score: NotRequired[float]
+    r"""Governance score for the period."""
+    period: NotRequired[str]
+    r"""Reporting period of the record."""
+    social_score: NotRequired[float]
+    r"""Social score for the period."""
+    total_esg_score: NotRequired[float]
+    r"""Total ESG score for the period."""
+
+
+class HistoricalEsgResponseData(BaseModel):
+    data: Optional[HistoricalEsgResponseDataData] = None
+    r"""Detailed ESG disclosures and metrics for the period."""
+
+    environment_score: Annotated[
+        Optional[float], pydantic.Field(alias="environmentScore")
+    ] = None
+    r"""Environmental score for the period."""
+
+    governance_score: Annotated[
+        Optional[float], pydantic.Field(alias="governanceScore")
+    ] = None
+    r"""Governance score for the period."""
+
+    period: Optional[str] = None
+    r"""Reporting period of the record."""
+
+    social_score: Annotated[Optional[float], pydantic.Field(alias="socialScore")] = None
+    r"""Social score for the period."""
+
+    total_esg_score: Annotated[
+        Optional[float], pydantic.Field(alias="totalESGScore")
+    ] = None
+    r"""Total ESG score for the period."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(
+            [
+                "data",
+                "environmentScore",
+                "governanceScore",
+                "period",
+                "socialScore",
+                "totalESGScore",
+            ]
+        )
+        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 HistoricalEsgResponseTypedDict(TypedDict):
+    r"""Historical ESG (environmental, social, governance) scores and disclosures for a company by period."""
+
+    data: NotRequired[List[HistoricalEsgResponseDataTypedDict]]
+    r"""ESG records by period."""
+    symbol: NotRequired[str]
+    r"""Ticker symbol of the company."""
+
+
+class HistoricalEsgResponse(BaseModel):
+    r"""Historical ESG (environmental, social, governance) scores and disclosures for a company by period."""
+
+    data: Optional[List[HistoricalEsgResponseData]] = None
+    r"""ESG records by period."""
+
+    symbol: Optional[str] = None
+    r"""Ticker symbol of the company."""
+
+    @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:
+    HistoricalEsgResponseDataData.model_rebuild()
+except NameError:
+    pass
+try:
+    HistoricalEsgResponseData.model_rebuild()
+except NameError:
+    pass

finance_dev/models/httpmetadata.py

@@ -0,0 +1,24 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+# @generated-id: fa8258d23c74
+
+from __future__ import annotations
+from finance_dev.types import BaseModel
+import httpx
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, TypedDict
+
+
+class HTTPMetadataTypedDict(TypedDict):
+    response: httpx.Response
+    r"""Raw HTTP response; suitable for custom response parsing"""
+    request: httpx.Request
+    r"""Raw HTTP request; suitable for debugging"""
+
+
+class HTTPMetadata(BaseModel):
+    response: Annotated[Optional[httpx.Response], pydantic.Field(exclude=True)] = None
+    r"""Raw HTTP response; suitable for custom response parsing"""
+
+    request: Annotated[Optional[httpx.Request], pydantic.Field(exclude=True)] = None
+    r"""Raw HTTP request; suitable for debugging"""