Class: OryClient::CreateRecoveryCodeForIdentityBody

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

Overview

Create Recovery Code for Identity Request Body

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 = {}) ⇒ CreateRecoveryCodeForIdentityBody

Initializes the object



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

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

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

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

Instance Attribute Details

#expires_in ⇒ Object

Code Expires In The recovery code will expire after that amount of time has passed. Defaults to the configuration value of selfservice.methods.code.config.lifespan.



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

def expires_in
  @expires_in
end

#flow_type ⇒ Object

The flow type can either be api or browser.



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

def flow_type
  @flow_type
end

#identity_id ⇒ Object

Identity to Recover The identity’s ID you wish to recover.



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

def identity_id
  @identity_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.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/create_recovery_code_for_identity_body.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/create_recovery_code_for_identity_body.rb', line 29

def self.attribute_map
  {
    :'expires_in' => :'expires_in',
    :'flow_type' => :'flow_type',
    :'identity_id' => :'identity_id'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.rb', line 169

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/create_recovery_code_for_identity_body.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/create_recovery_code_for_identity_body.rb', line 48

def self.openapi_types
  {
    :'expires_in' => :'String',
    :'flow_type' => :'String',
    :'identity_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



146
147
148
149
150
151
152
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expires_in == o.expires_in &&
      flow_type == o.flow_type &&
      identity_id == o.identity_id
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


156
157
158
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.rb', line 156

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



162
163
164
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.rb', line 162

def hash
  [expires_in, flow_type, identity_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^([0-9]+(ns|us|ms|s|m|h))*$/)
  if !@expires_in.nil? && @expires_in !~ pattern
    invalid_properties.push("invalid value for \"expires_in\", must conform to the pattern #{pattern}.")
  end

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/ory-client/models/create_recovery_code_for_identity_body.rb', line 191

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@expires_in.nil? && @expires_in !~ Regexp.new(/^([0-9]+(ns|us|ms|s|m|h))*$/)
  return false if @identity_id.nil?
  true
end