Class: NucleusApi::Budget

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/budget.rb

Overview

Budget Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Budget

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/nucleus_api/models/budget.rb', line 120

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?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'aggregation_accounts')
    if (value = attributes[:'aggregation_accounts']).is_a?(Array)
      self.aggregation_accounts = value
    end
  end

  if attributes.has_key?(:'budget')
    if (value = attributes[:'budget']).is_a?(Array)
      self.budget = value
    end
  end

  if attributes.has_key?(:'card_id')
    self.card_id = attributes[:'card_id']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

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

  if attributes.has_key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.has_key?(:'frequency')
    self.frequency = attributes[:'frequency']
  end

  if attributes.has_key?(:'frequency_unit')
    self.frequency_unit = attributes[:'frequency_unit']
  end

  if attributes.has_key?(:'goal_id')
    self.goal_id = attributes[:'goal_id']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'is_active')
    self.is_active = attributes[:'is_active']
  end

  if attributes.has_key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

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

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.has_key?(:'total_value')
    self.total_value = attributes[:'total_value']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end
end

Instance Attribute Details

#account_id ⇒ Object

accountId



19
20
21
 
# File 'lib/nucleus_api/models/budget.rb', line 19

def 
  @account_id
end

#aggregation_accounts ⇒ Object

Returns the value of attribute aggregation_accounts.



21
22
23
 
# File 'lib/nucleus_api/models/budget.rb', line 21

def aggregation_accounts
  @aggregation_accounts
end

#budget ⇒ Object

Returns the value of attribute budget.



23
24
25
 
# File 'lib/nucleus_api/models/budget.rb', line 23

def budget
  @budget
end

#card_id ⇒ Object

cardId



26
27
28
 
# File 'lib/nucleus_api/models/budget.rb', line 26

def card_id
  @card_id
end

#client_id ⇒ Object

clientId



29
30
31
 
# File 'lib/nucleus_api/models/budget.rb', line 29

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



31
32
33
 
# File 'lib/nucleus_api/models/budget.rb', line 31

def create_date
  @create_date
end

#currency_code ⇒ Object

currencyCode



34
35
36
 
# File 'lib/nucleus_api/models/budget.rb', line 34

def currency_code
  @currency_code
end

#end_date ⇒ Object

endDate



37
38
39
 
# File 'lib/nucleus_api/models/budget.rb', line 37

def end_date
  @end_date
end

#frequency ⇒ Object

frequency



40
41
42
 
# File 'lib/nucleus_api/models/budget.rb', line 40

def frequency
  @frequency
end

#frequency_unit ⇒ Object

frequencyUnit



43
44
45
 
# File 'lib/nucleus_api/models/budget.rb', line 43

def frequency_unit
  @frequency_unit
end

#goal_id ⇒ Object

goalId



46
47
48
 
# File 'lib/nucleus_api/models/budget.rb', line 46

def goal_id
  @goal_id
end

#id ⇒ Object

Returns the value of attribute id.



48
49
50
 
# File 'lib/nucleus_api/models/budget.rb', line 48

def id
  @id
end

#is_active ⇒ Object

is_active



51
52
53
 
# File 'lib/nucleus_api/models/budget.rb', line 51

def is_active
  @is_active
end

#metadata ⇒ Object

Returns the value of attribute metadata.



53
54
55
 
# File 'lib/nucleus_api/models/budget.rb', line 53

def metadata
  @metadata
end

#name ⇒ Object

name



56
57
58
 
# File 'lib/nucleus_api/models/budget.rb', line 56

def name
  @name
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



58
59
60
 
# File 'lib/nucleus_api/models/budget.rb', line 58

def secondary_id
  @secondary_id
end

#start_date ⇒ Object

startDate



61
62
63
 
# File 'lib/nucleus_api/models/budget.rb', line 61

def start_date
  @start_date
end

#total_value ⇒ Object

totalValue



64
65
66
 
# File 'lib/nucleus_api/models/budget.rb', line 64

def total_value
  @total_value
end

#update_date ⇒ Object

Returns the value of attribute update_date.



66
67
68
 
# File 'lib/nucleus_api/models/budget.rb', line 66

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/nucleus_api/models/budget.rb', line 69

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'aggregation_accounts' => :'aggregation_accounts',
    :'budget' => :'budget',
    :'card_id' => :'card_id',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'end_date' => :'end_date',
    :'frequency' => :'frequency',
    :'frequency_unit' => :'frequency_unit',
    :'goal_id' => :'goal_id',
    :'id' => :'id',
    :'is_active' => :'is_active',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'secondary_id' => :'secondary_id',
    :'start_date' => :'start_date',
    :'total_value' => :'total_value',
    :'update_date' => :'update_date'
  }
end

.swagger_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
114
115
116
 
# File 'lib/nucleus_api/models/budget.rb', line 94

def self.swagger_types
  {
    :'account_id' => :'String',
    :'aggregation_accounts' => :'Array<BudgetAggregationAccount>',
    :'budget' => :'Array<BudgetObject>',
    :'card_id' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'end_date' => :'Date',
    :'frequency' => :'Integer',
    :'frequency_unit' => :'String',
    :'goal_id' => :'String',
    :'id' => :'String',
    :'is_active' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'name' => :'String',
    :'secondary_id' => :'String',
    :'start_date' => :'Date',
    :'total_value' => :'Float',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/nucleus_api/models/budget.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      aggregation_accounts == o.aggregation_accounts &&
      budget == o.budget &&
      card_id == o.card_id &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      end_date == o.end_date &&
      frequency == o.frequency &&
      frequency_unit == o.frequency_unit &&
      goal_id == o.goal_id &&
      id == o.id &&
      is_active == o.is_active &&
      metadata == o.metadata &&
      name == o.name &&
      secondary_id == o.secondary_id &&
      start_date == o.start_date &&
      total_value == o.total_value &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/nucleus_api/models/budget.rb', line 302

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = NucleusApi.const_get(type).new
    temp_model.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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/nucleus_api/models/budget.rb', line 368

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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/nucleus_api/models/budget.rb', line 283

def build_from_hash(attributes)
  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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/nucleus_api/models/budget.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



276
277
278
 
# File 'lib/nucleus_api/models/budget.rb', line 276

def hash
  [, aggregation_accounts, budget, card_id, client_id, create_date, currency_code, end_date, frequency, frequency_unit, goal_id, id, is_active, metadata, name, secondary_id, start_date, total_value, update_date].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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/nucleus_api/models/budget.rb', line 211

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push('invalid value for "client_id", client_id cannot be nil.')
  end

  if @currency_code.nil?
    invalid_properties.push('invalid value for "currency_code", currency_code cannot be nil.')
  end

  if @frequency_unit.nil?
    invalid_properties.push('invalid value for "frequency_unit", frequency_unit cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  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



349
350
351
 
# File 'lib/nucleus_api/models/budget.rb', line 349

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



355
356
357
358
359
360
361
362
 
# File 'lib/nucleus_api/models/budget.rb', line 355

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    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



343
344
345
 
# File 'lib/nucleus_api/models/budget.rb', line 343

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



234
235
236
237
238
239
240
 
# File 'lib/nucleus_api/models/budget.rb', line 234

def valid?
  return false if @client_id.nil?
  return false if @currency_code.nil?
  return false if @frequency_unit.nil?
  return false if @name.nil?
  true
end