Class: SwaggerClient::UserDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/models/user_details.rb

Overview

User details

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/swagger_client/models/user_details.rb', line 155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#bio ⇒ Object

User’s biography



47
48
49
 
# File 'lib/swagger_client/models/user_details.rb', line 47

def bio
  @bio
end

#class_role ⇒ Object

Returns the value of attribute class_role.



41
42
43
 
# File 'lib/swagger_client/models/user_details.rb', line 41

def class_role
  @class_role
end

#followers_count ⇒ Object

Number of followers the user have



56
57
58
 
# File 'lib/swagger_client/models/user_details.rb', line 56

def followers_count
  @followers_count
end

#following_count ⇒ Object

Number of people the user follow



59
60
61
 
# File 'lib/swagger_client/models/user_details.rb', line 59

def following_count
  @following_count
end

#html_url ⇒ Object

Link to user profile (for Indiv. users only)



44
45
46
 
# File 'lib/swagger_client/models/user_details.rb', line 44

def html_url
  @html_url
end

#id ⇒ Object

Identifier of the user



19
20
21
 
# File 'lib/swagger_client/models/user_details.rb', line 19

def id
  @id
end

#instruments ⇒ Object

Returns the value of attribute instruments.



67
68
69
 
# File 'lib/swagger_client/models/user_details.rb', line 67

def instruments
  @instruments
end

#is_power_user ⇒ Object

User license status. ‘True’ if user is an individual Power user



34
35
36
 
# File 'lib/swagger_client/models/user_details.rb', line 34

def is_power_user
  @is_power_user
end

#liked_scores_count ⇒ Object

Number of the scores liked by the user



53
54
55
 
# File 'lib/swagger_client/models/user_details.rb', line 53

def liked_scores_count
  @liked_scores_count
end

#locale ⇒ Object

Returns the value of attribute locale.



75
76
77
 
# File 'lib/swagger_client/models/user_details.rb', line 75

def locale
  @locale
end

#name ⇒ Object

A displayable name for the user



25
26
27
 
# File 'lib/swagger_client/models/user_details.rb', line 25

def name
  @name
end

#organization ⇒ Object

Organization ID (for Edu users only)



37
38
39
 
# File 'lib/swagger_client/models/user_details.rb', line 37

def organization
  @organization
end

#organization_role ⇒ Object

Returns the value of attribute organization_role.



39
40
41
 
# File 'lib/swagger_client/models/user_details.rb', line 39

def organization_role
  @organization_role
end

#owned_public_scores_count ⇒ Object

Number of public scores the user have



62
63
64
 
# File 'lib/swagger_client/models/user_details.rb', line 62

def owned_public_scores_count
  @owned_public_scores_count
end

#picture ⇒ Object

User pictue



31
32
33
 
# File 'lib/swagger_client/models/user_details.rb', line 31

def picture
  @picture
end

#printable_name ⇒ Object

The name that can be directly printed (name or username)



28
29
30
 
# File 'lib/swagger_client/models/user_details.rb', line 28

def printable_name
  @printable_name
end

#private_profile ⇒ Object

Tell either this user profile is private or not (individual accounts only)



73
74
75
 
# File 'lib/swagger_client/models/user_details.rb', line 73

def private_profile
  @private_profile
end

#profile_theme ⇒ Object

Theme (background) for the profile



65
66
67
 
# File 'lib/swagger_client/models/user_details.rb', line 65

def profile_theme
  @profile_theme
end

#registration_date ⇒ Object

Date the user signed up



50
51
52
 
# File 'lib/swagger_client/models/user_details.rb', line 50

def registration_date
  @registration_date
end

#type ⇒ Object

The type of account



70
71
72
 
# File 'lib/swagger_client/models/user_details.rb', line 70

def type
  @type
end

#username ⇒ Object

The user name (unique for the organization)



22
23
24
 
