Class: Authentik::Api::CaptchaStageRequest

Inherits:
ApiModelBase show all
Defined in:
lib/authentik/api/models/captcha_stage_request.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 = {}) ⇒ CaptchaStageRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'private_key')
    self.private_key = attributes[:'private_key']
  else
    self.private_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.



23
24
25
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 23

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



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

def error_on_invalid_score
  @error_on_invalid_score
end

#interactive ⇒ Object

Returns the value of attribute interactive.



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

def interactive
  @interactive
end

#js_url ⇒ Object

Returns the value of attribute js_url.



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

def js_url
  @js_url
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#private_key ⇒ Object

Private key, acquired your captcha Provider.



19
20
21
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 19

def private_key
  @private_key
end

#public_key ⇒ Object

Public key, acquired your captcha Provider.



16
17
18
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 16

def public_key
  @public_key
end

#request_content_type ⇒ Object

Returns the value of attribute request_content_type.



25
26
27
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 25

def request_content_type
  @request_content_type
end

#score_max_threshold ⇒ Object

Returns the value of attribute score_max_threshold.



31
32
33
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 31

def score_max_threshold
  @score_max_threshold
end

#score_min_threshold ⇒ Object

Returns the value of attribute score_min_threshold.



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

def score_min_threshold
  @score_min_threshold
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 59

def self.attribute_map
  {
    :'name' => :'name',
    :'public_key' => :'public_key',
    :'private_key' => :'private_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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 326

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



101
102
103
104
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 85

def self.openapi_types
  {
    :'name' => :'String',
    :'public_key' => :'String',
    :'private_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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 296

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


313
314
315
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 313

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



319
320
321
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 319

def hash
  [name, public_key, private_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



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

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

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

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

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

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

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

  if !@js_url.nil? && @js_url.to_s.length < 1
    invalid_properties.push('invalid value for "js_url", the character length must be greater than or equal to 1.')
  end

  if !@api_url.nil? && @api_url.to_s.length < 1
    invalid_properties.push('invalid value for "api_url", the character length must be greater than or equal to 1.')
  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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 348

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



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/authentik/api/models/captcha_stage_request.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @public_key.nil?
  return false if @public_key.to_s.length < 1
  return false if @private_key.nil?
  return false if @private_key.to_s.length < 1
  return false if !@js_url.nil? && @js_url.to_s.length < 1
  return false if !@api_url.nil? && @api_url.to_s.length < 1
  true
end