Class: Zyphr::AuthUser

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/models/auth_user.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zyphr/models/auth_user.rb', line 144

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::AuthUser` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::AuthUser`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#anonymous_device_id ⇒ Object

Per-device identifier supplied at anonymous sign-in. Preserved across conversion so client-side "this device has scores from me" detection survives the upgrade. NULL for users who never signed in anonymously.



42
43
44
 
# File 'lib/zyphr/models/auth_user.rb', line 42

def anonymous_device_id
  @anonymous_device_id
end

#avatar_url ⇒ Object

Returns the value of attribute avatar_url.



26
27
28
 
# File 'lib/zyphr/models/auth_user.rb', line 26

def avatar_url
  @avatar_url
end

#created_at ⇒ Object

Returns the value of attribute created_at.



47
48
49
 
# File 'lib/zyphr/models/auth_user.rb', line 47

def created_at
  @created_at
end

#email ⇒ Object

Returns the value of attribute email.



20
21
22
 
# File 'lib/zyphr/models/auth_user.rb', line 20

def email
  @email
end

#email_verified ⇒ Object

Returns the value of attribute email_verified.



24
25
26
 
# File 'lib/zyphr/models/auth_user.rb', line 24

def email_verified
  @email_verified
end

#first_activity_at ⇒ Object

Set on the user’s first authenticated request after anonymous sign-in (excluding /auth/refresh). MAU billing for anonymous-origin users keys off this timestamp instead of created_at.



45
46
47
 
# File 'lib/zyphr/models/auth_user.rb', line 45

def first_activity_at
  @first_activity_at
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/zyphr/models/auth_user.rb', line 18

def id
  @id
end

#is_anonymous ⇒ Object

True if the user signed in anonymously and has not yet been converted to a full account.



39
40
41
 
# File 'lib/zyphr/models/auth_user.rb', line 39

def is_anonymous
  @is_anonymous
end

#last_login_at ⇒ Object

Returns the value of attribute last_login_at.



51
52
53
 
# File 'lib/zyphr/models/auth_user.rb', line 51

def 
  @last_login_at
end

#metadata ⇒ Object

Returns the value of attribute metadata.



28
29
30
 
# File 'lib/zyphr/models/auth_user.rb', line 28

def metadata
  @metadata
end

#mfa_enabled ⇒ Object

Returns the value of attribute mfa_enabled.



36
37
38
 
# File 'lib/zyphr/models/auth_user.rb', line 36

def mfa_enabled
  @mfa_enabled
end

#name ⇒ Object

Returns the value of attribute name.



22
23
24
 
# File 'lib/zyphr/models/auth_user.rb', line 22

def name
  @name
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



30
31
32
 
# File 'lib/zyphr/models/auth_user.rb', line 30

def phone_number
  @phone_number
end

#phone_verified ⇒ Object

Returns the value of attribute phone_verified.



32
33
34
 
# File 'lib/zyphr/models/auth_user.rb', line 32

def phone_verified
  @phone_verified
end

#status ⇒ Object

Returns the value of attribute status.



34
35
36
 
# File 'lib/zyphr/models/auth_user.rb', line 34

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



49
50
51
 
# File 'lib/zyphr/models/auth_user.rb', line 49

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/zyphr/models/auth_user.rb', line 314

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 = Zyphr.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



98
99
100
 
# File 'lib/zyphr/models/auth_user.rb', line 98

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/zyphr/models/auth_user.rb', line 103

def self.acceptable_attributes
  acceptable_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/zyphr/models/auth_user.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'name' => :'name',
    :'email_verified' => :'email_verified',
    :'avatar_url' => :'avatar_url',
    :'metadata' => :'metadata',
    :'phone_number' => :'phone_number',
    :'phone_verified' => :'phone_verified',
    :'status' => :'status',
    :'mfa_enabled' => :'mfa_enabled',
    :'is_anonymous' => :'is_anonymous',
    :'anonymous_device_id' => :'anonymous_device_id',
    :'first_activity_at' => :'first_activity_at',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'last_login_at' => :'last_login_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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/zyphr/models/auth_user.rb', line 290

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



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/zyphr/models/auth_user.rb', line 130

def self.openapi_nullable
  Set.new([
    :'email',
    :'name',
    :'avatar_url',
    :'phone_number',
    :'anonymous_device_id',
    :'first_activity_at',
    :'last_login_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/zyphr/models/auth_user.rb', line 108

def self.openapi_types
  {
    :'id' => :'String',
    :'email' => :'String',
    :'name' => :'String',
    :'email_verified' => :'Boolean',
    :'avatar_url' => :'String',
    :'metadata' => :'Hash<String, Object>',
    :'phone_number' => :'String',
    :'phone_verified' => :'Boolean',
    :'status' => :'String',
    :'mfa_enabled' => :'Boolean',
    :'is_anonymous' => :'Boolean',
    :'anonymous_device_id' => :'String',
    :'first_activity_at' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'last_login_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/zyphr/models/auth_user.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      name == o.name &&
      email_verified == o.email_verified &&
      avatar_url == o.avatar_url &&
      metadata == o.metadata &&
      phone_number == o.phone_number &&
      phone_verified == o.phone_verified &&
      status == o.status &&
      mfa_enabled == o.mfa_enabled &&
      is_anonymous == o.is_anonymous &&
      anonymous_device_id == o.anonymous_device_id &&
      first_activity_at == o.first_activity_at &&
      created_at == o.created_at &&
      updated_at == o.updated_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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/zyphr/models/auth_user.rb', line 385

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


277
278
279
 
# File 'lib/zyphr/models/auth_user.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/zyphr/models/auth_user.rb', line 283

def hash
  [id, email, name, email_verified, avatar_url, metadata, phone_number, phone_verified, status, mfa_enabled, is_anonymous, anonymous_device_id, first_activity_at, created_at, updated_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



227
228
229
230
231
 
# File 'lib/zyphr/models/auth_user.rb', line 227

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



361
362
363
 
# File 'lib/zyphr/models/auth_user.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/zyphr/models/auth_user.rb', line 367

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



355
356
357
 
# File 'lib/zyphr/models/auth_user.rb', line 355

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



235
236
237
238
239
240
 
# File 'lib/zyphr/models/auth_user.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["active", "inactive", "deleted"])
  return false unless status_validator.valid?(@status)
  true
end