Class: MxPlatformRuby::MonthlyCashFlowResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MonthlyCashFlowResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 77

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

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

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

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

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

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

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

Instance Attribute Details

#budgeted_expenses ⇒ Object

The amount of the budgeted expenses for the user.



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

def budgeted_expenses
  @budgeted_expenses
end

#budgeted_income ⇒ Object

The amount of the budgeted income for the user.



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

def budgeted_income
  @budgeted_income
end

#estimated_goals_contribution ⇒ Object

The estimated monthly dollar amount allocated for goals calculated from income and budgets.



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

def estimated_goals_contribution
  @estimated_goals_contribution
end

#goals_contribution ⇒ Object

The monthly dollar amount allocated for goals.



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

def goals_contribution
  @goals_contribution
end

#guid ⇒ Object

Unique identifier for the monthly cash flow profile. Defined by MX.



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

def guid
  @guid
end

#user_guid ⇒ Object

Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX.



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

def user_guid
  @user_guid
end

#uses_estimated_goals_contribution ⇒ Object

Returns the value of attribute uses_estimated_goals_contribution.



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

def uses_estimated_goals_contribution
  @uses_estimated_goals_contribution
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 187

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 39

def self.attribute_map
  {
    :'guid' => :'guid',
    :'user_guid' => :'user_guid',
    :'budgeted_income' => :'budgeted_income',
    :'budgeted_expenses' => :'budgeted_expenses',
    :'goals_contribution' => :'goals_contribution',
    :'estimated_goals_contribution' => :'estimated_goals_contribution',
    :'uses_estimated_goals_contribution' => :'uses_estimated_goals_contribution'
  }
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 163

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



70
71
72
73
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 57

def self.openapi_types
  {
    :'guid' => :'String',
    :'user_guid' => :'String',
    :'budgeted_income' => :'Float',
    :'budgeted_expenses' => :'Float',
    :'goals_contribution' => :'Float',
    :'estimated_goals_contribution' => :'Integer',
    :'uses_estimated_goals_contribution' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      user_guid == o.user_guid &&
      budgeted_income == o.budgeted_income &&
      budgeted_expenses == o.budgeted_expenses &&
      goals_contribution == o.goals_contribution &&
      estimated_goals_contribution == o.estimated_goals_contribution &&
      uses_estimated_goals_contribution == o.uses_estimated_goals_contribution
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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 258

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


150
151
152
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 156

def hash
  [guid, user_guid, budgeted_income, budgeted_expenses, goals_contribution, estimated_goals_contribution, uses_estimated_goals_contribution].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



121
122
123
124
125
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 121

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



234
235
236
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 234

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 240

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



228
229
230
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 228

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



129
130
131
132
 
# File 'lib/mx-platform-ruby/models/monthly_cash_flow_response.rb', line 129

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