Class: DocuSign_eSign::AuthenticationStatus
- Inherits:
-
Object
- Object
- DocuSign_eSign::AuthenticationStatus
- Defined in:
- lib/docusign_esign/models/authentication_status.rb
Overview
Contains information about the authentication status.
Instance Attribute Summary collapse
-
#access_code_result ⇒ Object
The result of a user’s attempt to authenticate by using an access code.
-
#age_verify_result ⇒ Object
The result of an age verification check.
-
#any_social_id_result ⇒ Object
Deprecated.
-
#facebook_result ⇒ Object
Deprecated.
-
#google_result ⇒ Object
Deprecated.
-
#id_lookup_result ⇒ Object
The result of an ID lookup authentication check.
-
#id_questions_result ⇒ Object
The result of the user’s answers to ID challenge questions.
-
#identity_verification_result ⇒ Object
The result of an [Identity Verification] workflow.
-
#linkedin_result ⇒ Object
Deprecated.
-
#live_id_result ⇒ Object
Deprecated.
-
#ofac_result ⇒ Object
The result of an Office of Foreign Asset Control (OFAC) check.
-
#open_id_result ⇒ Object
Deprecated.
-
#phone_auth_result ⇒ Object
The result of the user’s attempt to authenticate by using two-factor authentication (2FA) through phone messaging.
-
#s_tan_pin_result ⇒ Object
The result of a Student Authentication Network (STAN) authentication check.
-
#salesforce_result ⇒ Object
Success/failure result of authentication using sign-in with a Salesforce account.
-
#signature_provider_result ⇒ Object
The result of the user’s attempt to authenticate by using a signature provider.
-
#sms_auth_result ⇒ Object
The result of the user’s attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
-
#twitter_result ⇒ Object
Deprecated.
-
#yahoo_result ⇒ Object
Deprecated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AuthenticationStatus
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ AuthenticationStatus
Initializes the object
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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 126 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. = 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_result ⇒ Object
The result of a user’s attempt to authenticate by using an access code. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
18 19 20 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 18 def access_code_result @access_code_result end |
#age_verify_result ⇒ Object
The result of an age verification check. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
21 22 23 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 21 def age_verify_result @age_verify_result end |
#any_social_id_result ⇒ Object
Deprecated.
24 25 26 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 24 def @any_social_id_result end |
#facebook_result ⇒ Object
Deprecated.
27 28 29 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 27 def facebook_result @facebook_result end |
#google_result ⇒ Object
Deprecated.
30 31 32 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 30 def google_result @google_result end |
#id_lookup_result ⇒ Object
The result of an ID lookup authentication check. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
36 37 38 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 36 def id_lookup_result @id_lookup_result end |
#id_questions_result ⇒ Object
The result of the user’s answers to ID challenge questions. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
39 40 41 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 39 def id_questions_result @id_questions_result end |
#identity_verification_result ⇒ Object
The result of an [Identity Verification] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
33 34 35 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 33 def identity_verification_result @identity_verification_result end |
#linkedin_result ⇒ Object
Deprecated.
42 43 44 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 42 def linkedin_result @linkedin_result end |
#live_id_result ⇒ Object
Deprecated.
45 46 47 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 45 def live_id_result @live_id_result end |
#ofac_result ⇒ Object
The result of an Office of Foreign Asset Control (OFAC) check. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
48 49 50 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 48 def ofac_result @ofac_result end |
#open_id_result ⇒ Object
Deprecated.
51 52 53 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 51 def open_id_result @open_id_result end |
#phone_auth_result ⇒ Object
The result of the user’s attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
54 55 56 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 54 def phone_auth_result @phone_auth_result end |
#s_tan_pin_result ⇒ Object
The result of a Student Authentication Network (STAN) authentication check. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
66 67 68 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 66 def s_tan_pin_result @s_tan_pin_result end |
#salesforce_result ⇒ Object
Success/failure result of authentication using sign-in with a Salesforce account. It returns: - ‘Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor’s status code for a failed authentication.
57 58 59 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 57 def salesforce_result @salesforce_result end |
#signature_provider_result ⇒ Object
The result of the user’s attempt to authenticate by using a signature provider.
60 61 62 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 60 def signature_provider_result @signature_provider_result end |
#sms_auth_result ⇒ Object
The result of the user’s attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
63 64 65 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 63 def sms_auth_result @sms_auth_result end |
#twitter_result ⇒ Object
Deprecated.
69 70 71 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 69 def twitter_result @twitter_result end |
#yahoo_result ⇒ Object
Deprecated.
72 73 74 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 72 def yahoo_result @yahoo_result end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 75 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_types ⇒ Object
Attribute type mapping.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 100 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.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 224 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 && == o. && 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
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 284 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
350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 350 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
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 263 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
250 251 252 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 250 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
256 257 258 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 256 def hash [access_code_result, age_verify_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_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
211 212 213 214 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 211 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
330 331 332 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 330 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
336 337 338 339 340 341 342 343 344 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 336 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 ⇒ String
Returns the string representation of the object
324 325 326 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 324 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
218 219 220 |
# File 'lib/docusign_esign/models/authentication_status.rb', line 218 def valid? true end |