class

Plaid::TransferEventListRequest

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

Defines the request schema for /transfer/event/list

Constants

MAX_FOR_COUNT = Int32.new("25")

MIN_FOR_COUNT = Int32.new("1")

MIN_FOR_OFFSET = Int32.new("0")

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

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_id

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

Source

account_id=(new_value : String | Nil)

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

Source

account_id_present=(account_id_present : Bool)

Source

account_id_present?

Source

client_id

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.

Source

client_id=(new_value : String | Nil)

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

Source

count

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

Source

count=(new_value : Int32 | Nil)

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

Source

count_present=(count_present : Bool)

Source

count_present?

Source

end_date

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

Source

end_date=(new_value : Time | Nil)

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

Source

end_date_present=(end_date_present : Bool)

Source

end_date_present?

Source

event_types

Filter events by event type.

Source

event_types=(new_value : Array(TransferEventType) | Nil)

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

Source

funding_account_id

Filter transfer events to only those with the specified funding_account_id.

Source

funding_account_id=(new_value : String | Nil)

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

Source

funding_account_id_present=(funding_account_id_present : Bool)

Source

funding_account_id_present?

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

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 offset into the list of transfer events. When count=25 and offset=0, the first 25 events will be returned. When count=25 and offset=25, the next 25 events will be returned.

Source

offset=(new_value : Int32 | Nil)

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

Source

offset_present=(offset_present : Bool)

Source

offset_present?

Source

origination_account_id

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

Source

origination_account_id=(new_value : String | Nil)

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

Source

origination_account_id_present=(origination_account_id_present : Bool)

Source

origination_account_id_present?

Source

originator_client_id

Filter transfer events to only those with the specified originator client.

Source

originator_client_id=(new_value : String | Nil)

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

Source

originator_client_id_present=(originator_client_id_present : Bool)

Source

originator_client_id_present?

Source

secret

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.

Source

secret=(new_value : String | Nil)

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

Source

start_date

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

Source

start_date=(new_value : Time | Nil)

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

Source

start_date_present=(start_date_present : Bool)

Source

start_date_present?

Source

sweep_id

Plaid’s unique identifier for a sweep.

Source

sweep_id=(new_value : String | Nil)

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

Source

transfer_id

Plaid’s unique identifier for a transfer.

Source

transfer_id=(new_value : String | Nil)

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

Source

transfer_id_present=(transfer_id_present : Bool)

Source

transfer_id_present?

Source

transfer_type

Source

transfer_type=(new_value : Plaid::TransferEventListTransferType | Nil)

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

Source

transfer_type_present=(transfer_type_present : Bool)

Source

transfer_type_present?

Source

valid?

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

Source