bandwidth-sdk 6.1.0 → 8.0.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/utilities/date_time_helper.rb

@@ -0,0 +1,156 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Bandwidth
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper
+    # Safely converts a DateTime object into a rfc1123 format string
+    # @param [DateTime] The DateTime object
+    # @return [String] The rfc1123 formatted datetime string
+    def self.to_rfc1123(date_time)
+      date_time.httpdate unless date_time.nil?
+    end
+
+    # Safely converts a map of DateTime objects into a map of rfc1123 format string
+    # @param [hash] a map of DateTime objects
+    # @return [hash] a map of rfc1123 formatted datetime string
+    def self.to_rfc1123_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          if v.is_a?(BaseModel)
+            v.to_hash
+          else
+            v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
+          end
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into an array of rfc1123 format string
+    # @param [Array] an array of DateTime objects
+    # @return [Array] an array of rfc1123 formatted datetime string
+    def self.to_rfc1123_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        if v.is_a?(BaseModel)
+          v.to_hash
+        else
+          v.is_a?(DateTime) ? DateTimeHelper.to_rfc1123(v) : v
+        end
+      end
+    end
+
+    # Safely converts a DateTime object into a unix format string
+    # @param [DateTime] The DateTime object
+    # @return [String] The unix formatted datetime string
+    def self.to_unix(date_time)
+      date_time.to_time.utc.to_i unless date_time.nil?
+    end
+
+    # Safely converts a map of DateTime objects into a map of unix format string
+    # @param [hash] a map of DateTime objects
+    # @return [hash] a map of unix formatted datetime string
+    def self.to_unix_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          if v.is_a?(BaseModel)
+            v.to_hash
+          else
+            v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
+          end
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into a map of unix format string
+    # @param [hash] an array of DateTime objects
+    # @return [hash] an array of unix formatted datetime string
+    def self.to_unix_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        if v.is_a?(BaseModel)
+          v.to_hash
+        else
+          v.is_a?(DateTime) ? DateTimeHelper.to_unix(v) : v
+        end
+      end
+    end
+
+    # Safely converts a DateTime object into a rfc3339 format string
+    # @param [DateTime] The DateTime object
+    # @return [String] The rfc3339 formatted datetime string
+    def self.to_rfc3339(date_time)
+      date_time.rfc3339 unless date_time.nil?
+    end
+
+    # Safely converts a map of DateTime objects into a map of rfc1123 format string
+    # @param [hash] a map of DateTime objects
+    # @return [hash] a map of rfc1123 formatted datetime string
+    def self.to_rfc3339_map(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = {}
+      date_time.each do |k, v|
+        hash[key][k] =
+          if v.is_a?(BaseModel)
+            v.to_hash
+          else
+            v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
+          end
+      end
+      hash[key]
+    end
+
+    # Safely converts an array of DateTime objects into an array of rfc1123 format string
+    # @param [Array] an array of DateTime objects
+    # @return [Array] an array of rfc1123 formatted datetime string
+    def self.to_rfc3339_array(date_time, hash, key)
+      return if date_time.nil?
+
+      hash[key] = date_time.map do |v|
+        if v.is_a?(BaseModel)
+          v.to_hash
+        else
+          v.is_a?(DateTime) ? DateTimeHelper.to_rfc3339(v) : v
+        end
+      end
+    end
+
+    # Safely converts a rfc1123 format string into a DateTime object
+    # @param [String] The rfc1123 formatted datetime string
+    # @return [DateTime] A DateTime object
+    def self.from_rfc1123(date_time)
+      DateTime.httpdate(date_time)
+    end
+
+    # Safely converts a unix format string into a DateTime object
+    # @param [String] The unix formatted datetime string
+    # @return [DateTime] A DateTime object
+    def self.from_unix(date_time)
+      Time.at(date_time.to_i).utc.to_datetime
+    end
+
+    # Safely converts a rfc3339 format string into a DateTime object
+    # @param [String] The rfc3339 formatted datetime string
+    # @return [DateTime] A DateTime object
+    def self.from_rfc3339(date_time)
+      # missing timezone information
+      if date_time.end_with?('Z') || date_time.index('+')
+        DateTime.rfc3339(date_time)
+      else
+        DateTime.rfc3339("#{date_time}Z")
+      end
+    end
+  end
+end