class Plaid::TransactionStream
A grouping of related transactions
Attributes
The ID of the account to which the stream belongs
A hierarchical array of the categories to which this transaction belongs. See [Categories](plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new ‘personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.
The ID of the category to which this transaction belongs. See [Categories](plaid.com/docs/api/products/transactions/#categoriesget). All implementations are encouraged to use the new ‘personal_finance_category` instead of `category`. `personal_finance_category` provides more meaningful categorization and greater accuracy.
A description of the transaction stream.
The posted date of the earliest transaction in the stream.
Indicates whether the transaction stream is still live.
This will be set to ‘true` if the stream has been modified by request to a `/transactions/recurring/streams` endpoint. It will be `false` for all other streams.
The posted date of the latest transaction in the stream.
The date and time of the most recent user modification. This will only be set if ‘is_user_modified` is `true`.
The merchant associated with the transaction stream.
The predicted date of the next payment. This will only be set if the next payment date can be predicted.
A unique id for the stream
An array of Plaid
transaction IDs belonging to the stream, sorted by posted date.
Public Class Methods
Source
# File lib/plaid/models/transaction_stream.rb, line 115 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/transaction_stream.rb, line 91 def self.attribute_map { :'account_id' => :'account_id', :'stream_id' => :'stream_id', :'category' => :'category', :'category_id' => :'category_id', :'description' => :'description', :'merchant_name' => :'merchant_name', :'first_date' => :'first_date', :'last_date' => :'last_date', :'predicted_next_date' => :'predicted_next_date', :'frequency' => :'frequency', :'transaction_ids' => :'transaction_ids', :'average_amount' => :'average_amount', :'last_amount' => :'last_amount', :'is_active' => :'is_active', :'status' => :'status', :'personal_finance_category' => :'personal_finance_category', :'is_user_modified' => :'is_user_modified', :'last_user_modified_datetime' => :'last_user_modified_datetime' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/transaction_stream.rb, line 359 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/transaction_stream.rb, line 156 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionStream` 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::TransactionStream`. 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?(:'stream_id') self.stream_id = attributes[:'stream_id'] end if attributes.key?(:'category') if (value = attributes[:'category']).is_a?(Array) self.category = value end end if attributes.key?(:'category_id') self.category_id = attributes[:'category_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?(:'first_date') self.first_date = attributes[:'first_date'] end if attributes.key?(:'last_date') self.last_date = attributes[:'last_date'] end if attributes.key?(:'predicted_next_date') self.predicted_next_date = attributes[:'predicted_next_date'] end if attributes.key?(:'frequency') self.frequency = attributes[:'frequency'] 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?(:'last_amount') self.last_amount = attributes[:'last_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') self.personal_finance_category = attributes[:'personal_finance_category'] end if attributes.key?(:'is_user_modified') self.is_user_modified = attributes[:'is_user_modified'] end if attributes.key?(:'last_user_modified_datetime') self.last_user_modified_datetime = attributes[:'last_user_modified_datetime'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/transaction_stream.rb, line 144 def self.openapi_nullable Set.new([ :'category', :'category_id', :'merchant_name', :'predicted_next_date', :'personal_finance_category', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/transaction_stream.rb, line 120 def self.openapi_types { :'account_id' => :'String', :'stream_id' => :'String', :'category' => :'Array<String>', :'category_id' => :'String', :'description' => :'String', :'merchant_name' => :'String', :'first_date' => :'Date', :'last_date' => :'Date', :'predicted_next_date' => :'Date', :'frequency' => :'RecurringTransactionFrequency', :'transaction_ids' => :'Array<String>', :'average_amount' => :'TransactionStreamAmount', :'last_amount' => :'TransactionStreamAmount', :'is_active' => :'Boolean', :'status' => :'TransactionStreamStatus', :'personal_finance_category' => :'PersonalFinanceCategory', :'is_user_modified' => :'Boolean', :'last_user_modified_datetime' => :'Time' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/transaction_stream.rb, line 321 def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && stream_id == o.stream_id && category == o.category && category_id == o.category_id && description == o.description && merchant_name == o.merchant_name && first_date == o.first_date && last_date == o.last_date && predicted_next_date == o.predicted_next_date && frequency == o.frequency && transaction_ids == o.transaction_ids && average_amount == o.average_amount && last_amount == o.last_amount && is_active == o.is_active && status == o.status && personal_finance_category == o.personal_finance_category && is_user_modified == o.is_user_modified && last_user_modified_datetime == o.last_user_modified_datetime end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/transaction_stream.rb, line 390 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/transaction_stream.rb, line 461 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/transaction_stream.rb, line 366 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/transaction_stream.rb, line 346 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/transaction_stream.rb, line 352 def hash [account_id, stream_id, category, category_id, description, merchant_name, first_date, last_date, predicted_next_date, frequency, transaction_ids, average_amount, last_amount, is_active, status, personal_finance_category, is_user_modified, last_user_modified_datetime].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/transaction_stream.rb, line 248 def list_invalid_properties invalid_properties = Array.new if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @stream_id.nil? invalid_properties.push('invalid value for "stream_id", stream_id cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @first_date.nil? invalid_properties.push('invalid value for "first_date", first_date cannot be nil.') end if @last_date.nil? invalid_properties.push('invalid value for "last_date", last_date cannot be nil.') end if @frequency.nil? invalid_properties.push('invalid value for "frequency", frequency cannot be nil.') end if @transaction_ids.nil? invalid_properties.push('invalid value for "transaction_ids", transaction_ids cannot be nil.') end if @average_amount.nil? invalid_properties.push('invalid value for "average_amount", average_amount cannot be nil.') end if @last_amount.nil? invalid_properties.push('invalid value for "last_amount", last_amount cannot be nil.') end if @is_active.nil? invalid_properties.push('invalid value for "is_active", is_active cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @is_user_modified.nil? invalid_properties.push('invalid value for "is_user_modified", is_user_modified 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/transaction_stream.rb, line 443 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/transaction_stream.rb, line 431 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/transaction_stream.rb, line 303 def valid? return false if @account_id.nil? return false if @stream_id.nil? return false if @description.nil? return false if @first_date.nil? return false if @last_date.nil? return false if @frequency.nil? return false if @transaction_ids.nil? return false if @average_amount.nil? return false if @last_amount.nil? return false if @is_active.nil? return false if @status.nil? return false if @is_user_modified.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid