bandwidth-sdk 3.13.2 → 6.2.0

data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/base_controller.rb

@@ -0,0 +1,49 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'ruby-sdk'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back.on_after_response(response) if @http_call_back
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/bandwidth/{two_factor_auth_lib/two_factor_auth/exceptions/invalid_request_exception.rb → phone_number_lookup_lib/phone_number_lookup/exceptions/accounts_tnlookup400_error_exception.rb}

@@ -4,11 +4,11 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # InvalidRequest class.
-  class InvalidRequestException < APIException
-    # An error message pertaining to what the issue could be
+  # Accounts Tnlookup 400 Error class.
+  class AccountsTnlookup400ErrorException < APIException
+    # A description of what validation error occurred.
     # @return [String]
-    attr_accessor :result
+    attr_accessor :message
 
     # The constructor.
     # @param [String] The reason for raising an exception.
@@ -23,7 +23,7 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @result = hash['result']
+      @message = hash['message']
     end
   end
 end

data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_request.rb

@@ -0,0 +1,35 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Create TN Lookup Request
+  class OrderRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [List of String]
+    attr_accessor :tns
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tns'] = 'tns'
+      @_hash
+    end
+
+    def initialize(tns = nil)
+      @tns = tns
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tns = hash['tns']
+
+      # Create object from extracted values.
+      OrderRequest.new(tns)
+    end
+  end
+end

data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb

@@ -0,0 +1,45 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # The request has been accepted for processing but not yet finished and in a
+  # terminal state (COMPLETE, PARTIAL_COMPLETE, or FAILED)
+  class OrderResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    def initialize(request_id = nil,
+                   status = nil)
+      @request_id = request_id
+      @status = status
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      request_id = hash['requestId']
+      status = hash['status']
+
+      # Create object from extracted values.
+      OrderResponse.new(request_id,
+                        status)
+    end
+  end
+end

data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_status.rb

