ory-kratos-client 0.4.6.alpha1 → 0.5.0.alpha1

data/docs/RecoveryFlow.md

@@ -0,0 +1,33 @@
+# OryHydraClient::RecoveryFlow
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+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

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

data/docs/RecoveryFlowMethodConfig.md

@@ -0,0 +1,23 @@
+# OryHydraClient::RecoveryFlowMethodConfig
+
+## 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) | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::RecoveryFlowMethodConfig.new(action: null,
+                                 fields: null,
+                                 messages: null,
+                                 method: null)
+```
+
+

data/docs/RecoveryLink.md

@@ -0,0 +1,19 @@
+# OryHydraClient::RecoveryLink
+
+## 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. | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::RecoveryLink.new(expires_at: null,
+                                 recovery_link: null)
+```
+
+

data/docs/RegistrationFlow.md

@@ -0,0 +1,31 @@
+# OryHydraClient::RegistrationFlow
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+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

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

data/docs/RegistrationFlowMethodConfig.md

@@ -0,0 +1,25 @@
+# OryHydraClient::RegistrationFlowMethodConfig
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::RegistrationFlowMethodConfig.new(action: null,
+                                 fields: null,
+                                 messages: null,
+                                 method: null,
+                                 providers: null)
+```
+
+

data/docs/RegistrationViaApiResponse.md

@@ -0,0 +1,21 @@
+# OryHydraClient::RegistrationViaApiResponse
+
+## 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! | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::RegistrationViaApiResponse.new(identity: null,
+                                 session: null,
+                                 session_token: null)
+```
+
+

data/docs/RevokeSession.md

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

data/docs/Session.md

@@ -4,22 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**active** | **Boolean** |  | [optional] 
 **authenticated_at** | **DateTime** |  | 
 **expires_at** | **DateTime** |  | 
+**id** | **String** |  | 
 **identity** | [**Identity**](Identity.md) |  | 
 **issued_at** | **DateTime** |  | 
-**sid** | **String** |  | 
 
 ## Code Sample
 
 ```ruby
 require 'OryHydraClient'
 
-instance = OryHydraClient::Session.new(authenticated_at: null,
+instance = OryHydraClient::Session.new(active: null,
+                                 authenticated_at: null,
                                  expires_at: null,
+                                 id: null,
                                  identity: null,
-                                 issued_at: null,
-                                 sid: null)
+                                 issued_at: null)
 ```
 
 

data/docs/SettingsFlow.md

@@ -0,0 +1,35 @@
+# OryHydraClient::SettingsFlow
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+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)
+```
+
+

data/docs/SettingsFlowMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::SettingsFlowMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config** | [**SettingsFlowMethodConfig**](SettingsFlowMethodConfig.md) |  | 
+**method** | **String** | Method is the name of this flow method. | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::SettingsFlowMethod.new(config: null,
+                                 method: null)
+```
+
+

data/docs/SettingsFlowMethodConfig.md

@@ -0,0 +1,23 @@
+# OryHydraClient::SettingsFlowMethodConfig
+
+## 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) | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::SettingsFlowMethodConfig.new(action: null,
+                                 fields: null,
+                                 messages: null,
+                                 method: null)
+```
+
+

data/docs/SettingsViaApiResponse.md

@@ -0,0 +1,19 @@
+# OryHydraClient::SettingsViaApiResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**flow** | [**SettingsFlow**](SettingsFlow.md) |  | 
+**identity** | [**Identity**](Identity.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::SettingsViaApiResponse.new(flow: null,
+                                 identity: null)
+```
+
+

data/docs/UpdateIdentity.md

@@ -0,0 +1,19 @@
+# OryHydraClient::UpdateIdentity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. If set will update the Identity's SchemaID. | [optional] 
+**traits** | [**Object**](.md) | Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in `schema_id`. | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::UpdateIdentity.new(schema_id: null,
+                                 traits: null)
+```
+
+

data/docs/VerifiableAddress.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**expires_at** | **DateTime** |  | 
 **id** | **String** |  | 
+**status** | **String** |  | 
 **value** | **String** |  | 
 **verified** | **Boolean** |  | 
 **verified_at** | **DateTime** |  | [optional] 
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'OryHydraClient'
 
-instance = OryHydraClient::VerifiableAddress.new(expires_at: null,
-                                 id: null,
+instance = OryHydraClient::VerifiableAddress.new(id: null,
+                                 status: null,
                                  value: null,
                                  verified: null,
                                  verified_at: null,

data/docs/VerificationFlow.md

@@ -0,0 +1,33 @@
+# OryHydraClient::VerificationFlow
+
+## 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 verify the address, a new request has to be initiated. | [optional] 
+**id** | **String** |  | [optional] 
+**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | [optional] 
+**messages** | [**Array<Message>**](Message.md) |  | [optional] 
+**methods** | [**Hash<String, VerificationFlowMethod>**](VerificationFlowMethod.md) | Methods contains context for all account verification 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. | [optional] 
+**state** | **String** |  | 
+**type** | **String** | The flow type can either be `api` or `browser`. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::VerificationFlow.new(active: null,
+                                 expires_at: null,
+                                 id: null,
+                                 issued_at: null,
+                                 messages: null,
+                                 methods: null,
+                                 request_url: null,
+                                 state: null,
+                                 type: null)
+```
+
+

data/docs/VerificationFlowMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::VerificationFlowMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config** | [**VerificationFlowMethodConfig**](VerificationFlowMethodConfig.md) |  | 
+**method** | **String** | Method contains the request credentials type. | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::VerificationFlowMethod.new(config: null,
+                                 method: null)
+```
+
+