com.plaid.client.model

Class TransactionStream

java.lang.Object

com.plaid.client.model.TransactionStream

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class TransactionStream
extends Object

A grouping of related transactions

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ACCOUNT_ID
static String	SERIALIZED_NAME_AVERAGE_AMOUNT
static String	SERIALIZED_NAME_CATEGORY
static String	SERIALIZED_NAME_CATEGORY_ID
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_FIRST_DATE
static String	SERIALIZED_NAME_FREQUENCY
static String	SERIALIZED_NAME_IS_ACTIVE
static String	SERIALIZED_NAME_LAST_AMOUNT
static String	SERIALIZED_NAME_LAST_DATE
static String	SERIALIZED_NAME_MERCHANT_NAME
static String	SERIALIZED_NAME_PERSONAL_FINANCE_CATEGORY
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_STREAM_ID
static String	SERIALIZED_NAME_TRANSACTION_IDS

Constructor Summary

Constructors

Constructor and Description
TransactionStream()

Method Summary

Modifier and Type	Method and Description
TransactionStream	accountId(String accountId)
TransactionStream	addCategoryItem(String categoryItem)
TransactionStream	addTransactionIdsItem(String transactionIdsItem)
TransactionStream	averageAmount(TransactionStreamAmount averageAmount)
TransactionStream	category(List<String> category)
TransactionStream	categoryId(String categoryId)
TransactionStream	description(String description)
boolean	equals(Object o)
TransactionStream	firstDate(LocalDate firstDate)
TransactionStream	frequency(RecurringTransactionFrequency frequency)
String	getAccountId() The ID of the account to which the stream belongs
TransactionStreamAmount	getAverageAmount() Get averageAmount
List<String>	getCategory() A hierarchical array of the categories to which this transaction belongs.
String	getCategoryId() The ID of the category to which this transaction belongs.
String	getDescription() A description of the transaction stream.
LocalDate	getFirstDate() The posted date of the earliest transaction in the stream.
RecurringTransactionFrequency	getFrequency() Get frequency
Boolean	getIsActive() Indicates whether the transaction stream is still live.
TransactionStreamAmount	getLastAmount() Get lastAmount
LocalDate	getLastDate() The posted date of the latest transaction in the stream.
String	getMerchantName() The merchant associated with the transaction stream.
PersonalFinanceCategory	getPersonalFinanceCategory() Get personalFinanceCategory
TransactionStreamStatus	getStatus() Get status
String	getStreamId() A unique id for the stream
List<String>	getTransactionIds() An array of Plaid transaction IDs belonging to the stream, sorted by posted date.
int	hashCode()
TransactionStream	isActive(Boolean isActive)
TransactionStream	lastAmount(TransactionStreamAmount lastAmount)
TransactionStream	lastDate(LocalDate lastDate)
TransactionStream	merchantName(String merchantName)
TransactionStream	personalFinanceCategory(PersonalFinanceCategory personalFinanceCategory)
void	setAccountId(String accountId)
void	setAverageAmount(TransactionStreamAmount averageAmount)
void	setCategory(List<String> category)
void	setCategoryId(String categoryId)
void	setDescription(String description)
void	setFirstDate(LocalDate firstDate)
void	setFrequency(RecurringTransactionFrequency frequency)
void	setIsActive(Boolean isActive)
void	setLastAmount(TransactionStreamAmount lastAmount)
void	setLastDate(LocalDate lastDate)
void	setMerchantName(String merchantName)
void	setPersonalFinanceCategory(PersonalFinanceCategory personalFinanceCategory)
void	setStatus(TransactionStreamStatus status)
void	setStreamId(String streamId)
void	setTransactionIds(List<String> transactionIds)
TransactionStream	status(TransactionStreamStatus status)
TransactionStream	streamId(String streamId)
String	toString()
TransactionStream	transactionIds(List<String> transactionIds)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_STREAM_ID

public static final String SERIALIZED_NAME_STREAM_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_MERCHANT_NAME

public static final String SERIALIZED_NAME_MERCHANT_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_FIRST_DATE

public static final String SERIALIZED_NAME_FIRST_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_DATE

public static final String SERIALIZED_NAME_LAST_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_FREQUENCY

public static final String SERIALIZED_NAME_FREQUENCY

See Also:

Constant Field Values

