class Plaid::InflowModel
The ‘inflow_model` allows you to model a test account that receives regular income or make regular payments on a loan. Any transactions generated by the `inflow_model` will appear in addition to randomly generated test data or transactions specified by `override_accounts`.
Attributes
Amount of income per month. This value is required if ‘type` is `monthly-income`.
Number between 1 and 28, or ‘last` meaning the last day of the month. The day of the month on which the income transaction will appear. The name of the income transaction. This field is required if `type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
Number between 1 and 28, or ‘last` meaning the last day of the month. The day of the month on which the balance is calculated for the next payment. The name of the income transaction. This field is required if `type` is `monthly-balance-payment` or `monthly-interest-only-payment`.
The name of the income transaction. This field is required if ‘type` is `monthly-income`, `monthly-balance-payment` or `monthly-interest-only-payment`.
Inflow model. One of the following: ‘none`: No income `monthly-income`: Income occurs once per month `monthly-balance-payment`: Pays off the balance on a liability account at the given statement day of month. `monthly-interest-only-payment`: Makes an interest-only payment on a liability account at the given statement day of month. Note that account types supported by Liabilities will accrue interest in the Sandbox. The types impacted are account type `credit` with subtype `credit` or `paypal`, and account type `loan` with subtype `student` or `mortgage`.
Public Class Methods
Source
# File lib/plaid/models/inflow_model.rb, line 46 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/inflow_model.rb, line 35 def self.attribute_map { :'type' => :'type', :'income_amount' => :'income_amount', :'payment_day_of_month' => :'payment_day_of_month', :'transaction_name' => :'transaction_name', :'statement_day_of_month' => :'statement_day_of_month' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/inflow_model.rb, line 168 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/inflow_model.rb, line 69 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InflowModel` 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::InflowModel`. 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?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'income_amount') self.income_amount = attributes[:'income_amount'] end if attributes.key?(:'payment_day_of_month') self.payment_day_of_month = attributes[:'payment_day_of_month'] end if attributes.key?(:'transaction_name') self.transaction_name = attributes[:'transaction_name'] end if attributes.key?(:'statement_day_of_month') self.statement_day_of_month = attributes[:'statement_day_of_month'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/inflow_model.rb, line 62 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/inflow_model.rb, line 51 def self.openapi_types { :'type' => :'String', :'income_amount' => :'Float', :'payment_day_of_month' => :'Float', :'transaction_name' => :'String', :'statement_day_of_month' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/inflow_model.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && income_amount == o.income_amount && payment_day_of_month == o.payment_day_of_month && transaction_name == o.transaction_name && statement_day_of_month == o.statement_day_of_month end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/inflow_model.rb, line 199 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/inflow_model.rb, line 270 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/inflow_model.rb, line 175 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/inflow_model.rb, line 155 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/inflow_model.rb, line 161 def hash [type, income_amount, payment_day_of_month, transaction_name, statement_day_of_month].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/inflow_model.rb, line 105 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @income_amount.nil? invalid_properties.push('invalid value for "income_amount", income_amount cannot be nil.') end if @payment_day_of_month.nil? invalid_properties.push('invalid value for "payment_day_of_month", payment_day_of_month cannot be nil.') end if @transaction_name.nil? invalid_properties.push('invalid value for "transaction_name", transaction_name cannot be nil.') end if @statement_day_of_month.nil? invalid_properties.push('invalid value for "statement_day_of_month", statement_day_of_month cannot be nil.') end 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/inflow_model.rb, line 252 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/inflow_model.rb, line 240 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/inflow_model.rb, line 132 def valid? return false if @type.nil? return false if @income_amount.nil? return false if @payment_day_of_month.nil? return false if @transaction_name.nil? return false if @statement_day_of_month.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid