Class: YNAB::TransactionSummary
- Inherits:
-
Object
- Object
- YNAB::TransactionSummary
- Defined in:
- lib/ynab/models/transaction_summary.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#account_id ⇒ Object
Returns the value of attribute account_id.
-
#amount ⇒ Object
The transaction amount in milliunits format.
-
#approved ⇒ Object
Whether or not the transaction is approved.
-
#category_id ⇒ Object
Returns the value of attribute category_id.
-
#cleared ⇒ Object
The cleared status of the transaction.
-
#date ⇒ Object
The transaction date in ISO format (e.g. 2016-12-01).
-
#debt_transaction_type ⇒ Object
If the transaction is a debt/loan account transaction, the type of transaction.
-
#deleted ⇒ Object
Whether or not the transaction has been deleted.
-
#flag_color ⇒ Object
The transaction flag.
-
#id ⇒ Object
Returns the value of attribute id.
-
#import_id ⇒ Object
If the transaction was imported, this field is a unique (by account) import identifier.
-
#import_payee_name ⇒ Object
If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules.
-
#import_payee_name_original ⇒ Object
If the transaction was imported, the original payee name as it appeared on the statement.
-
#matched_transaction_id ⇒ Object
If transaction is matched, the id of the matched transaction.
-
#memo ⇒ Object
Returns the value of attribute memo.
-
#payee_id ⇒ Object
Returns the value of attribute payee_id.
-
#transfer_account_id ⇒ Object
If a transfer transaction, the account to which it transfers.
-
#transfer_transaction_id ⇒ Object
If a transfer transaction, the id of transaction on the other side of the transfer.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TransactionSummary
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TransactionSummary
Initializes the object
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/ynab/models/transaction_summary.rb', line 161 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `YNAB::TransactionSummary` 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 `YNAB::TransactionSummary`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'memo') self.memo = attributes[:'memo'] end if attributes.key?(:'cleared') self.cleared = attributes[:'cleared'] end if attributes.key?(:'approved') self.approved = attributes[:'approved'] end if attributes.key?(:'flag_color') self.flag_color = attributes[:'flag_color'] end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'payee_id') self.payee_id = attributes[:'payee_id'] end if attributes.key?(:'category_id') self.category_id = attributes[:'category_id'] end if attributes.key?(:'transfer_account_id') self.transfer_account_id = attributes[:'transfer_account_id'] end if attributes.key?(:'transfer_transaction_id') self.transfer_transaction_id = attributes[:'transfer_transaction_id'] end if attributes.key?(:'matched_transaction_id') self.matched_transaction_id = attributes[:'matched_transaction_id'] end if attributes.key?(:'import_id') self.import_id = attributes[:'import_id'] end if attributes.key?(:'import_payee_name') self.import_payee_name = attributes[:'import_payee_name'] end if attributes.key?(:'import_payee_name_original') self.import_payee_name_original = attributes[:'import_payee_name_original'] end if attributes.key?(:'debt_transaction_type') self.debt_transaction_type = attributes[:'debt_transaction_type'] end if attributes.key?(:'deleted') self.deleted = attributes[:'deleted'] end end |
Instance Attribute Details
#account_id ⇒ Object
Returns the value of attribute account_id.
37 38 39 |
# File 'lib/ynab/models/transaction_summary.rb', line 37 def account_id @account_id end |
#amount ⇒ Object
The transaction amount in milliunits format
24 25 26 |
# File 'lib/ynab/models/transaction_summary.rb', line 24 def amount @amount end |
#approved ⇒ Object
Whether or not the transaction is approved
32 33 34 |
# File 'lib/ynab/models/transaction_summary.rb', line 32 def approved @approved end |
#category_id ⇒ Object
Returns the value of attribute category_id.
41 42 43 |
# File 'lib/ynab/models/transaction_summary.rb', line 41 def category_id @category_id end |
#cleared ⇒ Object
The cleared status of the transaction
29 30 31 |
# File 'lib/ynab/models/transaction_summary.rb', line 29 def cleared @cleared end |
#date ⇒ Object
The transaction date in ISO format (e.g. 2016-12-01)
21 22 23 |
# File 'lib/ynab/models/transaction_summary.rb', line 21 def date @date end |
#debt_transaction_type ⇒ Object
If the transaction is a debt/loan account transaction, the type of transaction
62 63 64 |
# File 'lib/ynab/models/transaction_summary.rb', line 62 def debt_transaction_type @debt_transaction_type end |
#deleted ⇒ Object
Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.
65 66 67 |
# File 'lib/ynab/models/transaction_summary.rb', line 65 def deleted @deleted end |
#flag_color ⇒ Object
The transaction flag
35 36 37 |
# File 'lib/ynab/models/transaction_summary.rb', line 35 def flag_color @flag_color end |
#id ⇒ Object
Returns the value of attribute id.
18 19 20 |
# File 'lib/ynab/models/transaction_summary.rb', line 18 def id @id end |
#import_id ⇒ Object
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’.
53 54 55 |
# File 'lib/ynab/models/transaction_summary.rb', line 53 def import_id @import_id end |
#import_payee_name ⇒ Object
If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
56 57 58 |
# File 'lib/ynab/models/transaction_summary.rb', line 56 def import_payee_name @import_payee_name end |
#import_payee_name_original ⇒ Object
If the transaction was imported, the original payee name as it appeared on the statement
59 60 61 |
# File 'lib/ynab/models/transaction_summary.rb', line 59 def import_payee_name_original @import_payee_name_original end |
#matched_transaction_id ⇒ Object
If transaction is matched, the id of the matched transaction
50 51 52 |
# File 'lib/ynab/models/transaction_summary.rb', line 50 def matched_transaction_id @matched_transaction_id end |
#memo ⇒ Object
Returns the value of attribute memo.
26 27 28 |
# File 'lib/ynab/models/transaction_summary.rb', line 26 def memo @memo end |
#payee_id ⇒ Object
Returns the value of attribute payee_id.
39 40 41 |
# File 'lib/ynab/models/transaction_summary.rb', line 39 def payee_id @payee_id end |
#transfer_account_id ⇒ Object
If a transfer transaction, the account to which it transfers
44 45 46 |
# File 'lib/ynab/models/transaction_summary.rb', line 44 def transfer_account_id @transfer_account_id end |
#transfer_transaction_id ⇒ Object
If a transfer transaction, the id of transaction on the other side of the transfer
47 48 49 |
# File 'lib/ynab/models/transaction_summary.rb', line 47 def transfer_transaction_id @transfer_transaction_id end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
114 115 116 |
# File 'lib/ynab/models/transaction_summary.rb', line 114 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/ynab/models/transaction_summary.rb', line 90 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', :'import_payee_name' => :'import_payee_name', :'import_payee_name_original' => :'import_payee_name_original', :'debt_transaction_type' => :'debt_transaction_type', :'deleted' => :'deleted' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
331 332 333 |
# File 'lib/ynab/models/transaction_summary.rb', line 331 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/ynab/models/transaction_summary.rb', line 143 def self.openapi_nullable Set.new([ :'memo', :'flag_color', :'payee_id', :'category_id', :'transfer_account_id', :'transfer_transaction_id', :'matched_transaction_id', :'import_id', :'import_payee_name', :'import_payee_name_original', :'debt_transaction_type', ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/ynab/models/transaction_summary.rb', line 119 def self.openapi_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', :'import_payee_name' => :'String', :'import_payee_name_original' => :'String', :'debt_transaction_type' => :'String', :'deleted' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/ynab/models/transaction_summary.rb', line 293 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 && import_payee_name == o.import_payee_name && import_payee_name_original == o.import_payee_name_original && debt_transaction_type == o.debt_transaction_type && deleted == o.deleted end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/ynab/models/transaction_summary.rb', line 362 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 = YNAB.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/ynab/models/transaction_summary.rb', line 433 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/ynab/models/transaction_summary.rb', line 338 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 |
#eql?(o) ⇒ Boolean
318 319 320 |
# File 'lib/ynab/models/transaction_summary.rb', line 318 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
324 325 326 |
# File 'lib/ynab/models/transaction_summary.rb', line 324 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, import_payee_name, import_payee_name_original, debt_transaction_type, deleted].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
249 250 251 252 |
# File 'lib/ynab/models/transaction_summary.rb', line 249 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
409 410 411 |
# File 'lib/ynab/models/transaction_summary.rb', line 409 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/ynab/models/transaction_summary.rb', line 415 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 |
#to_s ⇒ String
Returns the string representation of the object
403 404 405 |
# File 'lib/ynab/models/transaction_summary.rb', line 403 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/ynab/models/transaction_summary.rb', line 256 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", "null"]) return false unless flag_color_validator.valid?(@flag_color) return false if @account_id.nil? debt_transaction_type_validator = EnumAttributeValidator.new('String', ["payment", "refund", "fee", "interest", "escrow", "balancedAdjustment", "credit", "charge", "null"]) return false unless debt_transaction_type_validator.valid?(@debt_transaction_type) return false if @deleted.nil? true end |