policyengine-api-simulation-client 0.20260112.77__py3-none-any.whl → 0.20260114.79__py3-none-any.whl

policyengine_api_simulation_client/api/default/ping_ping_post.py

@@ -67,10 +67,10 @@ def sync_detailed(
 ) -> Response[HTTPValidationError | PingResponse]:
     """Ping
 
-     Verify the api is able to recieve and process unauthenticated requests.
+     Verify the API is able to receive and process requests.
 
     Args:
-        body (PingRequest):
+        body (PingRequest): Request model for ping endpoint.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -98,10 +98,10 @@ def sync(
 ) -> HTTPValidationError | PingResponse | None:
     """Ping
 
-     Verify the api is able to recieve and process unauthenticated requests.
+     Verify the API is able to receive and process requests.
 
     Args:
-        body (PingRequest):
+        body (PingRequest): Request model for ping endpoint.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -124,10 +124,10 @@ async def asyncio_detailed(
 ) -> Response[HTTPValidationError | PingResponse]:
     """Ping
 
-     Verify the api is able to recieve and process unauthenticated requests.
+     Verify the API is able to receive and process requests.
 
     Args:
-        body (PingRequest):
+        body (PingRequest): Request model for ping endpoint.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -153,10 +153,10 @@ async def asyncio(
 ) -> HTTPValidationError | PingResponse | None:
     """Ping
 
-     Verify the api is able to recieve and process unauthenticated requests.
+     Verify the API is able to receive and process requests.
 
     Args:
-        body (PingRequest):
+        body (PingRequest): Request model for ping endpoint.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

policyengine_api_simulation_client/api/default/{simulate_simulate_economy_comparison_post.py → submit_simulation_simulate_economy_comparison_post.py}

@@ -1,19 +1,19 @@
 from http import HTTPStatus
-from typing import Any
+from typing import Any, cast
 
 import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.economy_comparison import EconomyComparison
 from ...models.http_validation_error import HTTPValidationError
-from ...models.simulation_options import SimulationOptions
+from ...models.job_submit_response import JobSubmitResponse
+from ...models.simulation_request import SimulationRequest
 from ...types import Response
 
 
 def _get_kwargs(
     *,
-    body: SimulationOptions,
+    body: SimulationRequest,
 ) -> dict[str, Any]:
     headers: dict[str, Any] = {}
 
@@ -32,12 +32,16 @@ def _get_kwargs(
 
 def _parse_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> EconomyComparison | HTTPValidationError | None:
+) -> Any | HTTPValidationError | JobSubmitResponse | None:
     if response.status_code == 200:
-        response_200 = EconomyComparison.from_dict(response.json())
+        response_200 = JobSubmitResponse.from_dict(response.json())
 
         return response_200
 
+    if response.status_code == 400:
+        response_400 = cast(Any, None)
+        return response_400
+
     if response.status_code == 422:
         response_422 = HTTPValidationError.from_dict(response.json())
 
