bandwidth-sdk 3.7.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10eadbf6902f10e74e9e2574332439ce256b7b8a57d8c7e87f6a776857376c0
-  data.tar.gz: 585279582d7e65c7a88dbb284d72a05f399be1a4c36dbc169fdeecd8a5317e61
+  metadata.gz: f1687b38b81b8c6261c0038d6bf49001afb6a1126098cf07cba1576cdba424a5
+  data.tar.gz: 7499a2af7f7671fab927b849b412a530ae434355d7f500394a373d473992de33
 SHA512:
-  metadata.gz: e2c78bbe4acf58b05f186547b72e39f10cd198e68fe22051ab268027177544e51111b95af0f3a44b9ec1d1e038ca8420ef2a871c537fbb17138e430fc8cab1d1
-  data.tar.gz: ad3b16633b516c60e14c8a9469acb912f74bc36c5e737fa636d4f2c32808636e76e718a1e3bcd7f30e7dcf2d93b278e31fdd1a71c08e5fe1574d16a484a0d184
+  metadata.gz: 4f5db84d3cd22771e57fa410a2ae87f9f648b389977a4bc2cb8c8a0c99dea18e26babf107572e4415102cd6c464e9cbaddfaed1989eac84254c8f850a757c7c6
+  data.tar.gz: f92963f362440fa3853db7ec18e019321d3ccac442490dfe18a19c6749339e7a65eb5ab1dfa25723a4384b1252ed536ef6bdce78605029372dc6b8f74f1a4316

data/lib/bandwidth.rb

@@ -42,4 +42,27 @@ require_relative 'bandwidth/http/auth/voice_basic_auth.rb'
 require_relative 'bandwidth/web_rtc_lib/web_rtc'
 require_relative 'bandwidth/http/auth/web_rtc_basic_auth.rb'
 
-# Controllers
+# External Files
+require_relative 'bandwidth/voice_lib/bxml/bxml.rb'
+require_relative 'bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/bridge.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/conference.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/forward.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/hangup.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/pause.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/pause_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/phone_number.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/play_audio.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/record.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/redirect.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/resume_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/ring.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/send_dtmf.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/speak_sentence.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/start_gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/start_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/stop_gather.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/stop_recording.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/transfer.rb'
+require_relative 'bandwidth/voice_lib/bxml/verbs/xml_verb.rb'

data/lib/bandwidth/api_helper.rb

@@ -41,17 +41,22 @@ module Bandwidth
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
-      # Iterate and append parameters.
-      parameters.each do |key, value|
-        replace_value = ''
-
-        if value.nil?
+      parameters.each do |key, val|
+        if val.nil?
           replace_value = ''
-        elsif value.instance_of? Array
-          value.map! { |element| CGI.escape(element.to_s) }
-          replace_value = value.join('/')
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
         else
-          replace_value = CGI.escape(value.to_s)
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
         end
 
         # Find the template parameter and replace it with its value.

data/lib/bandwidth/client.rb

@@ -30,6 +30,7 @@ module Bandwidth
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: Environment::PRODUCTION,
+                   base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
                    two_factor_auth_basic_auth_user_name: 'TODO: Replace',
@@ -43,6 +44,7 @@ module Bandwidth
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     environment: environment,
+                                    base_url: base_url,
                                     messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                     messaging_basic_auth_password: messaging_basic_auth_password,
                                     two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,

data/lib/bandwidth/configuration.rb

@@ -7,7 +7,8 @@ module Bandwidth
   # An enum for SDK environments.
   class Environment
     ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
+      PRODUCTION = 'production'.freeze,
+      CUSTOM = 'custom'.freeze
     ].freeze
   end
 
@@ -32,6 +33,7 @@ module Bandwidth
     attr_reader :retry_interval
     attr_reader :backoff_factor
     attr_reader :environment
+    attr_reader :base_url
     attr_reader :messaging_basic_auth_user_name
     attr_reader :messaging_basic_auth_password
     attr_reader :two_factor_auth_basic_auth_user_name
@@ -47,6 +49,7 @@ module Bandwidth
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: Environment::PRODUCTION,
+                   base_url: 'https://www.example.com',
                    messaging_basic_auth_user_name: 'TODO: Replace',
                    messaging_basic_auth_password: 'TODO: Replace',
                    two_factor_auth_basic_auth_user_name: 'TODO: Replace',
@@ -71,6 +74,9 @@ module Bandwidth
       # Current API environment
       @environment = String(environment)
 
