Class: OryClient::UpdateRecoveryFlowWithCodeMethod

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

Overview

Update Recovery Flow with Code Method

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateRecoveryFlowWithCodeMethod

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/ory-client/models/update_recovery_flow_with_code_method.rb', line 116

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Code from the recovery email If you want to submit a code, use this field, but make sure to not include the email field, as well.



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

def code
  @code
end

#csrf_token ⇒ Object

Sending the anti-csrf token is only required for browser login flows.



23
24
25
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 23

def csrf_token
  @csrf_token
end

#email ⇒ Object

The email address of the account to recover If the email belongs to a valid account, a recovery email will be sent. If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications) If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code. format: email



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

def email
  @email
end

#method ⇒ Object

Method is the method that should be used for this recovery flow Allowed values are ‘link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode



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

def method
  @method
end

#recovery_address ⇒ Object

A recovery address that is registered for the user. It can be an email, a phone number (to receive the code via SMS), etc. Used in RecoveryV2.



32
33
34
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 32

def recovery_address
  @recovery_address
end

#recovery_confirm_address ⇒ Object

If there are multiple recovery addresses registered for the user, and the initially provided address is different from the address chosen when the choice (of masked addresses) is presented, then we need to make sure that the user actually knows the full address to avoid information exfiltration, so we ask for the full address. Used in RecoveryV2.



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

def recovery_confirm_address
  @recovery_confirm_address
end

#recovery_select_address ⇒ Object

If there are multiple addresses registered for the user, a choice is presented and this field stores the result of this choice. Addresses are ‘masked’ (never sent in full to the client and shown partially in the UI) since at this point in the recovery flow, the user has not yet proven that it knows the full address and we want to avoid information exfiltration. So for all intents and purposes, the value of this field should be treated as an opaque identifier. Used in RecoveryV2.



38
39
40
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 38

def recovery_select_address
  @recovery_select_address
end

#screen ⇒ Object

Set to "previous" to go back in the flow, meaningfully. Used in RecoveryV2.



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

def screen
  @screen
end

#transient_payload ⇒ Object

Transient data to pass along to any webhooks



44
45
46
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 44

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



256
257
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
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 256

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

Returns attribute mapping this model knows about



84
85
86
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 69

def self.attribute_map
  {
    :'code' => :'code',
    :'csrf_token' => :'csrf_token',
    :'email' => :'email',
    :'method' => :'method',
    :'recovery_address' => :'recovery_address',
    :'recovery_confirm_address' => :'recovery_confirm_address',
    :'recovery_select_address' => :'recovery_select_address',
    :'screen' => :'screen',
    :'transient_payload' => :'transient_payload'
  }
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 232

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



109
110
111
112
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 94

def self.openapi_types
  {
    :'code' => :'String',
    :'csrf_token' => :'String',
    :'email' => :'String',
    :'method' => :'String',
    :'recovery_address' => :'String',
    :'recovery_confirm_address' => :'String',
    :'recovery_select_address' => :'String',
    :'screen' => :'String',
    :'transient_payload' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      csrf_token == o.csrf_token &&
      email == o.email &&
      method == o.method &&
      recovery_address == o.recovery_address &&
      recovery_confirm_address == o.recovery_confirm_address &&
      recovery_select_address == o.recovery_select_address &&
      screen == o.screen &&
      transient_payload == o.transient_payload
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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 327

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


219
220
221
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



225
226
227
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 225

def hash
  [code, csrf_token, email, method, recovery_address, recovery_confirm_address, recovery_select_address, screen, transient_payload].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
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 171

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @method.nil?
    invalid_properties.push('invalid value for "method", method cannot be nil.')
  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



303
304
305
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 309

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



297
298
299
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 297

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



183
184
185
186
187
188
189
 
# File 'lib/ory-client/models/update_recovery_flow_with_code_method.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["link", "code"])
  return false unless method_validator.valid?(@method)
  true
end