Class: ClerkHttpClient::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/models/session.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Session

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
199
200
201
202
203
204
205
206
207
 
# File 'lib/clerk-http-client/models/session.rb', line 123

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

  if attributes.key?(:'client_id')
    self.client_id = attributes[:'client_id']
  else
    self.client_id = nil
  end

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end

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

  if attributes.key?(:'last_active_at')
    self.last_active_at = attributes[:'last_active_at']
  else
    self.last_active_at = nil
  end

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

  if attributes.key?(:'expire_at')
    self.expire_at = attributes[:'expire_at']
  else
    self.expire_at = nil
  end

  if attributes.key?(:'abandon_at')
    self.abandon_at = attributes[:'abandon_at']
  else
    self.abandon_at = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end
end

Instance Attribute Details

#abandon_at ⇒ Object

Returns the value of attribute abandon_at.



39
40
41
 
# File 'lib/clerk-http-client/models/session.rb', line 39

def abandon_at
  @abandon_at
end

#actor ⇒ Object

Returns the value of attribute actor.



27
28
29
 
# File 'lib/clerk-http-client/models/session.rb', line 27

def actor
  @actor
end

#client_id ⇒ Object

Returns the value of attribute client_id.



25
26
27
 
# File 'lib/clerk-http-client/models/session.rb', line 25

def client_id
  @client_id
end

#created_at ⇒ Object

Unix timestamp of creation.



45
46
47
 
# File 'lib/clerk-http-client/models/session.rb', line 45

def created_at
  @created_at
end

#expire_at ⇒ Object

Returns the value of attribute expire_at.



37
38
39
 
# File 'lib/clerk-http-client/models/session.rb', line 37

def expire_at
  @expire_at
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/clerk-http-client/models/session.rb', line 21

def id
  @id
end

#last_active_at ⇒ Object

Returns the value of attribute last_active_at.



33
34
35
 
# File 'lib/clerk-http-client/models/session.rb', line 33

def last_active_at
  @last_active_at
end

#last_active_organization_id ⇒ Object

Returns the value of attribute last_active_organization_id.



31
32
33
 
# File 'lib/clerk-http-client/models/session.rb', line 31

def last_active_organization_id
  @last_active_organization_id
end

#latest_activity ⇒ Object

Returns the value of attribute latest_activity.



35
36
37
 
# File 'lib/clerk-http-client/models/session.rb', line 35

def latest_activity
  @latest_activity
end

#object ⇒ Object

String representing the object’s type. Objects of the same type share the same value.



19
20
21
 
# File 'lib/clerk-http-client/models/session.rb', line 19

def object
  @object
end

#status ⇒ Object

Returns the value of attribute status.



29
30
31
 
# File 'lib/clerk-http-client/models/session.rb', line 29

def status
  @status
end

#updated_at ⇒ Object

Unix timestamp of last update.



42
43
44
 
# File 'lib/clerk-http-client/models/session.rb', line 42

def updated_at
  @updated_at
end

#user_id ⇒ Object

Returns the value of attribute user_id.



23
24
25
 
# File 'lib/clerk-http-client/models/session.rb', line 23

def user_id
  @user_id
end

Class Method Details

._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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/clerk-http-client/models/session.rb', line 357

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = ClerkHttpClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/clerk-http-client/models/session.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/clerk-http-client/models/session.rb', line 70

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'user_id' => :'user_id',
    :'client_id' => :'client_id',
    :'actor' => :'actor',
    :'status' => :'status',
    :'last_active_organization_id' => :'last_active_organization_id',
    :'last_active_at' => :'last_active_at',
    :'latest_activity' => :'latest_activity',
    :'expire_at' => :'expire_at',
    :'abandon_at' => :'abandon_at',
    :'updated_at' => :'updated_at',
    :'created_at' => :'created_at'
  }
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/clerk-http-client/models/session.rb', line 333

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
119
 
# File 'lib/clerk-http-client/models/session.rb', line 113

def self.openapi_nullable
  Set.new([
    :'actor',
    :'last_active_organization_id',
    :'latest_activity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/clerk-http-client/models/session.rb', line 94

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'user_id' => :'String',
    :'client_id' => :'String',
    :'actor' => :'Object',
    :'status' => :'String',
    :'last_active_organization_id' => :'String',
    :'last_active_at' => :'Integer',
    :'latest_activity' => :'SessionLatestActivity',
    :'expire_at' => :'Integer',
    :'abandon_at' => :'Integer',
    :'updated_at' => :'Integer',
    :'created_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/clerk-http-client/models/session.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      user_id == o.user_id &&
      client_id == o.client_id &&
      actor == o.actor &&
      status == o.status &&
      last_active_organization_id == o.last_active_organization_id &&
      last_active_at == o.last_active_at &&
      latest_activity == o.latest_activity &&
      expire_at == o.expire_at &&
      abandon_at == o.abandon_at &&
      updated_at == o.updated_at &&
      created_at == o.created_at
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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/clerk-http-client/models/session.rb', line 428

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


320
321
322
 
# File 'lib/clerk-http-client/models/session.rb', line 320

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



326
327
328
 
# File 'lib/clerk-http-client/models/session.rb', line 326

def hash
  [object, id, user_id, client_id, actor, status, last_active_organization_id, last_active_at, latest_activity, expire_at, abandon_at, updated_at, created_at].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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/clerk-http-client/models/session.rb', line 211

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

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

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

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

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

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

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

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

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

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



404
405
406
 
# File 'lib/clerk-http-client/models/session.rb', line 404

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/clerk-http-client/models/session.rb', line 410

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



398
399
400
 
# File 'lib/clerk-http-client/models/session.rb', line 398

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/clerk-http-client/models/session.rb', line 259

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["session"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @user_id.nil?
  return false if @client_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["active", "revoked", "ended", "expired", "removed", "abandoned", "replaced"])
  return false unless status_validator.valid?(@status)
  return false if @last_active_at.nil?
  return false if @expire_at.nil?
  return false if @abandon_at.nil?
  return false if @updated_at.nil?
  return false if @created_at.nil?
  true
end