class

Plaid::TransferRecurringSchedule

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

The schedule that the recurring transfer will be executed on.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, interval_unit : Plaid::TransferScheduleIntervalUnit | Nil = nil, interval_count : Int32 | Nil = nil, interval_execution_day : Int32 | Nil = nil, start_date : Time | Nil = nil, end_date : Time | 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

end_date

A date in ISO 8601 format (YYYY-MM-DD). The recurring transfer will end on the last interval_execution_day on or before the end_date. If the interval_execution_day between the start date and the end date (inclusive) is also the same day that /transfer/recurring/create was called, the bank may make a payment on that day, but it is not guaranteed to do so.

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
hash(hasher)

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

interval_count

The number of recurring interval_units between originations. The recurring interval (before holiday adjustment) is calculated by multiplying interval_unit and interval_count. For example, to schedule a recurring transfer which originates once every two weeks, set interval_unit = week and interval_count = 2.

Source
interval_count=(new_value : Int32 | Nil)

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

Source
interval_execution_day

The day of the interval on which to schedule the transfer. If the interval_unit is week, interval_execution_day should be an integer from 1 (Monday) to 5 (Friday). If the interval_unit is month, interval_execution_day should be an integer indicating which day of the month to make the transfer on. Integers from 1 to 28 can be used to make a transfer on that day of the month. Negative integers from -1 to -5 can be used to make a transfer relative to the end of the month. To make a transfer on the last day of the month, use -1; to make the transfer on the second-to-last day, use -2, and so on. The transfer will be originated on the next available banking day if the designated day is a non banking day.

Source
interval_execution_day=(new_value : Int32 | Nil)

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

Source
interval_unit
Source
interval_unit=(new_value : Plaid::TransferScheduleIntervalUnit | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] interval_unit 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
start_date

A date in ISO 8601 format (YYYY-MM-DD). The recurring transfer will begin on the first interval_execution_day on or after the start_date. If the first interval_execution_day on or after the start date is also the same day that /transfer/recurring/create was called, the bank may make the first payment on that day, but it is not guaranteed to do so.

Source
start_date=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] start_date 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