bandwidth-sdk 15.0.0 → 15.1.0

data/docs/BlockedWebhook.md

@@ -0,0 +1,28 @@
+# Bandwidth::BlockedWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | User's account ID. | [optional] |
+| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
+| **status** | [**TfvCallbackStatusEnum**](TfvCallbackStatusEnum.md) |  | [optional] |
+| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
+| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
+| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BlockedWebhook.new(
+  account_id: 1234567,
+  phone_number: +18005555555,
+  status: null,
+  internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333,
+  blocked: true,
+  blocked_reason: Toll-free number was used to send spam messages
+)
+```
+

data/docs/RbmActionBase.md

@@ -16,7 +16,7 @@ require 'bandwidth-sdk'
 instance = Bandwidth::RbmActionBase.new(
   type: null,
   text: Hello world,
-  post_back_data: [B@204c5ddf
+  post_back_data: [B@6b103db7
 )
 ```
 

data/docs/TfvSubmissionInfo.md

@@ -32,9 +32,9 @@ instance = Bandwidth::TfvSubmissionInfo.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

data/docs/VerificationRequest.md

@@ -34,9 +34,9 @@ instance = Bandwidth::VerificationRequest.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

data/docs/VerificationUpdateRequest.md

@@ -32,9 +32,9 @@ instance = Bandwidth::VerificationUpdateRequest.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

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

@@ -0,0 +1,323 @@
+=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
+  class BlockedWebhook
+    # User's account ID.
+    attr_accessor :account_id
+
+    # Toll-free telephone number in E.164 format.
+    attr_accessor :phone_number
+
+    attr_accessor :status
+
+    # Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.
+    attr_accessor :internal_ticket_number
+
+    # Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    attr_accessor :blocked
+
+    # The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025)
+    attr_accessor :blocked_reason
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'phone_number' => :'phoneNumber',
+        :'status' => :'status',
+        :'internal_ticket_number' => :'internalTicketNumber',
+        :'blocked' => :'blocked',
+        :'blocked_reason' => :'blockedReason'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'phone_number' => :'String',
+        :'status' => :'TfvCallbackStatusEnum',
+        :'internal_ticket_number' => :'String',
+        :'blocked' => :'Boolean',
+        :'blocked_reason' => :'String'
+      }
+    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::BlockedWebhook` 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::BlockedWebhook`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'internal_ticket_number')
+        self.internal_ticket_number = attributes[:'internal_ticket_number']
+      end
+
+      if attributes.key?(:'blocked')
+        self.blocked = attributes[:'blocked']
+      end
+
+      if attributes.key?(:'blocked_reason')
+        self.blocked_reason = attributes[:'blocked_reason']
+      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 !@phone_number.nil? && @phone_number.to_s.length > 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 12.')
+      end
+
+      if !@phone_number.nil? && @phone_number.to_s.length < 12
+        invalid_properties.push('invalid value for "phone_number", the character length must be great than or equal to 12.')
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if !@phone_number.nil? && @phone_number !~ pattern
+        invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
+      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 !@phone_number.nil? && @phone_number.to_s.length > 12
+      return false if !@phone_number.nil? && @phone_number.to_s.length < 12
+      return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if phone_number.nil?
+        fail ArgumentError, 'phone_number cannot be nil'
+      end
+
+      if phone_number.to_s.length > 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 12.'
+      end
+
+      if phone_number.to_s.length < 12
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be great than or equal to 12.'
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if phone_number !~ pattern
+        fail ArgumentError, "invalid value for \"phone_number\", must conform to the pattern #{pattern}."
+      end
+
+      @phone_number = phone_number
+    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 &&
+          account_id == o.account_id &&
+          phone_number == o.phone_number &&
+          status == o.status &&
+          internal_ticket_number == o.internal_ticket_number &&
+          blocked == o.blocked &&
+          blocked_reason == o.blocked_reason
+    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
+      [account_id, phone_number, status, internal_ticket_number, blocked, blocked_reason].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/models/tfv_submission_info.rb

@@ -62,7 +62,7 @@ module Bandwidth
         :'isv_reseller' => :'isvReseller',
         :'privacy_policy_url' => :'privacyPolicyUrl',
         :'terms_and_conditions_url' => :'termsAndConditionsUrl',
-        :'business_dba' => :'businessDBA'
+        :'business_dba' => :'businessDba'
       }
     end
 

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

