class

Plaid::BeaconUserGetResponse

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

A Beacon User represents an end user that has been scanned against the Beacon Network.

Constants

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, created_at : Time | Nil = nil, updated_at : Time | Nil = nil, status : Plaid::BeaconUserStatus | Nil = nil, program_id : String | Nil = nil, client_user_id : String | Nil = nil, user : BeaconUserData | Nil = nil, audit_trail : BeaconAuditTrail | Nil = nil, request_id : 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

audit_trail
Source
audit_trail=(new_value : BeaconAuditTrail | Nil)

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

Source
client_user_id

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.

Source
client_user_id=(new_value : String | Nil)

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

Source
created_at

An ISO8601 formatted timestamp.

Source
created_at=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created_at 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

id

ID of the associated Beacon User.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id 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
program_id

ID of the associated Beacon Program.

Source
program_id=(new_value : String | Nil)

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

Source
request_id

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Source
request_id=(new_value : String | Nil)

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

Source
status
Source
status=(new_value : Plaid::BeaconUserStatus | Nil)

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

Source
updated_at

An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.

Source
updated_at=(new_value : Time | Nil)

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

Source
user
Source
user=(new_value : BeaconUserData | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user 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