bandwidth-sdk 9.3.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714d17e79fcabfbf641b2953be3d87f4661957c4ce6452a9add5fba71f7e06fc
-  data.tar.gz: 910e102f0b21b52e4ab8cacb474595a95960f8d5db93689c41261d775175bc86
+  metadata.gz: 7f647905f7c08b4614b21b7ca9278210ed8ff6f532f4b0cd09f1c705852c5567
+  data.tar.gz: '00348580d308e3fccd81a42642daed1a3b6a39562feb953d0789cbf750a79f0f'
 SHA512:
-  metadata.gz: 4bd7b9cb0599cbe42a6f414b2ba26b5b3aa3267f8b27be6748e6f50e0f53e0eb382860abcbedf3330e0aaf6c5c4994ee08986c5df2b898a021c84e8d7f7407a6
-  data.tar.gz: 875c6add47513bdd45c8db63c614f5ea58c030370a1c5265840eb0a8a1c652487ff0d0752d853fbdf2a2f3fb644b6afa87e4ecc98f8b70a168aca8f9321a2799
+  metadata.gz: c001719da52d9026ea151cb5f95229b0a1ef8b864c7bede8d48c02856f742c0124be304982d350be46ca399cd074170b957cc7a4b887c964f68a41cdf6385ca5
+  data.tar.gz: 3efb5225670bc0b6cc86088afa4ee45b8e9ecc5f023d33ff33ff6072454f0599474a4d575cfe0db2c2d85d70ca304cde445623f8f25b3f26d03d099da92c545f

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/call_state.rb

@@ -62,6 +62,9 @@ module Bandwidth
     # @return [DateTime]
     attr_accessor :start_time
 
+    # @return [DateTime]
+    attr_accessor :enqueued_time
+
     # The current state of the call. Current possible values are 'initiated',
     # 'answered' and 'disconnected'. Additional states may be added in the
     # future, so your application must be tolerant of unknown values.
@@ -124,6 +127,7 @@ module Bandwidth
       @_hash['identity'] = 'identity'
       @_hash['stir_shaken'] = 'stirShaken'
       @_hash['start_time'] = 'startTime'
+      @_hash['enqueued_time'] = 'enqueuedTime'
       @_hash['answer_time'] = 'answerTime'
       @_hash['end_time'] = 'endTime'
       @_hash['disconnect_cause'] = 'disconnectCause'
@@ -147,6 +151,7 @@ module Bandwidth
         identity
         stir_shaken
         start_time
+        enqueued_time
         answer_time
         end_time
         disconnect_cause
@@ -180,6 +185,7 @@ module Bandwidth
                    identity = nil,
                    stir_shaken = nil,
                    start_time = nil,
+                   enqueued_time = nil,
                    answer_time = nil,
                    end_time = nil,
                    disconnect_cause = nil,
@@ -197,6 +203,7 @@ module Bandwidth
       @identity = identity unless identity == SKIP
       @stir_shaken = stir_shaken unless stir_shaken == SKIP
       @start_time = start_time unless start_time == SKIP
+      @enqueued_time = enqueued_time unless enqueued_time == SKIP
       @answer_time = answer_time unless answer_time == SKIP
       @end_time = end_time unless end_time == SKIP
       @disconnect_cause = disconnect_cause unless disconnect_cause == SKIP
@@ -221,17 +228,22 @@ module Bandwidth
       identity = hash.key?('identity') ? hash['identity'] : SKIP
       stir_shaken = hash.key?('stirShaken') ? hash['stirShaken'] : SKIP
       start_time = if hash.key?('startTime')
