feat(voice): add AnswerWebhook support

Author: alnacle

voice/src/vonage_voice/models/__init__.py

@@ -23,6 +23,7 @@
     ToPhone,
     TtsStreamOptions,
 )
+from .webhooks import AnswerWebhook
 from .responses import (
     CallInfo,
     CallList,
@@ -36,6 +37,7 @@
     'AdvancedMachineDetection',
     'AppEndpoint',
     'AudioStreamOptions',
+    'AnswerWebhook',
     'CallInfo',
     'CallList',
     'CallMessage',

voice/src/vonage_voice/models/webhooks.py

@@ -0,0 +1,33 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class AnswerWebhook(BaseModel):
+    """Model for the Voice API Answer webhook payload.
+
+    Args:
+        to (str, Optional): The number or endpoint that answered the call.
+        from_ (str, Optional): The number or endpoint that initiated the call.
+        from_user (str, Optional): The Client SDK user that initiated the call.
+        endpoint_type (str, Optional): The type of endpoint that answered the call.
+        uuid (str, Optional): The unique identifier for this call.
+        conversation_uuid (str, Optional): The unique identifier for this conversation.
+        region_url (str, Optional): Regional API endpoint to control the call.
+        custom_data (dict, Optional): Custom data object passed from the Client SDK.
+        sipheader_user_to_user (str, Optional): Content of the SIP User-to-User header,
+            received as the `SipHeader_User-to-User` parameter on the webhook.
+    """
+
+    to: Optional[str] = None
+    from_: Optional[str] = Field(None, alias='from')
+    from_user: Optional[str] = None
+    endpoint_type: Optional[str] = None
+    uuid: Optional[str] = None
+    conversation_uuid: Optional[str] = None
+    region_url: Optional[str] = None
+    custom_data: Optional[dict] = None
+    sipheader_user_to_user: Optional[str] = Field(
+        None, serialization_alias='SipHeader_User-to-User'
+    )
+

voice/tests/test_answer_webhook.py

@@ -0,0 +1,25 @@
+from vonage_voice.models import AnswerWebhook
+
+
+def test_answer_webhook_sipheader_user_to_user_alias():
+    payload = {
+        'to': '442079460000',
+        'from': '447700900000',
+        'uuid': 'aaaaaaaa-bbbb-cccc-dddd-0123456789ab',
+        'conversation_uuid': 'CON-aaaaaaaa-bbbb-cccc-dddd-0123456789ab',
+        'SipHeader_User-to-User': '1234567890abcdef;encoding=hex',
+    }
+
+    hook = AnswerWebhook(**payload)
+
+    assert hook.to == '442079460000'
+    assert hook.from_ == '447700900000'
+    assert (
+        hook.sipheader_user_to_user == '1234567890abcdef;encoding=hex'
+    ), 'Field should be populated from SipHeader_User-to-User'
+
+    dumped = hook.model_dump(by_alias=True, exclude_none=True)
+    assert (
+        dumped['SipHeader_User-to-User'] == '1234567890abcdef;encoding=hex'
+    ), 'Field should serialize back with the SipHeader_User-to-User key'
+