bandwidth-sdk 14.1.3 → 15.0.0

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

@@ -0,0 +1,239 @@
+=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 SmsMessageContent
+    # The contents of the text message. Must be 2048 characters or less.
+    attr_accessor :text
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'text' => :'text'
+      }
+    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
+      {
+        :'text' => :'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::SmsMessageContent` 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::SmsMessageContent`. 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?(:'text')
+        self.text = attributes[:'text']
+      else
+        self.text = 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 @text.nil?
+        invalid_properties.push('invalid value for "text", text cannot be nil.')
+      end
+
+      if @text.to_s.length > 2048
+        invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 2048.')
+      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 @text.nil?
+      return false if @text.to_s.length > 2048
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] text Value to be assigned
+    def text=(text)
+      if text.nil?
+        fail ArgumentError, 'text cannot be nil'
+      end
+
+      if text.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "text", the character length must be smaller than or equal to 2048.'
+      end
+
+      @text = text
+    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 &&
+          text == o.text
+    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
+      [text].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/standalone_card_orientation_enum.rb

@@ -0,0 +1,40 @@
+=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 StandaloneCardOrientationEnum
+    HORIZONTAL = 'HORIZONTAL'.freeze
+    VERTICAL = 'VERTICAL'.freeze
+
+    def self.all_vars
+      @all_vars ||= [HORIZONTAL, VERTICAL].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if StandaloneCardOrientationEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #StandaloneCardOrientationEnum"
+    end
+  end
+end

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

@@ -37,6 +37,12 @@ module Bandwidth
 
     attr_accessor :submission
 
+    # 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
@@ -69,7 +75,9 @@ module Bandwidth
         :'resubmit_allowed' => :'resubmitAllowed',
         :'created_date_time' => :'createdDateTime',
         :'modified_date_time' => :'modifiedDateTime',
-        :'submission' => :'submission'
+        :'submission' => :'submission',
+        :'blocked' => :'blocked',
+        :'blocked_reason' => :'blockedReason'
       }
     end
 
@@ -88,7 +96,9 @@ module Bandwidth
         :'resubmit_allowed' => :'Boolean',
         :'created_date_time' => :'Time',
         :'modified_date_time' => :'Time',
-        :'submission' => :'TfvSubmissionInfo'
+        :'submission' => :'TfvSubmissionInfo',
+        :'blocked' => :'Boolean',
+        :'blocked_reason' => :'String'
       }
     end
 
@@ -144,6 +154,14 @@ module Bandwidth
       if attributes.key?(:'submission')
         self.submission = attributes[:'submission']
       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?
@@ -212,7 +230,9 @@ module Bandwidth
           resubmit_allowed == o.resubmit_allowed &&
           created_date_time == o.created_date_time &&
           modified_date_time == o.modified_date_time &&
-          submission == o.submission
+          submission == o.submission &&
+          blocked == o.blocked &&
+          blocked_reason == o.blocked_reason
     end
 
     # @see the `==` method
@@ -224,7 +244,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, status, internal_ticket_number, decline_reason_description, resubmit_allowed, created_date_time, modified_date_time, submission].hash
+      [phone_number, status, internal_ticket_number, decline_reason_description, resubmit_allowed, created_date_time, modified_date_time, submission, blocked, blocked_reason].hash
     end
 
     # Builds the object from hash

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

@@ -18,11 +18,9 @@ module Bandwidth
     VERIFIED = 'VERIFIED'.freeze
     UNVERIFIED = 'UNVERIFIED'.freeze
     PENDING = 'PENDING'.freeze
-    PARTIALLY_VERIFIED = 'PARTIALLY_VERIFIED'.freeze
-    INVALID_STATUS = 'INVALID_STATUS'.freeze
 
     def self.all_vars
-      @all_vars ||= [VERIFIED, UNVERIFIED, PENDING, PARTIALLY_VERIFIED, INVALID_STATUS].freeze
+      @all_vars ||= [VERIFIED, UNVERIFIED, PENDING].freeze
     end
 
     # Builds the enum from string

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