+      # baseUrl value
+      @base_url = base_url
+
       # The username to use with basic authentication
       @messaging_basic_auth_user_name = messaging_basic_auth_user_name
 
@@ -100,7 +106,7 @@ module Bandwidth
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil,
+                   backoff_factor: nil, environment: nil, base_url: nil,
                    messaging_basic_auth_user_name: nil,
                    messaging_basic_auth_password: nil,
                    two_factor_auth_basic_auth_user_name: nil,
@@ -114,6 +120,7 @@ module Bandwidth
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
       environment ||= self.environment
+      base_url ||= self.base_url
       messaging_basic_auth_user_name ||= self.messaging_basic_auth_user_name
       messaging_basic_auth_password ||= self.messaging_basic_auth_password
       two_factor_auth_basic_auth_user_name ||= self.two_factor_auth_basic_auth_user_name
@@ -126,7 +133,7 @@ module Bandwidth
       Configuration.new(
         timeout: timeout, max_retries: max_retries,
         retry_interval: retry_interval, backoff_factor: backoff_factor,
-        environment: environment,
+        environment: environment, base_url: base_url,
         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
         messaging_basic_auth_password: messaging_basic_auth_password,
         two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
@@ -152,6 +159,13 @@ module Bandwidth
         Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com',
         Server::WEBRTCDEFAULT => 'https://api.webrtc.bandwidth.com/v1'
+      },
+      Environment::CUSTOM => {
+        Server::DEFAULT => '{base_url}',
+        Server::MESSAGINGDEFAULT => '{base_url}',
+        Server::TWOFACTORAUTHDEFAULT => '{base_url}',
+        Server::VOICEDEFAULT => '{base_url}',
+        Server::WEBRTCDEFAULT => '{base_url}'
       }
     }.freeze
 
@@ -160,7 +174,12 @@ module Bandwidth
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = Server::DEFAULT)
-      ENVIRONMENTS[environment][server].clone
+      parameters = {
+        'base_url' => { 'value' => base_url, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -17,6 +17,7 @@ module Bandwidth
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                        backoff_factor: 1, environment: Environment::PRODUCTION,
+                       base_url: 'https://www.example.com',
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
                        two_factor_auth_basic_auth_user_name: 'TODO: Replace',
@@ -32,6 +33,7 @@ module Bandwidth
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
                                         environment: environment,
+                                        base_url: base_url,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
                                         two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,

data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -22,7 +22,7 @@ module Messaging
       _query_builder << '/users/{userId}/media'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id
+        'userId' => { 'value' => user_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -76,8 +76,10 @@ module Messaging
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response,
-                      data: decoded.map { |element| Media.from_hash(element) })
+      ApiResponse.new(
+        _response,
+        data: decoded.map { |element| Media.from_hash(element) }
+      )
     end
 
     # getMedia
@@ -91,8 +93,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_id, 'encode' => true },
+        'mediaId' => { 'value' => media_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -138,7 +140,9 @@ module Messaging
       validate_response(_response)
 
       # Return appropriate response type.
-      ApiResponse.new(_response, data: _response.raw_body)
+      ApiResponse.new(
+        _response, data: _response.raw_body
+      )
     end
 
     # uploadMedia
@@ -161,8 +165,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_id, 'encode' => true },
+        'mediaId' => { 'value' => media_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -240,8 +244,8 @@ module Messaging
       _query_builder << '/users/{userId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id,
-        'mediaId' => media_id
+        'userId' => { 'value' => user_id, 'encode' => true },
+        'mediaId' => { 'value' => media_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -301,7 +305,7 @@ module Messaging
       _query_builder << '/users/{userId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => user_id
+        'userId' => { 'value' => user_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -356,7 +360,9 @@ module Messaging
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response, data: BandwidthMessage.from_hash(decoded))
+      ApiResponse.new(
+        _response, data: BandwidthMessage.from_hash(decoded)
+      )
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.7.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.0'
       }
     end
 

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/client.rb

@@ -17,6 +17,7 @@ module Bandwidth
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                        backoff_factor: 1, environment: Environment::PRODUCTION,
+                       base_url: 'https://www.example.com',
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
                        two_factor_auth_basic_auth_user_name: 'TODO: Replace',
@@ -32,6 +33,7 @@ module Bandwidth
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
                                         environment: environment,
+                                        base_url: base_url,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
                                         two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb

@@ -23,7 +23,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/voice'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => account_id
+        'accountId' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -53,8 +53,9 @@ module TwoFactorAuth
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response,
-                      data: TwoFactorVoiceResponse.from_hash(decoded))
+      ApiResponse.new(
+        _response, data: TwoFactorVoiceResponse.from_hash(decoded)
+      )
     end
 
     # Two-Factor authentication with Bandwidth messaging services
@@ -69,7 +70,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/messaging'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => account_id
+        'accountId' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -99,8 +100,10 @@ module TwoFactorAuth
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response,
-                      data: TwoFactorMessagingResponse.from_hash(decoded))
+      ApiResponse.new(
+        _response,
+        data: TwoFactorMessagingResponse.from_hash(decoded)
+      )
     end
 
     # Verify a previously sent two-factor authentication code
