Class: LinodeOpenapiClient::User

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

Overview

A User on your Account. Unrestricted users can log in and access information about your Account, while restricted users may only access entities or perform actions they’ve been granted access to.

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



86
87
88
89
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/linode_openapi_client/models/user.rb', line 86

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

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

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

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

The email address for the User. Linode sends emails to this address for account management communications. May be used for other communications as configured.



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

def email
  @email
end

#last_login ⇒ Object

Returns the value of attribute last_login.



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

def 
  @last_login
end

#password_created ⇒ Object

Read-only The date and time when this User’s current password was created. User passwords are first created during the Account sign-up process, and updated using the [Reset Password](login.linode.com/forgot/password) webpage. ‘null` if this User has not created a password yet.



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

def password_created
  @password_created
end

#restricted ⇒ Object

If true, the User must be granted access to perform actions or access entities on this Account. Run [List a user’s grants](techdocs.akamai.com/linode-api/reference/get-user-grants) for details on how to configure grants for a restricted User.



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

def restricted
  @restricted
end

#ssh_keys ⇒ Object

Read-only A list of SSH Key labels added by this User. Users can add keys with the [Add an SSH key](techdocs.akamai.com/linode-api/reference/post-add-ssh-key) operation. These keys are deployed when this User is included in the ‘authorized_users` field of the following requests: - [Create a Linode](techdocs.akamai.com/linode-api/reference/post-linode-instance) - [Rebuild a Linode](techdocs.akamai.com/linode-api/reference/post-rebuild-linode-instance) - [Create a disk](techdocs.akamai.com/linode-api/reference/post-add-linode-disk)



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

def ssh_keys
  @ssh_keys
end

#tfa_enabled ⇒ Object

Read-only A boolean value indicating if the User has Two Factor Authentication (TFA) enabled. Run the [Create a two factor secret](techdocs.akamai.com/linode-api/reference/post-tfa-enable) operation to enable TFA.



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

def tfa_enabled
  @tfa_enabled
end

#username ⇒ Object

__Filterable__ The User’s username. This is used for logging in, and may also be displayed alongside actions the User performs (for example, in Events or public StackScripts).



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

def username
  @username
end

#verified_phone_number ⇒ Object

Read-only The phone number verified for this User Profile with the [Verify a phone number](techdocs.akamai.com/linode-api/reference/post-profile-phone-number-verify) operation. ‘null` if this User Profile has no verified phone number.



20
21
22
 
# File 'lib/linode_openapi_client/models/user.rb', line 20

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



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

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 = LinodeOpenapiClient.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



57
58
59
 
# File 'lib/linode_openapi_client/models/user.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/linode_openapi_client/models/user.rb', line 43

def self.attribute_map
  {
    :'verified_phone_number' => :'verified_phone_number',
    :'last_login' => :'last_login',
    :'username' => :'username',
    :'restricted' => :'restricted',
    :'ssh_keys' => :'ssh_keys',
    :'email' => :'email',
    :'tfa_enabled' => :'tfa_enabled',
    :'password_created' => :'password_created'
  }
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/linode_openapi_client/models/user.rb', line 218

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



76
77
78
79
80
81
82
 
# File 'lib/linode_openapi_client/models/user.rb', line 76

def self.openapi_nullable
  Set.new([
    :'verified_phone_number',
    :'last_login',
    :'password_created'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/linode_openapi_client/models/user.rb', line 62

def self.openapi_types
  {
    :'verified_phone_number' => :'String',
    :'last_login' => :'PostUserRequestAllOfLastLogin',
    :'username' => :'String',
    :'restricted' => :'Boolean',
    :'ssh_keys' => :'Array<String>',
    :'email' => :'String',
    :'tfa_enabled' => :'Boolean',
    :'password_created' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/linode_openapi_client/models/user.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      verified_phone_number == o.verified_phone_number &&
       == o. &&
      username == o.username &&
      restricted == o.restricted &&
      ssh_keys == o.ssh_keys &&
      email == o.email &&
      tfa_enabled == o.tfa_enabled &&
      password_created == o.password_created
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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/linode_openapi_client/models/user.rb', line 313

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


205
206
207
 
# File 'lib/linode_openapi_client/models/user.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/linode_openapi_client/models/user.rb', line 211

def hash
  [verified_phone_number, , username, restricted, ssh_keys, email, tfa_enabled, password_created].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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/linode_openapi_client/models/user.rb', line 136

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@username.nil? && @username.to_s.length > 32
    invalid_properties.push('invalid value for "username", the character length must be smaller than or equal to 32.')
  end

  if !@username.nil? && @username.to_s.length < 3
    invalid_properties.push('invalid value for "username", the character length must be great than or equal to 3.')
  end

  pattern = Regexp.new(/^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$/)
  if !@username.nil? && @username !~ pattern
    invalid_properties.push("invalid value for \"username\", must conform to the pattern #{pattern}.")
  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



289
290
291
 
# File 'lib/linode_openapi_client/models/user.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/linode_openapi_client/models/user.rb', line 295

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



283
284
285
 
# File 'lib/linode_openapi_client/models/user.rb', line 283

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



157
158
159
160
161
162
163
 
# File 'lib/linode_openapi_client/models/user.rb', line 157

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@username.nil? && @username.to_s.length > 32
  return false if !@username.nil? && @username.to_s.length < 3
  return false if !@username.nil? && @username !~ Regexp.new(/^[a-zA-Z0-9]((?![_-]{2,})[a-zA-Z0-9-_])+[a-zA-Z0-9]$/)
  true
end