Class: ClerkHttpClient::OAuthApplicationWithSecret

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuthApplicationWithSecret

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
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
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 139

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authorize_url ⇒ Object

Returns the value of attribute authorize_url.



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

def authorize_url
  @authorize_url
end

#callback_url ⇒ Object

Returns the value of attribute callback_url.



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

def callback_url
  @callback_url
end

#client_id ⇒ Object

Returns the value of attribute client_id.



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

def client_id
  @client_id
end

#client_secret ⇒ Object

Empty if public client.



51
52
53
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 51

def client_secret
  @client_secret
end

#created_at ⇒ Object

Unix timestamp of creation.



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

def created_at
  @created_at
end

#discovery_url ⇒ Object

Returns the value of attribute discovery_url.



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

def discovery_url
  @discovery_url
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#instance_id ⇒ Object

Returns the value of attribute instance_id.



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

def instance_id
  @instance_id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#object ⇒ Object

Returns the value of attribute object.



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

def object
  @object
end

#public ⇒ Object

Returns the value of attribute public.



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

def public
  @public
end

#scopes ⇒ Object

Returns the value of attribute scopes.



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

def scopes
  @scopes
end

#token_fetch_url ⇒ Object

Returns the value of attribute token_fetch_url.



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

def token_fetch_url
  @token_fetch_url
end

#token_introspection_url ⇒ Object

Returns the value of attribute token_introspection_url.



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

def token_introspection_url
  @token_introspection_url
end

#updated_at ⇒ Object

Unix timestamp of last update.



48
49
50
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 48

def updated_at
  @updated_at
end

#user_info_url ⇒ Object

Returns the value of attribute user_info_url.



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

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



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 411

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



98
99
100
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 76

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'instance_id' => :'instance_id',
    :'name' => :'name',
    :'client_id' => :'client_id',
    :'public' => :'public',
    :'scopes' => :'scopes',
    :'callback_url' => :'callback_url',
    :'authorize_url' => :'authorize_url',
    :'token_fetch_url' => :'token_fetch_url',
    :'user_info_url' => :'user_info_url',
    :'discovery_url' => :'discovery_url',
    :'token_introspection_url' => :'token_introspection_url',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'client_secret' => :'client_secret'
  }
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 387

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



131
132
133
134
135
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 131

def self.openapi_all_of
  [
  :'OAuthApplication'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 125

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 103

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'instance_id' => :'String',
    :'name' => :'String',
    :'client_id' => :'String',
    :'public' => :'Boolean',
    :'scopes' => :'String',
    :'callback_url' => :'String',
    :'authorize_url' => :'String',
    :'token_fetch_url' => :'String',
    :'user_info_url' => :'String',
    :'discovery_url' => :'String',
    :'token_introspection_url' => :'String',
    :'created_at' => :'Integer',
    :'updated_at' => :'Integer',
    :'client_secret' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 351

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      instance_id == o.instance_id &&
      name == o.name &&
      client_id == o.client_id &&
      public == o.public &&
      scopes == o.scopes &&
      callback_url == o.callback_url &&
      authorize_url == o.authorize_url &&
      token_fetch_url == o.token_fetch_url &&
       == o. &&
      discovery_url == o.discovery_url &&
      token_introspection_url == o.token_introspection_url &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      client_secret == o.client_secret
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



482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 482

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


374
375
376
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 374

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



380
381
382
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 380

def hash
  [object, id, instance_id, name, client_id, public, scopes, callback_url, authorize_url, token_fetch_url, , discovery_url, token_introspection_url, created_at, updated_at, client_secret].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



249
250
251
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 249

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

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

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

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

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

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

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

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

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

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

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

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

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



458
459
460
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 458

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



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 464

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



452
453
454
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 452

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/clerk-http-client/models/oauth_application_with_secret.rb', line 317

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["oauth_application"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @instance_id.nil?
  return false if @name.nil?
  return false if @client_id.nil?
  return false if @public.nil?
  return false if @scopes.nil?
  return false if @callback_url.nil?
  return false if @authorize_url.nil?
  return false if @token_fetch_url.nil?
  return false if @user_info_url.nil?
  return false if @discovery_url.nil?
  return false if @token_introspection_url.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end