ory-client 0.0.1.alpha14 → 0.0.1.alpha18

data/docs/SelfServiceSettingsFlowState.md

@@ -0,0 +1,15 @@
+# OryClient::SelfServiceSettingsFlowState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SelfServiceSettingsFlowState.new()
+```
+

data/docs/SelfServiceVerificationFlow.md

@@ -0,0 +1,32 @@
+# OryClient::SelfServiceVerificationFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] |
+| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to verify the address, a new request has to be initiated. | [optional] |
+| **id** | **String** |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. | [optional] |
+| **request_url** | **String** | 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. | [optional] |
+| **state** | [**SelfServiceVerificationFlowState**](SelfServiceVerificationFlowState.md) |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SelfServiceVerificationFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  request_url: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/SelfServiceVerificationFlowState.md

@@ -0,0 +1,15 @@
+# OryClient::SelfServiceVerificationFlowState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SelfServiceVerificationFlowState.new()
+```
+

data/docs/ServiceUpdateResponse.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ServiceUpdateResponse
+# OryClient::ServiceUpdateResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ServiceUpdateResponse.new(
+instance = OryClient::ServiceUpdateResponse.new(
   warnings: null
 )
 ```

data/docs/Session.md

@@ -1,24 +1,28 @@
-# OryHydraClient::Session
+# OryClient::Session
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | **Boolean** |  | [optional] |
-| **authenticated_at** | **Time** |  |  |
-| **expires_at** | **Time** |  |  |
+| **active** | **Boolean** | Active state. If false the session is no longer active. | [optional] |
+| **authenticated_at** | **Time** | The Session Authentication Timestamp  When this session was authenticated at. If multi-factor authentication was used this is the time when the last factor was authenticated (e.g. the TOTP code challenge was completed). | [optional] |
+| **authentication_methods** | [**Array<SessionAuthenticationMethod>**](SessionAuthenticationMethod.md) | A list of authenticators which were used to authenticate the session. | [optional] |
+| **authenticator_assurance_level** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
+| **expires_at** | **Time** | The Session Expiry  When this session expires at. | [optional] |
 | **id** | **String** |  |  |
 | **identity** | [**Identity**](Identity.md) |  |  |
-| **issued_at** | **Time** |  |  |
+| **issued_at** | **Time** | The Session Issuance Timestamp  When this session was issued at. Usually equal or close to `authenticated_at`. | [optional] |
 
 ## Example
 
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::Session.new(
+instance = OryClient::Session.new(
   active: null,
   authenticated_at: null,
+  authentication_methods: null,
+  authenticator_assurance_level: null,
   expires_at: null,
   id: null,
   identity: null,

data/docs/SessionAuthenticationMethod.md

@@ -0,0 +1,20 @@
+# OryClient::SessionAuthenticationMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completed_at** | **Time** | When the authentication challenge was completed. | [optional] |
+| **method** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SessionAuthenticationMethod.new(
+  completed_at: null,
+  method: null
+)
+```
+

data/docs/SessionDevice.md

@@ -0,0 +1,18 @@
+# OryClient::SessionDevice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_agent** | **String** | UserAgent of this device | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SessionDevice.new(
+  user_agent: null
+)
+```
+

data/docs/SettingsProfileFormConfig.md

@@ -1,4 +1,4 @@
-# OryHydraClient::SettingsProfileFormConfig
+# OryClient::SettingsProfileFormConfig
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::SettingsProfileFormConfig.new(
+instance = OryClient::SettingsProfileFormConfig.new(
   action: null,
   messages: null,
   method: null,

data/docs/SubmitSelfServiceLoginFlowBody.md

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

data/docs/SubmitSelfServiceLoginFlowWithLookupSecretMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceLoginFlowWithLookupSecretMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **lookup_secret** | **String** | The lookup secret. |  |
+| **method** | **String** | Method should be set to \"lookup_secret\" when logging in using the lookup_secret strategy. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceLoginFlowWithLookupSecretMethodBody.new(
+  csrf_token: null,
+  lookup_secret: null,
+  method: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceLoginFlowWithOidcMethodBody
+
+## 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::SubmitSelfServiceLoginFlowWithOidcMethodBody.new(
+  csrf_token: null,
+  method: null,
+  traits: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md

@@ -0,0 +1,24 @@
+# OryClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **method** | **String** | Method should be set to \"password\" when logging in using the identifier and password strategy. |  |
+| **password** | **String** | The user's password. |  |
+| **password_identifier** | **String** | Identifier is the email or username of the user trying to log in. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody.new(
+  csrf_token: null,
+  method: null,
+  password: null,
+  password_identifier: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlowWithTotpMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceLoginFlowWithTotpMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **method** | **String** | Method should be set to \"totp\" when logging in using the TOTP strategy. |  |
+| **totp_code** | **String** | The TOTP code. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceLoginFlowWithTotpMethodBody.new(
+  csrf_token: null,
+  method: null,
+  totp_code: null
+)
+```
+

data/docs/SubmitSelfServiceLoginFlowWithWebAuthnMethodBody.md

@@ -0,0 +1,22 @@
+# OryClient::SubmitSelfServiceLoginFlowWithWebAuthnMethodBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
+| **method** | **String** | Method should be set to \"webAuthn\" when logging in using the WebAuthn strategy. |  |
+| **webauthn_login** | **String** | Login a WebAuthn Security Key  This must contain the ID of the WebAuthN connection. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceLoginFlowWithWebAuthnMethodBody.new(
+  csrf_token: null,
+  method: null,
+  webauthn_login: null
+)
+```
+

data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md

@@ -0,0 +1,18 @@
+# OryClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_token** | **String** | The Session Token  Invalidate this session token. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody.new(
+  session_token: null
+)
+```
+

data/docs/SubmitSelfServiceRecoveryFlowBody.md

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