Class: DocuSign_eSign::ForgottenPasswordInformation

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

Overview

A complex element that has up to four Question/Answer pairs for forgotten password information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForgottenPasswordInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
105
106
107
108
109
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 72

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?(:'forgottenPasswordAnswer1')
    self.forgotten_password_answer1 = attributes[:'forgottenPasswordAnswer1']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#forgotten_password_answer1Object

The answer to the first forgotten password challenge question.


19
20
21
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 19

def forgotten_password_answer1
  @forgotten_password_answer1
end

#forgotten_password_answer2Object

The answer to the second forgotten password challenge question.


22
23
24
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 22

def forgotten_password_answer2
  @forgotten_password_answer2
end

#forgotten_password_answer3Object

The answer to the third forgotten password challenge question.


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

def forgotten_password_answer3
  @forgotten_password_answer3
end

#forgotten_password_answer4Object

The answer to the fourth forgotten password challenge question.


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

def forgotten_password_answer4
  @forgotten_password_answer4
end

#forgotten_password_question1Object

The first challenge question presented to a user who has forgotten their password.


31
32
33
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 31

def forgotten_password_question1
  @forgotten_password_question1
end

#forgotten_password_question2Object

The second challenge question presented to a user who has forgotten their password.


34
35
36
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 34

def forgotten_password_question2
  @forgotten_password_question2
end

#forgotten_password_question3Object

The third challenge question presented to a user who has forgotten their password.


37
38
39
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 37

def forgotten_password_question3
  @forgotten_password_question3
end

#forgotten_password_question4Object

The fourth challenge question presented to a user who has forgotten their password.


40
41
42
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 40

def forgotten_password_question4
  @forgotten_password_question4
end

Class Method Details

.attribute_mapObject

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


43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 43

def self.attribute_map
  {
    :'forgotten_password_answer1' => :'forgottenPasswordAnswer1',
    :'forgotten_password_answer2' => :'forgottenPasswordAnswer2',
    :'forgotten_password_answer3' => :'forgottenPasswordAnswer3',
    :'forgotten_password_answer4' => :'forgottenPasswordAnswer4',
    :'forgotten_password_question1' => :'forgottenPasswordQuestion1',
    :'forgotten_password_question2' => :'forgottenPasswordQuestion2',
    :'forgotten_password_question3' => :'forgottenPasswordQuestion3',
    :'forgotten_password_question4' => :'forgottenPasswordQuestion4'
  }
end

.swagger_typesObject

Attribute type mapping.


57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 57

def self.swagger_types
  {
    :'forgotten_password_answer1' => :'String',
    :'forgotten_password_answer2' => :'String',
    :'forgotten_password_answer3' => :'String',
    :'forgotten_password_answer4' => :'String',
    :'forgotten_password_question1' => :'String',
    :'forgotten_password_question2' => :'String',
    :'forgotten_password_question3' => :'String',
    :'forgotten_password_question4' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      forgotten_password_answer1 == o.forgotten_password_answer1 &&
      forgotten_password_answer2 == o.forgotten_password_answer2 &&
      forgotten_password_answer3 == o.forgotten_password_answer3 &&
      forgotten_password_answer4 == o.forgotten_password_answer4 &&
      forgotten_password_question1 == o.forgotten_password_question1 &&
      forgotten_password_question2 == o.forgotten_password_question2 &&
      forgotten_password_question3 == o.forgotten_password_question3 &&
      forgotten_password_question4 == o.forgotten_password_question4
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


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
207
208
209
210
211
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 175

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


241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 241

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


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 154

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

141
142
143
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 141

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


147
148
149
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 147

def hash
  [forgotten_password_answer1, forgotten_password_answer2, forgotten_password_answer3, forgotten_password_answer4, forgotten_password_question1, forgotten_password_question2, forgotten_password_question3, forgotten_password_question4].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


113
114
115
116
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 113

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


221
222
223
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 221

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


227
228
229
230
231
232
233
234
235
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 227

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


215
216
217
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 215

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


120
121
122
# File 'lib/docusign_esign/models/forgotten_password_information.rb', line 120

def valid?
  true
end