DX-2471 Add priority to createCallRequest model (#63)

* DX-2471

Add `priority` field to `createCallRequest` and `createCallResponse` models

Also added missing `machine_detection` field to `createCallResponse` model

* Add test for createCall with `priority` field

* bump version to `13.3.0`

* Remove `machineDetection` from `createCallResponse` model

Author: ajrice6713

bandwidth/tests/test_api.py

@@ -287,6 +287,45 @@ def test_failed_create_and_failed_get_call(self, voice_client):
             if get_response_body.id:
                 assert type(get_response_body.id) is str
 
+
+    def test_createCall_with_priority(self, voice_client):
+        """Create a successful voice api call with priority set
+
+        Args: 
+            voice_client: Contains the basic auth credentials needed to authenticate.
+
+        """
+        call_body = CreateCallRequest()
+        call_body.mfrom = BW_NUMBER
+        call_body.to = USER_NUMBER
+        call_body.application_id = BW_VOICE_APPLICATION_ID
+        call_body.answer_url = BASE_CALLBACK_URL + '/callbacks/answer'
+        call_body.answer_method = CallbackMethodEnum.POST
+        call_body.disconnect_url = BASE_CALLBACK_URL + '/callbacks/disconnect'
+        call_body.disconnect_method = CallbackMethodEnum.GET
+        call_body.priority = 1
+
+        create_response = voice_client.create_call(BW_ACCOUNT_ID, call_body)
+        create_response_body = create_response.body
+
+        print(vars(create_response))
+
+        assert create_response.status_code == 201
+        assert len(create_response_body.call_id) == 47    # assert request created and id matches expected length (47)
+        assert create_response_body.account_id == BW_ACCOUNT_ID
+        assert create_response_body.application_id == BW_VOICE_APPLICATION_ID
+        assert create_response_body.to == USER_NUMBER
+        assert create_response_body.mfrom == BW_NUMBER
+        assert create_response_body.call_url == "https://voice.bandwidth.com/api/v2/accounts/" + \
+               BW_ACCOUNT_ID + "/calls/" + create_response_body.call_id
+        assert dateutil.parser.isoparse(str(create_response_body.start_time))    # assert that str(start_time) is datetime
+        assert type(create_response_body.call_timeout) is float
+        assert type(create_response_body.callback_timeout) is float
+        assert create_response_body.answer_method == "POST"
+        assert create_response_body.disconnect_method == "GET"
+        assert create_response_body.priority == 1
+
+
     def test_successful_mfa_messaging(self, mfa_client):
         """Create a successful messaging MFA request.
 

bandwidth/voice/models/create_call_request.py

@@ -42,6 +42,8 @@ class CreateCallRequest(object):
         application_id (string): TODO: type description here.
         machine_detection (MachineDetectionConfiguration): TODO: type description
             here.
+        priority (int): 1-5. The priority of this call over other calls from 
+            your account when outbound call queueing is enabled. 
 
     """
 
@@ -64,7 +66,8 @@ class CreateCallRequest(object):
         "disconnect_url": 'disconnectUrl',
         "disconnect_method": 'disconnectMethod',
         "tag": 'tag',
-        "machine_detection": 'machineDetection'
+        "machine_detection": 'machineDetection',
+        "priority": "priority"
     }
 
     def __init__(self,
@@ -85,7 +88,8 @@ def __init__(self,
                  disconnect_url=None,
                  disconnect_method=None,
                  tag=None,
-                 machine_detection=None):
+                 machine_detection=None,
+                 priority=None):
         """Constructor for the CreateCallRequest class"""
 
         # Initialize members of the class
@@ -107,6 +111,7 @@ def __init__(self,
         self.tag = tag
         self.application_id = application_id
         self.machine_detection = machine_detection
+        self.priority=priority
 
     @classmethod
     def from_dictionary(cls,
@@ -144,6 +149,7 @@ def from_dictionary(cls,
         disconnect_method = dictionary.get('disconnectMethod')
         tag = dictionary.get('tag')
         machine_detection = MachineDetectionConfiguration.from_dictionary(dictionary.get('machineDetection')) if dictionary.get('machineDetection') else None
+        priority = dictionary.get('priority')
 
         # Return an object of this model
         return cls(mfrom,
@@ -163,4 +169,5 @@ def from_dictionary(cls,
                    disconnect_url,
                    disconnect_method,
                    tag,
-                   machine_detection)
+                   machine_detection,
+                   priority)

bandwidth/voice/models/create_call_response.py

@@ -7,6 +7,7 @@
  https://www.apimatic.io ).
 """
 from bandwidth.api_helper import APIHelper
+from bandwidth.voice.models.machine_detection_configuration import MachineDetectionConfiguration
 
 
 class CreateCallResponse(object):
@@ -38,6 +39,7 @@ class CreateCallResponse(object):
         fallback_username (string): TODO: type description here.
         fallback_password (string): TODO: type description here.
         tag (string): TODO: type description here.
+        priority (int): TODO: type description here.
 
     """
 
@@ -62,7 +64,9 @@ class CreateCallResponse(object):
         "password": 'password',
         "fallback_username": 'fallbackUsername',
         "fallback_password": 'fallbackPassword',
-        "tag": 'tag'
+        "tag": 'tag',
+        "machine_detection": 'machineDetection',
+        "priority": 'priority'
     }
 
     def __init__(self,
@@ -85,7 +89,8 @@ def __init__(self,
                  password=None,
                  fallback_username=None,
                  fallback_password=None,
-                 tag=None):
+                 tag=None,
+                 priority=None):
         """Constructor for the CreateCallResponse class"""
 
         # Initialize members of the class
@@ -109,6 +114,7 @@ def __init__(self,
         self.fallback_username = fallback_username
         self.fallback_password = fallback_password
         self.tag = tag
+        self.priority = priority
 
     @classmethod
     def from_dictionary(cls,
@@ -148,6 +154,7 @@ def from_dictionary(cls,
         fallback_username = dictionary.get('fallbackUsername')
         fallback_password = dictionary.get('fallbackPassword')
         tag = dictionary.get('tag')
+        priority = dictionary.get('priority')
 
         # Return an object of this model
         return cls(account_id,
@@ -169,4 +176,5 @@ def from_dictionary(cls,
                    password,
                    fallback_username,
                    fallback_password,
-                   tag)
+                   tag,
+                   priority)

setup.py

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