Class: Zitadel::Client::Models::UserServiceSetPassword

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserServiceSetPassword

Initializes the object

Parameters:

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

    Models attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
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
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 65

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

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

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

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

Instance Attribute Details

#current_password ⇒ Object

Returns the value of attribute current_password.



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

def current_password
  @current_password
end

#hashed_password ⇒ Object

Returns the value of attribute hashed_password.



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

def hashed_password
  @hashed_password
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#verification_code ⇒ Object

"the verification code generated during password reset request"



25
26
27
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 25

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



233
234
235
236
237
238
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
276
277
278
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 233

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 28

def self.attribute_map
  {
    :'password' => :'password',
    :'hashed_password' => :'hashedPassword',
    :'current_password' => :'currentPassword',
    :'verification_code' => :'verificationCode'
  }
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 209

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



58
59
60
61
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 58

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 48

def self.openapi_types
  {
    :'password' => :'UserServicePassword',
    :'hashed_password' => :'UserServiceHashedPassword',
    :'current_password' => :'String',
    :'verification_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      password == o.password &&
      hashed_password == o.hashed_password &&
      current_password == o.current_password &&
      verification_code == o.verification_code
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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 312

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



202
203
204
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 202

def hash
  [password, hashed_password, current_password, verification_code].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



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

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

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

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

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

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

  if @verification_code.to_s.length < 1
    invalid_properties.push('invalid value for "verification_code", 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



288
289
290
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 288

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



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

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



282
283
284
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 282

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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/zitadel/client/models/user_service_set_password.rb', line 136

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @current_password.nil?
  return false if @current_password.to_s.length > 200
  return false if @current_password.to_s.length < 1
  return false if @verification_code.nil?
  return false if @verification_code.to_s.length > 20
  return false if @verification_code.to_s.length < 1
  true
end