ory-client 0.0.1.alpha13 → 0.0.1.alpha17

data/docs/SelfServiceError.md

@@ -0,0 +1,24 @@
+# OryHydraClient::SelfServiceError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+| **error** | **Object** |  | [optional] |
+| **id** | **String** |  |  |
+| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceError.new(
+  created_at: null,
+  error: null,
+  id: null,
+  updated_at: null
+)
+```
+

data/docs/SelfServiceLoginFlow.md

@@ -0,0 +1,36 @@
+# OryHydraClient::SelfServiceLoginFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **String** | and so on. | [optional] |
+| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
+| **forced** | **Boolean** | Forced stores whether this login flow should enforce re-authentication. | [optional] |
+| **id** | **String** |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow started. |  |
+| **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. |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceLoginFlow.new(
+  active: null,
+  created_at: null,
+  expires_at: null,
+  forced: null,
+  id: null,
+  issued_at: null,
+  request_url: null,
+  type: null,
+  ui: null,
+  updated_at: null
+)
+```
+

data/docs/SelfServiceLogoutUrl.md

@@ -0,0 +1,18 @@
+# OryHydraClient::SelfServiceLogoutUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logout_url** | **String** | LogoutURL can be opened in a browser to  format: uri | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceLogoutUrl.new(
+  logout_url: null
+)
+```
+

data/docs/SelfServiceRecoveryFlow.md

@@ -0,0 +1,32 @@
+# OryHydraClient::SelfServiceRecoveryFlow
+
+## 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 update the setting, a new request has to be initiated. |  |
+| **id** | **String** |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the request occurred. |  |
+| **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. |  |
+| **state** | [**SelfServiceRecoveryFlowState**](SelfServiceRecoveryFlowState.md) |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceRecoveryFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  request_url: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/SelfServiceRecoveryFlowState.md

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

data/docs/SelfServiceRecoveryLink.md

@@ -0,0 +1,20 @@
+# OryHydraClient::SelfServiceRecoveryLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** | Recovery Link Expires At  The timestamp when the recovery link expires. | [optional] |
+| **recovery_link** | **String** | Recovery Link  This link can be used to recover the account. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceRecoveryLink.new(
+  expires_at: null,
+  recovery_link: null
+)
+```
+

data/docs/SelfServiceRegistrationFlow.md

@@ -0,0 +1,30 @@
+# OryHydraClient::SelfServiceRegistrationFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **String** | and so on. | [optional] |
+| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
+| **id** | **String** |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
+| **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. |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceRegistrationFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  request_url: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/SelfServiceSettingsFlow.md

@@ -0,0 +1,34 @@
+# OryHydraClient::SelfServiceSettingsFlow
+
+## 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 flow expires. If the user still wishes to update the setting, a new flow has to be initiated. |  |
+| **id** | **String** |  |  |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. |  |
+| **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. |  |
+| **state** | [**SelfServiceSettingsFlowState**](SelfServiceSettingsFlowState.md) |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceSettingsFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null,
+  request_url: null,
+  state: null,
+  type: null,
+  ui: null
+)
+```
+

data/docs/SelfServiceSettingsFlowState.md

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

data/docs/SelfServiceVerificationFlow.md

@@ -0,0 +1,32 @@
+# OryHydraClient::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 = OryHydraClient::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 @@
+# OryHydraClient::SelfServiceVerificationFlowState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryHydraClient::SelfServiceVerificationFlowState.new()
+```
+

data/docs/Session.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **active** | **Boolean** |  | [optional] |
-| **authenticated_at** | **Time** |  |  |
-| **expires_at** | **Time** |  |  |
+| **active** | **Boolean** | Whether or not the session is active. | [optional] |
+| **authenticated_at** | **Time** | The Session Authentication Timestamp  When this session was authenticated at. | [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 authenticated at. | [optional] |
 
 ## Example
 

data/docs/SubmitSelfServiceLoginFlowBody.md

@@ -0,0 +1,76 @@
+# OryHydraClient::SubmitSelfServiceLoginFlowBody
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlowBody.openapi_one_of
+# =>
+# [
+#   :'SubmitSelfServiceLoginFlowWithPasswordMethodBody'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlowBody.openapi_discriminator_name
+# => :'method'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlowBody.openapi_discriminator_mapping
+# =>
+# {
+#   :'oidc' => :'SubmitSelfServiceLoginFlowWithOidcMethodBody',
+#   :'password' => :'SubmitSelfServiceLoginFlowWithPasswordMethodBody'
+# }
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ory-client'
+
+OryHydraClient::SubmitSelfServiceLoginFlowBody.build(data)
+# => #<SubmitSelfServiceLoginFlowWithPasswordMethodBody:0x00007fdd4aab02a0>
+
+OryHydraClient::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
+
+- `SubmitSelfServiceLoginFlowWithPasswordMethodBody`
+- `nil` (if no type matches)
+

data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md

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

data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md

@@ -0,0 +1,24 @@
+# OryHydraClient::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 = OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody.new(
+  csrf_token: null,
+  method: null,
+  password: null,
+  password_identifier: null
+)
+```
+

data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md

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