Class: TalonOne::NewLoyaltyProgram

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

Overview

A new loyalty program

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewLoyaltyProgram

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
241
242
243
244
245
246
247
248
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 154

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

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

  if attributes.key?(:'subscribed_applications')
    if (value = attributes[:'subscribed_applications']).is_a?(Array)
      self.subscribed_applications = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'tiers')
    if (value = attributes[:'tiers']).is_a?(Array)
      self.tiers = value
    end
  end

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

  if attributes.key?(:'card_based')
    self.card_based = attributes[:'card_based']
  else
    self.card_based = false
  end
end

Instance Attribute Details

#allow_subledger ⇒ Object

Indicates if this program supports subledgers inside the program.



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

def allow_subledger
  @allow_subledger
end

#card_based ⇒ Object

Defines the type of loyalty program: - ‘true`: the program is a card-based. - `false`: the program is profile-based.



72
73
74
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 72

def card_based
  @card_based
end

#card_code_settings ⇒ Object

Returns the value of attribute card_code_settings.



57
58
59
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 57

def card_code_settings
  @card_code_settings
end

#default_pending ⇒ Object

The default duration of the pending time after which points should be valid. Can be ‘immediate’ or a specific time. The time format is a number followed by one letter indicating the time unit, like ‘30s’, ‘40m’, ‘1h’, ‘5D’, ‘7W’, or 10M’. These rounding suffixes are also supported: - ‘_D’ for rounding down. Can be used as a suffix after ‘D’, and signifies the start of the day. - ‘_U’ for rounding up. Can be used as a suffix after ‘D’, ‘W’, and ‘M’, and signifies the end of the day, week, and month.



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

def default_pending
  @default_pending
end

#default_validity ⇒ Object

The default duration after which new loyalty points should expire. Can be ‘unlimited’ or a specific time. The time format is a number followed by one letter indicating the time unit, like ‘30s’, ‘40m’, ‘1h’, ‘5D’, ‘7W’, or 10M’. These rounding suffixes are also supported: - ‘_D’ for rounding down. Can be used as a suffix after ‘D’, and signifies the start of the day. - ‘_U’ for rounding up. Can be used as a suffix after ‘D’, ‘W’, and ‘M’, and signifies the end of the day, week, and month.



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

def default_validity
  @default_validity
end

#description ⇒ Object

Description of our Loyalty Program.



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

def description
  @description
end

#name ⇒ Object

The internal name for the Loyalty Program. This is an immutable value.



63
64
65
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 63

def name
  @name
end

#program_join_policy ⇒ Object

The policy that defines when the customer joins the loyalty program. - ‘not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. Note: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.



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

def program_join_policy
  @program_join_policy
end

#return_policy ⇒ Object

The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](docs.talon.one/docs/dev/concepts/entities/customer-sessions). - ‘only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren’t enough pending points. The active balance of the customer cannot be negative. - ‘unlimited`: Allows negative balance without any limit.



60
61
62
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 60

def return_policy
  @return_policy
end

#sandbox ⇒ Object

Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type.



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

def sandbox
  @sandbox
end

#subscribed_applications ⇒ Object

A list containing the IDs of all applications that are subscribed to this Loyalty Program.



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

def subscribed_applications
  @subscribed_applications
end

#tier_cycle_start_date ⇒ Object

Timestamp at which the tier cycle starts for all customers in the loyalty program. Note: This is only required when the tier expiration policy is set to ‘absolute_expiration`.



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

def tier_cycle_start_date
  @tier_cycle_start_date
end

#tiers ⇒ Object

The tiers in this loyalty program.



66
67
68
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 66

def tiers
  @tiers
end

#tiers_downgrade_policy ⇒ Object

The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - ‘one_down`: If the customer doesn’t have enough points to stay in the current tier, they are downgraded by one tier. - ‘balance_based`: The customer’s tier is reevaluated based on the amount of active points they have at the moment.



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

def tiers_downgrade_policy
  @tiers_downgrade_policy
end

#tiers_expiration_policy ⇒ Object

The policy that defines how tier expiration, used to reevaluate the customer’s current tier, is determined. - ‘tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.



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

def tiers_expiration_policy
  @tiers_expiration_policy
end

#tiers_expire_in ⇒ Object

The amount of time after which the tier expires and is reevaluated. The time format is an integer followed by one letter indicating the time unit. Examples: ‘30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.



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

def tiers_expire_in
  @tiers_expire_in
end

#timezone ⇒ Object

A string containing an IANA timezone descriptor.



69
70
71
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 69

def timezone
  @timezone
end

#title ⇒ Object

The display title for the Loyalty Program.



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

def title
  @title
end

#users_per_card_limit ⇒ Object

The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when ‘cardBased` is `true`.



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

