Class: TalonOne::LedgerInfo

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

Overview

The balance in a Loyalty Program for some Customer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LedgerInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
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
 
# File 'lib/talon_one/models/ledger_info.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_balance ⇒ Object

Sum of currently active points.



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

def current_balance
  @current_balance
end

#current_tier ⇒ Object

Returns the value of attribute current_tier.



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

def current_tier
  @current_tier
end

#expired_balance ⇒ Object

DEPRECATED Value is shown as 0.



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

def expired_balance
  @expired_balance
end

#negative_balance ⇒ Object

Sum of negative points. This implies that ‘currentBalance` is `0`.



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

def negative_balance
  @negative_balance
end

#pending_balance ⇒ Object

Sum of pending points.



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

def pending_balance
  @pending_balance
end

#points_to_next_tier ⇒ Object

Points required to move up a tier.



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

def points_to_next_tier
  @points_to_next_tier
end

#spent_balance ⇒ Object

DEPRECATED Value is shown as 0.



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

def spent_balance
  @spent_balance
end

#tentative_current_balance ⇒ Object

The tentative points balance, reflecting the ‘currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.



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

def tentative_current_balance
  @tentative_current_balance
end

#tentative_negative_balance ⇒ Object

The tentative negative balance after all additions and deductions from the current customer session are applied to ‘negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.



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

def tentative_negative_balance
  @tentative_negative_balance
end

#tentative_pending_balance ⇒ Object

The tentative points balance, reflecting the ‘pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.



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

def tentative_pending_balance
  @tentative_pending_balance
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/talon_one/models/ledger_info.rb', line 48

def self.attribute_map
  {
    :'current_balance' => :'currentBalance',
    :'pending_balance' => :'pendingBalance',
    :'negative_balance' => :'negativeBalance',
    :'expired_balance' => :'expiredBalance',
    :'spent_balance' => :'spentBalance',
    :'tentative_current_balance' => :'tentativeCurrentBalance',
    :'tentative_pending_balance' => :'tentativePendingBalance',
    :'tentative_negative_balance' => :'tentativeNegativeBalance',
    :'current_tier' => :'currentTier',
    :'points_to_next_tier' => :'pointsToNextTier'
  }
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



211
212
213
 
# File 'lib/talon_one/models/ledger_info.rb', line 211

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/talon_one/models/ledger_info.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/talon_one/models/ledger_info.rb', line 64

def self.openapi_types
  {
    :'current_balance' => :'Float',
    :'pending_balance' => :'Float',
    :'negative_balance' => :'Float',
    :'expired_balance' => :'Float',
    :'spent_balance' => :'Float',
    :'tentative_current_balance' => :'Float',
    :'tentative_pending_balance' => :'Float',
    :'tentative_negative_balance' => :'Float',
    :'current_tier' => :'Tier',
    :'points_to_next_tier' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/talon_one/models/ledger_info.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      current_balance == o.current_balance &&
      pending_balance == o.pending_balance &&
      negative_balance == o.negative_balance &&
      expired_balance == o.expired_balance &&
      spent_balance == o.spent_balance &&
      tentative_current_balance == o.tentative_current_balance &&
      tentative_pending_balance == o.tentative_pending_balance &&
      tentative_negative_balance == o.tentative_negative_balance &&
      current_tier == o.current_tier &&
      points_to_next_tier == o.points_to_next_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



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

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/talon_one/models/ledger_info.rb', line 308

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/talon_one/models/ledger_info.rb', line 218

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


198
199
200
 
# File 'lib/talon_one/models/ledger_info.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/talon_one/models/ledger_info.rb', line 204

def hash
  [current_balance, pending_balance, negative_balance, expired_balance, spent_balance, tentative_current_balance, tentative_pending_balance, tentative_negative_balance, current_tier, points_to_next_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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/talon_one/models/ledger_info.rb', line 143

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

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

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

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

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



284
285
286
 
# File 'lib/talon_one/models/ledger_info.rb', line 284

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/talon_one/models/ledger_info.rb', line 290

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



278
279
280
 
# File 'lib/talon_one/models/ledger_info.rb', line 278

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



170
171
172
173
174
175
176
177
 
# File 'lib/talon_one/models/ledger_info.rb', line 170

def valid?
  return false if @current_balance.nil?
  return false if @pending_balance.nil?
  return false if @expired_balance.nil?
  return false if @spent_balance.nil?
  return false if @tentative_current_balance.nil?
  true
end