Class: DocuSign_eSign::RecipientSignatureProviderOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/recipient_signature_provider_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecipientSignatureProviderOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 67

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. = attributes[:'cpfNumberMetadata']
  end

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

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

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

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

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

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

Instance Attribute Details

#cpf_numberObject

Returns the value of attribute cpf_number


18
19
20
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 18

def cpf_number
  @cpf_number
end

#cpf_number_metadataObject

Returns the value of attribute cpf_number_metadata


20
21
22
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 20

def 
  @cpf_number_metadata
end

#one_time_passwordObject

Returns the value of attribute one_time_password


23
24
25
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 23

def one_time_password
  @one_time_password
end

#one_time_password_metadataObject

Returns the value of attribute one_time_password_metadata


25
26
27
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 25

def 
  @one_time_password_metadata
end

#signer_roleObject

Returns the value of attribute signer_role


28
29
30
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 28

def signer_role
  @signer_role
end

#signer_role_metadataObject

Returns the value of attribute signer_role_metadata


30
31
32
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 30

def 
  @signer_role_metadata
end

#smsObject

Returns the value of attribute sms


33
34
35
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 33

def sms
  @sms
end

#sms_metadataObject

Returns the value of attribute sms_metadata


35
36
37
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 35

def 
  @sms_metadata
end

Class Method Details

.attribute_mapObject

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


38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 38

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

.swagger_typesObject

Attribute type mapping.


52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 52

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 121

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cpf_number == o.cpf_number &&
       == o. &&
      one_time_password == o.one_time_password &&
       == o. &&
      signer_role == o.signer_role &&
       == o. &&
      sms == o.sms &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 170

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 236

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 149

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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

136
137
138
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 136

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


142
143
144
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 142

def hash
  [cpf_number, , one_time_password, , signer_role, , sms, ].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


108
109
110
111
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


216
217
218
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 216

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


222
223
224
225
226
227
228
229
230
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 222

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


210
211
212
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 210

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


115
116
117
# File 'lib/docusign_esign/models/recipient_signature_provider_options.rb', line 115

def valid?
  true
end