class Plaid::RecurringInsightsStream
Insights object for recurring transactions streams.
Attributes
The average number of days between each of the recurring transactions.
The client-provided raw description of the most recent transaction in the stream.
Indicates whether the transaction stream is still live.
The merchant or primary counterparty associated with the transaction stream.
The posted date of the latest transaction in the stream.
The posted date of the earliest transaction in the stream.
The detailed category associated with the transaction stream.
The primary category associated with the transaction stream.
A unique id for the stream.
The number of transactions in this stream.
An array of Plaid
transaction IDs belonging to the stream, sorted by posted date.
Public Class Methods
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 104 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 83 def self.attribute_map { :'stream_id' => :'stream_id', :'description' => :'description', :'merchant_name' => :'merchant_name', :'oldest_transaction_date' => :'oldest_transaction_date', :'newest_transaction_date' => :'newest_transaction_date', :'average_days_apart' => :'average_days_apart', :'frequency' => :'frequency', :'transaction_count' => :'transaction_count', :'transaction_ids' => :'transaction_ids', :'average_amount' => :'average_amount', :'newest_transaction_amount' => :'newest_transaction_amount', :'is_active' => :'is_active', :'status' => :'status', :'personal_finance_category_primary' => :'personal_finance_category_primary', :'personal_finance_category_detailed' => :'personal_finance_category_detailed' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 283 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/recurring_insights_stream.rb, line 137 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::RecurringInsightsStream` 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::RecurringInsightsStream`. 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?(:'stream_id') self.stream_id = attributes[:'stream_id'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'merchant_name') self.merchant_name = attributes[:'merchant_name'] end if attributes.key?(:'oldest_transaction_date') self.oldest_transaction_date = attributes[:'oldest_transaction_date'] end if attributes.key?(:'newest_transaction_date') self.newest_transaction_date = attributes[:'newest_transaction_date'] end if attributes.key?(:'average_days_apart') self.average_days_apart = attributes[:'average_days_apart'] end if attributes.key?(:'frequency') self.frequency = attributes[:'frequency'] end if attributes.key?(:'transaction_count') self.transaction_count = attributes[:'transaction_count'] end if attributes.key?(:'transaction_ids') if (value = attributes[:'transaction_ids']).is_a?(Array) self.transaction_ids = value end end if attributes.key?(:'average_amount') self.average_amount = attributes[:'average_amount'] end if attributes.key?(:'newest_transaction_amount') self.newest_transaction_amount = attributes[:'newest_transaction_amount'] end if attributes.key?(:'is_active') self.is_active = attributes[:'is_active'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'personal_finance_category_primary') self.personal_finance_category_primary = attributes[:'personal_finance_category_primary'] end if attributes.key?(:'personal_finance_category_detailed') self.personal_finance_category_detailed = attributes[:'personal_finance_category_detailed'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 130 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 109 def self.openapi_types { :'stream_id' => :'String', :'description' => :'String', :'merchant_name' => :'String', :'oldest_transaction_date' => :'Date', :'newest_transaction_date' => :'Date', :'average_days_apart' => :'Float', :'frequency' => :'RecurringTransactionFrequency', :'transaction_count' => :'Integer', :'transaction_ids' => :'Array<String>', :'average_amount' => :'TransactionStreamAmount', :'newest_transaction_amount' => :'TransactionStreamAmount', :'is_active' => :'Boolean', :'status' => :'TransactionStreamStatus', :'personal_finance_category_primary' => :'String', :'personal_finance_category_detailed' => :'String' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 248 def ==(o) return true if self.equal?(o) self.class == o.class && stream_id == o.stream_id && description == o.description && merchant_name == o.merchant_name && oldest_transaction_date == o.oldest_transaction_date && newest_transaction_date == o.newest_transaction_date && average_days_apart == o.average_days_apart && frequency == o.frequency && transaction_count == o.transaction_count && transaction_ids == o.transaction_ids && average_amount == o.average_amount && newest_transaction_amount == o.newest_transaction_amount && is_active == o.is_active && status == o.status && personal_finance_category_primary == o.personal_finance_category_primary && personal_finance_category_detailed == o.personal_finance_category_detailed end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 314 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/recurring_insights_stream.rb, line 385 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/recurring_insights_stream.rb, line 290 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/recurring_insights_stream.rb, line 270 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 276 def hash [stream_id, description, merchant_name, oldest_transaction_date, newest_transaction_date, average_days_apart, frequency, transaction_count, transaction_ids, average_amount, newest_transaction_amount, is_active, status, personal_finance_category_primary, personal_finance_category_detailed].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/recurring_insights_stream.rb, line 215 def list_invalid_properties invalid_properties = Array.new if @stream_id.nil? invalid_properties.push('invalid value for "stream_id", stream_id cannot be nil.') end if @merchant_name.nil? invalid_properties.push('invalid value for "merchant_name", merchant_name cannot be nil.') end if @average_days_apart.nil? invalid_properties.push('invalid value for "average_days_apart", average_days_apart cannot be nil.') end if @is_active.nil? invalid_properties.push('invalid value for "is_active", is_active 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/recurring_insights_stream.rb, line 367 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/recurring_insights_stream.rb, line 355 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/recurring_insights_stream.rb, line 238 def valid? return false if @stream_id.nil? return false if @merchant_name.nil? return false if @average_days_apart.nil? return false if @is_active.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid