policyengine-api-simulation-client 0.20251210.60__tar.gz → 0.20260115.81__tar.gz

{policyengine_api_simulation_client-0.20251210.60 → policyengine_api_simulation_client-0.20260115.81}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: policyengine_api_simulation_client
-Version: 0.20251210.60
-Summary: A client library for accessing policyengine-api-simulation
+Version: 0.20260115.81
+Summary: A client library for accessing PolicyEngine Simulation Gateway API
 Requires-Python: >=3.10,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -14,8 +14,8 @@ Requires-Dist: httpx (>=0.23.0,<0.29.0)
 Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
 Description-Content-Type: text/markdown
 
-# policyengine-api-simulation-client
-A client library for accessing policyengine-api-simulation
+# policyengine_api_simulation_client
+A client library for accessing PolicyEngine Simulation Gateway API
 
 ## Usage
 First, create a client:

{policyengine_api_simulation_client-0.20251210.60 → policyengine_api_simulation_client-0.20260115.81}/README.md

@@ -1,5 +1,5 @@
-# policyengine-api-simulation-client
-A client library for accessing policyengine-api-simulation
+# policyengine_api_simulation_client
+A client library for accessing PolicyEngine Simulation Gateway API
 
 ## Usage
 First, create a client:

{policyengine_api_simulation_client-0.20251210.60 → policyengine_api_simulation_client-0.20260115.81}/policyengine_api_simulation_client/__init__.py

@@ -1,4 +1,4 @@
-"""A client library for accessing policyengine-api-simulation"""
+"""A client library for accessing PolicyEngine Simulation Gateway API"""
 
 from .client import AuthenticatedClient, Client
 

policyengine_api_simulation_client-0.20260115.81/policyengine_api_simulation_client/api/default/get_country_versions_versions_country_get.py

@@ -0,0 +1,172 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_country_versions_versions_country_get_response_get_country_versions_versions_country_get import (
+    GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet,
+)
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    country: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/versions/{country}".format(
+            country=quote(str(country), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet.from_dict(
+            response.json()
+        )
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    country: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError]:
+    """Get Country Versions
+
+     Get available versions for a specific country.
+
+    Args:
+        country (str):
+
+    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[GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        country=country,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    country: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError | None:
+    """Get Country Versions
+
+     Get available versions for a specific country.
+
+    Args:
+        country (str):
+
+    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:
+        GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError
+    """
+
+    return sync_detailed(
+        country=country,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    country: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError]:
+    """Get Country Versions
+
+     Get available versions for a specific country.
+
+    Args:
+        country (str):
+
+    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[GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        country=country,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    country: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError | None:
+    """Get Country Versions
+
+     Get available versions for a specific country.
+
+    Args:
+        country (str):
+
+    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:
+        GetCountryVersionsVersionsCountryGetResponseGetCountryVersionsVersionsCountryGet | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            country=country,
+            client=client,
+        )
+    ).parsed

policyengine_api_simulation_client-0.20260115.81/policyengine_api_simulation_client/api/default/get_job_status_jobs_job_id_get.py

@@ -0,0 +1,204 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.job_status_response import JobStatusResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    job_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/jobs/{job_id}".format(
+            job_id=quote(str(job_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | JobStatusResponse | None:
+    if response.status_code == 200:
+        response_200 = JobStatusResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 202:
+        response_202 = cast(Any, None)
+        return response_202
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 500:
+        response_500 = cast(Any, None)
+        return response_500
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError | JobStatusResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    job_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any | HTTPValidationError | JobStatusResponse]:
+    r"""Get Job Status
+
+     Poll for job status.
+
+    Returns:
+        - 200 with status=\"complete\" and result when done
+        - 202 with status=\"running\" while in progress
+        - 404 if job_id not found
+        - 500 with status=\"failed\" and error on failure
+
+    Args:
+        job_id (str):
+
+    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[Any | HTTPValidationError | JobStatusResponse]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    job_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Any | HTTPValidationError | JobStatusResponse | None:
+    r"""Get Job Status
+
+     Poll for job status.
+
+    Returns:
+        - 200 with status=\"complete\" and result when done
+        - 202 with status=\"running\" while in progress
+        - 404 if job_id not found
+        - 500 with status=\"failed\" and error on failure
+
+    Args:
+        job_id (str):
+
+    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:
+        Any | HTTPValidationError | JobStatusResponse
+    """
+
+    return sync_detailed(
+        job_id=job_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    job_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Any | HTTPValidationError | JobStatusResponse]:
+    r"""Get Job Status
+
+     Poll for job status.
+
+    Returns:
+        - 200 with status=\"complete\" and result when done
+        - 202 with status=\"running\" while in progress
+        - 404 if job_id not found
+        - 500 with status=\"failed\" and error on failure
+
+    Args:
+        job_id (str):
+
+    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[Any | HTTPValidationError | JobStatusResponse]
+    """
+
+    kwargs = _get_kwargs(
+        job_id=job_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    job_id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Any | HTTPValidationError | JobStatusResponse | None:
+    r"""Get Job Status
+
+     Poll for job status.
+
+    Returns:
+        - 200 with status=\"complete\" and result when done
+        - 202 with status=\"running\" while in progress
+        - 404 if job_id not found
+        - 500 with status=\"failed\" and error on failure
+
+    Args:
+        job_id (str):
+
+    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:
+        Any | HTTPValidationError | JobStatusResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            job_id=job_id,
+            client=client,
+        )
+    ).parsed

policyengine_api_simulation_client-0.20251210.60/policyengine_api_simulation_client/api/default/started_ping_started_get.py → policyengine_api_simulation_client-0.20260115.81/policyengine_api_simulation_client/api/default/health_health_get.py

@@ -1,25 +1,29 @@
 from http import HTTPStatus
-from typing import Any, cast
+from typing import Any
 
 import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
+from ...models.health_health_get_response_health_health_get import HealthHealthGetResponseHealthHealthGet
 from ...types import Response
 
 
 def _get_kwargs() -> dict[str, Any]:
     _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": "/ping/started",
+        "url": "/health",
     }
 
     return _kwargs
 
 
-def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> str | None:
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HealthHealthGetResponseHealthHealthGet | None:
     if response.status_code == 200:
-        response_200 = cast(str, response.json())
+        response_200 = HealthHealthGetResponseHealthHealthGet.from_dict(response.json())
+
         return response_200
 
     if client.raise_on_unexpected_status:
@@ -28,7 +32,9 @@ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Res
         return None
 
 
-def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[str]:
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[HealthHealthGetResponseHealthHealthGet]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -40,17 +46,17 @@ def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Res
 def sync_detailed(
     *,
     client: AuthenticatedClient | Client,
-) -> Response[str]:
-    """Started
+) -> Response[HealthHealthGetResponseHealthHealthGet]:
+    """Health
 
-     Verify the api is running.
+     Health check endpoint.
 
     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[str]
+        Response[HealthHealthGetResponseHealthHealthGet]
     """
 
     kwargs = _get_kwargs()
@@ -65,17 +71,17 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient | Client,
-) -> str | None:
-    """Started
+) -> HealthHealthGetResponseHealthHealthGet | None:
+    """Health
 
-     Verify the api is running.
+     Health check endpoint.
 
     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:
-        str
+        HealthHealthGetResponseHealthHealthGet
     """
 
     return sync_detailed(
@@ -86,17 +92,17 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient | Client,
-) -> Response[str]:
-    """Started
+) -> Response[HealthHealthGetResponseHealthHealthGet]:
+    """Health
 
-     Verify the api is running.
+     Health check endpoint.
 
     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[str]
+        Response[HealthHealthGetResponseHealthHealthGet]
     """
 
     kwargs = _get_kwargs()
