vobiz-python 0.1.0__py3-none-any.whl

vobiz/resources/cdrs.py

@@ -0,0 +1,46 @@
+from typing import Any, Dict, Optional
+
+VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+
+
+class CDRs:
+    """
+    Vobiz Call Detail Records (CDRs) resource.
+
+    Endpoint: https://api.vobiz.ai/api/v1/account/{account_id}/cdr
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    @property
+    def _account_id(self) -> str:
+        return self.client.auth_id
+
+    def list(
+        self,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        start_date: Optional[str] = None,
+        end_date: Optional[str] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{account_id}/cdr
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/cdr"
+        params: Dict[str, Any] = {}
+        if page is not None:
+            params["page"] = page
+        if per_page is not None:
+            params["per_page"] = per_page
+        if start_date is not None:
+            params["start_date"] = start_date
+        if end_date is not None:
+            params["end_date"] = end_date
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)

vobiz/resources/credentials.py

@@ -0,0 +1,104 @@
+from typing import Any, Dict, Optional
+
+VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+
+
+class Credentials:
+    """
+    Vobiz SIP Credentials resource.
+
+    All endpoints are scoped to the authenticated account.
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    @property
+    def _account_id(self) -> str:
+        # For Vobiz, we treat the RestClient auth_id as the account_id
+        return self.client.auth_id
+
+    def create(
+        self,
+        username: str,
+        password: str,
+        enabled: Optional[bool] = None,
+        description: Optional[str] = None,
+        **extra: Any,
+    ):
+        """
+        POST /api/v1/account/{account_id}/credentials
+
+        Create a new SIP credential (username/password) for the account.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/credentials"
+        body: Dict[str, Any] = {
+            "username": username,
+            "password": password,
+        }
+        if enabled is not None:
+            body["enabled"] = enabled
+        if description is not None:
+            body["description"] = description
+        body.update(extra)
+
+        resp = self.client.session.post(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("POST", resp)
+
+    def list(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{account_id}/trunks/credentials
+
+        Retrieve a paginated list of all credentials associated with the account.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/trunks/credentials"
+        params: Dict[str, Any] = {}
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def get(self, credential_id: str):
+        """
+        GET /api/v1/account/{account_id}/credentials/{credential_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/credentials/{credential_id}"
+        resp = self.client.session.get(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def update(self, credential_id: str, **params: Any):
+        """
+        PUT /api/v1/account/{account_id}/credentials/{credential_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/credentials/{credential_id}"
+        body: Dict[str, Any] = dict(params)
+        resp = self.client.session.put(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("PUT", resp)
+
+    def delete(self, credential_id: str):
+        """
+        DELETE /api/v1/account/{account_id}/credentials/{credential_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/credentials/{credential_id}"
+        resp = self.client.session.delete(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("DELETE", resp)
+

vobiz/resources/endpoints.py

@@ -0,0 +1,101 @@
+from typing import Any, Dict, Optional
+
+
+class Endpoints:
+    """
+    Vobiz Endpoints (SIP endpoints / devices) resource.
+
+    Uses the `/v1/Account/{auth_id}/Endpoint/...` paths described in the
+    Vobiz endpoint documentation.
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    def create(
+        self,
+        username: str,
+        password: str,
+        alias: Optional[str] = None,
+        application: Optional[str] = None,
+        **extra: Any,
+    ):
+        """
+        POST /v1/Account/{auth_id}/Endpoint/
+
+        Create a new SIP endpoint.
+        """
+        body: Dict[str, Any] = {
+            "username": username,
+            "password": password,
+        }
+        if alias is not None:
+            body["alias"] = alias
+        if application is not None:
+            body["application"] = application
+        body.update(extra)
+
+        return self.client.request(
+            "POST",
+            ("Endpoint",),
+            data=body,
+        )
+
+    def list(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        **filters: Any,
+    ):
+        """
+        GET /v1/Account/{auth_id}/Endpoint/
+
+        Retrieve a paginated list of all SIP endpoints in the account.
+        """
+        params: Dict[str, Any] = {}
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        params.update(filters)
+
+        return self.client.request(
+            "GET",
+            ("Endpoint",),
+            data=params,
+        )
+
+    def get(self, endpoint_id: str):
+        """
+        GET /v1/Account/{auth_id}/Endpoint/{endpoint_id}/
+
+        Retrieve details for a specific endpoint.
+        """
+        return self.client.request(
+            "GET",
+            ("Endpoint", endpoint_id),
+        )
+
+    def update(self, endpoint_id: str, **params: Any):
+        """
+        POST /v1/Account/{auth_id}/Endpoint/{endpoint_id}/
+
+        Update an endpoint's password, alias, application, or permissions.
+        """
+        body: Dict[str, Any] = dict(params)
+        return self.client.request(
+            "POST",
+            ("Endpoint", endpoint_id),
+            data=body,
+        )
+
+    def delete(self, endpoint_id: str):
+        """
+        DELETE /v1/Account/{auth_id}/Endpoint/{endpoint_id}/
+
+        Delete an endpoint. On success, the API returns 204 No Content.
+        """
+        return self.client.request(
+            "DELETE",
+            ("Endpoint", endpoint_id),
+        )

vobiz/resources/ip_access_control_lists.py

@@ -0,0 +1,100 @@
+from typing import Any, Dict, Optional
+
+VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+
+
+class IpAccessControlLists:
+    """
+    Vobiz IP Access Control Lists resource.
+
+    All endpoints are scoped to the authenticated account.
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    @property
+    def _account_id(self) -> str:
+        # For Vobiz, we treat the RestClient auth_id as the account_id
+        return self.client.auth_id
+
+    def create(
+        self,
+        ip_address: str,
+        description: Optional[str] = None,
+        enabled: Optional[bool] = None,
+        **extra: Any,
+    ):
+        """
+        POST /api/v1/account/{account_id}/ip-acl
+
+        Create a new IP ACL entry.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/ip-acl"
+        body: Dict[str, Any] = {"ip_address": ip_address}
+        if description is not None:
+            body["description"] = description
+        if enabled is not None:
+            body["enabled"] = enabled
+        body.update(extra)
+
+        resp = self.client.session.post(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("POST", resp)
+
+    def list(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{account_id}/trunks/ip-acl
+
+        Retrieve a paginated list of all IP ACL entries.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/trunks/ip-acl"
+        params: Dict[str, Any] = {}
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def get(self, acl_id: str):
+        """
+        GET /api/v1/account/{account_id}/ip-acl/{ip_acl_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/ip-acl/{acl_id}"
+        resp = self.client.session.get(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def update(self, acl_id: str, **params: Any):
+        """
+        PUT /api/v1/account/{account_id}/ip-acl/{ip_acl_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/ip-acl/{acl_id}"
+        body: Dict[str, Any] = dict(params)
+        resp = self.client.session.put(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("PUT", resp)
+
+    def delete(self, acl_id: str):
+        """
+        DELETE /api/v1/account/{account_id}/ip-acl/{ip_acl_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/ip-acl/{acl_id}"
+        resp = self.client.session.delete(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("DELETE", resp)
+

vobiz/resources/numbers.py

@@ -0,0 +1,134 @@
+from typing import Any, Dict, Optional
+
+VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+
+
+class PhoneNumbers:
+    """
+    Vobiz Phone Numbers resource.
+
+    Implements inventory listing, purchase from inventory, and release,
+    as defined in the Vobiz phone number endpoints.
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    @property
+    def _account_id(self) -> str:
+        # For Vobiz, we treat the RestClient auth_id as the account_id
+        return self.client.auth_id
+
+    def list(
+        self,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        include_subaccounts: Optional[bool] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{auth_id}/numbers
+
+        List all phone numbers purchased and assigned to this account.
+        include_subaccounts: if True, also returns numbers from sub-accounts (master accounts only).
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/numbers"
+        params: Dict[str, Any] = {}
+        if page is not None:
+            params["page"] = page
+        if per_page is not None:
+            params["per_page"] = per_page
+        if include_subaccounts is not None:
+            params["include_subaccounts"] = include_subaccounts
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def list_inventory(        self,
+        country: Optional[str] = None,
+        page: Optional[int] = None,
+        per_page: Optional[int] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{auth_id}/inventory/numbers
+
+        Browse available phone numbers in inventory that are not assigned
+        to any account (auth_id IS NULL, status='active').
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/inventory/numbers"
+        params: Dict[str, Any] = {}
+        if country is not None:
+            params["country"] = country
+        if page is not None:
+            params["page"] = page
+        if per_page is not None:
+            params["per_page"] = per_page
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def purchase_from_inventory(
+        self,
+        e164: str,
+        currency: Optional[str] = None,
+        **extra: Any,
+    ):
+        """
+        POST /api/v1/account/{auth_id}/numbers/purchase-from-inventory
+
+        Purchase a phone number from inventory and assign it to the account.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/numbers/purchase-from-inventory"
+        body: Dict[str, Any] = {"e164": e164}
+        if currency is not None:
+            body["currency"] = currency
+        body.update(extra)
+
+        resp = self.client.session.post(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("POST", resp)
+
+    def release(self, e164_number: str):
+        """
+        DELETE /api/v1/account/{auth_id}/numbers/{e164_number}
+
+        Release a phone number from the account back to inventory.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/numbers/{e164_number}"
+        resp = self.client.session.delete(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("DELETE", resp)
+
+    def assign_to_trunk(self, e164_number: str, trunk_group_id: str):
+        """
+        POST /api/v1/account/{account_id}/numbers/{PHONE_NUMBER}/assign
+
+        Assign a phone number to a SIP trunk.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/numbers/{e164_number}/assign"
+        body: Dict[str, Any] = {"trunk_group_id": trunk_group_id}
+        resp = self.client.session.post(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("POST", resp)
+
+    def unassign_from_trunk(self, e164_number: str):
+        """
+        DELETE /api/v1/account/{account_id}/numbers/{PHONE_NUMBER}/assign
+
+        Unassign a phone number from its SIP trunk.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/numbers/{e164_number}/assign"
+        resp = self.client.session.delete(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("DELETE", resp)

vobiz/resources/origination_uris.py

@@ -0,0 +1,109 @@
+from typing import Any, Dict, Optional
+
+VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+
+
+class OriginationUris:
+    """
+    Vobiz Origination URIs resource.
+
+    Implements create, list, update, and delete operations using the
+    `/api/v1/account/{account_id}/origination-uris` and
+    `/api/v1/account/{account_id}/trunks/origination-uris` endpoints.
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    @property
+    def _account_id(self) -> str:
+        # For Vobiz, we treat the RestClient auth_id as the account_id
+        return self.client.auth_id
+
+    def create(
+        self,
+        uri: str,
+        priority: Optional[int] = None,
+        weight: Optional[int] = None,
+        enabled: Optional[bool] = None,
+        **extra: Any,
+    ):
+        """
+        POST /api/v1/account/{account_id}/origination-uris
+
+        Create a new origination URI for outbound routing.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/origination-uris"
+        body: Dict[str, Any] = {"uri": uri}
+        if priority is not None:
+            body["priority"] = priority
+        if weight is not None:
+            body["weight"] = weight
+        if enabled is not None:
+            body["enabled"] = enabled
+        body.update(extra)
+
+        resp = self.client.session.post(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("POST", resp)
+
+    def list(
+        self,
+        trunk_id: Optional[str] = None,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/account/{account_id}/trunks/origination-uris
+
+        Retrieve a paginated list of origination URIs.
+        Optionally filter by trunk_id.
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/trunks/origination-uris"
+        params: Dict[str, Any] = {}
+        if trunk_id is not None:
+            params["trunk_id"] = trunk_id
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        params.update(filters)
+
+        resp = self.client.session.get(
+            url, params=params, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def get(self, uri_id: str):
+        """
+        GET /api/v1/account/{account_id}/origination-uris/{uri_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/origination-uris/{uri_id}"
+        resp = self.client.session.get(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("GET", resp)
+
+    def update(self, uri_id: str, **params: Any):
+        """
+        PUT /api/v1/account/{account_id}/origination-uris/{uri_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/origination-uris/{uri_id}"
+        body: Dict[str, Any] = dict(params)
+        resp = self.client.session.put(
+            url, json=body, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("PUT", resp)
+
+    def delete(self, uri_id: str):
+        """
+        DELETE /api/v1/account/{account_id}/origination-uris/{uri_id}
+        """
+        url = f"{VOBIZ_API_V1}/account/{self._account_id}/origination-uris/{uri_id}"
+        resp = self.client.session.delete(
+            url, timeout=self.client.timeout, proxies=self.client.proxies
+        )
+        return self.client.process_response("DELETE", resp)
+

vobiz/resources/recordings.py

@@ -0,0 +1,91 @@
+from typing import Any, Dict, Optional
+
+
+class Recordings:
+    """
+    Vobiz Recordings resource.
+
+    Endpoint: https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/
+    """
+
+    def __init__(self, client):
+        self.client = client
+
+    def list(
+        self,
+        limit: Optional[int] = None,
+        offset: Optional[int] = None,
+        call_uuid: Optional[str] = None,
+        recording_type: Optional[str] = None,
+        **filters: Any,
+    ):
+        """
+        GET /api/v1/Account/{auth_id}/Recording/
+        """
+        params: Dict[str, Any] = {}
+        if limit is not None:
+            params["limit"] = limit
+        if offset is not None:
+            params["offset"] = offset
+        if call_uuid is not None:
+            params["call_uuid"] = call_uuid
+        if recording_type is not None:
+            params["recording_type"] = recording_type
+        params.update(filters)
+
+        return self.client.request("GET", ("Recording",), data=params)
+
+    def get(self, recording_id: str):
+        """
+        GET /api/v1/Account/{auth_id}/Recording/{recording_id}/
+        """
+        return self.client.request("GET", ("Recording", recording_id))
+
+    def delete(self, recording_id: str):
+        """
+        DELETE /api/v1/Account/{auth_id}/Recording/{recording_id}/
+        """
+        return self.client.request("DELETE", ("Recording", recording_id))
+
+    def export(self, recipient_emails: list, **filters: Any):
+        """
+        POST /api/v1/Account/{auth_id}/export/recording/
+
+        Async export — recordings matching filters are packaged and emailed.
+        recipient_emails: list of email addresses to receive the download link.
+
+        Date range filters (use one or the other, not both):
+          from_date / to_date  — e.g. "2025-01-01 00:00:00"
+          recording_storage_duration — exact days old
+          recording_storage_duration__gte / __lte — range of days old
+
+        Optional additional filters (only for ranges <= 30 days):
+          from_number, to_number, conference_name, recording_format ("mp3"/"wav")
+        """
+        VOBIZ_API_V1 = "https://api.vobiz.ai/api/v1"
+        url = f"{VOBIZ_API_V1}/Account/{self.client.auth_id}/export/recording/"
+        body: Dict[str, Any] = {
+            "recipient": {"customer_account": recipient_emails}
+        }
+        body.update(filters)
+        resp = self.client.session.post(
+            url, json=body,
+            timeout=self.client.timeout,
+            proxies=self.client.proxies,
+        )
+        return self.client.process_response("POST", resp)
+
+    def bulk_delete(self, **filters: Any):
+        """
+        DELETE /api/v1/Account/{auth_id}/Recording/BulkDelete/
+
+        Async bulk delete — permanently removes all recordings matching filters.
+        At least one filter is recommended to avoid deleting everything.
+
+        Filter params (as query string kwargs):
+          add_time__gte / add_time__lte  — "YYYY-MM-DD HH:MM:SS"
+          conference_name, recording_format, from_number, to_number
+        """
+        return self.client.request(
+            "DELETE", ("Recording", "BulkDelete"), data=filters
+        )