Class: TalonOne::ApplicationSession

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationSession

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
 
# File 'lib/talon_one/models/application_session.rb', line 114

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

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

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

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

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

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

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

  if attributes.has_key?(:'attributes')
    self.attributes = attributes[:'attributes']
  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/application_session.rb', line 25

def application_id
  @application_id
end

#attributes ⇒ Object

Arbitrary properties associated with this item



52
53
54
 
# File 'lib/talon_one/models/application_session.rb', line 52

def attributes
  @attributes
end

#cart_items ⇒ Object

Serialized JSON representation.



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

def cart_items
  @cart_items
end

#coupon ⇒ Object

Any coupon code entered.



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

def coupon
  @coupon
end

#created ⇒ Object

The exact moment this entity was created. The exact moment this entity was created.



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

def created
  @created
end

#discounts ⇒ Object

A map of labelled discount values, in the same currency as the session.



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

def discounts
  @discounts
end

#id ⇒ Object

Unique ID for this entity.



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

def id
  @id
end

#integration_id ⇒ Object

The ID used for this entity in the application system.



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

def integration_id
  @integration_id
end

#profile_id ⇒ Object

The globally unique Talon.One ID of the customer that created this entity.



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

def profile_id
  @profile_id
end

#referral ⇒ Object

Any referral code entered.



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

def referral
  @referral
end

#state ⇒ Object

Indicating if the customer session is in progress ("open"), "closed", or "cancelled".



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

def state
  @state
end

#total ⇒ Object

The total sum of the session before any discounts applied.



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

def total
  @total
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'application_id' => :'applicationId',
    :'profile_id' => :'profileId',
    :'integration_id' => :'integrationId',
    :'coupon' => :'coupon',
    :'referral' => :'referral',
    :'state' => :'state',
    :'cart_items' => :'cartItems',
    :'discounts' => :'discounts',
    :'total' => :'total',
    :'attributes' => :'attributes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/talon_one/models/application_session.rb', line 95

def self.swagger_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'application_id' => :'Integer',
    :'profile_id' => :'Integer',
    :'integration_id' => :'String',
    :'coupon' => :'String',
    :'referral' => :'String',
    :'state' => :'String',
    :'cart_items' => :'Array<CartItem>',
    :'discounts' => :'Hash<String, Float>',
    :'total' => :'Float',
    :'attributes' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/talon_one/models/application_session.rb', line 245

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 &&
      integration_id == o.integration_id &&
      coupon == o.coupon &&
      referral == o.referral &&
      state == o.state &&
      cart_items == o.cart_items &&
      discounts == o.discounts &&
      total == o.total &&
      attributes == o.attributes
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/talon_one/models/application_session.rb', line 298

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/talon_one/models/application_session.rb', line 364

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/talon_one/models/application_session.rb', line 277

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


264
265
266
 
# File 'lib/talon_one/models/application_session.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/talon_one/models/application_session.rb', line 270

def hash
  [id, created, application_id, profile_id, integration_id, coupon, referral, state, cart_items, discounts, total, attributes].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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/talon_one/models/application_session.rb', line 175

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

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

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

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

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

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



344
345
346
 
# File 'lib/talon_one/models/application_session.rb', line 344

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/talon_one/models/application_session.rb', line 350

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



338
339
340
 
# File 'lib/talon_one/models/application_session.rb', line 338

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



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

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @application_id.nil?
  return false if @integration_id.nil?
  return false if @coupon.nil?
  return false if @referral.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ['open', 'closed', 'cancelled'])
  return false unless state_validator.valid?(@state)
  return false if @cart_items.nil?
  return false if @discounts.nil?
  true
end