@@ -109,17 +115,17 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient | Client,
-) -> str | None:
-    """Started
+) -> HealthHealthGetResponseHealthHealthGet | None:
+    """Health
 
-     Verify the api is running.
+     Health check endpoint.
 
     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:
-        str
+        HealthHealthGetResponseHealthHealthGet
     """
 
     return (

policyengine_api_simulation_client-0.20251210.60/policyengine_api_simulation_client/api/default/alive_ping_alive_get.py → policyengine_api_simulation_client-0.20260115.81/policyengine_api_simulation_client/api/default/list_versions_versions_get.py

@@ -5,22 +5,26 @@ import httpx
 
 from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.health_status import HealthStatus
+from ...models.list_versions_versions_get_response_list_versions_versions_get import (
+    ListVersionsVersionsGetResponseListVersionsVersionsGet,
+)
 from ...types import Response
 
 
 def _get_kwargs() -> dict[str, Any]:
     _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": "/ping/alive",
+        "url": "/versions",
     }
 
     return _kwargs
 
 
-def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> HealthStatus | None:
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ListVersionsVersionsGetResponseListVersionsVersionsGet | None:
     if response.status_code == 200:
-        response_200 = HealthStatus.from_dict(response.json())
+        response_200 = ListVersionsVersionsGetResponseListVersionsVersionsGet.from_dict(response.json())
 
         return response_200
 
@@ -30,7 +34,9 @@ def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Res
         return None
 
 
-def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[HealthStatus]:
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ListVersionsVersionsGetResponseListVersionsVersionsGet]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -42,19 +48,17 @@ def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Res
 def sync_detailed(
     *,
     client: AuthenticatedClient | Client,
-) -> Response[HealthStatus]:
-    """Alive
+) -> Response[ListVersionsVersionsGetResponseListVersionsVersionsGet]:
+    """List Versions
 
-     Check if the service is healthy. This will always return
-    data, but will return a 503 response code if the service is
-    unhealthy.
+     List all available versions for all countries.
 
     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[HealthStatus]
+        Response[ListVersionsVersionsGetResponseListVersionsVersionsGet]
     """
 
     kwargs = _get_kwargs()
@@ -69,19 +73,17 @@ def sync_detailed(
 def sync(
     *,
     client: AuthenticatedClient | Client,
-) -> HealthStatus | None:
-    """Alive
+) -> ListVersionsVersionsGetResponseListVersionsVersionsGet | None:
+    """List Versions
 
-     Check if the service is healthy. This will always return
-    data, but will return a 503 response code if the service is
-    unhealthy.
+     List all available versions for all countries.
 
     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:
-        HealthStatus
+        ListVersionsVersionsGetResponseListVersionsVersionsGet
     """
 
     return sync_detailed(
@@ -92,19 +94,17 @@ def sync(
 async def asyncio_detailed(
     *,
     client: AuthenticatedClient | Client,
-) -> Response[HealthStatus]:
-    """Alive
+) -> Response[ListVersionsVersionsGetResponseListVersionsVersionsGet]:
+    """List Versions
 
-     Check if the service is healthy. This will always return
-    data, but will return a 503 response code if the service is
-    unhealthy.
+     List all available versions for all countries.
 
     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[HealthStatus]
+        Response[ListVersionsVersionsGetResponseListVersionsVersionsGet]
     """
 
     kwargs = _get_kwargs()
@@ -117,19 +117,17 @@ async def asyncio_detailed(
 async def asyncio(
     *,
     client: AuthenticatedClient | Client,
-) -> HealthStatus | None:
-    """Alive
+) -> ListVersionsVersionsGetResponseListVersionsVersionsGet | None:
+    """List Versions
 
-     Check if the service is healthy. This will always return
-    data, but will return a 503 response code if the service is
-    unhealthy.
+     List all available versions for all countries.
 
     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:
-        HealthStatus
+        ListVersionsVersionsGetResponseListVersionsVersionsGet
     """
 
     return (