ocpplab 0.1.1__py3-none-any.whl

ocpplab/__init__.py

@@ -0,0 +1,240 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        BrandListResponse,
+        BrandResponse,
+        CacheResetResponse,
+        ChargerLifecycleRequest,
+        ChargerListResponse,
+        ChargerLogEntry,
+        ChargerLogListResponse,
+        ChargerResponse,
+        ConfigurationChangeResponse,
+        ConfigurationEntry,
+        ConfigurationResponse,
+        ConfigurationUpdateRequest,
+        ConnectorSelectionRequest,
+        Coordinates,
+        CreateChargerRequest,
+        CreateLocationChargersResponse,
+        DeleteLocationChargersResponse,
+        FaultOperationResponse,
+        HttpErrorResponse,
+        HttpValidationError,
+        LocalAuthListEntry,
+        LocalAuthorizationListResponse,
+        LocalListMutationResponse,
+        LocationCommandFailure,
+        LocationCommandResponse,
+        LocationCreateChargerFailure,
+        LocationDeleteChargerFailure,
+        LocationFaultResponse,
+        LocationFaultResult,
+        LocationLifecycleRequest,
+        LocationListResponse,
+        LocationQueuedCommandResult,
+        LocationResponse,
+        LocationResponseCoordinates,
+        LocationUpdateChargerFailure,
+        ModelListResponse,
+        ModelResponse,
+        ProxyAction,
+        ProxyOcppVersion,
+        QueuedCommandResponse,
+        UpdateLocationChargerItem,
+        UpdateLocationChargersResponse,
+        ValidationError,
+        ValidationErrorLocItem,
+    )
+    from .errors import (
+        BadRequestError,
+        ForbiddenError,
+        InternalServerError,
+        NotFoundError,
+        UnauthorizedError,
+        UnprocessableEntityError,
+    )
+    from . import (
+        catalog,
+        charger_commands,
+        charger_configuration,
+        charger_deployments,
+        charger_faults,
+        charger_local_authorization,
+        charger_logs,
+        health,
+        location_charger_commands,
+        location_charger_faults,
+        location_charger_provisioning,
+        locations,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncOcpplabApi, OcpplabApi
+    from .version import __version__
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncOcpplabApi": ".client",
+    "BadRequestError": ".errors",
+    "BrandListResponse": ".types",
+    "BrandResponse": ".types",
+    "CacheResetResponse": ".types",
+    "ChargerLifecycleRequest": ".types",
+    "ChargerListResponse": ".types",
+    "ChargerLogEntry": ".types",
+    "ChargerLogListResponse": ".types",
+    "ChargerResponse": ".types",
+    "ConfigurationChangeResponse": ".types",
+    "ConfigurationEntry": ".types",
+    "ConfigurationResponse": ".types",
+    "ConfigurationUpdateRequest": ".types",
+    "ConnectorSelectionRequest": ".types",
+    "Coordinates": ".types",
+    "CreateChargerRequest": ".types",
+    "CreateLocationChargersResponse": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeleteLocationChargersResponse": ".types",
+    "FaultOperationResponse": ".types",
+    "ForbiddenError": ".errors",
+    "HttpErrorResponse": ".types",
+    "HttpValidationError": ".types",
+    "InternalServerError": ".errors",
+    "LocalAuthListEntry": ".types",
+    "LocalAuthorizationListResponse": ".types",
+    "LocalListMutationResponse": ".types",
+    "LocationCommandFailure": ".types",
+    "LocationCommandResponse": ".types",
+    "LocationCreateChargerFailure": ".types",
+    "LocationDeleteChargerFailure": ".types",
+    "LocationFaultResponse": ".types",
+    "LocationFaultResult": ".types",
+    "LocationLifecycleRequest": ".types",
+    "LocationListResponse": ".types",
+    "LocationQueuedCommandResult": ".types",
+    "LocationResponse": ".types",
+    "LocationResponseCoordinates": ".types",
+    "LocationUpdateChargerFailure": ".types",
+    "ModelListResponse": ".types",
+    "ModelResponse": ".types",
+    "NotFoundError": ".errors",
+    "OcpplabApi": ".client",
+    "ProxyAction": ".types",
+    "ProxyOcppVersion": ".types",
+    "QueuedCommandResponse": ".types",
+    "UnauthorizedError": ".errors",
+    "UnprocessableEntityError": ".errors",
+    "UpdateLocationChargerItem": ".types",
+    "UpdateLocationChargersResponse": ".types",
+    "ValidationError": ".types",
+    "ValidationErrorLocItem": ".types",
+    "__version__": ".version",
+    "catalog": ".catalog",
+    "charger_commands": ".charger_commands",
+    "charger_configuration": ".charger_configuration",
+    "charger_deployments": ".charger_deployments",
+    "charger_faults": ".charger_faults",
+    "charger_local_authorization": ".charger_local_authorization",
+    "charger_logs": ".charger_logs",
+    "health": ".health",
+    "location_charger_commands": ".location_charger_commands",
+    "location_charger_faults": ".location_charger_faults",
+    "location_charger_provisioning": ".location_charger_provisioning",
+    "locations": ".locations",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncOcpplabApi",
+    "BadRequestError",
+    "BrandListResponse",
+    "BrandResponse",
+    "CacheResetResponse",
+    "ChargerLifecycleRequest",
+    "ChargerListResponse",
+    "ChargerLogEntry",
+    "ChargerLogListResponse",
+    "ChargerResponse",
+    "ConfigurationChangeResponse",
+    "ConfigurationEntry",
+    "ConfigurationResponse",
+    "ConfigurationUpdateRequest",
+    "ConnectorSelectionRequest",
+    "Coordinates",
+    "CreateChargerRequest",
+    "CreateLocationChargersResponse",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeleteLocationChargersResponse",
+    "FaultOperationResponse",
+    "ForbiddenError",
+    "HttpErrorResponse",
+    "HttpValidationError",
+    "InternalServerError",
+    "LocalAuthListEntry",
+    "LocalAuthorizationListResponse",
+    "LocalListMutationResponse",
+    "LocationCommandFailure",
+    "LocationCommandResponse",
+    "LocationCreateChargerFailure",
+    "LocationDeleteChargerFailure",
+    "LocationFaultResponse",
+    "LocationFaultResult",
+    "LocationLifecycleRequest",
+    "LocationListResponse",
+    "LocationQueuedCommandResult",
+    "LocationResponse",
+    "LocationResponseCoordinates",
+    "LocationUpdateChargerFailure",
+    "ModelListResponse",
+    "ModelResponse",
+    "NotFoundError",
+    "OcpplabApi",
+    "ProxyAction",
+    "ProxyOcppVersion",
+    "QueuedCommandResponse",
+    "UnauthorizedError",
+    "UnprocessableEntityError",
+    "UpdateLocationChargerItem",
+    "UpdateLocationChargersResponse",
+    "ValidationError",
+    "ValidationErrorLocItem",
+    "__version__",
+    "catalog",
+    "charger_commands",
+    "charger_configuration",
+    "charger_deployments",
+    "charger_faults",
+    "charger_local_authorization",
+    "charger_logs",
+    "health",
+    "location_charger_commands",
+    "location_charger_faults",
+    "location_charger_provisioning",
+    "locations",
+]

