Class: ProtonApi::BudgetCalculatorRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BudgetCalculatorRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 97

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

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

  if attributes.has_key?(:'relative_lookback')
    self.relative_lookback = attributes[:'relative_lookback']
  else
    self.relative_lookback = true
  end

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

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

  if attributes.has_key?(:'show_average_spend')
    self.show_average_spend = attributes[:'show_average_spend']
  else
    self.show_average_spend = false
  end

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

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

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

  if attributes.has_key?(:'only_cleansed')
    self.only_cleansed = attributes[:'only_cleansed']
  else
    self.only_cleansed = false
  end

  if attributes.has_key?(:'show_budget_track')
    self.show_budget_track = attributes[:'show_budget_track']
  else
    self.show_budget_track = true
  end
end

Instance Attribute Details

#as_of_date ⇒ Object

Returns the value of attribute as_of_date.



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

def as_of_date
  @as_of_date
end

#budget_details ⇒ Object

Returns the value of attribute budget_details.



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

def budget_details
  @budget_details
end

#budget_id ⇒ Object

Returns the value of attribute budget_id.



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

def budget_id
  @budget_id
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



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

def currency_conversion
  @currency_conversion
end

#lookback_periods ⇒ Object

Returns the value of attribute lookback_periods.



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

def lookback_periods
  @lookback_periods
end

#only_cleansed ⇒ Object

Returns the value of attribute only_cleansed.



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

def only_cleansed
  @only_cleansed
end

#relative_lookback ⇒ Object

Returns the value of attribute relative_lookback.



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

def relative_lookback
  @relative_lookback
end

#scope ⇒ Object

Returns the value of attribute scope.



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

def scope
  @scope
end

#show_average_spend ⇒ Object

Returns the value of attribute show_average_spend.



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

def show_average_spend
  @show_average_spend
end

#show_budget_track ⇒ Object

Returns the value of attribute show_budget_track.



37
38
39
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 37

def show_budget_track
  @show_budget_track
end

#transaction_status_scope ⇒ Object

Returns the value of attribute transaction_status_scope.



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

def transaction_status_scope
  @transaction_status_scope
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 62

def self.attribute_map
  {
    :'scope' => :'scope',
    :'currency_conversion' => :'currency_conversion',
    :'relative_lookback' => :'relative_lookback',
    :'budget_id' => :'budget_id',
    :'as_of_date' => :'as_of_date',
    :'show_average_spend' => :'show_average_spend',
    :'lookback_periods' => :'lookback_periods',
    :'budget_details' => :'budget_details',
    :'transaction_status_scope' => :'transaction_status_scope',
    :'only_cleansed' => :'only_cleansed',
    :'show_budget_track' => :'show_budget_track'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 79

def self.swagger_types
  {
    :'scope' => :'String',
    :'currency_conversion' => :'String',
    :'relative_lookback' => :'BOOLEAN',
    :'budget_id' => :'String',
    :'as_of_date' => :'Date',
    :'show_average_spend' => :'BOOLEAN',
    :'lookback_periods' => :'Integer',
    :'budget_details' => :'BudgetDetails',
    :'transaction_status_scope' => :'Array<String>',
    :'only_cleansed' => :'BOOLEAN',
    :'show_budget_track' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      scope == o.scope &&
      currency_conversion == o.currency_conversion &&
      relative_lookback == o.relative_lookback &&
      budget_id == o.budget_id &&
      as_of_date == o.as_of_date &&
      show_average_spend == o.show_average_spend &&
      lookback_periods == o.lookback_periods &&
      budget_details == o.budget_details &&
      transaction_status_scope == o.transaction_status_scope &&
      only_cleansed == o.only_cleansed &&
      show_budget_track == o.show_budget_track
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



255
256
257
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
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 255

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 319

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 235

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


222
223
224
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 228

def hash
  [scope, currency_conversion, relative_lookback, budget_id, as_of_date, show_average_spend, lookback_periods, budget_details, transaction_status_scope, only_cleansed, show_budget_track].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



164
165
166
167
168
169
170
171
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 164

def list_invalid_properties
  invalid_properties = Array.new
  if !@lookback_periods.nil? && @lookback_periods < 1
    invalid_properties.push('invalid value for "lookback_periods", must be greater than or equal to 1.')
  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



300
301
302
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 306

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



294
295
296
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 294

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



175
176
177
178
179
180
 
# File 'lib/proton_api/models/budget_calculator_request.rb', line 175

def valid?
  scope_validator = EnumAttributeValidator.new('String', ['all', 'external', 'internal'])
  return false unless scope_validator.valid?(@scope)
  return false if !@lookback_periods.nil? && @lookback_periods < 1
  true
end