class DocuSign_eSign::RecipientSignatureProviderOptions

Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)

Attributes

cpf_number[RW]
cpf_number_metadata[RW]

Reserved for DocuSign.

one_time_password[RW]
one_time_password_metadata[RW]

Metadata that indicates whether the `oneTimePassword` property is editable.

signer_role[RW]
signer_role_metadata[RW]

Metadata that indicates whether the `signerRole` property is editable.

sms[RW]
sms_metadata[RW]

Metadata that indicates whether the `sms` property is editable.

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_signature_provider_options.rb, line 42
def self.attribute_map
  {
    :'cpf_number' => :'cpfNumber',
    :'cpf_number_metadata' => :'cpfNumberMetadata',
    :'one_time_password' => :'oneTimePassword',
    :'one_time_password_metadata' => :'oneTimePasswordMetadata',
    :'signer_role' => :'signerRole',
    :'signer_role_metadata' => :'signerRoleMetadata',
    :'sms' => :'sms',
    :'sms_metadata' => :'smsMetadata'
  }
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_signature_provider_options.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?(:'cpfNumber')
    self.cpf_number = attributes[:'cpfNumber']
  end

  if attributes.has_key?(:'cpfNumberMetadata')
    self.cpf_number_metadata = attributes[:'cpfNumberMetadata']
  end

  if attributes.has_key?(:'oneTimePassword')
    self.one_time_password = attributes[:'oneTimePassword']
  end

  if attributes.has_key?(:'oneTimePasswordMetadata')
    self.one_time_password_metadata = attributes[:'oneTimePasswordMetadata']
  end

  if attributes.has_key?(:'signerRole')
    self.signer_role = attributes[:'signerRole']
  end

  if attributes.has_key?(:'signerRoleMetadata')
    self.signer_role_metadata = attributes[:'signerRoleMetadata']
  end

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

  if attributes.has_key?(:'smsMetadata')
    self.sms_metadata = attributes[:'smsMetadata']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/docusign_esign/models/recipient_signature_provider_options.rb, line 56
def self.swagger_types
  {
    :'cpf_number' => :'String',
    :'cpf_number_metadata' => :'PropertyMetadata',
    :'one_time_password' => :'String',
    :'one_time_password_metadata' => :'PropertyMetadata',
    :'signer_role' => :'String',
    :'signer_role_metadata' => :'PropertyMetadata',
    :'sms' => :'String',
    :'sms_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_signature_provider_options.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cpf_number == o.cpf_number &&
      cpf_number_metadata == o.cpf_number_metadata &&
      one_time_password == o.one_time_password &&
      one_time_password_metadata == o.one_time_password_metadata &&
      signer_role == o.signer_role &&
      signer_role_metadata == o.signer_role_metadata &&
      sms == o.sms &&
      sms_metadata == o.sms_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_signature_provider_options.rb, line 174
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_signature_provider_options.rb, line 240
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_signature_provider_options.rb, line 153
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_signature_provider_options.rb, line 140
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_signature_provider_options.rb, line 146
def hash
  [cpf_number, cpf_number_metadata, one_time_password, one_time_password_metadata, signer_role, signer_role_metadata, sms, sms_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_signature_provider_options.rb, line 112
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_signature_provider_options.rb, line 220
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_signature_provider_options.rb, line 226
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_signature_provider_options.rb, line 214
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_signature_provider_options.rb, line 119
def valid?
  true
end