Class: WhiteLabelMachineName::AbstractHumanUserUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AbstractHumanUserUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 76

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

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

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

Instance Attribute Details

#email_address ⇒ Object

The email address of the user.



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

def email_address
  @email_address
end

#firstname ⇒ Object

The first name of the user.



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

def firstname
  @firstname
end

#language ⇒ Object

The preferred language of the user.



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

def language
  @language
end

#lastname ⇒ Object

The last name of the user.



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

def lastname
  @lastname
end

#mobile_phone_number ⇒ Object

Returns the value of attribute mobile_phone_number.



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

def mobile_phone_number
  @mobile_phone_number
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
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.



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

def time_zone
  @time_zone
end

#two_factor_enabled ⇒ Object

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



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

def two_factor_enabled
  @two_factor_enabled
end

Class Method Details

.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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 47

def self.attribute_map
  {
    :'email_address' => :'emailAddress',
    :'firstname' => :'firstname',
    :'language' => :'language',
    :'lastname' => :'lastname',
    :'mobile_phone_number' => :'mobilePhoneNumber',
    :'state' => :'state',
    :'time_zone' => :'timeZone',
    :'two_factor_enabled' => :'twoFactorEnabled'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'email_address' => :'String',
    :'firstname' => :'String',
    :'language' => :'String',
    :'lastname' => :'String',
    :'mobile_phone_number' => :'String',
    :'state' => :'CreationEntityState',
    :'time_zone' => :'String',
    :'two_factor_enabled' => :'BOOLEAN'
  }
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/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 190

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



239
240
241
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 239

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 218

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


205
206
207
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 211

def hash
  [email_address, firstname, language, lastname, mobile_phone_number, state, time_zone, two_factor_enabled].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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 117

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



285
286
287
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 291

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



279
280
281
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 279

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



140
141
142
143
144
145
146
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_human_user_update.rb', line 140

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