Class: SmplkitGeneratedClient::App::User

Inherits:
ApiModelBase show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb

Overview

A person with access to one or more accounts in smplkit.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ User

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 101

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

UUID of the account the user is acting within.



41
42
43
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 41

def 
  @account
end

#auth_provider ⇒ Object

Identity provider that authenticates the user, e.g. ‘google`, `microsoft`, or `email`.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 32

def auth_provider
  @auth_provider
end

#avatar_url ⇒ Object

Server-generated ‘data:` URL containing the user’s avatar image bytes when one has been captured. ‘null` when no avatar is available — callers should fall back to Gravatar or initials.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 29

def avatar_url
  @avatar_url
end

#created_at ⇒ Object

When the user record was created.



44
45
46
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 44

def created_at
  @created_at
end

#display_name ⇒ Object

Human-readable display name shown in the console and on shared resources.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 23

def display_name
  @display_name
end

#email ⇒ Object

Email address used to sign in to the user account.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 20

def email
  @email
end

#email_verified ⇒ Object

Whether the user has completed email verification.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 35

def email_verified
  @email_verified
end

#profile_pic ⇒ Object

URL of an external profile picture (e.g. the value supplied by the user’s identity provider).



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 26

def profile_pic
  @profile_pic
end

#role ⇒ Object

Role the user holds in the current account context. One of ‘OWNER`, `ADMIN`, `MEMBER`, or `VIEWER`.



38
39
40
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 38

def role
  @role
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 47

def self.attribute_map
  {
    :'email' => :'email',
    :'display_name' => :'display_name',
    :'profile_pic' => :'profile_pic',
    :'avatar_url' => :'avatar_url',
    :'auth_provider' => :'auth_provider',
    :'email_verified' => :'email_verified',
    :'role' => :'role',
    :'account' => :'account',
    :'created_at' => :'created_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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 241

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



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 87

def self.openapi_nullable
  Set.new([
    :'email',
    :'profile_pic',
    :'avatar_url',
    :'auth_provider',
    :'role',
    :'account',
    :'created_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 72

def self.openapi_types
  {
    :'email' => :'String',
    :'display_name' => :'String',
    :'profile_pic' => :'String',
    :'avatar_url' => :'String',
    :'auth_provider' => :'String',
    :'email_verified' => :'Boolean',
    :'role' => :'String',
    :'account' => :'String',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      display_name == o.display_name &&
      profile_pic == o.profile_pic &&
      avatar_url == o.avatar_url &&
      auth_provider == o.auth_provider &&
      email_verified == o.email_verified &&
      role == o.role &&
       == o. &&
      created_at == o.created_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


228
229
230
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 234

def hash
  [email, display_name, profile_pic, avatar_url, auth_provider, email_verified, role, , created_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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @display_name.nil?
    invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
  end

  if @display_name.to_s.length > 255
    invalid_properties.push('invalid value for "display_name", the character length must be smaller than or equal to 255.')
  end

  if !@profile_pic.nil? && @profile_pic.to_s.length > 2048
    invalid_properties.push('invalid value for "profile_pic", the character length must be smaller than or equal to 2048.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 263

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



178
179
180
181
182
183
184
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb', line 178

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @display_name.nil?
  return false if @display_name.to_s.length > 255
  return false if !@profile_pic.nil? && @profile_pic.to_s.length > 2048
  true
end