bandwidth-sdk 3.5.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48115c5ef2d3c4b9f64d4ef6afce6b6ecb94cdde4b445afb21fc4c1819b079c0
-  data.tar.gz: d9f295c220a2ac75b090ca8a419a1ae2375779119d9cb4bd7a14d09f0f5fed93
+  metadata.gz: f3d2881e1496cedc05c46f0cfd26e3d3d5f962ed99a44b058716601e604b9fdf
+  data.tar.gz: ee7642af1962da2ed997831b55dde24a8e6568403d47affd12df2200aae2a477
 SHA512:
-  metadata.gz: e0d4a309e16b781e6e020688cc1ab153b171aa6a9f59e1e34ddaa81d442c851623cae0a4fdc9d081d62623cee0935277e28265b8da883c7dc2a66aab0c762093
-  data.tar.gz: d2c7435d3f124001aa11bc8c610336086309b511e65c9744d3007082b03b812c7c14e200005774b5d078b3fb512e62fa483218d7855791efd8206b6868531fc9
+  metadata.gz: d8fb09237fb2de6e11a8714b7944dd46a8fbae1ca80c93eb5e596a039012a3755b850075ffb84c4e2bb55e914b08d71852ffdb307daba184d53ade4ac976b37b
+  data.tar.gz: 44c19dfccfbc76061c5977ac581ae041db2ddd62ddccfff99235e52d9e04134f4035ed934261656e1b11270d006d707f43d8377e429e169ff019b362ba480b1c

data/lib/bandwidth.rb

@@ -39,5 +39,7 @@ require_relative 'bandwidth/two_factor_auth_lib/two_factor_auth'
 require_relative 'bandwidth/http/auth/two_factor_auth_basic_auth.rb'
 require_relative 'bandwidth/voice_lib/voice'
 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

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

@@ -22,26 +22,37 @@ module Bandwidth
     def voice_client
       @voice_client ||= Voice::Client.new(config: config)
     end
+    # Access to web_rtc_client controller.
+    # @return [WebRtc::Client] Returns the client instance.
+    def web_rtc_client
+      @web_rtc_client ||= WebRtc::Client.new(config: config)
+    end
 
     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',
                    two_factor_auth_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
-                   voice_basic_auth_password: 'TODO: Replace', config: nil)
+                   voice_basic_auth_password: 'TODO: Replace',
+                   web_rtc_basic_auth_user_name: 'TODO: Replace',
+                   web_rtc_basic_auth_password: 'TODO: Replace', config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     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,
                                     two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                     voice_basic_auth_user_name: voice_basic_auth_user_name,
-                                    voice_basic_auth_password: voice_basic_auth_password)
+                                    voice_basic_auth_password: voice_basic_auth_password,
+                                    web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                    web_rtc_basic_auth_password: web_rtc_basic_auth_password)
                 else
                   config
                 end

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
 
@@ -17,7 +18,8 @@ module Bandwidth
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
       TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
-      VOICEDEFAULT = 'VoiceDefault'.freeze
+      VOICEDEFAULT = 'VoiceDefault'.freeze,
+      WEBRTCDEFAULT = 'WebRtcDefault'.freeze
     ].freeze
   end
 
@@ -31,12 +33,15 @@ 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
     attr_reader :two_factor_auth_basic_auth_password
     attr_reader :voice_basic_auth_user_name
     attr_reader :voice_basic_auth_password
+    attr_reader :web_rtc_basic_auth_user_name
+    attr_reader :web_rtc_basic_auth_password
 
     class << self
       attr_reader :environments
@@ -44,12 +49,15 @@ 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',
                    two_factor_auth_basic_auth_password: 'TODO: Replace',
                    voice_basic_auth_user_name: 'TODO: Replace',
-                   voice_basic_auth_password: 'TODO: Replace')
+                   voice_basic_auth_password: 'TODO: Replace',
+                   web_rtc_basic_auth_user_name: 'TODO: Replace',
+                   web_rtc_basic_auth_password: 'TODO: Replace')
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -66,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
 
@@ -84,40 +95,53 @@ module Bandwidth
       # The password to use with basic authentication
       @voice_basic_auth_password = voice_basic_auth_password
 
+      # The username to use with basic authentication
+      @web_rtc_basic_auth_user_name = web_rtc_basic_auth_user_name
+
+      # The password to use with basic authentication
+      @web_rtc_basic_auth_password = web_rtc_basic_auth_password
+
       # The Http Client to use for making requests.
       @http_client = create_http_client
     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,
                    two_factor_auth_basic_auth_password: nil,
                    voice_basic_auth_user_name: nil,
-                   voice_basic_auth_password: nil)
+                   voice_basic_auth_password: nil,
+                   web_rtc_basic_auth_user_name: nil,
+                   web_rtc_basic_auth_password: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       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
       two_factor_auth_basic_auth_password ||= self.two_factor_auth_basic_auth_password
       voice_basic_auth_user_name ||= self.voice_basic_auth_user_name
       voice_basic_auth_password ||= self.voice_basic_auth_password
+      web_rtc_basic_auth_user_name ||= self.web_rtc_basic_auth_user_name
+      web_rtc_basic_auth_password ||= self.web_rtc_basic_auth_password
 
       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,
         two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
         voice_basic_auth_user_name: voice_basic_auth_user_name,
-        voice_basic_auth_password: voice_basic_auth_password
+        voice_basic_auth_password: voice_basic_auth_password,
+        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+        web_rtc_basic_auth_password: web_rtc_basic_auth_password
       )
     end
 
@@ -133,7 +157,15 @@ module Bandwidth
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
         Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
-        Server::VOICEDEFAULT => 'https://voice.bandwidth.com'
+        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
 
@@ -142,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/http/auth/web_rtc_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class WebRtcBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.web_rtc_basic_auth_user_name
+      password = config.web_rtc_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

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

@@ -17,24 +17,31 @@ 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',
                        two_factor_auth_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
-                       voice_basic_auth_password: 'TODO: Replace', config: nil)
+                       voice_basic_auth_password: 'TODO: Replace',
+                       web_rtc_basic_auth_user_name: 'TODO: Replace',
+                       web_rtc_basic_auth_password: 'TODO: Replace',
+                       config: nil)
           @config = if config.nil?
                       Configuration.new(timeout: timeout,
                                         max_retries: max_retries,
                                         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,
                                         two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
-                                        voice_basic_auth_password: voice_basic_auth_password)
+                                        voice_basic_auth_password: voice_basic_auth_password,
+                                        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                        web_rtc_basic_auth_password: web_rtc_basic_auth_password)
                     else
                       config
                     end

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.5.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.10.0'
       }
     end
 

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

@@ -17,24 +17,31 @@ 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',
                        two_factor_auth_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
-                       voice_basic_auth_password: 'TODO: Replace', config: nil)
+                       voice_basic_auth_password: 'TODO: Replace',
+                       web_rtc_basic_auth_user_name: 'TODO: Replace',
+                       web_rtc_basic_auth_password: 'TODO: Replace',
+                       config: nil)
           @config = if config.nil?
                       Configuration.new(timeout: timeout,
                                         max_retries: max_retries,
                                         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,
                                         two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
-                                        voice_basic_auth_password: voice_basic_auth_password)
+                                        voice_basic_auth_password: voice_basic_auth_password,
+                                        web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,
+                                        web_rtc_basic_auth_password: web_rtc_basic_auth_password)
                     else
                       config
                     end

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