Class: ClerkHttpClient::SignUp

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignUp

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
246
247
248
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
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 172

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#abandon_at ⇒ Object

Returns the value of attribute abandon_at.



60
61
62
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 60

def abandon_at
  @abandon_at
end

#created_session_id ⇒ Object

Returns the value of attribute created_session_id.



56
57
58
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 56

def created_session_id
  @created_session_id
end

#created_user_id ⇒ Object

Returns the value of attribute created_user_id.



58
59
60
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 58

def created_user_id
  @created_user_id
end

#custom_action ⇒ Object

Returns the value of attribute custom_action.



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

def custom_action
  @custom_action
end

#email_address ⇒ Object

Returns the value of attribute email_address.



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

def email_address
  @email_address
end

#external_account ⇒ Object

Returns the value of attribute external_account.



65
66
67
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 65

def 
  @external_account
end

#external_id ⇒ Object

Returns the value of attribute external_id.



54
55
56
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 54

def external_id
  @external_id
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#legal_accepted_at ⇒ Object

Unix timestamp at which the user accepted the legal requirements.



63
64
65
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 63

def legal_accepted_at
  @legal_accepted_at
end

#missing_fields ⇒ Object

Returns the value of attribute missing_fields.



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

def missing_fields
  @missing_fields
end

#object ⇒ Object

Returns the value of attribute object.



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

def object
  @object
end

#optional_fields ⇒ Object

Returns the value of attribute optional_fields.



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

def optional_fields
  @optional_fields
end

#password_enabled ⇒ Object

Returns the value of attribute password_enabled.



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

def password_enabled
  @password_enabled
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#public_metadata ⇒ Object

Returns the value of attribute public_metadata.



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

def public_metadata
  @public_metadata
end

#required_fields ⇒ Object

Returns the value of attribute required_fields.



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

def required_fields
  @required_fields
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#unsafe_metadata ⇒ Object

Returns the value of attribute unsafe_metadata.



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

def unsafe_metadata
  @unsafe_metadata
end

#unverified_fields ⇒ Object

Returns the value of attribute unverified_fields.



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

def unverified_fields
  @unverified_fields
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

#verifications ⇒ Object

Returns the value of attribute verifications.



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

def verifications
  @verifications
end

#web3_wallet ⇒ Object

Returns the value of attribute web3_wallet.



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

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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 445

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



120
121
122
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 120

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'status' => :'status',
    :'required_fields' => :'required_fields',
    :'optional_fields' => :'optional_fields',
    :'missing_fields' => :'missing_fields',
    :'unverified_fields' => :'unverified_fields',
    :'verifications' => :'verifications',
    :'username' => :'username',
    :'email_address' => :'email_address',
    :'phone_number' => :'phone_number',
    :'web3_wallet' => :'web3_wallet',
    :'password_enabled' => :'password_enabled',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'unsafe_metadata' => :'unsafe_metadata',
    :'public_metadata' => :'public_metadata',
    :'custom_action' => :'custom_action',
    :'external_id' => :'external_id',
    :'created_session_id' => :'created_session_id',
    :'created_user_id' => :'created_user_id',
    :'abandon_at' => :'abandon_at',
    :'legal_accepted_at' => :'legal_accepted_at',
    :'external_account' => :'external_account'
  }
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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 421

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 155

def self.openapi_nullable
  Set.new([
    :'username',
    :'email_address',
    :'phone_number',
    :'web3_wallet',
    :'first_name',
    :'last_name',
    :'external_id',
    :'created_session_id',
    :'created_user_id',
    :'legal_accepted_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'status' => :'String',
    :'required_fields' => :'Array<String>',
    :'optional_fields' => :'Array<String>',
    :'missing_fields' => :'Array<String>',
    :'unverified_fields' => :'Array<String>',
    :'verifications' => :'Object',
    :'username' => :'String',
    :'email_address' => :'String',
    :'phone_number' => :'String',
    :'web3_wallet' => :'String',
    :'password_enabled' => :'Boolean',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'unsafe_metadata' => :'Hash<String, Object>',
    :'public_metadata' => :'Hash<String, Object>',
    :'custom_action' => :'Boolean',
    :'external_id' => :'String',
    :'created_session_id' => :'String',
    :'created_user_id' => :'String',
    :'abandon_at' => :'Integer',
    :'legal_accepted_at' => :'Integer',
    :'external_account' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 377

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      status == o.status &&
      required_fields == o.required_fields &&
      optional_fields == o.optional_fields &&
      missing_fields == o.missing_fields &&
      unverified_fields == o.unverified_fields &&
      verifications == o.verifications &&
      username == o.username &&
      email_address == o.email_address &&
      phone_number == o.phone_number &&
      web3_wallet == o.web3_wallet &&
      password_enabled == o.password_enabled &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      unsafe_metadata == o.unsafe_metadata &&
      public_metadata == o.public_metadata &&
      custom_action == o.custom_action &&
      external_id == o.external_id &&
      created_session_id == o.created_session_id &&
      created_user_id == o.created_user_id &&
      abandon_at == o.abandon_at &&
      legal_accepted_at == o.legal_accepted_at &&
       == o.
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



516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 516

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


408
409
410
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 408

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



414
415
416
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 414

def hash
  [object, id, status, required_fields, optional_fields, missing_fields, unverified_fields, verifications, username, email_address, phone_number, web3_wallet, password_enabled, first_name, last_name, unsafe_metadata, public_metadata, custom_action, external_id, created_session_id, created_user_id, abandon_at, legal_accepted_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



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

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

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

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

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



492
493
494
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 492

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



498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 498

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



486
487
488
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 486

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/clerk-http-client/models/sign_up.rb', line 340

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["sign_up_attempt"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["missing_requirements", "complete", "abandoned"])
  return false unless status_validator.valid?(@status)
  return false if @password_enabled.nil?
  return false if @custom_action.nil?
  return false if @abandon_at.nil?
  true
end