update account snippets for v4, add subaccounts snippets

Author: maxkahan

.env.dist

@@ -31,13 +31,13 @@ MESSAGES_SANDBOX_VIBER_SERVICE_ID=
 VONAGE_SIGNATURE_SECRET=
 VONAGE_SIGNATURE_SECRET_METHOD=
 
-# Verify v2
+# Verify
 TO_EMAIL='EMAIL_ADDRESS_TO_VERIFY'
 REQUEST_ID='REQUEST_ID'
 BRAND_NAME='Acme. Inc'
 CODE='CODE_SENT_TO_THE_USER'
 
-# Verify
+# Verify (Legacy)
 WORKFLOW_ID=1
 
 # Number Insight
@@ -53,7 +53,15 @@ BRAND_TEXT='YOUR_BRAND_NAME'
 
 # Account
 SMS_CALLBACK_URL='YOUR_CALLBACK_URL'
-VONAGE_SECRET_ID='YOUR_VONAGE_SECRET_ID'
+NEW_SECRET='YOUR_NEW_SECRET_ID'
+VONAGE_SECRET_ID='YOUR_SECRET_ID'
+
+# Subaccounts
+NEW_SUBACCOUNT_NAME='NEW_SUBACCOUNT_NAME'
+NEW_SUBACCOUNT_SECRET='NEW_SUBACCOUNT_SECRET'
+SUBACCOUNT_KEY='SUBACCOUNT_KEY'
+AMOUNT=0.00
+START_DATE='START_DATE'
 
 # Voice
 CONFERENCE_NAME='NAME_OF_YOUR_CONFERENCE'
@@ -68,8 +76,4 @@ VONAGE_NUMBER_FEATURES='SMS,VOICE'
 MESSAGES_APPLICATION_ID='12a3b4cd-a1b2-1ab2-a1b2-a1234bc5d678'
 VOICE_CALLBACK_TYPE='tel'
 VOICE_CALLBACK_VALUE='447700900002'
-VOICE_STATUS_URL='https://example.com/webhooks/status'
-
-# Redact
-VONAGE_REDACT_ID=
-VONAGE_REDACT_TYPE=
+VOICE_STATUS_URL='https://example.com/webhooks/status'

.github/workflows/linter.yml

@@ -28,11 +28,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.13
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.13'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.gitignore

@@ -81,6 +81,7 @@ celerybeat-schedule
 # virtualenv
 venv*/
 ENV/
