Class: OryClient::AccountExperienceConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/account_experience_configuration.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountExperienceConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
245
246
247
248
249
250
251
252
253
254
# File 'lib/ory-client/models/account_experience_configuration.rb', line 143

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::AccountExperienceConfiguration` 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))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::AccountExperienceConfiguration`. 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?(:'default_locale')
    self.default_locale = attributes[:'default_locale']
  else
    self.default_locale = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#default_localeObject

Returns the value of attribute default_locale.



18
19
20
# File 'lib/ory-client/models/account_experience_configuration.rb', line 18

def default_locale
  @default_locale
end

#default_redirect_urlObject

Returns the value of attribute default_redirect_url.



20
21
22
# File 'lib/ory-client/models/account_experience_configuration.rb', line 20

def default_redirect_url
  @default_redirect_url
end

#error_ui_urlObject

Returns the value of attribute error_ui_url.



22
23
24
# File 'lib/ory-client/models/account_experience_configuration.rb', line 22

def error_ui_url
  @error_ui_url
end

#favicon_dark_urlObject

Returns the value of attribute favicon_dark_url.



24
25
26
# File 'lib/ory-client/models/account_experience_configuration.rb', line 24

def favicon_dark_url
  @favicon_dark_url
end

#favicon_light_urlObject

Returns the value of attribute favicon_light_url.



26
27
28
# File 'lib/ory-client/models/account_experience_configuration.rb', line 26

def favicon_light_url
  @favicon_light_url
end

#locale_behaviorObject

force_default AccountExperienceLocaleBehaviorForceDefault respect_accept_language AccountExperienceLocaleBehaviorRespectAcceptLanguage



29
30
31
# File 'lib/ory-client/models/account_experience_configuration.rb', line 29

def locale_behavior
  @locale_behavior
end

#login_ui_urlObject

Returns the value of attribute login_ui_url.



31
32
33
# File 'lib/ory-client/models/account_experience_configuration.rb', line 31

def 
  @login_ui_url
end

#logo_dark_urlObject

Returns the value of attribute logo_dark_url.



33
34
35
# File 'lib/ory-client/models/account_experience_configuration.rb', line 33

def logo_dark_url
  @logo_dark_url
end

#logo_light_urlObject

Returns the value of attribute logo_light_url.



35
36
37
# File 'lib/ory-client/models/account_experience_configuration.rb', line 35

def logo_light_url
  @logo_light_url
end

#nameObject

Returns the value of attribute name.



37
38
39
# File 'lib/ory-client/models/account_experience_configuration.rb', line 37

def name
  @name
end

#recovery_enabledObject

Returns the value of attribute recovery_enabled.



39
40
41
# File 'lib/ory-client/models/account_experience_configuration.rb', line 39

def recovery_enabled
  @recovery_enabled
end

#recovery_ui_urlObject

Returns the value of attribute recovery_ui_url.



41
42
43
# File 'lib/ory-client/models/account_experience_configuration.rb', line 41

def recovery_ui_url
  @recovery_ui_url
end

#registration_enabledObject

Returns the value of attribute registration_enabled.



43
44
45
# File 'lib/ory-client/models/account_experience_configuration.rb', line 43

def registration_enabled
  @registration_enabled
end

#registration_ui_urlObject

Returns the value of attribute registration_ui_url.



45
46
47
# File 'lib/ory-client/models/account_experience_configuration.rb', line 45

def registration_ui_url
  @registration_ui_url
end

#settings_ui_urlObject

Returns the value of attribute settings_ui_url.



47
48
49
# File 'lib/ory-client/models/account_experience_configuration.rb', line 47

def settings_ui_url
  @settings_ui_url
end

#stylesheetObject

Returns the value of attribute stylesheet.



49
50
51
# File 'lib/ory-client/models/account_experience_configuration.rb', line 49

def stylesheet
  @stylesheet
end

#verification_enabledObject

Returns the value of attribute verification_enabled.



51
52
53
# File 'lib/ory-client/models/account_experience_configuration.rb', line 51

def verification_enabled
  @verification_enabled
end

#verification_ui_urlObject

Returns the value of attribute verification_ui_url.



53
54
55
# File 'lib/ory-client/models/account_experience_configuration.rb', line 53

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



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
# File 'lib/ory-client/models/account_experience_configuration.rb', line 532

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
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



102
103
104
# File 'lib/ory-client/models/account_experience_configuration.rb', line 102

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



107
108
109
# File 'lib/ory-client/models/account_experience_configuration.rb', line 107

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/ory-client/models/account_experience_configuration.rb', line 78

def self.attribute_map
  {
    :'default_locale' => :'default_locale',
    :'default_redirect_url' => :'default_redirect_url',
    :'error_ui_url' => :'error_ui_url',
    :'favicon_dark_url' => :'favicon_dark_url',
    :'favicon_light_url' => :'favicon_light_url',
    :'locale_behavior' => :'locale_behavior',
    :'login_ui_url' => :'login_ui_url',
    :'logo_dark_url' => :'logo_dark_url',
    :'logo_light_url' => :'logo_light_url',
    :'name' => :'name',
    :'recovery_enabled' => :'recovery_enabled',
    :'recovery_ui_url' => :'recovery_ui_url',
    :'registration_enabled' => :'registration_enabled',
    :'registration_ui_url' => :'registration_ui_url',
    :'settings_ui_url' => :'settings_ui_url',
    :'stylesheet' => :'stylesheet',
    :'verification_enabled' => :'verification_enabled',
    :'verification_ui_url' => :'verification_ui_url'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# File 'lib/ory-client/models/account_experience_configuration.rb', line 508

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)
end

.openapi_nullableObject

List of attributes with nullable: true



136
137
138
139
# File 'lib/ory-client/models/account_experience_configuration.rb', line 136

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

.openapi_typesObject

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'lib/ory-client/models/account_experience_configuration.rb', line 112

def self.openapi_types
  {
    :'default_locale' => :'String',
    :'default_redirect_url' => :'String',
    :'error_ui_url' => :'String',
    :'favicon_dark_url' => :'String',
    :'favicon_light_url' => :'String',
    :'locale_behavior' => :'String',
    :'login_ui_url' => :'String',
    :'logo_dark_url' => :'String',
    :'logo_light_url' => :'String',
    :'name' => :'String',
    :'recovery_enabled' => :'Boolean',
    :'recovery_ui_url' => :'String',
    :'registration_enabled' => :'Boolean',
    :'registration_ui_url' => :'String',
    :'settings_ui_url' => :'String',
    :'stylesheet' => :'String',
    :'verification_enabled' => :'Boolean',
    :'verification_ui_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/ory-client/models/account_experience_configuration.rb', line 470

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_locale == o.default_locale &&
      default_redirect_url == o.default_redirect_url &&
      error_ui_url == o.error_ui_url &&
      favicon_dark_url == o.favicon_dark_url &&
      favicon_light_url == o.favicon_light_url &&
      locale_behavior == o.locale_behavior &&
       == o. &&
      logo_dark_url == o.logo_dark_url &&
      logo_light_url == o.logo_light_url &&
      name == o.name &&
      recovery_enabled == o.recovery_enabled &&
      recovery_ui_url == o.recovery_ui_url &&
      registration_enabled == o.registration_enabled &&
      registration_ui_url == o.registration_ui_url &&
      settings_ui_url == o.settings_ui_url &&
      stylesheet == o.stylesheet &&
      verification_enabled == o.verification_enabled &&
      verification_ui_url == o.verification_ui_url
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



603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'lib/ory-client/models/account_experience_configuration.rb', line 603

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


495
496
497
# File 'lib/ory-client/models/account_experience_configuration.rb', line 495

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



501
502
503
# File 'lib/ory-client/models/account_experience_configuration.rb', line 501

def hash
  [default_locale, default_redirect_url, error_ui_url, favicon_dark_url, favicon_light_url, locale_behavior, , logo_dark_url, logo_light_url, name, recovery_enabled, recovery_ui_url, registration_enabled, registration_ui_url, settings_ui_url, stylesheet, verification_enabled, verification_ui_url].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/ory-client/models/account_experience_configuration.rb', line 258

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

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

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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



579
580
581
# File 'lib/ory-client/models/account_experience_configuration.rb', line 579

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



585
586
587
588
589
590
591
592
593
594
595
596
597
# File 'lib/ory-client/models/account_experience_configuration.rb', line 585

def to_hash
  hash = {}
  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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



573
574
575
# File 'lib/ory-client/models/account_experience_configuration.rb', line 573

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/ory-client/models/account_experience_configuration.rb', line 318

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @default_locale.nil?
  return false if @default_redirect_url.nil?
  return false if @error_ui_url.nil?
  return false if @locale_behavior.nil?
  locale_behavior_validator = EnumAttributeValidator.new('String', ["force_default", "respect_accept_language"])
  return false unless locale_behavior_validator.valid?(@locale_behavior)
  return false if @login_ui_url.nil?
  return false if @name.nil?
  return false if @recovery_enabled.nil?
  return false if @recovery_ui_url.nil?
  return false if @registration_enabled.nil?
  return false if @registration_ui_url.nil?
  return false if @settings_ui_url.nil?
  return false if @verification_enabled.nil?
  return false if @verification_ui_url.nil?
  true
end