bandwidth-sdk 9.2.0 → 9.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 063a9c96b344ab96b6b6717599921eed06e2e2cb8fffb2081b6e88da34d0883e
-  data.tar.gz: 5fbba072d5895a00208b1ae54451f05f01fc7b34c5eff381b34cd286bba65363
+  metadata.gz: 7b7e5b0e9890b1d9a0d92bca32e5e8197efa6110c70cfb2648a13219f5e51f38
+  data.tar.gz: 6955fba0a7d0c5245b10211e1cf49c99a612d6cfb80021e41248b3de8a83896b
 SHA512:
-  metadata.gz: '08f682f87864b61e67fed4badf7469d2e18ce260a0c592131ae5964e133d48418f10806baddaad4d636fa9d5b8d0436d7d4b9b9dc1a1f8ed12b56991932ac71d'
-  data.tar.gz: f047132f1527a0f4e4e794d6cfd4e1dee6b6adc732ca8bce596c35f394de77636719a154eb45f2a4144a23db596b4263e330a228d5d81d7f942ae584c759edbc
+  metadata.gz: bbd9d8709867f56cffcc8335a16b157908536dbd5512ffb7dd01fc9f623b21b1cd398f12ec2679872e0d3d490fc69d95c93d979a4c754c2d434ef0a6f87a9e7b
+  data.tar.gz: 36b3209ec8b26ddb55759bcddd5de4abe8413ec062c5ed14637dbd14c22133f894e1cc5fe08c4c5b31e7f17cff58b40fddf60cbd321785543d9158d5cacf3c8d

data/README.md

@@ -156,7 +156,10 @@ create_participant_response = web_rtc_client.create_participant(account_id, :bod
 participant_id = create_participant_response.data.participant.id
 puts participant_id
 
-web_rtc_client.add_participant_to_session(account_id, session_id, participant_id)
+body = Subscriptions.new
+body.session_id = "1234-abcd"
+
+web_rtc_client.add_participant_to_session(account_id, session_id, participant_id, body: body)
 ```
 
 ## Supported Ruby Versions

data/lib/bandwidth/http/faraday_client.rb

@@ -3,8 +3,11 @@
 # This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'faraday/follow_redirects'
+require 'faraday/gzip'
 require 'faraday/http_cache'
-require 'faraday_middleware'
+require 'faraday/multipart'
+require 'faraday/retry'
 
 module Bandwidth
   # An implementation of HttpClient.
@@ -15,8 +18,8 @@ module Bandwidth
                    cache: false, verify: true)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
-        faraday.use FaradayMiddleware::FollowRedirects
-        faraday.use :gzip
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.request :gzip
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where

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/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
@@ -261,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.2.0
+  version: 9.4.1
 platform: ruby
 authors:
 - Bandwidth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -28,24 +28,66 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday-gzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -140,6 +182,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The official client SDK for Bandwidht's Voice, Messaging, MFA, and WebRTC
   APIs
 email: dx@bandwidth.com
@@ -206,6 +262,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