class Plaid::BaseReportAccountInsights
Calculated insights derived from transaction-level data.
Attributes
Average number of days between sequential transactions
Deprecated; use ‘average_inflow_amounts` instead. Average amount of debit transactions into the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
Customers must transition from ‘average_inflow_amount` by January 31st 2025. Average amount of debit transactions into the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
Deprecated; use ‘average_outflow_amounts` instead. Average amount of transactions out of the account. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
Customers must transition from ‘average_outflow_amount` by January 31st 2025. Average amount of transactions out of the account in a time period. This array will be empty for non-depository accounts. This field only takes into account USD transactions from the account.
Number of days days available in the base report for the account.
Deprecated; use ‘longest_gaps_between_transactions` instead. Longest gap between sequential transactions
Customers must transition from ‘longest_gap_between_transactions` by January 31st 2025. Longest gap between sequential transactions in a time period. This array can include multiple time periods.
Date of the most recent transaction in the base report for the account.
Number of days with no transactions
The number of debits into the account. This array will be empty for non-depository accounts.
The number of outflows from the account. This array will be empty for non-depository accounts.
Date of the earliest transaction in the base report for the account.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/base_report_account_insights.rb, line 78 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/base_report_account_insights.rb, line 59 def self.attribute_map { :'oldest_transaction_date' => :'oldest_transaction_date', :'most_recent_transaction_date' => :'most_recent_transaction_date', :'days_available' => :'days_available', :'average_days_between_transactions' => :'average_days_between_transactions', :'longest_gap_between_transactions' => :'longest_gap_between_transactions', :'longest_gaps_between_transactions' => :'longest_gaps_between_transactions', :'number_of_inflows' => :'number_of_inflows', :'average_inflow_amount' => :'average_inflow_amount', :'average_inflow_amounts' => :'average_inflow_amounts', :'number_of_outflows' => :'number_of_outflows', :'average_outflow_amount' => :'average_outflow_amount', :'average_outflow_amounts' => :'average_outflow_amounts', :'number_of_days_no_transactions' => :'number_of_days_no_transactions' } 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/base_report_account_insights.rb, line 241 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/base_report_account_insights.rb, line 111 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::BaseReportAccountInsights` 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::BaseReportAccountInsights`. 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?(:'oldest_transaction_date') self.oldest_transaction_date = attributes[:'oldest_transaction_date'] end if attributes.key?(:'most_recent_transaction_date') self.most_recent_transaction_date = attributes[:'most_recent_transaction_date'] end if attributes.key?(:'days_available') self.days_available = attributes[:'days_available'] end if attributes.key?(:'average_days_between_transactions') self.average_days_between_transactions = attributes[:'average_days_between_transactions'] end if attributes.key?(:'longest_gap_between_transactions') if (value = attributes[:'longest_gap_between_transactions']).is_a?(Array) self.longest_gap_between_transactions = value end end if attributes.key?(:'longest_gaps_between_transactions') if (value = attributes[:'longest_gaps_between_transactions']).is_a?(Array) self.longest_gaps_between_transactions = value end end if attributes.key?(:'number_of_inflows') if (value = attributes[:'number_of_inflows']).is_a?(Array) self.number_of_inflows = value end end if attributes.key?(:'average_inflow_amount') if (value = attributes[:'average_inflow_amount']).is_a?(Array) self.average_inflow_amount = value end end if attributes.key?(:'average_inflow_amounts') if (value = attributes[:'average_inflow_amounts']).is_a?(Array) self.average_inflow_amounts = value end end if attributes.key?(:'number_of_outflows') if (value = attributes[:'number_of_outflows']).is_a?(Array) self.number_of_outflows = value end end if attributes.key?(:'average_outflow_amount') if (value = attributes[:'average_outflow_amount']).is_a?(Array) self.average_outflow_amount = value end end if attributes.key?(:'average_outflow_amounts') if (value = attributes[:'average_outflow_amounts']).is_a?(Array) self.average_outflow_amounts = value end end if attributes.key?(:'number_of_days_no_transactions') self.number_of_days_no_transactions = attributes[:'number_of_days_no_transactions'] end end
List of attributes with nullable: true
# File lib/plaid/models/base_report_account_insights.rb, line 102 def self.openapi_nullable Set.new([ :'oldest_transaction_date', :'most_recent_transaction_date', ]) end
Attribute type mapping.
# File lib/plaid/models/base_report_account_insights.rb, line 83 def self.openapi_types { :'oldest_transaction_date' => :'Date', :'most_recent_transaction_date' => :'Date', :'days_available' => :'Integer', :'average_days_between_transactions' => :'Float', :'longest_gap_between_transactions' => :'Array<BaseReportLongestGapInsights>', :'longest_gaps_between_transactions' => :'Array<BaseReportLongestGapInsights>', :'number_of_inflows' => :'Array<BaseReportNumberFlowInsights>', :'average_inflow_amount' => :'Array<BaseReportAverageFlowInsights>', :'average_inflow_amounts' => :'Array<BaseReportAverageFlowInsights>', :'number_of_outflows' => :'Array<BaseReportNumberFlowInsights>', :'average_outflow_amount' => :'Array<BaseReportAverageFlowInsights>', :'average_outflow_amounts' => :'Array<BaseReportAverageFlowInsights>', :'number_of_days_no_transactions' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/base_report_account_insights.rb, line 208 def ==(o) return true if self.equal?(o) self.class == o.class && oldest_transaction_date == o.oldest_transaction_date && most_recent_transaction_date == o.most_recent_transaction_date && days_available == o.days_available && average_days_between_transactions == o.average_days_between_transactions && longest_gap_between_transactions == o.longest_gap_between_transactions && longest_gaps_between_transactions == o.longest_gaps_between_transactions && number_of_inflows == o.number_of_inflows && average_inflow_amount == o.average_inflow_amount && average_inflow_amounts == o.average_inflow_amounts && number_of_outflows == o.number_of_outflows && average_outflow_amount == o.average_outflow_amount && average_outflow_amounts == o.average_outflow_amounts && number_of_days_no_transactions == o.number_of_days_no_transactions 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/base_report_account_insights.rb, line 272 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/base_report_account_insights.rb, line 343 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/base_report_account_insights.rb, line 248 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/base_report_account_insights.rb, line 228 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/base_report_account_insights.rb, line 234 def hash [oldest_transaction_date, most_recent_transaction_date, days_available, average_days_between_transactions, longest_gap_between_transactions, longest_gaps_between_transactions, number_of_inflows, average_inflow_amount, average_inflow_amounts, number_of_outflows, average_outflow_amount, average_outflow_amounts, number_of_days_no_transactions].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/base_report_account_insights.rb, line 195 def list_invalid_properties invalid_properties = Array.new 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/base_report_account_insights.rb, line 325 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/base_report_account_insights.rb, line 313 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/base_report_account_insights.rb, line 202 def valid? true end