start updating snippet env variable names

Author: maxkahan

.env.dist

@@ -1,13 +1,110 @@
-# Authentication
-VONAGE_API_KEY='YOUR_API_KEY'
-VONAGE_API_SECRET='YOUR_API_SECRET'
-VONAGE_APPLICATION_ID='12a3b4cd-a1b2-1ab2-a1b2-a1234bc5d678'
-VONAGE_APPLICATION_PRIVATE_KEY_PATH='PATH_TO_KEY_FILE'
+# General
+VONAGE_API_KEY='VONAGE_API_KEY'
+VONAGE_API_SECRET='VONAGE_API_SECRET'
+VONAGE_APPLICATION_ID='VONAGE_APPLICATION_ID'
+VONAGE_PRIVATE_KEY='VONAGE_PRIVATE_KEY'
+VONAGE_SIGNATURE_SECRET='VONAGE_SIGNATURE_SECRET'
+VONAGE_VIRTUAL_NUMBER='VONAGE_VIRTUAL_NUMBER'
+
+# Account
+ACCOUNT_ID='ACCOUNT_ID'
+ACCOUNT_SECRET_VALUE='ACCOUNT_SECRET_VALUE'
+ACCOUNT_SECRET_ID='ACCOUNT_SECRET_ID'
+ACCOUNT_SMS_CALLBACK_URL='ACCOUNT_SMS_CALLBACK_URL'
+
+# Application and Users
+APPLICATION_NAME='APPLICATION_NAME'
+USER_ID='USER_ID'
+USER_NAME='USER_NAME'
+USER_DISPLAY_NAME='USER_DISPLAY_NAME'
 
 # Messages
