bandwidth-sdk 3.2.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a28919bebd82a316cecaedd2e6abdea2c60bd092021e6a8128577d3f6e2c07
-  data.tar.gz: 1ecfc47dbe9ee1ea5a50654a86c25ed712fe685e65ee7dc9401818a4b2fea530
+  metadata.gz: e10eadbf6902f10e74e9e2574332439ce256b7b8a57d8c7e87f6a776857376c0
+  data.tar.gz: 585279582d7e65c7a88dbb284d72a05f399be1a4c36dbc169fdeecd8a5317e61
 SHA512:
-  metadata.gz: 4d77b5a15e04975c3815cc9b39adaaf5828a3ebb71064a57e5dcea8209f36516ec7ff5cce85c987586aa52eb0f25410ba8f864336023d8a52c877c059b26115e
-  data.tar.gz: b3f26d82dbcf9b7f16551e972d18a11c66759a745547978ca4165c19a23dfb36edf6d2d85f7905db33dc576cf536d8221cffa398382bc447fd0b51c08c29ef21
+  metadata.gz: e2c78bbe4acf58b05f186547b72e39f10cd198e68fe22051ab268027177544e51111b95af0f3a44b9ec1d1e038ca8420ef2a871c537fbb17138e430fc8cab1d1
+  data.tar.gz: ad3b16633b516c60e14c8a9469acb912f74bc36c5e737fa636d4f2c32808636e76e718a1e3bcd7f30e7dcf2d93b278e31fdd1a71c08e5fe1574d16a484a0d184

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

@@ -22,6 +22,11 @@ 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,
@@ -30,7 +35,9 @@ module Bandwidth
                    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,
@@ -41,7 +48,9 @@ module Bandwidth
                                     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

@@ -17,7 +17,8 @@ module Bandwidth
       DEFAULT = 'default'.freeze,
       MESSAGINGDEFAULT = 'MessagingDefault'.freeze,
       TWOFACTORAUTHDEFAULT = 'TwoFactorAuthDefault'.freeze,
-      VOICEDEFAULT = 'VoiceDefault'.freeze
+      VOICEDEFAULT = 'VoiceDefault'.freeze,
+      WEBRTCDEFAULT = 'WebRtcDefault'.freeze
     ].freeze
   end
 
@@ -37,6 +38,8 @@ module Bandwidth
     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
@@ -49,7 +52,9 @@ module Bandwidth
                    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
 
@@ -84,6 +89,12 @@ 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
@@ -95,7 +106,9 @@ module Bandwidth
                    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
@@ -107,6 +120,8 @@ module Bandwidth
       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,
@@ -117,7 +132,9 @@ module Bandwidth
         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 +150,8 @@ 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'
       }
     }.freeze
 

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

@@ -22,7 +22,10 @@ module Bandwidth
                        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,
@@ -34,7 +37,9 @@ module Bandwidth
                                         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/base_controller.rb

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

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb

@@ -14,6 +14,7 @@ require_relative 'two_factor_auth/models/two_factor_verify_request_schema.rb'
 require_relative 'two_factor_auth/models/two_factor_verify_code_response.rb'
 
 # Exceptions
+require_relative 'two_factor_auth/exceptions/invalid_request_exception.rb'
 # Controllers
 require_relative 'two_factor_auth/controllers/base_controller.rb'
 require_relative 'two_factor_auth/controllers/api_controller.rb'

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

@@ -22,7 +22,10 @@ module Bandwidth
                        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,
@@ -34,7 +37,9 @@ module Bandwidth
                                         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

@@ -41,6 +41,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.
@@ -79,6 +87,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.
@@ -117,6 +133,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.

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

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/invalid_request_exception.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # InvalidRequest class.
+  class InvalidRequestException < APIException
+    # An error message pertaining to what the issue could be
+    # @return [String]
+    attr_accessor :result
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @result = hash['result']
+    end
+  end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_code_request_schema.rb

@@ -6,22 +6,38 @@
 module Bandwidth
   # TwoFactorCodeRequestSchema Model.
   class TwoFactorCodeRequestSchema < BaseModel
-    # TODO: Write general description for this method
+    # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The application phone number, the sender of the 2fa code.
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The application unique ID, obtained from Bandwidth.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # An optional field to denote what scope or action the 2fa code is
+    # addressing.  If not supplied, defaults to "2FA".
     # @return [String]
     attr_accessor :scope
 
