class YNAB::TransactionSummary
Attributes
The transaction amount in milliunits format
Whether or not the transaction is approved
The cleared status of the transaction
The transaction date in ISO format (e.g. 2016-12-01)
Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
The transaction flag
If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API
, the import_id
will have the format: 'YNAB::[iso_date]:'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id
of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id
would be 'YNAB:-294230:2015-12-30:2'.
If transaction is matched, the id of the matched transaction
If a transfer transaction, the account to which it transfers
If a transfer transaction, the id of transaction on the other side of the transfer
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ynab/models/transaction_summary.rb, line 80 def self.attribute_map { :'id' => :'id', :'date' => :'date', :'amount' => :'amount', :'memo' => :'memo', :'cleared' => :'cleared', :'approved' => :'approved', :'flag_color' => :'flag_color', :'account_id' => :'account_id', :'payee_id' => :'payee_id', :'category_id' => :'category_id', :'transfer_account_id' => :'transfer_account_id', :'transfer_transaction_id' => :'transfer_transaction_id', :'matched_transaction_id' => :'matched_transaction_id', :'import_id' => :'import_id', :'deleted' => :'deleted' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ynab/models/transaction_summary.rb, line 123 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'date') self.date = attributes[:'date'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'memo') self.memo = attributes[:'memo'] end if attributes.has_key?(:'cleared') self.cleared = attributes[:'cleared'] end if attributes.has_key?(:'approved') self.approved = attributes[:'approved'] end if attributes.has_key?(:'flag_color') self.flag_color = attributes[:'flag_color'] end if attributes.has_key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.has_key?(:'payee_id') self.payee_id = attributes[:'payee_id'] end if attributes.has_key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.has_key?(:'transfer_account_id') self.transfer_account_id = attributes[:'transfer_account_id'] end if attributes.has_key?(:'transfer_transaction_id') self.transfer_transaction_id = attributes[:'transfer_transaction_id'] end if attributes.has_key?(:'matched_transaction_id') self.matched_transaction_id = attributes[:'matched_transaction_id'] end if attributes.has_key?(:'import_id') self.import_id = attributes[:'import_id'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end end
Attribute type mapping.
# File lib/ynab/models/transaction_summary.rb, line 101 def self.swagger_types { :'id' => :'String', :'date' => :'Date', :'amount' => :'Integer', :'memo' => :'String', :'cleared' => :'String', :'approved' => :'BOOLEAN', :'flag_color' => :'String', :'account_id' => :'String', :'payee_id' => :'String', :'category_id' => :'String', :'transfer_account_id' => :'String', :'transfer_transaction_id' => :'String', :'matched_transaction_id' => :'String', :'import_id' => :'String', :'deleted' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ynab/models/transaction_summary.rb, line 256 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && date == o.date && amount == o.amount && memo == o.memo && cleared == o.cleared && approved == o.approved && flag_color == o.flag_color && account_id == o.account_id && payee_id == o.payee_id && category_id == o.category_id && transfer_account_id == o.transfer_account_id && transfer_transaction_id == o.transfer_transaction_id && matched_transaction_id == o.matched_transaction_id && import_id == o.import_id && deleted == o.deleted 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/ynab/models/transaction_summary.rb, line 311 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = YNAB.const_get(type).new temp_model.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/ynab/models/transaction_summary.rb, line 377 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/ynab/models/transaction_summary.rb, line 290 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] cleared Object to be assigned
# File lib/ynab/models/transaction_summary.rb, line 244 def cleared=(cleared) @cleared = cleared end
@see the `==` method @param [Object] Object to be compared
# File lib/ynab/models/transaction_summary.rb, line 278 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] flag_color
Object to be assigned
# File lib/ynab/models/transaction_summary.rb, line 250 def flag_color=(flag_color) @flag_color = flag_color end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ynab/models/transaction_summary.rb, line 284 def hash [id, date, amount, memo, cleared, approved, flag_color, account_id, payee_id, category_id, transfer_account_id, transfer_transaction_id, matched_transaction_id, import_id, deleted].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ynab/models/transaction_summary.rb, line 192 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @date.nil? invalid_properties.push('invalid value for "date", date cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @cleared.nil? invalid_properties.push('invalid value for "cleared", cleared cannot be nil.') end if @approved.nil? invalid_properties.push('invalid value for "approved", approved cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @deleted.nil? invalid_properties.push('invalid value for "deleted", deleted 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/ynab/models/transaction_summary.rb, line 363 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ynab/models/transaction_summary.rb, line 351 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/ynab/models/transaction_summary.rb, line 227 def valid? return false if @id.nil? return false if @date.nil? return false if @amount.nil? return false if @cleared.nil? cleared_validator = EnumAttributeValidator.new('String', ['cleared', 'uncleared', 'reconciled']) return false unless cleared_validator.valid?(@cleared) return false if @approved.nil? flag_color_validator = EnumAttributeValidator.new('String', ['red', 'orange', 'yellow', 'green', 'blue', 'purple']) return false unless flag_color_validator.valid?(@flag_color) return false if @account_id.nil? return false if @deleted.nil? true end