-                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+                      (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
                    else
                      SKIP
                    end
+      enqueued_time = if hash.key?('enqueuedTime')
+                        (DateTimeHelper.from_rfc3339(hash['enqueuedTime']) if hash['enqueuedTime'])
+                      else
+                        SKIP
+                      end
       answer_time = if hash.key?('answerTime')
                       (DateTimeHelper.from_rfc3339(hash['answerTime']) if hash['answerTime'])
                     else
                       SKIP
                     end
       end_time = if hash.key?('endTime')
-                   (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
+                    (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
                  else
                    SKIP
                  end
@@ -257,6 +269,7 @@ module Bandwidth
                     identity,
                     stir_shaken,
                     start_time,
+                    enqueued_time,
                     answer_time,
                     end_time,
                     disconnect_cause,
@@ -269,6 +282,10 @@ module Bandwidth
       DateTimeHelper.to_rfc3339(start_time)
     end
 
+    def to_enqueued_time
+      DateTimeHelper.to_rfc3339(enqueued_time)
+    end
+
     def to_answer_time
       DateTimeHelper.to_rfc3339(answer_time)
     end

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

@@ -32,7 +32,7 @@ module Bandwidth
 
     # TODO: Write general description for this method
     # @return [DateTime]
-    attr_accessor :start_time
+    attr_accessor :enqueued_time
 
     # TODO: Write general description for this method
     # @return [String]
@@ -101,7 +101,7 @@ module Bandwidth
       @_hash['application_id'] = 'applicationId'
       @_hash['to'] = 'to'
       @_hash['from'] = 'from'
-      @_hash['start_time'] = 'startTime'
+      @_hash['enqueued_time'] = 'enqueuedTime '
       @_hash['call_url'] = 'callUrl'
       @_hash['call_timeout'] = 'callTimeout'
       @_hash['callback_timeout'] = 'callbackTimeout'
@@ -123,7 +123,7 @@ module Bandwidth
     # An array for optional fields
     def optionals
       %w[
-        start_time
+        enqueued_time
         call_timeout
         callback_timeout
         answer_fallback_url
@@ -163,7 +163,7 @@ module Bandwidth
                    answer_url = nil,
                    answer_method = nil,
                    disconnect_method = nil,
-                   start_time = nil,
+                   enqueued_time = nil,
                    call_timeout = nil,
                    callback_timeout = nil,
                    answer_fallback_url = nil,
@@ -180,7 +180,7 @@ module Bandwidth
       @application_id = application_id unless application_id == SKIP
       @to = to unless to == SKIP
       @from = from unless from == SKIP
-      @start_time = start_time unless start_time == SKIP
+      @enqueued_time = enqueued_time unless enqueued_time == SKIP
       @call_url = call_url unless call_url == SKIP
       @call_timeout = call_timeout unless call_timeout == SKIP
       @callback_timeout = callback_timeout unless callback_timeout == SKIP
@@ -213,8 +213,8 @@ module Bandwidth
       answer_method = hash.key?('answerMethod') ? hash['answerMethod'] : SKIP
       disconnect_method =
         hash.key?('disconnectMethod') ? hash['disconnectMethod'] : SKIP
-      start_time = if hash.key?('startTime')
-                     (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
+        enqueued_time = if hash.key?('enqueuedTime')
+                     (DateTimeHelper.from_rfc3339(hash['enqueuedTime']) if hash['enqueuedTime'])
                    else
                      SKIP
                    end
@@ -245,7 +245,7 @@ module Bandwidth
                              answer_url,
                              answer_method,
                              disconnect_method,
-                             start_time,
+                             enqueued_time,
                              call_timeout,
                              callback_timeout,
                              answer_fallback_url,
@@ -259,8 +259,8 @@ module Bandwidth
                              priority)
     end
 
-    def to_start_time
-      DateTimeHelper.to_rfc3339(start_time)
+    def to_enqueued_time
+      DateTimeHelper.to_rfc3339(enqueued_time)
     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

@@ -111,11 +111,15 @@ class IntegrationTest < Test::Unit::TestCase
         body.answer_url = BASE_CALLBACK_URL
         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_not_nil(response.data.enqueued_time, "enqueued time is nil")
+        assert(response.data.enqueued_time.is_a?(DateTime), "enqueued time is not a DateTime object")
 
         #Get phone call information
         sleep 1
         response = @bandwidth_client.voice_client.client.get_call(BW_ACCOUNT_ID, response.data.call_id)
         assert(response.data.state.length > 0, "state value not set")
+        assert_not_nil(response.data.enqueued_time, "enqueued time is nil")
+        assert(response.data.enqueued_time.is_a?(DateTime), "enqueued time is not a DateTime object")
     end
 
     def test_create_call_with_amd_and_get_call_state
@@ -262,6 +266,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.3.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Bandwidth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-07-05 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