Class: OryClient::RegistrationFlow

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RegistrationFlow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
201
202
 
# File 'lib/ory-client/models/registration_flow.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Active, if set, contains the registration method that is being used. It is initially not set. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode



19
20
21
 
# File 'lib/ory-client/models/registration_flow.rb', line 19

def active
  @active
end

#expires_at ⇒ Object

ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.



22
23
24
 
# File 'lib/ory-client/models/registration_flow.rb', line 22

def expires_at
  @expires_at
end

#id ⇒ Object

ID represents the flow’s unique ID. When performing the registration flow, this represents the id in the registration ui’s query parameter: http://<selfservice.flows.registration.ui_url>/?flow=<id>



25
26
27
 
# File 'lib/ory-client/models/registration_flow.rb', line 25

def id
  @id
end

#issued_at ⇒ Object

IssuedAt is the time (UTC) when the flow occurred.



28
29
30
 
# File 'lib/ory-client/models/registration_flow.rb', line 28

def issued_at
  @issued_at
end

#oauth2_login_challenge ⇒ Object

Ory OAuth 2.0 Login Challenge. This value is set using the ‘login_challenge` query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.



31
32
33
 
# File 'lib/ory-client/models/registration_flow.rb', line 31

def 
  @oauth2_login_challenge
end

#oauth2_login_request ⇒ Object

Returns the value of attribute oauth2_login_request.



33
34
35
 
# File 'lib/ory-client/models/registration_flow.rb', line 33

def 
  @oauth2_login_request
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#request_url ⇒ Object

RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL’s path or query for example.



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

def request_url
  @request_url
end

#return_to ⇒ Object

ReturnTo contains the requested return_to URL.



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

def return_to
  @return_to
end

#session_token_exchange_code ⇒ Object

SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type "api", and only on creating the flow.



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

def session_token_exchange_code
  @session_token_exchange_code
end

#state ⇒ Object

State represents the state of this request: choose_method: ask the user to choose a method (e.g. registration with email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the registration challenge was passed.



47
48
49
 
# File 'lib/ory-client/models/registration_flow.rb', line 47

def state
  @state
end

#transient_payload ⇒ Object

TransientPayload is used to pass data from the registration to a webhook



50
51
52
 
# File 'lib/ory-client/models/registration_flow.rb', line 50

def transient_payload
  @transient_payload
end

#type ⇒ Object

The flow type can either be ‘api` or `browser`.



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

def type
  @type
end

#ui ⇒ Object

Returns the value of attribute ui.



55
56
57
 
# File 'lib/ory-client/models/registration_flow.rb', line 55

def ui
  @ui
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



100
101
102
 
# File 'lib/ory-client/models/registration_flow.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ory-client/models/registration_flow.rb', line 80

def self.attribute_map
  {
    :'active' => :'active',
    :'expires_at' => :'expires_at',
    :'id' => :'id',
    :'issued_at' => :'issued_at',
    :'oauth2_login_challenge' => :'oauth2_login_challenge',
    :'oauth2_login_request' => :'oauth2_login_request',
    :'organization_id' => :'organization_id',
    :'request_url' => :'request_url',
    :'return_to' => :'return_to',
    :'session_token_exchange_code' => :'session_token_exchange_code',
    :'state' => :'state',
    :'transient_payload' => :'transient_payload',
    :'type' => :'type',
    :'ui' => :'ui'
  }
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



295
296
297
 
# File 'lib/ory-client/models/registration_flow.rb', line 295

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



125
126
127
128
129
130
 
# File 'lib/ory-client/models/registration_flow.rb', line 125

def self.openapi_nullable
  Set.new([
    :'organization_id',
    :'state',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/ory-client/models/registration_flow.rb', line 105

def self.openapi_types
  {
    :'active' => :'String',
    :'expires_at' => :'Time',
    :'id' => :'String',
    :'issued_at' => :'Time',
    :'oauth2_login_challenge' => :'String',
    :'oauth2_login_request' => :'OAuth2LoginRequest',
    :'organization_id' => :'String',
    :'request_url' => :'String',
    :'return_to' => :'String',
    :'session_token_exchange_code' => :'String',
    :'state' => :'Object',
    :'transient_payload' => :'Object',
    :'type' => :'String',
    :'ui' => :'UiContainer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/ory-client/models/registration_flow.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      expires_at == o.expires_at &&
      id == o.id &&
      issued_at == o.issued_at &&
       == o. &&
       == o. &&
      organization_id == o.organization_id &&
      request_url == o.request_url &&
      return_to == o.return_to &&
      session_token_exchange_code == o.session_token_exchange_code &&
      state == o.state &&
      transient_payload == o.transient_payload &&
      type == o.type &&
      ui == o.ui
end

#_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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/ory-client/models/registration_flow.rb', line 326

def _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_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/ory-client/models/registration_flow.rb', line 397

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

#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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/ory-client/models/registration_flow.rb', line 302

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


282
283
284
 
# File 'lib/ory-client/models/registration_flow.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



288
289
290
 
# File 'lib/ory-client/models/registration_flow.rb', line 288

def hash
  [active, expires_at, id, issued_at, , , organization_id, request_url, return_to, session_token_exchange_code, state, transient_payload, type, ui].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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ory-client/models/registration_flow.rb', line 206

def list_invalid_properties
  invalid_properties = Array.new
  if @expires_at.nil?
    invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
  end

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

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

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

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

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



373
374
375
 
# File 'lib/ory-client/models/registration_flow.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/ory-client/models/registration_flow.rb', line 379

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



367
368
369
 
# File 'lib/ory-client/models/registration_flow.rb', line 367

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



237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/ory-client/models/registration_flow.rb', line 237

def valid?
  active_validator = EnumAttributeValidator.new('String', ["password", "oidc", "totp", "lookup_secret", "webauthn", "code", "link_recovery", "code_recovery"])
  return false unless active_validator.valid?(@active)
  return false if @expires_at.nil?
  return false if @id.nil?
  return false if @issued_at.nil?
  return false if @request_url.nil?
  return false if @type.nil?
  return false if @ui.nil?
  true
end