bandwidth-sdk 17.0.1 → 17.1.0

data/lib/bandwidth-sdk/api/toll_free_verification_api.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
 
@@ -74,7 +74,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'WebhookSubscription'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.create_webhook_subscription",
@@ -127,7 +127,7 @@ module Bandwidth
       end
 
       if @api_client.config.client_side_validation && phone_number.to_s.length < 12
-        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.delete_verification_request, the character length must be great than or equal to 12.'
+        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.delete_verification_request, the character length must be greater than or equal to 12.'
       end
 
       pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
@@ -156,7 +156,7 @@ module Bandwidth
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.delete_verification_request",
@@ -225,7 +225,7 @@ module Bandwidth
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.delete_webhook_subscription",
@@ -278,7 +278,7 @@ module Bandwidth
       end
 
       if @api_client.config.client_side_validation && phone_number.to_s.length < 12
-        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.get_toll_free_verification_status, the character length must be great than or equal to 12.'
+        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.get_toll_free_verification_status, the character length must be greater than or equal to 12.'
       end
 
       pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
@@ -307,7 +307,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'TfvStatus'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.get_toll_free_verification_status",
@@ -364,7 +364,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'Array<String>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.list_toll_free_use_cases",
@@ -427,7 +427,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'WebhookSubscriptionsListBody'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.list_webhook_subscriptions",
@@ -501,7 +501,7 @@ module Bandwidth
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.request_toll_free_verification",
@@ -556,7 +556,7 @@ module Bandwidth
       end
 
       if @api_client.config.client_side_validation && phone_number.to_s.length < 12
-        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.update_toll_free_verification_request, the character length must be great than or equal to 12.'
+        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.update_toll_free_verification_request, the character length must be greater than or equal to 12.'
       end
 
       pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
@@ -594,7 +594,7 @@ module Bandwidth
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.update_toll_free_verification_request",
@@ -674,7 +674,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'WebhookSubscription'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TollFreeVerificationApi.update_webhook_subscription",

data/lib/bandwidth-sdk/api/transcriptions_api.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
 
@@ -75,7 +75,7 @@ module Bandwidth
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TranscriptionsApi.delete_real_time_transcription",
@@ -150,7 +150,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'CallTranscriptionResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TranscriptionsApi.get_real_time_transcription",
@@ -219,7 +219,7 @@ module Bandwidth
       return_type = opts[:debug_return_type] || 'Array<CallTranscriptionMetadata>'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['Basic']
+      auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2']
 
       new_options = opts.merge(
         :operation => :"TranscriptionsApi.list_real_time_transcriptions",

data/lib/bandwidth-sdk/api_client.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
 
@@ -322,9 +322,13 @@ module Bandwidth
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models (e.g. Pet) or oneOf
+        # models (e.g. Pet) or oneOf/anyOf
         klass = Bandwidth.const_get(return_type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
+        if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of)
+          klass.build(data)
+        else
+          klass.build_from_hash(data)
+        end
       end
     end
 
@@ -353,8 +357,8 @@ module Bandwidth
         auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
         case auth_setting[:in]
-        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value] unless auth_setting[:value].nil?
+        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value] unless auth_setting[:value].nil?
         else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end

data/lib/bandwidth-sdk/api_error.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
 

data/lib/bandwidth-sdk/api_model_base.rb

@@ -0,0 +1,88 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+module Bandwidth
+  class ApiModelBase
+    # 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
+
+    # 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/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