class Plaid::CraBankIncomeSource
Detailed information for the income source.
Attributes
The account ID with which this income source is associated.
Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).
The predicted average monthly net income amount for the income source(s).
The prediction interval(s) for the forecasted average monthly income.
An estimate of the average gross monthly income based on the historical net amount and income category for the income source(s).
The average monthly net income amount estimated based on the historical data for the income source(s).
The most common name or original description for the underlying income transactions.
A unique identifier for an income source.
The ISO 4217 currency code of the amount or balance.
The expected date of the end user’s next paycheck for the income source. The date will be returned in an ISO 8601 format (YYYY-MM-DD).
Minimum of all dates within the specific income sources in the user’s bank account for days requested by the client. The date will be returned in an ISO 8601 format (YYYY-MM-DD).
Total
amount of earnings in the user’s bank account for the specific income source for days requested by the client.
Number of transactions for the income source within the start and end date.
The unofficial currency code associated with the amount or balance. Always ‘null` if `iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/cra_bank_income_source.rb, line 116 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/cra_bank_income_source.rb, line 92 def self.attribute_map { :'account_id' => :'account_id', :'income_source_id' => :'income_source_id', :'income_description' => :'income_description', :'income_category' => :'income_category', :'start_date' => :'start_date', :'end_date' => :'end_date', :'pay_frequency' => :'pay_frequency', :'total_amount' => :'total_amount', :'iso_currency_code' => :'iso_currency_code', :'unofficial_currency_code' => :'unofficial_currency_code', :'transaction_count' => :'transaction_count', :'next_payment_date' => :'next_payment_date', :'historical_average_monthly_gross_income' => :'historical_average_monthly_gross_income', :'historical_average_monthly_income' => :'historical_average_monthly_income', :'forecasted_average_monthly_income' => :'forecasted_average_monthly_income', :'forecasted_average_monthly_income_prediction_intervals' => :'forecasted_average_monthly_income_prediction_intervals', :'employer' => :'employer', :'historical_summary' => :'historical_summary' } 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/cra_bank_income_source.rb, line 306 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/cra_bank_income_source.rb, line 158 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraBankIncomeSource` 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::CraBankIncomeSource`. 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?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'income_source_id') self.income_source_id = attributes[:'income_source_id'] end if attributes.key?(:'income_description') self.income_description = attributes[:'income_description'] end if attributes.key?(:'income_category') self.income_category = attributes[:'income_category'] 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?(:'pay_frequency') self.pay_frequency = attributes[:'pay_frequency'] end if attributes.key?(:'total_amount') self.total_amount = attributes[:'total_amount'] end if attributes.key?(:'iso_currency_code') self.iso_currency_code = attributes[:'iso_currency_code'] end if attributes.key?(:'unofficial_currency_code') self.unofficial_currency_code = attributes[:'unofficial_currency_code'] end if attributes.key?(:'transaction_count') self.transaction_count = attributes[:'transaction_count'] end if attributes.key?(:'next_payment_date') self.next_payment_date = attributes[:'next_payment_date'] end if attributes.key?(:'historical_average_monthly_gross_income') self.historical_average_monthly_gross_income = attributes[:'historical_average_monthly_gross_income'] end if attributes.key?(:'historical_average_monthly_income') self.historical_average_monthly_income = attributes[:'historical_average_monthly_income'] end if attributes.key?(:'forecasted_average_monthly_income') self.forecasted_average_monthly_income = attributes[:'forecasted_average_monthly_income'] end if attributes.key?(:'forecasted_average_monthly_income_prediction_intervals') if (value = attributes[:'forecasted_average_monthly_income_prediction_intervals']).is_a?(Array) self.forecasted_average_monthly_income_prediction_intervals = value end end if attributes.key?(:'employer') self.employer = attributes[:'employer'] end if attributes.key?(:'historical_summary') if (value = attributes[:'historical_summary']).is_a?(Array) self.historical_summary = value end end end
List of attributes with nullable: true
# File lib/plaid/models/cra_bank_income_source.rb, line 145 def self.openapi_nullable Set.new([ :'iso_currency_code', :'unofficial_currency_code', :'next_payment_date', :'historical_average_monthly_gross_income', :'historical_average_monthly_income', :'forecasted_average_monthly_income', ]) end
Attribute type mapping.
# File lib/plaid/models/cra_bank_income_source.rb, line 121 def self.openapi_types { :'account_id' => :'String', :'income_source_id' => :'String', :'income_description' => :'String', :'income_category' => :'CreditBankIncomeCategory', :'start_date' => :'Date', :'end_date' => :'Date', :'pay_frequency' => :'CreditBankIncomePayFrequency', :'total_amount' => :'Float', :'iso_currency_code' => :'String', :'unofficial_currency_code' => :'String', :'transaction_count' => :'Integer', :'next_payment_date' => :'Date', :'historical_average_monthly_gross_income' => :'Float', :'historical_average_monthly_income' => :'Float', :'forecasted_average_monthly_income' => :'Float', :'forecasted_average_monthly_income_prediction_intervals' => :'Array<CraPredictionInterval>', :'employer' => :'CraBankIncomeEmployer', :'historical_summary' => :'Array<CraBankIncomeHistoricalSummary>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/cra_bank_income_source.rb, line 268 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && income_source_id == o.income_source_id && income_description == o.income_description && income_category == o.income_category && start_date == o.start_date && end_date == o.end_date && pay_frequency == o.pay_frequency && total_amount == o.total_amount && iso_currency_code == o.iso_currency_code && unofficial_currency_code == o.unofficial_currency_code && transaction_count == o.transaction_count && next_payment_date == o.next_payment_date && historical_average_monthly_gross_income == o.historical_average_monthly_gross_income && historical_average_monthly_income == o.historical_average_monthly_income && forecasted_average_monthly_income == o.forecasted_average_monthly_income && forecasted_average_monthly_income_prediction_intervals == o.forecasted_average_monthly_income_prediction_intervals && employer == o.employer && historical_summary == o.historical_summary 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/cra_bank_income_source.rb, line 337 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/cra_bank_income_source.rb, line 408 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/cra_bank_income_source.rb, line 313 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/cra_bank_income_source.rb, line 293 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/cra_bank_income_source.rb, line 299 def hash [account_id, income_source_id, income_description, income_category, start_date, end_date, pay_frequency, total_amount, iso_currency_code, unofficial_currency_code, transaction_count, next_payment_date, historical_average_monthly_gross_income, historical_average_monthly_income, forecasted_average_monthly_income, forecasted_average_monthly_income_prediction_intervals, employer, historical_summary].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/cra_bank_income_source.rb, line 250 def list_invalid_properties invalid_properties = Array.new if @forecasted_average_monthly_income_prediction_intervals.nil? invalid_properties.push('invalid value for "forecasted_average_monthly_income_prediction_intervals", forecasted_average_monthly_income_prediction_intervals 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/cra_bank_income_source.rb, line 390 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/cra_bank_income_source.rb, line 378 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/cra_bank_income_source.rb, line 261 def valid? return false if @forecasted_average_monthly_income_prediction_intervals.nil? true end