+    # The message format of the 2fa code.  There are three values that the
+    # system will replace "{CODE}", "{NAME}", "{SCOPE}".  The "{SCOPE}" and
+    # "{NAME} value template are optional, while "{CODE}" must be supplied.  As
+    # the name would suggest, code will be replace with the actual 2fa code. 
+    # Name is replaced with the application name, configured during provisioning
+    # of 2fa.  The scope value is the same value sent during the call and
+    # partitioned by the server.
+    # @return [String]
+    attr_accessor :message
+
+    # The number of digits for your 2fa code.  The valid number ranges from 2 to
+    # 8, inclusively.
+    # @return [Float]
+    attr_accessor :digits
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -29,17 +45,23 @@ module Bandwidth
       @_hash['from'] = 'from'
       @_hash['application_id'] = 'applicationId'
       @_hash['scope'] = 'scope'
+      @_hash['message'] = 'message'
+      @_hash['digits'] = 'digits'
       @_hash
     end
 
     def initialize(to = nil,
                    from = nil,
                    application_id = nil,
+                   message = nil,
+                   digits = nil,
                    scope = nil)
       @to = to
       @from = from
       @application_id = application_id
       @scope = scope
+      @message = message
+      @digits = digits
     end
 
     # Creates an instance of the object from a hash.
@@ -50,12 +72,16 @@ module Bandwidth
       to = hash['to']
       from = hash['from']
       application_id = hash['applicationId']
+      message = hash['message']
+      digits = hash['digits']
       scope = hash['scope']
 
       # Create object from extracted values.
       TwoFactorCodeRequestSchema.new(to,
                                      from,
                                      application_id,
+                                     message,
+                                     digits,
                                      scope)
     end
   end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_verify_request_schema.rb

@@ -6,23 +6,36 @@
 module Bandwidth
   # TwoFactorVerifyRequestSchema Model.
   class TwoFactorVerifyRequestSchema < BaseModel
-    # TODO: Write general description for this method
+    # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The application phone number, the sender of the 2fa code.
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The application unique ID, obtained from Bandwidth.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # An optional field to denote what scope or action the 2fa code is
+    # addressing.  If not supplied, defaults to "2FA".
     # @return [String]
     attr_accessor :scope
 
-    # TODO: Write general description for this method
+    # The number of digits for your 2fa code.  The valid number ranges from 2 to
+    # 8, inclusively.
+    # @return [Float]
+    attr_accessor :digits
+
+    # The time period, in minutes, to validate the 2fa code.  By setting this to
+    # 3 minutes, it will mean any code generated within the last 3 minutes are
+    # still valid.  The valid range for expiration time is between 0 and 15
+    # minutes, exclusively and inclusively, respectively.
+    # @return [Float]
+    attr_accessor :expiration_time_in_minutes
+
+    # The generated 2fa code to check if valid
     # @return [String]
     attr_accessor :code
 
@@ -33,6 +46,8 @@ module Bandwidth
       @_hash['from'] = 'from'
       @_hash['application_id'] = 'applicationId'
       @_hash['scope'] = 'scope'
+      @_hash['digits'] = 'digits'
+      @_hash['expiration_time_in_minutes'] = 'expirationTimeInMinutes'
       @_hash['code'] = 'code'
       @_hash
     end
@@ -40,12 +55,16 @@ module Bandwidth
     def initialize(to = nil,
                    from = nil,
                    application_id = nil,
-                   scope = nil,
-                   code = nil)
+                   digits = nil,
+                   expiration_time_in_minutes = nil,
+                   code = nil,
+                   scope = nil)
       @to = to
       @from = from
       @application_id = application_id
       @scope = scope
+      @digits = digits
+      @expiration_time_in_minutes = expiration_time_in_minutes
       @code = code
     end
 
@@ -57,15 +76,19 @@ module Bandwidth
       to = hash['to']
       from = hash['from']
       application_id = hash['applicationId']
-      scope = hash['scope']
+      digits = hash['digits']
+      expiration_time_in_minutes = hash['expirationTimeInMinutes']
       code = hash['code']
+      scope = hash['scope']
 
       # Create object from extracted values.
       TwoFactorVerifyRequestSchema.new(to,
                                        from,
                                        application_id,
-                                       scope,
-                                       code)
+                                       digits,
+                                       expiration_time_in_minutes,
+                                       code,
+                                       scope)
     end
   end
 end