Class: Zitadel::Client::Models::SessionServiceOTPEmailSendCode

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SessionServiceOTPEmailSendCode

Initializes the object

Parameters:

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

    Models attributes in the form of hash



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 53

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

Instance Attribute Details

#url_template ⇒ Object

Optionally set a url_template, which will be used in the mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used. The following placeholders can be used: Code, UserID, LoginName, DisplayName, PreferredLanguage, SessionID



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

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



164
165
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
203
204
205
206
207
208
209
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 164

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



29
30
31
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 29

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



22
23
24
25
26
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 22

def self.attribute_map
  {
    :'url_template' => :'urlTemplate'
  }
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 140

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



46
47
48
49
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 46

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 39

def self.openapi_types
  {
    :'url_template' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 119

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 243

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


127
128
129
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 127

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



133
134
135
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 133

def hash
  [url_template].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



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 76

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

  if !@url_template.nil? && @url_template.to_s.length < 1
    invalid_properties.push('invalid value for "url_template", 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



219
220
221
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 219

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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 225

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



213
214
215
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 213

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



92
93
94
95
96
97
 
# File 'lib/zitadel/client/models/session_service_o_t_p_email_send_code.rb', line 92

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