bandwidth-sdk 13.1.4 → 14.1.0

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

@@ -0,0 +1,242 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  # A list of all webhook subscriptions registered for this account ID for this particular feature (unpaginated).
+  class WebhookSubscriptionsListBody
+    attr_accessor :links
+
+    attr_accessor :errors
+
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'links' => :'links',
+        :'errors' => :'errors',
+        :'data' => :'data'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'links' => :'LinksObject',
+        :'errors' => :'Array<Error>',
+        :'data' => :'Array<WebhookSubscription>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::WebhookSubscriptionsListBody` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      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::WebhookSubscriptionsListBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'links')
+        self.links = attributes[:'links']
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @data.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          links == o.links &&
+          errors == o.errors &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [links, errors, data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.8.0
 =end
 
 module Bandwidth
-  VERSION = '13.1.4'
+  VERSION = '14.1.0'
 end

data/lib/bandwidth-sdk.rb

@@ -18,6 +18,8 @@ require 'bandwidth-sdk/configuration'
 
 # Models
 require 'bandwidth-sdk/models/account_statistics'
+require 'bandwidth-sdk/models/additional_denial_reason'
+require 'bandwidth-sdk/models/address'
 require 'bandwidth-sdk/models/answer_callback'
 require 'bandwidth-sdk/models/bridge_complete_callback'
 require 'bandwidth-sdk/models/bridge_target_complete_callback'
@@ -31,6 +33,7 @@ require 'bandwidth-sdk/models/call_transcription_metadata'
 require 'bandwidth-sdk/models/call_transcription_response'
 require 'bandwidth-sdk/models/call_transcription_track_enum'
 require 'bandwidth-sdk/models/callback_method_enum'
+require 'bandwidth-sdk/models/callback_type_enum'
 require 'bandwidth-sdk/models/code_request'
 require 'bandwidth-sdk/models/conference'
 require 'bandwidth-sdk/models/conference_completed_callback'
@@ -42,6 +45,7 @@ require 'bandwidth-sdk/models/conference_recording_available_callback'
 require 'bandwidth-sdk/models/conference_recording_metadata'
 require 'bandwidth-sdk/models/conference_redirect_callback'
 require 'bandwidth-sdk/models/conference_state_enum'
+require 'bandwidth-sdk/models/contact'
 require 'bandwidth-sdk/models/create_call'
 require 'bandwidth-sdk/models/create_call_response'
 require 'bandwidth-sdk/models/create_lookup_response'
@@ -50,12 +54,13 @@ require 'bandwidth-sdk/models/deferred_result'
 require 'bandwidth-sdk/models/disconnect_callback'
 require 'bandwidth-sdk/models/diversion'
 require 'bandwidth-sdk/models/dtmf_callback'
+require 'bandwidth-sdk/models/error'
+require 'bandwidth-sdk/models/failure_webhook'
 require 'bandwidth-sdk/models/field_error'
 require 'bandwidth-sdk/models/file_format_enum'
 require 'bandwidth-sdk/models/gather_callback'
-require 'bandwidth-sdk/models/inbound_message_callback'
-require 'bandwidth-sdk/models/inbound_message_callback_message'
 require 'bandwidth-sdk/models/initiate_callback'
+require 'bandwidth-sdk/models/links_object'
 require 'bandwidth-sdk/models/list_message_direction_enum'
 require 'bandwidth-sdk/models/list_message_item'
 require 'bandwidth-sdk/models/lookup_request'
@@ -68,14 +73,10 @@ require 'bandwidth-sdk/models/machine_detection_mode_enum'
 require 'bandwidth-sdk/models/machine_detection_result'
 require 'bandwidth-sdk/models/media'
 require 'bandwidth-sdk/models/message'
-require 'bandwidth-sdk/models/message_delivered_callback'
-require 'bandwidth-sdk/models/message_delivered_callback_message'
+require 'bandwidth-sdk/models/message_callback'
+require 'bandwidth-sdk/models/message_callback_message'
 require 'bandwidth-sdk/models/message_direction_enum'
-require 'bandwidth-sdk/models/message_failed_callback'
-require 'bandwidth-sdk/models/message_failed_callback_message'
 require 'bandwidth-sdk/models/message_request'
-require 'bandwidth-sdk/models/message_sending_callback'
-require 'bandwidth-sdk/models/message_sending_callback_message'
 require 'bandwidth-sdk/models/message_status_enum'
 require 'bandwidth-sdk/models/message_type_enum'
 require 'bandwidth-sdk/models/messages_list'
@@ -84,6 +85,7 @@ require 'bandwidth-sdk/models/messaging_request_error'
 require 'bandwidth-sdk/models/mfa_forbidden_request_error'
 require 'bandwidth-sdk/models/mfa_request_error'
 require 'bandwidth-sdk/models/mfa_unauthorized_request_error'
+require 'bandwidth-sdk/models/opt_in_workflow'
 require 'bandwidth-sdk/models/page_info'
 require 'bandwidth-sdk/models/priority_enum'
 require 'bandwidth-sdk/models/recording_available_callback'
@@ -95,6 +97,14 @@ require 'bandwidth-sdk/models/redirect_callback'
 require 'bandwidth-sdk/models/redirect_method_enum'
 require 'bandwidth-sdk/models/stir_shaken'
 require 'bandwidth-sdk/models/tag'
+require 'bandwidth-sdk/models/telephone_number'
+require 'bandwidth-sdk/models/tfv_basic_authentication'
+require 'bandwidth-sdk/models/tfv_callback_status_enum'
+require 'bandwidth-sdk/models/tfv_error'
+require 'bandwidth-sdk/models/tfv_status'
+require 'bandwidth-sdk/models/tfv_status_enum'
+require 'bandwidth-sdk/models/tfv_submission_info'
+require 'bandwidth-sdk/models/tfv_submission_wrapper'
 require 'bandwidth-sdk/models/tn_lookup_request_error'
 require 'bandwidth-sdk/models/transcribe_recording'
 require 'bandwidth-sdk/models/transcription'
@@ -106,10 +116,19 @@ require 'bandwidth-sdk/models/update_call'
 require 'bandwidth-sdk/models/update_call_recording'
 require 'bandwidth-sdk/models/update_conference'
 require 'bandwidth-sdk/models/update_conference_member'
+require 'bandwidth-sdk/models/verification_denial_webhook'
+require 'bandwidth-sdk/models/verification_request'
+require 'bandwidth-sdk/models/verification_update_request'
+require 'bandwidth-sdk/models/verification_webhook'
 require 'bandwidth-sdk/models/verify_code_request'
 require 'bandwidth-sdk/models/verify_code_response'
 require 'bandwidth-sdk/models/voice_api_error'
 require 'bandwidth-sdk/models/voice_code_response'
+require 'bandwidth-sdk/models/webhook_subscription'
+require 'bandwidth-sdk/models/webhook_subscription_basic_authentication'
+require 'bandwidth-sdk/models/webhook_subscription_request_schema'
+require 'bandwidth-sdk/models/webhook_subscription_type_enum'
+require 'bandwidth-sdk/models/webhook_subscriptions_list_body'
 
 # BXML
 require 'bandwidth-sdk/models/bxml/root'
@@ -155,6 +174,7 @@ require 'bandwidth-sdk/api/messages_api'
 require 'bandwidth-sdk/api/phone_number_lookup_api'
 require 'bandwidth-sdk/api/recordings_api'
 require 'bandwidth-sdk/api/statistics_api'
+require 'bandwidth-sdk/api/toll_free_verification_api'
 require 'bandwidth-sdk/api/transcriptions_api'
 
 module Bandwidth

data/openapi-config.yml

@@ -6,7 +6,7 @@ gemLicense: MIT
 gemName: bandwidth-sdk
 gemRequiredRubyVersion: '>=2.7'
 gemSummary: Bandwidth Ruby SDK
-gemVersion: 11.0.0
+gemVersion: 1.0.0
 library: faraday
 moduleName: Bandwidth
 templateDir: custom_templates

data/spec/call_utils.rb

@@ -41,13 +41,13 @@ end
 def cleanup_calls(calls, calls_api)
   attempts = 0
 
-  while (calls.length > 0 && attempts < 10)
+  while (calls&.length > 0 && attempts < 10)
     calls.delete_if { |call_id| call_ended(call_id, calls_api) }
     sleep(SLEEP_TIME_S)
     attempts += 1
   end
 
-  if (calls.length > 0)
+  if (calls&.length > 0)
     error_message = 'Failed to terminate all calls' + calls.to_s
     raise StandardError.new error_message
   end

data/spec/smoke/toll_free_verification_api_spec.rb

@@ -0,0 +1,69 @@
+# Integration tests for Bandwidth::TollFreeVerificationApi
+describe 'TollFreeVerificationApi' do
+  before(:all) do
+    Bandwidth.configure do |config|
+      config.username = BW_USERNAME
+      config.password = BW_PASSWORD
+    end
+    @tfv_api_instance = Bandwidth::TollFreeVerificationApi.new
+  end
+
+  # Create Webhook Subscription
+  describe 'create_webhook_subscription test' do
+    it 'creates webhook subscription' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # Delete Webhook Subscription
+  describe 'delete_webhook_subscription test' do
+    it 'deletes webhook subscription' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # Get Toll-Free Verification Status
+  describe 'get_toll_free_verification_status test' do
+    it 'gets toll free verification status' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # List Toll-Free Use Cases
+  describe 'list_toll_free_use_cases test' do
+    it 'lists toll free use cases' do
+      data, status_code = @tfv_api_instance.list_toll_free_use_cases_with_http_info
+
+      expect(status_code).to eq(200)
+      expect(data).to be_instance_of(Array)
+    end
+  end
+
+  # List Webhook Subscriptions
+  describe 'list_webhook_subscriptions test' do
+    it 'lists webhook subscriptions' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # Request Toll-Free Verification
+  describe 'request_toll_free_verification test' do
+    it 'requests toll free verification' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # Update Toll-Free Verification Request
+  describe 'update_toll_free_verification_request test' do
+    it 'updates toll free verification request' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # Update Webhook Subscription
+  describe 'update_webhook_subscription test' do
+    it 'updates webhook subscription' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ SimpleCov.start do
   end
   add_group 'Models', 'lib/bandwidth-sdk/models/'
   add_group 'APIs', 'lib/bandwidth-sdk/api/'
-  add_group 'Client', ['api_client.rb', 'api_error.rb', 'configuration.rb', 'bandwidth-sdk.rb']
+  add_group 'Client', ['api_client.rb', 'api_error.rb', 'configuration.rb', 'version.rb', 'bandwidth-sdk.rb']
   add_group 'Tests', 'spec'
 end
 

data/spec/unit/api/mfa_api_spec.rb

@@ -105,7 +105,7 @@ describe 'MFAApi' do
       }.to raise_error(ArgumentError)
     end
 
-    it 'causes an ArgumentError for a missing cvarify_ode_request' do
+    it 'causes an ArgumentError for a missing verify_code_request' do
       expect {
         @mfa_api_instance.verify_code(BW_ACCOUNT_ID, nil)
       }.to raise_error(ArgumentError)