Class: TalonOne::LoyaltyProgram

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltyProgram

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
183
184
185
186
187
188
189
190
191
 
# File 'lib/talon_one/models/loyalty_program.rb', line 113

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

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

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

#account_id ⇒ Object

The ID of the Talon.One account that owns this program.



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

def 
  @account_id
end

#allow_subledger ⇒ Object

Indicates if this program supports subledgers inside the program.



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

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.



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

def card_based
  @card_based
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
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.



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

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.



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

def default_validity
  @default_validity
end

#description ⇒ Object

Description of our Loyalty Program.



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

def description
  @description
end

#id ⇒ Object

The ID of loyalty program. Internal ID of this entity.



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

def id
  @id
end

#name ⇒ Object

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



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

def name
  @name
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.



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

def sandbox
  @sandbox
end

#subscribed_applications ⇒ Object

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



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

def subscribed_applications
  @subscribed_applications
end

#tiers ⇒ Object

The tiers in this loyalty program.



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

def tiers
  @tiers
end

#timezone ⇒ Object

A string containing an IANA timezone descriptor.



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

def timezone
  @timezone
end

#title ⇒ Object

The display title for the Loyalty Program.



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

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`.



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

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.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/talon_one/models/loyalty_program.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'title' => :'title',
    :'description' => :'description',
    :'subscribed_applications' => :'subscribedApplications',
    :'default_validity' => :'defaultValidity',
    :'default_pending' => :'defaultPending',
    :'allow_subledger' => :'allowSubledger',
    :'users_per_card_limit' => :'usersPerCardLimit',
    :'sandbox' => :'sandbox',
    :'account_id' => :'accountID',
    :'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



342
343
344
 
# File 'lib/talon_one/models/loyalty_program.rb', line 342

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/talon_one/models/loyalty_program.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'title' => :'String',
    :'description' => :'String',
    :'subscribed_applications' => :'Array<Integer>',
    :'default_validity' => :'String',
    :'default_pending' => :'String',
    :'allow_subledger' => :'Boolean',
    :'users_per_card_limit' => :'Integer',
    :'sandbox' => :'Boolean',
    :'account_id' => :'Integer',
    :'name' => :'String',
    :'tiers' => :'Array<LoyaltyTier>',
    :'timezone' => :'String',
    :'card_based' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/talon_one/models/loyalty_program.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      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 &&
       == o. &&
      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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/talon_one/models/loyalty_program.rb', line 370

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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/talon_one/models/loyalty_program.rb', line 439

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/talon_one/models/loyalty_program.rb', line 349

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


329
330
331
 
# File 'lib/talon_one/models/loyalty_program.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/talon_one/models/loyalty_program.rb', line 335

def hash
  [id, created, title, description, subscribed_applications, default_validity, default_pending, allow_subledger, users_per_card_limit, sandbox, , 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



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
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/talon_one/models/loyalty_program.rb', line 195

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

  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  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 @subscribed_applications.nil?
    invalid_properties.push('invalid value for "subscribed_applications", subscribed_applications 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 @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id 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



415
416
417
 
# File 'lib/talon_one/models/loyalty_program.rb', line 415

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/talon_one/models/loyalty_program.rb', line 421

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



409
410
411
 
# File 'lib/talon_one/models/loyalty_program.rb', line 409

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/talon_one/models/loyalty_program.rb', line 262

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @title.nil?
  return false if @description.nil?
  return false if @subscribed_applications.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?
  return false if @account_id.nil?
  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