class Plaid::TransferRecurringSchedule
The schedule that the recurring transfer will be executed on.
Attributes
A date in [ISO 8601](wikipedia.org/wiki/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.
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.
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.
A date in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). The recurring transfer will begin on the first ‘interval_execution_day` on or after the `start_date`. For `rtp` recurring transfers, `start_date` must be in the future. Otherwise, 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.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/transfer_recurring_schedule.rb, line 67 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/transfer_recurring_schedule.rb, line 56 def self.attribute_map { :'interval_unit' => :'interval_unit', :'interval_count' => :'interval_count', :'interval_execution_day' => :'interval_execution_day', :'start_date' => :'start_date', :'end_date' => :'end_date' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/transfer_recurring_schedule.rb, line 185 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/transfer_recurring_schedule.rb, line 91 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransferRecurringSchedule` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransferRecurringSchedule`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'interval_unit') self.interval_unit = attributes[:'interval_unit'] end if attributes.key?(:'interval_count') self.interval_count = attributes[:'interval_count'] end if attributes.key?(:'interval_execution_day') self.interval_execution_day = attributes[:'interval_execution_day'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'end_date') self.end_date = attributes[:'end_date'] end end
List of attributes with nullable: true
# File lib/plaid/models/transfer_recurring_schedule.rb, line 83 def self.openapi_nullable Set.new([ :'end_date' ]) end
Attribute type mapping.
# File lib/plaid/models/transfer_recurring_schedule.rb, line 72 def self.openapi_types { :'interval_unit' => :'TransferScheduleIntervalUnit', :'interval_count' => :'Integer', :'interval_execution_day' => :'Integer', :'start_date' => :'Date', :'end_date' => :'Date' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/transfer_recurring_schedule.rb, line 160 def ==(o) return true if self.equal?(o) self.class == o.class && interval_unit == o.interval_unit && interval_count == o.interval_count && interval_execution_day == o.interval_execution_day && start_date == o.start_date && end_date == o.end_date end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/transfer_recurring_schedule.rb, line 216 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/plaid/models/transfer_recurring_schedule.rb, line 287 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/transfer_recurring_schedule.rb, line 192 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/transfer_recurring_schedule.rb, line 172 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/transfer_recurring_schedule.rb, line 178 def hash [interval_unit, interval_count, interval_execution_day, start_date, end_date].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/transfer_recurring_schedule.rb, line 127 def list_invalid_properties invalid_properties = Array.new if @interval_unit.nil? invalid_properties.push('invalid value for "interval_unit", interval_unit cannot be nil.') end if @interval_count.nil? invalid_properties.push('invalid value for "interval_count", interval_count cannot be nil.') end if @interval_execution_day.nil? invalid_properties.push('invalid value for "interval_execution_day", interval_execution_day cannot be nil.') end if @start_date.nil? invalid_properties.push('invalid value for "start_date", start_date cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/transfer_recurring_schedule.rb, line 269 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/transfer_recurring_schedule.rb, line 257 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/transfer_recurring_schedule.rb, line 150 def valid? return false if @interval_unit.nil? return false if @interval_count.nil? return false if @interval_execution_day.nil? return false if @start_date.nil? true end