ory-kratos-client 0.5.5.alpha2 → 0.6.0.alpha4

data/docs/FormField.md

@@ -1,30 +0,0 @@
-# OryHydraClient::FormField
-
-## 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** | Value is the equivalent of `<input value=\"{{.Value}}\">` | [optional] |
-
-## Example
-
-```ruby
-require 'ory-kratos-client'
-
-instance = OryHydraClient::FormField.new(
-  disabled: null,
-  messages: null,
-  name: null,
-  pattern: null,
-  required: null,
-  type: null,
-  value: null
-)
-```
-

data/docs/HealthApi.md

@@ -1,131 +0,0 @@
-# OryHydraClient::HealthApi
-
-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 |
-
-
-## 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.
-
-### Examples
-
-```ruby
-require 'time'
-require 'ory-kratos-client'
-
-api_instance = OryHydraClient::HealthApi.new
-
-begin
-  # Check alive status
-  result = api_instance.is_instance_alive
-  p result
-rescue OryHydraClient::ApiError => 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
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**HealthStatus**](HealthStatus.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## 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.
-
-### Examples
-
-```ruby
-require 'time'
-require 'ory-kratos-client'
-
-api_instance = OryHydraClient::HealthApi.new
-
-begin
-  # Check readiness status
-  result = api_instance.is_instance_ready
-  p result
-rescue OryHydraClient::ApiError => 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
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**HealthStatus**](HealthStatus.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/LoginFlowMethod.md

@@ -1,20 +0,0 @@
-# OryHydraClient::LoginFlowMethod
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **config** | [**LoginFlowMethodConfig**](LoginFlowMethodConfig.md) |  |  |
-| **method** | **String** | and so on. |  |
-
-## Example
-
-```ruby
-require 'ory-kratos-client'
-
-instance = OryHydraClient::LoginFlowMethod.new(
-  config: null,
-  method: null
-)
-```
-

data/docs/LoginFlowMethodConfig.md

@@ -1,26 +0,0 @@
-# OryHydraClient::LoginFlowMethodConfig
-
-## 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\" flow method. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-kratos-client'
-
-instance = OryHydraClient::LoginFlowMethodConfig.new(
-  action: null,
-  fields: null,
-  messages: null,
-  method: null,
-  providers: null
-)
-```
-

data/docs/LoginRequest.md

@@ -1,31 +0,0 @@
-# OryHydraClient::LoginRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**active** | **String** | and so on. | [optional] 
-**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to log in, a new request has to be initiated. | 
-**forced** | **Boolean** | Forced stores whether this login request should enforce reauthentication. | [optional] 
-**id** | **String** |  | 
-**issued_at** | **DateTime** | IssuedAt is the time (UTC) when the request occurred. | 
-**messages** | [**Array<Message>**](Message.md) |  | [optional] 
-**methods** | [**Hash<String, LoginRequestMethod>**](LoginRequestMethod.md) | Methods contains context for all enabled login methods. If a login 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. | 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::LoginRequest.new(active: null,
-                                 expires_at: null,
-                                 forced: null,
-                                 id: null,
-                                 issued_at: null,
-                                 messages: null,
-                                 methods: null,
-                                 request_url: null)
-```
-
-

data/docs/LoginRequestMethod.md

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

data/docs/LoginRequestMethodConfig.md

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

data/docs/Message.md

@@ -1,24 +0,0 @@
-# OryHydraClient::Message
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **context** | **Object** |  | [optional] |
-| **id** | **Integer** |  | [optional] |
-| **text** | **String** |  | [optional] |
-| **type** | **String** | The flow type can either be `api` or `browser`. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-kratos-client'
-
-instance = OryHydraClient::Message.new(
-  context: null,
-  id: null,
-  text: null,
-  type: null
-)
-```
-

data/docs/OidcStrategyCredentialsConfig.md

@@ -1,19 +0,0 @@
-# OryHydraClient::OidcStrategyCredentialsConfig
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**provider** | **String** |  | [optional] 
-**subject** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::OidcStrategyCredentialsConfig.new(provider: null,
-                                 subject: null)
-```
-
-

data/docs/OidcStrategyRequestMethod.md

@@ -1,25 +0,0 @@
-# OryHydraClient::OidcStrategyRequestMethod
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**action** | **String** | Action should be used as the form action URL (<form action=\"{{ .Action }}\" method=\"post\">). | [optional] 
-**errors** | [**Array<Error>**](Error.md) | Errors contains all form errors. These will be duplicates of the individual field errors. | [optional] 
-**fields** | [**Hash<String, FormField>**](FormField.md) | Fields contains multiple fields asdfasdf | [optional] 
-**method** | **String** | Method is the form method (e.g. POST) | [optional] 
-**providers** | [**Array<FormField>**](FormField.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::OidcStrategyRequestMethod.new(action: null,
-                                 errors: null,
-                                 fields: null,
-                                 method: null,
-                                 providers: null)
-```
-
-

data/docs/ProfileManagementRequest.md

@@ -1,29 +0,0 @@
-# OryHydraClient::ProfileManagementRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**expires_at** | **DateTime** | ExpiresAt is the time (UTC) when the request expires. If the user still wishes to update the profile, a new request has to be initiated. | 
-**form** | [**Form**](Form.md) |  | 
-**id** | **String** |  | 
-**identity** | [**Identity**](Identity.md) |  | 
-**issued_at** | **DateTime** | 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. | 
-**update_successful** | **Boolean** | UpdateSuccessful, if true, indicates that the profile has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a request with invalid (e.g. \"please use a valid phone number\") data was sent. | 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::ProfileManagementRequest.new(expires_at: null,
-                                 form: null,
-                                 id: null,
-                                 identity: null,
-                                 issued_at: null,
-                                 request_url: null,
-                                 update_successful: null)
-```
-
-

data/docs/ProviderCredentialsConfig.md

@@ -1,19 +0,0 @@
-# OryHydraClient::ProviderCredentialsConfig
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**provider** | **String** |  | [optional] 
-**subject** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::ProviderCredentialsConfig.new(provider: null,
-                                 subject: null)
-```
-
-

data/docs/RecoveryFlowMethod.md

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

data/docs/RecoveryRequest.md

@@ -1,31 +0,0 @@
-# OryHydraClient::RecoveryRequest
-
-## 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, RecoveryRequestMethod>**](RecoveryRequestMethod.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** |  | 
-
-## Code Sample
-
-```ruby
-require 'OryHydraClient'
-
-instance = OryHydraClient::RecoveryRequest.new(active: null,
-                                 expires_at: null,
-                                 id: null,
-                                 issued_at: null,
-                                 messages: null,
-                                 methods: null,
-                                 request_url: null,
-                                 state: null)
-```
-
-