DEVEXP-963: Numbers Snippets

README.md

@@ -4,3 +4,26 @@ Sinch Python SDK Code Snippets Repository
 
 This repository contains code snippets demonstrating usage of the
 [Sinch Python SDK](https://github.com/sinch/sinch-sdk-python).
+
+
+## Functions Demonstrated
+
+- **Active Numbers**
+  - [List active numbers](snippets/numbers/active_numbers/list/snippet.py)
+  - [List active numbers (auto pagination)](snippets/numbers/active_numbers/list_auto/snippet.py)
+  - [Retrieve an active phone number](snippets/numbers/active_numbers/get/snippet.py)
+  - [Update an active phone number](snippets/numbers/active_numbers/update/snippet.py)
+  - [Release an active number](snippets/numbers/active_numbers/release/snippet.py)
+
+- **Available Numbers**
+  - [Search for available numbers](snippets/numbers/available_numbers/search_for_available_numbers/snippet.py)
+  - [Search for a specific phone number](snippets/numbers/available_numbers/check_availability/snippet.py)
+  - [Activate a new phone number](snippets/numbers/available_numbers/rent/snippet.py)
+  - [Rent any number that matches the criteria](snippets/numbers/available_numbers/rent_any/snippet.py)
+
+- **Available Regions**
+  - [List available regions](snippets/numbers/available_regions/list/snippet.py)
+
+- **Callback Configuration**
+  - [Get callbacks configuration](snippets/numbers/callback_configuration/get/snippet.py)
+  - [Update callback configuration](snippets/numbers/callback_configuration/update/snippet.py)

snippets/numbers/active_numbers/get/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 phone_number = "YOUR_RENTED_PHONE_NUMBER"

snippets/numbers/active_numbers/list/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 active_numbers = sinch_client.numbers.list(

snippets/numbers/active_numbers/list_auto/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 active_numbers = sinch_client.numbers.list(

snippets/numbers/active_numbers/release/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 phone_number = "PHONE_NUMBER_TO_BE_RELEASED"

snippets/numbers/active_numbers/update/snippet.py

@@ -1,10 +1,14 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 from sinch.domains.numbers.models.v1.types import VoiceConfigurationDictType
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 phone_number = "PHONE_NUMBER"

snippets/numbers/available_numbers/check_availability/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 phone_number = "PHONE_NUMBER"

snippets/numbers/available_numbers/rent/snippet.py

@@ -1,10 +1,14 @@
+import os
+from dotenv import load_dotenv
 from sinch.domains.numbers.models.v1.types import SmsConfigurationDict
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 phone_number = "AVAILABLE_PHONE_NUMBER_TO_BE_RENTED"

snippets/numbers/available_numbers/rent_any/snippet.py

@@ -1,12 +1,16 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 from sinch.domains.numbers.models.v1.types import (
     NumberPatternDict, SmsConfigurationDict, VoiceConfigurationDictType
 )
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 sms_configuration: SmsConfigurationDict = {

snippets/numbers/available_numbers/search_for_available_numbers/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 available_numbers = sinch_client.numbers.search_for_available_numbers(

snippets/numbers/available_regions/list/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 available_regions = sinch_client.numbers.regions.list(

snippets/numbers/callback_configuration/get/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 response = sinch_client.numbers.callback_configuration.get()

snippets/numbers/callback_configuration/update/snippet.py

@@ -1,9 +1,13 @@
+import os
+from dotenv import load_dotenv
 from sinch import SinchClient
 
+load_dotenv()
+
 sinch_client = SinchClient(
-    project_id="YOUR_PROJECT_ID",
-    key_id="KEY_ID",
-    key_secret="KEY_SECRET"
+    project_id=os.environ["PROJECT_ID"],
+    key_id=os.environ["KEY_ID"],
+    key_secret=os.environ["KEY_SECRET"]
 )
 
 hmac_secret = "NEW_HMAC_SECRET"