Class: NucleusApi::Goal

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Goal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/nucleus_api/models/goal.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accumulation_horizon ⇒ Object

Returns the value of attribute accumulation_horizon.



17
18
19
 
# File 'lib/nucleus_api/models/goal.rb', line 17

def accumulation_horizon
  @accumulation_horizon
end

#category ⇒ Object

category



20
21
22
 
# File 'lib/nucleus_api/models/goal.rb', line 20

def category
  @category
end

#client_id ⇒ Object

Returns the value of attribute client_id.



22
23
24
 
# File 'lib/nucleus_api/models/goal.rb', line 22

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



24
25
26
 
# File 'lib/nucleus_api/models/goal.rb', line 24

def create_date
  @create_date
end

#decumulation_horizon ⇒ Object

Returns the value of attribute decumulation_horizon.



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

def decumulation_horizon
  @decumulation_horizon
end

#goal_amount ⇒ Object

Returns the value of attribute goal_amount.



28
29
30
 
# File 'lib/nucleus_api/models/goal.rb', line 28

def goal_amount
  @goal_amount
end

#id ⇒ Object

Returns the value of attribute id.



30
31
32
 
# File 'lib/nucleus_api/models/goal.rb', line 30

def id
  @id
end

#image ⇒ Object

image



33
34
35
 
# File 'lib/nucleus_api/models/goal.rb', line 33

def image
  @image
end

#is_active ⇒ Object

isActive



36
37
38
 
# File 'lib/nucleus_api/models/goal.rb', line 36

def is_active
  @is_active
end

#is_decumulation ⇒ Object

isDecumulation



39
40
41
 
# File 'lib/nucleus_api/models/goal.rb', line 39

def is_decumulation
  @is_decumulation
end

#metadata ⇒ Object

Returns the value of attribute metadata.



41
42
43
 
# File 'lib/nucleus_api/models/goal.rb', line 41

def metadata
  @metadata
end

#name ⇒ Object

Goal name



44
45
46
 
# File 'lib/nucleus_api/models/goal.rb', line 44

def name
  @name
end

#parent_goal_id ⇒ Object

Goal Parent Goal Id



47
48
49
 
# File 'lib/nucleus_api/models/goal.rb', line 47

def parent_goal_id
  @parent_goal_id
end

#questionnaire_id ⇒ Object

questionnaire_id



50
51
52
 
# File 'lib/nucleus_api/models/goal.rb', line 50

def questionnaire_id
  @questionnaire_id
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



52
53
54
 
# File 'lib/nucleus_api/models/goal.rb', line 52

def secondary_id
  @secondary_id
end

#type ⇒ Object

type



55
56
57
 
# File 'lib/nucleus_api/models/goal.rb', line 55

def type
  @type
end

#update_date ⇒ Object

Returns the value of attribute update_date.



57
58
59
 
# File 'lib/nucleus_api/models/goal.rb', line 57

def update_date
  @update_date
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
74
75
76
77
78
79
80
 
# File 'lib/nucleus_api/models/goal.rb', line 60

def self.attribute_map
  {
    :'accumulation_horizon' => :'accumulation_horizon',
    :'category' => :'category',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'decumulation_horizon' => :'decumulation_horizon',
    :'goal_amount' => :'goal_amount',
    :'id' => :'id',
    :'image' => :'image',
    :'is_active' => :'is_active',
    :'is_decumulation' => :'is_decumulation',
    :'metadata' => :'metadata',
    :'name' => :'name',
    :'parent_goal_id' => :'parent_goal_id',
    :'questionnaire_id' => :'questionnaire_id',
    :'secondary_id' => :'secondary_id',
    :'type' => :'type',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/nucleus_api/models/goal.rb', line 83

def self.swagger_types
  {
    :'accumulation_horizon' => :'Float',
    :'category' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'decumulation_horizon' => :'Float',
    :'goal_amount' => :'Float',
    :'id' => :'String',
    :'image' => :'String',
    :'is_active' => :'BOOLEAN',
    :'is_decumulation' => :'BOOLEAN',
    :'metadata' => :'Hash<String, String>',
    :'name' => :'String',
    :'parent_goal_id' => :'String',
    :'questionnaire_id' => :'String',
    :'secondary_id' => :'String',
    :'type' => :'String',
    :'update_date' => :'DateTime'
  }
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
219
220
221
222
223
224
 
# File 'lib/nucleus_api/models/goal.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accumulation_horizon == o.accumulation_horizon &&
      category == o.category &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      decumulation_horizon == o.decumulation_horizon &&
      goal_amount == o.goal_amount &&
      id == o.id &&
      image == o.image &&
      is_active == o.is_active &&
      is_decumulation == o.is_decumulation &&
      metadata == o.metadata &&
      name == o.name &&
      parent_goal_id == o.parent_goal_id &&
      questionnaire_id == o.questionnaire_id &&
      secondary_id == o.secondary_id &&
      type == o.type &&
      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



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
295
296
 
# File 'lib/nucleus_api/models/goal.rb', line 260

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/nucleus_api/models/goal.rb', line 326

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/nucleus_api/models/goal.rb', line 241

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


228
229
230
 
# File 'lib/nucleus_api/models/goal.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/nucleus_api/models/goal.rb', line 234

def hash
  [accumulation_horizon, category, client_id, create_date, decumulation_horizon, goal_amount, id, image, is_active, is_decumulation, metadata, name, parent_goal_id, questionnaire_id, secondary_id, type, 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



186
187
188
189
190
191
192
193
 
# File 'lib/nucleus_api/models/goal.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  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



307
308
309
 
# File 'lib/nucleus_api/models/goal.rb', line 307

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



313
314
315
316
317
318
319
320
 
# File 'lib/nucleus_api/models/goal.rb', line 313

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



301
302
303
 
# File 'lib/nucleus_api/models/goal.rb', line 301

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



197
198
199
200
 
# File 'lib/nucleus_api/models/goal.rb', line 197

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