Class: YNAB::SubTransaction

Inherits:
ApiModelBase show all
Defined in:
lib/ynab/models/sub_transaction.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SubTransaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/ynab/models/sub_transaction.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `YNAB::SubTransaction` 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::SubTransaction`. 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?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  end

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'memo')
    self.memo = attributes[:'memo']
  end

  if attributes.key?(:'payee_id')
    self.payee_id = attributes[:'payee_id']
  end

  if attributes.key?(:'payee_name')
    self.payee_name = attributes[:'payee_name']
  end

  if attributes.key?(:'category_id')
    self.category_id = attributes[:'category_id']
  end

  if attributes.key?(:'category_name')
    self.category_name = attributes[:'category_name']
  end

  if attributes.key?(:'transfer_account_id')
    self. = attributes[:'transfer_account_id']
  end

  if attributes.key?(:'transfer_transaction_id')
    self.transfer_transaction_id = attributes[:'transfer_transaction_id']
  end

  if attributes.key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.key?(:'amount_formatted')
    self.amount_formatted = attributes[:'amount_formatted']
  end

  if attributes.key?(:'amount_currency')
    self.amount_currency = attributes[:'amount_currency']
  end
end

Instance Attribute Details

#amount ⇒ Object

The subtransaction amount in milliunits format



20
21
22
 
# File 'lib/ynab/models/sub_transaction.rb', line 20

def amount
  @amount
end

#amount_currency ⇒ Object

The subtransaction amount as a decimal currency amount



45
46
47
 
# File 'lib/ynab/models/sub_transaction.rb', line 45

def amount_currency
  @amount_currency
end

#amount_formatted ⇒ Object

The subtransaction amount formatted in the plan’s currency format



42
43
44
 
# File 'lib/ynab/models/sub_transaction.rb', line 42

def amount_formatted
  @amount_formatted
end

#category_id ⇒ Object

Returns the value of attribute category_id.



28
29
30
 
# File 'lib/ynab/models/sub_transaction.rb', line 28

def category_id
  @category_id
end

#category_name ⇒ Object

Returns the value of attribute category_name.



30
31
32
 
# File 'lib/ynab/models/sub_transaction.rb', line 30

def category_name
  @category_name
end

#deleted ⇒ Object

Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests.



39
40
41
 
# File 'lib/ynab/models/sub_transaction.rb', line 39

def deleted
  @deleted
end

#id ⇒ Object

Returns the value of attribute id.



15
16
17
 
# File 'lib/ynab/models/sub_transaction.rb', line 15

def id
  @id
end

#memo ⇒ Object

Returns the value of attribute memo.



22
23
24
 
# File 'lib/ynab/models/sub_transaction.rb', line 22

def memo
  @memo
end

#payee_id ⇒ Object

Returns the value of attribute payee_id.



24
25
26
 
# File 'lib/ynab/models/sub_transaction.rb', line 24

def payee_id
  @payee_id
end

#payee_name ⇒ Object

Returns the value of attribute payee_name.



26
27
28
 
# File 'lib/ynab/models/sub_transaction.rb', line 26

def payee_name
  @payee_name
end

#transaction_id ⇒ Object

Returns the value of attribute transaction_id.



17
18
19
 
# File 'lib/ynab/models/sub_transaction.rb', line 17

def transaction_id
  @transaction_id
end

#transfer_account_id ⇒ Object

If a transfer, the account_id which the subtransaction transfers to



33
34
35
 
# File 'lib/ynab/models/sub_transaction.rb', line 33

def 
  @transfer_account_id
end

#transfer_transaction_id ⇒ Object

If a transfer, the id of transaction on the other side of the transfer



36
37
38
 
# File 'lib/ynab/models/sub_transaction.rb', line 36

def transfer_transaction_id
  @transfer_transaction_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/ynab/models/sub_transaction.rb', line 67

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ynab/models/sub_transaction.rb', line 48

def self.attribute_map
  {
    :'id' => :'id',
    :'transaction_id' => :'transaction_id',
    :'amount' => :'amount',
    :'memo' => :'memo',
    :'payee_id' => :'payee_id',
    :'payee_name' => :'payee_name',
    :'category_id' => :'category_id',
    :'category_name' => :'category_name',
    :'transfer_account_id' => :'transfer_account_id',
    :'transfer_transaction_id' => :'transfer_transaction_id',
    :'deleted' => :'deleted',
    :'amount_formatted' => :'amount_formatted',
    :'amount_currency' => :'amount_currency'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ynab/models/sub_transaction.rb', line 223

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



97
98
99
100
101
 
# File 'lib/ynab/models/sub_transaction.rb', line 97

def self.openapi_all_of
  [
  :'SubTransactionBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/ynab/models/sub_transaction.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ynab/models/sub_transaction.rb', line 72

def self.openapi_types
  {
    :'id' => :'String',
    :'transaction_id' => :'String',
    :'amount' => :'Integer',
    :'memo' => :'String',
    :'payee_id' => :'String',
    :'payee_name' => :'String',
    :'category_id' => :'String',
    :'category_name' => :'String',
    :'transfer_account_id' => :'String',
    :'transfer_transaction_id' => :'String',
    :'deleted' => :'Boolean',
    :'amount_formatted' => :'String',
    :'amount_currency' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/ynab/models/sub_transaction.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      transaction_id == o.transaction_id &&
      amount == o.amount &&
      memo == o.memo &&
      payee_id == o.payee_id &&
      payee_name == o.payee_name &&
      category_id == o.category_id &&
      category_name == o.category_name &&
       == o. &&
      transfer_transaction_id == o.transfer_transaction_id &&
      deleted == o.deleted &&
      amount_formatted == o.amount_formatted &&
      amount_currency == o.amount_currency
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/ynab/models/sub_transaction.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/ynab/models/sub_transaction.rb', line 216

def hash
  [id, transaction_id, amount, memo, payee_id, payee_name, category_id, category_name, , transfer_transaction_id, deleted, amount_formatted, amount_currency].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



173
174
175
176
 
# File 'lib/ynab/models/sub_transaction.rb', line 173

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ynab/models/sub_transaction.rb', line 245

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



180
181
182
183
184
185
186
 
# File 'lib/ynab/models/sub_transaction.rb', line 180

def valid?
  return false if @id.nil?
  return false if @transaction_id.nil?
  return false if @amount.nil?
  return false if @deleted.nil?
  true
end