com.plaid.client.model

Class BankTransferEventListRequest

java.lang.Object

com.plaid.client.model.BankTransferEventListRequest

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

Defines the request schema for `/bank_transfer/event/list`

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_ID
static String	SERIALIZED_NAME_BANK_TRANSFER_ID
static String	SERIALIZED_NAME_BANK_TRANSFER_TYPE
static String	SERIALIZED_NAME_CLIENT_ID
static String	SERIALIZED_NAME_COUNT
static String	SERIALIZED_NAME_DIRECTION
static String	SERIALIZED_NAME_END_DATE
static String	SERIALIZED_NAME_EVENT_TYPES
static String	SERIALIZED_NAME_OFFSET
static String	SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID
static String	SERIALIZED_NAME_SECRET
static String	SERIALIZED_NAME_START_DATE

Constructor Summary

Constructors

Constructor and Description
BankTransferEventListRequest()

Method Summary

Modifier and Type	Method and Description
BankTransferEventListRequest	accountId(String accountId)
BankTransferEventListRequest	addEventTypesItem(BankTransferEventType eventTypesItem)
BankTransferEventListRequest	bankTransferId(String bankTransferId)
BankTransferEventListRequest	bankTransferType(BankTransferEventListBankTransferType bankTransferType)
BankTransferEventListRequest	clientId(String clientId)
BankTransferEventListRequest	count(Integer count)
BankTransferEventListRequest	direction(BankTransferEventListDirection direction)
BankTransferEventListRequest	endDate(OffsetDateTime endDate)
boolean	equals(Object o)
BankTransferEventListRequest	eventTypes(List<BankTransferEventType> eventTypes)
String	getAccountId() The account ID to get events for all transactions to/from an account.
String	getBankTransferId() Plaid’s unique identifier for a bank transfer.
BankTransferEventListBankTransferType	getBankTransferType() Get bankTransferType
String	getClientId() Your Plaid API `client_id`.
Integer	getCount() The maximum number of bank transfer events to return.
BankTransferEventListDirection	getDirection() Get direction
OffsetDateTime	getEndDate() The end datetime of bank transfers to list.
List<BankTransferEventType>	getEventTypes() Filter events by event type.
Integer	getOffset() The offset into the list of bank transfer events.
String	getOriginationAccountId() The origination account ID to get events for transfers from a specific origination account.
String	getSecret() Your Plaid API `secret`.
OffsetDateTime	getStartDate() The start datetime of bank transfers to list.
int	hashCode()
BankTransferEventListRequest	offset(Integer offset)
BankTransferEventListRequest	originationAccountId(String originationAccountId)
BankTransferEventListRequest	secret(String secret)
void	setAccountId(String accountId)
void	setBankTransferId(String bankTransferId)
void	setBankTransferType(BankTransferEventListBankTransferType bankTransferType)
void	setClientId(String clientId)
void	setCount(Integer count)
void	setDirection(BankTransferEventListDirection direction)
void	setEndDate(OffsetDateTime endDate)
void	setEventTypes(List<BankTransferEventType> eventTypes)
void	setOffset(Integer offset)
void	setOriginationAccountId(String originationAccountId)
void	setSecret(String secret)
void	setStartDate(OffsetDateTime startDate)
BankTransferEventListRequest	startDate(OffsetDateTime startDate)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_CLIENT_ID

public static final String SERIALIZED_NAME_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SECRET

public static final String SERIALIZED_NAME_SECRET

See Also:

Constant Field Values

SERIALIZED_NAME_START_DATE

public static final String SERIALIZED_NAME_START_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_END_DATE

public static final String SERIALIZED_NAME_END_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_BANK_TRANSFER_ID

public static final String SERIALIZED_NAME_BANK_TRANSFER_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_BANK_TRANSFER_TYPE

public static final String SERIALIZED_NAME_BANK_TRANSFER_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_TYPES

public static final String SERIALIZED_NAME_EVENT_TYPES

See Also:

Constant Field Values

SERIALIZED_NAME_COUNT

public static final String SERIALIZED_NAME_COUNT

See Also:

Constant Field Values

SERIALIZED_NAME_OFFSET

public static final String SERIALIZED_NAME_OFFSET

See Also:

Constant Field Values

SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

public static final String SERIALIZED_NAME_ORIGINATION_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DIRECTION

public static final String SERIALIZED_NAME_DIRECTION

See Also:

Constant Field Values

Constructor Detail

BankTransferEventListRequest

public BankTransferEventListRequest()

Method Detail

clientId

public BankTransferEventListRequest clientId(String clientId)

getClientId

@Nullable
public String getClientId()

Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

clientId

setClientId

public void setClientId(String clientId)

secret

public BankTransferEventListRequest secret(String secret)

getSecret

@Nullable
public String getSecret()

Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

secret

setSecret

public void setSecret(String secret)

startDate

public BankTransferEventListRequest startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

endDate

public BankTransferEventListRequest endDate(OffsetDateTime endDate)

getEndDate

@Nullable
public OffsetDateTime getEndDate()

The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. `2019-12-06T22:35:49Z`)

Returns:

endDate

setEndDate

public void setEndDate(OffsetDateTime endDate)

bankTransferId

public BankTransferEventListRequest bankTransferId(String bankTransferId)

getBankTransferId

@Nullable
public String getBankTransferId()

Plaid’s unique identifier for a bank transfer.

Returns:

bankTransferId

setBankTransferId

public void setBankTransferId(String bankTransferId)

accountId

public BankTransferEventListRequest accountId(String accountId)

getAccountId

@Nullable
public String getAccountId()

The account ID to get events for all transactions to/from an account.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

bankTransferType

public BankTransferEventListRequest bankTransferType(BankTransferEventListBankTransferType bankTransferType)

getBankTransferType

@Nullable
public BankTransferEventListBankTransferType getBankTransferType()

Get bankTransferType

Returns:

bankTransferType

setBankTransferType

public void setBankTransferType(BankTransferEventListBankTransferType bankTransferType)

eventTypes

public BankTransferEventListRequest eventTypes(List<BankTransferEventType> eventTypes)

addEventTypesItem

public BankTransferEventListRequest addEventTypesItem(BankTransferEventType eventTypesItem)

getEventTypes

@Nullable
public List<BankTransferEventType> getEventTypes()

Filter events by event type.

Returns:

eventTypes

setEventTypes

public void setEventTypes(List<BankTransferEventType> eventTypes)

count

public BankTransferEventListRequest count(Integer count)

getCount

@Nullable
public Integer getCount()

The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than `count`, the most recent events will be returned. minimum: 1 maximum: 25

Returns:

count

setCount

public void setCount(Integer count)

offset

public BankTransferEventListRequest offset(Integer offset)

getOffset

@Nullable
public Integer getOffset()

The offset into the list of bank transfer events. When `count`=25 and `offset`=0, the first 25 events will be returned. When `count`=25 and `offset`=25, the next 25 bank transfer events will be returned. minimum: 0

Returns:

offset

setOffset

public void setOffset(Integer offset)

originationAccountId

public BankTransferEventListRequest originationAccountId(String originationAccountId)

getOriginationAccountId

@Nullable
public String getOriginationAccountId()

The origination account ID to get events for transfers from a specific origination account.

Returns:

originationAccountId

setOriginationAccountId

public void setOriginationAccountId(String originationAccountId)

direction

public BankTransferEventListRequest direction(BankTransferEventListDirection direction)

getDirection

@Nullable
public BankTransferEventListDirection getDirection()

Get direction

Returns:

direction

setDirection

public void setDirection(BankTransferEventListDirection direction)

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