Class: TalonOne::Event

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Event

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
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
 
# File 'lib/talon_one/models/event.rb', line 81

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'ledgerEntries')
    if (value = attributes[:'ledgerEntries']).is_a?(Array)
      self.ledger_entries = value
    end
  end

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

Instance Attribute Details

#application_id ⇒ Object

The ID of the application that owns this entity.



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

def application_id
  @application_id
end

#attributes ⇒ Object

Arbitrary additional JSON data associated with the event.



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

def attributes
  @attributes
end

#created ⇒ Object

The exact moment this entity was created.



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

def created
  @created
end

#effects ⇒ Object

An array of "effects" that must be applied in response to this event. Example effects include ‘addItemToCart` or `setDiscount`.



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

def effects
  @effects
end

#id ⇒ Object

Unique ID for this entity.



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

def id
  @id
end

#ledger_entries ⇒ Object

Ledger entries for the event.



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

def ledger_entries
  @ledger_entries
end

#meta ⇒ Object

Returns the value of attribute meta.



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

def meta
  @meta
end

#profile_id ⇒ Object

ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID.



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

def profile_id
  @profile_id
end

#session_id ⇒ Object

The ID of the session that this event occurred in.



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

def session_id
  @session_id
end

#type ⇒ Object

A string representing the event. Must not be a reserved event name.



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

def type
  @type
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/event.rb', line 48

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'application_id' => :'applicationId',
    :'profile_id' => :'profileId',
    :'type' => :'type',
    :'attributes' => :'attributes',
    :'session_id' => :'sessionId',
    :'effects' => :'effects',
    :'ledger_entries' => :'ledgerEntries',
    :'meta' => :'meta'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'application_id' => :'Integer',
    :'profile_id' => :'String',
    :'type' => :'String',
    :'attributes' => :'Object',
    :'session_id' => :'String',
    :'effects' => :'Array<Object>',
    :'ledger_entries' => :'Array<LedgerEntry>',
    :'meta' => :'Meta'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      application_id == o.application_id &&
      profile_id == o.profile_id &&
      type == o.type &&
      attributes == o.attributes &&
      session_id == o.session_id &&
      effects == o.effects &&
      ledger_entries == o.ledger_entries &&
      meta == o.meta
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



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

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/talon_one/models/event.rb', line 318

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/talon_one/models/event.rb', line 231

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, created, application_id, profile_id, type, attributes, session_id, effects, ledger_entries, meta].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



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
168
169
 
# File 'lib/talon_one/models/event.rb', line 134

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

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

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

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

  if @type.to_s.length < 1
    invalid_properties.push('invalid value for "type", the character length must be great than or equal to 1.')
  end

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

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

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



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

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



304
305
306
307
308
309
310
311
312
 
# File 'lib/talon_one/models/event.rb', line 304

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



292
293
294
 
# File 'lib/talon_one/models/event.rb', line 292

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



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/talon_one/models/event.rb', line 173

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @application_id.nil?
  return false if @type.nil?
  return false if @type.to_s.length < 1
  return false if @attributes.nil?
  return false if @effects.nil?
  return false if @ledger_entries.nil?
  true
end