Class: OryKratosClient::RecoveryCodeForIdentity

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

Overview

Used when an administrator creates a recovery code for an identity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecoveryCodeForIdentity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 59

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryKratosClient::RecoveryCodeForIdentity` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryKratosClient::RecoveryCodeForIdentity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

Instance Attribute Details

#expires_at ⇒ Object

Expires At is the timestamp of when the recovery flow expires The timestamp when the recovery code expires.



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

def expires_at
  @expires_at
end

#recovery_code ⇒ Object

RecoveryCode is the code that can be used to recover the account



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

def recovery_code
  @recovery_code
end

#recovery_link ⇒ Object

RecoveryLink with flow This link opens the recovery UI with an empty ‘code` field.



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

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



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
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 163

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 = OryKratosClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 29

def self.attribute_map
  {
    :'expires_at' => :'expires_at',
    :'recovery_code' => :'recovery_code',
    :'recovery_link' => :'recovery_link'
  }
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 139

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 43

def self.openapi_types
  {
    :'expires_at' => :'Time',
    :'recovery_code' => :'String',
    :'recovery_link' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expires_at == o.expires_at &&
      recovery_code == o.recovery_code &&
      recovery_link == o.recovery_link
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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 234

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


126
127
128
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



132
133
134
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 132

def hash
  [expires_at, recovery_code, recovery_link].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



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 91

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

  if @recovery_link.nil?
    invalid_properties.push('invalid value for "recovery_link", recovery_link 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



210
211
212
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 210

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



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 216

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



204
205
206
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 204

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



107
108
109
110
111
112
 
# File 'lib/ory-kratos-client/models/recovery_code_for_identity.rb', line 107

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @recovery_code.nil?
  return false if @recovery_link.nil?
  true
end