Class: MxPlatformRuby::BudgetResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/models/budget_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BudgetResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 131

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

A goal amount set by the user for a category’s transaction total during a month.



19
20
21
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 19

def amount
  @amount
end

#category_guid ⇒ Object

Unique identifier for the budget category. Defined by MX.



22
23
24
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 22

def category_guid
  @category_guid
end

#created_at ⇒ Object

Date and time the budget was created, represented in ISO 8601 format with timestamp.



25
26
27
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 25

def created_at
  @created_at
end

#guid ⇒ Object

Unique identifier for the budget. Defined by MX.



28
29
30
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 28

def guid
  @guid
end

#is_exceeded ⇒ Object

If the budget has been exceeded, this field will be true. Otherwise, this field will be false.



31
32
33
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 31

def is_exceeded
  @is_exceeded
end

#is_off_track ⇒ Object

If the budget is off track, this field will be true. Otherwise, this field will be false.



34
35
36
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 34

def is_off_track
  @is_off_track
end

#metadata ⇒ Object

Additional information a partner can store on the budget.



37
38
39
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 37

def metadata
  @metadata
end

#name ⇒ Object

The name of the budget that is visible to the user (ie "Food", "Bills", "Entertainment", etc).



40
41
42
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 40

def name
  @name
end

#off_track_percentage ⇒ Object

The percentage amount of off track spending. (Deprecated).



43
44
45
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 43

def off_track_percentage
  @off_track_percentage
end

#parent_guid ⇒ Object

Unique identifier for the parent budget. Defined by MX.



46
47
48
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 46

def parent_guid
  @parent_guid
end

#percent_spent ⇒ Object

The percentage of a budget that has been spent during the current calendar month Calculated as the transaction total divided by the amount and then multiplied by 100.A value of zero will be returned when ‘amount` is zero.



49
50
51
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 49

def percent_spent
  @percent_spent
end

#projected_spending ⇒ Object

The projected amount of spending for the budget.



52
53
54
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 52

def projected_spending
  @projected_spending
end

#revision ⇒ Object

The revision number of this budget record.



55
56
57
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 55

def revision
  @revision
end

#transaction_total ⇒ Object

The cumulative amount of all transactions under the budget.



58
59
60
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 58

def transaction_total
  @transaction_total
end

#updated_at ⇒ Object

Date and time the budget was updated, represented in ISO 8601 format with timestamp.



61
62
63
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 61

def updated_at
  @updated_at
end

#user_guid ⇒ Object

Unique identifier for the user. Defined by MX.



64
65
66
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 64

def user_guid
  @user_guid
end

Class Method Details

._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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 286

def self._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 = MxPlatformRuby.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 67

def self.attribute_map
  {
    :'amount' => :'amount',
    :'category_guid' => :'category_guid',
    :'created_at' => :'created_at',
    :'guid' => :'guid',
    :'is_exceeded' => :'is_exceeded',
    :'is_off_track' => :'is_off_track',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'off_track_percentage' => :'off_track_percentage',
    :'parent_guid' => :'parent_guid',
    :'percent_spent' => :'percent_spent',
    :'projected_spending' => :'projected_spending',
    :'revision' => :'revision',
    :'transaction_total' => :'transaction_total',
    :'updated_at' => :'updated_at',
    :'user_guid' => :'user_guid'
  }
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 262

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_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 116

def self.openapi_nullable
  Set.new([
    :'metadata',
    :'name',
    :'off_track_percentage',
    :'parent_guid',
    :'percent_spent',
    :'transaction_total',
    :'updated_at',
    :'user_guid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 94

def self.openapi_types
  {
    :'amount' => :'Float',
    :'category_guid' => :'String',
    :'created_at' => :'String',
    :'guid' => :'String',
    :'is_exceeded' => :'Boolean',
    :'is_off_track' => :'Boolean',
    :'metadata' => :'String',
    :'name' => :'String',
    :'off_track_percentage' => :'Float',
    :'parent_guid' => :'String',
    :'percent_spent' => :'Float',
    :'projected_spending' => :'Float',
    :'revision' => :'Integer',
    :'transaction_total' => :'Object',
    :'updated_at' => :'Object',
    :'user_guid' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      category_guid == o.category_guid &&
      created_at == o.created_at &&
      guid == o.guid &&
      is_exceeded == o.is_exceeded &&
      is_off_track == o.is_off_track &&
      metadata == o.metadata &&
      name == o.name &&
      off_track_percentage == o.off_track_percentage &&
      parent_guid == o.parent_guid &&
      percent_spent == o.percent_spent &&
      projected_spending == o.projected_spending &&
      revision == o.revision &&
      transaction_total == o.transaction_total &&
      updated_at == o.updated_at &&
      user_guid == o.user_guid
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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 357

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


249
250
251
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 255

def hash
  [amount, category_guid, created_at, guid, is_exceeded, is_off_track, metadata, name, off_track_percentage, parent_guid, percent_spent, projected_spending, revision, transaction_total, updated_at, user_guid].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



211
212
213
214
215
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 211

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



333
334
335
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 339

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



327
328
329
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 327

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



219
220
221
222
 
# File 'lib/mx-platform-ruby/models/budget_response.rb', line 219

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end