@@ -39,6 +39,15 @@ module Bandwidth
     # ISV name.
     attr_accessor :isv_reseller
 
+    # The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
+    attr_accessor :privacy_policy_url
+
+    # The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
+    attr_accessor :terms_and_conditions_url
+
+    # The company 'Doing Business As'. (Not Available Until 5/28/2025)
+    attr_accessor :business_dba
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -50,7 +59,10 @@ module Bandwidth
         :'production_message_content' => :'productionMessageContent',
         :'opt_in_workflow' => :'optInWorkflow',
         :'additional_information' => :'additionalInformation',
-        :'isv_reseller' => :'isvReseller'
+        :'isv_reseller' => :'isvReseller',
+        :'privacy_policy_url' => :'privacyPolicyUrl',
+        :'terms_and_conditions_url' => :'termsAndConditionsUrl',
+        :'business_dba' => :'businessDBA'
       }
     end
 
@@ -70,7 +82,10 @@ module Bandwidth
         :'production_message_content' => :'String',
         :'opt_in_workflow' => :'OptInWorkflow',
         :'additional_information' => :'String',
-        :'isv_reseller' => :'String'
+        :'isv_reseller' => :'String',
+        :'privacy_policy_url' => :'String',
+        :'terms_and_conditions_url' => :'String',
+        :'business_dba' => :'String'
       }
     end
 
@@ -78,7 +93,7 @@ module Bandwidth
     def self.openapi_nullable
       Set.new([
         :'additional_information',
-        :'isv_reseller'
+        :'isv_reseller',
       ])
     end
 
@@ -132,6 +147,18 @@ module Bandwidth
       if attributes.key?(:'isv_reseller')
         self.isv_reseller = attributes[:'isv_reseller']
       end
+
+      if attributes.key?(:'privacy_policy_url')
+        self.privacy_policy_url = attributes[:'privacy_policy_url']
+      end
+
+      if attributes.key?(:'terms_and_conditions_url')
+        self.terms_and_conditions_url = attributes[:'terms_and_conditions_url']
+      end
+
+      if attributes.key?(:'business_dba')
+        self.business_dba = attributes[:'business_dba']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -322,7 +349,10 @@ module Bandwidth
           production_message_content == o.production_message_content &&
           opt_in_workflow == o.opt_in_workflow &&
           additional_information == o.additional_information &&
-          isv_reseller == o.isv_reseller
+          isv_reseller == o.isv_reseller &&
+          privacy_policy_url == o.privacy_policy_url &&
+          terms_and_conditions_url == o.terms_and_conditions_url &&
+          business_dba == o.business_dba
     end
 
     # @see the `==` method
@@ -334,7 +364,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [business_address, business_contact, message_volume, use_case, use_case_summary, production_message_content, opt_in_workflow, additional_information, isv_reseller].hash
+      [business_address, business_contact, message_volume, use_case, use_case_summary, production_message_content, opt_in_workflow, additional_information, isv_reseller, privacy_policy_url, terms_and_conditions_url, business_dba].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,40 @@
+=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 ThumbnailAlignmentEnum
+    LEFT = 'LEFT'.freeze
+    RIGHT = 'RIGHT'.freeze
+
+    def self.all_vars
+      @all_vars ||= [LEFT, RIGHT].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ThumbnailAlignmentEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ThumbnailAlignmentEnum"
+    end
+  end
+end

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

@@ -38,6 +38,12 @@ module Bandwidth
 
     attr_accessor :status
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +54,9 @@ module Bandwidth
         :'internal_ticket_number' => :'internalTicketNumber',
         :'phone_number' => :'phoneNumber',
         :'resubmit_allowed' => :'resubmitAllowed',
-        :'status' => :'status'
+        :'status' => :'status',
+        :'blocked' => :'blocked',
+        :'blocked_reason' => :'blockedReason'
       }
     end
 
@@ -67,7 +75,9 @@ module Bandwidth
         :'internal_ticket_number' => :'String',
         :'phone_number' => :'String',
         :'resubmit_allowed' => :'Boolean',
