verification_request.rb

=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

require 'date'
require 'time'

module Bandwidth
  class VerificationRequest < ApiModelBase
    attr_accessor :business_address

    attr_accessor :business_contact

    # Estimated monthly volume of messages from the toll-free number.
    attr_accessor :message_volume

    attr_accessor :phone_numbers

    # The category of the use case.
    attr_accessor :use_case

    # A general idea of the use case and customer.
    attr_accessor :use_case_summary

    # Example of message content.
    attr_accessor :production_message_content

    attr_accessor :opt_in_workflow

    # Any additional information.
    attr_accessor :additional_information

    # ISV name.
    attr_accessor :isv_reseller

    # The Toll-Free Verification request privacy policy URL.
    attr_accessor :privacy_policy_url

    # The Toll-Free Verification request terms and conditions policy URL.
    attr_accessor :terms_and_conditions_url

    # The company 'Doing Business As'.
    attr_accessor :business_dba

    # US Federal Tax ID Number (EIN) or Canada Business Number (CBN). Optional until early 2026. If a value is provided for this field, a value must be provided for `businessRegistrationType` and `businessEntityType`. Available starting October 1st, 2025.
    attr_accessor :business_registration_number

    attr_accessor :business_registration_type

    attr_accessor :business_entity_type

    # A message that gets sent to users requesting help.
    attr_accessor :help_message_response

    # Indicates whether the content is age-gated.
    attr_accessor :age_gated_content

    # The token provided by Campaign Verify to validate your political use case. Only required for 527 political organizations. If you are not a 527 political organization, this field should be omitted. Supplying an empty string will likely result in rejection.
    attr_accessor :cv_token

    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
      {
        :'business_address' => :'businessAddress',
        :'business_contact' => :'businessContact',
        :'message_volume' => :'messageVolume',
        :'phone_numbers' => :'phoneNumbers',
        :'use_case' => :'useCase',
        :'use_case_summary' => :'useCaseSummary',
        :'production_message_content' => :'productionMessageContent',
        :'opt_in_workflow' => :'optInWorkflow',
        :'additional_information' => :'additionalInformation',
        :'isv_reseller' => :'isvReseller',
        :'privacy_policy_url' => :'privacyPolicyUrl',
        :'terms_and_conditions_url' => :'termsAndConditionsUrl',
        :'business_dba' => :'businessDba',
        :'business_registration_number' => :'businessRegistrationNumber',
        :'business_registration_type' => :'businessRegistrationType',
        :'business_entity_type' => :'businessEntityType',
        :'help_message_response' => :'helpMessageResponse',
        :'age_gated_content' => :'ageGatedContent',
        :'cv_token' => :'cvToken'
      }
    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
      acceptable_attribute_map.values
    end

    # Attribute type mapping.
    def self.openapi_types
      {
        :'business_address' => :'Address',
        :'business_contact' => :'Contact',
        :'message_volume' => :'Integer',
        :'phone_numbers' => :'Array<String>',
        :'use_case' => :'String',
        :'use_case_summary' => :'String',
        :'production_message_content' => :'String',
        :'opt_in_workflow' => :'OptInWorkflow',
        :'additional_information' => :'String',
        :'isv_reseller' => :'String',
        :'privacy_policy_url' => :'String',
        :'terms_and_conditions_url' => :'String',
        :'business_dba' => :'String',
        :'business_registration_number' => :'String',
        :'business_registration_type' => :'BusinessRegistrationTypeEnum',
        :'business_entity_type' => :'BusinessEntityTypeEnum',
        :'help_message_response' => :'String',
        :'age_gated_content' => :'Boolean',
        :'cv_token' => :'String'
      }
    end

    # List of attributes with nullable: true
    def self.openapi_nullable
      Set.new([
        :'additional_information',
        :'isv_reseller',
        :'business_registration_number',
        :'business_registration_type',
        :'business_entity_type',
        :'help_message_response',
        :'cv_token'
      ])
    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::VerificationRequest` initialize method'
      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 (!acceptable_attribute_map.key?(k.to_sym))
          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::VerificationRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
        end
        h[k.to_sym] = v
      }

      if attributes.key?(:'business_address')
        self.business_address = attributes[:'business_address']
      else
        self.business_address = nil
      end

      if attributes.key?(:'business_contact')
        self.business_contact = attributes[:'business_contact']
      else
        self.business_contact = nil
      end

      if attributes.key?(:'message_volume')
        self.message_volume = attributes[:'message_volume']
      else
        self.message_volume = nil
      end

      if attributes.key?(:'phone_numbers')
        if (value = attributes[:'phone_numbers']).is_a?(Array)
          self.phone_numbers = value
        end
      else
        self.phone_numbers = nil
      end

      if attributes.key?(:'use_case')
        self.use_case = attributes[:'use_case']
      else
        self.use_case = nil
      end

      if attributes.key?(:'use_case_summary')
        self.use_case_summary = attributes[:'use_case_summary']
      else
        self.use_case_summary = nil
      end

      if attributes.key?(:'production_message_content')
        self.production_message_content = attributes[:'production_message_content']
      else
        self.production_message_content = nil
      end

      if attributes.key?(:'opt_in_workflow')
        self.opt_in_workflow = attributes[:'opt_in_workflow']
      else
        self.opt_in_workflow = nil
      end

      if attributes.key?(:'additional_information')
        self.additional_information = attributes[:'additional_information']
      end

      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

      if attributes.key?(:'business_registration_number')
        self.business_registration_number = attributes[:'business_registration_number']
      end

      if attributes.key?(:'business_registration_type')
        self.business_registration_type = attributes[:'business_registration_type']
      end

      if attributes.key?(:'business_entity_type')
        self.business_entity_type = attributes[:'business_entity_type']
      end

      if attributes.key?(:'help_message_response')
        self.help_message_response = attributes[:'help_message_response']
      end

      if attributes.key?(:'age_gated_content')
        self.age_gated_content = attributes[:'age_gated_content']
      end

      if attributes.key?(:'cv_token')
        self.cv_token = attributes[:'cv_token']
      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 @business_address.nil?
        invalid_properties.push('invalid value for "business_address", business_address cannot be nil.')
      end

      if @business_contact.nil?
        invalid_properties.push('invalid value for "business_contact", business_contact cannot be nil.')
      end

      if @message_volume.nil?
        invalid_properties.push('invalid value for "message_volume", message_volume cannot be nil.')
      end

      if @message_volume > 10000000
        invalid_properties.push('invalid value for "message_volume", must be smaller than or equal to 10000000.')
      end

      if @message_volume < 10
        invalid_properties.push('invalid value for "message_volume", must be greater than or equal to 10.')
      end

      if @phone_numbers.nil?
        invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
      end

      if @phone_numbers.length > 10
        invalid_properties.push('invalid value for "phone_numbers", number of items must be less than or equal to 10.')
      end

      if @phone_numbers.length < 1
        invalid_properties.push('invalid value for "phone_numbers", number of items must be greater than or equal to 1.')
      end

      if @use_case.nil?
        invalid_properties.push('invalid value for "use_case", use_case cannot be nil.')
      end

      if @use_case.to_s.length > 500
        invalid_properties.push('invalid value for "use_case", the character length must be smaller than or equal to 500.')
      end

      if @use_case.to_s.length < 0
        invalid_properties.push('invalid value for "use_case", the character length must be greater than or equal to 0.')
      end

      if @use_case_summary.nil?
        invalid_properties.push('invalid value for "use_case_summary", use_case_summary cannot be nil.')
      end

      if @use_case_summary.to_s.length > 500
        invalid_properties.push('invalid value for "use_case_summary", the character length must be smaller than or equal to 500.')
      end

      if @use_case_summary.to_s.length < 0
        invalid_properties.push('invalid value for "use_case_summary", the character length must be greater than or equal to 0.')
      end

      if @production_message_content.nil?
        invalid_properties.push('invalid value for "production_message_content", production_message_content cannot be nil.')
      end

      if @production_message_content.to_s.length > 500
        invalid_properties.push('invalid value for "production_message_content", the character length must be smaller than or equal to 500.')
      end

      if @production_message_content.to_s.length < 0
        invalid_properties.push('invalid value for "production_message_content", the character length must be greater than or equal to 0.')
      end

      if @opt_in_workflow.nil?
        invalid_properties.push('invalid value for "opt_in_workflow", opt_in_workflow cannot be nil.')
      end

      if !@additional_information.nil? && @additional_information.to_s.length > 500
        invalid_properties.push('invalid value for "additional_information", the character length must be smaller than or equal to 500.')
      end

      if !@additional_information.nil? && @additional_information.to_s.length < 0
        invalid_properties.push('invalid value for "additional_information", the character length must be greater than or equal to 0.')
      end

      if !@isv_reseller.nil? && @isv_reseller.to_s.length > 500
        invalid_properties.push('invalid value for "isv_reseller", the character length must be smaller than or equal to 500.')
      end

      if !@isv_reseller.nil? && @isv_reseller.to_s.length < 0
        invalid_properties.push('invalid value for "isv_reseller", the character length must be greater than or equal to 0.')
      end

      if !@business_registration_number.nil? && @business_registration_number.to_s.length > 500
        invalid_properties.push('invalid value for "business_registration_number", the character length must be smaller than or equal to 500.')
      end

      if !@help_message_response.nil? && @help_message_response.to_s.length > 500
        invalid_properties.push('invalid value for "help_message_response", the character length must be smaller than or equal to 500.')
      end

      if !@cv_token.nil? && @cv_token.to_s.length > 500
        invalid_properties.push('invalid value for "cv_token", the character length must be smaller than or equal to 500.')
      end

      if !@cv_token.nil? && @cv_token.to_s.length < 0
        invalid_properties.push('invalid value for "cv_token", the character length must be greater than or equal to 0.')
      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 @business_address.nil?
      return false if @business_contact.nil?
      return false if @message_volume.nil?
      return false if @message_volume > 10000000
      return false if @message_volume < 10
      return false if @phone_numbers.nil?
      return false if @phone_numbers.length > 10
      return false if @phone_numbers.length < 1
      return false if @use_case.nil?
      return false if @use_case.to_s.length > 500
      return false if @use_case.to_s.length < 0
      return false if @use_case_summary.nil?
      return false if @use_case_summary.to_s.length > 500
      return false if @use_case_summary.to_s.length < 0
      return false if @production_message_content.nil?
      return false if @production_message_content.to_s.length > 500
      return false if @production_message_content.to_s.length < 0
      return false if @opt_in_workflow.nil?
      return false if !@additional_information.nil? && @additional_information.to_s.length > 500
      return false if !@additional_information.nil? && @additional_information.to_s.length < 0
      return false if !@isv_reseller.nil? && @isv_reseller.to_s.length > 500
      return false if !@isv_reseller.nil? && @isv_reseller.to_s.length < 0
      return false if !@business_registration_number.nil? && @business_registration_number.to_s.length > 500
      return false if !@help_message_response.nil? && @help_message_response.to_s.length > 500
      return false if !@cv_token.nil? && @cv_token.to_s.length > 500
      return false if !@cv_token.nil? && @cv_token.to_s.length < 0
      true
    end

    # Custom attribute writer method with validation
    # @param [Object] business_address Value to be assigned
    def business_address=(business_address)
      if business_address.nil?
        fail ArgumentError, 'business_address cannot be nil'
      end

      @business_address = business_address
    end

    # Custom attribute writer method with validation
    # @param [Object] business_contact Value to be assigned
    def business_contact=(business_contact)
      if business_contact.nil?
        fail ArgumentError, 'business_contact cannot be nil'
      end

      @business_contact = business_contact
    end

    # Custom attribute writer method with validation
    # @param [Object] message_volume Value to be assigned
    def message_volume=(message_volume)
      if message_volume.nil?
        fail ArgumentError, 'message_volume cannot be nil'
      end

      if message_volume > 10000000
        fail ArgumentError, 'invalid value for "message_volume", must be smaller than or equal to 10000000.'
      end

      if message_volume < 10
        fail ArgumentError, 'invalid value for "message_volume", must be greater than or equal to 10.'
      end

      @message_volume = message_volume
    end

    # Custom attribute writer method with validation
    # @param [Object] phone_numbers Value to be assigned
    def phone_numbers=(phone_numbers)
      if phone_numbers.nil?
        fail ArgumentError, 'phone_numbers cannot be nil'
      end

      if phone_numbers.length > 10
        fail ArgumentError, 'invalid value for "phone_numbers", number of items must be less than or equal to 10.'
      end

      if phone_numbers.length < 1
        fail ArgumentError, 'invalid value for "phone_numbers", number of items must be greater than or equal to 1.'
      end

      @phone_numbers = phone_numbers
    end

    # Custom attribute writer method with validation
    # @param [Object] use_case Value to be assigned
    def use_case=(use_case)
      if use_case.nil?
        fail ArgumentError, 'use_case cannot be nil'
      end

      if use_case.to_s.length > 500
        fail ArgumentError, 'invalid value for "use_case", the character length must be smaller than or equal to 500.'
      end

      if use_case.to_s.length < 0
        fail ArgumentError, 'invalid value for "use_case", the character length must be greater than or equal to 0.'
      end

      @use_case = use_case
    end

    # Custom attribute writer method with validation
    # @param [Object] use_case_summary Value to be assigned
    def use_case_summary=(use_case_summary)
      if use_case_summary.nil?
        fail ArgumentError, 'use_case_summary cannot be nil'
      end

      if use_case_summary.to_s.length > 500
        fail ArgumentError, 'invalid value for "use_case_summary", the character length must be smaller than or equal to 500.'
      end

      if use_case_summary.to_s.length < 0
        fail ArgumentError, 'invalid value for "use_case_summary", the character length must be greater than or equal to 0.'
      end

      @use_case_summary = use_case_summary
    end

    # Custom attribute writer method with validation
    # @param [Object] production_message_content Value to be assigned
    def production_message_content=(production_message_content)
      if production_message_content.nil?
        fail ArgumentError, 'production_message_content cannot be nil'
      end

      if production_message_content.to_s.length > 500
        fail ArgumentError, 'invalid value for "production_message_content", the character length must be smaller than or equal to 500.'
      end

      if production_message_content.to_s.length < 0
        fail ArgumentError, 'invalid value for "production_message_content", the character length must be greater than or equal to 0.'
      end

      @production_message_content = production_message_content
    end

    # Custom attribute writer method with validation
    # @param [Object] opt_in_workflow Value to be assigned
    def opt_in_workflow=(opt_in_workflow)
      if opt_in_workflow.nil?
        fail ArgumentError, 'opt_in_workflow cannot be nil'
      end

      @opt_in_workflow = opt_in_workflow
    end

    # Custom attribute writer method with validation
    # @param [Object] additional_information Value to be assigned
    def additional_information=(additional_information)
      if !additional_information.nil? && additional_information.to_s.length > 500
        fail ArgumentError, 'invalid value for "additional_information", the character length must be smaller than or equal to 500.'
      end

      if !additional_information.nil? && additional_information.to_s.length < 0
        fail ArgumentError, 'invalid value for "additional_information", the character length must be greater than or equal to 0.'
      end

      @additional_information = additional_information
    end

    # Custom attribute writer method with validation
    # @param [Object] isv_reseller Value to be assigned
    def isv_reseller=(isv_reseller)
      if !isv_reseller.nil? && isv_reseller.to_s.length > 500
        fail ArgumentError, 'invalid value for "isv_reseller", the character length must be smaller than or equal to 500.'
      end

      if !isv_reseller.nil? && isv_reseller.to_s.length < 0
        fail ArgumentError, 'invalid value for "isv_reseller", the character length must be greater than or equal to 0.'
      end

      @isv_reseller = isv_reseller
    end

    # Custom attribute writer method with validation
    # @param [Object] business_registration_number Value to be assigned
    def business_registration_number=(business_registration_number)
      if !business_registration_number.nil? && business_registration_number.to_s.length > 500
        fail ArgumentError, 'invalid value for "business_registration_number", the character length must be smaller than or equal to 500.'
      end

      @business_registration_number = business_registration_number
    end

    # Custom attribute writer method with validation
    # @param [Object] help_message_response Value to be assigned
    def help_message_response=(help_message_response)
      if !help_message_response.nil? && help_message_response.to_s.length > 500
        fail ArgumentError, 'invalid value for "help_message_response", the character length must be smaller than or equal to 500.'
      end

      @help_message_response = help_message_response
    end

    # Custom attribute writer method with validation
    # @param [Object] cv_token Value to be assigned
    def cv_token=(cv_token)
      if !cv_token.nil? && cv_token.to_s.length > 500
        fail ArgumentError, 'invalid value for "cv_token", the character length must be smaller than or equal to 500.'
      end

      if !cv_token.nil? && cv_token.to_s.length < 0
        fail ArgumentError, 'invalid value for "cv_token", the character length must be greater than or equal to 0.'
      end

      @cv_token = cv_token
    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 &&
          business_address == o.business_address &&
          business_contact == o.business_contact &&
          message_volume == o.message_volume &&
          phone_numbers == o.phone_numbers &&
          use_case == o.use_case &&
          use_case_summary == o.use_case_summary &&
          production_message_content == o.production_message_content &&
          opt_in_workflow == o.opt_in_workflow &&
          additional_information == o.additional_information &&
          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 &&
          business_registration_number == o.business_registration_number &&
          business_registration_type == o.business_registration_type &&
          business_entity_type == o.business_entity_type &&
          help_message_response == o.help_message_response &&
          age_gated_content == o.age_gated_content &&
          cv_token == o.cv_token
    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
      [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, business_registration_number, business_registration_type, business_entity_type, help_message_response, age_gated_content, cv_token].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

    # 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
  end
end