Class: TalonOne::LoyaltySubLedger

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

Overview

Ledger of Balance in Loyalty Program for a Customer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltySubLedger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 92

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_points ⇒ Object

List of all currently active points.



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

def active_points
  @active_points
end

#current_tier ⇒ Object

Returns the value of attribute current_tier.



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

def current_tier
  @current_tier
end

#expired_points ⇒ Object

List of expired points.



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

def expired_points
  @expired_points
end

#expiring_points ⇒ Object

List of all points that will expire.



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

def expiring_points
  @expiring_points
end

#pending_points ⇒ Object

List of all points pending activation.



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

def pending_points
  @pending_points
end

#total ⇒ Object

DEPRECATED Use ‘totalActivePoints` property instead. Total amount of currently active and available points in the customer’s balance.



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

def total
  @total
end

#total_active_points ⇒ Object

Total amount of currently active and available points in the customer’s balance.



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

def total_active_points
  @total_active_points
end

#total_expired_points ⇒ Object

Total amount of points, that expired without ever being spent.



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

def total_expired_points
  @total_expired_points
end

#total_pending_points ⇒ Object

Total amount of pending points, which are not active yet but will become active in the future.



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

def total_pending_points
  @total_pending_points
end

#total_spent_points ⇒ Object

Total amount of points already spent by this customer.



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

def total_spent_points
  @total_spent_points
end

#transactions ⇒ Object

List of all events that have happened such as additions, subtractions and expiries.



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

def transactions
  @transactions
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 51

def self.attribute_map
  {
    :'total' => :'total',
    :'total_active_points' => :'totalActivePoints',
    :'total_pending_points' => :'totalPendingPoints',
    :'total_spent_points' => :'totalSpentPoints',
    :'total_expired_points' => :'totalExpiredPoints',
    :'transactions' => :'transactions',
    :'expiring_points' => :'expiringPoints',
    :'active_points' => :'activePoints',
    :'pending_points' => :'pendingPoints',
    :'expired_points' => :'expiredPoints',
    :'current_tier' => :'currentTier'
  }
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



231
232
233
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 231

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 85

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'total' => :'Float',
    :'total_active_points' => :'Float',
    :'total_pending_points' => :'Float',
    :'total_spent_points' => :'Float',
    :'total_expired_points' => :'Float',
    :'transactions' => :'Array<LoyaltyLedgerEntry>',
    :'expiring_points' => :'Array<LoyaltyLedgerEntry>',
    :'active_points' => :'Array<LoyaltyLedgerEntry>',
    :'pending_points' => :'Array<LoyaltyLedgerEntry>',
    :'expired_points' => :'Array<LoyaltyLedgerEntry>',
    :'current_tier' => :'Tier'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      total_active_points == o.total_active_points &&
      total_pending_points == o.total_pending_points &&
      total_spent_points == o.total_spent_points &&
      total_expired_points == o.total_expired_points &&
      transactions == o.transactions &&
      expiring_points == o.expiring_points &&
      active_points == o.active_points &&
      pending_points == o.pending_points &&
      expired_points == o.expired_points &&
      current_tier == o.current_tier
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



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

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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 328

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 238

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


218
219
220
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 218

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 224

def hash
  [total, total_active_points, total_pending_points, total_spent_points, total_expired_points, transactions, expiring_points, active_points, pending_points, expired_points, current_tier].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 162

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

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

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

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

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



304
305
306
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 310

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



298
299
300
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 298

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



189
190
191
192
193
194
195
196
 
# File 'lib/talon_one/models/loyalty_sub_ledger.rb', line 189

def valid?
  return false if @total.nil?
  return false if @total_active_points.nil?
  return false if @total_pending_points.nil?
  return false if @total_spent_points.nil?
  return false if @total_expired_points.nil?
  true
end