bandwidth-sdk 6.2.0 → 9.0.0

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/client.rb

@@ -4,7 +4,7 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-    module TwoFactorAuth
+    module MultiFactorAuth
       #  bandwidth client class.
       class Client
         attr_reader :config
@@ -16,12 +16,17 @@ module Bandwidth
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       backoff_factor: 2,
+                       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                       retry_methods: %i[get put get put],
+                       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',
+                       multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
                        voice_basic_auth_password: 'TODO: Replace',
                        web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -32,12 +37,16 @@ module Bandwidth
                                         max_retries: max_retries,
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses,
+                                        retry_methods: retry_methods,
                                         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,
+                                        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+                                        phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+                                        phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
                                         voice_basic_auth_password: voice_basic_auth_password,
                                         web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/controllers/base_controller.rb

@@ -19,14 +19,12 @@ module Bandwidth
 
     def validate_parameters(args)
       args.each do |_name, value|
-        if value.nil?
-          raise ArgumentError, "Required parameter #{_name} cannot be nil."
-        end
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
       end
     end
 
     def execute_request(request, binary: false)
-      @http_call_back.on_before_request(request) if @http_call_back
+      @http_call_back&.on_before_request(request)
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
@@ -36,7 +34,7 @@ module Bandwidth
                  else
                    config.http_client.execute_as_string(request)
                  end
-      @http_call_back.on_after_response(response) if @http_call_back
+      @http_call_back&.on_after_response(response)
 
       response
     end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/controllers/mfa_controller.rb

@@ -4,14 +4,15 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-module TwoFactorAuth
+module MultiFactorAuth
   # MFAController
   class MFAController < BaseController
     def initialize(config, http_call_back: nil)
       super(config, http_call_back: http_call_back)
     end
 
