class Plaid::LinkTokenCreateRequestAuth
Specifies options for initializing Link for use with the Auth product. This field can be used to enable or disable extended Auth flows for the resulting Link session. Omitting any field will result in a default that can be configured by your account manager. The default behavior described in the documentation is the default behavior that will apply if you have not requested your account manager to apply a different default. If you have enabled the [Dashboard Account Verification pane](dashboard.plaid.com/account-verification), the settings enabled there will override any settings in this object.
Attributes
Specifies whether Auth Type Select is enabled for the Link session, allowing the end user to choose between linking via a credentials-based flow (i.e. Instant Auth, Instant Match, Automated Micro-deposits) or a manual flow that does not require login (all other Auth flows) prior to selecting their financial institution. Default behavior is ‘false`.
Specifies whether the Link session is enabled for the Automated Micro-deposits flow. Default behavior is ‘false`.
Database Insights has been deprecated and replaced with Database Auth. Use the [Account Verification Dashboard](dashboard.plaid.com/account-verification) to enable Database Auth.
Database Match has been deprecated and replaced with Database Auth. Use the [Account Verification Dashboard](dashboard.plaid.com/account-verification) to enable Database Auth.
This field has been deprecated in favor of ‘auth_type_select_enabled`.
Specifies whether the Link session is enabled for the Instant Match flow. Instant Match is enabled by default. Instant Match can be disabled by setting this field to ‘false`.
Specifies what type of [Reroute to Credentials](plaid.com/docs/auth/coverage/flow-options/#removing-manual-verification-entry-points-with-reroute-to-credentials) pane should be used in the Link session for the Same Day Micro-deposits flow. Default behavior is ‘OPTIONAL`.
Specifies whether the Link session is enabled for the Same Day Micro-deposits flow. Default behavior is ‘false`.
Specifies whether the Link session is enabled for SMS micro-deposits verification. Default behavior is ‘true`.
Public Class Methods
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 88 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 72 def self.attribute_map { :'auth_type_select_enabled' => :'auth_type_select_enabled', :'automated_microdeposits_enabled' => :'automated_microdeposits_enabled', :'instant_match_enabled' => :'instant_match_enabled', :'same_day_microdeposits_enabled' => :'same_day_microdeposits_enabled', :'instant_microdeposits_enabled' => :'instant_microdeposits_enabled', :'reroute_to_credentials' => :'reroute_to_credentials', :'database_match_enabled' => :'database_match_enabled', :'database_insights_enabled' => :'database_insights_enabled', :'flow_type' => :'flow_type', :'sms_microdeposits_verification_enabled' => :'sms_microdeposits_verification_enabled' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 239 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/link_token_create_request_auth.rb, line 116 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::LinkTokenCreateRequestAuth` 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::LinkTokenCreateRequestAuth`. 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?(:'auth_type_select_enabled') self.auth_type_select_enabled = attributes[:'auth_type_select_enabled'] end if attributes.key?(:'automated_microdeposits_enabled') self.automated_microdeposits_enabled = attributes[:'automated_microdeposits_enabled'] end if attributes.key?(:'instant_match_enabled') self.instant_match_enabled = attributes[:'instant_match_enabled'] end if attributes.key?(:'same_day_microdeposits_enabled') self.same_day_microdeposits_enabled = attributes[:'same_day_microdeposits_enabled'] end if attributes.key?(:'instant_microdeposits_enabled') self.instant_microdeposits_enabled = attributes[:'instant_microdeposits_enabled'] end if attributes.key?(:'reroute_to_credentials') self.reroute_to_credentials = attributes[:'reroute_to_credentials'] end if attributes.key?(:'database_match_enabled') self.database_match_enabled = attributes[:'database_match_enabled'] end if attributes.key?(:'database_insights_enabled') self.database_insights_enabled = attributes[:'database_insights_enabled'] end if attributes.key?(:'flow_type') self.flow_type = attributes[:'flow_type'] end if attributes.key?(:'sms_microdeposits_verification_enabled') self.sms_microdeposits_verification_enabled = attributes[:'sms_microdeposits_verification_enabled'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 109 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 93 def self.openapi_types { :'auth_type_select_enabled' => :'Boolean', :'automated_microdeposits_enabled' => :'Boolean', :'instant_match_enabled' => :'Boolean', :'same_day_microdeposits_enabled' => :'Boolean', :'instant_microdeposits_enabled' => :'Boolean', :'reroute_to_credentials' => :'String', :'database_match_enabled' => :'Boolean', :'database_insights_enabled' => :'Boolean', :'flow_type' => :'String', :'sms_microdeposits_verification_enabled' => :'Boolean' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 209 def ==(o) return true if self.equal?(o) self.class == o.class && auth_type_select_enabled == o.auth_type_select_enabled && automated_microdeposits_enabled == o.automated_microdeposits_enabled && instant_match_enabled == o.instant_match_enabled && same_day_microdeposits_enabled == o.same_day_microdeposits_enabled && instant_microdeposits_enabled == o.instant_microdeposits_enabled && reroute_to_credentials == o.reroute_to_credentials && database_match_enabled == o.database_match_enabled && database_insights_enabled == o.database_insights_enabled && flow_type == o.flow_type && sms_microdeposits_verification_enabled == o.sms_microdeposits_verification_enabled end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 270 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/link_token_create_request_auth.rb, line 341 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/link_token_create_request_auth.rb, line 246 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/link_token_create_request_auth.rb, line 226 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 199 def flow_type=(flow_type) validator = EnumAttributeValidator.new('String', ["FLEXIBLE_AUTH"]) unless validator.valid?(flow_type) fail ArgumentError, "invalid value for \"flow_type\", must be one of #{validator.allowable_values}." end @flow_type = flow_type end
Custom attribute writer method checking allowed values (enum). @param [Object] flow_type
Object to be assigned
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 232 def hash [auth_type_select_enabled, automated_microdeposits_enabled, instant_match_enabled, same_day_microdeposits_enabled, instant_microdeposits_enabled, reroute_to_credentials, database_match_enabled, database_insights_enabled, flow_type, sms_microdeposits_verification_enabled].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 172 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 189 def reroute_to_credentials=(reroute_to_credentials) validator = EnumAttributeValidator.new('String', ["OFF", "OPTIONAL", "FORCED"]) unless validator.valid?(reroute_to_credentials) fail ArgumentError, "invalid value for \"reroute_to_credentials\", must be one of #{validator.allowable_values}." end @reroute_to_credentials = reroute_to_credentials end
Custom attribute writer method checking allowed values (enum). @param [Object] reroute_to_credentials
Object to be assigned
Source
Source
# File lib/plaid/models/link_token_create_request_auth.rb, line 323 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/link_token_create_request_auth.rb, line 311 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/link_token_create_request_auth.rb, line 179 def valid? reroute_to_credentials_validator = EnumAttributeValidator.new('String', ["OFF", "OPTIONAL", "FORCED"]) return false unless reroute_to_credentials_validator.valid?(@reroute_to_credentials) flow_type_validator = EnumAttributeValidator.new('String', ["FLEXIBLE_AUTH"]) return false unless flow_type_validator.valid?(@flow_type) true end
Check to see if the all the properties in the model are valid @return true if the model is valid