-TO_NUMBER='EXAMPLE_TO_NUMBER'
-RECIPIENT_NUMBER='EXAMPLE_RECIPIENT_NUMBER'
-FROM_NUMBER='EXAMPLE_FROM_NUMBER'
+MESSAGES_TO_NUMBER='MESSAGES_TO_NUMBER'
+MESSAGES_API_URL='MESSAGES_API_URL'
+GEOSPECIFIC_MESSAGES_API_URL='GEOSPECIFIC_MESSAGES_API_URL'
+MESSAGES_MESSAGE_ID='MESSAGES_MESSAGE_ID'
+SMS_SENDER_ID='SMS_SENDER_ID'
+MMS_SENDER_ID='MMS_SENDER_ID'
+RCS_SENDER_ID='RCS_SENDER_ID'
+WHATSAPP_SENDER_ID='WHATSAPP_SENDER_ID'
+WHATSAPP_TEMPLATE_NAME='WHATSAPP_TEMPLATE_NAME'
+WHATSAPP_CATALOG_ID='WHATSAPP_CATALOG_ID'
+WHATSAPP_PRODUCT_ID_1='WHATSAPP_PRODUCT_ID_1'
+WHATSAPP_PRODUCT_ID_2='WHATSAPP_PRODUCT_ID_2'
+WHATSAPP_OTP='WHATSAPP_OTP'
+MESSENGER_RECIPIENT_ID='MESSENGER_RECIPIENT_ID'
+MESSENGER_SENDER_ID='MESSENGER_SENDER_ID'
+VIBER_SENDER_ID='VIBER_SENDER_ID'
+MESSAGES_IMAGE_URL='MESSAGES_IMAGE_URL'
+MESSAGES_AUDIO_URL='MESSAGES_AUDIO_URL'
+MESSAGES_VIDEO_URL='MESSAGES_VIDEO_URL'
+MESSAGES_VIDEO_DURATION='MESSAGES_VIDEO_DURATION'
+MESSAGES_VIDEO_FILE_SIZE='MESSAGES_VIDEO_FILE_SIZE'
+MESSAGES_FILE_URL='MESSAGES_FILE_URL'
+MESSAGES_VCARD_URL='MESSAGES_VCARD_URL'
+MESSAGES_EMOJI='MESSAGES_EMOJI'
+WHATSAPP_STICKER_ID='WHATSAPP_STICKER_ID'
+WHATSAPP_STICKER_URL='WHATSAPP_STICKER_URL'
+
+# NI
+INSIGHT_NUMBER='INSIGHT_NUMBER'
+INSIGHT_CALLBACK_URL='INSIGHT_CALLBACK_URL'
+
+# Numbers
+NUMBER_MSISDN='NUMBER_MSISDN'
+NUMBER_COUNTRY_CODE='NUMBER_COUNTRY_CODE'
+NUMBER_TYPE='NUMBER_TYPE'
+NUMBER_FEATURES='NUMBER_FEATURES'
+NUMBER_SEARCH_CRITERIA='NUMBER_SEARCH_CRITERIA'
+NUMBER_SEARCH_PATTERN='NUMBER_SEARCH_PATTERN'
+NUMBER_SMS_CALLBACK_URL='NUMBER_SMS_CALLBACK_URL'
+NUMBER_VOICE_CALLBACK_URL='NUMBER_VOICE_CALLBACK_URL'
+NUMBER_VOICE_STATUS_CALLBACK_URL='NUMBER_VOICE_STATUS_CALLBACK_URL'
+
+# SMS
+## Note: Set SMS_SENDER_ID under the Messages section
+SMS_TO_NUMBER='SMS_TO_NUMBER'
+SMS_SIGNATURE='SMS_SIGNATURE'
+SMS_TIMESTAMP='SMS_TIMESTAMP'
+
+# Subaccounts
+SUBACCOUNT_NAME='SUBACCOUNT_NAME'
+SUBACCOUNT_SECRET='SUBACCOUNT_SECRET'
+SUBACCOUNT_KEY='SUBACCOUNT_KEY'
+SUBACCOUNT_BALANCE_AMOUNT='SUBACCOUNT_BALANCE_AMOUNT'
+SUBACCOUNT_CREDIT_AMOUNT='SUBACCOUNT_CREDIT_AMOUNT'
+SUBACCOUNT_START_DATE='SUBACCOUNT_START_DATE'
+
+# Verify
+VERIFY_NUMBER='VERIFY_NUMBER'
+VERIFY_BRAND_NAME='VERIFY_BRAND_NAME'
+VERIFY_REQUEST_ID='VERIFY_REQUEST_ID'
+VERIFY_CODE='VERIFY_CODE'
+VERIFY_TEMPLATE_ID='VERIFY_TEMPLATE_ID'
+VERIFY_TEMPLATE_FRAGMENT_ID='VERIFY_TEMPLATE_FRAGMENT_ID'
+VERIFY_TO_EMAIL='VERIFY_TO_EMAIL'
+VERIFY_FROM_EMAIL='VERIFY_FROM_EMAIL'
+
+# Verify Legacy
+VERIFY_PAYEE_NAME='VERIFY_PAYEE_NAME'
+VERIFY_AMOUNT='VERIFY_AMOUNT'
+VERIFY_WORKFLOW_ID='VERIFY_WORKFLOW_ID'
+
+# Voice
+VOICE_CALL_ID='VOICE_CALL_ID'
+VOICE_TO_NUMBER='VOICE_TO_NUMBER'
+VOICE_TEXT='VOICE_TEXT'
+VOICE_LANGUAGE='VOICE_LANGUAGE'
+VOICE_DTMF_DIGITS='VOICE_DTMF_DIGITS'
+VOICE_CONFERENCE_NAME='VOICE_CONFERENCE_NAME'
+VOICE_ANSWER_URL='VOICE_ANSWER_URL'
+VOICE_STREAM_URL='VOICE_STREAM_URL'
+VOICE_RECORDING_URL='VOICE_RECORDING_URL'
+
+
+
+
+
 VONAGE_BRAND_NAME='Acme Inc.'
 VONAGE_FB_SENDER_ID='YOUR_FB_MESSENGER_SENDER_ID'
 FB_RECIPIENT_ID='YOUR_FB_MESSENGER_RECIPIENT_ID'
@@ -64,11 +161,6 @@ SESSION_ID='YOUR_SESSION_UUID'
 MAIN_COLOR='#FF0000'
 BRAND_TEXT='YOUR_BRAND_NAME'
 
-# Account
-SMS_CALLBACK_URL='YOUR_CALLBACK_URL'
-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'
@@ -100,4 +192,4 @@ USER_NAME='USER_NAME'
 USER_DISPLAY_NAME='USER_DISPLAY_NAME'
 USER_NEW_NAME='USER_NEW_NAME'
 USER_NEW_DISPLAY_NAME='USER_NEW_DISPLAY_NAME'
-USER_ID='USER_ID'
+USER_ID='USER_ID'

account/configure-account.py

@@ -7,15 +7,15 @@
 
 VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
 VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
-SMS_CALLBACK_URL = os.getenv('SMS_CALLBACK_URL')
+ACCOUNT_SMS_CALLBACK_URL = os.getenv('ACCOUNT_SMS_CALLBACK_URL')
 
 from vonage import Auth, Vonage
 from vonage_account import SettingsResponse
 
 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
+    mo_callback_url=ACCOUNT_SMS_CALLBACK_URL
 )
 
 print(settings)

account/create-secret.py

@@ -8,12 +8,12 @@
 
 VONAGE_API_KEY = os.getenv('VONAGE_API_KEY')
 VONAGE_API_SECRET = os.getenv('VONAGE_API_SECRET')
-NEW_SECRET = os.getenv('NEW_SECRET')
+ACCOUNT_SECRET_VALUE = os.getenv('ACCOUNT_SECRET_VALUE')
 
 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)
+response: VonageApiSecret = client.account.create_secret(ACCOUNT_SECRET_VALUE)
 print(response)

account/fetch-a-secret.py

@@ -7,13 +7,13 @@
 
 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")
+ACCOUNT_SECRET_ID = os.environ.get("ACCOUNT_SECRET_ID")
 
 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)
+secret: VonageApiSecret = client.account.get_secret(ACCOUNT_SECRET_ID)
 
 print(f'Secret ID: {secret.id}; Created at {secret.created_at}')

account/revoke-secret.py

@@ -8,9 +8,9 @@
 
 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")
+ACCOUNT_SECRET_ID = os.getenv("ACCOUNT_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)
+client.account.revoke_secret(ACCOUNT_SECRET_ID)

application/list-applications.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+from pprint import pprint
 import os
 from os.path import join, dirname
 from dotenv import load_dotenv
@@ -18,4 +18,4 @@
     filter=ListApplicationsFilter(page_size=10, page=1)
 )
 
-print(f'Applications:\n{applications}, \nNext page: {next_page}')
+pprint(f'Applications:\n{applications}, \nNext page: {next_page}')

decode-jwt/main.py

@@ -8,7 +8,7 @@
 load_dotenv(envpath)
 
 
-VONAGE_SIGNATURE = os.getenv('VONAGE_SIGNATURE')
+VONAGE_SIGNATURE_SECRET = os.getenv('VONAGE_SIGNATURE_SECRET')
 
 from fastapi import FastAPI, Request
 from vonage_jwt.verify_jwt import verify_signature
@@ -22,7 +22,7 @@ async def verify_signed_webhook(request: Request):
     auth_header = request.headers["authorization"].split()
     token = auth_header[1].strip()
 
-    if verify_signature(token, VONAGE_SIGNATURE):
+    if verify_signature(token, VONAGE_SIGNATURE_SECRET):
         print('Valid signature')
     else:
         print('Invalid signature')

meetings/create-instant-room.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 ROOM_DISPLAY_NAME = os.environ.get('ROOM_DISPLAY_NAME')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.create_room({'display_name': ROOM_DISPLAY_NAME})

meetings/create-long-term-room.py

@@ -7,15 +7,15 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 ROOM_DISPLAY_NAME = os.environ.get('ROOM_DISPLAY_NAME')
 
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 expiration_date = (datetime.utcnow() + timedelta(days=30)).isoformat()

meetings/create-theme.py

@@ -6,15 +6,15 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 MAIN_COLOR = os.environ.get('MAIN_COLOR')
 BRAND_TEXT = os.environ.get('BRAND_TEXT')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.create_theme(

meetings/delete-recording.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 RECORDING_ID = os.environ.get('RECORDING_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 client.meetings.delete_recording(RECORDING_ID)

meetings/delete-theme.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 THEME_ID = os.environ.get('THEME_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 client.meetings.delete_theme(THEME_ID)

meetings/get-recording.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 RECORDING_ID = os.environ.get('RECORDING_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.get_recording(RECORDING_ID)

meetings/get-room.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 ROOM_ID = os.environ.get('ROOM_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.get_room(ROOM_ID)

meetings/get-theme.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 THEME_ID = os.environ.get('THEME_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.get_theme(THEME_ID)

meetings/list-dial-in-numbers.py

@@ -6,13 +6,13 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.list_dial_in_numbers()

meetings/list-recordings.py

@@ -6,14 +6,14 @@
 load_dotenv(dotenv_path)
 
 VONAGE_APPLICATION_ID = os.environ.get('VONAGE_APPLICATION_ID')
-VONAGE_APPLICATION_PRIVATE_KEY_PATH = os.environ.get('VONAGE_APPLICATION_PRIVATE_KEY_PATH')
+VONAGE_PRIVATE_KEY = os.environ.get('VONAGE_PRIVATE_KEY')
 SESSION_ID = os.environ.get('SESSION_ID')
 
 import vonage
 
 client = vonage.Client(
     application_id=VONAGE_APPLICATION_ID,
-    private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
+    private_key=VONAGE_PRIVATE_KEY,
 )
 
 response = client.meetings.get_session_recordings(SESSION_ID)