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.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'created')
    self.created = attributes[:'created']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
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.



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

def customer_session_id
  @customer_session_id
end

#event_id ⇒ Object

Returns the value of attribute event_id.



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

def event_id
  @event_id
end

#expiry_date ⇒ Object

Returns the value of attribute expiry_date.



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

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.



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

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

#sub_ledger_id ⇒ Object

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



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

def sub_ledger_id
  @sub_ledger_id
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created' => :'created',
    :'program_id' => :'programID',
    :'customer_profile_id' => :'customerProfileID',
    :'customer_session_id' => :'customerSessionID',
    :'event_id' => :'eventID',
    :'type' => :'type',
    :'amount' => :'amount',
    :'expiry_date' => :'expiryDate',
    :'name' => :'name',
    :'sub_ledger_id' => :'subLedgerID'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'created' => :'DateTime',
    :'program_id' => :'Integer',
    :'customer_profile_id' => :'String',
    :'customer_session_id' => :'String',
    :'event_id' => :'Integer',
    :'type' => :'String',
    :'amount' => :'Float',
    :'expiry_date' => :'DateTime',
    :'name' => :'String',
    :'sub_ledger_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 205

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 &&
      customer_session_id == o.customer_session_id &&
      event_id == o.event_id &&
      type == o.type &&
      amount == o.amount &&
      expiry_date == o.expiry_date &&
      name == o.name &&
      sub_ledger_id == o.sub_ledger_id
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



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

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
    temp_model = TalonOne.const_get(type).new
    temp_model.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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 322

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 235

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


222
223
224
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 228

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



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

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



302
303
304
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 302

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



308
309
310
311
312
313
314
315
316
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 308

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



296
297
298
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 296

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



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/talon_one/models/loyalty_ledger_entry.rb', line 180

def valid?
  return false if @created.nil?
  return false if @program_id.nil?
  return false if @customer_profile_id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['addition', 'subtraction'])
  return false unless type_validator.valid?(@type)
  return false if @amount.nil?
  return false if @name.nil?
  return false if @sub_ledger_id.nil?
  true
end