@@ -65,7 +65,7 @@ module Bandwidth
         :'isv_reseller' => :'isvReseller',
         :'privacy_policy_url' => :'privacyPolicyUrl',
         :'terms_and_conditions_url' => :'termsAndConditionsUrl',
-        :'business_dba' => :'businessDBA'
+        :'business_dba' => :'businessDba'
       }
     end
 

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

@@ -62,7 +62,7 @@ module Bandwidth
         :'isv_reseller' => :'isvReseller',
         :'privacy_policy_url' => :'privacyPolicyUrl',
         :'terms_and_conditions_url' => :'termsAndConditionsUrl',
-        :'business_dba' => :'businessDBA'
+        :'business_dba' => :'businessDba'
       }
     end
 

data/lib/bandwidth-sdk/version.rb

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

data/lib/bandwidth-sdk.rb

@@ -21,6 +21,7 @@ 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/blocked_webhook'
 require 'bandwidth-sdk/models/bridge_complete_callback'
 require 'bandwidth-sdk/models/bridge_target_complete_callback'
 require 'bandwidth-sdk/models/call_direction_enum'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 15.0.0
+  version: 15.1.0
 platform: ruby
 authors:
 - Bandwidth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-13 00:00:00.000000000 Z
+date: 2025-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,6 +147,7 @@ files:
 - docs/AdditionalDenialReason.md
 - docs/Address.md
 - docs/AnswerCallback.md
+- docs/BlockedWebhook.md
 - docs/BridgeCompleteCallback.md
 - docs/BridgeTargetCompleteCallback.md
 - docs/CallDirectionEnum.md
@@ -319,6 +320,7 @@ files:
 - lib/bandwidth-sdk/models/additional_denial_reason.rb
 - lib/bandwidth-sdk/models/address.rb
 - lib/bandwidth-sdk/models/answer_callback.rb
+- lib/bandwidth-sdk/models/blocked_webhook.rb
 - lib/bandwidth-sdk/models/bridge_complete_callback.rb
 - lib/bandwidth-sdk/models/bridge_target_complete_callback.rb
 - lib/bandwidth-sdk/models/bxml/bxml.rb
@@ -587,66 +589,66 @@ summary: Bandwidth Ruby SDK
 test_files:
 - spec/call_utils.rb
 - spec/fixtures/ruby_cat.jpeg
-- spec/smoke/recordings_api_spec.rb
-- spec/smoke/multi_channel_api_spec.rb
-- spec/smoke/phone_number_lookup_api_spec.rb
+- spec/smoke/calls_api_spec.rb
+- spec/smoke/toll_free_verification_api_spec.rb
 - spec/smoke/statistics_api_spec.rb
+- spec/smoke/transcriptions_api_spec.rb
 - spec/smoke/conferences_api_spec.rb
+- spec/smoke/phone_number_lookup_api_spec.rb
 - spec/smoke/mfa_api_spec.rb
-- spec/smoke/transcriptions_api_spec.rb
-- spec/smoke/media_api_spec.rb
-- spec/smoke/toll_free_verification_api_spec.rb
+- spec/smoke/recordings_api_spec.rb
+- spec/smoke/multi_channel_api_spec.rb
 - spec/smoke/messages_api_spec.rb
-- spec/smoke/calls_api_spec.rb
+- spec/smoke/media_api_spec.rb
 - spec/spec_helper.rb
-- spec/unit/client/api_error_spec.rb
-- spec/unit/client/configuration_spec.rb
-- spec/unit/client/api_client_spec.rb
-- spec/unit/api/recordings_api_spec.rb
-- spec/unit/api/multi_channel_api_spec.rb
-- spec/unit/api/phone_number_lookup_api_spec.rb
+- spec/unit/api/calls_api_spec.rb
+- spec/unit/api/toll_free_verification_api_spec.rb
 - spec/unit/api/statistics_api_spec.rb
+- spec/unit/api/transcriptions_api_spec.rb
 - spec/unit/api/conferences_api_spec.rb
+- spec/unit/api/phone_number_lookup_api_spec.rb
 - spec/unit/api/mfa_api_spec.rb
-- spec/unit/api/transcriptions_api_spec.rb
-- spec/unit/api/media_api_spec.rb
-- spec/unit/api/toll_free_verification_api_spec.rb
+- spec/unit/api/recordings_api_spec.rb
+- spec/unit/api/multi_channel_api_spec.rb
 - spec/unit/api/messages_api_spec.rb