def users_per_card_limit
  @users_per_card_limit
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 97

def self.attribute_map
  {
    :'title' => :'title',
    :'description' => :'description',
    :'subscribed_applications' => :'subscribedApplications',
    :'default_validity' => :'defaultValidity',
    :'default_pending' => :'defaultPending',
    :'allow_subledger' => :'allowSubledger',
    :'users_per_card_limit' => :'usersPerCardLimit',
    :'sandbox' => :'sandbox',
    :'program_join_policy' => :'programJoinPolicy',
    :'tiers_expiration_policy' => :'tiersExpirationPolicy',
    :'tier_cycle_start_date' => :'tierCycleStartDate',
    :'tiers_expire_in' => :'tiersExpireIn',
    :'tiers_downgrade_policy' => :'tiersDowngradePolicy',
    :'card_code_settings' => :'cardCodeSettings',
    :'return_policy' => :'returnPolicy',
    :'name' => :'name',
    :'tiers' => :'tiers',
    :'timezone' => :'timezone',
    :'card_based' => :'cardBased'
  }
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



426
427
428
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 426

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 147

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

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 122

def self.openapi_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'subscribed_applications' => :'Array<Integer>',
    :'default_validity' => :'String',
    :'default_pending' => :'String',
    :'allow_subledger' => :'Boolean',
    :'users_per_card_limit' => :'Integer',
    :'sandbox' => :'Boolean',
    :'program_join_policy' => :'String',
    :'tiers_expiration_policy' => :'String',
    :'tier_cycle_start_date' => :'DateTime',
    :'tiers_expire_in' => :'String',
    :'tiers_downgrade_policy' => :'String',
    :'card_code_settings' => :'CodeGeneratorSettings',
    :'return_policy' => :'String',
    :'name' => :'String',
    :'tiers' => :'Array<NewLoyaltyTier>',
    :'timezone' => :'String',
    :'card_based' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 387

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      subscribed_applications == o.subscribed_applications &&
      default_validity == o.default_validity &&
      default_pending == o.default_pending &&
      allow_subledger == o.allow_subledger &&
      users_per_card_limit == o.users_per_card_limit &&
      sandbox == o.sandbox &&
      program_join_policy == o.program_join_policy &&
      tiers_expiration_policy == o.tiers_expiration_policy &&
      tier_cycle_start_date == o.tier_cycle_start_date &&
      tiers_expire_in == o.tiers_expire_in &&
      tiers_downgrade_policy == o.tiers_downgrade_policy &&
      card_code_settings == o.card_code_settings &&
      return_policy == o.return_policy &&
      name == o.name &&
      tiers == o.tiers &&
      timezone == o.timezone &&
      card_based == o.card_based
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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 454

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



523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 523

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 433

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


413
414
415
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 413

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



419
420
421
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 419

def hash
  [title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, program_join_policy, tiers_expiration_policy, tier_cycle_start_date, tiers_expire_in, tiers_downgrade_policy, card_code_settings, return_policy, name, tiers, timezone, card_based].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



252
253
254
255
256
257
258
259
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
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 252

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

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

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

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

  if !@users_per_card_limit.nil? && @users_per_card_limit < 0
    invalid_properties.push('invalid value for "users_per_card_limit", must be greater than or equal to 0.')
  end

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

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

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

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

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



499
500
501
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 499

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



505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 505

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



493
494
495
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 493

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/talon_one/models/new_loyalty_program.rb', line 299

def valid?
  return false if @title.nil?
  return false if @default_validity.nil?
  return false if @default_pending.nil?
  return false if @allow_subledger.nil?
  return false if !@users_per_card_limit.nil? && @users_per_card_limit < 0
  return false if @sandbox.nil?
  program_join_policy_validator = EnumAttributeValidator.new('String', ["not_join", "points_activated", "points_earned"])
  return false unless program_join_policy_validator.valid?(@program_join_policy)
  tiers_expiration_policy_validator = EnumAttributeValidator.new('String', ["tier_start_date", "program_join_date", "customer_attribute", "absolute_expiration"])
  return false unless tiers_expiration_policy_validator.valid?(@tiers_expiration_policy)
  tiers_downgrade_policy_validator = EnumAttributeValidator.new('String', ["one_down", "balance_based"])
  return false unless tiers_downgrade_policy_validator.valid?(@tiers_downgrade_policy)
  return_policy_validator = EnumAttributeValidator.new('String', ["only_pending", "within_balance", "unlimited"])
  return false unless return_policy_validator.valid?(@return_policy)
  return false if @name.nil?
  return false if @timezone.nil?
  return false if @timezone.to_s.length < 1
  return false if @card_based.nil?
  true
end