com.plaid.client.model

Class BeaconUser

java.lang.Object

com.plaid.client.model.BeaconUser

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class BeaconUser
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_AUDIT_TRAIL
static String	SERIALIZED_NAME_CLIENT_USER_ID
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_ITEM_IDS
static String	SERIALIZED_NAME_PROGRAM_ID
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_UPDATED_AT
static String	SERIALIZED_NAME_USER
static String	SERIALIZED_NAME_VERSION

Constructor Summary

Constructors

Constructor and Description
BeaconUser()

Method Summary

Modifier and Type	Method and Description
BeaconUser	addItemIdsItem(String itemIdsItem)
BeaconUser	auditTrail(BeaconAuditTrail auditTrail)
BeaconUser	clientUserId(String clientUserId)
BeaconUser	createdAt(Timestamp createdAt)
boolean	equals(Object o)
BeaconAuditTrail	getAuditTrail() Get auditTrail
String	getClientUserId() A unique ID that identifies the end user in your system.
Timestamp	getCreatedAt() Get createdAt
String	getId() ID of the associated Beacon User.
Set<String>	getItemIds() An array of Plaid Item IDs corresponding to the Accounts associated with this Beacon User.
String	getProgramId() ID of the associated Beacon Program.
BeaconUserStatus	getStatus() Get status
OffsetDateTime	getUpdatedAt() An ISO8601 formatted timestamp.
BeaconUserData	getUser() Get user
Integer	getVersion() The `version` field begins with 1 and increments each time the user is updated.
int	hashCode()
BeaconUser	id(String id)
BeaconUser	itemIds(Set<String> itemIds)
BeaconUser	programId(String programId)
void	setAuditTrail(BeaconAuditTrail auditTrail)
void	setClientUserId(String clientUserId)
void	setCreatedAt(Timestamp createdAt)
void	setId(String id)
void	setItemIds(Set<String> itemIds)
void	setProgramId(String programId)
void	setStatus(BeaconUserStatus status)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setUser(BeaconUserData user)
void	setVersion(Integer version)
BeaconUser	status(BeaconUserStatus status)
String	toString()
BeaconUser	updatedAt(OffsetDateTime updatedAt)
BeaconUser	user(BeaconUserData user)
BeaconUser	version(Integer version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ITEM_IDS

public static final String SERIALIZED_NAME_ITEM_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_VERSION

public static final String SERIALIZED_NAME_VERSION

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_PROGRAM_ID

public static final String SERIALIZED_NAME_PROGRAM_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CLIENT_USER_ID

public static final String SERIALIZED_NAME_CLIENT_USER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_USER

public static final String SERIALIZED_NAME_USER

See Also:

Constant Field Values

SERIALIZED_NAME_AUDIT_TRAIL

public static final String SERIALIZED_NAME_AUDIT_TRAIL

See Also:

Constant Field Values

Constructor Detail

BeaconUser

public BeaconUser()

Method Detail

itemIds

public BeaconUser itemIds(Set<String> itemIds)

addItemIdsItem

public BeaconUser addItemIdsItem(String itemIdsItem)

getItemIds

public Set<String> getItemIds()

An array of Plaid Item IDs corresponding to the Accounts associated with this Beacon User.

Returns:

itemIds

setItemIds

public void setItemIds(Set<String> itemIds)

id

public BeaconUser id(String id)

getId

public String getId()

ID of the associated Beacon User.

Returns:

id

setId

public void setId(String id)

version

public BeaconUser version(Integer version)

getVersion

public Integer getVersion()

The `version` field begins with 1 and increments each time the user is updated.

Returns:

version

setVersion

public void setVersion(Integer version)

createdAt

public BeaconUser createdAt(Timestamp createdAt)

getCreatedAt

public Timestamp getCreatedAt()

Get createdAt

Returns:

createdAt

setCreatedAt

public void setCreatedAt(Timestamp createdAt)

updatedAt

public BeaconUser updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

public OffsetDateTime getUpdatedAt()

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

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

status

public BeaconUser status(BeaconUserStatus status)

getStatus

public BeaconUserStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(BeaconUserStatus status)

programId

public BeaconUser programId(String programId)

getProgramId

public String getProgramId()

ID of the associated Beacon Program.

Returns:

programId

setProgramId

public void setProgramId(String programId)

clientUserId

public BeaconUser clientUserId(String clientUserId)

getClientUserId

public String getClientUserId()

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`.

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

user

public BeaconUser user(BeaconUserData user)

getUser

public BeaconUserData getUser()

Get user

Returns:

user

setUser

public void setUser(BeaconUserData user)

auditTrail

public BeaconUser auditTrail(BeaconAuditTrail auditTrail)

getAuditTrail

public BeaconAuditTrail getAuditTrail()

Get auditTrail

Returns:

auditTrail

setAuditTrail

public void setAuditTrail(BeaconAuditTrail auditTrail)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object