Class: Zitadel::Client::Models::OrganizationServiceAddHumanUserRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationServiceAddHumanUserRequest

Initializes the object

Parameters:

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

    Models attributes in the form of hash



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 95

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#hashed_password ⇒ Object

Returns the value of attribute hashed_password.



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

def hashed_password
  @hashed_password
end

#idp_links ⇒ Object

Returns the value of attribute idp_links.



38
39
40
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 38

def idp_links
  @idp_links
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#phone ⇒ Object

Returns the value of attribute phone.



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

def phone
  @phone
end

#profile ⇒ Object

Returns the value of attribute profile.



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

def profile
  @profile
end

#totp_secret ⇒ Object

An Implementation of RFC 6238 is used, with HMAC-SHA-1 and time-step of 30 seconds. Currently no other options are supported, and if anything different is used the validation will fail.



41
42
43
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 41

def totp_secret
  @totp_secret
end

#user_id ⇒ Object

optionally set your own id unique for the user.



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

def user_id
  @user_id
end

#username ⇒ Object

optionally set a unique username, if none is provided the email will be used.



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

def username
  @username
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



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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 350

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



61
62
63
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 44

def self.attribute_map
  {
    :'user_id' => :'userId',
    :'username' => :'username',
    :'organization' => :'organization',
    :'profile' => :'profile',
    :'email' => :'email',
    :'phone' => :'phone',
    :'metadata' => :'metadata',
    :'password' => :'password',
    :'hashed_password' => :'hashedPassword',
    :'idp_links' => :'idpLinks',
    :'totp_secret' => :'totpSecret'
  }
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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 326

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



88
89
90
91
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'user_id' => :'String',
    :'username' => :'String',
    :'organization' => :'Zitadelobjectv2Organization',
    :'profile' => :'OrganizationServiceSetHumanProfile',
    :'email' => :'OrganizationServiceSetHumanEmail',
    :'phone' => :'OrganizationServiceSetHumanPhone',
    :'metadata' => :'Array<OrganizationServiceSetMetadataEntry>',
    :'password' => :'OrganizationServicePassword',
    :'hashed_password' => :'OrganizationServiceHashedPassword',
    :'idp_links' => :'Array<OrganizationServiceIDPLink>',
    :'totp_secret' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      username == o.username &&
      organization == o.organization &&
      profile == o.profile &&
      email == o.email &&
      phone == o.phone &&
      metadata == o.metadata &&
      password == o.password &&
      hashed_password == o.hashed_password &&
      idp_links == o.idp_links &&
      totp_secret == o.totp_secret
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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 429

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



319
320
321
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 319

def hash
  [user_id, username, organization, profile, email, phone, metadata, password, hashed_password, idp_links, totp_secret].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@user_id.nil? && @user_id.to_s.length > 200
    invalid_properties.push('invalid value for "user_id", the character length must be smaller than or equal to 200.')
  end

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

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

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

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

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

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

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



405
406
407
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 405

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



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

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



399
400
401
 
# File 'lib/zitadel/client/models/organization_service_add_human_user_request.rb', line 399

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@user_id.nil? && @user_id.to_s.length > 200
  return false if !@user_id.nil? && @user_id.to_s.length < 1
  return false if !@username.nil? && @username.to_s.length > 200
  return false if !@username.nil? && @username.to_s.length < 1
  return false if @profile.nil?
  return false if @email.nil?
  return false if !@totp_secret.nil? && @totp_secret.to_s.length > 200
  return false if !@totp_secret.nil? && @totp_secret.to_s.length < 1
  true
end