bandwidth-sdk 9.1.2 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db76591055af337edfa263589d610ccaeb6548b790e8198c151c8aef12aae58a
-  data.tar.gz: '0149d372e10582225a5add12aa9f07b43ab52686431facea7968c011297ca97e'
+  metadata.gz: 18a1aa70f505740cb401da02868903300dd1dea4bad46e34334387a24b5ed391
+  data.tar.gz: c6d3de5ab878190e7a7b9fe29fd503b240aa3434c3fd54b72bce236d1ddfafd9
 SHA512:
-  metadata.gz: 07716df459d4e176ec1725d353f1c811db5fe8890bb413d84cc54a531d69db998add4aee95f6da55d113a62678a9d924c2278e6148a3fafeb0f04230c1561337
-  data.tar.gz: 21c7a1a53d35326b9319dc7836d93d71a7e252b0804ca2311053aaed6c85149e9ec5ac1f2bd2adfcf9439ae80259c22302f2b1f18c63d207d5b3b5260895bb46
+  metadata.gz: 97b472c59acf4f4fe5552a5a7c561d0b36fdbdbeb7c240fc0d3c4dfcf3eee3a46d0ca5316325f1245086ab6efc91101a80a9826d49078ccee6d2f7563db6171c
+  data.tar.gz: 526b08eeab6f9335208edd49b2c3ea7b01193b4077254374d5cf496d20048231ff990029a92c2e4c33013657ef5a5cad7705296073910a5b6406862d7d06ee9b

data/lib/bandwidth/voice_lib/bxml/bxml.rb

@@ -3,14 +3,11 @@ Dir[File.dirname(__FILE__) + '/verbs/*'].each {|file|
   require_relative file
 }
 
-SSML_REGEX = /<([a-zA-Z\/\/].*?)>/
-SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>.*?<\/SpeakSentence>/
-
 module Bandwidth 
   module Voice 
-    class Response
+    class Bxml
       # Initializer
-      # @param verbs [Array] optional list of verbs to include into response
+      # @param verbs [Array] optional list of verbs to include in the bxml tag
       def initialize(verbs = nil)
         @verbs = verbs || []
       end
@@ -19,7 +16,7 @@ module Bandwidth
       def to_bxml()
         xml = Builder::XmlMarkup.new()
         xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
-        xml.Response do
+        xml.Bxml do
           @verbs.each {|verb| verb.to_bxml(xml)}
         end
         xml.target!().gsub(SPEAK_SENTENCE_REGEX){|s|s.gsub(SSML_REGEX, '<\1>')}

data/lib/bandwidth/voice_lib/bxml/response.rb

@@ -0,0 +1,39 @@
+require 'builder'
+Dir[File.dirname(__FILE__) + '/verbs/*'].each {|file|
+  require_relative file
+}
+
+SSML_REGEX = /<([a-zA-Z\/\/].*?)>/
+SPEAK_SENTENCE_REGEX = /<SpeakSentence.*?>.*?<\/SpeakSentence>/
+
+module Bandwidth 
+  module Voice 
+    class Response
+      # Initializer
+      # @param verbs [Array] optional list of verbs to include into response
+      def initialize(verbs = nil)
+        @verbs = verbs || []
+      end
+
+      # Return BXML representaion of this response
+      def to_bxml()
+        xml = Builder::XmlMarkup.new()
+        xml.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
+        xml.Response do
+          @verbs.each {|verb| verb.to_bxml(xml)}
+        end
+        xml.target!().gsub(SPEAK_SENTENCE_REGEX){|s|s.gsub(SSML_REGEX, '<\1>')}
+      end
+
+      # Add one or more verbs to this response
+      def push(*verbs)
+        @verbs.push(*verbs)
+      end
+
+      # Add a verb to this response
+      def <<(verb)
+        @verbs << verb
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb

@@ -252,6 +252,87 @@ module Voice
       ApiResponse.new(_response)
     end
 
