Class: TalonOne::LoyaltyProgramTransaction

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltyProgramTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Amount of loyalty points added or deducted in the transaction.



33
34
35
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 33

def amount
  @amount
end

#campaign_id ⇒ Object

ID of the campaign.



24
25
26
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 24

def campaign_id
  @campaign_id
end

#card_identifier ⇒ Object

The alphanumeric identifier of the loyalty card.



48
49
50
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 48

def card_identifier
  @card_identifier
end

#created ⇒ Object

Date and time the loyalty transaction occurred.



27
28
29
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 27

def created
  @created
end

#customer_profile_id ⇒ Object

Customer profile integration ID used in the loyalty program.



45
46
47
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 45

def customer_profile_id
  @customer_profile_id
end

#customer_session_id ⇒ Object

ID of the customer session where the transaction occurred.



54
55
56
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 54

def customer_session_id
  @customer_session_id
end

#expiry_date ⇒ Object

When points expire. Possible values: - ‘unlimited`: Points have no expiration date. - a timestamp value: Points expire at a given date and time.



42
43
44
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 42

def expiry_date
  @expiry_date
end

#id ⇒ Object

ID of the loyalty ledger transaction.



18
19
20
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 18

def id
  @id
end

#import_id ⇒ Object

ID of the import where the transaction occurred.



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

def import_id
  @import_id
end

#name ⇒ Object

Name or reason for the loyalty ledger transaction.



36
37
38
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 36

def name
  @name
end

#program_id ⇒ Object

ID of the loyalty program.



21
22
23
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 21

def program_id
  @program_id
end

#rule_name ⇒ Object

Name of the rule that triggered the effect. Applies only for transactions that resulted from a customer session.



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

def rule_name
  @rule_name
end

#ruleset_id ⇒ Object

ID of the ruleset containing the rule that triggered the effect. Applies only for transactions that resulted from a customer session.



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

def ruleset_id
  @ruleset_id
end

#start_date ⇒ Object

When points become active. Possible values: - ‘immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time.



39
40
41
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 39

def start_date
  @start_date
end

#subledger_id ⇒ Object

ID of the subledger.



51
52
53
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 51

def subledger_id
  @subledger_id
end

#type ⇒ Object

Type of transaction. Possible values: - ‘addition`: Signifies added points. - `subtraction`: Signifies deducted points.



30
31
32
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 30

def type
  @type
end

#user_email ⇒ Object

The email of the Campaign Manager account that manually added or deducted points. Applies only to manual transactions.



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

def user_email
  @user_email
end

#user_id ⇒ Object

ID of the user who manually added or deducted points. Applies only to manual transactions.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 94

def self.attribute_map
  {
    :'id' => :'id',
    :'program_id' => :'programId',
    :'campaign_id' => :'campaignId',
    :'created' => :'created',
    :'type' => :'type',
    :'amount' => :'amount',
    :'name' => :'name',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'customer_profile_id' => :'customerProfileId',
    :'card_identifier' => :'cardIdentifier',
    :'subledger_id' => :'subledgerId',
    :'customer_session_id' => :'customerSessionId',
    :'import_id' => :'importId',
    :'user_id' => :'userId',
    :'user_email' => :'userEmail',
    :'ruleset_id' => :'rulesetId',
    :'rule_name' => :'ruleName'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 142

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 118

def self.openapi_types
  {
    :'id' => :'Integer',
    :'program_id' => :'Integer',
    :'campaign_id' => :'Integer',
    :'created' => :'DateTime',
    :'type' => :'String',
    :'amount' => :'Float',
    :'name' => :'String',
    :'start_date' => :'String',
    :'expiry_date' => :'String',
    :'customer_profile_id' => :'String',
    :'card_identifier' => :'String',
    :'subledger_id' => :'String',
    :'customer_session_id' => :'String',
    :'import_id' => :'Integer',
    :'user_id' => :'Integer',
    :'user_email' => :'String',
    :'ruleset_id' => :'Integer',
    :'rule_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 414

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      program_id == o.program_id &&
      campaign_id == o.campaign_id &&
      created == o.created &&
      type == o.type &&
      amount == o.amount &&
      name == o.name &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      customer_profile_id == o.customer_profile_id &&
      card_identifier == o.card_identifier &&
      subledger_id == o.subledger_id &&
      customer_session_id == o.customer_session_id &&
      import_id == o.import_id &&
      user_id == o.user_id &&
      user_email == o.user_email &&
      ruleset_id == o.ruleset_id &&
      rule_name == o.rule_name
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



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 480

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



549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 549

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



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 459

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


439
440
441
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 439

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



445
446
447
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 445

def hash
  [id, program_id, campaign_id, created, type, amount, name, start_date, expiry_date, customer_profile_id, card_identifier, subledger_id, customer_session_id, import_id, user_id, user_email, ruleset_id, rule_name].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



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
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
297
298
299
300
301
302
303
304
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 237

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

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

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

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

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

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

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

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

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

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

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

  if !@customer_profile_id.nil? && @customer_profile_id.to_s.length > 255
    invalid_properties.push('invalid value for "customer_profile_id", the character length must be smaller than or equal to 255.')
  end

  if !@card_identifier.nil? && @card_identifier.to_s.length > 108
    invalid_properties.push('invalid value for "card_identifier", the character length must be smaller than or equal to 108.')
  end

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

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

  if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
    invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.')
  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



525
526
527
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 525

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



531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 531

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



519
520
521
 
# File 'lib/talon_one/models/loyalty_program_transaction.rb', line 519

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



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

def valid?
  return false if @id.nil?
  return false if @program_id.nil?
  return false if @created.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["addition", "subtraction"])
  return false unless type_validator.valid?(@type)
  return false if @type.to_s.length > 255
  return false if @amount.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @start_date.nil?
  return false if @start_date.to_s.length > 64
  return false if @expiry_date.nil?
  return false if !@customer_profile_id.nil? && @customer_profile_id.to_s.length > 255
  return false if !@card_identifier.nil? && @card_identifier.to_s.length > 108
  return false if @subledger_id.nil?
  return false if @subledger_id.to_s.length > 64
  return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255
  true
end