Merge branch 'DX-2897' into DX-2898

Author: brianluisgomez

bandwidth/model/bxml/verbs/__init__.py

@@ -1,8 +1,12 @@
 from .bridge import Bridge
 from .hangup import Hangup
-from .pause_recording import PauseRecording
+from .gather import Gather
 from .phone_number import PhoneNumber
+from .play_audio import PlayAudio
 from .record import Record
+from .start_recording import StartRecording
 from .sip_uri import SipUri
+from .stop_recording import StopRecording
+from .speak_sentence import SpeakSentence
 from .tag import Tag
 from .transfer import Transfer

bandwidth/model/bxml/verbs/forward.py

@@ -0,0 +1,66 @@
+"""
+forward.py
+
+Bandwidth's Forward BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class Forward(TerminalVerb):
+
+    def __init__(
+        self, to: str=None, from_: str=None, 
+        call_timeout: str=None, diversion_treatment: str=None, 
+        diversion_reason: str=None, uui: str=None
+    ):
+        """Initialize a <Forward> verb
+
+        Args:
+            to (str): The phone number destination of the call.
+            from_ (str, optional): The phone number that the recipient will receive the call from.
+            call_timeout (str, optional): The number of seconds to wait before timing out the call.
+            diversion_treatment (str, optional): Can be any of the following:
+                none: No diversion headers are sent on the outbound leg of the transferred call.
+                propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg.
+                stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call.
+
+                Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None.
+            diversion_reason (str, optional): Can be any of the following values:
+                unknown
+                user-busy
+                no-answer
+                unavailable
+                unconditional
+                time-of-day
+                do-not-disturb
+                deflection
+                follow-me
+                out-of-service
+                away
+
+                This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown. 
+                Defaults to None.
+            uui (str, optional): The value of the User-To-User header to send within the outbound INVITE when forwarding to a SIP URI. 
+                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.
+        """
+        self.to = to
+        self.from_ = from_
+        self.call_timeout = call_timeout
+        self.diversion_treatment = diversion_treatment
+        self.diversion_reason = diversion_reason
+        self.uui = uui
+
+        super().__init__(tag="Forward", content=None) 
+    @property
+    def _attributes(self):
+        return {
+            "to": self.to,
+            "from_": self.from_,
+            "callTimeout": self.call_timeout,
+            "diversionTreatment": self.diversion_treatment,
+            "diversionReason": self.diversion_reason,
+            "uui": self.uui,
+        }        

bandwidth/model/bxml/verbs/gather.py

@@ -0,0 +1,88 @@
+"""
+gather.py
+
+Bandwidth's Gather BXML verb
+
+@copyright Bandwidth INC
+"""
+from typing import Union, List
+from ..verb import Verb
+from .play_audio import PlayAudio
+from .speak_sentence import SpeakSentence
+
+
+class Gather(Verb):
+
+    def __init__(
+        self, audio_verbs: List[Union[PlayAudio, SpeakSentence]] = [],
+        gather_url: str=None, gather_method: str=None, 
+        gather_fallback_url: str=None, gather_fallback_method: str=None, 
+        username: str=None, password: str=None,
+        fallback_username: str=None, fallback_password: str=None, 
+        tag: str=None, terminating_digits: str=None,
+        max_digits: str=None, inter_digit_timeout: str=None, 
+        first_digit_timeout: str=None, repeat_count: str=None
+    ):
+        """Initialize a <Gather> verb
+
+        Args:
+            gather_url (str, optional): URL to send Gather event to and request new BXML. May be a relative URL.
+            gather_method (str, optional): The HTTP method to use for the request to gather_url. GET or POST. Default value is POST.
+            gather_fallback_url (str, optional): A fallback url which, if provided, will be used to retry the Gather event callback delivery in case gather_url fails to respond.
+            gather_fallback_method (str, optional): The HTTP method to use to deliver the Gather event callback to gather_fallback_url. GET or POST. Default value is POST.
+            username (str, optional): The username to send in the HTTP request to gather_url.
+            password (str, optional): The password to send in the HTTP request to gather_url.
+            fallback_username (str, optional): The username to send in the HTTP request to gather_fallback_url.
+            fallback_password (str, optional): The password to send in the HTTP request to gather_fallback_url.
+            tag (str, optional): A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. 
+                May be cleared by setting tag="". Max length 256 characters.
+            terminating_digits (str, optional): When any of these digits are pressed, it will terminate the Gather. Default value is "", which disables this feature.
+            max_digits (str, optional): Max number of digits to collect. Default value is 50. Range: decimal values between 1 - 50.
+            inter_digit_timeout (str, optional): Time (in seconds) allowed between digit presses before automatically terminating the Gather. Default value is 5. Range: decimal values between 1 - 60.
+            first_digit_timeout (str, optional): Time (in seconds) to pause after any audio from nested <SpeakSentence> or <PlayAudio> verb is played (in seconds) before terminating the Gather. 
+                Default value is 5. Range: decimal values between 0 - 60.
+            repeat_count (str, optional): The number of times the audio prompt should be played if no digits are pressed. For example, if this value is 3, the nested audio clip will be played a maximum of three times. 
+                The delay between repetitions will be equal to first_digit_timeout. Default value is 1. repeat_count * number of verbs must not be greater than 20.
+
+        Nested Verbs:
+            PlayAudio: (optional) Using the PlayAudio inside the Gather verb will play the media until a digit is received.
+            SpeakSentence: (optional) Using the SpeakSentence inside the Gather verb will speak the text until a digit is received.
+        """
+        self.gather_url = gather_url
+        self.gather_method = gather_method
+        self.gather_fallback_url = gather_fallback_url
+        self.gather_fallback_method = gather_fallback_method
+        self.username = username
+        self.password = password
+        self.fallback_username = fallback_username
+        self.fallback_password = fallback_password
+        self.tag = tag
+        self.terminating_digits = terminating_digits
+        self.max_digits = max_digits
+        self.inter_digit_timeout = inter_digit_timeout
+        self.first_digit_timeout = first_digit_timeout
+        self.repeat_count = repeat_count
+        self.audio_verbs = audio_verbs
+        super().__init__(
+            tag="Gather", 
+            content=None,
+            nested_verbs=self.audio_verbs)
+
+    @property
+    def _attributes(self):
+        return {
+            "gatherUrl": self.gather_url,
+            "gatherMethod": self.gather_method,
+            "gatherFallbackUrl": self.gather_fallback_url,
+            "gatherFallbackMethod": self.gather_fallback_method,
+            "username": self.username,
+            "password": self.password,
+            "fallbackUsername": self.fallback_username,
+            "fallbackPassword": self.fallback_password,
+            "tag": self.tag,
+            "terminatingDigits": self.terminating_digits,
+            "maxDigits": self.max_digits,
+            "interDigitTimeout": self.inter_digit_timeout,
+            "firstDigitTimeout": self.first_digit_timeout,
+            "repeatCount": self.repeat_count,
+        }

bandwidth/model/bxml/verbs/play_audio.py

@@ -0,0 +1,37 @@
+"""
+play_audio.py
+
+Bandwidth's PlayAudio BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class PlayAudio(TerminalVerb):
+
+    def __init__(
+        self, audio_uri: str, 
+        username: str=None, password: str=None
+    ):
+        """Initialize a <PlayAudio> verb
+
+        Args:
+            audio_uri (str): The URL of the audio file to play. May be a relative URL.
+            username (str, optional): The username to send in the HTTP request to audio_uri.
+            password (str, optional): The password to send in the HTTP request to audio_uri.
+        """
+        self.audio_uri = audio_uri
+        self.username = username
+        self.password = password
+        super().__init__(
+            tag="PlayAudio",
+            content=self.audio_uri,
+        )
+
+    @property
+    def _attributes(self):
+        return {
+            "username": self.username,
+            "password": self.password,
+        }