+.venv*/
 
 # Spyder project settings
 .spyderproject

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Vonage Community
+Copyright (c) 2024 Vonage Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,17 +8,12 @@
 ![Last Commit](https://img.shields.io/github/last-commit/Vonage/vonage-python-code-snippets)
 ![Size](https://img.shields.io/github/repo-size/Vonage/vonage-python-code-snippets)
 
-<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
-
-Code snippets also available for: [Java](https://github.com/nexmo/nexmo-java-code-snippets), [.NET](https://github.com/nexmo/nexmo-dotnet-code-snippets), [Node.js](https://github.com/nexmo/nexmo-node-code-snippets), [PHP](https://github.com/nexmo/nexmo-php-code-snippets), [Ruby](https://github.com/nexmo/nexmo-ruby-code-snippets), [Curl](https://github.com/Nexmo/nexmo-curl-code-snippets), [Go](https://github.com/Vonage/vonage-go-code-snippets) and [Android](https://github.com/nexmo-community/quickstart-android)
-
-The purpose of the Code Snippets is to provide simple examples focused
-on one goal. For example, sending an SMS, handling an incoming SMS webhook,
-or making a Text to Speech call.
+The purpose of these Code Snippets is to provide simple examples focused
+on one goal. For example, sending an SMS, creating a Vonage Video API session, handling an incoming webhook, or making a Text-to-Speech call.
 
 ## Setup
 
-These code samples are meant to be used for [https://developer.vonage.com/](https://developer.vonage.com/), and are structured in such a way as to be used for internal testing. Developers are free to use these code snippets as a reference, but these may require changes to be worked into your specific application. We recommend checking out the [Vonage Developer Website](https://developer.vonage.com/), which displays these code snippets in a more copy/paste fashion.
+These code samples are meant to be embedded into pages on [https://developer.vonage.com/](https://developer.vonage.com/). Developers are free to use these code snippets as a reference, but these may require changes to be worked into your specific application. We recommend checking out the [Vonage Developer Website](https://developer.vonage.com/), which displays these code snippets in a more copy/paste fashion.
 
 To use the examples, you will first need a [Vonage account][sign-up]. Then rename
 the `.env.dist` file to `.env` and set the values as required.

account/configure-account.py

@@ -1,7 +1,6 @@
 import os
 from os.path import join, dirname
 from pprint import pprint
-import vonage
 from dotenv import load_dotenv
 
 dotenv_path = join(dirname(__file__), '../.env')
@@ -11,7 +10,13 @@
 VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
 SMS_CALLBACK_URL = os.getenv('SMS_CALLBACK_URL')
 
-client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
+from vonage import Auth, Vonage
+from vonage_account import SettingsResponse
 
-result = client.account.update_default_sms_webhook({'moCallBackUrl':SMS_CALLBACK_URL})
-pprint(result)
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+settings: SettingsResponse = client.account.update_default_sms_webhook(
+    mo_callback_url=SMS_CALLBACK_URL
+)
+
+print(settings)

account/create-secret.py

@@ -0,0 +1,19 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
+VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
+NEW_SECRET = os.getenv('NEW_SECRET')
+
+from vonage import Auth, Vonage
+from vonage_account import VonageApiSecret
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+response: VonageApiSecret = client.account.create_secret(NEW_SECRET)
+print(response)

secrets/fetch-a-secret.py renamed to account/fetch-a-secret.py

@@ -1,6 +1,5 @@
 import os
 from os.path import join, dirname
-import vonage
 from dotenv import load_dotenv
 
 dotenv_path = join(dirname(__file__), "../.env")
@@ -9,7 +8,12 @@
 VONAGE_API_KEY = os.environ.get("VONAGE_API_KEY")
 VONAGE_API_SECRET = os.environ.get("VONAGE_API_SECRET")
 VONAGE_SECRET_ID = os.environ.get("VONAGE_SECRET_ID")
-client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
 
-secret = client.account.get_secret(api_key=VONAGE_API_KEY, secret_id=VONAGE_SECRET_ID)
-print(secret["id"] + ": Created on " + secret["created_at"])
+from vonage import Auth, Vonage
+from vonage_account import VonageApiSecret
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+secret: VonageApiSecret = client.account.get_secret(VONAGE_SECRET_ID)
+
+print(f'Secret ID: {secret.id}; Created at {secret.created_at}')

account/get-balance.py

@@ -1,15 +1,18 @@
 import os
 from os.path import join, dirname
 from dotenv import load_dotenv
-import vonage
 
 dotenv_path = join(dirname(__file__), '../.env')
 load_dotenv(dotenv_path)
 
 VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
 VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
 
-client = vonage.Client(key=VONAGE_API_KEY, secret=VONAGE_API_SECRET)
+from vonage import Auth, Vonage
+from vonage_account import Balance
 
-result = client.account.get_balance()
-print(f"{result['value']:0.2f} EUR")
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+balance: Balance = client.account.get_balance()
+
+print(f'{balance.value:0.2f} EUR, auto-reload: {balance.auto_reload}')

account/list-all-secrets.py

@@ -0,0 +1,17 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+dotenv_path = join(dirname(__file__), "../.env")
+load_dotenv(dotenv_path)
+
+VONAGE_API_KEY = os.environ.get("VONAGE_API_KEY")
+VONAGE_API_SECRET = os.environ.get("VONAGE_API_SECRET")
+
+from vonage import Auth, Vonage
+from vonage_account import VonageApiSecret
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+response: list[VonageApiSecret] = client.account.list_secrets()
+print(response)

account/revoke-secret.py

@@ -0,0 +1,16 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.environ.get("VONAGE_API_KEY")
+VONAGE_API_SECRET = os.environ.get("VONAGE_API_SECRET")
+VONAGE_SECRET_ID = os.getenv("VONAGE_SECRET_ID")
+
+from vonage import Auth, Vonage
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+client.account.revoke_secret(VONAGE_SECRET_ID)

secrets/create-secret.py

@@ -0,0 +1,27 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
+VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
+NEW_SUBACCOUNT_NAME = os.getenv('NEW_SUBACCOUNT_NAME')
+NEW_SUBACCOUNT_SECRET = os.getenv('NEW_SUBACCOUNT_SECRET')
+
+from vonage import Auth, Vonage
+from vonage_subaccounts import NewSubaccount, SubaccountOptions
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+response: NewSubaccount = client.subaccounts.create_subaccount(
+    SubaccountOptions(
+        name=NEW_SUBACCOUNT_NAME,
+        secret=NEW_SUBACCOUNT_SECRET,
+        use_primary_account_balance=False,
+    )
+)
+
+print(response)

secrets/list-all-secrets.py

@@ -0,0 +1,20 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
+VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
+SUBACCOUNT_KEY = os.getenv('SUBACCOUNT_KEY')
+
+from vonage import Auth, Vonage
+from vonage_subaccounts import Subaccount
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+subaccount: Subaccount = client.subaccounts.get_subaccount(SUBACCOUNT_KEY)
+
+print(subaccount)

secrets/revoke-secret.py

@@ -0,0 +1,22 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
+VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
+START_DATE = os.getenv("START_DATE")
+
+from vonage import Auth, Vonage
+from vonage_subaccounts import ListTransfersFilter, Transfer
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+response: list[Transfer] = client.subaccounts.list_balance_transfers(
+    ListTransfersFilter(start_date=START_DATE)
+)
+
+print(response)

subaccounts/create-subaccount.py

@@ -0,0 +1,22 @@
+import os
+from os.path import join, dirname
+from dotenv import load_dotenv
+
+# Load the environment
+envpath = join(dirname(__file__), "../.env")
+load_dotenv(envpath)
+
+VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
+VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
+START_DATE = os.getenv("START_DATE")
+
+from vonage import Auth, Vonage
+from vonage_subaccounts import ListTransfersFilter, Transfer
+
+client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))
+
+response: list[Transfer] = client.subaccounts.list_credit_transfers(
+    ListTransfersFilter(start_date=START_DATE)
+)
+
+print(response)