Class: TalonOne::AddedDeductedPointsNotification

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AddedDeductedPointsNotification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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_sdk/models/added_deducted_points_notification.rb', line 140

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
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_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: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

  if attributes.key?(:'profile_integration_id')
    self.profile_integration_id = attributes[:'profile_integration_id']
  else
    self.profile_integration_id = nil
  end

  if attributes.key?(:'session_integration_id')
    self.session_integration_id = attributes[:'session_integration_id']
  else
    self.session_integration_id = nil
  end

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

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

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

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

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

  if attributes.key?(:'operation')
    self.operation = attributes[:'operation']
  else
    self.operation = nil
  end

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

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

  if attributes.key?(:'transaction_uuid')
    self.transaction_uuid = attributes[:'transaction_uuid']
  else
    self.transaction_uuid = nil
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount of added or deducted loyalty points.



43
44
45
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 43

def amount
  @amount
end

#employee_name ⇒ Object

The name of the employee who added or deducted points.



19
20
21
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 19

def employee_name
  @employee_name
end

#expiry_date ⇒ Object

The expiration date for loyalty points.



46
47
48
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 46

def expiry_date
  @expiry_date
end

#loyalty_program_id ⇒ Object

The ID of the loyalty program.



22
23
24
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 22

def loyalty_program_id
  @loyalty_program_id
end

#notification_type ⇒ Object

The type of notification.



25
26
27
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 25

def notification_type
  @notification_type
end

#operation ⇒ Object

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



49
50
51
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 49

def operation
  @operation
end

#profile_integration_id ⇒ Object

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



28
29
30
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 28

def profile_integration_id
  @profile_integration_id
end

#reason ⇒ Object

The reason for the points addition or deduction.



52
53
54
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 52

def reason
  @reason
end

#session_integration_id ⇒ Object

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



31
32
33
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 31

def session_integration_id
  @session_integration_id
end

#start_date ⇒ Object

The start date for loyalty points.



55
56
57
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 55

def start_date
  @start_date
end

#subledger_id ⇒ Object

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



34
35
36
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 34

def subledger_id
  @subledger_id
end

#transaction_uuid ⇒ Object

The identifier of the transaction in the loyalty ledger.



58
59
60
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 58

def transaction_uuid
  @transaction_uuid
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)



37
38
39
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 37

def type_of_change
  @type_of_change
end

#user_id ⇒ Object

The ID of the employee who added or deducted points.



40
41
42
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 40

def user_id
  @user_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



103
104
105
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 103

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



108
109
110
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 108

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 83

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



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 481

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



133
134
135
136
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 133

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

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 113

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 447

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_name == o.employee_name &&
      loyalty_program_id == o.loyalty_program_id &&
      notification_type == o.notification_type &&
      profile_integration_id == o.profile_integration_id &&
      session_integration_id == o.session_integration_id &&
      subledger_id == o.subledger_id &&
      type_of_change == o.type_of_change &&
      user_id == o.user_id &&
      amount == o.amount &&
      expiry_date == o.expiry_date &&
      operation == o.operation &&
      reason == o.reason &&
      start_date == o.start_date &&
      transaction_uuid == o.transaction_uuid
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


468
469
470
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 468

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



474
475
476
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 474

def hash
  [employee_name, loyalty_program_id, notification_type, profile_integration_id, session_integration_id, subledger_id, type_of_change, user_id, amount, expiry_date, operation, reason, start_date, transaction_uuid].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
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 237

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @employee_name.nil?
    invalid_properties.push('invalid value for "employee_name", employee_name 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 @notification_type.nil?
    invalid_properties.push('invalid value for "notification_type", notification_type cannot be nil.')
  end

  if @profile_integration_id.nil?
    invalid_properties.push('invalid value for "profile_integration_id", profile_integration_id 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 @subledger_id.nil?
    invalid_properties.push('invalid value for "subledger_id", subledger_id 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 @user_id.nil?
    invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
  end

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/talon_one_sdk/models/added_deducted_points_notification.rb', line 503

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



297
298
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_sdk/models/added_deducted_points_notification.rb', line 297

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @employee_name.nil?
  return false if @loyalty_program_id.nil?
  return false if @loyalty_program_id < 1
  return false if @notification_type.nil?
  notification_type_validator = EnumAttributeValidator.new('String', ["LoyaltyPointsDeducted", "LoyaltyPointsAdded"])
  return false unless notification_type_validator.valid?(@notification_type)
  return false if @profile_integration_id.nil?
  return false if @session_integration_id.nil?
  return false if @subledger_id.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 @user_id.nil?
  return false if @amount.nil?
  return false if @operation.nil?
  operation_validator = EnumAttributeValidator.new('String', ["addition", "subtraction"])
  return false unless operation_validator.valid?(@operation)
  return false if @reason.nil?
  return false if @transaction_uuid.nil?
  true
end