add new structure

Author: maxkahan

pants.toml

@@ -1,5 +1,5 @@
 [GLOBAL]
-pants_version = '2.21.0'
+pants_version = '2.21.1'
 
 backend_packages = [
   'pants.backend.python',
@@ -42,6 +42,7 @@ filter = [
   'number_insight/src',
   'number_insight_v2/src',
   'sms/src',
+  'subaccounts/src',
   'users/src',
   'utils/src',
   'testutils',

subaccounts/BUILD

@@ -0,0 +1,16 @@
+resource(name='pyproject', source='pyproject.toml')
+file(name='readme', source='README.md')
+
+files(sources=['tests/data/*'])
+
+python_distribution(
+    name='vonage-subaccounts',
+    dependencies=[
+        ':pyproject',
+        ':readme',
+        'subaccounts/src/vonage_subaccounts',
+    ],
+    provides=python_artifact(),
+    generate_setup=False,
+    repositories=['@pypi'],
+)

subaccounts/CHANGES.md

@@ -0,0 +1,2 @@
+# 1.0.0
+- Initial upload

subaccounts/README.md

@@ -0,0 +1,66 @@
+# Vonage Subaccount Package
+
+This package contains the code to use Vonage's Subaccount API in Python.
+
+It includes methods for managing Vonage subaccounts.
+
+## Usage
+
+It is recommended to use this as part of the main `vonage` package. The examples below assume you've created an instance of the `vonage.Vonage` class called `vonage_client`.
+
+
+<!-- ### Get Account Balance
+
+```python
+balance = vonage_client.account.get_balance()
+print(balance)
+```
+
+### Top-Up Account
+
+```python
+response = vonage_client.account.top_up(trx='1234567890')
+print(response)
+```
+
+### Update the Default SMS Webhook
+
+This will return a Pydantic object (`SettingsResponse`) containing multiple settings for your account.
+
+```python
+settings: SettingsResponse = vonage_client.account.update_default_sms_webhook(
+    mo_callback_url='https://example.com/inbound_sms_webhook',
+    dr_callback_url='https://example.com/delivery_receipt_webhook',
+)
+
+print(settings)
+```
+
+### List Secrets Associated with the Account
+
+```python
+response = vonage_client.account.list_secrets()
+print(response)
+```
+
+### Create a New Account Secret
+
+```python
+secret = vonage_client.account.create_secret('Mytestsecret12345')
+print(secret)
+```
+
+### Get Information About One Secret
+
+```python
+secret = vonage_client.account.get_secret(MY_SECRET_ID)
+print(secret)
+```
+
+### Revoke a Secret
+
+Note: it isn't possible to revoke all account secrets, there must always be one valid secret. Attempting to do so will give a 403 error.
+
+```python
+client.account.revoke_secret(MY_SECRET_ID)
+``` -->

subaccounts/pyproject.toml

@@ -0,0 +1,29 @@
+[project]
+name = 'vonage-subaccounts'
+version = '1.0.0'
+description = 'Vonage Subaccounts API package'
+readme = "README.md"
+authors = [{ name = "Vonage", email = "[email protected]" }]
+requires-python = ">=3.8"
+dependencies = [
+  "vonage-http-client>=1.4.0",
+  "vonage-utils>=1.1.2",
+  "pydantic>=2.7.1",
+]
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: Apache Software License",
+]
+
+[project.urls]
+homepage = "https://github.com/Vonage/vonage-python-sdk"
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

subaccounts/src/vonage_subaccounts/BUILD

@@ -0,0 +1 @@
+python_sources()

subaccounts/src/vonage_subaccounts/__init__.py

@@ -0,0 +1,5 @@
+from .subaccounts import Subaccounts
+
+__all__ = [
+    'Subaccounts',
+]

subaccounts/src/vonage_subaccounts/errors.py

@@ -0,0 +1,5 @@
+from vonage_utils.errors import VonageError
+
+
+class SubaccountsError(VonageError):
+    """Indicates an error with the Subaccounts API package."""

subaccounts/src/vonage_subaccounts/responses.py

@@ -0,0 +1,21 @@
+from datetime import datetime
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class VonageAccount(BaseModel):
+    api_key: str
+    name: str
+    primary_account_api_key: str
+    use_primary_account_balance: bool
+    created_at: datetime
+    suspended: bool
+    balance: Optional[float]
+    credit_limit: Optional[float]
+
+
+class PrimaryAccount(VonageAccount): ...
+
+
+class Subaccount(VonageAccount): ...

subaccounts/src/vonage_subaccounts/subaccounts.py

@@ -0,0 +1,44 @@
+from typing import List, Union
+from pydantic import validate_call
+from vonage_http_client.http_client import HttpClient
+
+# from .responses import Balance, SettingsResponse, TopUpResponse, VonageApiSecret
+
+
+class Subaccounts:
+    """Class containing methods to manage Vonage subaccounts."""
+
+    def __init__(self, http_client: HttpClient) -> None:
+        self._http_client = http_client
+        self._auth_type = 'basic'
+
+    @property
+    def http_client(self) -> HttpClient:
+        """The HTTP client used to make requests to the Users API.
+
+        Returns:
+            HttpClient: The HTTP client used to make requests to the Users API.
+        """
+        return self._http_client
+
+    def list_subaccounts(self) -> Tuple[PrimaryAccount, List[Subaccount]]:
+        """List all subaccounts associated with the primary account.
+
+        Returns:
+            List[Union[PrimaryAccount, Subaccount]]: List of PrimaryAccount and Subaccount objects.
+        """
+        response = self._http_client.get(
+            self._http_client.api_host,
+            f'/accounts/{self._http_client.auth.api_key}/subaccounts',
+            auth_type=self._auth_type,
+        )
+        accounts = []
+        # accounts.append(PrimaryAccount(**response['_embedded']['account']))
+
+        # for element in response['_embedded']['accounts']:
+        #     if element['type'] == 'PRIMARY':
+        #         accounts.append(PrimaryAccount(**element))
+        #     else:
+        #         accounts.append(Subaccount(**element))
+
+        # return accounts