class

Plaid::LinkEventMetadata

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

Metadata about an event that occured while the user was going through Link

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, request_id : String | Nil = nil, error_code : String | Nil = nil, error_message : String | Nil = nil, error_type : String | Nil = nil, exit_status : String | Nil = nil, institution_id : String | Nil = nil, institution_name : String | Nil = nil, institution_search_query : String | Nil = nil, mfa_type : String | Nil = nil, view_name : String | Nil = nil, selection : String | Nil = nil, brand_name : String | Nil = nil, match_reason : String | Nil = nil, routing_number : String | Nil = nil, account_number_mask : String | Nil = nil)

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

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

account_number_mask

The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, account_number_mask is empty. Emitted by SUBMIT_ACCOUNT_NUMBER.

account_number_mask=(new_value : String | Nil)

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

brand_name

The name of the selected brand.

brand_name=(new_value : String | Nil)

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

error_code

The error code that the user encountered. Emitted by ERROR, EXIT.

error_code=(new_value : String | Nil)

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

error_message

The error message that the user encountered. Emitted by: ERROR, EXIT.

error_message=(new_value : String | Nil)

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

error_type

The error type that the user encountered. Emitted by: ERROR, EXIT.

error_type=(new_value : String | Nil)

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

exit_status

The status key indicates the point at which the user exited the Link flow. Emitted by: EXIT.

exit_status=(new_value : String | Nil)

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

hash(hasher)

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

institution_id

The ID of the selected institution. Emitted by: all events.

institution_id=(new_value : String | Nil)

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

institution_name

The name of the selected institution. Emitted by: all events.

institution_name=(new_value : String | Nil)

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

institution_search_query

The query used to search for institutions. Emitted by: SEARCH_INSTITUTION.

institution_search_query=(new_value : String | Nil)

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

list_invalid_properties

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

match_reason

The reason this institution was matched, which will be either returning_user or routing_number. Emitted by: MATCHED_SELECT_INSTITUTION.

match_reason=(new_value : String | Nil)

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

mfa_type

If set, the user has encountered one of the following MFA types: code, device, questions, selections. Emitted by: SUBMIT_MFA and TRANSITION_VIEW when view_name is MFA.

mfa_type=(new_value : String | Nil)

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

request_id

The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events.

request_id=(new_value : String | Nil)

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

routing_number

The routing number submitted by user at the micro-deposits routing number pane. Emitted by SUBMIT_ROUTING_NUMBER.

routing_number=(new_value : String | Nil)

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

selection

Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are phoneotp or password; if selection is used to describe the selected Auth Type Select flow, then possible values are flow_type_manual or flow_type_instant. Emitted by: MATCHED_SELECT_VERIFY_METHOD and SELECT_AUTH_TYPE.

selection=(new_value : String | Nil)

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

valid?

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

view_name

The name of the view that is being transitioned to. Emitted by: TRANSITION_VIEW.

view_name=(new_value : String | Nil)

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