# #Plaid Compatibility Layer # # No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # # The version of the OpenAPI document: 0.1.0 # # Generated by: https://openapi-generator.tech # OpenAPI Generator version: 5.1.1 # require 'date' require 'time' module MoneyKit module PlaidCompatible # A representation of a transaction class Transaction # The ID of the account in which this transaction occurred. attr_accessor :account_id # The settled value of the transaction, denominated in the transactions's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. attr_accessor :amount # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null. attr_accessor :iso_currency_code # A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. attr_accessor :category # The ID of the category to which this transaction belongs. For a full list of categories, see [`/categories/get`](https://plaid.com/docs/api/products/transactions/#categoriesget). If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. attr_accessor :category_id # For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DD` ). attr_accessor :date # The merchant name or transaction description. If the `transactions` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights. attr_accessor :name # The merchant name, as enriched by Plaid from the `name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`. attr_accessor :merchant_name # The string returned by the financial institution to describe the transaction. For transactions returned by `/transactions/get`, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set `options.include_original_description` to `true`. attr_accessor :original_description # When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. attr_accessor :pending # The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive. attr_accessor :transaction_id # Date and time when a transaction was posted in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later. attr_accessor :datetime attr_accessor :personal_finance_category # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { 'account_id': :account_id, 'amount': :amount, 'iso_currency_code': :iso_currency_code, 'category': :category, 'category_id': :category_id, 'date': :date, 'name': :name, 'merchant_name': :merchant_name, 'original_description': :original_description, 'pending': :pending, 'transaction_id': :transaction_id, 'datetime': :datetime, 'personal_finance_category': :personal_finance_category } end # Returns all the JSON keys this model knows about def self.acceptable_attributes attribute_map.values end # Attribute type mapping. def self.openapi_types { 'account_id': :String, 'amount': :Float, 'iso_currency_code': :String, 'category': :'Array', 'category_id': :String, 'date': :Date, 'name': :String, 'merchant_name': :String, 'original_description': :String, 'pending': :Boolean, 'transaction_id': :String, 'datetime': :Time, 'personal_finance_category': :PersonalFinanceCategory } end # List of attributes with nullable: true def self.openapi_nullable Set.new(%i[ iso_currency_code category category_id merchant_name original_description datetime personal_finance_category ]) end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) unless attributes.is_a?(Hash) raise ArgumentError, 'The input argument (attributes) must be a hash in `MoneyKit::PlaidCompatible::Transaction` initialize method' end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) do |(k, v), h| unless self.class.attribute_map.key?(k.to_sym) raise ArgumentError, "`#{k}` is not a valid attribute in `MoneyKit::PlaidCompatible::Transaction`. 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 end self.account_id = attributes[:account_id] if attributes.key?(:account_id) self.amount = attributes[:amount] if attributes.key?(:amount) self.iso_currency_code = attributes[:iso_currency_code] if attributes.key?(:iso_currency_code) if attributes.key?(:category) && (value = attributes[:category]).is_a?(Array) self.category = value end self.category_id = attributes[:category_id] if attributes.key?(:category_id) self.date = attributes[:date] if attributes.key?(:date) self.name = attributes[:name] if attributes.key?(:name) self.merchant_name = attributes[:merchant_name] if attributes.key?(:merchant_name) self.original_description = attributes[:original_description] if attributes.key?(:original_description) self.pending = attributes[:pending] if attributes.key?(:pending) self.transaction_id = attributes[:transaction_id] if attributes.key?(:transaction_id) self.datetime = attributes[:datetime] if attributes.key?(:datetime) return unless attributes.key?(:personal_finance_category) self.personal_finance_category = attributes[:personal_finance_category] end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = [] invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') if @account_id.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') if @amount.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') if @date.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil? invalid_properties.push('invalid value for "pending", pending cannot be nil.') if @pending.nil? if @transaction_id.nil? invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.') end invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? return false if @account_id.nil? return false if @amount.nil? return false if @date.nil? return false if @name.nil? return false if @pending.nil? return false if @transaction_id.nil? true end # Checks equality by comparing each attribute. # @param [Object] Object to be compared def ==(other) return true if equal?(other) self.class == other.class && account_id == other.account_id && amount == other.amount && iso_currency_code == other.iso_currency_code && category == other.category && category_id == other.category_id && date == other.date && name == other.name && merchant_name == other.merchant_name && original_description == other.original_description && pending == other.pending && transaction_id == other.transaction_id && datetime == other.datetime && personal_finance_category == other.personal_finance_category end # @see the `==` method # @param [Object] Object to be compared def eql?(other) self == other end # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash [account_id, amount, iso_currency_code, category, category_id, date, name, merchant_name, original_description, pending, transaction_id, datetime, personal_finance_category].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself 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 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) 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) send("#{key}=", attributes[self.class.attribute_map[key]].map do |v| _deserialize(::Regexp.last_match(1), v) end) end elsif !attributes[self.class.attribute_map[key]].nil? send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data 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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 = MoneyKit::PlaidCompatible.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = 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 # 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 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 end end end