Class: ProtonApi::BudgetDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/budget_details.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BudgetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
 
# File 'lib/proton_api/models/budget_details.rb', line 93

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



29
30
31
 
# File 'lib/proton_api/models/budget_details.rb', line 29

def 
  @account_id
end

#aggregation_accounts ⇒ Object

Returns the value of attribute aggregation_accounts.



33
34
35
 
# File 'lib/proton_api/models/budget_details.rb', line 33

def aggregation_accounts
  @aggregation_accounts
end

#budget ⇒ Object

Returns the value of attribute budget.



27
28
29
 
# File 'lib/proton_api/models/budget_details.rb', line 27

def budget
  @budget
end

#client_id ⇒ Object

Returns the value of attribute client_id.



19
20
21
 
# File 'lib/proton_api/models/budget_details.rb', line 19

def client_id
  @client_id
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



17
18
19
 
# File 'lib/proton_api/models/budget_details.rb', line 17

def currency_code
  @currency_code
end

#end_date ⇒ Object

Returns the value of attribute end_date.



23
24
25
 
# File 'lib/proton_api/models/budget_details.rb', line 23

def end_date
  @end_date
end

#frequency ⇒ Object

Returns the value of attribute frequency.



21
22
23
 
# File 'lib/proton_api/models/budget_details.rb', line 21

def frequency
  @frequency
end

#frequency_unit ⇒ Object

Returns the value of attribute frequency_unit.



35
36
37
 
# File 'lib/proton_api/models/budget_details.rb', line 35

def frequency_unit
  @frequency_unit
end

#start_date ⇒ Object

Returns the value of attribute start_date.



31
32
33
 
# File 'lib/proton_api/models/budget_details.rb', line 31

def start_date
  @start_date
end

#total_value ⇒ Object

Returns the value of attribute total_value.



25
26
27
 
# File 'lib/proton_api/models/budget_details.rb', line 25

def total_value
  @total_value
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/proton_api/models/budget_details.rb', line 60

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'frequency' => :'frequency',
    :'end_date' => :'end_date',
    :'total_value' => :'total_value',
    :'budget' => :'budget',
    :'account_id' => :'account_id',
    :'start_date' => :'start_date',
    :'aggregation_accounts' => :'aggregation_accounts',
    :'frequency_unit' => :'frequency_unit'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/proton_api/models/budget_details.rb', line 76

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'frequency' => :'Integer',
    :'end_date' => :'Date',
    :'total_value' => :'Float',
    :'budget' => :'Array<BudgetComponent>',
    :'account_id' => :'String',
    :'start_date' => :'Date',
    :'aggregation_accounts' => :'Array<BudgetAggregationAccount>',
    :'frequency_unit' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/proton_api/models/budget_details.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      frequency == o.frequency &&
      end_date == o.end_date &&
      total_value == o.total_value &&
      budget == o.budget &&
       == o. &&
      start_date == o.start_date &&
      aggregation_accounts == o.aggregation_accounts &&
      frequency_unit == o.frequency_unit
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/proton_api/models/budget_details.rb', line 258

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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/proton_api/models/budget_details.rb', line 322

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/proton_api/models/budget_details.rb', line 238

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


225
226
227
 
# File 'lib/proton_api/models/budget_details.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/proton_api/models/budget_details.rb', line 231

def hash
  [currency_code, client_id, frequency, end_date, total_value, budget, , start_date, aggregation_accounts, frequency_unit].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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/proton_api/models/budget_details.rb', line 148

def list_invalid_properties
  invalid_properties = Array.new
  if !@frequency.nil? && @frequency < 1
    invalid_properties.push('invalid value for "frequency", must be greater than or equal to 1.')
  end

  if !@total_value.nil? && @total_value < 0
    invalid_properties.push('invalid value for "total_value", must be greater than or equal to 0.')
  end

  if @frequency_unit.nil?
    invalid_properties.push('invalid value for "frequency_unit", frequency_unit 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



303
304
305
 
# File 'lib/proton_api/models/budget_details.rb', line 303

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/proton_api/models/budget_details.rb', line 309

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



297
298
299
 
# File 'lib/proton_api/models/budget_details.rb', line 297

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



167
168
169
170
171
172
173
174
 
# File 'lib/proton_api/models/budget_details.rb', line 167

def valid?
  return false if !@frequency.nil? && @frequency < 1
  return false if !@total_value.nil? && @total_value < 0
  return false if @frequency_unit.nil?
  frequency_unit_validator = EnumAttributeValidator.new('String', ['daily', 'weekly', 'bi-weekly', 'monthly', 'quarterly', 'annually'])
  return false unless frequency_unit_validator.valid?(@frequency_unit)
  true
end