class Trulioo::VerifyRequest
The verification call for the Normalized API is a POST method call
Attributes
Indicate that Trulioo
terms and conditions are accepted
Set to true if you want to receive address cleanse information, This will only change the response if you have address cleansing enabled for the country you are querying for.
Indicate the configuration used for the verification. Currently only 'Identity Verification' is supported.
Some datasources required your customer provide consent to access them. Set that the customer has provided consent for each datasource that requires one. If consent is not provided the datasource will not be queried.
The country code for which the verification needs to be performed.
Customer Reference Id
This field is not used anymore. If provided it must match the setting on your account or you will get an error.
Verbose Mode Output Flag.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/trulioo_sdk/models/verify_request.rb, line 63 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/trulioo_sdk/models/verify_request.rb, line 46 def self.attribute_map { :'accept_trulioo_terms_and_conditions' => :'AcceptTruliooTermsAndConditions', :'demo' => :'Demo', :'call_back_url' => :'CallBackUrl', :'timeout' => :'Timeout', :'cleansed_address' => :'CleansedAddress', :'configuration_name' => :'ConfigurationName', :'consent_for_data_sources' => :'ConsentForDataSources', :'country_code' => :'CountryCode', :'customer_reference_id' => :'CustomerReferenceID', :'data_fields' => :'DataFields', :'verbose_mode' => :'VerboseMode' } end
:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/trulioo_sdk/models/verify_request.rb, line 281 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/trulioo_sdk/models/verify_request.rb, line 92 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::VerifyRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Trulioo::VerifyRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'accept_trulioo_terms_and_conditions') self.accept_trulioo_terms_and_conditions = attributes[:'accept_trulioo_terms_and_conditions'] end if attributes.key?(:'demo') self.demo = attributes[:'demo'] end if attributes.key?(:'call_back_url') self.call_back_url = attributes[:'call_back_url'] end if attributes.key?(:'timeout') self.timeout = attributes[:'timeout'] end if attributes.key?(:'cleansed_address') self.cleansed_address = attributes[:'cleansed_address'] end if attributes.key?(:'configuration_name') self.configuration_name = attributes[:'configuration_name'] end if attributes.key?(:'consent_for_data_sources') if (value = attributes[:'consent_for_data_sources']).is_a?(Array) self.consent_for_data_sources = value end end if attributes.key?(:'country_code') self.country_code = attributes[:'country_code'] end if attributes.key?(:'customer_reference_id') self.customer_reference_id = attributes[:'customer_reference_id'] end if attributes.key?(:'data_fields') self.data_fields = attributes[:'data_fields'] end if attributes.key?(:'verbose_mode') self.verbose_mode = attributes[:'verbose_mode'] end end
List of attributes with nullable: true
# File lib/trulioo_sdk/models/verify_request.rb, line 85 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/trulioo_sdk/models/verify_request.rb, line 68 def self.openapi_types { :'accept_trulioo_terms_and_conditions' => :'Boolean', :'demo' => :'Boolean', :'call_back_url' => :'String', :'timeout' => :'Integer', :'cleansed_address' => :'Boolean', :'configuration_name' => :'String', :'consent_for_data_sources' => :'Array<String>', :'country_code' => :'String', :'customer_reference_id' => :'String', :'data_fields' => :'DataFields', :'verbose_mode' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/trulioo_sdk/models/verify_request.rb, line 249 def ==(o) return true if self.equal?(o) self.class == o.class && accept_trulioo_terms_and_conditions == o.accept_trulioo_terms_and_conditions && demo == o.demo && call_back_url == o.call_back_url && timeout == o.timeout && cleansed_address == o.cleansed_address && configuration_name == o.configuration_name && consent_for_data_sources == o.consent_for_data_sources && country_code == o.country_code && customer_reference_id == o.customer_reference_id && data_fields == o.data_fields && verbose_mode == o.verbose_mode end
:nocov: Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/trulioo_sdk/models/verify_request.rb, line 315 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Trulioo.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
:nocov: 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/trulioo_sdk/models/verify_request.rb, line 394 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
:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/trulioo_sdk/models/verify_request.rb, line 290 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif 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 end self end
Custom attribute writer method with validation @param [Object] call_back_url
Value to be assigned
# File lib/trulioo_sdk/models/verify_request.rb, line 207 def call_back_url=(call_back_url) if !call_back_url.nil? && call_back_url.to_s.length > 2083 fail ArgumentError, 'invalid value for "call_back_url", the character length must be smaller than or equal to 2083.' end if !call_back_url.nil? && call_back_url.to_s.length < 0 fail ArgumentError, 'invalid value for "call_back_url", the character length must be great than or equal to 0.' end @call_back_url = call_back_url end
Custom attribute writer method with validation @param [Object] configuration_name
Value to be assigned
# File lib/trulioo_sdk/models/verify_request.rb, line 221 def configuration_name=(configuration_name) if !configuration_name.nil? && configuration_name.to_s.length > 45 fail ArgumentError, 'invalid value for "configuration_name", the character length must be smaller than or equal to 45.' end if !configuration_name.nil? && configuration_name.to_s.length < 0 fail ArgumentError, 'invalid value for "configuration_name", the character length must be great than or equal to 0.' end @configuration_name = configuration_name end
Custom attribute writer method with validation @param [Object] customer_reference_id
Value to be assigned
# File lib/trulioo_sdk/models/verify_request.rb, line 235 def customer_reference_id=(customer_reference_id) if !customer_reference_id.nil? && customer_reference_id.to_s.length > 128 fail ArgumentError, 'invalid value for "customer_reference_id", the character length must be smaller than or equal to 128.' end if !customer_reference_id.nil? && customer_reference_id.to_s.length < 0 fail ArgumentError, 'invalid value for "customer_reference_id", the character length must be great than or equal to 0.' end @customer_reference_id = customer_reference_id end
@see the `==` method @param [Object] Object to be compared
# File lib/trulioo_sdk/models/verify_request.rb, line 267 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/trulioo_sdk/models/verify_request.rb, line 273 def hash [accept_trulioo_terms_and_conditions, demo, call_back_url, timeout, cleansed_address, configuration_name, consent_for_data_sources, country_code, customer_reference_id, data_fields, verbose_mode].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/trulioo_sdk/models/verify_request.rb, line 154 def list_invalid_properties invalid_properties = Array.new if !@call_back_url.nil? && @call_back_url.to_s.length > 2083 invalid_properties.push('invalid value for "call_back_url", the character length must be smaller than or equal to 2083.') end if !@call_back_url.nil? && @call_back_url.to_s.length < 0 invalid_properties.push('invalid value for "call_back_url", the character length must be great than or equal to 0.') end if !@configuration_name.nil? && @configuration_name.to_s.length > 45 invalid_properties.push('invalid value for "configuration_name", the character length must be smaller than or equal to 45.') end if !@configuration_name.nil? && @configuration_name.to_s.length < 0 invalid_properties.push('invalid value for "configuration_name", the character length must be great than or equal to 0.') end if @country_code.nil? invalid_properties.push('invalid value for "country_code", country_code cannot be nil.') end if !@customer_reference_id.nil? && @customer_reference_id.to_s.length > 128 invalid_properties.push('invalid value for "customer_reference_id", the character length must be smaller than or equal to 128.') end if !@customer_reference_id.nil? && @customer_reference_id.to_s.length < 0 invalid_properties.push('invalid value for "customer_reference_id", the character length must be great than or equal to 0.') end if @data_fields.nil? invalid_properties.push('invalid value for "data_fields", data_fields cannot be nil.') end invalid_properties end
:nocov: Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/trulioo_sdk/models/verify_request.rb, line 374 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
:nocov: Returns the string representation of the object @return [String] String presentation of the object
# File lib/trulioo_sdk/models/verify_request.rb, line 358 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/trulioo_sdk/models/verify_request.rb, line 193 def valid? return false if !@call_back_url.nil? && @call_back_url.to_s.length > 2083 return false if !@call_back_url.nil? && @call_back_url.to_s.length < 0 return false if !@configuration_name.nil? && @configuration_name.to_s.length > 45 return false if !@configuration_name.nil? && @configuration_name.to_s.length < 0 return false if @country_code.nil? return false if !@customer_reference_id.nil? && @customer_reference_id.to_s.length > 128 return false if !@customer_reference_id.nil? && @customer_reference_id.to_s.length < 0 return false if @data_fields.nil? true end