+    # Makes a PUT request to /api/v2/accounts/{accountId}/calls/{callId}/bxml
+    # @param [String] account_id Required parameter: Example:
+    # @param [String] call_id Required parameter: Example:
+    # @param [String] body Required parameter: Example:
+    # @return [void] response from the API call
+    def modify_call_bxml(account_id,
+                         call_id,
+                         body
+                        )
+      # Prepare query url.
+      _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
+      _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/bxml'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'accountId' => { 'value' => account_id, 'encode' => false },
+        'callId' => { 'value' => call_id, 'encode' => false }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'content-type' => 'application/xml; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      VoiceBasicAuth.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      case _response.status_code
+      when 400
+        raise ApiErrorException.new(
+          'Something\'s not quite right... Your request is invalid. Please' \
+          ' fix it before trying again.',
+          _response
+        )
+      when 401
+        raise APIException.new(
+          'Your credentials are invalid. Please use your Bandwidth dashboard' \
+          ' credentials to authenticate to the API.',
+          _response
+        )
+      when 403
+        raise ApiErrorException.new(
+          'User unauthorized to perform this action.',
+          _response
+        )
+      when 404
+        raise ApiErrorException.new(
+          'The resource specified cannot be found or does not belong to you.',
+          _response
+        )
+      when 415
+        raise ApiErrorException.new(
+          'We don\'t support that media type. If a request body is required,' \
+          ' please send it to us as `application/xml`.',
+          _response
+        )
+      when 429
+        raise ApiErrorException.new(
+          'You\'re sending requests to this endpoint too frequently. Please' \
+          ' slow your request rate down and try again.',
+          _response
+        )
+      when 500
+        raise ApiErrorException.new(
+          'Something unexpected happened. Please try again.',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      ApiResponse.new(_response)
+    end
+
     # Pauses or resumes a recording.
     # @param [String] account_id Required parameter: Example:
     # @param [String] call_id Required parameter: Example:

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

@@ -25,126 +25,54 @@ module Bandwidth
     # @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 @@ module Bandwidth
       @_hash['tag'] = 'tag'
       @_hash['application_id'] = 'applicationId'
       @_hash['machine_detection'] = 'machineDetection'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -186,6 +115,7 @@ module Bandwidth
         disconnect_method
         tag
         machine_detection
+        priority
       ]
     end
 
@@ -205,6 +135,7 @@ module Bandwidth
         disconnect_url
         disconnect_method
         tag
+        priority
       ]
     end
 
@@ -225,7 +156,8 @@ module Bandwidth
                    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 @@ module Bandwidth
       @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 @@ module Bandwidth
       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 @@ module Bandwidth
                             disconnect_url,
                             disconnect_method,
                             tag,
-                            machine_detection)
+                            machine_detection,
+                            priority)
     end
   end
 end

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

@@ -90,6 +90,9 @@ module Bandwidth
     # @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 @@ module Bandwidth
       @_hash['fallback_username'] = 'fallbackUsername'
       @_hash['fallback_password'] = 'fallbackPassword'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -130,6 +134,7 @@ module Bandwidth
         fallback_username
         fallback_password
         tag
+        priority
       ]
     end
 
@@ -145,6 +150,7 @@ module Bandwidth
         fallback_username
         fallback_password
         tag
+        priority
       ]
     end
 
@@ -167,7 +173,8 @@ module Bandwidth
                    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 @@ module Bandwidth
       @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 @@ module Bandwidth
       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 @@ module Bandwidth
                              password,
                              fallback_username,
                              fallback_password,
-                             tag)
+                             tag,
+                             priority)
     end
 
     def to_start_time

data/lib/bandwidth/voice_lib/voice/models/machine_detection_configuration.rb

@@ -86,6 +86,11 @@ module Bandwidth
     # @return [String]
     attr_accessor :fallback_password
 
+    # When an answering machine is detected, the amount of silence (in seconds) 
+    # before assuming the message has finished playing.
+    # return [Float]
+    attr_accessor :machine_speech_end_threshold
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -103,6 +108,7 @@ module Bandwidth
       @_hash['password'] = 'password'
       @_hash['fallback_username'] = 'fallbackUsername'
       @_hash['fallback_password'] = 'fallbackPassword'
+      @_hash['machine_speech_end_threshold'] = 'machineSpeechEndThreshold'
       @_hash
     end
 
@@ -123,6 +129,7 @@ module Bandwidth
         password
         fallback_username
         fallback_password
+        machine_speech_end_threshold
       ]
     end
 
@@ -137,6 +144,7 @@ module Bandwidth
         password
         fallback_username
         fallback_password
+        machine_speech_end_threshold
       ]
     end
 
@@ -153,7 +161,8 @@ module Bandwidth
                    username = nil,
                    password = nil,
                    fallback_username = nil,
