class

Plaid::TransferSweepListRequest

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

Defines the request schema for /transfer/sweep/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
new(*, client_id : String | Nil = nil, secret : String | Nil = nil, start_date : Time | Nil = nil, end_date : Time | Nil = nil, count : Int32 | Nil = 25, offset : Int32 | Nil = 0, amount : String | Nil = nil, status : Plaid::SweepStatus | Nil = nil, originator_client_id : String | Nil = nil, funding_account_id : String | Nil = nil, transfer_id : String | Nil = nil, trigger : Plaid::SweepTrigger | Nil = nil)

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

amount

Filter sweeps to only those with the specified amount.

Source
amount=(new_value : String | Nil)

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

Source
amount_present=(amount_present : Bool)
Source
amount_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 sweeps to return.

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 sweeps to return (RFC 3339 format).

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
funding_account_id

Filter sweeps 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 number of sweeps to skip before returning results.

Source
offset=(new_value : Int32 | Nil)

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

Source
originator_client_id

Filter sweeps 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 sweeps to return (RFC 3339 format).

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
status
Source
status=(new_value : Plaid::SweepStatus | Nil)

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

Source
status_present=(status_present : Bool)
Source
status_present?
Source
transfer_id

Filter sweeps to only those with the included transfer_id.

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
trigger
Source
trigger=(new_value : Plaid::SweepTrigger | Nil)

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

Source
trigger_present=(trigger_present : Bool)
Source
trigger_present?
Source
valid?

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

Source