SERIALIZED_NAME_TRANSACTION_IDS

public static final String SERIALIZED_NAME_TRANSACTION_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_AVERAGE_AMOUNT

public static final String SERIALIZED_NAME_AVERAGE_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_LAST_AMOUNT

public static final String SERIALIZED_NAME_LAST_AMOUNT

See Also:

Constant Field Values

SERIALIZED_NAME_IS_ACTIVE

public static final String SERIALIZED_NAME_IS_ACTIVE

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_PERSONAL_FINANCE_CATEGORY

public static final String SERIALIZED_NAME_PERSONAL_FINANCE_CATEGORY

See Also:

Constant Field Values

Constructor Detail

TransactionStream

public TransactionStream()

Method Detail

accountId

public TransactionStream accountId(String accountId)

getAccountId

public String getAccountId()

The ID of the account to which the stream belongs

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

streamId

public TransactionStream streamId(String streamId)

getStreamId

public String getStreamId()

A unique id for the stream

Returns:

streamId

setStreamId

public void setStreamId(String streamId)

category

public TransactionStream category(List<String> category)

addCategoryItem

public TransactionStream addCategoryItem(String categoryItem)

getCategory

public List<String> getCategory()

A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new `personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.

Returns:

category

setCategory

public void setCategory(List<String> category)

categoryId

public TransactionStream categoryId(String categoryId)

getCategoryId

public String getCategoryId()

The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new `personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

description

public TransactionStream description(String description)

getDescription

public String getDescription()

A description of the transaction stream.

Returns:

description

setDescription

public void setDescription(String description)

merchantName

public TransactionStream merchantName(String merchantName)

getMerchantName

@Nullable
public String getMerchantName()

The merchant associated with the transaction stream.

Returns:

merchantName

setMerchantName

public void setMerchantName(String merchantName)

firstDate

public TransactionStream firstDate(LocalDate firstDate)

getFirstDate

public LocalDate getFirstDate()

The posted date of the earliest transaction in the stream.

Returns:

firstDate

setFirstDate

public void setFirstDate(LocalDate firstDate)

lastDate

public TransactionStream lastDate(LocalDate lastDate)

getLastDate

public LocalDate getLastDate()

The posted date of the latest transaction in the stream.

Returns:

lastDate

setLastDate

public void setLastDate(LocalDate lastDate)

frequency

public TransactionStream frequency(RecurringTransactionFrequency frequency)

getFrequency

public RecurringTransactionFrequency getFrequency()

Get frequency

Returns:

frequency

setFrequency

public void setFrequency(RecurringTransactionFrequency frequency)

transactionIds

public TransactionStream transactionIds(List<String> transactionIds)

addTransactionIdsItem

public TransactionStream addTransactionIdsItem(String transactionIdsItem)

getTransactionIds

public List<String> getTransactionIds()

An array of Plaid transaction IDs belonging to the stream, sorted by posted date.

Returns:

transactionIds

setTransactionIds

public void setTransactionIds(List<String> transactionIds)

averageAmount

public TransactionStream averageAmount(TransactionStreamAmount averageAmount)

getAverageAmount

public TransactionStreamAmount getAverageAmount()

Get averageAmount

Returns:

averageAmount

setAverageAmount

public void setAverageAmount(TransactionStreamAmount averageAmount)

lastAmount

public TransactionStream lastAmount(TransactionStreamAmount lastAmount)

getLastAmount

public TransactionStreamAmount getLastAmount()

Get lastAmount

Returns:

lastAmount

setLastAmount

public void setLastAmount(TransactionStreamAmount lastAmount)

isActive

public TransactionStream isActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

Indicates whether the transaction stream is still live.

Returns:

isActive

setIsActive

public void setIsActive(Boolean isActive)

status

public TransactionStream status(TransactionStreamStatus status)

getStatus

public TransactionStreamStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(TransactionStreamStatus status)

personalFinanceCategory

public TransactionStream personalFinanceCategory(PersonalFinanceCategory personalFinanceCategory)

getPersonalFinanceCategory

@Nullable
public PersonalFinanceCategory getPersonalFinanceCategory()

Get personalFinanceCategory

Returns:

personalFinanceCategory

setPersonalFinanceCategory

public void setPersonalFinanceCategory(PersonalFinanceCategory personalFinanceCategory)

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