Class: TalonOne::User

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/user.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/talon_one/models/user.rb', line 145

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



31
32
33
 
# File 'lib/talon_one/models/user.rb', line 31

def 
  @account_id
end

#additional_attributes ⇒ Object

Additional user attributes, created and used by external identity providers.



67
68
69
 
# File 'lib/talon_one/models/user.rb', line 67

def additional_attributes
  @additional_attributes
end

#application_notification_subscriptions ⇒ Object

Application notifications that the user is subscribed to.



55
56
57
 
# File 'lib/talon_one/models/user.rb', line 55

def application_notification_subscriptions
  @application_notification_subscriptions
end

#auth_method ⇒ Object

Authentication method for this user.



52
53
54
 
# File 'lib/talon_one/models/user.rb', line 52

def auth_method
  @auth_method
end

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one/models/user.rb', line 22

def created
  @created
end

#email ⇒ Object

The email address associated with the user profile.



28
29
30
 
# File 'lib/talon_one/models/user.rb', line 28

def email
  @email
end

#id ⇒ Object

Internal ID of this entity.



19
20
21
 
# File 'lib/talon_one/models/user.rb', line 19

def id
  @id
end

#invite_token ⇒ Object

Invitation token of the user. Note: If the user has already accepted their invitation, this is ‘null`.



40
41
42
 
# File 'lib/talon_one/models/user.rb', line 40

def invite_token
  @invite_token
end

#is_admin ⇒ Object

Indicates whether the user is an ‘admin`.



43
44
45
 
# File 'lib/talon_one/models/user.rb', line 43

def is_admin
  @is_admin
end

#last_accessed ⇒ Object

Timestamp of the user’s last activity after signing in to Talon.One.



61
62
63
 
# File 'lib/talon_one/models/user.rb', line 61

def last_accessed
  @last_accessed
end

#last_signed_in ⇒ Object

Timestamp when the user last signed in to Talon.One.



58
59
60
 
# File 'lib/talon_one/models/user.rb', line 58

def last_signed_in
  @last_signed_in
end

#latest_feed_timestamp ⇒ Object

Timestamp when the user was notified for feed.



64
65
66
 
# File 'lib/talon_one/models/user.rb', line 64

def latest_feed_timestamp
  @latest_feed_timestamp
end

#modified ⇒ Object

The time this entity was last modified.



25
26
27
 
# File 'lib/talon_one/models/user.rb', line 25

def modified
  @modified
end

#name ⇒ Object

Name of the user.



34
35
36
 
# File 'lib/talon_one/models/user.rb', line 34

def name
  @name
end

#policy ⇒ Object

Access level of the user.



46
47
48
 
# File 'lib/talon_one/models/user.rb', line 46

def policy
  @policy
end

#roles ⇒ Object

A list of the IDs of the roles assigned to the user.



49
50
51
 
# File 'lib/talon_one/models/user.rb', line 49

def roles
  @roles
end

#state ⇒ Object

State of the user.



37
38
39
 
# File 'lib/talon_one/models/user.rb', line 37

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/talon_one/models/user.rb', line 92

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'modified' => :'modified',
    :'email' => :'email',
    :'account_id' => :'accountId',
    :'name' => :'name',
    :'state' => :'state',
    :'invite_token' => :'inviteToken',
    :'is_admin' => :'isAdmin',
    :'policy' => :'policy',
    :'roles' => :'roles',
    :'auth_method' => :'authMethod',
    :'application_notification_subscriptions' => :'applicationNotificationSubscriptions',
    :'last_signed_in' => :'lastSignedIn',
    :'last_accessed' => :'lastAccessed',
    :'latest_feed_timestamp' => :'latestFeedTimestamp',
    :'additional_attributes' => :'additionalAttributes'
  }
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



338
339
340
 
# File 'lib/talon_one/models/user.rb', line 338

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
 
# File 'lib/talon_one/models/user.rb', line 138

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

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/talon_one/models/user.rb', line 115

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'modified' => :'DateTime',
    :'email' => :'String',
    :'account_id' => :'Integer',
    :'name' => :'String',
    :'state' => :'String',
    :'invite_token' => :'String',
    :'is_admin' => :'Boolean',
    :'policy' => :'Object',
    :'roles' => :'Array<Integer>',
    :'auth_method' => :'String',
    :'application_notification_subscriptions' => :'Object',
    :'last_signed_in' => :'DateTime',
    :'last_accessed' => :'DateTime',
    :'latest_feed_timestamp' => :'DateTime',
    :'additional_attributes' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/talon_one/models/user.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      modified == o.modified &&
      email == o.email &&
       == o. &&
      name == o.name &&
      state == o.state &&
      invite_token == o.invite_token &&
      is_admin == o.is_admin &&
      policy == o.policy &&
      roles == o.roles &&
      auth_method == o.auth_method &&
      application_notification_subscriptions == o.application_notification_subscriptions &&
      last_signed_in == o.last_signed_in &&
      last_accessed == o.last_accessed &&
      latest_feed_timestamp == o.latest_feed_timestamp &&
      additional_attributes == o.additional_attributes
end

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



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
395
396
397
398
399
400
401
 
# File 'lib/talon_one/models/user.rb', line 366

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    TalonOne.const_get(type).build_from_hash(value)
  end
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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/talon_one/models/user.rb', line 435

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

#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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/talon_one/models/user.rb', line 345

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


325
326
327
 
# File 'lib/talon_one/models/user.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



331
332
333
 
# File 'lib/talon_one/models/user.rb', line 331

def hash
  [id, created, modified, email, , name, state, invite_token, is_admin, policy, roles, auth_method, application_notification_subscriptions, last_signed_in, last_accessed, latest_feed_timestamp, additional_attributes].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



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
 
# File 'lib/talon_one/models/user.rb', line 231

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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



411
412
413
 
# File 'lib/talon_one/models/user.rb', line 411

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/talon_one/models/user.rb', line 417

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



405
406
407
 
# File 'lib/talon_one/models/user.rb', line 405

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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/talon_one/models/user.rb', line 274

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @modified.nil?
  return false if @email.nil?
  return false if @account_id.nil?
  return false if @name.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["invited", "active", "deactivated"])
  return false unless state_validator.valid?(@state)
  return false if @invite_token.nil?
  return false if @policy.nil?
  true
end