Class: TalonOne::AddedDeductedPointsNotification

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddedDeductedPointsNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

  if attributes.key?(:'operation')
    self.operation = attributes[:'operation']
  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?(:'session_integration_id')
    self.session_integration_id = attributes[:'session_integration_id']
  end

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

Instance Attribute Details

#amount ⇒ Object

The amount of added or deducted loyalty points.



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

def amount
  @amount
end

#employee_name ⇒ Object

The name of the employee who added or deducted points.



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

def employee_name
  @employee_name
end

#expiry_date ⇒ Object

The expiration date for loyalty points.



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

def expiry_date
  @expiry_date
end

#loyalty_program_id ⇒ Object

The ID of the loyalty program.



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

def loyalty_program_id
  @loyalty_program_id
end

#notification_type ⇒ Object

The type of notification.



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

def notification_type
  @notification_type
end

#operation ⇒ Object

The action (addition or deduction) made with loyalty points.



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

def operation
  @operation
end

#profile_integration_id ⇒ Object

The integration ID of the customer profile to whom points were added or deducted.



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

def profile_integration_id
  @profile_integration_id
end

#reason ⇒ Object

The reason for the points addition or deduction.



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

def reason
  @reason
end

#session_integration_id ⇒ Object

The integration ID of the session through which the points were earned or lost.



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

def session_integration_id
  @session_integration_id
end

#start_date ⇒ Object

The start date for loyalty points.



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

def start_date
  @start_date
end

#subledger_id ⇒ Object

The ID of the subledger within the loyalty program where these points were added.



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

def subledger_id
  @subledger_id
end

#type_of_change ⇒ Object

The notification source, that is, it indicates whether the points were added or deducted via one of the following routes: - [The Campaign Manager](/docs/product/getting-started) - [Management API](/management-api#tag/Loyalty) - [Rule Engine](/docs/product/applications/evaluation-order-for-rules-and-filters)



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

def type_of_change
  @type_of_change
end

#user_id ⇒ Object

The ID of the employee who added or deducted points.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 79

def self.attribute_map
  {
    :'profile_integration_id' => :'ProfileIntegrationID',
    :'loyalty_program_id' => :'LoyaltyProgramID',
    :'subledger_id' => :'SubledgerID',
    :'amount' => :'Amount',
    :'reason' => :'Reason',
    :'type_of_change' => :'TypeOfChange',
    :'employee_name' => :'EmployeeName',
    :'user_id' => :'UserID',
    :'operation' => :'Operation',
    :'start_date' => :'StartDate',
    :'expiry_date' => :'ExpiryDate',
    :'session_integration_id' => :'SessionIntegrationID',
    :'notification_type' => :'NotificationType'
  }
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



367
368
369
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 367

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'profile_integration_id' => :'String',
    :'loyalty_program_id' => :'Integer',
    :'subledger_id' => :'String',
    :'amount' => :'Float',
    :'reason' => :'String',
    :'type_of_change' => :'String',
    :'employee_name' => :'String',
    :'user_id' => :'Integer',
    :'operation' => :'String',
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'session_integration_id' => :'String',
    :'notification_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 334

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_integration_id == o.profile_integration_id &&
      loyalty_program_id == o.loyalty_program_id &&
      subledger_id == o.subledger_id &&
      amount == o.amount &&
      reason == o.reason &&
      type_of_change == o.type_of_change &&
      employee_name == o.employee_name &&
      user_id == o.user_id &&
      operation == o.operation &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      session_integration_id == o.session_integration_id &&
      notification_type == o.notification_type
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



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 395

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



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 464

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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 374

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


354
355
356
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 354

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



360
361
362
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 360

def hash
  [profile_integration_id, loyalty_program_id, subledger_id, amount, reason, type_of_change, employee_name, user_id, operation, start_date, expiry_date, session_integration_id, notification_type].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



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

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

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

  if @loyalty_program_id < 1
    invalid_properties.push('invalid value for "loyalty_program_id", must be greater than or equal to 1.')
  end

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

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

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

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

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

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

  if @user_id < 1
    invalid_properties.push('invalid value for "user_id", must be greater than or equal to 1.')
  end

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

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

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



440
441
442
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 440

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 446

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



434
435
436
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 434

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/talon_one/models/added_deducted_points_notification.rb', line 251

def valid?
  return false if @profile_integration_id.nil?
  return false if @loyalty_program_id.nil?
  return false if @loyalty_program_id < 1
  return false if @subledger_id.nil?
  return false if @amount.nil?
  return false if @reason.nil?
  return false if @type_of_change.nil?
  type_of_change_validator = EnumAttributeValidator.new('String', ["campaign_manager", "rule_engine", "management_api"])
  return false unless type_of_change_validator.valid?(@type_of_change)
  return false if @employee_name.nil?
  return false if @user_id.nil?
  return false if @user_id < 1
  return false if @operation.nil?
  operation_validator = EnumAttributeValidator.new('String', ["addition", "deduction"])
  return false unless operation_validator.valid?(@operation)
  return false if @session_integration_id.nil?
  return false if @notification_type.nil?
  notification_type_validator = EnumAttributeValidator.new('String', ["LoyaltyPointsDeducted", "LoyaltyPointsAdded"])
  return false unless notification_type_validator.valid?(@notification_type)
  true
end