@@ -51,7 +55,7 @@ def _parse_response(
 
 def _build_response(
     *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[EconomyComparison | HTTPValidationError]:
+) -> Response[Any | HTTPValidationError | JobSubmitResponse]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -63,19 +67,24 @@ def _build_response(
 def sync_detailed(
     *,
     client: AuthenticatedClient | Client,
-    body: SimulationOptions,
-) -> Response[EconomyComparison | HTTPValidationError]:
-    """Simulate
+    body: SimulationRequest,
+) -> Response[Any | HTTPValidationError | JobSubmitResponse]:
+    """Submit Simulation
+
+     Submit a simulation job.
+
+    Routes to the appropriate simulation app based on country and version.
+    Returns immediately with a job_id for polling.
 
     Args:
-        body (SimulationOptions):
+        body (SimulationRequest): Request model for simulation submission.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[EconomyComparison | HTTPValidationError]
+        Response[Any | HTTPValidationError | JobSubmitResponse]
     """
 
     kwargs = _get_kwargs(
@@ -92,19 +101,24 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient | Client,
-    body: SimulationOptions,
-) -> EconomyComparison | HTTPValidationError | None:
-    """Simulate
+    body: SimulationRequest,
+) -> Any | HTTPValidationError | JobSubmitResponse | None:
+    """Submit Simulation
+
+     Submit a simulation job.
+
+    Routes to the appropriate simulation app based on country and version.
+    Returns immediately with a job_id for polling.
 
     Args:
-        body (SimulationOptions):
+        body (SimulationRequest): Request model for simulation submission.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        EconomyComparison | HTTPValidationError
+        Any | HTTPValidationError | JobSubmitResponse
     """
 
     return sync_detailed(
@@ -116,19 +130,24 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient | Client,
-    body: SimulationOptions,
-) -> Response[EconomyComparison | HTTPValidationError]:
-    """Simulate
+    body: SimulationRequest,
+) -> Response[Any | HTTPValidationError | JobSubmitResponse]:
+    """Submit Simulation
+
+     Submit a simulation job.
+
+    Routes to the appropriate simulation app based on country and version.
+    Returns immediately with a job_id for polling.
 
     Args:
-        body (SimulationOptions):
+        body (SimulationRequest): Request model for simulation submission.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        Response[EconomyComparison | HTTPValidationError]
+        Response[Any | HTTPValidationError | JobSubmitResponse]
     """
 
     kwargs = _get_kwargs(
@@ -143,19 +162,24 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient | Client,
-    body: SimulationOptions,
-) -> EconomyComparison | HTTPValidationError | None:
-    """Simulate
+    body: SimulationRequest,
+) -> Any | HTTPValidationError | JobSubmitResponse | None:
+    """Submit Simulation
+
+     Submit a simulation job.
+
+    Routes to the appropriate simulation app based on country and version.
+    Returns immediately with a job_id for polling.
 
     Args:
-        body (SimulationOptions):
+        body (SimulationRequest): Request model for simulation submission.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
         httpx.TimeoutException: If the request takes longer than Client.timeout.
 
     Returns:
-        EconomyComparison | HTTPValidationError
+        Any | HTTPValidationError | JobSubmitResponse
     """
 
     return (

policyengine_api_simulation_client/models/__init__.py

@@ -1,117 +1,31 @@
 """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 .get_country_versions_versions_country_get_response_get_country_versions_versions_country_get import (
+    GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet,
+)
+from .health_health_get_response_health_health_get import HealthHealthGetResponseHealthHealthGet
 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 .job_status_response import JobStatusResponse
+from .job_status_response_result_type_0 import JobStatusResponseResultType0
+from .job_submit_response import JobSubmitResponse
+from .list_versions_versions_get_response_list_versions_versions_get import (
+    ListVersionsVersionsGetResponseListVersionsVersionsGet,
 )
-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 .simulation_request import SimulationRequest
 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",
+    "GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet",
+    "HealthHealthGetResponseHealthHealthGet",
     "HTTPValidationError",
-    "InequalityImpact",
-    "IntraDecileImpact",
-    "IntraDecileImpactAll",
-    "IntraDecileImpactDeciles",
-    "IntraWealthDecileImpactWithValues",
-    "IntraWealthDecileImpactWithValuesAll",
-    "IntraWealthDecileImpactWithValuesDeciles",
-    "LaborSupplyResponse",
-    "LaborSupplyResponseDecile",
-    "LaborSupplyResponseDecileAdditionalProperty",
-    "LaborSupplyResponseDecileAdditionalPropertyAdditionalProperty",
-    "LaborSupplyResponseRelativeLsr",
-    "ParameterChangeDict",
-    "ParametricReform",
+    "JobStatusResponse",
+    "JobStatusResponseResultType0",
+    "JobSubmitResponse",
+    "ListVersionsVersionsGetResponseListVersionsVersionsGet",
     "PingRequest",
     "PingResponse",
-    "PovertyGenderBreakdown",
-    "PovertyImpact",
-    "PovertyRacialBreakdownWithValues",
-    "ProbeStatus",
-    "ProgramSpecificImpact",
-    "RacialBaselineReformValues",
-    "SimulationOptions",
-    "SimulationOptionsCountry",
-    "SimulationOptionsDataType1",
-    "SimulationOptionsScope",
-    "SystemStatus",
-    "UKConstituencyBreakdownByConstituency",
-    "UKConstituencyBreakdownWithValues",
-    "UKConstituencyBreakdownWithValuesByConstituency",
-    "UKConstituencyBreakdownWithValuesOutcomesByRegion",
-    "UKConstituencyBreakdownWithValuesOutcomesByRegionAdditionalProperty",
-    "UKLocalAuthorityBreakdownByLocalAuthority",
-    "UKLocalAuthorityBreakdownWithValues",
-    "UKLocalAuthorityBreakdownWithValuesByLocalAuthority",
+    "SimulationRequest",
     "ValidationError",
-    "WealthDecileImpactWithValues",
-    "WealthDecileImpactWithValuesAverage",
-    "WealthDecileImpactWithValuesRelative",
 )

policyengine_api_simulation_client/models/{baseline_reform_values.py → get_country_versions_versions_country_get_response_get_country_versions_versions_country_get.py}

@@ -6,51 +6,28 @@ from typing import Any, TypeVar
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
-T = TypeVar("T", bound="BaselineReformValues")
+T = TypeVar("T", bound="GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet")
 
 
 @_attrs_define
-class BaselineReformValues:
-    """
-    Attributes:
-        baseline (float):
-        reform (float):
-    """
+class GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet:
+    """ """
 
-    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,
-        )
+        get_country_versions_versions_country_get_response_get_country_versions_versions_country_get = cls()
 
-        baseline_reform_values.additional_properties = d
-        return baseline_reform_values
+        get_country_versions_versions_country_get_response_get_country_versions_versions_country_get.additional_properties = d
+        return get_country_versions_versions_country_get_response_get_country_versions_versions_country_get
 
     @property
     def additional_keys(self) -> list[str]:

policyengine_api_simulation_client/models/{labor_supply_response_relative_lsr.py → health_health_get_response_health_health_get.py}

@@ -6,11 +6,11 @@ from typing import Any, TypeVar
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
-T = TypeVar("T", bound="LaborSupplyResponseRelativeLsr")
+T = TypeVar("T", bound="HealthHealthGetResponseHealthHealthGet")
 
 
 @_attrs_define
-class LaborSupplyResponseRelativeLsr:
+class HealthHealthGetResponseHealthHealthGet:
     """ """
 
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
@@ -24,10 +24,10 @@ class LaborSupplyResponseRelativeLsr:
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         d = dict(src_dict)
-        labor_supply_response_relative_lsr = cls()
+        health_health_get_response_health_health_get = cls()
 
-        labor_supply_response_relative_lsr.additional_properties = d
-        return labor_supply_response_relative_lsr
+        health_health_get_response_health_health_get.additional_properties = d
+        return health_health_get_response_health_health_get
 
     @property
     def additional_keys(self) -> list[str]:

policyengine_api_simulation_client/models/job_status_response.py

@@ -0,0 +1,122 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar, cast
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.job_status_response_result_type_0 import JobStatusResponseResultType0
+
+
+T = TypeVar("T", bound="JobStatusResponse")
+
+
+@_attrs_define
+class JobStatusResponse:
+    """Response model for job status polling.
+
+    Attributes:
+        status (str):
+        result (JobStatusResponseResultType0 | None | Unset):
+        error (None | str | Unset):
+    """
+
+    status: str
+    result: JobStatusResponseResultType0 | None | Unset = UNSET
+    error: None | str | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.job_status_response_result_type_0 import JobStatusResponseResultType0
+
+        status = self.status
+
+        result: dict[str, Any] | None | Unset
+        if isinstance(self.result, Unset):
+            result = UNSET
+        elif isinstance(self.result, JobStatusResponseResultType0):
+            result = self.result.to_dict()
+        else:
+            result = self.result
+
+        error: None | str | Unset
+        if isinstance(self.error, Unset):
+            error = UNSET
+        else:
+            error = self.error
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "status": status,
+            }
+        )
+        if result is not UNSET:
+            field_dict["result"] = result
+        if error is not UNSET:
+            field_dict["error"] = error
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.job_status_response_result_type_0 import JobStatusResponseResultType0
+
+        d = dict(src_dict)
+        status = d.pop("status")
+
+        def _parse_result(data: object) -> JobStatusResponseResultType0 | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                result_type_0 = JobStatusResponseResultType0.from_dict(data)
+
+                return result_type_0
+            except (TypeError, ValueError, AttributeError, KeyError):
+                pass
+            return cast(JobStatusResponseResultType0 | None | Unset, data)
+
+        result = _parse_result(d.pop("result", UNSET))
+
+        def _parse_error(data: object) -> None | str | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(None | str | Unset, data)
+
+        error = _parse_error(d.pop("error", UNSET))
+
+        job_status_response = cls(
+            status=status,
+            result=result,
+            error=error,
+        )
+
+        job_status_response.additional_properties = d
+        return job_status_response
+
+    @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/{simulation_options_data_type_1.py → job_status_response_result_type_0.py}

@@ -6,11 +6,11 @@ from typing import Any, TypeVar
 from attrs import define as _attrs_define
 from attrs import field as _attrs_field
 
-T = TypeVar("T", bound="SimulationOptionsDataType1")
+T = TypeVar("T", bound="JobStatusResponseResultType0")
 
 
 @_attrs_define
-class SimulationOptionsDataType1:
+class JobStatusResponseResultType0:
     """ """
 
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
@@ -24,10 +24,10 @@ class SimulationOptionsDataType1:
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         d = dict(src_dict)
-        simulation_options_data_type_1 = cls()
+        job_status_response_result_type_0 = cls()
 
-        simulation_options_data_type_1.additional_properties = d
-        return simulation_options_data_type_1
+        job_status_response_result_type_0.additional_properties = d
+        return job_status_response_result_type_0
 
     @property
     def additional_keys(self) -> list[str]: