Class: Zitadel::Client::Models::SettingsServiceOptions

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SettingsServiceOptions

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
 
# File 'lib/zitadel/client/models/settings_service_options.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::SettingsServiceOptions` 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::SettingsServiceOptions`. 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?(:'is_linking_allowed')
    self.is_linking_allowed = attributes[:'is_linking_allowed']
  end

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

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

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

  if attributes.key?(:'auto_linking')
    self.auto_linking = attributes[:'auto_linking']
  else
    self.auto_linking = 'AUTO_LINKING_OPTION_UNSPECIFIED'
  end
end

Instance Attribute Details

#auto_linking ⇒ Object

Returns the value of attribute auto_linking.



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

def auto_linking
  @auto_linking
end

#is_auto_creation ⇒ Object

Enable if a new account in ZITADEL should be created automatically when login with an external account.



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

def is_auto_creation
  @is_auto_creation
end

#is_auto_update ⇒ Object

Enable if a the ZITADEL account fields should be updated automatically on each login.



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

def is_auto_update
  @is_auto_update
end

#is_creation_allowed ⇒ Object

Enable if users should be able to create a new account in ZITADEL when using an external account.



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

def is_creation_allowed
  @is_creation_allowed
end

#is_linking_allowed ⇒ Object

Enable if users should be able to link an existing ZITADEL user with an external account.



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

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 199

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'is_linking_allowed' => :'isLinkingAllowed',
    :'is_creation_allowed' => :'isCreationAllowed',
    :'is_auto_creation' => :'isAutoCreation',
    :'is_auto_update' => :'isAutoUpdate',
    :'auto_linking' => :'autoLinking'
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 175

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/settings_service_options.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'is_linking_allowed' => :'Boolean',
    :'is_creation_allowed' => :'Boolean',
    :'is_auto_creation' => :'Boolean',
    :'is_auto_update' => :'Boolean',
    :'auto_linking' => :'SettingsServiceAutoLinkingOption'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_linking_allowed == o.is_linking_allowed &&
      is_creation_allowed == o.is_creation_allowed &&
      is_auto_creation == o.is_auto_creation &&
      is_auto_update == o.is_auto_update &&
      auto_linking == o.auto_linking
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



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

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


162
163
164
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 168

def hash
  [is_linking_allowed, is_creation_allowed, is_auto_creation, is_auto_update, auto_linking].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



135
136
137
138
139
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 135

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 254

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 260

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



248
249
250
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 248

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



143
144
145
146
 
# File 'lib/zitadel/client/models/settings_service_options.rb', line 143

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