class DocuSign_eSign::AuthenticationStatus
Contains information about the authentication status.
Attributes
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.
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.
Deprecated.
Deprecated.
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.
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.
The result of an [Identity Verification] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
Deprecated.
Deprecated.
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.
Deprecated.
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.
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.
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.
The result of the user's attempt to authenticate by using a signature provider.
The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
Deprecated.
Deprecated.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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.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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# 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 && 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
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/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
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/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
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/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
@see the `==` method @param [Object] Object
to be compared
# File lib/docusign_esign/models/authentication_status.rb, line 250 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/authentication_status.rb, line 256 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/authentication_status.rb, line 211 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/authentication_status.rb, line 324 def to_s to_hash.to_s end
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/authentication_status.rb, line 218 def valid? true end