ory-kratos-client 0.0.3.alpha2

data/docs/CommonApi.md

@@ -0,0 +1,152 @@
+# OryHydraClient::CommonApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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_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_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).
+
+### 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. `/login?request=abcde`).
+
+begin
+  #Get the request context of browser-based login user flows
+  result = api_instance.get_self_service_browser_login_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling CommonApi->get_self_service_browser_login_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. `/login?request=abcde`). | 
+
+### Return type
+
+[**LoginRequest**](LoginRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_self_service_browser_profile_management_request
+
+> ProfileManagementRequest get_self_service_browser_profile_management_request(request)
+
+Get the request context of browser-based profile management 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).
+
+### 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. `/login?request=abcde`).
+
+begin
+  #Get the request context of browser-based profile management flows
+  result = api_instance.get_self_service_browser_profile_management_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling CommonApi->get_self_service_browser_profile_management_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. `/login?request=abcde`). | 
+
+### Return type
+
+[**ProfileManagementRequest**](ProfileManagementRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_self_service_browser_registration_request
+
+> RegistrationRequest get_self_service_browser_registration_request(request)
+
+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).
+
+### Example
+
+```ruby
+# load the gem
+require 'ory-kratos-client'
+
+api_instance = OryHydraClient::CommonApi.new
+request = 'request_example' # String | Request is the Registration Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`).
+
+begin
+  #Get the request context of browser-based registration user flows
+  result = api_instance.get_self_service_browser_registration_request(request)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Exception when calling CommonApi->get_self_service_browser_registration_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | **String**| Request is the Registration Request ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/registration?request=abcde`). | 
+
+### Return type
+
+[**RegistrationRequest**](RegistrationRequest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CompleteSelfServiceBrowserProfileManagementFlowPayload.md

@@ -0,0 +1,17 @@
+# OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**traits** | [**Object**](.md) | Traits contains all of the identity's traits.  type: string format: binary | 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::CompleteSelfServiceBrowserProfileManagementFlowPayload.new(traits: null)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,17 @@
+# OryHydraClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Code    FormErrorCode `json:\"id,omitempty\"` | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::Error.new(message: null)
+```
+
+

data/docs/Form.md

@@ -0,0 +1,23 @@
+# OryHydraClient::Form
+
+## 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** | [**Array<FormField>**](FormField.md) | Fields contains multiple fields | [optional] 
+**method** | **String** | Method is the form method (e.g. POST) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::Form.new(action: null,
+                                 errors: null,
+                                 fields: null,
+                                 method: null)
+```
+
+

data/docs/FormField.md

@@ -0,0 +1,25 @@
+# OryHydraClient::FormField
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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}}\"> | [optional] 
+**required** | **Boolean** | Required is the equivalent of <input required=\"{{.Required}}\"> | [optional] 
+**type** | **String** | Type is the equivalent of <input type=\"{{.Type}}\"> | [optional] 
+**value** | [**Object**](.md) | Value is the equivalent of <input value=\"{{.Value}}\"> | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::FormField.new(errors: null,
+                                 name: null,
+                                 required: null,
+                                 type: null,
+                                 value: null)
+```
+
+

data/docs/GenericError.md

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

data/docs/GenericErrorPayload.md

@@ -0,0 +1,29 @@
+# OryHydraClient::GenericErrorPayload
+
+## 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** | **Array<Hash<String, Object>>** |  | [optional] 
+**message** | **String** |  | [optional] 
+**reason** | **String** |  | [optional] 
+**request** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+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

@@ -0,0 +1,96 @@
+# 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.
+
+### Example
+
+```ruby
+# load the gem
+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 "Exception when calling HealthApi->is_instance_alive: #{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.
+
+### Example
+
+```ruby
+# load the gem
+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 "Exception when calling HealthApi->is_instance_ready: #{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/HealthNotReadyStatus.md

@@ -0,0 +1,17 @@
+# OryHydraClient::HealthNotReadyStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::HealthNotReadyStatus.new(errors: null)
+```
+
+

data/docs/HealthStatus.md

@@ -0,0 +1,17 @@
+# OryHydraClient::HealthStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Status always contains \"ok\". | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::HealthStatus.new(status: null)
+```
+
+

data/docs/Identity.md

@@ -0,0 +1,23 @@
+# OryHydraClient::Identity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**traits** | [**Object**](.md) |  | 
+**traits_schema_id** | **String** | TraitsSchemaID is the ID of the JSON Schema to be used for validating the identity's traits. | [optional] 
+**traits_schema_url** | **String** | TraitsSchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.  format: url | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OryHydraClient'
+
+instance = OryHydraClient::Identity.new(id: null,
+                                 traits: null,
+                                 traits_schema_id: null,
+                                 traits_schema_url: null)
+```
+
+