Class: Authentik::Api::CaptchaStage

Inherits:
ApiModelBase show all
Defined in:
lib/authentik/api/models/captcha_stage.rb

Overview

CaptchaStage Serializer

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CaptchaStage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Authentik::Api::CaptchaStage` 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 `Authentik::Api::CaptchaStage`. 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?(:'pk')
    self.pk = attributes[:'pk']
  else
    self.pk = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_url ⇒ Object

Returns the value of attribute api_url.



36
37
38
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 36

def api_url
  @api_url
end

#component ⇒ Object

Get object type so that we know how to edit the object



18
19
20
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 18

def component
  @component
end

#error_on_invalid_score ⇒ Object

When enabled and the received captcha score is outside of the given threshold, the stage will show an error message. When not enabled, the flow will continue, but the data from the captcha will be available in the context for policy decisions



47
48
49
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 47

def error_on_invalid_score
  @error_on_invalid_score
end

#flow_set ⇒ Object

Returns the value of attribute flow_set.



29
30
31
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 29

def flow_set
  @flow_set
end

#interactive ⇒ Object

Returns the value of attribute interactive.



40
41
42
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 40

def interactive
  @interactive
end

#js_url ⇒ Object

Returns the value of attribute js_url.



34
35
36
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 34

def js_url
  @js_url
end

#meta_model_name ⇒ Object

Return internal model name



27
28
29
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 27

def meta_model_name
  @meta_model_name
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 15

def name
  @name
end

#pk ⇒ Object

Returns the value of attribute pk.



13
14
15
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 13

def pk
  @pk
end

#public_key ⇒ Object

Public key, acquired your captcha Provider.



32
33
34
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 32

def public_key
  @public_key
end

#request_content_type ⇒ Object

Returns the value of attribute request_content_type.



38
39
40
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 38

def request_content_type
  @request_content_type
end

#score_max_threshold ⇒ Object

Returns the value of attribute score_max_threshold.



44
45
46
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 44

def score_max_threshold
  @score_max_threshold
end

#score_min_threshold ⇒ Object

Returns the value of attribute score_min_threshold.



42
43
44
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 42

def score_min_threshold
  @score_min_threshold
end

#verbose_name ⇒ Object

Return object's verbose_name



21
22
23
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 21

def verbose_name
  @verbose_name
end

#verbose_name_plural ⇒ Object

Return object's plural verbose_name



24
25
26
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 24

def verbose_name_plural
  @verbose_name_plural
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



93
94
95
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 98

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 72

def self.attribute_map
  {
    :'pk' => :'pk',
    :'name' => :'name',
    :'component' => :'component',
    :'verbose_name' => :'verbose_name',
    :'verbose_name_plural' => :'verbose_name_plural',
    :'meta_model_name' => :'meta_model_name',
    :'flow_set' => :'flow_set',
    :'public_key' => :'public_key',
    :'js_url' => :'js_url',
    :'api_url' => :'api_url',
    :'request_content_type' => :'request_content_type',
    :'interactive' => :'interactive',
    :'score_min_threshold' => :'score_min_threshold',
    :'score_max_threshold' => :'score_max_threshold',
    :'error_on_invalid_score' => :'error_on_invalid_score'
  }
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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 396

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_nullable ⇒ Object

List of attributes with nullable: true



124
125
126
127
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 124

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 103

def self.openapi_types
  {
    :'pk' => :'String',
    :'name' => :'String',
    :'component' => :'String',
    :'verbose_name' => :'String',
    :'verbose_name_plural' => :'String',
    :'meta_model_name' => :'String',
    :'flow_set' => :'Array<FlowSet>',
    :'public_key' => :'String',
    :'js_url' => :'String',
    :'api_url' => :'String',
    :'request_content_type' => :'RequestContentTypeEnum',
    :'interactive' => :'Boolean',
    :'score_min_threshold' => :'Float',
    :'score_max_threshold' => :'Float',
    :'error_on_invalid_score' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 361

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pk == o.pk &&
      name == o.name &&
      component == o.component &&
      verbose_name == o.verbose_name &&
      verbose_name_plural == o.verbose_name_plural &&
      meta_model_name == o.meta_model_name &&
      flow_set == o.flow_set &&
      public_key == o.public_key &&
      js_url == o.js_url &&
      api_url == o.api_url &&
      request_content_type == o.request_content_type &&
      interactive == o.interactive &&
      score_min_threshold == o.score_min_threshold &&
      score_max_threshold == o.score_max_threshold &&
      error_on_invalid_score == o.error_on_invalid_score
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


383
384
385
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 383

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



389
390
391
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 389

def hash
  [pk, name, component, verbose_name, verbose_name_plural, meta_model_name, flow_set, public_key, js_url, api_url, request_content_type, interactive, score_min_threshold, score_max_threshold, error_on_invalid_score].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



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
255
256
257
258
259
260
261
262
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 226

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 418

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/authentik/api/models/captcha_stage.rb', line 266

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @pk.nil?
  return false if @name.nil?
  return false if @component.nil?
  return false if @verbose_name.nil?
  return false if @verbose_name_plural.nil?
  return false if @meta_model_name.nil?
  return false if @flow_set.nil?
  return false if @public_key.nil?
  true
end