policyengine-api-simulation-client 0.20251216.73__py3-none-any.whl

policyengine_api_simulation_client/client.py

@@ -0,0 +1,268 @@
+import ssl
+from typing import Any
+
+import httpx
+from attrs import define, evolve, field
+
+
+@define
+class Client:
+    """A class for keeping track of data related to the API
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    def with_headers(self, headers: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "Client":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "Client":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "Client":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "Client":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "Client":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)
+
+
+@define
+class AuthenticatedClient:
+    """A Client which has been authenticated for use on secured endpoints
+
+    The following are accepted as keyword arguments and will be used to construct httpx Clients internally:
+
+        ``base_url``: The base URL for the API, all requests are made to a relative path to this URL
+
+        ``cookies``: A dictionary of cookies to be sent with every request
+
+        ``headers``: A dictionary of headers to be sent with every request
+
+        ``timeout``: The maximum amount of a time a request can take. API functions will raise
+        httpx.TimeoutException if this is exceeded.
+
+        ``verify_ssl``: Whether or not to verify the SSL certificate of the API server. This should be True in production,
+        but can be set to False for testing purposes.
+
+        ``follow_redirects``: Whether or not to follow redirects. Default value is False.
+
+        ``httpx_args``: A dictionary of additional arguments to be passed to the ``httpx.Client`` and ``httpx.AsyncClient`` constructor.
+
+
+    Attributes:
+        raise_on_unexpected_status: Whether or not to raise an errors.UnexpectedStatus if the API returns a
+            status code that was not documented in the source OpenAPI document. Can also be provided as a keyword
+            argument to the constructor.
+        token: The token to use for authentication
+        prefix: The prefix to use for the Authorization header
+        auth_header_name: The name of the Authorization header
+    """
+
+    raise_on_unexpected_status: bool = field(default=False, kw_only=True)
+    _base_url: str = field(alias="base_url")
+    _cookies: dict[str, str] = field(factory=dict, kw_only=True, alias="cookies")
+    _headers: dict[str, str] = field(factory=dict, kw_only=True, alias="headers")
+    _timeout: httpx.Timeout | None = field(default=None, kw_only=True, alias="timeout")
+    _verify_ssl: str | bool | ssl.SSLContext = field(default=True, kw_only=True, alias="verify_ssl")
+    _follow_redirects: bool = field(default=False, kw_only=True, alias="follow_redirects")
+    _httpx_args: dict[str, Any] = field(factory=dict, kw_only=True, alias="httpx_args")
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
+
+    token: str
+    prefix: str = "Bearer"
+    auth_header_name: str = "Authorization"
+
+    def with_headers(self, headers: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional headers"""
+        if self._client is not None:
+            self._client.headers.update(headers)
+        if self._async_client is not None:
+            self._async_client.headers.update(headers)
+        return evolve(self, headers={**self._headers, **headers})
+
+    def with_cookies(self, cookies: dict[str, str]) -> "AuthenticatedClient":
+        """Get a new client matching this one with additional cookies"""
+        if self._client is not None:
+            self._client.cookies.update(cookies)
+        if self._async_client is not None:
+            self._async_client.cookies.update(cookies)
+        return evolve(self, cookies={**self._cookies, **cookies})
+
+    def with_timeout(self, timeout: httpx.Timeout) -> "AuthenticatedClient":
+        """Get a new client matching this one with a new timeout configuration"""
+        if self._client is not None:
+            self._client.timeout = timeout
+        if self._async_client is not None:
+            self._async_client.timeout = timeout
+        return evolve(self, timeout=timeout)
+
+    def set_httpx_client(self, client: httpx.Client) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.Client
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._client = client
+        return self
+
+    def get_httpx_client(self) -> httpx.Client:
+        """Get the underlying httpx.Client, constructing a new one if not previously set"""
+        if self._client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._client = httpx.Client(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._client
+
+    def __enter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for self.client—you cannot enter twice (see httpx docs)"""
+        self.get_httpx_client().__enter__()
+        return self
+
+    def __exit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for internal httpx.Client (see httpx docs)"""
+        self.get_httpx_client().__exit__(*args, **kwargs)
+
+    def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "AuthenticatedClient":
+        """Manually set the underlying httpx.AsyncClient
+
+        **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
+        """
+        self._async_client = async_client
+        return self
+
+    def get_async_httpx_client(self) -> httpx.AsyncClient:
+        """Get the underlying httpx.AsyncClient, constructing a new one if not previously set"""
+        if self._async_client is None:
+            self._headers[self.auth_header_name] = f"{self.prefix} {self.token}" if self.prefix else self.token
+            self._async_client = httpx.AsyncClient(
+                base_url=self._base_url,
+                cookies=self._cookies,
+                headers=self._headers,
+                timeout=self._timeout,
+                verify=self._verify_ssl,
+                follow_redirects=self._follow_redirects,
+                **self._httpx_args,
+            )
+        return self._async_client
+
+    async def __aenter__(self) -> "AuthenticatedClient":
+        """Enter a context manager for underlying httpx.AsyncClient—you cannot enter twice (see httpx docs)"""
+        await self.get_async_httpx_client().__aenter__()
+        return self
+
+    async def __aexit__(self, *args: Any, **kwargs: Any) -> None:
+        """Exit a context manager for underlying httpx.AsyncClient (see httpx docs)"""
+        await self.get_async_httpx_client().__aexit__(*args, **kwargs)

policyengine_api_simulation_client/errors.py

@@ -0,0 +1,16 @@
+"""Contains shared errors types that can be raised from API functions"""
+
+
+class UnexpectedStatus(Exception):
+    """Raised by api functions when the response status an undocumented status and Client.raise_on_unexpected_status is True"""
+
+    def __init__(self, status_code: int, content: bytes):
+        self.status_code = status_code
+        self.content = content
+
+        super().__init__(
+            f"Unexpected status code: {status_code}\n\nResponse content:\n{content.decode(errors='ignore')}"
+        )
+
+
+__all__ = ["UnexpectedStatus"]

policyengine_api_simulation_client/models/__init__.py

@@ -0,0 +1,117 @@
+"""Contains all the data models used in inputs/outputs"""
+
+from .age_group_baseline_reform_values import AgeGroupBaselineReformValues
+from .baseline_reform_values import BaselineReformValues
+from .budgetary_impact import BudgetaryImpact
+from .cliff_impact import CliffImpact
+from .cliff_impact_in_simulation import CliffImpactInSimulation
+from .decile_impact import DecileImpact
+from .decile_impact_average import DecileImpactAverage
+from .decile_impact_relative import DecileImpactRelative
+from .economy_comparison import EconomyComparison
+from .economy_comparison_detailed_budget_type_0 import EconomyComparisonDetailedBudgetType0
+from .gender_baseline_reform_values import GenderBaselineReformValues
+from .health_status import HealthStatus
+from .hours_response import HoursResponse
+from .http_validation_error import HTTPValidationError
+from .inequality_impact import InequalityImpact
+from .intra_decile_impact import IntraDecileImpact
+from .intra_decile_impact_all import IntraDecileImpactAll
+from .intra_decile_impact_deciles import IntraDecileImpactDeciles
+from .intra_wealth_decile_impact_with_values import IntraWealthDecileImpactWithValues
+from .intra_wealth_decile_impact_with_values_all import IntraWealthDecileImpactWithValuesAll
+from .intra_wealth_decile_impact_with_values_deciles import IntraWealthDecileImpactWithValuesDeciles
+from .labor_supply_response import LaborSupplyResponse
+from .labor_supply_response_decile import LaborSupplyResponseDecile
+from .labor_supply_response_decile_additional_property import LaborSupplyResponseDecileAdditionalProperty
+from .labor_supply_response_decile_additional_property_additional_property import (
+    LaborSupplyResponseDecileAdditionalPropertyAdditionalProperty,
+)
+from .labor_supply_response_relative_lsr import LaborSupplyResponseRelativeLsr
+from .parameter_change_dict import ParameterChangeDict
+from .parametric_reform import ParametricReform
+from .ping_request import PingRequest
+from .ping_response import PingResponse
+from .poverty_gender_breakdown import PovertyGenderBreakdown
+from .poverty_impact import PovertyImpact
+from .poverty_racial_breakdown_with_values import PovertyRacialBreakdownWithValues
+from .probe_status import ProbeStatus
+from .program_specific_impact import ProgramSpecificImpact
+from .racial_baseline_reform_values import RacialBaselineReformValues
+from .simulation_options import SimulationOptions
+from .simulation_options_country import SimulationOptionsCountry
+from .simulation_options_data_type_1 import SimulationOptionsDataType1
+from .simulation_options_scope import SimulationOptionsScope
+from .system_status import SystemStatus
+from .uk_constituency_breakdown_by_constituency import UKConstituencyBreakdownByConstituency
+from .uk_constituency_breakdown_with_values import UKConstituencyBreakdownWithValues
+from .uk_constituency_breakdown_with_values_by_constituency import UKConstituencyBreakdownWithValuesByConstituency
+from .uk_constituency_breakdown_with_values_outcomes_by_region import UKConstituencyBreakdownWithValuesOutcomesByRegion
+from .uk_constituency_breakdown_with_values_outcomes_by_region_additional_property import (
+    UKConstituencyBreakdownWithValuesOutcomesByRegionAdditionalProperty,
+)
+from .uk_local_authority_breakdown_by_local_authority import UKLocalAuthorityBreakdownByLocalAuthority
+from .uk_local_authority_breakdown_with_values import UKLocalAuthorityBreakdownWithValues
+from .uk_local_authority_breakdown_with_values_by_local_authority import (
+    UKLocalAuthorityBreakdownWithValuesByLocalAuthority,
+)
+from .validation_error import ValidationError
+from .wealth_decile_impact_with_values import WealthDecileImpactWithValues
+from .wealth_decile_impact_with_values_average import WealthDecileImpactWithValuesAverage
+from .wealth_decile_impact_with_values_relative import WealthDecileImpactWithValuesRelative
+
+__all__ = (
+    "AgeGroupBaselineReformValues",
+    "BaselineReformValues",
+    "BudgetaryImpact",
+    "CliffImpact",
+    "CliffImpactInSimulation",
+    "DecileImpact",
+    "DecileImpactAverage",
+    "DecileImpactRelative",
+    "EconomyComparison",
+    "EconomyComparisonDetailedBudgetType0",
+    "GenderBaselineReformValues",
+    "HealthStatus",
+    "HoursResponse",
+    "HTTPValidationError",
+    "InequalityImpact",
+    "IntraDecileImpact",
+    "IntraDecileImpactAll",
+    "IntraDecileImpactDeciles",
+    "IntraWealthDecileImpactWithValues",
+    "IntraWealthDecileImpactWithValuesAll",
+    "IntraWealthDecileImpactWithValuesDeciles",
+    "LaborSupplyResponse",
+    "LaborSupplyResponseDecile",
+    "LaborSupplyResponseDecileAdditionalProperty",
+    "LaborSupplyResponseDecileAdditionalPropertyAdditionalProperty",
+    "LaborSupplyResponseRelativeLsr",
+    "ParameterChangeDict",
+    "ParametricReform",
+    "PingRequest",
+    "PingResponse",
+    "PovertyGenderBreakdown",
+    "PovertyImpact",
+    "PovertyRacialBreakdownWithValues",
+    "ProbeStatus",
+    "ProgramSpecificImpact",
+    "RacialBaselineReformValues",
+    "SimulationOptions",
+    "SimulationOptionsCountry",
+    "SimulationOptionsDataType1",
+    "SimulationOptionsScope",
+    "SystemStatus",
+    "UKConstituencyBreakdownByConstituency",
+    "UKConstituencyBreakdownWithValues",
+    "UKConstituencyBreakdownWithValuesByConstituency",
+    "UKConstituencyBreakdownWithValuesOutcomesByRegion",
+    "UKConstituencyBreakdownWithValuesOutcomesByRegionAdditionalProperty",
+    "UKLocalAuthorityBreakdownByLocalAuthority",
+    "UKLocalAuthorityBreakdownWithValues",
+    "UKLocalAuthorityBreakdownWithValuesByLocalAuthority",
+    "ValidationError",
+    "WealthDecileImpactWithValues",
+    "WealthDecileImpactWithValuesAverage",
+    "WealthDecileImpactWithValuesRelative",
+)

policyengine_api_simulation_client/models/age_group_baseline_reform_values.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+if TYPE_CHECKING:
+    from ..models.baseline_reform_values import BaselineReformValues
+
+
+T = TypeVar("T", bound="AgeGroupBaselineReformValues")
+
+
+@_attrs_define
+class AgeGroupBaselineReformValues:
+    """
+    Attributes:
+        child (BaselineReformValues):
+        adult (BaselineReformValues):
+        senior (BaselineReformValues):
+        all_ (BaselineReformValues):
+    """
+
+    child: BaselineReformValues
+    adult: BaselineReformValues
+    senior: BaselineReformValues
+    all_: BaselineReformValues
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        child = self.child.to_dict()
+
+        adult = self.adult.to_dict()
+
+        senior = self.senior.to_dict()
+
+        all_ = self.all_.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "child": child,
+                "adult": adult,
+                "senior": senior,
+                "all": all_,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.baseline_reform_values import BaselineReformValues
+
+        d = dict(src_dict)
+        child = BaselineReformValues.from_dict(d.pop("child"))
+
+        adult = BaselineReformValues.from_dict(d.pop("adult"))
+
+        senior = BaselineReformValues.from_dict(d.pop("senior"))
+
+        all_ = BaselineReformValues.from_dict(d.pop("all"))
+
+        age_group_baseline_reform_values = cls(
+            child=child,
+            adult=adult,
+            senior=senior,
+            all_=all_,
+        )
+
+        age_group_baseline_reform_values.additional_properties = d
+        return age_group_baseline_reform_values
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

policyengine_api_simulation_client/models/baseline_reform_values.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="BaselineReformValues")
+
+
+@_attrs_define
+class BaselineReformValues:
+    """
+    Attributes:
+        baseline (float):
+        reform (float):
+    """
+
+    baseline: float
+    reform: float
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        baseline = self.baseline
+
+        reform = self.reform
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "baseline": baseline,
+                "reform": reform,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        baseline = d.pop("baseline")
+
+        reform = d.pop("reform")
+
+        baseline_reform_values = cls(
+            baseline=baseline,
+            reform=reform,
+        )
+
+        baseline_reform_values.additional_properties = d
+        return baseline_reform_values
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

