class

Plaid::LinkTokenCreateRequestAuth

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constants

ERROR_MESSAGE_FOR_FLOW_TYPE = "invalid value for \"flow_type\", must be one of [FLEXIBLE_AUTH]."
ERROR_MESSAGE_FOR_REROUTE_TO_CREDENTIALS = "invalid value for \"reroute_to_credentials\", must be one of [OFF, OPTIONAL, FORCED]."
VALID_VALUES_FOR_FLOW_TYPE = String.static_array("FLEXIBLE_AUTH")
VALID_VALUES_FOR_REROUTE_TO_CREDENTIALS = String.static_array("OFF", "OPTIONAL", "FORCED")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, auth_type_select_enabled : Bool | Nil = false, automated_microdeposits_enabled : Bool | Nil = nil, instant_match_enabled : Bool | Nil = nil, same_day_microdeposits_enabled : Bool | Nil = nil, instant_microdeposits_enabled : Bool | Nil = nil, reroute_to_credentials : String | Nil = nil, database_match_enabled : Bool | Nil = nil, flow_type : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

auth_type_select_enabled

Specifies whether Auth Type Select is enabled for the Link session, allowing the end user to choose between linking instantly or manually prior to selecting their financial institution. Note that this can only be true if same_day_microdeposits_enabled is set to true.

Source
auth_type_select_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] auth_type_select_enabled Object to be assigned

Source
automated_microdeposits_enabled

Specifies whether the Link session is enabled for the Automated Micro-deposits flow.

Source
automated_microdeposits_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] automated_microdeposits_enabled Object to be assigned

Source
database_match_enabled

Specifies whether the Link session is enabled for the Database Match flow.

Source
database_match_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] database_match_enabled Object to be assigned

Source
flow_type

This field has been deprecated in favor of auth_type_select_enabled.

Source
flow_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] flow_type Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

instant_match_enabled

Specifies whether the Link session is enabled for the Instant Match flow. As of November 2022, Instant Match will be enabled by default. Instant Match can be disabled by setting this field to false.

Source
instant_match_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] instant_match_enabled Object to be assigned

Source
instant_microdeposits_enabled

Specifies whether the Link session is enabled for the Instant Micro-deposits flow.

Source
instant_microdeposits_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] instant_microdeposits_enabled Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
reroute_to_credentials

Specifies what type of Reroute to Credentials pane should be used in the Link session for the Same Day Micro-deposits flow. As of October 15 2023, the default setting is OPTIONAL.

Source
reroute_to_credentials=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] reroute_to_credentials Object to be assigned

Source
same_day_microdeposits_enabled

Specifies whether the Link session is enabled for the Same Day Micro-deposits flow.

Source
same_day_microdeposits_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] same_day_microdeposits_enabled Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source