-    # Allows a user to send a MFA code through a phone call
+    # Multi-Factor authentication with Bandwidth Voice services. Allows for a
+    # user to send an MFA code via a phone call.
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Voice service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -19,7 +20,7 @@ module TwoFactorAuth
     def create_voice_two_factor(account_id,
                                 body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/voice'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -39,26 +40,27 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise ErrorWithRequestException.new(
           'If there is any issue with values passed in by the user',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise UnauthorizedRequestException.new(
           'Authentication is either incorrect or not present',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise ForbiddenRequestException.new(
           'The user is not authorized to access this resource',
           _response
         )
-      elsif _response.status_code == 500
+      when 500
         raise ErrorWithRequestException.new(
           'An internal server error occurred',
           _response
@@ -73,7 +75,8 @@ module TwoFactorAuth
       )
     end
 
-    # Allows a user to send a MFA code through a text message (SMS)
+    # Multi-Factor authentication with Bandwidth Messaging services. Allows a
+    # user to send an MFA code via a text message (SMS).
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Messaging service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -81,7 +84,7 @@ module TwoFactorAuth
     def create_messaging_two_factor(account_id,
                                     body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/messaging'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -101,26 +104,27 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise ErrorWithRequestException.new(
           'If there is any issue with values passed in by the user',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise UnauthorizedRequestException.new(
           'Authentication is either incorrect or not present',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise ForbiddenRequestException.new(
           'The user is not authorized to access this resource',
           _response
         )
-      elsif _response.status_code == 500
+      when 500
         raise ErrorWithRequestException.new(
           'An internal server error occurred',
           _response
@@ -136,7 +140,7 @@ module TwoFactorAuth
       )
     end
 
-    # Allows a user to verify an MFA code
+    # Allows a user to verify an MFA code.
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Two-Factor enabled
     # @param [TwoFactorVerifyRequestSchema] body Required parameter: Example:
@@ -144,7 +148,7 @@ module TwoFactorAuth
     def create_verify_two_factor(account_id,
                                  body)
       # Prepare query url.
-      _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
+      _query_builder = config.get_base_uri(Server::MULTIFACTORAUTHDEFAULT)
       _query_builder << '/accounts/{accountId}/code/verify'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
@@ -164,32 +168,33 @@ module TwoFactorAuth
         headers: _headers,
         parameters: body.to_json
       )
-      TwoFactorAuthBasicAuth.apply(config, _request)
+      MultiFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
-      if _response.status_code == 400
+      case _response.status_code
+      when 400
         raise ErrorWithRequestException.new(
           'If there is any issue with values passed in by the user',
           _response
         )
-      elsif _response.status_code == 401
+      when 401
         raise UnauthorizedRequestException.new(
           'Authentication is either incorrect or not present',
           _response
         )
-      elsif _response.status_code == 403
+      when 403
         raise ForbiddenRequestException.new(
           'The user is not authorized to access this resource',
           _response
         )
-      elsif _response.status_code == 429
+      when 429
         raise ErrorWithRequestException.new(
           'The user has made too many bad requests and is temporarily locked' \
           ' out',
           _response
         )
-      elsif _response.status_code == 500
+      when 500
         raise ErrorWithRequestException.new(
           'An internal server error occurred',
           _response

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/exceptions/error_with_request_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # ErrorWithRequest class.
   class ErrorWithRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # An error message pertaining to what the issue could be
     # @return [String]
     attr_accessor :error
@@ -27,8 +30,8 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @error = hash['error']
-      @request_id = hash['requestId']
+      @error = hash.key?('error') ? hash['error'] : SKIP
+      @request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
     end
   end
 end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/exceptions/forbidden_request_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # ForbiddenRequest class.
   class ForbiddenRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The message containing the reason behind the request being forbidden
     # @return [String]
     attr_accessor :message
@@ -23,7 +26,7 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @message = hash['Message']
+      @message = hash.key?('Message') ? hash['Message'] : SKIP
     end
   end
 end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/exceptions/unauthorized_request_exception.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # UnauthorizedRequest class.
   class UnauthorizedRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The message containing the reason behind the request being unauthorized
     # @return [String]
     attr_accessor :message
@@ -23,7 +26,7 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @message = hash['message']
+      @message = hash.key?('message') ? hash['message'] : SKIP
     end
   end
 end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/models/two_factor_code_request_schema.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TwoFactorCodeRequestSchema Model.
   class TwoFactorCodeRequestSchema < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
@@ -50,18 +53,30 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    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
+      @to = to unless to == SKIP
+      @from = from unless from == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @scope = scope unless scope == SKIP
+      @message = message unless message == SKIP
+      @digits = digits unless digits == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -69,12 +84,12 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      to = hash['to']
-      from = hash['from']
-      application_id = hash['applicationId']
-      message = hash['message']
-      digits = hash['digits']
-      scope = hash['scope']
+      to = hash.key?('to') ? hash['to'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      digits = hash.key?('digits') ? hash['digits'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
 
       # Create object from extracted values.
       TwoFactorCodeRequestSchema.new(to,

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/models/two_factor_messaging_response.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TwoFactorMessagingResponse Model.
   class TwoFactorMessagingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :message_id
@@ -17,8 +20,20 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        message_id
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(message_id = nil)
-      @message_id = message_id
+      @message_id = message_id unless message_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -26,7 +41,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      message_id = hash['messageId']
+      message_id = hash.key?('messageId') ? hash['messageId'] : SKIP
 
       # Create object from extracted values.
       TwoFactorMessagingResponse.new(message_id)

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/models/two_factor_verify_code_response.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TwoFactorVerifyCodeResponse Model.
   class TwoFactorVerifyCodeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [Boolean]
     attr_accessor :valid
@@ -17,8 +20,20 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        valid
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(valid = nil)
-      @valid = valid
+      @valid = valid unless valid == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -26,7 +41,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      valid = hash['valid']
+      valid = hash.key?('valid') ? hash['valid'] : SKIP
 
       # Create object from extracted values.
       TwoFactorVerifyCodeResponse.new(valid)

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/models/two_factor_verify_request_schema.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TwoFactorVerifyRequestSchema Model.
   class TwoFactorVerifyRequestSchema < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
@@ -41,16 +44,31 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        scope
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(to = nil,
                    application_id = nil,
                    expiration_time_in_minutes = nil,
                    code = nil,
                    scope = nil)
-      @to = to
-      @application_id = application_id
-      @scope = scope
-      @expiration_time_in_minutes = expiration_time_in_minutes
-      @code = code
+      @to = to unless to == SKIP
+      @application_id = application_id unless application_id == SKIP
+      @scope = scope unless scope == SKIP
+      unless expiration_time_in_minutes == SKIP
+        @expiration_time_in_minutes =
+          expiration_time_in_minutes
+      end
+      @code = code unless code == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -58,11 +76,12 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      to = hash['to']
-      application_id = hash['applicationId']
-      expiration_time_in_minutes = hash['expirationTimeInMinutes']
-      code = hash['code']
-      scope = hash['scope']
+      to = hash.key?('to') ? hash['to'] : SKIP
+      application_id = hash.key?('applicationId') ? hash['applicationId'] : SKIP
+      expiration_time_in_minutes =
+        hash.key?('expirationTimeInMinutes') ? hash['expirationTimeInMinutes'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
 
       # Create object from extracted values.
       TwoFactorVerifyRequestSchema.new(to,

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth → multi_factor_auth_lib/multi_factor_auth}/models/two_factor_voice_response.rb

@@ -6,6 +6,9 @@
 module Bandwidth
   # TwoFactorVoiceResponse Model.
   class TwoFactorVoiceResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :call_id
@@ -17,8 +20,20 @@ module Bandwidth
       @_hash
     end
 
+    # An array for optional fields
+    def optionals
+      %w[
+        call_id
+      ]
+    end
+
+    # An array for nullable fields
+    def nullables
+      []
+    end
+
     def initialize(call_id = nil)
-      @call_id = call_id
+      @call_id = call_id unless call_id == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -26,7 +41,7 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      call_id = hash['callId']
+      call_id = hash.key?('callId') ? hash['callId'] : SKIP
 
       # Create object from extracted values.
       TwoFactorVoiceResponse.new(call_id)

data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth.rb

@@ -0,0 +1,23 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+
+require_relative 'multi_factor_auth/client.rb'
+
+# Models
+require_relative 'multi_factor_auth/models/two_factor_code_request_schema.rb'
+require_relative 'multi_factor_auth/models/two_factor_voice_response.rb'
+require_relative 'multi_factor_auth/models/two_factor_messaging_response.rb'
+require_relative 'multi_factor_auth/models/two_factor_verify_request_schema.rb'
+require_relative 'multi_factor_auth/models/two_factor_verify_code_response.rb'
+
+# Exceptions
+require_relative 'multi_factor_auth/exceptions/error_with_request_exception.rb'
+require_relative 'multi_factor_auth/exceptions/unauthorized_request' \
+                 '_exception.rb'
+require_relative 'multi_factor_auth/exceptions/forbidden_request_exception.rb'
+# Controllers
+require_relative 'multi_factor_auth/controllers/base_controller.rb'
+require_relative 'multi_factor_auth/controllers/mfa_controller.rb'