orb-cloud-client 1.3.3__tar.gz → 1.4.0__tar.gz

{orb_cloud_client-1.3.3/orb_cloud_client.egg-info → orb_cloud_client-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orb-cloud-client
-Version: 1.3.3
+Version: 1.4.0
 Summary: Python client library for Orb Cloud API
 Author-email: Orb Networks <support@orb.net>
 License-Expression: MIT

orb_cloud_client-1.4.0/orb_cloud_client/client.py

@@ -0,0 +1,216 @@
+"""
+Simple HTTP client for Orb Cloud API.
+"""
+
+import httpx
+from typing import Dict, Any, Optional, List
+
+from .models.generic import Device, TempDatasetsRequest, Organization
+from .models.server import OrganizationConfigurationsResponse, OrganizationDeviceConfigurationDeleteRequest
+
+class OrbCloudClientBase(object):
+    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
+        self.base_url = base_url.rstrip('/')
+        self.headers = {"Content-Type": "application/json"}
+        if token:
+            self.headers["Authorization"] = f"Bearer {token}"
+
+    def _get_organization_devices(self, response: httpx.Response) -> List[Device]:
+        """Get list of devices for the organization from a response."""
+        response.raise_for_status()
+        return [Device(**device) for device in response.json()]
+
+    def _configure_temporary_datasets(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for configuring temporary datasets."""
+        response.raise_for_status()
+        return response.json()
+
+    def _trigger_speedtest(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for triggering a speedtest."""
+        response.raise_for_status()
+        return response.json()
+
+    def _get_organizations(self, response: httpx.Response) -> List[Organization]:
+        """Get list of organizations accessible with the provided token."""
+        response.raise_for_status()
+        return [Organization(**org) for org in response.json()]
+
+    def _get_organization_configurations(self, response: httpx.Response) -> List[OrganizationConfigurationsResponse]:
+        """Get list of configurations for an organization."""
+        response.raise_for_status()
+        return [OrganizationConfigurationsResponse(**config) for config in response.json()]
+
+    def _get_organization_device_configuration(self, response: httpx.Response) -> Dict[str, Any]:
+        """Get the current device configuration."""
+        response.raise_for_status()
+        return response.json()
+
+    def _patch_organization_device_configuration(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for patching device configuration."""
+        response.raise_for_status()
+        return response.json()
+
+    def _delete_organization_device_configuration(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for deleting device configuration override."""
+        response.raise_for_status()
+        return response.json()
+
+    def _push_organization_device_temp_datasets(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for enabling temporary datasets for a device."""
+        response.raise_for_status()
+        return response.json()
+
+    def _organization_device_trigger_speedtest(self, response: httpx.Response) -> Dict[str, Any]:
+        """Process the response for triggering speedtest on an organization device."""
+        response.raise_for_status()
+        return response.json()
+
+class OrbCloudClient(OrbCloudClientBase):
+    """Simple HTTP client for Orb Cloud API."""
+
+    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
+        super().__init__(base_url, token)
+        self.client = httpx.Client(base_url=self.base_url, headers=self.headers)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.client.close()
+
+    def close(self):
+        """Close the HTTP client."""
+        self.client.close()
+
+    def get_organization_devices(self, organization_id: str) -> List[Device]:
+        """Get list of devices for the organization."""
+        response = self.client.get(f"/api/v2/organization/{organization_id}/devices")
+        return self._get_organization_devices(response)
+
+    def configure_temporary_datasets(self, device_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
+        """Enable temporary data reporting to a custom endpoint with a given config for a specified duration."""
+        response = self.client.post(f"/api/v1/device/{device_id}/temp-datasets", json=temp_datasets_request.model_dump())
+        return self._configure_temporary_datasets(response)
+
+    def get_organizations(self) -> List[Organization]:
+        """Get list of organizations accessible with the provided token."""
+        response = self.client.get("/api/v2/organizations")
+        return self._get_organizations(response)
+
+    def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a content or top speedtest"""
+        response = self.client.post(f"/api/v2/device/{device_id}/trigger-speedtest/{test_type}")
+        return self._trigger_speedtest(response)
+
+    def get_organization_configurations(self, organization_id: str) -> List[OrganizationConfigurationsResponse]:
+        """Get list of configurations for the organization."""
+        response = self.client.get(f"/api/v1/organization/{organization_id}/configurations")
+        return self._get_organization_configurations(response)
+
+    def get_organization_device_configuration(self, organization_id: str, orb_id: str) -> Dict[str, Any]:
+        """Get the current device configuration."""
+        response = self.client.get(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration")
+        return self._get_organization_device_configuration(response)
+
+    def patch_organization_device_configuration(self, organization_id: str, orb_id: str, config_patch: Dict[str, Any]) -> Dict[str, Any]:
+        """Patch the current device configuration and set it as an override for the device."""
+        response = self.client.patch(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration", json=config_patch)
+        return self._patch_organization_device_configuration(response)
+
+    def delete_organization_device_configuration(self, organization_id: str, orb_id: str, configuration_id: Optional[str] = None) -> Dict[str, Any]:
+        """Delete device configuration override. Optionally set a specific configuration to fallback to."""
+        body = {}
+        if configuration_id:
+            body = OrganizationDeviceConfigurationDeleteRequest(configuration_id=configuration_id).model_dump(exclude_none=True)
+        response = self.client.delete(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration", json=body if body else None)
+        return self._delete_organization_device_configuration(response)
+
+    def push_organization_device_temp_datasets(self, organization_id: str, orb_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
+        """Enable temporary datasets for a specific device in the organization."""
+        response = self.client.post(f"/api/v2/organization/{organization_id}/devices/{orb_id}/temp-datasets", json=temp_datasets_request.model_dump())
+        return self._push_organization_device_temp_datasets(response)
+
+    def organization_device_trigger_speedtest(self, organization_id: str, orb_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a speedtest on a specific device in the organization."""
+        response = self.client.post(f"/api/v2/organization/{organization_id}/devices/{orb_id}/trigger-speedtest/{test_type}")
+        return self._organization_device_trigger_speedtest(response)
+
+
+    def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """Make a raw HTTP request for any other endpoints."""
+        return self.client.request(method, endpoint, **kwargs)
+
+
+class OrbCloudClientAsync(OrbCloudClientBase):
+    """Simple async HTTP client for Orb Cloud API."""
+
+    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
+        super().__init__(base_url, token)
+        self.client = httpx.AsyncClient(base_url=self.base_url, headers=self.headers)
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.client.aclose()
+
+    async def close(self):
+        """Close the HTTP client."""
+        await self.client.aclose()
+
+    async def get_organization_devices(self, organization_id: str) -> List[Device]:
+        """Get list of devices for the organization."""
+        response = await self.client.get(f"/api/v2/organization/{organization_id}/devices")
+        return self._get_organization_devices(response)
+
+    async def configure_temporary_datasets(self, device_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
+        """Enable temporary data reporting to a custom endpoint with a given config for a specified duration."""
+        response = await self.client.post(f"/api/v1/device/{device_id}/temp-datasets", json=temp_datasets_request.model_dump())
+        return self._configure_temporary_datasets(response)
+
+    async def get_organizations(self) -> List[Organization]:
+        """Get list of organizations accessible with the provided token."""
+        response = await self.client.get("/api/v2/organizations")
+        return self._get_organizations(response)
+
+    async def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a content or top speedtest"""
+        response = await self.client.post(f"/api/v2/device/{device_id}/trigger-speedtest/{test_type}")
+        return self._trigger_speedtest(response)
+
+    async def get_organization_configurations(self, organization_id: str) -> List[OrganizationConfigurationsResponse]:
+        """Get list of configurations for the organization."""
+        response = await self.client.get(f"/api/v1/organization/{organization_id}/configurations")
+        return self._get_organization_configurations(response)
+
+    async def get_organization_device_configuration(self, organization_id: str, orb_id: str) -> Dict[str, Any]:
+        """Get the current device configuration."""
+        response = await self.client.get(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration")
+        return self._get_organization_device_configuration(response)
+
+    async def patch_organization_device_configuration(self, organization_id: str, orb_id: str, config_patch: Dict[str, Any]) -> Dict[str, Any]:
+        """Patch the current device configuration and set it as an override for the device."""
+        response = await self.client.patch(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration", json=config_patch)
+        return self._patch_organization_device_configuration(response)
+
+    async def delete_organization_device_configuration(self, organization_id: str, orb_id: str, configuration_id: Optional[str] = None) -> Dict[str, Any]:
+        """Delete device configuration override. Optionally set a specific configuration to fallback to."""
+        body = {}
+        if configuration_id:
+            body = OrganizationDeviceConfigurationDeleteRequest(configuration_id=configuration_id).model_dump(exclude_none=True)
+        response = await self.client.delete(f"/api/v2/organization/{organization_id}/devices/{orb_id}/configuration", json=body if body else None)
+        return self._delete_organization_device_configuration(response)
+
+    async def push_organization_device_temp_datasets(self, organization_id: str, orb_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
+        """Enable temporary datasets for a specific device in the organization."""
+        response = await self.client.post(f"/api/v2/organization/{organization_id}/devices/{orb_id}/temp-datasets", json=temp_datasets_request.model_dump())
+        return self._push_organization_device_temp_datasets(response)
+
+    async def organization_device_trigger_speedtest(self, organization_id: str, orb_id: str, test_type: str) -> Dict[str, Any]:
+        """Trigger a speedtest on a specific device in the organization."""
+        response = await self.client.post(f"/api/v2/organization/{organization_id}/devices/{orb_id}/trigger-speedtest/{test_type}")
+        return self._organization_device_trigger_speedtest(response)
+
+    async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
+        """Make a raw async HTTP request for any other endpoints."""
+        return await self.client.request(method, endpoint, **kwargs)

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0}/orb_cloud_client/models/__init__.py

@@ -1,3 +1,3 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yaml
-#   timestamp: 2026-02-17T16:20:27+00:00
+#   timestamp: 2026-04-01T13:20:02+00:00

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0}/orb_cloud_client/models/config.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yaml
-#   timestamp: 2026-02-17T16:20:27+00:00
+#   timestamp: 2026-04-01T13:20:02+00:00
 
 from __future__ import annotations
 

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0}/orb_cloud_client/models/db.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yaml
-#   timestamp: 2026-02-17T16:20:27+00:00
+#   timestamp: 2026-04-01T13:20:02+00:00
 
 from __future__ import annotations
 
@@ -14,6 +14,7 @@ class AccountConfigEntitlements(BaseModel):
 class AccountPlanLimits(BaseModel):
     deployment_tokens: int | None = None
     devices: int | None = None
+    spaces: int | None = None
     users: int | None = None
 
 

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0}/orb_cloud_client/models/server.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  openapi.yaml
-#   timestamp: 2026-02-17T16:20:27+00:00
+#   timestamp: 2026-04-01T13:20:02+00:00
 
 from __future__ import annotations
 
@@ -25,6 +25,35 @@ class DeviceLinkOrganizationInvite(BaseModel):
     name: str | None = None
 
 
+class OrganizationConfigurationsResponse(BaseModel):
+    access_code: str | None = Field(
+        None, description='optional, the access code for this configuration'
+    )
+    access_code_expiration_ts: str | None = Field(
+        None, description='optional, expiration time for the access code'
+    )
+    config: list[int] | None = None
+    created_at: str | None = None
+    devices: int | None = Field(None, description='number of devices using this token')
+    id: str | None = None
+    is_revoked: bool | None = Field(
+        None, description='true if the token is revoked, false otherwise'
+    )
+    last_used_at: str | None = Field(
+        None, description='optional, if the token has been used'
+    )
+    name: str | None = None
+    tags: list[int] | None = None
+    token: str | None = None
+    updated_at: str | None = None
+
+
+class OrganizationDeviceConfigurationDeleteRequest(BaseModel):
+    configuration_id: str | None = Field(
+        None, description='optional ID of the configuration to delete'
+    )
+
+
 class OrganizationDeviceLink(BaseModel):
     expiration_ts: str | None = None
     invite: DeviceLinkOrganizationInvite | None = None
@@ -59,13 +88,22 @@ class OrganizationDeviceResponse(BaseModel):
     )
 
 
+class OrganizationManager(BaseModel):
+    icon_image_url: str | None = None
+    name: str | None = None
+    organization_id: str | None = None
+
+
 class DatasetsRequest(BaseModel):
     datasets_config: config_1.Datasets | None = None
     duration: str | None = None
 
 
 class OrganizationsResponse(BaseModel):
+    allocations: db.AccountPlanLimits | None = None
     customer_id: str | None = None
+    icon_image_url: str | None = None
+    manager: OrganizationManager | None = None
     name: str | None = None
     organization_id: str | None = None
     plan: db.AccountPlan | None = None

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0/orb_cloud_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orb-cloud-client
-Version: 1.3.3
+Version: 1.4.0
 Summary: Python client library for Orb Cloud API
 Author-email: Orb Networks <support@orb.net>
 License-Expression: MIT

{orb_cloud_client-1.3.3 → orb_cloud_client-1.4.0}/pyproject.toml

@@ -27,7 +27,7 @@ license = "MIT"
 name = "orb-cloud-client"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "1.3.3"
+version = "1.4.0"
 
 [project.optional-dependencies]
 dev = [

orb_cloud_client-1.3.3/orb_cloud_client/client.py

@@ -1,119 +0,0 @@
-"""
-Simple HTTP client for Orb Cloud API.
-"""
-
-import httpx
-from typing import Dict, Any, Optional, List
-
-from .models.generic import Device, TempDatasetsRequest, Organization
-
-class OrbCloudClientBase(object):
-    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
-        self.base_url = base_url.rstrip('/')
-        self.headers = {"Content-Type": "application/json"}
-        if token:
-            self.headers["Authorization"] = f"Bearer {token}"
-
-    def _get_organization_devices(self, response: httpx.Response) -> List[Device]:
-        """Get list of devices for the organization from a response."""
-        response.raise_for_status()
-        return [Device(**device) for device in response.json()]
-
-    def _configure_temporary_datasets(self, response: httpx.Response) -> Dict[str, Any]:
-        """Process the response for configuring temporary datasets."""
-        response.raise_for_status()
-        return response.json()
-
-    def _trigger_speedtest(self, response: httpx.Response) -> Dict[str, Any]:
-        """Process the response for triggering a speedtest."""
-        response.raise_for_status()
-        return response.json()
-
-    def _get_organizations(self, response: httpx.Response) -> List[Organization]:
-        """Get list of organizations accessible with the provided token."""
-        response.raise_for_status()
-        return [Organization(**org) for org in response.json()]
-
-class OrbCloudClient(OrbCloudClientBase):
-    """Simple HTTP client for Orb Cloud API."""
-
-    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
-        super().__init__(base_url, token)
-        self.client = httpx.Client(base_url=self.base_url, headers=self.headers)
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.client.close()
-
-    def close(self):
-        """Close the HTTP client."""
-        self.client.close()
-
-    def get_organization_devices(self, organization_id: str) -> List[Device]:
-        """Get list of devices for the organization."""
-        response = self.client.get(f"/api/v2/organization/{organization_id}/devices")
-        return self._get_organization_devices(response)
-
-    def configure_temporary_datasets(self, device_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
-        """Enable temporary data reporting to a custom endpoint with a given config for a specified duration."""
-        response = self.client.post(f"/api/v1/device/{device_id}/temp-datasets", json=temp_datasets_request.model_dump())
-        return self._configure_temporary_datasets(response)
-
-    def get_organizations(self) -> List[Organization]:
-        """Get list of organizations accessible with the provided token."""
-        response = self.client.get("/api/v2/organizations")
-        return self._get_organizations(response)
-
-    def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
-        """Trigger a content or top speedtest"""
-        response = self.client.post(f"/api/v2/device/{device_id}/trigger-speedtest/{test_type}")
-        return self._trigger_speedtest(response)
-
-
-    def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
-        """Make a raw HTTP request for any other endpoints."""
-        return self.client.request(method, endpoint, **kwargs)
-
-
-class OrbCloudClientAsync(OrbCloudClientBase):
-    """Simple async HTTP client for Orb Cloud API."""
-
-    def __init__(self, base_url: str = "https://panel.orb.net", token: Optional[str] = None):
-        super().__init__(base_url, token)
-        self.client = httpx.AsyncClient(base_url=self.base_url, headers=self.headers)
-
-    async def __aenter__(self):
-        return self
-
-    async def __aexit__(self, exc_type, exc_val, exc_tb):
-        await self.client.aclose()
-
-    async def close(self):
-        """Close the HTTP client."""
-        await self.client.aclose()
-
-    async def get_organization_devices(self, organization_id: str) -> List[Device]:
-        """Get list of devices for the organization."""
-        response = await self.client.get(f"/api/v2/organization/{organization_id}/devices")
-        return self._get_organization_devices(response)
-
-    async def configure_temporary_datasets(self, device_id: str, temp_datasets_request: TempDatasetsRequest) -> Dict[str, Any]:
-        """Enable temporary data reporting to a custom endpoint with a given config for a specified duration."""
-        response = await self.client.post(f"/api/v1/device/{device_id}/temp-datasets", json=temp_datasets_request.model_dump())
-        return self._configure_temporary_datasets(response)
-
-    async def get_organizations(self) -> List[Organization]:
-        """Get list of organizations accessible with the provided token."""
-        response = await self.client.get("/api/v2/organizations")
-        return self._get_organizations(response)
-
-    async def trigger_speedtest(self, device_id: str, test_type: str) -> Dict[str, Any]:
-        """Trigger a content or top speedtest"""
-        response = await self.client.post(f"/api/v2/device/{device_id}/trigger-speedtest/{test_type}")
-        return self._trigger_speedtest(response)
-
-    async def request(self, method: str, endpoint: str, **kwargs) -> httpx.Response:
-        """Make a raw async HTTP request for any other endpoints."""
-        return await self.client.request(method, endpoint, **kwargs)