ocpplab/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install ocpplab[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

ocpplab/catalog/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

ocpplab/catalog/client.py

@@ -0,0 +1,332 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.brand_list_response import BrandListResponse
+from ..types.model_list_response import ModelListResponse
+from ..types.model_response import ModelResponse
+from .raw_client import AsyncRawCatalogClient, RawCatalogClient
+
+
+class CatalogClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCatalogClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCatalogClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCatalogClient
+        """
+        return self._raw_client
+
+    def list_catalog_brands(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BrandListResponse:
+        """
+        Retrieve the catalog of charger brands available to the platform.
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number for the paginated brand catalog.
+
+        limit : typing.Optional[int]
+            Maximum number of brands returned in one page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BrandListResponse
+            Catalog brands retrieved successfully
+
+        Examples
+        --------
+        from ocpplab import OcpplabApi
+
+        client = OcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.catalog.list_catalog_brands(
+            page=1,
+            limit=20,
+        )
+        """
+        _response = self._raw_client.list_catalog_brands(page=page, limit=limit, request_options=request_options)
+        return _response.data
+
+    def list_catalog_brand_models(
+        self,
+        brand_slug: str,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ModelListResponse:
+        """
+        Retrieve charger model details for a specific brand slug.
+
+        Parameters
+        ----------
+        brand_slug : str
+            Brand slug (URL-safe identifier) used to scope model discovery.
+
+        page : typing.Optional[int]
+            Page number for the paginated brand model list.
+
+        limit : typing.Optional[int]
+            Maximum number of models returned in one page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelListResponse
+            Models retrieved successfully
+
+        Examples
+        --------
+        from ocpplab import OcpplabApi
+
+        client = OcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.catalog.list_catalog_brand_models(
+            brand_slug="wallbox",
+            page=1,
+            limit=50,
+        )
+        """
+        _response = self._raw_client.list_catalog_brand_models(
+            brand_slug, page=page, limit=limit, request_options=request_options
+        )
+        return _response.data
+
+    def get_catalog_brand_model(
+        self, brand_slug: str, model_slug: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ModelResponse:
+        """
+        Retrieve one charger model detail record by brand slug and model slug.
+
+        Parameters
+        ----------
+        brand_slug : str
+            Brand slug (URL-safe identifier) used to scope model discovery.
+
+        model_slug : str
+            Model slug (URL-safe identifier) scoped under one brand.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelResponse
+            Model retrieved successfully
+
+        Examples
+        --------
+        from ocpplab import OcpplabApi
+
+        client = OcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+        client.catalog.get_catalog_brand_model(
+            brand_slug="wallbox",
+            model_slug="wallbox-pulsar-plus",
+        )
+        """
+        _response = self._raw_client.get_catalog_brand_model(brand_slug, model_slug, request_options=request_options)
+        return _response.data
+
+
+class AsyncCatalogClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCatalogClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCatalogClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCatalogClient
+        """
+        return self._raw_client
+
+    async def list_catalog_brands(
+        self,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> BrandListResponse:
+        """
+        Retrieve the catalog of charger brands available to the platform.
+
+        Parameters
+        ----------
+        page : typing.Optional[int]
+            Page number for the paginated brand catalog.
+
+        limit : typing.Optional[int]
+            Maximum number of brands returned in one page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BrandListResponse
+            Catalog brands retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from ocpplab import AsyncOcpplabApi
+
+        client = AsyncOcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.catalog.list_catalog_brands(
+                page=1,
+                limit=20,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_catalog_brands(page=page, limit=limit, request_options=request_options)
+        return _response.data
+
+    async def list_catalog_brand_models(
+        self,
+        brand_slug: str,
+        *,
+        page: typing.Optional[int] = None,
+        limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> ModelListResponse:
+        """
+        Retrieve charger model details for a specific brand slug.
+
+        Parameters
+        ----------
+        brand_slug : str
+            Brand slug (URL-safe identifier) used to scope model discovery.
+
+        page : typing.Optional[int]
+            Page number for the paginated brand model list.
+
+        limit : typing.Optional[int]
+            Maximum number of models returned in one page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelListResponse
+            Models retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from ocpplab import AsyncOcpplabApi
+
+        client = AsyncOcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.catalog.list_catalog_brand_models(
+                brand_slug="wallbox",
+                page=1,
+                limit=50,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_catalog_brand_models(
+            brand_slug, page=page, limit=limit, request_options=request_options
+        )
+        return _response.data
+
+    async def get_catalog_brand_model(
+        self, brand_slug: str, model_slug: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> ModelResponse:
+        """
+        Retrieve one charger model detail record by brand slug and model slug.
+
+        Parameters
+        ----------
+        brand_slug : str
+            Brand slug (URL-safe identifier) used to scope model discovery.
+
+        model_slug : str
+            Model slug (URL-safe identifier) scoped under one brand.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ModelResponse
+            Model retrieved successfully
+
+        Examples
+        --------
+        import asyncio
+
+        from ocpplab import AsyncOcpplabApi
+
+        client = AsyncOcpplabApi(
+            organization_id="YOUR_ORGANIZATION_ID",
+            token="YOUR_TOKEN",
+            base_url="https://yourhost.com/path/to/api",
+        )
+
+
+        async def main() -> None:
+            await client.catalog.get_catalog_brand_model(
+                brand_slug="wallbox",
+                model_slug="wallbox-pulsar-plus",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_catalog_brand_model(
+            brand_slug, model_slug, request_options=request_options
+        )
+        return _response.data