VAPI-3435 Simplify Refer to reuse Transfer's SipUri

Remove ReferCompleteCallback (will land later via a separate api-specs-driven
PR once VAPI-3440 merges) and delete the distinct ReferSipUri type. Refer now
takes the existing Transfer-flavored SipUri directly, matching the plain,
validation-free style of the other BXML verb models in this SDK.

Author: stampercasey

.openapi-generator/FILES

@@ -197,7 +197,6 @@ bandwidth/models/thumbnail_alignment_enum.py
 bandwidth/models/transcribe_recording.py
 bandwidth/models/transcription.py
 bandwidth/models/transcription_available_callback.py
-bandwidth/models/refer_complete_callback.py
 bandwidth/models/transfer_answer_callback.py
 bandwidth/models/transfer_complete_callback.py
 bandwidth/models/transfer_disconnect_callback.py

bandwidth/__init__.py

@@ -217,7 +217,6 @@
     "TranscribeRecording",
     "Transcription",
     "TranscriptionAvailableCallback",
-    "ReferCompleteCallback",
     "TransferAnswerCallback",
     "TransferCompleteCallback",
     "TransferDisconnectCallback",
@@ -444,7 +443,6 @@
 from bandwidth.models.transcribe_recording import TranscribeRecording as TranscribeRecording
 from bandwidth.models.transcription import Transcription as Transcription
 from bandwidth.models.transcription_available_callback import TranscriptionAvailableCallback as TranscriptionAvailableCallback
-from bandwidth.models.refer_complete_callback import ReferCompleteCallback as ReferCompleteCallback
 from bandwidth.models.transfer_answer_callback import TransferAnswerCallback as TransferAnswerCallback
 from bandwidth.models.transfer_complete_callback import TransferCompleteCallback as TransferCompleteCallback
 from bandwidth.models.transfer_disconnect_callback import TransferDisconnectCallback as TransferDisconnectCallback

bandwidth/models/__init__.py

@@ -191,7 +191,6 @@
 from bandwidth.models.transcribe_recording import TranscribeRecording
 from bandwidth.models.transcription import Transcription
 from bandwidth.models.transcription_available_callback import TranscriptionAvailableCallback
-from bandwidth.models.refer_complete_callback import ReferCompleteCallback
 from bandwidth.models.transfer_answer_callback import TransferAnswerCallback
 from bandwidth.models.transfer_complete_callback import TransferCompleteCallback
 from bandwidth.models.transfer_disconnect_callback import TransferDisconnectCallback

bandwidth/models/bxml/verbs/__init__.py

@@ -12,7 +12,6 @@
 from .play_audio import PlayAudio
 from .record import Record
 from .refer import Refer
-from .refer_sip_uri import ReferSipUri
 from .redirect import Redirect
 from .resume_recording import ResumeRecording
 from .ring import Ring

bandwidth/models/bxml/verbs/refer.py

@@ -6,13 +6,13 @@
 @copyright Bandwidth INC
 """
 from ..nestable_verb import NestableVerb
-from .refer_sip_uri import ReferSipUri
+from .sip_uri import SipUri
 
 
 class Refer(NestableVerb):
 
     def __init__(
-        self, sip_uri: ReferSipUri,
+        self, sip_uri: SipUri,
         refer_complete_url: str=None, refer_complete_method: str=None,
         tag: str=None
     ):
@@ -24,13 +24,12 @@ def __init__(
         redirects away from Bandwidth entirely. This is a SIP protocol
         property, not a Bandwidth design choice. As a result, BXML returned in
         response to the referComplete callback is only meaningful for failure
-        handling — there is no live call to act on after success.
+        handling - there is no live call to act on after success.
 
         Args:
-            sip_uri (ReferSipUri): The SIP URI to refer the call to. Required.
-                Exactly one <SipUri> child element is allowed. Use ReferSipUri,
-                not SipUri — the Transfer SipUri carries callbacks and auth
-                fields that are not valid in a REFER context.
+            sip_uri (SipUri): The SIP URI to refer the call to. Required.
+                Exactly one <SipUri> child element is allowed. This is the
+                same SipUri model used by <Transfer>.
             refer_complete_url (str, optional): URL to send the Refer Complete
                 event to when the REFER flow finishes (success or failure).
                 May be a relative URL. Defaults to None.

bandwidth/models/bxml/verbs/refer_sip_uri.py

@@ -18,6 +18,8 @@ def __init__(
     ):
         """Initialize a <SipUri> verb
 
+        This SipUri is shared between the <Transfer> and <Refer> verbs.
+
         Args:
             uri (str): A SIP URI to transfer the call to (e.g. sip:user@server.com)
             uui (str, optional): he value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters. Defaults to None.

bandwidth/models/bxml/verbs/sip_uri.py

@@ -7,13 +7,13 @@
 """
 import unittest
 
-from bandwidth.models.bxml import Refer, ReferSipUri, SipUri, Verb, NestableVerb
+from bandwidth.models.bxml import Refer, SipUri, Verb, NestableVerb
 
 
 class TestRefer(unittest.TestCase):
 
     def setUp(self):
-        self.sip_uri = ReferSipUri(uri="sip:alice@atlanta.example.com")
+        self.sip_uri = SipUri(uri="sip:alice@atlanta.example.com")
         self.refer = Refer(
             sip_uri=self.sip_uri,
             refer_complete_url="https://example.com/handleRefer",
@@ -31,19 +31,14 @@ def test_to_bxml(self):
         assert expected == self.refer.to_bxml()
 
     def test_minimal(self):
-        minimal_refer = Refer(sip_uri=ReferSipUri(uri="sip:bob@example.com"))
+        minimal_refer = Refer(sip_uri=SipUri(uri="sip:bob@example.com"))
         expected = '<Refer><SipUri>sip:bob@example.com</SipUri></Refer>'
         assert expected == minimal_refer.to_bxml()
 
-    def test_refer_sip_uri_is_not_transfer_sip_uri(self):
-        """ReferSipUri is a distinct type from the Transfer SipUri — no Transfer-specific
-        attributes (transfer_answer_url, uui, auth, etc.) are accepted."""
-        assert not isinstance(self.sip_uri, SipUri)
-        assert isinstance(self.sip_uri, ReferSipUri)
-
-    def test_refer_sip_uri_has_no_transfer_attributes(self):
-        """ReferSipUri carries only uri — no Transfer baggage."""
-        assert not hasattr(self.sip_uri, 'transfer_answer_url')
-        assert not hasattr(self.sip_uri, 'uui')
-        assert not hasattr(self.sip_uri, 'username')
-        assert not hasattr(self.sip_uri, 'password')
+    def test_shares_sip_uri_with_transfer(self):
+        """Refer uses the same SipUri model as Transfer, including its
+        transfer-flavored attributes if the caller sets them."""
+        sip_uri = SipUri(uri="sip:alice@atlanta.example.com", uui="test")
+        refer = Refer(sip_uri=sip_uri)
+        expected = '<Refer><SipUri uui="test">sip:alice@atlanta.example.com</SipUri></Refer>'
+        assert expected == refer.to_bxml()