policyengine_api_simulation_client/models/budgetary_impact.py

@@ -0,0 +1,101 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="BudgetaryImpact")
+
+
+@_attrs_define
+class BudgetaryImpact:
+    """
+    Attributes:
+        budgetary_impact (float):
+        tax_revenue_impact (float):
+        state_tax_revenue_impact (float):
+        benefit_spending_impact (float):
+        households (float):
+        baseline_net_income (float):
+    """
+
+    budgetary_impact: float
+    tax_revenue_impact: float
+    state_tax_revenue_impact: float
+    benefit_spending_impact: float
+    households: float
+    baseline_net_income: float
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        budgetary_impact = self.budgetary_impact
+
+        tax_revenue_impact = self.tax_revenue_impact
+
+        state_tax_revenue_impact = self.state_tax_revenue_impact
+
+        benefit_spending_impact = self.benefit_spending_impact
+
+        households = self.households
+
+        baseline_net_income = self.baseline_net_income
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "budgetary_impact": budgetary_impact,
+                "tax_revenue_impact": tax_revenue_impact,
+                "state_tax_revenue_impact": state_tax_revenue_impact,
+                "benefit_spending_impact": benefit_spending_impact,
+                "households": households,
+                "baseline_net_income": baseline_net_income,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        budgetary_impact = d.pop("budgetary_impact")
+
+        tax_revenue_impact = d.pop("tax_revenue_impact")
+
+        state_tax_revenue_impact = d.pop("state_tax_revenue_impact")
+
+        benefit_spending_impact = d.pop("benefit_spending_impact")
+
+        households = d.pop("households")
+
+        baseline_net_income = d.pop("baseline_net_income")
+
+        budgetary_impact = cls(
+            budgetary_impact=budgetary_impact,
+            tax_revenue_impact=tax_revenue_impact,
+            state_tax_revenue_impact=state_tax_revenue_impact,
+            benefit_spending_impact=benefit_spending_impact,
+            households=households,
+            baseline_net_income=baseline_net_income,
+        )
+
+        budgetary_impact.additional_properties = d
+        return budgetary_impact
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties