ory-kratos-client 0.5.0.alpha1 → 0.5.5.alpha2

data/docs/RecoveryAddress.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | 
-**value** | **String** |  | 
-**via** | **String** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **value** | **String** |  |  |
+| **via** | **String** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RecoveryAddress.new(id: null,
-                                 value: null,
-                                 via: null)
+instance = OryHydraClient::RecoveryAddress.new(
+  id: null,
+  value: null,
+  via: null
+)
 ```
 
-

data/docs/RecoveryFlow.md

@@ -2,32 +2,33 @@
 
 ## 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** | **DateTime** | 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** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**methods** | [**Hash<String, RecoveryFlowMethod>**](RecoveryFlowMethod.md) | Methods contains context for all account recovery methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. | 
-**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** | **String** |  | 
-**type** | **String** | The flow type can either be `api` or `browser`. | [optional] 
+| 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. |  |
+| **messages** | [**Array<Message>**](Message.md) |  | [optional] |
+| **methods** | [**Hash<String, RecoveryFlowMethod>**](RecoveryFlowMethod.md) | Methods contains context for all account recovery methods. If a registration request has been processed, but for example the password is incorrect, this will contain error messages. |  |
+| **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** | **String** |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RecoveryFlow.new(active: null,
-                                 expires_at: null,
-                                 id: null,
-                                 issued_at: null,
-                                 messages: null,
-                                 methods: null,
-                                 request_url: null,
-                                 state: null,
-                                 type: null)
+instance = OryHydraClient::RecoveryFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  messages: null,
+  methods: null,
+  request_url: null,
+  state: null,
+  type: null
+)
 ```
 
-

data/docs/RecoveryFlowMethod.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**config** | [**RecoveryFlowMethodConfig**](RecoveryFlowMethodConfig.md) |  | 
-**method** | **String** | Method contains the request credentials type. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | [**RecoveryFlowMethodConfig**](RecoveryFlowMethodConfig.md) |  |  |
+| **method** | **String** | Method contains the request credentials type. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RecoveryFlowMethod.new(config: null,
-                                 method: null)
+instance = OryHydraClient::RecoveryFlowMethod.new(
+  config: null,
+  method: null
+)
 ```
 
-

data/docs/RecoveryFlowMethodConfig.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. | 
-**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**method** | **String** | Method is the form method (e.g. POST) | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |  |
+| **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |  |
+| **messages** | [**Array<Message>**](Message.md) |  | [optional] |
+| **method** | **String** | Method is the form method (e.g. POST) |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RecoveryFlowMethodConfig.new(action: null,
-                                 fields: null,
-                                 messages: null,
-                                 method: null)
+instance = OryHydraClient::RecoveryFlowMethodConfig.new(
+  action: null,
+  fields: null,
+  messages: null,
+  method: null
+)
 ```
 
-

data/docs/RecoveryLink.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**expires_at** | **DateTime** | 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. | 
+| 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. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RecoveryLink.new(expires_at: null,
-                                 recovery_link: null)
+instance = OryHydraClient::RecoveryLink.new(
+  expires_at: null,
+  recovery_link: null
+)
 ```
 
-

data/docs/RegistrationFlow.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **String** | and so on. | [optional] 
-**expires_at** | **DateTime** | 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** | **DateTime** | IssuedAt is the time (UTC) when the flow occurred. | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**methods** | [**Hash<String, RegistrationFlowMethod>**](RegistrationFlowMethod.md) | Methods contains context for all enabled registration methods. If a registration flow has been processed, but for example the password is incorrect, this will contain error messages. | 
-**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] 
+| 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. |  |
+| **messages** | [**Array<Message>**](Message.md) |  | [optional] |
+| **methods** | [**Hash<String, RegistrationFlowMethod>**](RegistrationFlowMethod.md) | Methods contains context for all enabled registration methods. If a registration flow has been processed, but for example the password is incorrect, this will contain error messages. |  |
+| **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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RegistrationFlow.new(active: null,
-                                 expires_at: null,
-                                 id: null,
-                                 issued_at: null,
-                                 messages: null,
-                                 methods: null,
-                                 request_url: null,
-                                 type: null)
+instance = OryHydraClient::RegistrationFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  messages: null,
+  methods: null,
+  request_url: null,
+  type: null
+)
 ```
 
-

data/docs/RegistrationFlowMethod.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**config** | [**RegistrationFlowMethodConfig**](RegistrationFlowMethodConfig.md) |  | 
-**method** | **String** | and so on. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | [**RegistrationFlowMethodConfig**](RegistrationFlowMethodConfig.md) |  |  |
+| **method** | **String** | and so on. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RegistrationFlowMethod.new(config: null,
-                                 method: null)
+instance = OryHydraClient::RegistrationFlowMethod.new(
+  config: null,
+  method: null
+)
 ```
 
-

data/docs/RegistrationFlowMethodConfig.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. | 
-**fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**method** | **String** | Method is the form method (e.g. POST) | 
-**providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" registration method. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Action should be used as the form action URL `<form action=\"{{ .Action }}\" method=\"post\">`. |  |
+| **fields** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields |  |
+| **messages** | [**Array<Message>**](Message.md) |  | [optional] |
+| **method** | **String** | Method is the form method (e.g. POST) |  |
+| **providers** | [**Array<FormField>**](FormField.md) | Providers is set for the \"oidc\" registration method. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RegistrationFlowMethodConfig.new(action: null,
-                                 fields: null,
-                                 messages: null,
-                                 method: null,
-                                 providers: null)
+instance = OryHydraClient::RegistrationFlowMethodConfig.new(
+  action: null,
+  fields: null,
+  messages: null,
+  method: null,
+  providers: null
+)
 ```
 
-

data/docs/RegistrationViaApiResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**identity** | [**Identity**](Identity.md) |  | 
-**session** | [**Session**](Session.md) |  | [optional] 
-**session_token** | **String** | The Session Token  This field is only set when the session hook is configured as a post-registration hook.  A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:  Authorization: bearer ${session-token}  The session token is only issued for API flows, not for Browser flows! | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **session** | [**Session**](Session.md) |  | [optional] |
+| **session_token** | **String** | The Session Token  This field is only set when the session hook is configured as a post-registration hook.  A session token is equivalent to a session cookie, but it can be sent in the HTTP Authorization Header:  Authorization: bearer ${session-token}  The session token is only issued for API flows, not for Browser flows! |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RegistrationViaApiResponse.new(identity: null,
-                                 session: null,
-                                 session_token: null)
+instance = OryHydraClient::RegistrationViaApiResponse.new(
+  identity: null,
+  session: null,
+  session_token: null
+)
 ```
 
-

data/docs/RevokeSession.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**session_token** | **String** | The Session Token  Invalidate this session token. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_token** | **String** | The Session Token  Invalidate this session token. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::RevokeSession.new(session_token: null)
+instance = OryHydraClient::RevokeSession.new(
+  session_token: null
+)
 ```
 
-

data/docs/Session.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **Boolean** |  | [optional] 
-**authenticated_at** | **DateTime** |  | 
-**expires_at** | **DateTime** |  | 
-**id** | **String** |  | 
-**identity** | [**Identity**](Identity.md) |  | 
-**issued_at** | **DateTime** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** |  | [optional] |
+| **authenticated_at** | **Time** |  |  |
+| **expires_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **identity** | [**Identity**](Identity.md) |  |  |
+| **issued_at** | **Time** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::Session.new(active: null,
-                                 authenticated_at: null,
-                                 expires_at: null,
-                                 id: null,
-                                 identity: null,
-                                 issued_at: null)
+instance = OryHydraClient::Session.new(
+  active: null,
+  authenticated_at: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null
+)
 ```
 
-

data/docs/SettingsFlow.md

@@ -2,34 +2,35 @@
 
 ## 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** | **DateTime** | 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** | **DateTime** | IssuedAt is the time (UTC) when the flow occurred. | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**methods** | [**Hash<String, SettingsFlowMethod>**](SettingsFlowMethod.md) | Methods contains context for all enabled registration methods. If a settings flow has been processed, but for example the first name is empty, this will contain error messages. | 
-**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** | **String** |  | 
-**type** | **String** | The flow type can either be `api` or `browser`. | [optional] 
+| 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. |  |
+| **messages** | [**Array<Message>**](Message.md) |  | [optional] |
+| **methods** | [**Hash<String, SettingsFlowMethod>**](SettingsFlowMethod.md) | Methods contains context for all enabled registration methods. If a settings flow has been processed, but for example the first name is empty, this will contain error messages. |  |
+| **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** | **String** |  |  |
+| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::SettingsFlow.new(active: null,
-                                 expires_at: null,
-                                 id: null,
-                                 identity: null,
-                                 issued_at: null,
-                                 messages: null,
-                                 methods: null,
-                                 request_url: null,
-                                 state: null,
-                                 type: null)
+instance = OryHydraClient::SettingsFlow.new(
+  active: null,
+  expires_at: null,
+  id: null,
+  identity: null,
+  issued_at: null,
+  messages: null,
+  methods: null,
+  request_url: null,
+  state: null,
+  type: null
+)
 ```
 
-