Class: FireflyIIIClient::BasicSummaryEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/models/basic_summary_entry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BasicSummaryEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
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
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 91

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#currency_code ⇒ Object

Returns the value of attribute currency_code.



30
31
32
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 30

def currency_code
  @currency_code
end

#currency_decimal_places ⇒ Object

Number of decimals for the associated currency.



35
36
37
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 35

def currency_decimal_places
  @currency_decimal_places
end

#currency_id ⇒ Object

The currency ID of the associated currency.



28
29
30
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 28

def currency_id
  @currency_id
end

#currency_symbol ⇒ Object

Returns the value of attribute currency_symbol.



32
33
34
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 32

def currency_symbol
  @currency_symbol
end

#key ⇒ Object

This is a reference to the type of info shared, not influenced by translations or user preferences.



19
20
21
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 19

def key
  @key
end

#local_icon ⇒ Object

Reference to a font-awesome icon without the fa- part.



41
42
43
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 41

def local_icon
  @local_icon
end

#monetary_value ⇒ Object

The amount as a float.



25
26
27
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 25

def monetary_value
  @monetary_value
end

#sub_title ⇒ Object

A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant.



44
45
46
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 44

def sub_title
  @sub_title
end

#title ⇒ Object

A translated title for the information shared.



22
23
24
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 22

def title
  @title
end

#value_parsed ⇒ Object

The amount formatted according to the users locale



38
39
40
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 38

def value_parsed
  @value_parsed
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 47

def self.attribute_map
  {
    :'key' => :'key',
    :'title' => :'title',
    :'monetary_value' => :'monetary_value',
    :'currency_id' => :'currency_id',
    :'currency_code' => :'currency_code',
    :'currency_symbol' => :'currency_symbol',
    :'currency_decimal_places' => :'currency_decimal_places',
    :'value_parsed' => :'value_parsed',
    :'local_icon' => :'local_icon',
    :'sub_title' => :'sub_title'
  }
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



190
191
192
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 190

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



84
85
86
87
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 84

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 68

def self.openapi_types
  {
    :'key' => :'String',
    :'title' => :'String',
    :'monetary_value' => :'Float',
    :'currency_id' => :'Integer',
    :'currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_decimal_places' => :'Integer',
    :'value_parsed' => :'String',
    :'local_icon' => :'String',
    :'sub_title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key == o.key &&
      title == o.title &&
      monetary_value == o.monetary_value &&
      currency_id == o.currency_id &&
      currency_code == o.currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_decimal_places == o.currency_decimal_places &&
      value_parsed == o.value_parsed &&
      local_icon == o.local_icon &&
      sub_title == o.sub_title
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 220

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 = FireflyIIIClient.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 291

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 197

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)
      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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


177
178
179
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



183
184
185
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 183

def hash
  [key, title, monetary_value, currency_id, currency_code, currency_symbol, currency_decimal_places, value_parsed, local_icon, sub_title].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



147
148
149
150
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 147

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 267

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 273

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

Returns:

  • (String) —

    String presentation of the object



261
262
263
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 261

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
 
# File 'lib/firefly_iii_client/models/basic_summary_entry.rb', line 154

def valid?
  true
end