Class: Zitadel::Client::Models::UserServiceHumanUser

Inherits:
Object
  • Object
show all
Defined in:
lib/zitadel/client/models/user_service_human_user.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserServiceHumanUser

Initializes the object



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
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
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 121

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    # MODIFIED: Updated class name in error message
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zitadel::Client::Models::UserServiceHumanUser` 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))
      # MODIFIED: Updated class name in error message
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zitadel::Client::Models::UserServiceHumanUser`. 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?(:'user_id')
    self.user_id = attributes[:'user_id']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'USER_STATE_UNSPECIFIED'
  end

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

  if attributes.key?(:'login_names')
    if (value = attributes[:'login_names']).is_a?(Array)
      self. = value
    end
  end

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

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

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

Returns the value of attribute email.



34
35
36
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 34

def email
  @email
end

#login_names ⇒ Object

Possible usable login names for the user.



27
28
29
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 27

def 
  @login_names
end

#mfa_init_skipped ⇒ Object

The time the user last skipped MFA initialization.



45
46
47
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 45

def mfa_init_skipped
  @mfa_init_skipped
end

#password_change_required ⇒ Object

User is required to change the used password on the next login.



39
40
41
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 39

def password_change_required
  @password_change_required
end

#password_changed ⇒ Object

The time the user last changed their password.



42
43
44
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 42

def password_changed
  @password_changed
end

#phone ⇒ Object

Returns the value of attribute phone.



36
37
38
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 36

def phone
  @phone
end

#preferred_login_name ⇒ Object

Preferred login name of the user.



30
31
32
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 30

def 
  @preferred_login_name
end

#profile ⇒ Object

Returns the value of attribute profile.



32
33
34
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 32

def profile
  @profile
end

#state ⇒ Object

Returns the value of attribute state.



21
22
23
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 21

def state
  @state
end

#user_id ⇒ Object

Unique identifier of the user.



19
20
21
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 19

def user_id
  @user_id
end

#username ⇒ Object

Username of the user, which can be globally unique or unique on organization level.



24
25
26
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 24

def username
  @username
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



258
259
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
297
298
299
300
301
302
303
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 258

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf/anyOf constructs that resolve to a model name
    # MODIFIED: Ensure model is looked up in the Models namespace
    # 'type' here is expected to be the simple class name (e.g., "User", "OrderDetails")
    klass = Zitadel::Client::Models.const_get(type)
    # The `klass.build` method is for oneOf/anyOf types (defined in partial_oneof_module.mustache / partial_anyof_module.mustache)
    # The `klass.build_from_hash` is for regular model types (defined in this base_object.mustache itself)
    if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_allOf)
      klass.build(value) # For oneOf/anyOf/allOf, delegate to their specific build method
    else
      klass.build_from_hash(value) # For regular models
    end
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



87
88
89
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 87

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 92

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 70

def self.attribute_map
  {
    :'user_id' => :'userId',
    :'state' => :'state',
    :'username' => :'username',
    :'login_names' => :'loginNames',
    :'preferred_login_name' => :'preferredLoginName',
    :'profile' => :'profile',
    :'email' => :'email',
    :'phone' => :'phone',
    :'password_change_required' => :'passwordChangeRequired',
    :'password_changed' => :'passwordChanged',
    :'mfa_init_skipped' => :'mfaInitSkipped'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 234

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) # `new` will call the initialize method of the specific model class.
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 114

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 97

def self.openapi_types
  {
    :'user_id' => :'String',
    :'state' => :'UserServiceUserState',
    :'username' => :'String',
    :'login_names' => :'Array<String>',
    :'preferred_login_name' => :'String',
    :'profile' => :'UserServiceHumanProfile',
    :'email' => :'UserServiceHumanEmail',
    :'phone' => :'UserServiceHumanPhone',
    :'password_change_required' => :'Boolean',
    :'password_changed' => :'Time',
    :'mfa_init_skipped' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      state == o.state &&
      username == o.username &&
       == o. &&
       == o. &&
      profile == o.profile &&
      email == o.email &&
      phone == o.phone &&
      password_change_required == o.password_change_required &&
      password_changed == o.password_changed &&
      mfa_init_skipped == o.mfa_init_skipped
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 337

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


221
222
223
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



227
228
229
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 227

def hash
  [user_id, state, username, , , profile, email, phone, password_change_required, password_changed, mfa_init_skipped].hash
end

#list_invalid_properties ⇒ Object

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



188
189
190
191
192
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 188

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



313
314
315
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 313

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 319

def to_hash
  hash = {} # Calls super.to_hash if parent exists
  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

#to_s ⇒ String

Returns the string representation of the object



307
308
309
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 307

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



196
197
198
199
 
# File 'lib/zitadel/client/models/user_service_human_user.rb', line 196

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end