Class: DocuSign_eSign::AuthenticationStatus

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

Overview

Contains information about the authentication status.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticationStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'lib/docusign_esign/models/authentication_status.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#access_code_resultObject

Returns the value of attribute access_code_result.



17
18
19
# File 'lib/docusign_esign/models/authentication_status.rb', line 17

def access_code_result
  @access_code_result
end

#age_verify_resultObject

Returns the value of attribute age_verify_result.



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

def age_verify_result
  @age_verify_result
end

#any_social_id_resultObject

Returns the value of attribute any_social_id_result.



21
22
23
# File 'lib/docusign_esign/models/authentication_status.rb', line 21

def any_social_id_result
  @any_social_id_result
end

#facebook_resultObject

Returns the value of attribute facebook_result.



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

def facebook_result
  @facebook_result
end

#google_resultObject

Returns the value of attribute google_result.



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

def google_result
  @google_result
end

#id_lookup_resultObject

Returns the value of attribute id_lookup_result.



29
30
31
# File 'lib/docusign_esign/models/authentication_status.rb', line 29

def id_lookup_result
  @id_lookup_result
end

#id_questions_resultObject

Returns the value of attribute id_questions_result.



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

def id_questions_result
  @id_questions_result
end

#identity_verification_resultObject

Returns the value of attribute identity_verification_result.



27
28
29
# File 'lib/docusign_esign/models/authentication_status.rb', line 27

def identity_verification_result
  @identity_verification_result
end

#linkedin_resultObject

Returns the value of attribute linkedin_result.



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

def linkedin_result
  @linkedin_result
end

#live_id_resultObject

Returns the value of attribute live_id_result.



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

def live_id_result
  @live_id_result
end

#ofac_resultObject

Returns the value of attribute ofac_result.



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

def ofac_result
  @ofac_result
end

#open_id_resultObject

Returns the value of attribute open_id_result.



39
40
41
# File 'lib/docusign_esign/models/authentication_status.rb', line 39

def open_id_result
  @open_id_result
end

#phone_auth_resultObject

Returns the value of attribute phone_auth_result.



41
42
43
# File 'lib/docusign_esign/models/authentication_status.rb', line 41

def phone_auth_result
  @phone_auth_result
end

#s_tan_pin_resultObject

Returns the value of attribute s_tan_pin_result.



49
50
51
# File 'lib/docusign_esign/models/authentication_status.rb', line 49

def s_tan_pin_result
  @s_tan_pin_result
end

#salesforce_resultObject

Returns the value of attribute salesforce_result.



43
44
45
# File 'lib/docusign_esign/models/authentication_status.rb', line 43

def salesforce_result
  @salesforce_result
end

#signature_provider_resultObject

Returns the value of attribute signature_provider_result.



45
46
47
# File 'lib/docusign_esign/models/authentication_status.rb', line 45

def signature_provider_result
  @signature_provider_result
end

#sms_auth_resultObject

Returns the value of attribute sms_auth_result.



47
48
49
# File 'lib/docusign_esign/models/authentication_status.rb', line 47

def sms_auth_result
  @sms_auth_result
end

#twitter_resultObject

Returns the value of attribute twitter_result.



51
52
53
# File 'lib/docusign_esign/models/authentication_status.rb', line 51

def twitter_result
  @twitter_result
end

#yahoo_resultObject

Returns the value of attribute yahoo_result.



53
54
55
# File 'lib/docusign_esign/models/authentication_status.rb', line 53

def yahoo_result
  @yahoo_result
end

Class Method Details

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/docusign_esign/models/authentication_status.rb', line 57

