Class: TalonOne::LoyaltyLedgerEntry

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

Overview

A single row of the ledger, describing one addition or deduction.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltyLedgerEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 99

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#archived ⇒ Object

Indicates if the entry belongs to the archived session.



49
50
51
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 49

def archived
  @archived
end

#card_id ⇒ Object

Returns the value of attribute card_id.



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

def card_id
  @card_id
end

#created ⇒ Object

Returns the value of attribute created.



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

def created
  @created
end

#customer_profile_id ⇒ Object

Returns the value of attribute customer_profile_id.



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

def customer_profile_id
  @customer_profile_id
end

#customer_session_id ⇒ Object

Returns the value of attribute customer_session_id.



26
27
28
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 26

def customer_session_id
  @customer_session_id
end

#event_id ⇒ Object

Returns the value of attribute event_id.



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

def event_id
  @event_id
end

#expiry_date ⇒ Object

Returns the value of attribute expiry_date.



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

def expiry_date
  @expiry_date
end

#name ⇒ Object

A name referencing the condition or effect that added this entry, or the specific name provided in an API call.



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

def name
  @name
end

#program_id ⇒ Object

Returns the value of attribute program_id.



20
21
22
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 20

def program_id
  @program_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



35
36
37
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 35

def start_date
  @start_date
end

#sub_ledger_id ⇒ Object

This specifies if we are adding loyalty points to the main ledger or a subledger.



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

def sub_ledger_id
  @sub_ledger_id
end

#type ⇒ Object

The type of the ledger transaction. Possible values are: - ‘addition` - `subtraction` - `expire` - `expiring` (for expiring points ledgers)



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

def type
  @type
end

#user_id ⇒ Object

This is the ID of the user who created this entry, if the addition or subtraction was done manually.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 52

def self.attribute_map
  {
    :'created' => :'created',
    :'program_id' => :'programID',
    :'customer_profile_id' => :'customerProfileID',
    :'card_id' => :'cardID',
    :'customer_session_id' => :'customerSessionID',
    :'event_id' => :'eventID',
    :'type' => :'type',
    :'amount' => :'amount',
    :'start_date' => :'startDate',
    :'expiry_date' => :'expiryDate',
    :'name' => :'name',
    :'sub_ledger_id' => :'subLedgerID',
    :'user_id' => :'userID',
    :'archived' => :'archived'
  }
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



248
249
250
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 248

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 72

def self.openapi_types
  {
    :'created' => :'DateTime',
    :'program_id' => :'Integer',
    :'customer_profile_id' => :'String',
    :'card_id' => :'Integer',
    :'customer_session_id' => :'String',
    :'event_id' => :'Integer',
    :'type' => :'String',
    :'amount' => :'Float',
    :'start_date' => :'DateTime',
    :'expiry_date' => :'DateTime',
    :'name' => :'String',
    :'sub_ledger_id' => :'String',
    :'user_id' => :'Integer',
    :'archived' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      program_id == o.program_id &&
      customer_profile_id == o.customer_profile_id &&
      card_id == o.card_id &&
      customer_session_id == o.customer_session_id &&
      event_id == o.event_id &&
      type == o.type &&
      amount == o.amount &&
      start_date == o.start_date &&
      expiry_date == o.expiry_date &&
      name == o.name &&
      sub_ledger_id == o.sub_ledger_id &&
      user_id == o.user_id &&
      archived == o.archived
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



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
305
306
307
308
309
310
311
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 276

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 345

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 255

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


235
236
237
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 241

def hash
  [created, program_id, customer_profile_id, card_id, customer_session_id, event_id, type, amount, start_date, expiry_date, name, sub_ledger_id, user_id, archived].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



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

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

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

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



321
322
323
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 321

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



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

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



315
316
317
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 315

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



202
203
204
205
206
207
208
209
210
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 202

def valid?
  return false if @created.nil?
  return false if @program_id.nil?
  return false if @type.nil?
  return false if @amount.nil?
  return false if @name.nil?
  return false if @sub_ledger_id.nil?
  true
end