bandwidth-sdk 6.1.0 → 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/phone_number_lookup_lib/phone_number_lookup/exceptions/accounts_tnlookup400_error_exception.rb

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # Accounts Tnlookup 400 Error class.
+  class AccountsTnlookup400ErrorException < APIException
+    # A description of what validation error occurred.
+    # @return [String]
+    attr_accessor :message
+
+    # 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)
+      @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/web_rtc_lib/web_rtc/client.rb

@@ -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',
+                       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,
+                                        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/web_rtc_lib/web_rtc/models/device_api_version_enum.rb

@@ -8,10 +8,10 @@ module Bandwidth
   class DeviceApiVersionEnum
     DEVICE_API_VERSION_ENUM = [
       # TODO: Write general description for V3
-      V3 = 'v3'.freeze,
+      V3 = 'V3'.freeze,
 
       # TODO: Write general description for V2
-      V2 = 'v2'.freeze
+      V2 = 'V2'.freeze
     ].freeze
   end
 end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,21 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'bandwidth'
+require_relative '../test_helper'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include Bandwidth
+
+  # Create configuration and set any test parameters
+  CONFIG = Configuration.new
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < Bandwidth::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+

data/test/integration/test_integration.rb

@@ -35,7 +35,9 @@ class IntegrationTest < Test::Unit::TestCase
             messaging_basic_auth_user_name: USERNAME,
             messaging_basic_auth_password: PASSWORD,
             two_factor_auth_basic_auth_user_name: USERNAME,
-            two_factor_auth_basic_auth_password: PASSWORD
+            two_factor_auth_basic_auth_password: PASSWORD,
+            phone_number_lookup_basic_auth_user_name: USERNAME,
+            phone_number_lookup_basic_auth_password: PASSWORD
         )
     end
 
@@ -567,4 +569,15 @@ class IntegrationTest < Test::Unit::TestCase
         actual = response.to_bxml()
         assert_equal(expected, actual)
     end
+
+    def test_tn_lookup
+        body = OrderRequest.new
+        body.tns = [PHONE_NUMBER_OUTBOUND]
+        create_response = @bandwidth_client.phone_number_lookup_client.client.create_lookup_request(ACCOUNT_ID, body)
+        assert(create_response.data.request_id.length > 0, "request_id value not set")
+
+        request_id = create_response.data.request_id
+        get_response = @bandwidth_client.phone_number_lookup_client.client.get_lookup_request_status(ACCOUNT_ID, request_id)
+        assert(get_response.data.status.length > 0, "status value not set")
+    end
 end