Struct plaid::model::RecurringInsightsStream

pub struct RecurringInsightsStream {

    pub average_amount: Option<TransactionStreamAmount>,
    pub average_days_apart: f64,
    pub description: Option<String>,
    pub frequency: Option<String>,
    pub is_active: bool,
    pub merchant_name: String,
    pub newest_transaction_amount: Option<TransactionStreamAmount>,
    pub newest_transaction_date: Option<NaiveDate>,
    pub oldest_transaction_date: Option<NaiveDate>,
    pub personal_finance_category_detailed: Option<String>,
    pub personal_finance_category_primary: Option<String>,
    pub status: Option<String>,
    pub stream_id: String,
    pub transaction_count: Option<i64>,
    pub transaction_ids: Option<Vec<String>>,
}

Insights object for recurring transactions streams.

Fields

average_amount: Option<TransactionStreamAmount>

Object with data pertaining to an amount on the transaction stream.

average_days_apart: f64

The average number of days between each of the recurring transactions.

description: Option<String>

The client-provided raw description of the most recent transaction in the stream.

frequency: Option<String>

Describes the frequency of the transaction stream.

WEEKLY: Assigned to a transaction stream that occurs approximately every week.

BIWEEKLY: Assigned to a transaction stream that occurs approximately every 2 weeks.

SEMI_MONTHLY: Assigned to a transaction stream that occurs approximately twice per month. This frequency is typically seen for inflow transaction streams.

MONTHLY: Assigned to a transaction stream that occurs approximately every month.

ANNUALLY: Assigned to a transaction stream that occurs approximately every year.

UNKNOWN: Assigned to a transaction stream that does not fit any of the pre-defined frequencies.

is_active: bool

Indicates whether the transaction stream is still live.

merchant_name: String

The merchant or primary counterparty associated with the transaction stream.

newest_transaction_amount: Option<TransactionStreamAmount>

Object with data pertaining to an amount on the transaction stream.

newest_transaction_date: Option<NaiveDate>

The posted date of the latest transaction in the stream.

oldest_transaction_date: Option<NaiveDate>

The posted date of the earliest transaction in the stream.

personal_finance_category_detailed: Option<String>

The detailed category associated with the transaction stream.

personal_finance_category_primary: Option<String>

The primary category associated with the transaction stream.

status: Option<String>

The current status of the transaction stream.

MATURE: A MATURE recurring stream should have at least 3 transactions and happen on a regular cadence (For Annual recurring stream, we will mark it MATURE after 2 instances).

EARLY_DETECTION: When a recurring transaction first appears in the transaction history and before it fulfills the requirement of a mature stream, the status will be EARLY_DETECTION.

TOMBSTONED: A stream that was previously in the EARLY_DETECTION status will move to the TOMBSTONED status when no further transactions were found at the next expected date.

UNKNOWN: A stream is assigned an UNKNOWN status when none of the other statuses are applicable.

stream_id: String

A unique id for the stream.

transaction_count: Option<i64>

The number of transactions in this stream.

transaction_ids: Option<Vec<String>>

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

Trait Implementations

impl Clone for RecurringInsightsStream

fn clone(&self) -> RecurringInsightsStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RecurringInsightsStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RecurringInsightsStream

fn default() -> RecurringInsightsStream

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RecurringInsightsStream

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RecurringInsightsStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for RecurringInsightsStream

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.