bandwidth-sdk 17.0.0 → 17.1.0

data/lib/bandwidth-sdk/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.17.0
 
 =end
 
@@ -59,6 +59,16 @@ module Bandwidth
     # @return [String]
     attr_accessor :password
 
+    # Defines the client ID used with OAuth2.
+    # 
+    # @return [String]
+    attr_accessor :client_id
+
+    # Defines the client secret used with OAuth2.
+    # 
+    # @return [String]
+    attr_accessor :client_secret
+
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
@@ -182,6 +192,32 @@ module Bandwidth
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @access_token_expiration = nil
+      @access_token_getter = Proc.new {
+        access_token_valid = @access_token && (@access_token_expiration.nil? || @access_token_expiration > Time.now + 60)
+        next @access_token if access_token_valid
+        next unless @client_id && @client_secret
+
+        puts "Refreshing access token..." if @debugging
+        # obtain new access token using client credentials
+        token_url = 'https://api.bandwidth.com/api/v1/oauth2/token'
+        auth_header = 'Basic ' + ["#{@client_id}:#{@client_secret}"].pack('m').delete("\r\n")
+        conn = Faraday.new(url: token_url) do |faraday|
+          faraday.request :url_encoded
+          faraday.adapter Faraday.default_adapter
+        end
+        response = conn.post do |req|
+          req.headers['Authorization'] = auth_header
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = 'grant_type=client_credentials'
+        end
+        if response.status != 200
+          raise "Failed to obtain access token: #{response.status} #{response.body}"
+        end
+        body = JSON.parse(response.body)
+        @access_token = body['access_token']
+        @access_token_expiration = Time.now + body['expires_in']
+      }
 
       yield(self) if block_given?
     end
@@ -245,6 +281,12 @@ module Bandwidth
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
     end
 
+    # Gets Bearer auth token string
+    def oauth_bearer_token
+      "Bearer #{access_token_with_refresh}" unless access_token_with_refresh.nil?
+    end
+
+
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
@@ -255,6 +297,13 @@ module Bandwidth
             key: 'Authorization',
             value: basic_auth_token
           },
+        'OAuth2' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: oauth_bearer_token
+          },
       }
     end
 

data/lib/bandwidth-sdk/models/account_statistics.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.17.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class AccountStatistics
+  class AccountStatistics < ApiModelBase
     # The number of calls currently enqueued.
     attr_accessor :current_call_queue_size
 
@@ -29,9 +29,14 @@ module Bandwidth
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -56,9 +61,10 @@ module Bandwidth
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AccountStatistics`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AccountStatistics`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -131,61 +137,6 @@ module Bandwidth
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = Bandwidth.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -201,23 +152,5 @@ module Bandwidth
       end
       hash
     end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
   end
 end

data/lib/bandwidth-sdk/models/additional_denial_reason.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.17.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class AdditionalDenialReason
+  class AdditionalDenialReason < ApiModelBase
     # Reason code for denial.
     attr_accessor :status_code
 
@@ -33,9 +33,14 @@ module Bandwidth
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -61,9 +66,10 @@ module Bandwidth
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AdditionalDenialReason`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AdditionalDenialReason`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -117,6 +123,36 @@ module Bandwidth
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] status_code Value to be assigned
+    def status_code=(status_code)
+      if status_code.nil?
+        fail ArgumentError, 'status_code cannot be nil'
+      end
+
+      @status_code = status_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reason Value to be assigned
+    def reason=(reason)
+      if reason.nil?
+        fail ArgumentError, 'reason cannot be nil'
+      end
+
+      @reason = reason
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] resubmit_allowed Value to be assigned
+    def resubmit_allowed=(resubmit_allowed)
+      if resubmit_allowed.nil?
+        fail ArgumentError, 'resubmit_allowed cannot be nil'
+      end
+
+      @resubmit_allowed = resubmit_allowed
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -162,61 +198,6 @@ module Bandwidth
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = Bandwidth.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -232,23 +213,5 @@ module Bandwidth
       end
       hash
     end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
   end
 end

data/lib/bandwidth-sdk/models/address.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: letstalk@bandwidth.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.8.0
+Generator version: 7.17.0
 
 =end
 
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class Address
+  class Address < ApiModelBase
     # The name of the business using the toll-free number.
     attr_accessor :name
 
@@ -49,9 +49,14 @@ module Bandwidth
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -82,9 +87,10 @@ module Bandwidth
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::Address`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::Address`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -144,7 +150,7 @@ module Bandwidth
       end
 
       if @name.to_s.length < 1
-        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
       end
 
       if @addr1.nil?
@@ -156,7 +162,7 @@ module Bandwidth
       end
 
       if @addr1.to_s.length < 1
-        invalid_properties.push('invalid value for "addr1", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "addr1", the character length must be greater than or equal to 1.')
       end
 
       if !@addr2.nil? && @addr2.to_s.length > 500
@@ -164,7 +170,7 @@ module Bandwidth
       end
 
       if !@addr2.nil? && @addr2.to_s.length < 0
-        invalid_properties.push('invalid value for "addr2", the character length must be great than or equal to 0.')
+        invalid_properties.push('invalid value for "addr2", the character length must be greater than or equal to 0.')
       end
 
       if @city.nil?
@@ -176,7 +182,7 @@ module Bandwidth
       end
 
       if @city.to_s.length < 1
-        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "city", the character length must be greater than or equal to 1.')
       end
 
       if @state.nil?
@@ -188,7 +194,7 @@ module Bandwidth
       end
 
       if @state.to_s.length < 1
-        invalid_properties.push('invalid value for "state", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "state", the character length must be greater than or equal to 1.')
       end
 
       if @zip.nil?
@@ -209,7 +215,7 @@ module Bandwidth
       end
 
       if @url.to_s.length < 1
-        invalid_properties.push('invalid value for "url", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "url", the character length must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -253,7 +259,7 @@ module Bandwidth
       end
 
       if name.to_s.length < 1
-        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
       end
 
       @name = name
@@ -271,7 +277,7 @@ module Bandwidth
       end
 
       if addr1.to_s.length < 1
-        fail ArgumentError, 'invalid value for "addr1", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "addr1", the character length must be greater than or equal to 1.'
       end
 
       @addr1 = addr1
@@ -285,7 +291,7 @@ module Bandwidth
       end
 
       if !addr2.nil? && addr2.to_s.length < 0
-        fail ArgumentError, 'invalid value for "addr2", the character length must be great than or equal to 0.'
+        fail ArgumentError, 'invalid value for "addr2", the character length must be greater than or equal to 0.'
       end
 
       @addr2 = addr2
@@ -303,7 +309,7 @@ module Bandwidth
       end
 
       if city.to_s.length < 1
-        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "city", the character length must be greater than or equal to 1.'
       end
 
       @city = city
@@ -321,7 +327,7 @@ module Bandwidth
       end
 
       if state.to_s.length < 1
-        fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "state", the character length must be greater than or equal to 1.'
       end
 
       @state = state
@@ -354,7 +360,7 @@ module Bandwidth
       end
 
       if url.to_s.length < 1
-        fail ArgumentError, 'invalid value for "url", the character length must be great than or equal to 1.'
+        fail ArgumentError, 'invalid value for "url", the character length must be greater than or equal to 1.'
       end
 
       @url = url
@@ -409,61 +415,6 @@ module Bandwidth
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = Bandwidth.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -479,23 +430,5 @@ module Bandwidth
       end
       hash
     end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
   end
 end