Class: ZoomUs::Models::User

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

Overview

The user object represents a specific user on Zoom.

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



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/zoom_us/models/user.rb', line 93

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.has_key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  else
    self.email = '[email protected]'
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'role_name')
    self.role_name = attributes[:'role_name']
  end

  if attributes.has_key?(:'pmi')
    self.pmi = attributes[:'pmi']
  end

  if attributes.has_key?(:'use_pmi')
    self.use_pmi = attributes[:'use_pmi']
  else
    self.use_pmi = false
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'dept')
    self.dept = attributes[:'dept']
  end

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

  if attributes.has_key?(:'last_login_time')
    self. = attributes[:'last_login_time']
  end

  if attributes.has_key?(:'last_client_version')
    self.last_client_version = attributes[:'last_client_version']
  end
end

Instance Attribute Details

#created_at ⇒ Object

User create time.



47
48
49
 
# File 'lib/zoom_us/models/user.rb', line 47

def created_at
  @created_at
end

#dept ⇒ Object

Department.



44
45
46
 
# File 'lib/zoom_us/models/user.rb', line 44

def dept
  @dept
end

#email ⇒ Object

User’s email address.



26
27
28
 
# File 'lib/zoom_us/models/user.rb', line 26

def email
  @email
end

#first_name ⇒ Object

User’s first name.



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

def first_name
  @first_name
end

#last_client_version ⇒ Object

User last login client version.



53
54
55
 
# File 'lib/zoom_us/models/user.rb', line 53

def last_client_version
  @last_client_version
end

#last_login_time ⇒ Object

User last login time.



50
51
52
 
# File 'lib/zoom_us/models/user.rb', line 50

def 
  
end

#last_name ⇒ Object

User’s last name.



23
24
25
 
# File 'lib/zoom_us/models/user.rb', line 23

def last_name
  @last_name
end

#pmi ⇒ Object

Personal meeting ID.



35
36
37
 
# File 'lib/zoom_us/models/user.rb', line 35

def pmi
  @pmi
end

#role_name ⇒ Object

User’s [role](support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) name.



32
33
34
 
# File 'lib/zoom_us/models/user.rb', line 32

def role_name
  @role_name
end

#timezone ⇒ Object

The time zone of the user.



41
42
43
 
# File 'lib/zoom_us/models/user.rb', line 41

def timezone
  @timezone
end

#type ⇒ Object

User’s plan type:
‘1` - Basic.
`2` - Licensed.
`3` - On-prem.



29
30
31
 
# File 'lib/zoom_us/models/user.rb', line 29

def type
  @type
end

#use_pmi ⇒ Object

Use Personal Meeting ID for instant meetings.



38
39
40
 
# File 'lib/zoom_us/models/user.rb', line 38

def use_pmi
  @use_pmi
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/zoom_us/models/user.rb', line 56

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'email' => :'email',
    :'type' => :'type',
    :'role_name' => :'role_name',
    :'pmi' => :'pmi',
    :'use_pmi' => :'use_pmi',
    :'timezone' => :'timezone',
    :'dept' => :'dept',
    :'created_at' => :'created_at',
    :'last_login_time' => :'last_login_time',
    :'last_client_version' => :'last_client_version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/zoom_us/models/user.rb', line 74

def self.swagger_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'type' => :'Integer',
    :'role_name' => :'String',
    :'pmi' => :'Integer',
    :'use_pmi' => :'BOOLEAN',
    :'timezone' => :'String',
    :'dept' => :'String',
    :'created_at' => :'DateTime',
    :'last_login_time' => :'DateTime',
    :'last_client_version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/zoom_us/models/user.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    first_name == o.first_name &&
    last_name == o.last_name &&
    email == o.email &&
    type == o.type &&
    role_name == o.role_name &&
    pmi == o.pmi &&
    use_pmi == o.use_pmi &&
    timezone == o.timezone &&
    dept == o.dept &&
    created_at == o.created_at &&
     == o. &&
    last_client_version == o.last_client_version
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/zoom_us/models/user.rb', line 260

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
    temp_model = Models.const_get(type).new
    temp_model.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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/zoom_us/models/user.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/zoom_us/models/user.rb', line 239

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


226
227
228
 
# File 'lib/zoom_us/models/user.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/zoom_us/models/user.rb', line 232

def hash
  [first_name, last_name, email, type, role_name, pmi, use_pmi, timezone, dept, created_at, , last_client_version].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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/zoom_us/models/user.rb', line 154

def list_invalid_properties
  invalid_properties = Array.new
  if !@first_name.nil? && @first_name.to_s.length > 64
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 64.')
  end

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

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

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



306
307
308
 
# File 'lib/zoom_us/models/user.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/zoom_us/models/user.rb', line 312

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



300
301
302
 
# File 'lib/zoom_us/models/user.rb', line 300

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



177
178
179
180
181
182
183
 
# File 'lib/zoom_us/models/user.rb', line 177

def valid?
  return false if !@first_name.nil? && @first_name.to_s.length > 64
  return false if !@last_name.nil? && @last_name.to_s.length > 64
  return false if @email.nil?
  return false if @type.nil?
  true
end