Class: Zitadel::Client::Models::UserServiceSetHumanProfile

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserServiceSetHumanProfile

Initializes the object

Parameters:

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

    Models attributes in the form of hash



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

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::UserServiceSetHumanProfile` 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::UserServiceSetHumanProfile`. 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?(:'given_name')
    self.given_name = attributes[:'given_name']
  else
    self.given_name = nil
  end

  if attributes.key?(:'family_name')
    self.family_name = attributes[:'family_name']
  else
    self.family_name = nil
  end

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

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

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

  if attributes.key?(:'gender')
    self.gender = attributes[:'gender']
  else
    self.gender = 'GENDER_UNSPECIFIED'
  end
end

Instance Attribute Details

#display_name ⇒ Object

Returns the value of attribute display_name.



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

def display_name
  @display_name
end

#family_name ⇒ Object

Returns the value of attribute family_name.



20
21
22
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 20

def family_name
  @family_name
end

#gender ⇒ Object

Returns the value of attribute gender.



28
29
30
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 28

def gender
  @gender
end

#given_name ⇒ Object

Returns the value of attribute given_name.



18
19
20
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 18

def given_name
  @given_name
end

#nick_name ⇒ Object

Returns the value of attribute nick_name.



22
23
24
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 22

def nick_name
  @nick_name
end

#preferred_language ⇒ Object

Returns the value of attribute preferred_language.



26
27
28
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 26

def preferred_language
  @preferred_language
end

Class Method Details

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



331
332
333
334
335
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
373
374
375
376
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 331

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



65
66
67
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 53

def self.attribute_map
  {
    :'given_name' => :'givenName',
    :'family_name' => :'familyName',
    :'nick_name' => :'nickName',
    :'display_name' => :'displayName',
    :'preferred_language' => :'preferredLanguage',
    :'gender' => :'gender'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Models attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 307

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 75

def self.openapi_types
  {
    :'given_name' => :'String',
    :'family_name' => :'String',
    :'nick_name' => :'String',
    :'display_name' => :'String',
    :'preferred_language' => :'String',
    :'gender' => :'UserServiceGender'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 281

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      given_name == o.given_name &&
      family_name == o.family_name &&
      nick_name == o.nick_name &&
      display_name == o.display_name &&
      preferred_language == o.preferred_language &&
      gender == o.gender
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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 410

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


294
295
296
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



300
301
302
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 300

def hash
  [given_name, family_name, nick_name, display_name, preferred_language, gender].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @given_name.nil?
    invalid_properties.push('invalid value for "given_name", given_name cannot be nil.')
  end

  if @given_name.to_s.length > 200
    invalid_properties.push('invalid value for "given_name", the character length must be smaller than or equal to 200.')
  end

  if @given_name.to_s.length < 1
    invalid_properties.push('invalid value for "given_name", the character length must be great than or equal to 1.')
  end

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

  if @family_name.to_s.length > 200
    invalid_properties.push('invalid value for "family_name", the character length must be smaller than or equal to 200.')
  end

  if @family_name.to_s.length < 1
    invalid_properties.push('invalid value for "family_name", the character length must be great than or equal to 1.')
  end

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

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

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



386
387
388
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 392

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

Returns:

  • (String) —

    String presentation of the object



380
381
382
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 380

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



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/zitadel/client/models/user_service_set_human_profile.rb', line 187

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @given_name.nil?
  return false if @given_name.to_s.length > 200
  return false if @given_name.to_s.length < 1
  return false if @family_name.nil?
  return false if @family_name.to_s.length > 200
  return false if @family_name.to_s.length < 1
  return false if !@nick_name.nil? && @nick_name.to_s.length > 200
  return false if !@display_name.nil? && @display_name.to_s.length > 200
  return false if !@preferred_language.nil? && @preferred_language.to_s.length > 10
  true
end