class Plaid::IdentityVerificationCreateRequest
Request schema for ‘/identity_verification/create’
Attributes
Your Plaid
API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid
products. Financial Account Matching requires this field and the ‘/link/token/create` `client_user_id` to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
A flag specifying whether the end user has already agreed to a privacy policy specifying that their data will be shared with Plaid
for verification purposes. If ‘gave_consent` is set to `true`, the `accept_tos` step will be marked as `skipped` and the end user’s session will start at the next step requirement.
An optional flag specifying how you would like Plaid
to handle attempts to create an Identity Verification when an Identity Verification already exists for the provided ‘client_user_id` and `template_id`. If idempotency is enabled, Plaid
will return the existing Identity Verification. If idempotency is disabled, Plaid
will reject the request with a `400 Bad Request` status code if an Identity Verification already exists for the supplied `client_user_id` and `template_id`.
Your Plaid
API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
ID of the associated Identity Verification template.
Public Class Methods
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 57 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 43 def self.attribute_map { :'client_user_id' => :'client_user_id', :'is_shareable' => :'is_shareable', :'template_id' => :'template_id', :'gave_consent' => :'gave_consent', :'user' => :'user', :'client_id' => :'client_id', :'secret' => :'secret', :'is_idempotent' => :'is_idempotent' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 191 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 85 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IdentityVerificationCreateRequest` 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 `Plaid::IdentityVerificationCreateRequest`. 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?(:'client_user_id') self.client_user_id = attributes[:'client_user_id'] end if attributes.key?(:'is_shareable') self.is_shareable = attributes[:'is_shareable'] end if attributes.key?(:'template_id') self.template_id = attributes[:'template_id'] end if attributes.key?(:'gave_consent') self.gave_consent = attributes[:'gave_consent'] else self.gave_consent = false end if attributes.key?(:'user') self.user = attributes[:'user'] end if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'is_idempotent') self.is_idempotent = attributes[:'is_idempotent'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 76 def self.openapi_nullable Set.new([ :'user', :'is_idempotent' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 62 def self.openapi_types { :'client_user_id' => :'String', :'is_shareable' => :'Boolean', :'template_id' => :'String', :'gave_consent' => :'Boolean', :'user' => :'IdentityVerificationCreateRequestUser', :'client_id' => :'String', :'secret' => :'String', :'is_idempotent' => :'Boolean' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 163 def ==(o) return true if self.equal?(o) self.class == o.class && client_user_id == o.client_user_id && is_shareable == o.is_shareable && template_id == o.template_id && gave_consent == o.gave_consent && user == o.user && client_id == o.client_id && secret == o.secret && is_idempotent == o.is_idempotent end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 222 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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 293 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
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
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 198 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 178 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 184 def hash [client_user_id, is_shareable, template_id, gave_consent, user, client_id, secret, is_idempotent].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 135 def list_invalid_properties invalid_properties = Array.new if @is_shareable.nil? invalid_properties.push('invalid value for "is_shareable", is_shareable cannot be nil.') end if @template_id.nil? invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') end if @gave_consent.nil? invalid_properties.push('invalid value for "gave_consent", gave_consent cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 275 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 263 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/identity_verification_create_request.rb, line 154 def valid? return false if @is_shareable.nil? return false if @template_id.nil? return false if @gave_consent.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid