BeaconUserGetResponse (com.plaid:plaid-java 29.0.0 API)

java.lang.Object
- com.plaid.client.model.BeaconUserGetResponse

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-14T16:41:31.650700Z[Etc/UTC]")
public class BeaconUserGetResponse
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_REQUEST_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

BeaconUserGetResponse()

Constructors
Constructor and Description
`BeaconUserGetResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeaconUserGetResponse`	`addItemIdsItem(String itemIdsItem)`
`BeaconUserGetResponse`	`auditTrail(BeaconAuditTrail auditTrail)`
`BeaconUserGetResponse`	`clientUserId(String clientUserId)`
`BeaconUserGetResponse`	`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.
`String`	`getRequestId()` A unique identifier for the request, which can be used for troubleshooting.
`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()`
`BeaconUserGetResponse`	`id(String id)`
`BeaconUserGetResponse`	`itemIds(Set<String> itemIds)`
`BeaconUserGetResponse`	`programId(String programId)`
`BeaconUserGetResponse`	`requestId(String requestId)`
`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`	`setRequestId(String requestId)`
`void`	`setStatus(BeaconUserStatus status)`
`void`	`setUpdatedAt(OffsetDateTime updatedAt)`
`void`	`setUser(BeaconUserData user)`
`void`	`setVersion(Integer version)`
`BeaconUserGetResponse`	`status(BeaconUserStatus status)`
`String`	`toString()`
`BeaconUserGetResponse`	`updatedAt(OffsetDateTime updatedAt)`
`BeaconUserGetResponse`	`user(BeaconUserData user)`
`BeaconUserGetResponse`	`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
- SERIALIZED_NAME_REQUEST_ID
```
public static final String SERIALIZED_NAME_REQUEST_ID
```
  See Also:
  
  Constant Field Values

Constructor Detail
- BeaconUserGetResponse
```
public BeaconUserGetResponse()
```

Method Detail

itemIds

public BeaconUserGetResponse itemIds(Set<String> itemIds)

addItemIdsItem

public BeaconUserGetResponse 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 BeaconUserGetResponse id(String id)

getId
```
public String getId()
```
ID of the associated Beacon User.

Returns:

id

setId
```
public void setId(String id)
```

version

public BeaconUserGetResponse 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 BeaconUserGetResponse createdAt(Timestamp createdAt)

getCreatedAt
```
public Timestamp getCreatedAt()
```
Get createdAt

Returns:

createdAt

setCreatedAt

public void setCreatedAt(Timestamp createdAt)

updatedAt

public BeaconUserGetResponse 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 BeaconUserGetResponse status(BeaconUserStatus status)

getStatus
```
public BeaconUserStatus getStatus()
```
Get status

Returns:

status

setStatus

public void setStatus(BeaconUserStatus status)

programId

public BeaconUserGetResponse programId(String programId)

getProgramId
```
public String getProgramId()
```
ID of the associated Beacon Program.

Returns:

programId

setProgramId

public void setProgramId(String programId)

clientUserId

public BeaconUserGetResponse 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 BeaconUserGetResponse user(BeaconUserData user)

getUser
```
public BeaconUserData getUser()
```
Get user

Returns:

user

setUser

public void setUser(BeaconUserData user)

auditTrail

public BeaconUserGetResponse auditTrail(BeaconAuditTrail auditTrail)

getAuditTrail

public BeaconAuditTrail getAuditTrail()

Get auditTrail

Returns:: auditTrail

setAuditTrail

public void setAuditTrail(BeaconAuditTrail auditTrail)

requestId

public BeaconUserGetResponse requestId(String requestId)

getRequestId
```
public String getRequestId()
```
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Returns:

requestId

setRequestId

public void setRequestId(String requestId)

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

Class BeaconUserGetResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ITEM_IDS

SERIALIZED_NAME_ID

SERIALIZED_NAME_VERSION

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_UPDATED_AT

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_PROGRAM_ID

SERIALIZED_NAME_CLIENT_USER_ID

SERIALIZED_NAME_USER

SERIALIZED_NAME_AUDIT_TRAIL

SERIALIZED_NAME_REQUEST_ID

Constructor Detail

BeaconUserGetResponse

Method Detail

itemIds

addItemIdsItem

getItemIds

setItemIds

id

getId

setId

version

getVersion

setVersion

createdAt

getCreatedAt

setCreatedAt

updatedAt

getUpdatedAt

setUpdatedAt

status

getStatus

setStatus

programId

getProgramId

setProgramId

clientUserId

getClientUserId

setClientUserId

user

getUser

setUser

auditTrail

getAuditTrail

setAuditTrail

requestId

getRequestId

setRequestId

equals

hashCode

toString