DX-2472 Add priority to createCall (#48)

* DX-2472 Add `priority` to `createCall`

* @_hash

* Apply suggestions from code review

* update version

Author: ckoegel

bandwidth.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'bandwidth-sdk'
-  s.version = '9.1.2'
+  s.version = '9.2.0'
   s.summary = 'Bandwidth'
   s.description = 'The official client SDK for Bandwidht\'s Voice, Messaging, MFA, and WebRTC APIs'
   s.authors = ['Bandwidth']

lib/bandwidth/voice_lib/voice/models/create_call_request.rb

@@ -25,126 +25,54 @@ class CreateCallRequest < BaseModel
     # @return [String]
     attr_accessor :uui
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [Float]
     attr_accessor :call_timeout
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [Float]
     attr_accessor :callback_timeout
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :answer_url
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :answer_fallback_url
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :username
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :password
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :fallback_username
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :fallback_password
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [AnswerMethodEnum]
     attr_accessor :answer_method
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [AnswerFallbackMethodEnum]
     attr_accessor :answer_fallback_method
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :disconnect_url
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [DisconnectMethodEnum]
     attr_accessor :disconnect_method
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :tag
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [String]
     attr_accessor :application_id
 
-    # A comma-separated list of 'User-To-User' headers to be sent in the INVITE
-    # when calling a SIP URI. Each value must end with an 'encoding' parameter
-    # as described in https://tools.ietf.org/html/rfc7433. Only 'jwt' and
-    # 'base64' encodings are allowed. The entire value cannot exceed 350
-    # characters, including parameters and separators.
     # @return [MachineDetectionRequest]
     attr_accessor :machine_detection
 
+    # @return [Integer]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -166,6 +94,7 @@ def self.names
       @_hash['tag'] = 'tag'
       @_hash['application_id'] = 'applicationId'
       @_hash['machine_detection'] = 'machineDetection'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -186,6 +115,7 @@ def optionals
         disconnect_method
         tag
         machine_detection
+        priority
       ]
     end
 
@@ -205,6 +135,7 @@ def nullables
         disconnect_url
         disconnect_method
         tag
+        priority
       ]
     end
 
@@ -225,7 +156,8 @@ def initialize(from = nil,
                    disconnect_url = nil,
                    disconnect_method = nil,
                    tag = nil,
-                   machine_detection = nil)
+                   machine_detection = nil,
+                   priority = nil)
       @from = from unless from == SKIP
       @to = to unless to == SKIP
       @uui = uui unless uui == SKIP
@@ -244,6 +176,7 @@ def initialize(from = nil,
       @tag = tag unless tag == SKIP
       @application_id = application_id unless application_id == SKIP
       @machine_detection = machine_detection unless machine_detection == SKIP
+      @priority = priority unless priority == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -276,6 +209,7 @@ def self.from_hash(hash)
       tag = hash.key?('tag') ? hash['tag'] : SKIP
       machine_detection = MachineDetectionConfiguration.from_hash(hash['machineDetection']) if
         hash['machineDetection']
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
 
       # Create object from extracted values.
       CreateCallRequest.new(from,
@@ -295,7 +229,8 @@ def self.from_hash(hash)
                             disconnect_url,
                             disconnect_method,
                             tag,
-                            machine_detection)
+                            machine_detection,
+                            priority)
     end
   end
 end

lib/bandwidth/voice_lib/voice/models/create_call_response.rb

@@ -90,6 +90,9 @@ class CreateCallResponse < BaseModel
     # @return [String]
     attr_accessor :tag
 
+    # @return [Integer]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -113,6 +116,7 @@ def self.names
       @_hash['fallback_username'] = 'fallbackUsername'
       @_hash['fallback_password'] = 'fallbackPassword'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -130,6 +134,7 @@ def optionals
         fallback_username
         fallback_password
         tag
+        priority
       ]
     end
 
@@ -145,6 +150,7 @@ def nullables
         fallback_username
         fallback_password
         tag
+        priority
       ]
     end
 
@@ -167,7 +173,8 @@ def initialize(account_id = nil,
                    password = nil,
                    fallback_username = nil,
                    fallback_password = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @account_id = account_id unless account_id == SKIP
       @call_id = call_id unless call_id == SKIP
       @application_id = application_id unless application_id == SKIP
@@ -188,6 +195,7 @@ def initialize(account_id = nil,
       @fallback_username = fallback_username unless fallback_username == SKIP
       @fallback_password = fallback_password unless fallback_password == SKIP
       @tag = tag unless tag == SKIP
+      @priority = priority unless priority == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -225,6 +233,7 @@ def self.from_hash(hash)
       fallback_password =
         hash.key?('fallbackPassword') ? hash['fallbackPassword'] : SKIP
       tag = hash.key?('tag') ? hash['tag'] : SKIP
+      priority = hash.key?('priority') ? hash['priority'] : SKIP
 
       # Create object from extracted values.
       CreateCallResponse.new(account_id,
@@ -246,7 +255,8 @@ def self.from_hash(hash)
                              password,
                              fallback_username,
                              fallback_password,
-                             tag)
+                             tag,
+                             priority)
     end
 
     def to_start_time

test/integration/test_integration.rb

@@ -143,6 +143,19 @@ def test_create_call_with_amd_and_get_call_state
         assert(response.data.state.length > 0, "state value not set")
     end
 
+    def test_create_call_with_priority
+        body = CreateCallRequest.new
+        body.from = BW_NUMBER
+        body.to = USER_NUMBER
+        body.application_id = BW_VOICE_APPLICATION_ID
+        body.answer_url = BASE_CALLBACK_URL
+        body.priority = 1
+
+        response = @bandwidth_client.voice_client.client.create_call(BW_ACCOUNT_ID, body)
+        assert(response.data.call_id.length > 0, "call_id value not set")
+        assert(response.data.priority == 1, "priority not set")
+    end
+
     def test_create_call_invalid_phone_number
         body = CreateCallRequest.new
         body.from = BW_NUMBER