Class: OryClient::RecoveryCodeForIdentity

Inherits:
ApiModelBase show all
Defined in:
lib/ory-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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ RecoveryCodeForIdentity

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::RecoveryCodeForIdentity` 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::RecoveryCodeForIdentity`. 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?(:'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-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-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-client/models/recovery_code_for_identity.rb', line 26

def recovery_link
  @recovery_link
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_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-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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 165

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



57
58
59
60
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 48

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:

  • to be compared



142
143
144
145
146
147
148
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 142

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

#eql?(o) ⇒ Boolean

Parameters:

  • to be compared

Returns:

See Also:

  • `==` method


152
153
154
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



158
159
160
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 158

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



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 97

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 187

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:

  • true if the model is valid



113
114
115
116
117
118
 
# File 'lib/ory-client/models/recovery_code_for_identity.rb', line 113

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