def self.attribute_map
  {
    :'access_code_result' => :'accessCodeResult',
    :'age_verify_result' => :'ageVerifyResult',
    :'any_social_id_result' => :'anySocialIDResult',
    :'facebook_result' => :'facebookResult',
    :'google_result' => :'googleResult',
    :'identity_verification_result' => :'identityVerificationResult',
    :'id_lookup_result' => :'idLookupResult',
    :'id_questions_result' => :'idQuestionsResult',
    :'linkedin_result' => :'linkedinResult',
    :'live_id_result' => :'liveIDResult',
    :'ofac_result' => :'ofacResult',
    :'open_id_result' => :'openIDResult',
    :'phone_auth_result' => :'phoneAuthResult',
    :'salesforce_result' => :'salesforceResult',
    :'signature_provider_result' => :'signatureProviderResult',
    :'sms_auth_result' => :'smsAuthResult',
    :'s_tan_pin_result' => :'sTANPinResult',
    :'twitter_result' => :'twitterResult',
    :'yahoo_result' => :'yahooResult'
  }
end

.swagger_typesObject

Attribute type mapping.



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/authentication_status.rb', line 82

def self.swagger_types
  {
    :'access_code_result' => :'EventResult',
    :'age_verify_result' => :'EventResult',
    :'any_social_id_result' => :'EventResult',
    :'facebook_result' => :'EventResult',
    :'google_result' => :'EventResult',
    :'identity_verification_result' => :'EventResult',
    :'id_lookup_result' => :'EventResult',
    :'id_questions_result' => :'EventResult',
    :'linkedin_result' => :'EventResult',
    :'live_id_result' => :'EventResult',
    :'ofac_result' => :'EventResult',
    :'open_id_result' => :'EventResult',
    :'phone_auth_result' => :'EventResult',
    :'salesforce_result' => :'EventResult',
    :'signature_provider_result' => :'EventResult',
    :'sms_auth_result' => :'EventResult',
    :'s_tan_pin_result' => :'EventResult',
    :'twitter_result' => :'EventResult',
    :'yahoo_result' => :'EventResult'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/docusign_esign/models/authentication_status.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code_result == o.access_code_result &&
      age_verify_result == o.age_verify_result &&
      any_social_id_result == o.any_social_id_result &&
      facebook_result == o.facebook_result &&
      google_result == o.google_result &&
      identity_verification_result == o.identity_verification_result &&
      id_lookup_result == o.id_lookup_result &&
      id_questions_result == o.id_questions_result &&
      linkedin_result == o.linkedin_result &&
      live_id_result == o.live_id_result &&
      ofac_result == o.ofac_result &&
      open_id_result == o.open_id_result &&
      phone_auth_result == o.phone_auth_result &&
      salesforce_result == o.salesforce_result &&
      signature_provider_result == o.signature_provider_result &&
      sms_auth_result == o.sms_auth_result &&
      s_tan_pin_result == o.s_tan_pin_result &&
      twitter_result == o.twitter_result &&
      yahoo_result == o.yahoo_result
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/docusign_esign/models/authentication_status.rb', line 267

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



333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/docusign_esign/models/authentication_status.rb', line 333

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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/docusign_esign/models/authentication_status.rb', line 246

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


233
234
235
# File 'lib/docusign_esign/models/authentication_status.rb', line 233

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



239
240
241
# File 'lib/docusign_esign/models/authentication_status.rb', line 239

def hash
  [access_code_result, age_verify_result, any_social_id_result, facebook_result, google_result, identity_verification_result, id_lookup_result, id_questions_result, linkedin_result, live_id_result, ofac_result, open_id_result, phone_auth_result, salesforce_result, signature_provider_result, sms_auth_result, s_tan_pin_result, twitter_result, yahoo_result].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



194
195
196
197
# File 'lib/docusign_esign/models/authentication_status.rb', line 194

def list_invalid_properties
  invalid_properties = Array.new
  return 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



313
314
315
# File 'lib/docusign_esign/models/authentication_status.rb', line 313

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



319
320
321
322
323
324
325
326
327
# File 'lib/docusign_esign/models/authentication_status.rb', line 319

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



307
308
309
# File 'lib/docusign_esign/models/authentication_status.rb', line 307

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



201
202
203
# File 'lib/docusign_esign/models/authentication_status.rb', line 201

def valid?
  return true
end