bandwidth/model/bxml/verbs/resume_recording.py

@@ -0,0 +1,21 @@
+"""
+record.py
+
+Bandwidth's ResumeRecording BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class ResumeRecording(TerminalVerb):
+
+    def __init__(
+        self
+    ):
+        """Initialize a <ResumeRecording> verb
+
+        Args: There are no args or text content for ResumeRecording
+        """
+
+        super().__init__(tag="ResumeRecording", content=None)

bandwidth/model/bxml/verbs/speak_sentence.py

@@ -0,0 +1,42 @@
+"""
+speak_sentence.py
+
+Bandwidth's SpeakSentence BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class SpeakSentence(TerminalVerb):
+
+    def __init__(
+        self, text: str, voice: str=None, 
+        gender: str=None, locale: str=None
+    ):
+        """Initialize a <SpeakSentence> verb
+
+        Args:
+            text (str): The text to speak. Cannot be blank. Can be a mixture of plain text and SSML tags. 
+                You can find a list of supported SSML tags here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-ssml-tags
+            voice (str, optional): Selects the voice of the speaker. Consult the voice column in the below table for valid values.
+                If the voice attribute is present, gender and locale are ignored. You can find a list of supported voices here: https://dev.bandwidth.com/docs/voice/bxml/speakSentence/#supported-voices
+            gender (str, optional): Selects the gender of the speaker. Valid values are "male" or "female". Default "female".
+            locale (str, optional): Selects the locale of the speaker. Consult the locale column in the below table for valid values. Default "en_US"
+        """
+        self.text = text
+        self.voice = voice
+        self.gender = gender
+        self.locale = locale
+        super().__init__(
+            tag="SpeakSentence",
+            content=self.text,
+        )
+
+    @property
+    def _attributes(self):
+        return {
+            "voice": self.voice,
+            "gender": self.gender,
+            "locale": self.locale,
+        }        

