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

data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md

@@ -2,20 +2,21 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod.new(csrf_token: null,
-                                 identifier: null,
-                                 password: null)
+instance = OryHydraClient::CompleteSelfServiceLoginFlowWithPasswordMethod.new(
+  csrf_token: null,
+  identifier: null,
+  password: null
+)
 ```
 
-

data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md

@@ -2,18 +2,19 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod.new(csrf_token: null,
-                                 email: null)
+instance = OryHydraClient::CompleteSelfServiceRecoveryFlowWithLinkMethod.new(
+  csrf_token: null,
+  email: null
+)
 ```
 
-

data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md

@@ -2,18 +2,19 @@
 
 ## 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 | 
+| 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new(csrf_token: null,
-                                 password: null)
+instance = OryHydraClient::CompleteSelfServiceSettingsFlowWithPasswordMethod.new(
+  csrf_token: null,
+  password: null
+)
 ```
 
-

data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md

@@ -2,18 +2,19 @@
 
 ## 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] 
+| 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod.new(csrf_token: null,
-                                 email: null)
+instance = OryHydraClient::CompleteSelfServiceVerificationFlowWithLinkMethod.new(
+  csrf_token: null,
+  email: null
+)
 ```
 
-

data/docs/CreateIdentity.md

@@ -2,18 +2,19 @@
 
 ## 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`. | 
+| 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** | 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CreateIdentity.new(schema_id: null,
-                                 traits: null)
+instance = OryHydraClient::CreateIdentity.new(
+  schema_id: null,
+  traits: null
+)
 ```
 
-

data/docs/CreateRecoveryLink.md

@@ -2,18 +2,19 @@
 
 ## 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** |  | 
+| 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
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::CreateRecoveryLink.new(expires_in: null,
-                                 identity_id: null)
+instance = OryHydraClient::CreateRecoveryLink.new(
+  expires_in: null,
+  identity_id: null
+)
 ```
 
-

data/docs/ErrorContainer.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**errors** | [**Object**](.md) | Errors in the container | 
-**id** | **String** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | **Object** | Errors in the container |  |
+| **id** | **String** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::ErrorContainer.new(errors: null,
-                                 id: null)
+instance = OryHydraClient::ErrorContainer.new(
+  errors: null,
+  id: null
+)
 ```
 
-

data/docs/FormField.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | Value is the equivalent of `<input value=\"{{.Value}}\">` | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::FormField.new(disabled: null,
-                                 messages: null,
-                                 name: null,
-                                 pattern: null,
-                                 required: null,
-                                 type: null,
-                                 value: null)
+instance = OryHydraClient::FormField.new(
+  disabled: null,
+  messages: null,
+  name: null,
+  pattern: null,
+  required: null,
+  type: null,
+  value: null
+)
 ```
 
-

data/docs/GenericError.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**GenericErrorPayload**](GenericErrorPayload.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**GenericErrorPayload**](GenericErrorPayload.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::GenericError.new(error: null)
+instance = OryHydraClient::GenericError.new(
+  error: null
+)
 ```
 
-

data/docs/GenericErrorPayload.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-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** | [**Object**](.md) |  | [optional] 
-**message** | **String** |  | [optional] 
-**reason** | **String** |  | [optional] 
-**request** | **String** |  | [optional] 
-**status** | **String** |  | [optional] 
+| 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** | **Object** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **reason** | **String** |  | [optional] |
+| **request** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-kratos-client'
 
-instance = OryHydraClient::GenericErrorPayload.new(code: 404,
-                                 debug: The database adapter was unable to find the element,
-                                 details: null,
-                                 message: null,
-                                 reason: null,
-                                 request: null,
-                                 status: null)
+instance = OryHydraClient::GenericErrorPayload.new(
+  code: 404,
+  debug: The database adapter was unable to find the element,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
 ```
 
-

data/docs/HealthApi.md

@@ -2,35 +2,52 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status
-[**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**is_instance_alive**](HealthApi.md#is_instance_alive) | **GET** /health/alive | Check alive status |
+| [**is_instance_ready**](HealthApi.md#is_instance_ready) | **GET** /health/ready | Check readiness status |
 
 
 ## is_instance_alive
 
-> HealthStatus is_instance_alive
+> <HealthStatus> is_instance_alive
 
 Check alive status
 
 This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-kratos-client'
 
 api_instance = OryHydraClient::HealthApi.new
 
 begin
-  #Check alive status
+  # Check alive status
   result = api_instance.is_instance_alive
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling HealthApi->is_instance_alive: #{e}"
+  puts "Error when calling HealthApi->is_instance_alive: #{e}"
+end
+```
+
+#### Using the is_instance_alive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthStatus>, Integer, Hash)> is_instance_alive_with_http_info
+
+```ruby
+begin
+  # Check alive status
+  data, status_code, headers = api_instance.is_instance_alive_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthStatus>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling HealthApi->is_instance_alive_with_http_info: #{e}"
 end
 ```
 
@@ -54,26 +71,44 @@ No authorization required
 
 ## is_instance_ready
 
-> HealthStatus is_instance_ready
+> <HealthStatus> is_instance_ready
 
 Check readiness status
 
 This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well.  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.  Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-kratos-client'
 
 api_instance = OryHydraClient::HealthApi.new
 
 begin
-  #Check readiness status
+  # Check readiness status
   result = api_instance.is_instance_ready
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling HealthApi->is_instance_ready: #{e}"
+  puts "Error when calling HealthApi->is_instance_ready: #{e}"
+end
+```
+
+#### Using the is_instance_ready_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthStatus>, Integer, Hash)> is_instance_ready_with_http_info
+
+```ruby
+begin
+  # Check readiness status
+  data, status_code, headers = api_instance.is_instance_ready_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthStatus>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling HealthApi->is_instance_ready_with_http_info: #{e}"
 end
 ```