class DocuSign_eSign::RecipientPhoneAuthentication

A complex type that Contains the elements: * recipMayProvideNumber - Boolean. When set to *true*, the recipient can use whatever phone number they choose. * senderProvidedNumbers - ArrayOfString. A list of phone numbers the recipient can use. * recordVoicePrint - Reserved. * validateRecipProvidedNumber - Reserved.

Attributes

recip_may_provide_number[RW]

Boolean. When set to *true*, the recipient can supply a phone number their choice.

recip_may_provide_number_metadata[RW]

Metadata that indicates whether the `recipMayProvideNumber` property can be edited.

record_voice_print[RW]

Reserved.

record_voice_print_metadata[RW]

Reserved for DocuSign.

sender_provided_numbers[RW]

An Array containing a list of phone numbers the recipient may use for SMS text authentication.

sender_provided_numbers_metadata[RW]

Metadata that indicates whether the `senderProvidedNumbers` property can be edited.

validate_recip_provided_number[RW]

Reserved.

validate_recip_provided_number_metadata[RW]

Reserved for DocuSign.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 42
def self.attribute_map
  {
    :'recip_may_provide_number' => :'recipMayProvideNumber',
    :'recip_may_provide_number_metadata' => :'recipMayProvideNumberMetadata',
    :'record_voice_print' => :'recordVoicePrint',
    :'record_voice_print_metadata' => :'recordVoicePrintMetadata',
    :'sender_provided_numbers' => :'senderProvidedNumbers',
    :'sender_provided_numbers_metadata' => :'senderProvidedNumbersMetadata',
    :'validate_recip_provided_number' => :'validateRecipProvidedNumber',
    :'validate_recip_provided_number_metadata' => :'validateRecipProvidedNumberMetadata'
  }
end

new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 71
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'recipMayProvideNumber')
    self.recip_may_provide_number = attributes[:'recipMayProvideNumber']
  end

  if attributes.has_key?(:'recipMayProvideNumberMetadata')
    self.recip_may_provide_number_metadata = attributes[:'recipMayProvideNumberMetadata']
  end

  if attributes.has_key?(:'recordVoicePrint')
    self.record_voice_print = attributes[:'recordVoicePrint']
  end

  if attributes.has_key?(:'recordVoicePrintMetadata')
    self.record_voice_print_metadata = attributes[:'recordVoicePrintMetadata']
  end

  if attributes.has_key?(:'senderProvidedNumbers')
    if (value = attributes[:'senderProvidedNumbers']).is_a?(Array)
      self.sender_provided_numbers = value
    end
  end

  if attributes.has_key?(:'senderProvidedNumbersMetadata')
    self.sender_provided_numbers_metadata = attributes[:'senderProvidedNumbersMetadata']
  end

  if attributes.has_key?(:'validateRecipProvidedNumber')
    self.validate_recip_provided_number = attributes[:'validateRecipProvidedNumber']
  end

  if attributes.has_key?(:'validateRecipProvidedNumberMetadata')
    self.validate_recip_provided_number_metadata = attributes[:'validateRecipProvidedNumberMetadata']
  end
end

swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 56
def self.swagger_types
  {
    :'recip_may_provide_number' => :'String',
    :'recip_may_provide_number_metadata' => :'PropertyMetadata',
    :'record_voice_print' => :'String',
    :'record_voice_print_metadata' => :'PropertyMetadata',
    :'sender_provided_numbers' => :'Array<String>',
    :'sender_provided_numbers_metadata' => :'PropertyMetadata',
    :'validate_recip_provided_number' => :'String',
    :'validate_recip_provided_number_metadata' => :'PropertyMetadata'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 127
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recip_may_provide_number == o.recip_may_provide_number &&
      recip_may_provide_number_metadata == o.recip_may_provide_number_metadata &&
      record_voice_print == o.record_voice_print &&
      record_voice_print_metadata == o.record_voice_print_metadata &&
      sender_provided_numbers == o.sender_provided_numbers &&
      sender_provided_numbers_metadata == o.sender_provided_numbers_metadata &&
      validate_recip_provided_number == o.validate_recip_provided_number &&
      validate_recip_provided_number_metadata == o.validate_recip_provided_number_metadata
end

_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 176
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

_to_hash(value) click to toggle source

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

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 242
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

build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 155
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 142
def eql?(o)
  self == o
end

hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 148
def hash
  [recip_may_provide_number, recip_may_provide_number_metadata, record_voice_print, record_voice_print_metadata, sender_provided_numbers, sender_provided_numbers_metadata, validate_recip_provided_number, validate_recip_provided_number_metadata].hash
end

list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 114
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 222
def to_body
  to_hash
end

to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 228
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 216
def to_s
  to_hash.to_s
end

valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docusign_esign/models/recipient_phone_authentication.rb, line 121
def valid?
  true
end