DX-2465 add modifyCallBxml function (#86)

* DX-2465 add modifyCallBxml function

* Add Tests

* Revert accidental change

* Update bandwidth/voice/bxml/bxml.py

Co-authored-by: Brian <bgome004@gmail.com>

* Update bandwidth/voice/bxml/bxml.py

Co-authored-by: Brian <bgome004@gmail.com>

* Update bandwidth/voice/bxml/bxml.py

Co-authored-by: Brian <bgome004@gmail.com>

* Update Version

Co-authored-by: Brian <bgome004@gmail.com>

Author: ajrice6713

.gitignore

@@ -2,4 +2,9 @@
 .DS_Store
 .idea/
 *.pyc
-.pytest_cache/
+.pytest_cache/
+
+# Build files
+build/
+bandwidth_sdk.egg-info
+pyproject.toml

bandwidth/tests/test_bxml.py

@@ -6,6 +6,7 @@
 @copyright Bandwidth Inc.
 """
 from bandwidth.voice.bxml.response import Response
+from bandwidth.voice.bxml.bxml import Bxml
 from bandwidth.voice.bxml.verbs import *
 from bandwidth.webrtc.utils import *
 
@@ -377,6 +378,24 @@ def test_gather_speak_sentence_ssml(self):
         response.add_verb(gather)
         assert response.to_bxml() == expected_bxml
 
+    def test_empty_bxml_verb(self):
+        expected_bxml = '<?xml version="1.0" encoding="UTF-8"?><Bxml></Bxml>'
+
+        bxml = Bxml()
+        assert bxml.to_bxml() == expected_bxml
+
+    def test_bxml_speak_sentence_pause(self):
+        expected_bxml = '<?xml version="1.0" encoding="UTF-8"?><Bxml><SpeakSentence voice="Julie">Wee Woo</SpeakSentence><Pause duration="10"/></Bxml>'
+        bxml = Bxml()
+        speak_sentence = SpeakSentence(
+            voice="Julie",
+            sentence="Wee Woo"
+        )
+        pause = Pause(10)
+        bxml.add_verb(speak_sentence)
+        bxml.add_verb(pause)
+        assert bxml.to_bxml() == expected_bxml
+
     def test_generate_transfer_bxml(self):
         expected = '<?xml version="1.0" encoding="UTF-8"?><Response><Transfer><SipUri uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt">sip:sipx.webrtc.bandwidth.com:5060</SipUri></Transfer></Response>'
         actual = generate_transfer_bxml(
@@ -388,3 +407,5 @@ def test_generate_transfer_bxml_verb(self):
         actual = generate_transfer_bxml_verb(
             'asdf', 'c-93d6f3c0-be584596-0b74-4fa2-8015-d8ede84bd1a4')
         assert actual == expected
+    
+    

bandwidth/voice/bxml/__init__.py

@@ -1,2 +1,3 @@
 from . import response
+from . import bxml
 from . import verbs

bandwidth/voice/bxml/bxml.py

@@ -0,0 +1,42 @@
+"""
+bxml.py
+
+Class that allows user to generate BXML programatically in python
+BXML is the parent element
+
+@copyright Bandwidth INC
+"""
+
+BXML_TAG = "Bxml"
+XML_HEADER = '<?xml version="1.0" encoding="UTF-8"?>'
+
+
+class Bxml:
+
+    def __init__(self):
+        """
+        Creates the Bxml class 
+        """
+        self.verbs = []
+
+    def add_verb(self, verb):
+        """
+        Adds the Verb to the already existing verbs
+
+        :param Verb verb: The Verb to add
+        """
+        self.verbs.append(verb)
+
+    def to_bxml(self):
+        """
+        Converts the Bxml class to its XML representation
+
+        :rtype str: The XML representation of the Bxml class
+        """
+        xml_string = XML_HEADER
+        xml_string += '<' + BXML_TAG + '>'
+        for verb in self.verbs:
+            xml_string += verb.to_bxml()
+        xml_string += '</' + BXML_TAG + '>' 
+
+        return xml_string

bandwidth/voice/controllers/api_controller.py

@@ -225,6 +225,54 @@ def modify_call(self,
 
         # Return appropriate type
         return ApiResponse(_response)
+    
+    def modify_call_bxml(self, account_id, call_id, body):
+        """Does a PUT request to /api/v2/accounts/{accountId}/calls/{callId}/bxml.
+        
+        Interrupts and replaces an active call's BXML document, sending the new BXML.
+
+        Args: 
+            account_id (string): Bandwidth Account ID. Ex: "99001234"
+            call_id (string): ID of the call for which you wish to replace the active BXML instructions. 
+            body (string): XML string in valid BXML format
+        """
+        
+        # Prepare query URL
+        _url_path = '/api/v2/accounts/{accountId}/calls/{callId}/bxml'
+        _url_path = APIHelper.append_url_with_template_parameters(_url_path, {
+            'accountId': {'value': account_id, 'encode': False},
+            'callId': {'value': call_id, 'encode': False}
+        })
+        _query_builder = self.config.get_base_uri(Server.VOICEDEFAULT)
+        _query_builder += _url_path
+        _query_url = APIHelper.clean_url(_query_builder)
+
+        # Prepare headers
+        _headers = {
+            'content-type': 'application/xml; charset=utf-8'
+        }
+
+                # Prepare and execute request
+        _request = self.config.http_client.put(_query_url, headers=_headers, parameters=body)
+        VoiceBasicAuth.apply(self.config, _request)
+        _response = self.execute_request(_request)
+
+        # Endpoint and global error handling using HTTP status codes.
+        if _response.status_code == 400:
+            raise ApiErrorException('Something\'s not quite right... Your request is invalid. Please fix it before trying again.', _response)
+        elif _response.status_code == 401:
+            raise APIException('Your credentials are invalid. Please use your Bandwidth dashboard credentials to authenticate to the API.', _response)
+        elif _response.status_code == 403:
+            raise ApiErrorException('User unauthorized to perform this action.', _response)
+        elif _response.status_code == 404:
+            raise ApiErrorException('The resource specified cannot be found or does not belong to you.', _response)
+        elif _response.status_code == 415:
+            raise ApiErrorException('We don\'t support that media type. If a request body is required, please send it to us as `application/json`.', _response)
+        elif _response.status_code == 429:
+            raise ApiErrorException('You\'re sending requests to this endpoint too frequently. Please slow your request rate down and try again.', _response)
+        elif _response.status_code == 500:
+            raise ApiErrorException('Something unexpected happened. Please try again.', _response)
+        self.validate_response(_response)
 
     def modify_call_recording_state(self,
                                     account_id,

setup.py

@@ -15,7 +15,7 @@
 
 setup(
     name='bandwidth-sdk',
-    version='13.4.0',
+    version='13.5.0',
     description='Bandwidth\'s set of APIs',
     long_description=long_description,
     long_description_content_type="text/markdown",