Class: MxPlatformRuby::GoalResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GoalResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_guid ⇒ Object

Unique identifier of the account for the goal.



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

def 
  @account_guid
end

#amount ⇒ Object

Amount of the goal.



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

def amount
  @amount
end

#completed_at ⇒ Object

Date and time the goal was completed.



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

def completed_at
  @completed_at
end

#current_amount ⇒ Object

The current amount of the goal.



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

def current_amount
  @current_amount
end

#goal_type_name ⇒ Object

The goal type.



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

def goal_type_name
  @goal_type_name
end

#guid ⇒ Object

Unique identifier for the goal. Defined by MX.



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

def guid
  @guid
end

#has_been_spent ⇒ Object

Determines if the goal has been spent.



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

def has_been_spent
  @has_been_spent
end

#is_complete ⇒ Object

Determines if the goal is complete.



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

def is_complete
  @is_complete
end

#meta_type_name ⇒ Object

The category of the goal.



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

def meta_type_name
  @meta_type_name
end

#metadata ⇒ Object

Additional information a partner can store on the goal.



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

def metadata
  @metadata
end

#name ⇒ Object

The name of the goal.



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

def name
  @name
end

#position ⇒ Object

The priority of the goal in relation to multiple goals.



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

def position
  @position
end

#projected_to_complete_at ⇒ Object

Date and time the goal is projected to be completed.



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

def projected_to_complete_at
  @projected_to_complete_at
end

#targeted_to_complete_at ⇒ Object

Date and time the goal is to complete. Intended for users to set their own goal completion dates.



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

def targeted_to_complete_at
  @targeted_to_complete_at
end

#track_type_name ⇒ Object

Returns the value of attribute track_type_name.



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

def track_type_name
  @track_type_name
end

#user_guid ⇒ Object

The unique identifier for the the user. Defined by MX.



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

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



277
278
279
280
281
282
283
284
285
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
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 277

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'account_guid' => :'account_guid',
    :'amount' => :'amount',
    :'completed_at' => :'completed_at',
    :'current_amount' => :'current_amount',
    :'goal_type_name' => :'goal_type_name',
    :'guid' => :'guid',
    :'has_been_spent' => :'has_been_spent',
    :'is_complete' => :'is_complete',
    :'metadata' => :'metadata',
    :'meta_type_name' => :'meta_type_name',
    :'name' => :'name',
    :'position' => :'position',
    :'projected_to_complete_at' => :'projected_to_complete_at',
    :'targeted_to_complete_at' => :'targeted_to_complete_at',
    :'track_type_name' => :'track_type_name',
    :'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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 253

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



115
116
117
118
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'account_guid' => :'String',
    :'amount' => :'Float',
    :'completed_at' => :'String',
    :'current_amount' => :'Float',
    :'goal_type_name' => :'String',
    :'guid' => :'String',
    :'has_been_spent' => :'Boolean',
    :'is_complete' => :'Boolean',
    :'metadata' => :'String',
    :'meta_type_name' => :'String',
    :'name' => :'String',
    :'position' => :'Integer',
    :'projected_to_complete_at' => :'String',
    :'targeted_to_complete_at' => :'String',
    :'track_type_name' => :'String',
    :'user_guid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      completed_at == o.completed_at &&
      current_amount == o.current_amount &&
      goal_type_name == o.goal_type_name &&
      guid == o.guid &&
      has_been_spent == o.has_been_spent &&
      is_complete == o.is_complete &&
      metadata == o.metadata &&
      meta_type_name == o.meta_type_name &&
      name == o.name &&
      position == o.position &&
      projected_to_complete_at == o.projected_to_complete_at &&
      targeted_to_complete_at == o.targeted_to_complete_at &&
      track_type_name == o.track_type_name &&
      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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 348

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


240
241
242
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 246

def hash
  [, amount, completed_at, current_amount, goal_type_name, guid, has_been_spent, is_complete, metadata, meta_type_name, name, position, projected_to_complete_at, targeted_to_complete_at, track_type_name, 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



202
203
204
205
206
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 202

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



324
325
326
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 324

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 330

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



318
319
320
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 318

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



210
211
212
213
 
# File 'lib/mx-platform-ruby/models/goal_response.rb', line 210

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