class

Plaid::TransactionsGetRequestOptions

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

An optional object to be used with the request. If specified, options must not be null.

Constants

MAX_FOR_COUNT = Int32.new("500")
MAX_FOR_DAYS_REQUESTED = Int32.new("730")
MIN_FOR_COUNT = Int32.new("1")
MIN_FOR_DAYS_REQUESTED = Int32.new("1")
MIN_FOR_OFFSET = Int32.new("0")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account_ids : Array(String) | Nil = nil, count : Int32 | Nil = 100, offset : Int32 | Nil = 0, include_original_description : Bool | Nil = false, include_personal_finance_category_beta : Bool | Nil = false, include_personal_finance_category : Bool | Nil = false, include_logo_and_counterparty_beta : Bool | Nil = false, days_requested : Int32 | Nil = 90)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

account_ids

A list of account_ids to retrieve for the Item Note: An error will be returned if a provided account_id is not associated with the Item.

Source
account_ids=(new_value : Array(String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] account_ids Object to be assigned

Source
count

The number of transactions to fetch.

Source
count=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] count Object to be assigned

Source
days_requested

This option only applies to calls for Items that were not initialized with Transactions during Link and are now adding the Transactions product to the Item for the first time. In these cases, this option controls the maximum number of days of transaction history that Plaid will request from the financial institution. For developer accounts created after December 3, 2023, if no value is specified, this will default to 90 days. For developer accounts created on December 3, 2023 or earlier, if no value is specified, this will default to 730 days until June 24, 2024, at which point it will default to 90 days. If Transactions has already been added to the Item prior to this call, this field will have no effect.

Source
days_requested=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] days_requested Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

include_logo_and_counterparty_beta

Counterparties and extra merchant fields are now returned by default.

Source
include_logo_and_counterparty_beta=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] include_logo_and_counterparty_beta Object to be assigned

Source
include_original_description

Include the raw unparsed transaction description from the financial institution. This field is disabled by default. If you need this information in addition to the parsed data provided, contact your Plaid Account Manager, or submit a Support request.

Source
include_original_description=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] include_original_description Object to be assigned

Source
include_original_description_present=(include_original_description_present : Bool)
Source
include_original_description_present?
Source
include_personal_finance_category

Personal finance categories are now returned by default.

Source
include_personal_finance_category=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] include_personal_finance_category Object to be assigned

Source
include_personal_finance_category_beta

Personal finance categories are now returned by default.

Source
include_personal_finance_category_beta=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] include_personal_finance_category_beta Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
offset

The number of transactions to skip. The default value is 0.

Source
offset=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] offset Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source