-                   fallback_password = nil)
+                   fallback_password = nil,
+                   machine_speech_end_threshold = nil)
       @mode = mode unless mode == SKIP
       @detection_timeout = detection_timeout unless detection_timeout == SKIP
       @silence_timeout = silence_timeout unless silence_timeout == SKIP
@@ -168,6 +177,7 @@ module Bandwidth
       @password = password unless password == SKIP
       @fallback_username = fallback_username unless fallback_username == SKIP
       @fallback_password = fallback_password unless fallback_password == SKIP
+      @machine_speech_end_threshold = machine_speech_end_threshold unless machine_speech_end_threshold == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -197,6 +207,8 @@ module Bandwidth
         hash.key?('fallbackUsername') ? hash['fallbackUsername'] : SKIP
       fallback_password =
         hash.key?('fallbackPassword') ? hash['fallbackPassword'] : SKIP
+      machine_speech_end_threshold = 
+        hash.key?('machineSpeechEndThreshold') ? hash['machineSpeechEndThreshold'] : SKIP
 
       # Create object from extracted values.
       MachineDetectionConfiguration.new(mode,
@@ -212,7 +224,8 @@ module Bandwidth
                                   username,
                                   password,
                                   fallback_username,
-                                  fallback_password)
+                                  fallback_password,
+                                  machine_speech_end_threshold)
     end
   end
 end

data/lib/bandwidth.rb

@@ -47,6 +47,7 @@ require_relative 'bandwidth/http/auth/web_rtc_basic_auth'
 require_relative 'bandwidth/http/auth/web_rtc_basic_auth.rb'
 
 # External Files
+require_relative 'bandwidth/voice_lib/bxml/response.rb'
 require_relative 'bandwidth/voice_lib/bxml/bxml.rb'
 require_relative 'bandwidth/voice_lib/bxml/verbs/bridge.rb'
 require_relative 'bandwidth/voice_lib/bxml/verbs/conference.rb'

data/test/integration/test_integration.rb

@@ -128,6 +128,7 @@ class IntegrationTest < Test::Unit::TestCase
         machine_detection.delay_result = true
         machine_detection.callback_url = BASE_CALLBACK_URL + '/machineDetection'
         machine_detection.callback_method = 'POST'
+        machine_detection.machine_speech_end_threshold = 3.2
 
         body = CreateCallRequest.new
         body.from = BW_NUMBER
@@ -143,6 +144,19 @@ class IntegrationTest < Test::Unit::TestCase
         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
@@ -248,6 +262,34 @@ class IntegrationTest < Test::Unit::TestCase
         assert_equal(expected, actual)
     end
 
+    def test_empty_bxml_verb
+        bxml = Bandwidth::Voice::Bxml.new()
+
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Bxml></Bxml>'
+        actual = bxml.to_bxml()
+        assert_equal(expected, actual)
+    end
+
+    def test_bxml_speak_sentence_pause
+        bxml = Bandwidth::Voice::Bxml.new()
+
+        speak_sentence = Bandwidth::Voice::SpeakSentence.new({
+            :sentence => "new modify call bxml is pog",
+            :voice => "Julie"
+        })
+
+        pause = Bandwidth::Voice::Pause.new({
+            :duration => 6
+        })
+
+        bxml.push(speak_sentence)
+        bxml.push(pause)
+
+        expected = '<?xml version="1.0" encoding="UTF-8"?><Bxml><SpeakSentence voice="Julie">new modify call bxml is pog</SpeakSentence><Pause duration="6"/></Bxml>'
+        actual = bxml.to_bxml()
+        assert_equal(expected, actual)
+    end
+
     def test_hangup
         hangup = Bandwidth::Voice::Hangup.new()
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 9.1.2
+  version: 9.4.0
 platform: ruby
 authors:
 - Bandwidth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -206,6 +206,7 @@ files:
 - lib/bandwidth/utilities/date_time_helper.rb
 - lib/bandwidth/utilities/file_wrapper.rb
 - lib/bandwidth/voice_lib/bxml/bxml.rb
+- lib/bandwidth/voice_lib/bxml/response.rb
 - lib/bandwidth/voice_lib/bxml/verbs/bridge.rb
 - lib/bandwidth/voice_lib/bxml/verbs/conference.rb
 - lib/bandwidth/voice_lib/bxml/verbs/forward.rb