Class: TalonOne::RollbackIncreasedAchievementProgressEffectProps

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb

Overview

The properties specific to the "rollbackIncreasedAchievementProgress" effect. This gets triggered whenever a closed session where the ‘increaseAchievementProgress` effect was triggered is cancelled. This is applicable only when the customer has not completed the achievement.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RollbackIncreasedAchievementProgressEffectProps

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
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
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 68

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

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

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

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

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

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

Instance Attribute Details

#achievement_id ⇒ Object

The internal ID of the achievement.



19
20
21
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 19

def achievement_id
  @achievement_id
end

#achievement_name ⇒ Object

The name of the achievement.



22
23
24
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 22

def achievement_name
  @achievement_name
end

#current_progress ⇒ Object

The current progress of the customer in the achievement.



31
32
33
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 31

def current_progress
  @current_progress
end

#decrease_progress_by ⇒ Object

The value by which the customer’s current progress in the achievement is decreased.



28
29
30
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 28

def decrease_progress_by
  @decrease_progress_by
end

#progress_tracker_id ⇒ Object

The internal ID of the achievement progress tracker.



25
26
27
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 25

def progress_tracker_id
  @progress_tracker_id
end

#target ⇒ Object

The target value to complete the achievement.



34
35
36
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 34

def target
  @target
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 37

def self.attribute_map
  {
    :'achievement_id' => :'achievementId',
    :'achievement_name' => :'achievementName',
    :'progress_tracker_id' => :'progressTrackerId',
    :'decrease_progress_by' => :'decreaseProgressBy',
    :'current_progress' => :'currentProgress',
    :'target' => :'target'
  }
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



177
178
179
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 177

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 61

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 49

def self.openapi_types
  {
    :'achievement_id' => :'Integer',
    :'achievement_name' => :'String',
    :'progress_tracker_id' => :'Integer',
    :'decrease_progress_by' => :'Float',
    :'current_progress' => :'Float',
    :'target' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      achievement_id == o.achievement_id &&
      achievement_name == o.achievement_name &&
      progress_tracker_id == o.progress_tracker_id &&
      decrease_progress_by == o.decrease_progress_by &&
      current_progress == o.current_progress &&
      target == o.target
end

#_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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 205

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    TalonOne.const_get(type).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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 274

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 184

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


164
165
166
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



170
171
172
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 170

def hash
  [achievement_id, achievement_name, progress_tracker_id, decrease_progress_by, current_progress, target].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



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
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if @achievement_id.nil?
    invalid_properties.push('invalid value for "achievement_id", achievement_id cannot be nil.')
  end

  if @achievement_name.nil?
    invalid_properties.push('invalid value for "achievement_name", achievement_name cannot be nil.')
  end

  if @progress_tracker_id.nil?
    invalid_properties.push('invalid value for "progress_tracker_id", progress_tracker_id cannot be nil.')
  end

  if @decrease_progress_by.nil?
    invalid_properties.push('invalid value for "decrease_progress_by", decrease_progress_by cannot be nil.')
  end

  if @current_progress.nil?
    invalid_properties.push('invalid value for "current_progress", current_progress cannot be nil.')
  end

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



250
251
252
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 250

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 256

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



244
245
246
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 244

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



139
140
141
142
143
144
145
146
147
 
# File 'lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb', line 139

def valid?
  return false if @achievement_id.nil?
  return false if @achievement_name.nil?
  return false if @progress_tracker_id.nil?
  return false if @decrease_progress_by.nil?
  return false if @current_progress.nil?
  return false if @target.nil?
  true
end