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

data/docs/CommonApi.md

@@ -4,21 +4,69 @@ All URIs are relative to *http://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**get_schema**](CommonApi.md#get_schema) | **GET** /schemas/{id} | 
 [**get_self_service_browser_login_request**](CommonApi.md#get_self_service_browser_login_request) | **GET** /self-service/browser/flows/requests/login | Get the request context of browser-based login user flows
-[**get_self_service_browser_profile_management_request**](CommonApi.md#get_self_service_browser_profile_management_request) | **GET** /self-service/browser/flows/requests/profile | Get the request context of browser-based profile management flows
+[**get_self_service_browser_recovery_request**](CommonApi.md#get_self_service_browser_recovery_request) | **GET** /self-service/browser/flows/requests/recovery | Get the request context of browser-based recovery flows
 [**get_self_service_browser_registration_request**](CommonApi.md#get_self_service_browser_registration_request) | **GET** /self-service/browser/flows/requests/registration | Get the request context of browser-based registration user flows
+[**get_self_service_browser_settings_request**](CommonApi.md#get_self_service_browser_settings_request) | **GET** /self-service/browser/flows/requests/settings | Get the request context of browser-based settings flows
 [**get_self_service_error**](CommonApi.md#get_self_service_error) | **GET** /self-service/errors | Get user-facing self-service errors
 [**get_self_service_verification_request**](CommonApi.md#get_self_service_verification_request) | **GET** /self-service/browser/flows/requests/verification | Get the request context of browser-based verification flows
 
 
 
+## get_schema
+
+> Object get_schema(id)
+
+
+
+Get a traits schema definition
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::CommonApi.new
+id = 'id_example' # String | ID must be set to the ID of schema you want to get
+
+begin
+  result = api_instance.get_schema(id)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling CommonApi->get_schema: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID must be set to the ID of schema you want to get | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_self_service_browser_login_request
 
 > LoginRequest get_self_service_browser_login_request(request)
 
 Get the request context of browser-based login user flows
 
-This endpoint returns a login request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
+This endpoint returns a login request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
 
 ### Example
 
@@ -59,13 +107,13 @@ No authorization required
 - **Accept**: application/json
 
 
-## get_self_service_browser_profile_management_request
+## get_self_service_browser_recovery_request
 
-> ProfileManagementRequest get_self_service_browser_profile_management_request(request)
+> RecoveryRequest get_self_service_browser_recovery_request(request)
 
-Get the request context of browser-based profile management flows
+Get the request context of browser-based recovery flows
 
-When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500.  More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
+When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500.  More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
 
 ### Example
 
@@ -74,14 +122,14 @@ When accessing this endpoint through ORY Kratos' Public API, ensure that cookies
 require 'ory-kratos-client'
 
 api_instance = OryHydraClient::CommonApi.new
-request = 'request_example' # String | Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
+request = 'request_example' # String | Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`).
 
 begin
-  #Get the request context of browser-based profile management flows
-  result = api_instance.get_self_service_browser_profile_management_request(request)
+  #Get the request context of browser-based recovery flows
+  result = api_instance.get_self_service_browser_recovery_request(request)
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling CommonApi->get_self_service_browser_profile_management_request: #{e}"
+  puts "Exception when calling CommonApi->get_self_service_browser_recovery_request: #{e}"
 end
 ```
 
@@ -90,11 +138,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **request** | **String**| Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`). | 
+ **request** | **String**| Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recover?request=abcde`). | 
 
 ### Return type
 
-[**ProfileManagementRequest**](ProfileManagementRequest.md)
+[**RecoveryRequest**](RecoveryRequest.md)
 
 ### Authorization
 
@@ -112,7 +160,7 @@ No authorization required
 
 Get the request context of browser-based registration user flows
 
-This endpoint returns a registration request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
+This endpoint returns a registration request's context with, for example, error details and other information.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes.  More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
 
 ### Example
 
@@ -153,13 +201,60 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_self_service_browser_settings_request
+
+> SettingsRequest get_self_service_browser_settings_request(request)
+
+Get the request context of browser-based settings flows
+
+When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500.  More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::CommonApi.new
+request = 'request_example' # String | Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`).
+
+begin
+  #Get the request context of browser-based settings flows
+  result = api_instance.get_self_service_browser_settings_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling CommonApi->get_self_service_browser_settings_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | **String**| Request is the Login Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/settingss?request=abcde`). | 
+
+### Return type
+
+[**SettingsRequest**](SettingsRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_self_service_error
 
 > ErrorContainer get_self_service_error(opts)
 
 Get user-facing self-service errors
 
-This endpoint returns the error associated with a user-facing self service errors.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks.  More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
+This endpoint returns the error associated with a user-facing self service errors.  When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes.  More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
 
 ### Example
 
@@ -169,7 +264,7 @@ require 'ory-kratos-client'
 
 api_instance = OryHydraClient::CommonApi.new
 opts = {
-  id: 'id_example' # String | 
+  error: 'error_example' # String | 
 }
 
 begin
@@ -186,7 +281,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**|  | [optional] 
+ **error** | **String**|  | [optional] 
 
 ### Return type
 

data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | RequestID is request ID.  in: query | [optional] 
+**traits** | [**Object**](.md) | Traits contains all of the identity's traits.  type: string format: binary | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.new(request_id: null,
+                                 traits: null)
+```
+
+

data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md

@@ -0,0 +1,21 @@
+# OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] 
+**identifier** | **String** | Identifier is the email or username of the user trying to log in. | [optional] 
+**password** | **String** | The user's password. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod.new(csrf_token: null,
+                                 identifier: null,
+                                 password: null)
+```
+
+

data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod
+
+## 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 in: body | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod.new(csrf_token: null,
+                                 email: null)
+```
+
+

data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**csrf_token** | **String** | CSRFToken is the anti-CSRF token  type: string | [optional] 
+**password** | **String** | Password is the updated password  type: string | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new(csrf_token: null,
+                                 password: null)
+```
+
+

data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod
+
+## 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 Verify  Needs to be set when initiating the flow. If the email is a registered verification email, a verification link will be sent. If the email is not known, a email with details on what happened will be sent instead.  format: email in: body | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod.new(csrf_token: null,
+                                 email: null)
+```
+
+

data/docs/CreateIdentity.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CreateIdentity
+
+## 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. | 
+**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_url`. | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateIdentity.new(schema_id: null,
+                                 traits: null)
+```
+
+

data/docs/CreateRecoveryLink.md

@@ -0,0 +1,19 @@
+# OryHydraClient::CreateRecoveryLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expires_in** | **String** | Link Expires In  The recovery link will expire at that point in time. Defaults to the configuration value of `selfservice.flows.recovery.request_lifespan`. | [optional] 
+**identity_id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CreateRecoveryLink.new(expires_in: null,
+                                 identity_id: null)
+```
+
+

data/docs/ErrorContainer.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errors** | [**Object**](.md) |  | [optional] 
-**id** | **String** |  | [optional] 
+**errors** | [**Object**](.md) | Errors in the container | 
+**id** | **String** |  | 
 
 ## Code Sample
 

data/docs/Form.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**action** | **String** | Action should be used as the form action URL (<form action=\"{{ .Action }}\" method=\"post\">). | 
-**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional] 
+**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
@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 require 'OryHydraClient'
 
 instance = OryHydraClient::Form.new(action: null,
-                                 errors: null,
                                  fields: null,
+                                 messages: null,
                                  method: null)
 ```
 

data/docs/FormField.md

@@ -4,13 +4,13 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**disabled** | **Boolean** | Disabled is the equivalent of <input disabled=\"{{.Disabled}}\"> | [optional] 
-**errors** | [**Array<Error>**](Error.md) | Errors contains all validation errors this particular field has caused. | [optional] 
-**name** | **String** | Name is the equivalent of <input name=\"{{.Name}}\"> | 
-**pattern** | **String** | Pattern is the equivalent of <input pattern=\"{{.Pattern}}\"> | [optional] 
-**required** | **Boolean** | Required is the equivalent of <input required=\"{{.Required}}\"> | 
-**type** | **String** | Type is the equivalent of <input type=\"{{.Type}}\"> | 
-**value** | [**Object**](.md) | Value is the equivalent of <input value=\"{{.Value}}\"> | [optional] 
+**disabled** | **Boolean** | Disabled is the equivalent of `<input {{if .Disabled}}disabled{{end}}\">` | [optional] 
+**messages** | [**Array<Message>**](Message.md) |  | [optional] 
+**name** | **String** | Name is the equivalent of `<input name=\"{{.Name}}\">` | 
+**pattern** | **String** | Pattern is the equivalent of `<input pattern=\"{{.Pattern}}\">` | [optional] 
+**required** | **Boolean** | Required is the equivalent of `<input required=\"{{.Required}}\">` | [optional] 
+**type** | **String** | Type is the equivalent of `<input type=\"{{.Type}}\">` | 
+**value** | [**Object**](.md) | Value is the equivalent of `<input value=\"{{.Value}}\">` | [optional] 
 
 ## Code Sample
 
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 require 'OryHydraClient'
 
 instance = OryHydraClient::FormField.new(disabled: null,
-                                 errors: null,
+                                 messages: null,
                                  name: null,
                                  pattern: null,
                                  required: null,

data/docs/GenericErrorPayload.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **Integer** | Code represents the error status code (404, 403, 401, ...). | [optional] 
 **debug** | **String** | Debug contains debug information. This is usually not available and has to be enabled. | [optional] 
-**details** | **Array<Hash<String, Object>>** |  | [optional] 
+**details** | [**Object**](.md) |  | [optional] 
 **message** | **String** |  | [optional] 
 **reason** | **String** |  | [optional] 
 **request** | **String** |  | [optional] 

data/docs/Identity.md

@@ -4,22 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) |  | [optional] 
 **id** | **String** |  | 
+**recovery_addresses** | [**Array<RecoveryAddress>**](RecoveryAddress.md) | RecoveryAddresses contains all the addresses that can be used to recover an identity. | [optional] 
+**schema_id** | **String** | SchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | 
+**schema_url** | **String** | SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.  format: url | 
 **traits** | [**Object**](.md) |  | 
-**traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | 
-**traits_schema_url** | **String** | TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.  format: url | [optional] 
+**verifiable_addresses** | [**Array<VerifiableAddress>**](VerifiableAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'OryHydraClient'
 
-instance = OryHydraClient::Identity.new(addresses: null,
-                                 id: null,
+instance = OryHydraClient::Identity.new(id: null,
+                                 recovery_addresses: null,
+                                 schema_id: null,
+                                 schema_url: null,
                                  traits: null,
-                                 traits_schema_id: null,
-                                 traits_schema_url: null)
+                                 verifiable_addresses: null)
 ```