@@ -115,7 +118,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/verify'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => account_id
+        'accountId' => { 'value' => account_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -145,8 +148,10 @@ module TwoFactorAuth
 
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
-      ApiResponse.new(_response,
-                      data: TwoFactorVerifyCodeResponse.from_hash(decoded))
+      ApiResponse.new(
+        _response,
+        data: TwoFactorVerifyCodeResponse.from_hash(decoded)
+      )
     end
   end
 end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.7.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.0'
       }
     end
 

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

@@ -14,7 +14,13 @@ module Bandwidth
          'bridgeTargetCompleteMethod' => bridge_target_complete_method,
          'username' => username,
          'password' => password,
-         'tag' => tag
+         'tag' => tag,
+         'bridgeCompleteFallbackUrl' => bridge_complete_fallback_url,
+         'bridgeCompleteFallbackMethod' => bridge_complete_fallback_method,
+         'bridgeTargetCompleteFallbackUrl' => bridge_target_complete_fallback_url,
+         'bridgeTargetCompleteFallbackMethod' => bridge_target_complete_fallback_method,
+         'fallbackUsername' => fallback_username,
+         'fallbackPassword' => fallback_password
         }))
       end
     end

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

@@ -20,7 +20,11 @@ module Bandwidth
          'conferenceEventMethod' => conference_event_method,
          'username' => username,
          'password' => password,
-         'tag' => tag
+         'tag' => tag,
+         'conferenceEventFallbackUrl' => conference_event_fallback_url,
+         'conferenceEventFallbackMethod' => conference_event_fallback_method,
+         'fallbackUsername' => fallback_username,
+         'fallbackPassword' => fallback_password
         }))
       end
     end

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

@@ -17,7 +17,11 @@ module Bandwidth
           'username' => username,
           'password' => password,
           'firstDigitTimeout' => first_digit_timeout,
-          'repeatCount' => repeat_count
+          'repeatCount' => repeat_count,
+          'gatherFallbackUrl' => gather_fallback_url,
+          'gatherFallbackMethod' => gather_fallback_method,
+          'fallbackUsername' => fallback_username,
+          'fallbackPassword' => fallback_password
          })) do
            def embedded_xml(xml, property, type)
              if property

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

@@ -12,7 +12,11 @@ module Bandwidth
           'transferDisconnectMethod' => transfer_disconnect_method,
           'username' => username,
           'password' => password,
-          'tag' => tag
+          'tag' => tag,
+          'transferAnswerFallbackUrl' => transfer_answer_fallback_url,
+          'transferAnswerFallbackMethod' => transfer_answer_fallback_method,
+          'fallbackUsername' => fallback_username,
+          'fallbackPassword' => fallback_password
         }))
       end
     end

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

@@ -21,7 +21,11 @@ module Bandwidth
          'transcribe' => transcribe,
          'transcriptionAvailableUrl' => transcription_available_url,
          'transcriptionAvailableMethod' => transcription_available_method,
-         'silenceTimeout' => silence_timeout
+         'silenceTimeout' => silence_timeout,
+         'recordCompleteFallbackUrl' => record_complete_fallback_url,
+         'recordCompleteFallbackMethod' => record_complete_fallback_method,
+         'fallbackUsername' => fallback_username,
+         'fallbackPassword' => fallback_password
         }))
       end
     end

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

@@ -12,7 +12,11 @@ module Bandwidth
          'redirectMethod' => redirect_method,
          'tag' => tag,
          'username' => username,
-         'password' => password
+         'password' => password,
+         'redirectFallbackUrl' => redirect_fallback_url,
+         'redirectFallbackMethod' => redirect_fallback_method,
+         'fallbackUsername' => fallback_username,
+         'fallbackPassword' => fallback_password
         }))
       end
     end