# File 'lib/swagger_client/models/user_details.rb', line 22

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/swagger_client/models/user_details.rb', line 100

def self.attribute_map
  {
    :'id' => :'id',
    :'username' => :'username',
    :'name' => :'name',
    :'printable_name' => :'printableName',
    :'picture' => :'picture',
    :'is_power_user' => :'isPowerUser',
    :'organization' => :'organization',
    :'organization_role' => :'organizationRole',
    :'class_role' => :'classRole',
    :'html_url' => :'htmlUrl',
    :'bio' => :'bio',
    :'registration_date' => :'registrationDate',
    :'liked_scores_count' => :'likedScoresCount',
    :'followers_count' => :'followersCount',
    :'following_count' => :'followingCount',
    :'owned_public_scores_count' => :'ownedPublicScoresCount',
    :'profile_theme' => :'profileTheme',
    :'instruments' => :'instruments',
    :'type' => :'type',
    :'private_profile' => :'privateProfile',
    :'locale' => :'locale'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/swagger_client/models/user_details.rb', line 127

def self.swagger_types
  {
    :'id' => :'String',
    :'username' => :'String',
    :'name' => :'String',
    :'printable_name' => :'String',
    :'picture' => :'String',
    :'is_power_user' => :'BOOLEAN',
    :'organization' => :'String',
    :'organization_role' => :'OrganizationRoles',
    :'class_role' => :'ClassRoles',
    :'html_url' => :'String',
    :'bio' => :'String',
    :'registration_date' => :'DateTime',
    :'liked_scores_count' => :'Integer',
    :'followers_count' => :'Integer',
    :'following_count' => :'Integer',
    :'owned_public_scores_count' => :'Integer',
    :'profile_theme' => :'String',
    :'instruments' => :'UserInstruments',
    :'type' => :'String',
    :'private_profile' => :'BOOLEAN',
    :'locale' => :'FlatLocales'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/swagger_client/models/user_details.rb', line 274

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      username == o.username &&
      name == o.name &&
      printable_name == o.printable_name &&
      picture == o.picture &&
      is_power_user == o.is_power_user &&
      organization == o.organization &&
      organization_role == o.organization_role &&
      class_role == o.class_role &&
      html_url == o.html_url &&
      bio == o.bio &&
      registration_date == o.registration_date &&
      liked_scores_count == o.liked_scores_count &&
      followers_count == o.followers_count &&
      following_count == o.following_count &&
      owned_public_scores_count == o.owned_public_scores_count &&
      profile_theme == o.profile_theme &&
      instruments == o.instruments &&
      type == o.type &&
      private_profile == o.private_profile &&
      locale == o.locale
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



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
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/swagger_client/models/user_details.rb', line 336

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



402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/swagger_client/models/user_details.rb', line 402

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/swagger_client/models/user_details.rb', line 315

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


302
303
304
 
# File 'lib/swagger_client/models/user_details.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



308
309
310
 
# File 'lib/swagger_client/models/user_details.rb', line 308

def hash
  [id, username, name, printable_name, picture, is_power_user, organization, organization_role, class_role, html_url, bio, registration_date, liked_scores_count, followers_count, following_count, owned_public_scores_count, profile_theme, instruments, type, private_profile, locale].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



249
250
251
252
 
# File 'lib/swagger_client/models/user_details.rb', line 249

def list_invalid_properties
  invalid_properties = Array.new
  return 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



382
383
384
 
# File 'lib/swagger_client/models/user_details.rb', line 382

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



388
389
390
391
392
393
394
395
396
 
# File 'lib/swagger_client/models/user_details.rb', line 388

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



376
377
378
 
# File 'lib/swagger_client/models/user_details.rb', line 376

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



256
257
258
259
260
 
# File 'lib/swagger_client/models/user_details.rb', line 256

def valid?
  type_validator = EnumAttributeValidator.new('String', ["user", "guest"])
  return false unless type_validator.valid?(@type)
  return true
end