class Plaid::ExternalPaymentScheduleBase
The schedule that the payment will be executed on. If a schedule is provided, the payment is automatically set up as a standing order. If no schedule is specified, the payment will be executed only once.
Attributes
The start date sent to the bank after adjusting for holidays or weekends. Will be provided in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). If the start date did not require adjustment, this field will be ‘null`.
A date in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments will end on the last ‘interval_execution_day` on or before the `end_date`. If the only `interval_execution_day` between the start date and the end date (inclusive) is also the same day that `/payment_initiation/payment/create` was called, the bank may make a payment on that day, but it is not guaranteed to do so.
The day of the interval on which to schedule the payment. If the payment interval is weekly, ‘interval_execution_day` should be an integer from 1 (Monday) to 7 (Sunday). If the payment interval is monthly, `interval_execution_day` should be an integer indicating which day of the month to make the payment on. Integers from 1 to 28 can be used to make a payment on that day of the month. Negative integers from -1 to -5 can be used to make a payment relative to the end of the month. To make a payment on the last day of the month, use -1; to make the payment on the second-to-last day, use -2, and so on.
A date in [ISO 8601](wikipedia.org/wiki/ISO_8601) format (YYYY-MM-DD). Standing order payments 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 `/payment_initiation/payment/create` was called, the bank may make the first payment on that day, but it is not guaranteed to do so.
Public Class Methods
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 67 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 56 def self.attribute_map { :'interval' => :'interval', :'interval_execution_day' => :'interval_execution_day', :'start_date' => :'start_date', :'end_date' => :'end_date', :'adjusted_start_date' => :'adjusted_start_date' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 166 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 92 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::ExternalPaymentScheduleBase` 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::ExternalPaymentScheduleBase`. 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') self.interval = attributes[:'interval'] 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 if attributes.key?(:'adjusted_start_date') self.adjusted_start_date = attributes[:'adjusted_start_date'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 83 def self.openapi_nullable Set.new([ :'end_date', :'adjusted_start_date' ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 72 def self.openapi_types { :'interval' => :'PaymentScheduleInterval', :'interval_execution_day' => :'Integer', :'start_date' => :'Date', :'end_date' => :'Date', :'adjusted_start_date' => :'Date' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 141 def ==(o) return true if self.equal?(o) self.class == o.class && interval == o.interval && interval_execution_day == o.interval_execution_day && start_date == o.start_date && end_date == o.end_date && adjusted_start_date == o.adjusted_start_date end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 197 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 268 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
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
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 173 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 153 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 159 def hash [interval, interval_execution_day, start_date, end_date, adjusted_start_date].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 128 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 250 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 object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 238 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/external_payment_schedule_base.rb, line 135 def valid? true end
Check to see if the all the properties in the model are valid @return true if the model is valid