-        :'status' => :'String'
+        :'status' => :'String',
+        :'blocked' => :'Boolean',
+        :'blocked_reason' => :'String'
       }
     end
 
@@ -127,6 +137,14 @@ module Bandwidth
       else
         self.status = 'UNVERIFIED'
       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?
@@ -195,7 +213,9 @@ module Bandwidth
           internal_ticket_number == o.internal_ticket_number &&
           phone_number == o.phone_number &&
           resubmit_allowed == o.resubmit_allowed &&
-          status == o.status
+          status == o.status &&
+          blocked == o.blocked &&
+          blocked_reason == o.blocked_reason
     end
 
     # @see the `==` method
@@ -207,7 +227,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, additional_denial_reasons, decline_reason_description, denial_status_code, internal_ticket_number, phone_number, resubmit_allowed, status].hash
+      [account_id, additional_denial_reasons, decline_reason_description, denial_status_code, internal_ticket_number, phone_number, resubmit_allowed, status, blocked, blocked_reason].hash
     end
 
     # Builds the object from hash

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

@@ -41,6 +41,15 @@ module Bandwidth
     # ISV name.
     attr_accessor :isv_reseller
 
+    # The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025)
+    attr_accessor :privacy_policy_url
+
+    # The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025)
+    attr_accessor :terms_and_conditions_url
+
+    # The company 'Doing Business As'. (Not Available Until 5/28/2025)
+    attr_accessor :business_dba
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -53,7 +62,10 @@ module Bandwidth
         :'production_message_content' => :'productionMessageContent',
         :'opt_in_workflow' => :'optInWorkflow',
         :'additional_information' => :'additionalInformation',
-        :'isv_reseller' => :'isvReseller'
+        :'isv_reseller' => :'isvReseller',
+        :'privacy_policy_url' => :'privacyPolicyUrl',
+        :'terms_and_conditions_url' => :'termsAndConditionsUrl',
+        :'business_dba' => :'businessDBA'
       }
     end
 
@@ -74,7 +86,10 @@ module Bandwidth
         :'production_message_content' => :'String',
         :'opt_in_workflow' => :'OptInWorkflow',
         :'additional_information' => :'String',
-        :'isv_reseller' => :'String'
+        :'isv_reseller' => :'String',
+        :'privacy_policy_url' => :'String',
+        :'terms_and_conditions_url' => :'String',
+        :'business_dba' => :'String'
       }
     end
 
@@ -82,7 +97,7 @@ module Bandwidth
     def self.openapi_nullable
       Set.new([
         :'additional_information',
-        :'isv_reseller'
+        :'isv_reseller',
       ])
     end
 
@@ -158,6 +173,18 @@ module Bandwidth
       if attributes.key?(:'isv_reseller')
         self.isv_reseller = attributes[:'isv_reseller']
       end
+
+      if attributes.key?(:'privacy_policy_url')
+        self.privacy_policy_url = attributes[:'privacy_policy_url']
+      end
+
+      if attributes.key?(:'terms_and_conditions_url')
+        self.terms_and_conditions_url = attributes[:'terms_and_conditions_url']
+      end
+
+      if attributes.key?(:'business_dba')
+        self.business_dba = attributes[:'business_dba']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -417,7 +444,10 @@ module Bandwidth
           production_message_content == o.production_message_content &&
           opt_in_workflow == o.opt_in_workflow &&
           additional_information == o.additional_information &&
-          isv_reseller == o.isv_reseller
+          isv_reseller == o.isv_reseller &&
+          privacy_policy_url == o.privacy_policy_url &&
+          terms_and_conditions_url == o.terms_and_conditions_url &&
+          business_dba == o.business_dba
     end
 
     # @see the `==` method
@@ -429,7 +459,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [business_address, business_contact, message_volume, phone_numbers, use_case, use_case_summary, production_message_content, opt_in_workflow, additional_information, isv_reseller].hash
+      [business_address, business_contact, message_volume, phone_numbers, use_case, use_case_summary, production_message_content, opt_in_workflow, additional_information, isv_reseller, privacy_policy_url, terms_and_conditions_url, business_dba].hash
     end
 
     # Builds the object from hash