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



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
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/talon_one/models/user.rb', line 124

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?(:'invite_token')
    self.invite_token = attributes[:'invite_token']
  end

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

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

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

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

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

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

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

#application_notification_subscriptions ⇒ Object

Returns the value of attribute application_notification_subscriptions.



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

def application_notification_subscriptions
  @application_notification_subscriptions
end

#auth_method ⇒ Object

The Authentication method for this user.



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

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 your account.



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

Invite token, empty if the user as already accepted their invite.



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

def invite_token
  @invite_token
end

#latest_feed_timestamp ⇒ Object

Latest timestamp the user has been notified for feed.



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

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

Full name



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

def name
  @name
end

#policy ⇒ Object

User ACL Policy



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

def policy
  @policy
end

#roles ⇒ Object

Contains a list of all roles the user is a member of.



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

def roles
  @roles
end

#state ⇒ Object

Current user state.



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.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one/models/user.rb', line 79

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



297
298
299
 
# File 'lib/talon_one/models/user.rb', line 297

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/talon_one/models/user.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/talon_one/models/user.rb', line 98

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/talon_one/models/user.rb', line 264

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. &&
      invite_token == o.invite_token &&
      state == o.state &&
      name == o.name &&
      policy == o.policy &&
      latest_feed_timestamp == o.latest_feed_timestamp &&
      roles == o.roles &&
      application_notification_subscriptions == o.application_notification_subscriptions &&
      auth_method == o.auth_method
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



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
352
353
354
355
356
357
358
359
360
 
# File 'lib/talon_one/models/user.rb', line 325

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/talon_one/models/user.rb', line 394

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



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

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


284
285
286
 
# File 'lib/talon_one/models/user.rb', line 284

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



290
291
292
 
# File 'lib/talon_one/models/user.rb', line 290

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



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

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

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

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



370
371
372
 
# File 'lib/talon_one/models/user.rb', line 370

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/talon_one/models/user.rb', line 376

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



364
365
366
 
# File 'lib/talon_one/models/user.rb', line 364

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/talon_one/models/user.rb', line 237

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 @invite_token.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["invited", "active", "deactivated"])
  return false unless state_validator.valid?(@state)
  return false if @name.nil?
  return false if @policy.nil?
  true
end