@@ -0,0 +1,74 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # If requestId exists, the result for that request is returned. See the
+  # Examples for details on the various responses that you can receive. 
+  # Generally, if you see a Response Code of 0 in a result for a TN, information
+  # will be available for it.  Any other Response Code will indicate no
+  # information was available for the TN.
+  class OrderStatus < BaseModel
+    # The requestId.
+    # @return [String]
+    attr_accessor :request_id
+
+    # The status of the request (IN_PROGRESS, COMPLETE, PARTIAL_COMPLETE, or
+    # FAILED).
+    # @return [String]
+    attr_accessor :status
+
+    # The telephone numbers whose lookup failed
+    # @return [List of String]
+    attr_accessor :failed_telephone_numbers
+
+    # The carrier information results for the specified telephone number.
+    # @return [List of Result]
+    attr_accessor :result
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash['status'] = 'status'
+      @_hash['failed_telephone_numbers'] = 'failedTelephoneNumbers'
+      @_hash['result'] = 'result'
+      @_hash
+    end
+
+    def initialize(request_id = nil,
+                   status = nil,
+                   failed_telephone_numbers = nil,
+                   result = nil)
+      @request_id = request_id
+      @status = status
+      @failed_telephone_numbers = failed_telephone_numbers
+      @result = result
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      request_id = hash['requestId']
+      status = hash['status']
+      failed_telephone_numbers = hash['failedTelephoneNumbers']
+      # Parameter is an array, so we need to iterate through it
+      result = nil
+      unless hash['result'].nil?
+        result = []
+        hash['result'].each do |structure|
+          result << (Result.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      OrderStatus.new(request_id,
+                      status,
+                      failed_telephone_numbers,
+                      result)
+    end
+  end
+end

data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/result.rb

@@ -0,0 +1,107 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Result Model.
+  class Result < BaseModel
+    # Our vendor's response code.
+    # @return [Integer]
+    attr_accessor :response_code
+
+    # Message associated with the response code.
+    # @return [String]
+    attr_accessor :message
+
+    # The telephone number in E.164 format.
+    # @return [String]
+    attr_accessor :e_164_format
+
+    # The formatted version of the telephone number.
+    # @return [String]
+    attr_accessor :formatted
+
+    # The country of the telephone number.
+    # @return [String]
+    attr_accessor :country
+
+    # The line type of the telephone number.
+    # @return [String]
+    attr_accessor :line_type
+
+    # The service provider of the telephone number.
+    # @return [String]
+    attr_accessor :line_provider
+
+    # The first half of the Home Network Identity (HNI).
+    # @return [String]
+    attr_accessor :mobile_country_code
+
+    # The second half of the HNI.
+    # @return [String]
+    attr_accessor :mobile_network_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_code'] = 'Response Code'
+      @_hash['message'] = 'Message'
+      @_hash['e_164_format'] = 'E.164 Format'
+      @_hash['formatted'] = 'Formatted'
+      @_hash['country'] = 'Country'
+      @_hash['line_type'] = 'Line Type'
+      @_hash['line_provider'] = 'Line Provider'
+      @_hash['mobile_country_code'] = 'Mobile Country Code'
+      @_hash['mobile_network_code'] = 'Mobile Network Code'
+      @_hash
+    end
+
+    def initialize(response_code = nil,
+                   message = nil,
+                   e_164_format = nil,
+                   formatted = nil,
+                   country = nil,
+                   line_type = nil,
+                   line_provider = nil,
+                   mobile_country_code = nil,
+                   mobile_network_code = nil)
+      @response_code = response_code
+      @message = message
+      @e_164_format = e_164_format
+      @formatted = formatted
+      @country = country
+      @line_type = line_type
+      @line_provider = line_provider
+      @mobile_country_code = mobile_country_code
+      @mobile_network_code = mobile_network_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      response_code = hash['Response Code']
+      message = hash['Message']
+      e_164_format = hash['E.164 Format']
+      formatted = hash['Formatted']
+      country = hash['Country']
+      line_type = hash['Line Type']
+      line_provider = hash['Line Provider']
+      mobile_country_code = hash['Mobile Country Code']
+      mobile_network_code = hash['Mobile Network Code']
+
+      # Create object from extracted values.
+      Result.new(response_code,
+                 message,
+                 e_164_format,
+                 formatted,
+                 country,
+                 line_type,
+                 line_provider,
+                 mobile_country_code,
+                 mobile_network_code)
+    end
+  end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb

@@ -14,7 +14,9 @@ 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'
+require_relative 'two_factor_auth/exceptions/error_with_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/unauthorized_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/forbidden_request_exception.rb'
 # Controllers
 require_relative 'two_factor_auth/controllers/base_controller.rb'
-require_relative 'two_factor_auth/controllers/api_controller.rb'
+require_relative 'two_factor_auth/controllers/mfa_controller.rb'

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

@@ -9,10 +9,10 @@ module Bandwidth
       class Client
         attr_reader :config
 
-        # Access to client controller.
-        # @return [APIController] Returns the controller instance.
-        def client
-          @client ||= APIController.new config
+        # Access to mfa controller.
+        # @return [MFAController] Returns the controller instance.
+        def mfa
+          @mfa ||= MFAController.new config
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,

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.12.1'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

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

@@ -5,13 +5,13 @@
 
 module Bandwidth
 module TwoFactorAuth
-  # APIController
-  class APIController < BaseController
+  # MFAController
+  class MFAController < BaseController
     def initialize(config, http_call_back: nil)
       super(config, http_call_back: http_call_back)
     end
 
-    # Two-Factor authentication with Bandwidth Voice services
+    # Allows a user to send a MFA code through a phone call
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Voice service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -23,7 +23,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/voice'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -44,8 +44,23 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -58,7 +73,7 @@ module TwoFactorAuth
       )
     end
 
-    # Two-Factor authentication with Bandwidth messaging services
+    # Allows a user to send a MFA code through a text message (SMS)
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Messaging service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -70,7 +85,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/messaging'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -91,8 +106,23 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -106,7 +136,7 @@ module TwoFactorAuth
       )
     end
 
-    # Verify a previously sent two-factor authentication 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:
@@ -118,7 +148,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/verify'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -139,8 +169,29 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise ErrorWithRequestException.new(
+          'The user has made too many bad requests and is temporarily locked' \
+          ' out',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end