Feature/devexp 802 python conversation api apps (#2)

* feat(conversation): apps implementation

Author: marcos-sinch

.github/workflows/ci.yml

@@ -33,10 +33,6 @@ jobs:
       run: |
         pip install python-dotenv
         python scripts/check_snippet_coverage.py
-    
-    - name: Generate Documentation
-      run: |
-        make docs
 
     - name: Lint and format check with Ruff
       run: |
@@ -79,6 +75,7 @@ jobs:
         cp sinch-sdk-mockserver/features/sms/* ./tests/e2e/sms/features/
         cp sinch-sdk-mockserver/features/number-lookup/lookups.feature ./tests/e2e/number-lookup/features/
         cp sinch-sdk-mockserver/features/conversation/messages.feature ./tests/e2e/conversation/features/
+        cp sinch-sdk-mockserver/features/conversation/apps.feature ./tests/e2e/conversation/features/
         cp sinch-sdk-mockserver/features/conversation/webhooks-events.feature ./tests/e2e/conversation/features/
 
     - name: Wait for mock server

CHANGELOG.md

@@ -18,7 +18,12 @@ All notable changes to the **Sinch Python SDK** are documented in this file.
 
 ## v2.2.0 – unreleased
 
+### Conversation
 
+- **[feature]** Conversation Apps API: `create`, `get`, `list`, `update`, and `delete` operations, with full model, endpoints and unit/e2e test coverage.
+- **[deprecation notice]** `ConversationProcessingMode` and `ConversationRetentionPolicyType` are deprecated; they are unused by the SDK and will be removed in 3.0.
+- **[deprecation notice]** `ConversationMetadataReportView` is deprecated in favour of `ConversationMetadataReportViewType`; it will be removed in 3.0.
+- **[deprecation notice]** `ConversationChannel` is deprecated in favour of `ConversationChannelType`; it will be removed in 3.0.
 
 ---
 

examples/snippets/conversation/apps/create/snippet.py

@@ -0,0 +1,44 @@
+"""
+Sinch Python Snippet
+
+This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
+"""
+
+import os
+from dotenv import load_dotenv
+from sinch import SinchClient
+
+load_dotenv()
+
+sinch_client = SinchClient(
+    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
+    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
+    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
+    conversation_region=os.environ.get("SINCH_CONVERSATION_REGION") or "MY_CONVERSATION_REGION"
+)
+
+# The display name for the app
+display_name = "[Python SDK: Conversation App] Sample app"
+
+# The service plan ID for the SMS channel
+sms_service_plan_id = os.environ.get("SINCH_SERVICE_PLAN_ID") or "SMS_SERVICE_PLAN_ID"
+
+# The API token for the SMS channel
+sms_api_token = "SMS_API_TOKEN"
+
+# The channel credentials for the app
+channel_credentials = {
+    "SMS": {
+        "claimed_identity": sms_service_plan_id,
+        "token": sms_api_token
+    }
+}
+
+response = sinch_client.conversation.apps.create(
+    display_name=display_name,
+    channel_credentials=channel_credentials,
+)
+
+print(f"Successfully created app.\n{response}")
+
+

examples/snippets/conversation/apps/delete/snippet.py

@@ -0,0 +1,25 @@
+"""
+Sinch Python Snippet
+
+This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
+"""
+
+import os
+from dotenv import load_dotenv
+from sinch import SinchClient
+
+load_dotenv()
+
+sinch_client = SinchClient(
+    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
+    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
+    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
+    conversation_region=os.environ.get("SINCH_CONVERSATION_REGION") or "MY_CONVERSATION_REGION"
+)
+
+# The ID of the app to delete
+app_id = "CONVERSATION_APP_ID"
+
+sinch_client.conversation.apps.delete(app_id=app_id)
+
+print("App deleted successfully")

examples/snippets/conversation/apps/get/snippet.py

@@ -0,0 +1,25 @@
+"""
+Sinch Python Snippet
+
+This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
+"""
+
+import os
+from dotenv import load_dotenv
+from sinch import SinchClient
+
+load_dotenv()
+
+sinch_client = SinchClient(
+    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
+    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
+    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
+    conversation_region=os.environ.get("SINCH_CONVERSATION_REGION") or "MY_CONVERSATION_REGION"
+)
+
+# The ID of the app to retrieve
+app_id = "CONVERSATION_APP_ID"
+
+response = sinch_client.conversation.apps.get(app_id=app_id)
+
+print(f"App details:\n{response}")

examples/snippets/conversation/apps/list/snippet.py

@@ -0,0 +1,24 @@
+"""
+Sinch Python Snippet
+
+This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
+"""
+
+import os
+from dotenv import load_dotenv
+from sinch import SinchClient
+
+load_dotenv()
+
+sinch_client = SinchClient(
+    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
+    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
+    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
+    conversation_region=os.environ.get("SINCH_CONVERSATION_REGION") or "MY_CONVERSATION_REGION"
+)
+
+apps = sinch_client.conversation.apps.list()
+
+print("List of apps:\n")
+for app in apps.iterator():
+    print(app)

examples/snippets/conversation/apps/update/snippet.py

@@ -0,0 +1,31 @@
+"""
+Sinch Python Snippet
+
+This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
+"""
+
+import os
+from dotenv import load_dotenv
+from sinch import SinchClient
+
+load_dotenv()
+
+sinch_client = SinchClient(
+    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
+    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
+    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
+    conversation_region=os.environ.get("SINCH_CONVERSATION_REGION") or "MY_CONVERSATION_REGION"
+)
+
+# The ID of the app to update
+app_id = "CONVERSATION_APP_ID"
+
+# The new display name for the app
+display_name = "Updated from Python SDK snippet"
+
+response = sinch_client.conversation.apps.update(
+    app_id=app_id,
+    display_name=display_name
+)
+
+print(f"Updated app:\n{response}")

sinch/domains/conversation/api/v1/__init__.py

@@ -1,5 +1,7 @@
+from sinch.domains.conversation.api.v1.apps_apis import Apps
 from sinch.domains.conversation.api.v1.messages_apis import Messages
 
 __all__ = [
     "Messages",
+    "Apps",
 ]