-- spec/unit/api/calls_api_spec.rb
-- spec/unit/models/call_state_enum_spec.rb
+- spec/unit/api/media_api_spec.rb
+- spec/unit/models/message_spec.rb
 - spec/unit/models/verify_code_request_spec.rb
 - spec/unit/models/deferred_result_spec.rb
-- spec/unit/models/message_spec.rb
 - spec/unit/models/call_state_spec.rb
-- spec/unit/models/bxml/bxml_spec.rb
-- spec/unit/models/bxml/nestable_verb_spec.rb
-- spec/unit/models/bxml/response_spec.rb
-- spec/unit/models/bxml/verb_spec.rb
+- spec/unit/models/bxml/verbs/start_transcription_spec.rb
+- spec/unit/models/bxml/verbs/redirect_spec.rb
 - spec/unit/models/bxml/verbs/start_recording_spec.rb
-- spec/unit/models/bxml/verbs/stop_gather_spec.rb
-- spec/unit/models/bxml/verbs/pause_spec.rb
-- spec/unit/models/bxml/verbs/stop_transcription_spec.rb
-- spec/unit/models/bxml/verbs/stop_recording_spec.rb
-- spec/unit/models/bxml/verbs/pause_recording_spec.rb
 - spec/unit/models/bxml/verbs/sip_uri_spec.rb
+- spec/unit/models/bxml/verbs/ring_spec.rb
 - spec/unit/models/bxml/verbs/send_dtmf_spec.rb
-- spec/unit/models/bxml/verbs/redirect_spec.rb
+- spec/unit/models/bxml/verbs/phone_number_spec.rb
 - spec/unit/models/bxml/verbs/speak_sentence_spec.rb
-- spec/unit/models/bxml/verbs/start_stream_spec.rb
+- spec/unit/models/bxml/verbs/stop_stream_spec.rb
+- spec/unit/models/bxml/verbs/resume_recording_spec.rb
 - spec/unit/models/bxml/verbs/conference_spec.rb
-- spec/unit/models/bxml/verbs/bridge_spec.rb
-- spec/unit/models/bxml/verbs/hangup_spec.rb
-- spec/unit/models/bxml/verbs/forward_spec.rb
+- spec/unit/models/bxml/verbs/start_stream_spec.rb
 - spec/unit/models/bxml/verbs/record_spec.rb
-- spec/unit/models/bxml/verbs/custom_param_spec.rb
-- spec/unit/models/bxml/verbs/start_transcription_spec.rb
-- spec/unit/models/bxml/verbs/play_audio_spec.rb
-- spec/unit/models/bxml/verbs/resume_recording_spec.rb
-- spec/unit/models/bxml/verbs/ring_spec.rb
-- spec/unit/models/bxml/verbs/stop_stream_spec.rb
-- spec/unit/models/bxml/verbs/stream_param_spec.rb
-- spec/unit/models/bxml/verbs/tag_spec.rb
-- spec/unit/models/bxml/verbs/start_gather_spec.rb
-- spec/unit/models/bxml/verbs/phone_number_spec.rb
+- spec/unit/models/bxml/verbs/stop_gather_spec.rb
+- spec/unit/models/bxml/verbs/pause_recording_spec.rb
 - spec/unit/models/bxml/verbs/gather_spec.rb
+- spec/unit/models/bxml/verbs/stop_recording_spec.rb
 - spec/unit/models/bxml/verbs/transfer_spec.rb
+- spec/unit/models/bxml/verbs/pause_spec.rb
+- spec/unit/models/bxml/verbs/forward_spec.rb
+- spec/unit/models/bxml/verbs/hangup_spec.rb
+- spec/unit/models/bxml/verbs/stop_transcription_spec.rb
+- spec/unit/models/bxml/verbs/bridge_spec.rb
+- spec/unit/models/bxml/verbs/play_audio_spec.rb
+- spec/unit/models/bxml/verbs/start_gather_spec.rb
+- spec/unit/models/bxml/verbs/custom_param_spec.rb
+- spec/unit/models/bxml/verbs/tag_spec.rb
+- spec/unit/models/bxml/verbs/stream_param_spec.rb
+- spec/unit/models/bxml/bxml_spec.rb
+- spec/unit/models/bxml/verb_spec.rb
+- spec/unit/models/bxml/nestable_verb_spec.rb
+- spec/unit/models/bxml/response_spec.rb
+- spec/unit/models/call_state_enum_spec.rb
+- spec/unit/client/configuration_spec.rb
+- spec/unit/client/api_error_spec.rb
+- spec/unit/client/api_client_spec.rb