ory-client 0.0.1.alpha14 → 0.0.1.alpha18

data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **email** | **String** | Email to Recover  Needs to be set when initiating the flow. If the email is a registered recovery email, a recovery link will be sent. If the email is not known, a email with details on what happened will be sent instead.  format: email |  |
+| **method** | **String** | Method supports `link` only right now. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody.new(
+  csrf_token: null,
+  email: null,
+  method: null
+)
+```
+

data/docs/SubmitSelfServiceRegistrationFlowBody.md

@@ -0,0 +1,76 @@
+# OryClient::SubmitSelfServiceRegistrationFlowBody
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceRegistrationFlowWithPasswordMethodBody'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_discriminator_name
+# => :'method'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceRegistrationFlowBody.openapi_discriminator_mapping
+# =>
+# {
+#   :'oidc' => :'SubmitSelfServiceRegistrationFlowWithOidcMethodBody',
+#   :'password' => :'SubmitSelfServiceRegistrationFlowWithPasswordMethodBody'
+# }
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceRegistrationFlowBody.build(data)
+# => #<SubmitSelfServiceRegistrationFlowWithPasswordMethodBody:0x00007fdd4aab02a0>
+
+OryClient::SubmitSelfServiceRegistrationFlowBody.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceRegistrationFlowWithPasswordMethodBody`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | The CSRF Token | [optional] |
+| **method** | **String** | Method to use  This field must be set to `oidc` when using the oidc method. |  |
+| **traits** | **String** | The provider to register with |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody.new(
+  csrf_token: null,
+  method: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md

@@ -0,0 +1,24 @@
+# OryClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | The CSRF Token | [optional] |
+| **method** | **String** | Method to use  This field must be set to `password` when using the password method. |  |
+| **password** | **String** | Password to sign the user up with |  |
+| **traits** | **Object** | The identity's traits |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.new(
+  csrf_token: null,
+  method: null,
+  password: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowBody.md

@@ -0,0 +1,84 @@
+# OryClient::SubmitSelfServiceSettingsFlowBody
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceSettingsFlowBody.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceSettingsFlowWithOidcMethodBody',
+#   :'SubmitSelfServiceSettingsFlowWithPasswordMethodBody',
+#   :'SubmitSelfServiceSettingsFlowWithProfileMethodBody',
+#   :'SubmitSelfServiceSettingsFlowWithTotpMethodBody'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceSettingsFlowBody.openapi_discriminator_name
+# => :'method'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceSettingsFlowBody.openapi_discriminator_mapping
+# =>
+# {
+#   :'oidc' => :'SubmitSelfServiceSettingsFlowWithOidcMethodBody',
+#   :'password' => :'SubmitSelfServiceSettingsFlowWithPasswordMethodBody',
+#   :'profile' => :'SubmitSelfServiceSettingsFlowWithProfileMethodBody',
+#   :'totp' => :'SubmitSelfServiceSettingsFlowWithTotpMethodBody'
+# }
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceSettingsFlowBody.build(data)
+# => #<SubmitSelfServiceSettingsFlowWithOidcMethodBody:0x00007fdd4aab02a0>
+
+OryClient::SubmitSelfServiceSettingsFlowBody.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceSettingsFlowWithOidcMethodBody`
+- `SubmitSelfServiceSettingsFlowWithPasswordMethodBody`
+- `SubmitSelfServiceSettingsFlowWithProfileMethodBody`
+- `SubmitSelfServiceSettingsFlowWithTotpMethodBody`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceSettingsFlowWithLookupMethodBody.md

@@ -0,0 +1,26 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithLookupMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
+| **lookup_secret_confirm** | **Boolean** | If set to true will save the regenerated lookup secrets | [optional] |
+| **lookup_secret_regenerate** | **Boolean** | If set to true will regenerate the lookup secrets | [optional] |
+| **lookup_secret_reveal** | **Boolean** | If set to true will reveal the lookup secrets | [optional] |
+| **method** | **String** | Method  Should be set to \"lookup\" when trying to add, update, or remove a lookup pairing. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithLookupMethodBody.new(
+  csrf_token: null,
+  lookup_secret_confirm: null,
+  lookup_secret_regenerate: null,
+  lookup_secret_reveal: null,
+  method: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md

@@ -0,0 +1,24 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flow** | **String** | Flow ID is the flow's ID.  in: query | [optional] |
+| **link** | **String** | Link this provider  Either this or `unlink` must be set.  type: string in: body | [optional] |
+| **method** | **String** | Method  Should be set to profile when trying to update a profile. |  |
+| **unlink** | **String** | Unlink this provider  Either this or `link` must be set.  type: string in: body | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithOidcMethodBody.new(
+  flow: null,
+  link: null,
+  method: null,
+  unlink: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
+| **method** | **String** | Method  Should be set to password when trying to update a password. |  |
+| **password** | **String** | Password is the updated password |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody.new(
+  csrf_token: null,
+  method: null,
+  password: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | The Anti-CSRF Token  This token is only required when performing browser flows. | [optional] |
+| **method** | **String** | Method  Should be set to profile when trying to update a profile. |  |
+| **traits** | **Object** | Traits contains all of the identity's traits. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithProfileMethodBody.new(
+  csrf_token: null,
+  method: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowWithTotpMethodBody.md

@@ -0,0 +1,24 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithTotpMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
+| **method** | **String** | Method  Should be set to \"totp\" when trying to add, update, or remove a totp pairing. |  |
+| **totp_code** | **String** | ValidationTOTP must contain a valid TOTP based on the | [optional] |
+| **totp_unlink** | **Boolean** | UnlinkTOTP if true will remove the TOTP pairing, effectively removing the credential. This can be used to set up a new TOTP device. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithTotpMethodBody.new(
+  csrf_token: null,
+  method: null,
+  totp_code: null,
+  totp_unlink: null
+)
+```
+

data/docs/SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody.md

@@ -0,0 +1,26 @@
+# OryClient::SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | CSRFToken is the anti-CSRF token | [optional] |
+| **method** | **String** | Method  Should be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing. |  |
+| **webauthn_register** | **String** | Register a WebAuthn Security Key  It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional] |
+| **webauthn_register_displayname** | **String** | Name of the WebAuthn Security Key to be Added  A human-readable name for the security key which will be added. | [optional] |
+| **webauthn_remove** | **String** | Remove a WebAuthn Security Key  This must contain the ID of the WebAuthN connection. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody.new(
+  csrf_token: null,
+  method: null,
+  webauthn_register: null,
+  webauthn_register_displayname: null,
+  webauthn_remove: null
+)
+```
+

data/docs/SubmitSelfServiceVerificationFlowBody.md

@@ -0,0 +1,75 @@
+# OryClient::SubmitSelfServiceVerificationFlowBody
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceVerificationFlowBody.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceVerificationFlowWithLinkMethodBody'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceVerificationFlowBody.openapi_discriminator_name
+# => :'method'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceVerificationFlowBody.openapi_discriminator_mapping
+# =>
+# {
+#   :'link' => :'SubmitSelfServiceVerificationFlowWithLinkMethodBody'
+# }
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryClient::SubmitSelfServiceVerificationFlowBody.build(data)
+# => #<SubmitSelfServiceVerificationFlowWithLinkMethodBody:0x00007fdd4aab02a0>
+
+OryClient::SubmitSelfServiceVerificationFlowBody.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SubmitSelfServiceVerificationFlowWithLinkMethodBody`
+- `nil` (if no type matches)
+