policyengine-api-simulation-client 0.20251001.18__tar.gz → 0.20251216.72__tar.gz

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/PKG-INFO

@@ -1,10 +1,9 @@
 Metadata-Version: 2.4
 Name: policyengine_api_simulation_client
-Version: 0.20251001.18
+Version: 0.20251216.72
 Summary: A client library for accessing policyengine-api-simulation
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/api/default/alive_ping_alive_get.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 
@@ -18,7 +18,7 @@ def _get_kwargs() -> dict[str, Any]:
     return _kwargs
 
 
-def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[HealthStatus]:
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> HealthStatus | None:
     if response.status_code == 200:
         response_200 = HealthStatus.from_dict(response.json())
 
@@ -30,7 +30,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         return None
 
 
-def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[HealthStatus]:
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[HealthStatus]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -41,7 +41,7 @@ def _build_response(*, client: Union[AuthenticatedClient, Client], response: htt
 
 def sync_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
 ) -> Response[HealthStatus]:
     """Alive
 
@@ -68,8 +68,8 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Union[AuthenticatedClient, Client],
-) -> Optional[HealthStatus]:
+    client: AuthenticatedClient | Client,
+) -> HealthStatus | None:
     """Alive
 
      Check if the service is healthy. This will always return
@@ -91,7 +91,7 @@ def sync(
 
 async def asyncio_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
 ) -> Response[HealthStatus]:
     """Alive
 
@@ -116,8 +116,8 @@ async def asyncio_detailed(
 
 async def asyncio(
     *,
-    client: Union[AuthenticatedClient, Client],
-) -> Optional[HealthStatus]:
+    client: AuthenticatedClient | Client,
+) -> HealthStatus | None:
     """Alive
 
      Check if the service is healthy. This will always return

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/api/default/ping_ping_post.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 
@@ -31,8 +31,8 @@ def _get_kwargs(
 
 
 def _parse_response(
-    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[HTTPValidationError, PingResponse]]:
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | PingResponse | None:
     if response.status_code == 200:
         response_200 = PingResponse.from_dict(response.json())
 
@@ -50,8 +50,8 @@ def _parse_response(
 
 
 def _build_response(
-    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[HTTPValidationError, PingResponse]]:
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HTTPValidationError | PingResponse]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -62,9 +62,9 @@ def _build_response(
 
 def sync_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: PingRequest,
-) -> Response[Union[HTTPValidationError, PingResponse]]:
+) -> Response[HTTPValidationError | PingResponse]:
     """Ping
 
      Verify the api is able to recieve and process unauthenticated requests.
@@ -77,7 +77,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Union[HTTPValidationError, PingResponse]]
+        Response[HTTPValidationError | PingResponse]
     """
 
     kwargs = _get_kwargs(
@@ -93,9 +93,9 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: PingRequest,
-) -> Optional[Union[HTTPValidationError, PingResponse]]:
+) -> HTTPValidationError | PingResponse | None:
     """Ping
 
      Verify the api is able to recieve and process unauthenticated requests.
@@ -108,7 +108,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Union[HTTPValidationError, PingResponse]
+        HTTPValidationError | PingResponse
     """
 
     return sync_detailed(
@@ -119,9 +119,9 @@ def sync(
 
 async def asyncio_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: PingRequest,
-) -> Response[Union[HTTPValidationError, PingResponse]]:
+) -> Response[HTTPValidationError | PingResponse]:
     """Ping
 
      Verify the api is able to recieve and process unauthenticated requests.
@@ -134,7 +134,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Union[HTTPValidationError, PingResponse]]
+        Response[HTTPValidationError | PingResponse]
     """
 
     kwargs = _get_kwargs(
@@ -148,9 +148,9 @@ async def asyncio_detailed(
 
 async def asyncio(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: PingRequest,
-) -> Optional[Union[HTTPValidationError, PingResponse]]:
+) -> HTTPValidationError | PingResponse | None:
     """Ping
 
      Verify the api is able to recieve and process unauthenticated requests.
@@ -163,7 +163,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Union[HTTPValidationError, PingResponse]
+        HTTPValidationError | PingResponse
     """
 
     return (

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/api/default/simulate_simulate_economy_comparison_post.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 
@@ -31,8 +31,8 @@ def _get_kwargs(
 
 
 def _parse_response(
-    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Optional[Union[EconomyComparison, HTTPValidationError]]:
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> EconomyComparison | HTTPValidationError | None:
     if response.status_code == 200:
         response_200 = EconomyComparison.from_dict(response.json())
 
@@ -50,8 +50,8 @@ def _parse_response(
 
 
 def _build_response(
-    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
-) -> Response[Union[EconomyComparison, HTTPValidationError]]:
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[EconomyComparison | HTTPValidationError]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -62,9 +62,9 @@ def _build_response(
 
 def sync_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: SimulationOptions,
-) -> Response[Union[EconomyComparison, HTTPValidationError]]:
+) -> Response[EconomyComparison | HTTPValidationError]:
     """Simulate
 
     Args:
@@ -75,7 +75,7 @@ def sync_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Union[EconomyComparison, HTTPValidationError]]
+        Response[EconomyComparison | HTTPValidationError]
     """
 
     kwargs = _get_kwargs(
@@ -91,9 +91,9 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: SimulationOptions,
-) -> Optional[Union[EconomyComparison, HTTPValidationError]]:
+) -> EconomyComparison | HTTPValidationError | None:
     """Simulate
 
     Args:
@@ -104,7 +104,7 @@ def sync(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Union[EconomyComparison, HTTPValidationError]
+        EconomyComparison | HTTPValidationError
     """
 
     return sync_detailed(
@@ -115,9 +115,9 @@ def sync(
 
 async def asyncio_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: SimulationOptions,
-) -> Response[Union[EconomyComparison, HTTPValidationError]]:
+) -> Response[EconomyComparison | HTTPValidationError]:
     """Simulate
 
     Args:
@@ -128,7 +128,7 @@ async def asyncio_detailed(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[Union[EconomyComparison, HTTPValidationError]]
+        Response[EconomyComparison | HTTPValidationError]
     """
 
     kwargs = _get_kwargs(
@@ -142,9 +142,9 @@ async def asyncio_detailed(
 
 async def asyncio(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
     body: SimulationOptions,
-) -> Optional[Union[EconomyComparison, HTTPValidationError]]:
+) -> EconomyComparison | HTTPValidationError | None:
     """Simulate
 
     Args:
@@ -155,7 +155,7 @@ async def asyncio(
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Union[EconomyComparison, HTTPValidationError]
+        EconomyComparison | HTTPValidationError
     """
 
     return (

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/api/default/started_ping_started_get.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Optional, Union, cast
+from typing import Any, cast
 
 import httpx
 
@@ -17,7 +17,7 @@ def _get_kwargs() -> dict[str, Any]:
     return _kwargs
 
 
-def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[str]:
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> str | None:
     if response.status_code == 200:
         response_200 = cast(str, response.json())
         return response_200
@@ -28,7 +28,7 @@ def _parse_response(*, client: Union[AuthenticatedClient, Client], response: htt
         return None
 
 
-def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[str]:
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[str]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -39,7 +39,7 @@ def _build_response(*, client: Union[AuthenticatedClient, Client], response: htt
 
 def sync_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
 ) -> Response[str]:
     """Started
 
@@ -64,8 +64,8 @@ def sync_detailed(
 
 def sync(
     *,
-    client: Union[AuthenticatedClient, Client],
-) -> Optional[str]:
+    client: AuthenticatedClient | Client,
+) -> str | None:
     """Started
 
      Verify the api is running.
@@ -85,7 +85,7 @@ def sync(
 
 async def asyncio_detailed(
     *,
-    client: Union[AuthenticatedClient, Client],
+    client: AuthenticatedClient | Client,
 ) -> Response[str]:
     """Started
 
@@ -108,8 +108,8 @@ async def asyncio_detailed(
 
 async def asyncio(
     *,
-    client: Union[AuthenticatedClient, Client],
-) -> Optional[str]:
+    client: AuthenticatedClient | Client,
+) -> str | None:
     """Started
 
      Verify the api is running.

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/client.py

@@ -1,5 +1,5 @@
 import ssl
-from typing import Any, Optional, Union
+from typing import Any
 
 import httpx
 from attrs import define, evolve, field
@@ -38,12 +38,12 @@ class Client:
     _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: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
-    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(default=True, kw_only=True, alias="verify_ssl")
+    _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: Optional[httpx.Client] = field(default=None, init=False)
-    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+    _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"""
@@ -62,7 +62,7 @@ class Client:
         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 (in seconds)"""
+        """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:
@@ -101,7 +101,7 @@ class Client:
         self.get_httpx_client().__exit__(*args, **kwargs)
 
     def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "Client":
-        """Manually the underlying httpx.AsyncClient
+        """Manually set the underlying httpx.AsyncClient
 
         **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
         """
@@ -168,12 +168,12 @@ class AuthenticatedClient:
     _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: Optional[httpx.Timeout] = field(default=None, kw_only=True, alias="timeout")
-    _verify_ssl: Union[str, bool, ssl.SSLContext] = field(default=True, kw_only=True, alias="verify_ssl")
+    _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: Optional[httpx.Client] = field(default=None, init=False)
-    _async_client: Optional[httpx.AsyncClient] = field(default=None, init=False)
+    _client: httpx.Client | None = field(default=None, init=False)
+    _async_client: httpx.AsyncClient | None = field(default=None, init=False)
 
     token: str
     prefix: str = "Bearer"
@@ -196,7 +196,7 @@ class AuthenticatedClient:
         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 (in seconds)"""
+        """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:
@@ -236,7 +236,7 @@ class AuthenticatedClient:
         self.get_httpx_client().__exit__(*args, **kwargs)
 
     def set_async_httpx_client(self, async_client: httpx.AsyncClient) -> "AuthenticatedClient":
-        """Manually the underlying httpx.AsyncClient
+        """Manually set the underlying httpx.AsyncClient
 
         **NOTE**: This will override any other settings on the client, including cookies, headers, and timeout.
         """

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/__init__.py

@@ -50,6 +50,11 @@ from .uk_constituency_breakdown_with_values_outcomes_by_region import UKConstitu
 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
@@ -102,6 +107,9 @@ __all__ = (
     "UKConstituencyBreakdownWithValuesByConstituency",
     "UKConstituencyBreakdownWithValuesOutcomesByRegion",
     "UKConstituencyBreakdownWithValuesOutcomesByRegionAdditionalProperty",
+    "UKLocalAuthorityBreakdownByLocalAuthority",
+    "UKLocalAuthorityBreakdownWithValues",
+    "UKLocalAuthorityBreakdownWithValuesByLocalAuthority",
     "ValidationError",
     "WealthDecileImpactWithValues",
     "WealthDecileImpactWithValuesAverage",

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/age_group_baseline_reform_values.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, TypeVar
 
@@ -21,10 +23,10 @@ class AgeGroupBaselineReformValues:
         all_ (BaselineReformValues):
     """
 
-    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]:

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/baseline_reform_values.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any, TypeVar
 

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/budgetary_impact.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any, TypeVar
 

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/cliff_impact.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, TypeVar
 
@@ -19,8 +21,8 @@ class CliffImpact:
         reform (CliffImpactInSimulation):
     """
 
-    baseline: "CliffImpactInSimulation"
-    reform: "CliffImpactInSimulation"
+    baseline: CliffImpactInSimulation
+    reform: CliffImpactInSimulation
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/cliff_impact_in_simulation.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any, TypeVar
 

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/decile_impact.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import TYPE_CHECKING, Any, TypeVar
 
@@ -20,8 +22,8 @@ class DecileImpact:
         average (DecileImpactAverage):
     """
 
-    relative: "DecileImpactRelative"
-    average: "DecileImpactAverage"
+    relative: DecileImpactRelative
+    average: DecileImpactAverage
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/decile_impact_average.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any, TypeVar
 

{policyengine_api_simulation_client-0.20251001.18 → policyengine_api_simulation_client-0.20251216.72}/policyengine_api_simulation_client/models/decile_impact_relative.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from collections.abc import Mapping
 from typing import Any, TypeVar