Class: ClerkHttpClient::Client

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Client

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/clerk-http-client/models/client.rb', line 109

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

  if attributes.key?(:'sessions')
    if (value = attributes[:'sessions']).is_a?(Array)
      self.sessions = value
    end
  else
    self.sessions = nil
  end

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

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

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

#created_atObject

Unix timestamp of creation.



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

def created_at
  @created_at
end

#idObject

String representing the identifier of the session.



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

def id
  @id
end

#last_active_session_idObject

Last active session_id.



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

def last_active_session_id
  @last_active_session_id
end

#objectObject

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



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

def object
  @object
end

#session_idsObject

Returns the value of attribute session_ids.



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

def session_ids
  @session_ids
end

#sessionsObject

Returns the value of attribute sessions.



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

def sessions
  @sessions
end

#sign_in_idObject

Returns the value of attribute sign_in_id.



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

def 
  @sign_in_id
end

#sign_up_idObject

Returns the value of attribute sign_up_id.



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

def 
  @sign_up_id
end

#updated_atObject

Unix timestamp of last update.



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

def updated_at
  @updated_at
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



293
294
295
296
297
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
# File 'lib/clerk-http-client/models/client.rb', line 293

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_attributesObject

Returns all the JSON keys this model knows about



79
80
81
# File 'lib/clerk-http-client/models/client.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/clerk-http-client/models/client.rb', line 64

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'session_ids' => :'session_ids',
    :'sessions' => :'sessions',
    :'sign_in_id' => :'sign_in_id',
    :'sign_up_id' => :'sign_up_id',
    :'last_active_session_id' => :'last_active_session_id',
    :'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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/clerk-http-client/models/client.rb', line 269

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_nullableObject

List of attributes with nullable: true



99
100
101
102
103
104
105
# File 'lib/clerk-http-client/models/client.rb', line 99

def self.openapi_nullable
  Set.new([
    :'sign_in_id',
    :'sign_up_id',
    :'last_active_session_id',
  ])
end

.openapi_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/clerk-http-client/models/client.rb', line 84

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'session_ids' => :'Array<String>',
    :'sessions' => :'Array<Session>',
    :'sign_in_id' => :'String',
    :'sign_up_id' => :'String',
    :'last_active_session_id' => :'String',
    :'updated_at' => :'Integer',
    :'created_at' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/clerk-http-client/models/client.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      session_ids == o.session_ids &&
      sessions == o.sessions &&
       == o. &&
       == o. &&
      last_active_session_id == o.last_active_session_id &&
      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



364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/clerk-http-client/models/client.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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


256
257
258
# File 'lib/clerk-http-client/models/client.rb', line 256

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



262
263
264
# File 'lib/clerk-http-client/models/client.rb', line 262

def hash
  [object, id, session_ids, sessions, , , last_active_session_id, updated_at, created_at].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/clerk-http-client/models/client.rb', line 183

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

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

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



340
341
342
# File 'lib/clerk-http-client/models/client.rb', line 340

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/clerk-http-client/models/client.rb', line 346

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



334
335
336
# File 'lib/clerk-http-client/models/client.rb', line 334

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



215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/clerk-http-client/models/client.rb', line 215

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["client"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @session_ids.nil?
  return false if @sessions.nil?
  return false if @updated_at.nil?
  return false if @created_at.nil?
  true
end