archil-openapi 0.0.72__tar.gz → 0.0.73__tar.gz

{archil_openapi-0.0.72 → archil_openapi-0.0.73}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: archil-openapi
-Version: 0.0.72
+Version: 0.0.73
 Summary: Generated low-level Python client for the Archil control plane API
 Keywords: archil,openapi
 Author: Archil, Inc.

{archil_openapi-0.0.72 → archil_openapi-0.0.73}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "archil-openapi"
-version = "0.0.72"
+version = "0.0.73"
 description = "Generated low-level Python client for the Archil control plane API"
 readme = "README.md"
 license = { file = "LICENSE" }

archil_openapi-0.0.73/src/archil_openapi/api/sandboxes/get_sandbox_usage.py

@@ -0,0 +1,211 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_response_sandbox_usage import ApiResponseSandboxUsage
+from ...models.error_response import ErrorResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    sid: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/sandboxes/{sid}/usage".format(
+            sid=sid,
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    if response.status_code == 200:
+        response_200 = ApiResponseSandboxUsage.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = ErrorResponse.from_dict(response.json())
+
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+
+    if response.status_code == 503:
+        response_503 = ErrorResponse.from_dict(response.json())
+
+        return response_503
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    sid: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    """Get a sandbox's usage and cost
+
+     Returns the vCPU-hours and memory GiB-hours a sandbox has been billed for over its life, and what
+    that comes to at the account's rates. A sandbox is billed for its allocated vCPUs and memory for
+    every minute it runs, whatever it actually uses; paused and stopped time is free. The figures grow
+    about once a minute while the sandbox runs. Rates are the account's plan prices, including any
+    customer-specific ones, and the cost is gross usage before included allowances and prepaid credit,
+    as in `/api/billing/usage`; a plan that does not price sandbox usage has zero rates. A plan change
+    reaches the rates within a minute. Usage stays readable after the sandbox is deleted, for as long as
+    usage records are retained (90 days by default). Hours and dollars carry six decimal places.
+
+    Args:
+        sid (UUID):
+
+    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[Union[ApiResponseSandboxUsage, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        sid=sid,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    sid: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    """Get a sandbox's usage and cost
+
+     Returns the vCPU-hours and memory GiB-hours a sandbox has been billed for over its life, and what
+    that comes to at the account's rates. A sandbox is billed for its allocated vCPUs and memory for
+    every minute it runs, whatever it actually uses; paused and stopped time is free. The figures grow
+    about once a minute while the sandbox runs. Rates are the account's plan prices, including any
+    customer-specific ones, and the cost is gross usage before included allowances and prepaid credit,
+    as in `/api/billing/usage`; a plan that does not price sandbox usage has zero rates. A plan change
+    reaches the rates within a minute. Usage stays readable after the sandbox is deleted, for as long as
+    usage records are retained (90 days by default). Hours and dollars carry six decimal places.
+
+    Args:
+        sid (UUID):
+
+    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:
+        Union[ApiResponseSandboxUsage, ErrorResponse]
+    """
+
+    return sync_detailed(
+        sid=sid,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    sid: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    """Get a sandbox's usage and cost
+
+     Returns the vCPU-hours and memory GiB-hours a sandbox has been billed for over its life, and what
+    that comes to at the account's rates. A sandbox is billed for its allocated vCPUs and memory for
+    every minute it runs, whatever it actually uses; paused and stopped time is free. The figures grow
+    about once a minute while the sandbox runs. Rates are the account's plan prices, including any
+    customer-specific ones, and the cost is gross usage before included allowances and prepaid credit,
+    as in `/api/billing/usage`; a plan that does not price sandbox usage has zero rates. A plan change
+    reaches the rates within a minute. Usage stays readable after the sandbox is deleted, for as long as
+    usage records are retained (90 days by default). Hours and dollars carry six decimal places.
+
+    Args:
+        sid (UUID):
+
+    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[Union[ApiResponseSandboxUsage, ErrorResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        sid=sid,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    sid: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union[ApiResponseSandboxUsage, ErrorResponse]]:
+    """Get a sandbox's usage and cost
+
+     Returns the vCPU-hours and memory GiB-hours a sandbox has been billed for over its life, and what
+    that comes to at the account's rates. A sandbox is billed for its allocated vCPUs and memory for
+    every minute it runs, whatever it actually uses; paused and stopped time is free. The figures grow
+    about once a minute while the sandbox runs. Rates are the account's plan prices, including any
+    customer-specific ones, and the cost is gross usage before included allowances and prepaid credit,
+    as in `/api/billing/usage`; a plan that does not price sandbox usage has zero rates. A plan change
+    reaches the rates within a minute. Usage stays readable after the sandbox is deleted, for as long as
+    usage records are retained (90 days by default). Hours and dollars carry six decimal places.
+
+    Args:
+        sid (UUID):
+
+    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:
+        Union[ApiResponseSandboxUsage, ErrorResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            sid=sid,
+            client=client,
+        )
+    ).parsed

{archil_openapi-0.0.72 → archil_openapi-0.0.73}/src/archil_openapi/models/__init__.py

@@ -54,6 +54,7 @@ from .api_response_sandbox_port import ApiResponseSandboxPort
 from .api_response_sandbox_port_list import ApiResponseSandboxPortList
 from .api_response_sandbox_port_token import ApiResponseSandboxPortToken
 from .api_response_sandbox_port_token_list import ApiResponseSandboxPortTokenList
+from .api_response_sandbox_usage import ApiResponseSandboxUsage
 from .api_response_share_url import ApiResponseShareUrl
 from .api_response_share_url_data import ApiResponseShareUrlData
 from .api_response_token_created import ApiResponseTokenCreated
@@ -236,6 +237,8 @@ from .sandbox_port_token import SandboxPortToken
 from .sandbox_port_token_list import SandboxPortTokenList
 from .sandbox_state import SandboxState
 from .sandbox_timeout_request import SandboxTimeoutRequest
+from .sandbox_usage import SandboxUsage
+from .sandbox_usage_rates import SandboxUsageRates
 from .set_allowed_i_ps_body import SetAllowedIPsBody
 from .set_billing_default_payment_method_body import SetBillingDefaultPaymentMethodBody
 from .set_sandbox_mount_body import SetSandboxMountBody
@@ -300,6 +303,7 @@ __all__ = (
     "ApiResponseSandboxPortList",
     "ApiResponseSandboxPortToken",
     "ApiResponseSandboxPortTokenList",
+    "ApiResponseSandboxUsage",
     "ApiResponseShareUrl",
     "ApiResponseShareUrlData",
     "ApiResponseTokenCreated",
@@ -482,6 +486,8 @@ __all__ = (
     "SandboxPortTokenList",
     "SandboxState",
     "SandboxTimeoutRequest",
+    "SandboxUsage",
+    "SandboxUsageRates",
     "SetAllowedIPsBody",
     "SetBillingDefaultPaymentMethodBody",
     "SetSandboxMountBody",

archil_openapi-0.0.73/src/archil_openapi/models/api_response_sandbox_usage.py

@@ -0,0 +1,73 @@
+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.sandbox_usage import SandboxUsage
+
+
+T = TypeVar("T", bound="ApiResponseSandboxUsage")
+
+
+@_attrs_define
+class ApiResponseSandboxUsage:
+    """
+    Attributes:
+        success (bool):  Example: True.
+        data (SandboxUsage):
+    """
+
+    success: bool
+    data: "SandboxUsage"
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        success = self.success
+
+        data = self.data.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "success": success,
+                "data": data,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.sandbox_usage import SandboxUsage
+
+        d = dict(src_dict)
+        success = d.pop("success")
+
+        data = SandboxUsage.from_dict(d.pop("data"))
+
+        api_response_sandbox_usage = cls(
+            success=success,
+            data=data,
+        )
+
+        api_response_sandbox_usage.additional_properties = d
+        return api_response_sandbox_usage
+
+    @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

archil_openapi-0.0.73/src/archil_openapi/models/sandbox_usage.py

@@ -0,0 +1,107 @@
+import datetime
+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
+from dateutil.parser import isoparse
+
+if TYPE_CHECKING:
+    from ..models.sandbox_usage_rates import SandboxUsageRates
+
+
+T = TypeVar("T", bound="SandboxUsage")
+
+
+@_attrs_define
+class SandboxUsage:
+    """
+    Attributes:
+        sandbox_id (str):
+        as_of (datetime.datetime): When the usage was read.
+        vcpu_hours (float): Allocated vCPUs times hours running. Example: 3.0.
+        memory_gib_hours (float): Allocated memory in GiB times hours running. Example: 6.0.
+        rates (SandboxUsageRates):
+        cost (float): Dollars, before included allowances and prepaid credit. Example: 0.285.
+    """
+
+    sandbox_id: str
+    as_of: datetime.datetime
+    vcpu_hours: float
+    memory_gib_hours: float
+    rates: "SandboxUsageRates"
+    cost: float
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        sandbox_id = self.sandbox_id
+
+        as_of = self.as_of.isoformat()
+
+        vcpu_hours = self.vcpu_hours
+
+        memory_gib_hours = self.memory_gib_hours
+
+        rates = self.rates.to_dict()
+
+        cost = self.cost
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "sandbox_id": sandbox_id,
+                "as_of": as_of,
+                "vcpu_hours": vcpu_hours,
+                "memory_gib_hours": memory_gib_hours,
+                "rates": rates,
+                "cost": cost,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.sandbox_usage_rates import SandboxUsageRates
+
+        d = dict(src_dict)
+        sandbox_id = d.pop("sandbox_id")
+
+        as_of = isoparse(d.pop("as_of"))
+
+        vcpu_hours = d.pop("vcpu_hours")
+
+        memory_gib_hours = d.pop("memory_gib_hours")
+
+        rates = SandboxUsageRates.from_dict(d.pop("rates"))
+
+        cost = d.pop("cost")
+
+        sandbox_usage = cls(
+            sandbox_id=sandbox_id,
+            as_of=as_of,
+            vcpu_hours=vcpu_hours,
+            memory_gib_hours=memory_gib_hours,
+            rates=rates,
+            cost=cost,
+        )
+
+        sandbox_usage.additional_properties = d
+        return sandbox_usage
+
+    @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

archil_openapi-0.0.73/src/archil_openapi/models/sandbox_usage_rates.py

@@ -0,0 +1,67 @@
+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="SandboxUsageRates")
+
+
+@_attrs_define
+class SandboxUsageRates:
+    """
+    Attributes:
+        vcpu_hour (float): Dollars per vCPU-hour at the account's rates. Example: 0.055.
+        memory_gib_hour (float): Dollars per GiB-hour at the account's rates. Example: 0.02.
+    """
+
+    vcpu_hour: float
+    memory_gib_hour: float
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        vcpu_hour = self.vcpu_hour
+
+        memory_gib_hour = self.memory_gib_hour
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "vcpu_hour": vcpu_hour,
+                "memory_gib_hour": memory_gib_hour,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        vcpu_hour = d.pop("vcpu_hour")
+
+        memory_gib_hour = d.pop("memory_gib_hour")
+
+        sandbox_usage_rates = cls(
+            vcpu_hour=vcpu_hour,
+            memory_gib_hour=memory_gib_hour,
+        )
+
+        sandbox_usage_rates.additional_properties = d
+        return sandbox_usage_rates
+
+    @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