Class: WhiteLabelMachineName::HumanUser

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/human_user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HumanUser

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#email_address ⇒ Object

The email address of the user.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 24

def email_address
  @email_address
end

#email_address_verified ⇒ Object

Defines whether a user is verified or not.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 27

def email_address_verified
  @email_address_verified
end

#firstname ⇒ Object

The first name of the user.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 30

def firstname
  @firstname
end

#language ⇒ Object

The preferred language of the user.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 33

def language
  @language
end

#lastname ⇒ Object

The last name of the user.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 36

def lastname
  @lastname
end

#mobile_phone_number ⇒ Object

Returns the value of attribute mobile_phone_number.



39
40
41
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 39

def mobile_phone_number
  @mobile_phone_number
end

#mobile_phone_verified ⇒ Object

Defines whether a users mobile phone number is verified or not.



42
43
44
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 42

def mobile_phone_verified
  @mobile_phone_verified
end

#primary_account ⇒ Object

The primary account links the user to a specific account.



45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 45

def 
  @primary_account
end

#scope ⇒ Object

The scope to which the user belongs to.



48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 48

def scope
  @scope
end

#time_zone ⇒ Object

The time zone which is applied for the user. If no timezone is specified the browser is used to determine an appropriate time zone.



51
52
53
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 51

def time_zone
  @time_zone
end

#two_factor_enabled ⇒ Object

Defines whether two-factor authentication is enabled for this user.



54
55
56
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 54

def two_factor_enabled
  @two_factor_enabled
end

#two_factor_type ⇒ Object

Returns the value of attribute two_factor_type.



57
58
59
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 57

def two_factor_type
  @two_factor_type
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 60

def self.attribute_map
  {
    :'email_address' => :'emailAddress',
    :'email_address_verified' => :'emailAddressVerified',
    :'firstname' => :'firstname',
    :'language' => :'language',
    :'lastname' => :'lastname',
    :'mobile_phone_number' => :'mobilePhoneNumber',
    :'mobile_phone_verified' => :'mobilePhoneVerified',
    :'primary_account' => :'primaryAccount',
    :'scope' => :'scope',
    :'time_zone' => :'timeZone',
    :'two_factor_enabled' => :'twoFactorEnabled',
    :'two_factor_type' => :'twoFactorType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 78

def self.swagger_types
  {
    :'email_address' => :'String',
    :'email_address_verified' => :'BOOLEAN',
    :'firstname' => :'String',
    :'language' => :'String',
    :'lastname' => :'String',
    :'mobile_phone_number' => :'String',
    :'mobile_phone_verified' => :'BOOLEAN',
    :'primary_account' => :'Account',
    :'scope' => :'Scope',
    :'time_zone' => :'String',
    :'two_factor_enabled' => :'BOOLEAN',
    :'two_factor_type' => :'TwoFactorAuthenticationType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email_address == o.email_address &&
      email_address_verified == o.email_address_verified &&
      firstname == o.firstname &&
      language == o.language &&
      lastname == o.lastname &&
      mobile_phone_number == o.mobile_phone_number &&
      mobile_phone_verified == o.mobile_phone_verified &&
       == o. &&
      scope == o.scope &&
      time_zone == o.time_zone &&
      two_factor_enabled == o.two_factor_enabled &&
      two_factor_type == o.two_factor_type
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 280

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 346

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 259

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 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


246
247
248
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 252

def hash
  [email_address, email_address_verified, firstname, language, lastname, mobile_phone_number, mobile_phone_verified, , scope, time_zone, two_factor_enabled, two_factor_type].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/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 154

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

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

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

  if !@mobile_phone_number.nil? && @mobile_phone_number.to_s.length > 30
    invalid_properties.push('invalid value for "mobile_phone_number", the character length must be smaller than or equal to 30.')
  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



326
327
328
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 326

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 332

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



320
321
322
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 320

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/whitelabelmachinename-ruby-sdk/models/human_user.rb', line 177

def valid?
  return false if !@email_address.nil? && @email_address.to_s.length > 128
  return false if !@firstname.nil? && @firstname.to_s.length > 100
  return false if !@lastname.nil? && @lastname.to_s.length > 100
  return false if !@mobile_phone_number.nil? && @mobile_phone_number.to_s.length > 30
  true
end