bandwidth/model/bxml/verbs/start_recording.py

@@ -0,0 +1,61 @@
+"""
+start_recording.py
+
+Bandwidth's StartRecording BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class StartRecording(TerminalVerb):
+
+    def __init__(
+        self, recording_available_url: str = None,
+        recording_available_method: str = None,
+        transcribe: str = None, transcription_available_url: str = None,
+        transcription_available_method: str = None,  username: str=None,
+        password: str=None, tag: str=None,
+        file_format: str = None, multi_channel: str = None
+    ):
+        """Initialize a <StartRecording> verb
+
+        Args:
+            recording_available_url (str, optional): URL to send the Recording Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
+            recording_available_method (str, optional): The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
+            transcribe (str, optional): A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is false. Defaults to None.
+            transcription_available_url (str, optional): URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL. Defaults to None.
+            transcription_available_method (str, optional): The HTTP method to use for the request to transcriptionAvailableUrl. GET or POST. Default value is POST. Defaults to None.
+            username (str, optional): The username to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
+            password (str, optional): The password to send in the HTTP request to recordCompleteUrl, recordingAvailableUrl or transcriptionAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https). Defaults to None.
+            tag (str, optional): A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or <Tag> verb, or cleared. May be cleared by setting tag="". Max length 256 characters. Defaults to None.
+            file_format (str, optional): The audio format that the recording will be saved as: mp3 or wav. Default value is wav. Defaults to None.            max_duration (str, optional): Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60. Defaults to None.
+            multi_channel (str, optional): A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is false.
+
+        """
+        self.recording_available_url = recording_available_url
+        self.recording_available_method = recording_available_method
+        self.transcribe = transcribe
+        self.transcription_available_url = transcription_available_url
+        self.transcription_available_method = transcription_available_method
+        self.username = username
+        self.password = password
+        self.tag = tag
+        self.file_format = file_format
+        self.multi_channel = multi_channel
+        super().__init__(tag="StartRecording", content=None)
+
+    @property
+    def _attributes(self):
+        return {
+            "recordingAvailableUrl": self.recording_available_url,
+            "recordingAvailableMethod": self.recording_available_method,
+            "transcribe": self.transcribe,
+            "transcriptionAvailableUrl": self.transcription_available_url,
+            "transcriptionAvailableMethod": self.transcription_available_method,
+            "username": self.username,
+            "password": self.password,
+            "tag": self.tag,
+            "fileFormat": self.file_format,
+            "multiChannel": self.multi_channel
+        }

bandwidth/model/bxml/verbs/stop_recording.py

@@ -0,0 +1,19 @@
+"""
+record.py
+
+Bandwidth's StopRecording BXML verb
+
+@copyright Bandwidth INC
+"""
+from ..terminal_verb import TerminalVerb
+
+
+class StopRecording(TerminalVerb):
+
+    def __init__(self):
+        """Initialize a <StopRecording> verb
+
+        Args: There are no args or text content for StopRecording
+        """
+
+        super().__init__(tag="StopRecording", content=None)

test/unit/bxml/test_forward.py

@@ -0,0 +1,38 @@
+"""
+test_forward.py
+
+Unit tests for the <Forward> BXML verb
+
+@copyright Bandwidth Inc.
+"""
+import os
+import pytest
+import unittest
+
+from bandwidth.model.bxml.verb import Verb
+from bandwidth.model.bxml.verbs.forward import Forward
+
+class TestForward(unittest.TestCase):
+    
+    def setUp(self):
+        self.forward = Forward(
+            to="19195554321",
+            from_="19195554322",
+            call_timeout = "15",
+            diversion_treatment="propagate",
+            diversion_reason="away",
+            uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt"
+        )
+        self.test_verb = Verb(tag="test")
+
+    
+    def test_to_bxml(self):
+        if os.environ['PYTHON_VERSION'] == '3.7':
+            expected = '<Forward callTimeout="15" diversionReason="away" diversionTreatment="propagate" from_="19195554322" to="19195554321" uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt" />'
+        else:
+            expected = '<Forward to="19195554321" from_="19195554322" callTimeout="15" diversionTreatment="propagate" diversionReason="away" uui="93d6f3c0be5845960b744fa28015d8ede84bd1a4;encoding=base64,asdf;encoding=jwt" />'
+        assert(expected == self.forward.to_bxml())
+    
+    def test_add_verb(self):
+        with pytest.raises(AttributeError):
+            self.forward.add_verb(self.test_verb)