Class: TalonOne::AchievementProgressWithDefinition

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

Overview

The current progress of the customer in the achievement.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AchievementProgressWithDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
199
200
201
202
203
204
205
206
207
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#achievement_activation_policy ⇒ Object

The policy that determines how the achievement starts, ends, or resets. - ‘user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule.



55
56
57
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 55

def achievement_activation_policy
  @achievement_activation_policy
end

#achievement_end_date ⇒ Object

The achievement’s end date. If defined, customers cannot participate in the achievement after this date. Note: It is an RFC3339 timestamp string.



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

def achievement_end_date
  @achievement_end_date
end

#achievement_fixed_start_date ⇒ Object

The achievement’s start date when ‘achievementActivationPolicy` is equal to `fixed_schedule`. Note: It is an RFC3339 timestamp string.



58
59
60
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 58

def achievement_fixed_start_date
  @achievement_fixed_start_date
end

#achievement_id ⇒ Object

The internal ID of the achievement.



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

def achievement_id
  @achievement_id
end

#achievement_recurrence_policy ⇒ Object

The policy that determines if and how the achievement recurs. - ‘no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again.



52
53
54
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 52

def achievement_recurrence_policy
  @achievement_recurrence_policy
end

#campaign_id ⇒ Object

The ID of the campaign the achievement belongs to.



46
47
48
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 46

def campaign_id
  @campaign_id
end

#completion_date ⇒ Object

Timestamp at which point the customer completed the achievement.



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

def completion_date
  @completion_date
end

#description ⇒ Object

The description of the achievement in the Campaign Manager.



43
44
45
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 43

def description
  @description
end

#end_date ⇒ Object

Timestamp at which point the achievement ends and resets for the customer.



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

def end_date
  @end_date
end

#name ⇒ Object

The internal name of the achievement used in API requests.



37
38
39
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 37

def name
  @name
end

#progress ⇒ Object

The current progress of the customer in the achievement.



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

def progress
  @progress
end

#start_date ⇒ Object

Timestamp at which the customer started the achievement.



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

def start_date
  @start_date
end

#status ⇒ Object

The status of the achievement.



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

def status
  @status
end

#target ⇒ Object

The required number of actions or the transactional milestone to complete the achievement.



49
50
51
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 49

def target
  @target
end

#title ⇒ Object

The display name of the achievement in the Campaign Manager.



40
41
42
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 40

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 86

def self.attribute_map
  {
    :'status' => :'status',
    :'progress' => :'progress',
    :'start_date' => :'startDate',
    :'completion_date' => :'completionDate',
    :'end_date' => :'endDate',
    :'achievement_id' => :'achievementId',
    :'name' => :'name',
    :'title' => :'title',
    :'description' => :'description',
    :'campaign_id' => :'campaignId',
    :'target' => :'target',
    :'achievement_recurrence_policy' => :'achievementRecurrencePolicy',
    :'achievement_activation_policy' => :'achievementActivationPolicy',
    :'achievement_fixed_start_date' => :'achievementFixedStartDate',
    :'achievement_end_date' => :'achievementEndDate'
  }
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



379
380
381
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 379

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 107

def self.openapi_types
  {
    :'status' => :'String',
    :'progress' => :'Float',
    :'start_date' => :'DateTime',
    :'completion_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'achievement_id' => :'Integer',
    :'name' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'campaign_id' => :'Integer',
    :'target' => :'Float',
    :'achievement_recurrence_policy' => :'String',
    :'achievement_activation_policy' => :'String',
    :'achievement_fixed_start_date' => :'DateTime',
    :'achievement_end_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 344

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      progress == o.progress &&
      start_date == o.start_date &&
      completion_date == o.completion_date &&
      end_date == o.end_date &&
      achievement_id == o.achievement_id &&
      name == o.name &&
      title == o.title &&
      description == o.description &&
      campaign_id == o.campaign_id &&
      target == o.target &&
      achievement_recurrence_policy == o.achievement_recurrence_policy &&
      achievement_activation_policy == o.achievement_activation_policy &&
      achievement_fixed_start_date == o.achievement_fixed_start_date &&
      achievement_end_date == o.achievement_end_date
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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 407

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



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 476

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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 386

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


366
367
368
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 366

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



372
373
374
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 372

def hash
  [status, progress, start_date, completion_date, end_date, achievement_id, name, title, description, campaign_id, target, achievement_recurrence_policy, achievement_activation_policy, achievement_fixed_start_date, achievement_end_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



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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 211

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

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

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

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

  if @name.to_s.length > 1000
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 1000.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^[a-zA-Z]\w+$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

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

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

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



452
453
454
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 452

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 458

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



446
447
448
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 446

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/talon_one/models/achievement_progress_with_definition.rb', line 267

def valid?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["inprogress", "completed", "expired", "not_started"])
  return false unless status_validator.valid?(@status)
  return false if @progress.nil?
  return false if @achievement_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 1000
  return false if @name.to_s.length < 1
  return false if @name !~ Regexp.new(/^[a-zA-Z]\w+$/)
  return false if @title.nil?
  return false if @description.nil?
  return false if @campaign_id.nil?
  return false if @achievement_recurrence_policy.nil?
  achievement_recurrence_policy_validator = EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
  return false unless achievement_recurrence_policy_validator.valid?(@achievement_recurrence_policy)
  return false if @achievement_activation_policy.nil?
  achievement_activation_policy_validator = EnumAttributeValidator.new('String', ["user_action", "fixed_schedule"])
  return false unless achievement_activation_policy_validator.valid?(@achievement_activation_policy)
  true
end