ory-client 0.0.1.alpha14 → 0.0.1.alpha18

data/docs/ContainerChangeResponseItem.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerChangeResponseItem
+# OryClient::ContainerChangeResponseItem
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerChangeResponseItem.new(
+instance = OryClient::ContainerChangeResponseItem.new(
   kind: null,
   path: null
 )

data/docs/ContainerCreateCreatedBody.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerCreateCreatedBody
+# OryClient::ContainerCreateCreatedBody
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerCreateCreatedBody.new(
+instance = OryClient::ContainerCreateCreatedBody.new(
   id: null,
   warnings: null
 )

data/docs/ContainerTopOKBody.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerTopOKBody
+# OryClient::ContainerTopOKBody
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerTopOKBody.new(
+instance = OryClient::ContainerTopOKBody.new(
   processes: null,
   titles: null
 )

data/docs/ContainerUpdateOKBody.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerUpdateOKBody
+# OryClient::ContainerUpdateOKBody
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerUpdateOKBody.new(
+instance = OryClient::ContainerUpdateOKBody.new(
   warnings: null
 )
 ```

data/docs/ContainerWaitOKBody.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerWaitOKBody
+# OryClient::ContainerWaitOKBody
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerWaitOKBody.new(
+instance = OryClient::ContainerWaitOKBody.new(
   error: null,
   status_code: null
 )

data/docs/ContainerWaitOKBodyError.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ContainerWaitOKBodyError
+# OryClient::ContainerWaitOKBodyError
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ContainerWaitOKBodyError.new(
+instance = OryClient::ContainerWaitOKBodyError.new(
   message: null
 )
 ```

data/docs/ErrorResponse.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ErrorResponse
+# OryClient::ErrorResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ErrorResponse.new(
+instance = OryClient::ErrorResponse.new(
   message: null
 )
 ```

data/docs/GenericError.md

@@ -1,4 +1,4 @@
-# OryHydraClient::GenericError
+# OryClient::GenericError
 
 ## Properties
 
@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **code** | **Integer** | The status code | [optional] |
 | **debug** | **String** | Debug information  This field is often not exposed to protect against leaking sensitive information. | [optional] |
-| **details** | **Hash<String, Object>** | Further error details | [optional] |
+| **details** | **Object** | Further error details | [optional] |
 | **message** | **String** | Error message  The error's message. |  |
 | **reason** | **String** | A human-readable reason for the error | [optional] |
 | **request** | **String** | The request ID  The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional] |
@@ -17,7 +17,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::GenericError.new(
+instance = OryClient::GenericError.new(
   code: 404,
   debug: SQL field "foo" is not a bool.,
   details: null,

data/docs/GraphDriverData.md

@@ -1,4 +1,4 @@
-# OryHydraClient::GraphDriverData
+# OryClient::GraphDriverData
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::GraphDriverData.new(
+instance = OryClient::GraphDriverData.new(
   data: null,
   name: null
 )

data/docs/HealthNotReadyStatus.md

@@ -1,4 +1,4 @@
-# OryHydraClient::HealthNotReadyStatus
+# OryClient::HealthNotReadyStatus
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::HealthNotReadyStatus.new(
+instance = OryClient::HealthNotReadyStatus.new(
   errors: null
 )
 ```

data/docs/HealthStatus.md

@@ -1,4 +1,4 @@
-# OryHydraClient::HealthStatus
+# OryClient::HealthStatus
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::HealthStatus.new(
+instance = OryClient::HealthStatus.new(
   status: null
 )
 ```

data/docs/IdResponse.md

@@ -1,4 +1,4 @@
-# OryHydraClient::IdResponse
+# OryClient::IdResponse
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::IdResponse.new(
+instance = OryClient::IdResponse.new(
   id: null
 )
 ```

data/docs/Identity.md

@@ -1,14 +1,17 @@
-# OryHydraClient::Identity
+# OryClient::Identity
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+| **credentials** | [**Hash<String, IdentityCredentials>**](IdentityCredentials.md) | Credentials represents all credentials that can be used for authenticating this identity. | [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 |  |
+| **state** | [**IdentityState**](IdentityState.md) |  | [optional] |
+| **state_changed_at** | **Time** |  | [optional] |
 | **traits** | [**AnyType**](.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`. |  |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **verifiable_addresses** | [**Array<VerifiableIdentityAddress>**](VerifiableIdentityAddress.md) | VerifiableAddresses contains all the addresses that can be verified by the user. | [optional] |
@@ -18,12 +21,15 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::Identity.new(
+instance = OryClient::Identity.new(
   created_at: null,
+  credentials: null,
   id: null,
   recovery_addresses: null,
   schema_id: null,
   schema_url: null,
+  state: null,
+  state_changed_at: null,
   traits: null,
   updated_at: null,
   verifiable_addresses: null

data/docs/IdentityCredentials.md

@@ -1,4 +1,4 @@
-# OryHydraClient::IdentityCredentials
+# OryClient::IdentityCredentials
 
 ## Properties
 
@@ -7,7 +7,7 @@
 | **config** | **Object** |  | [optional] |
 | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 | **identifiers** | **Array<String>** | Identifiers represents a list of unique identifiers this credential type matches. | [optional] |
-| **type** | **String** | and so on. | [optional] |
+| **type** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
 | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
 
 ## Example
@@ -15,7 +15,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::IdentityCredentials.new(
+instance = OryClient::IdentityCredentials.new(
   config: null,
   created_at: null,
   identifiers: null,

data/docs/IdentityCredentialsType.md

@@ -0,0 +1,15 @@
+# OryClient::IdentityCredentialsType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::IdentityCredentialsType.new()
+```
+

data/docs/IdentityState.md

@@ -0,0 +1,15 @@
+# OryClient::IdentityState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::IdentityState.new()
+```
+

data/docs/ImageDeleteResponseItem.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ImageDeleteResponseItem
+# OryClient::ImageDeleteResponseItem
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ImageDeleteResponseItem.new(
+instance = OryClient::ImageDeleteResponseItem.new(
   deleted: null,
   untagged: null
 )

data/docs/ImageSummary.md

@@ -1,4 +1,4 @@
-# OryHydraClient::ImageSummary
+# OryClient::ImageSummary
 
 ## Properties
 
@@ -20,7 +20,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::ImageSummary.new(
+instance = OryClient::ImageSummary.new(
   containers: null,
   created: null,
   id: null,

data/docs/InlineResponse200.md

@@ -1,4 +1,4 @@
-# OryHydraClient::InlineResponse200
+# OryClient::InlineResponse200
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::InlineResponse200.new(
+instance = OryClient::InlineResponse200.new(
   status: null
 )
 ```

data/docs/InlineResponse2001.md

@@ -1,4 +1,4 @@
-# OryHydraClient::InlineResponse2001
+# OryClient::InlineResponse2001
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::InlineResponse2001.new(
+instance = OryClient::InlineResponse2001.new(
   version: null
 )
 ```

data/docs/InlineResponse503.md

@@ -1,4 +1,4 @@
-# OryHydraClient::InlineResponse503
+# OryClient::InlineResponse503
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::InlineResponse503.new(
+instance = OryClient::InlineResponse503.new(
   errors: null
 )
 ```

data/docs/JsonError.md

@@ -1,4 +1,4 @@
-# OryHydraClient::JsonError
+# OryClient::JsonError
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::JsonError.new(
+instance = OryClient::JsonError.new(
   error: null
 )
 ```

data/docs/Meta.md

@@ -1,4 +1,4 @@
-# OryHydraClient::Meta
+# OryClient::Meta
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'ory-client'
 
-instance = OryHydraClient::Meta.new(
+instance = OryClient::Meta.new(
   label: null
 )
 ```

data/docs/MetadataApi.md

@@ -0,0 +1,254 @@
+# OryClient::MetadataApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_version**](MetadataApi.md#get_version) | **GET** /api/kratos/public/version | Return Running Software Version. |
+| [**is_alive**](MetadataApi.md#is_alive) | **GET** /api/kratos/public/health/alive | Check HTTP Server Status |
+| [**is_ready**](MetadataApi.md#is_ready) | **GET** /api/kratos/public/health/ready | Check HTTP Server and Database Status |
+| [**prometheus**](MetadataApi.md#prometheus) | **GET** /api/kratos/public/metrics/prometheus | Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so: |
+
+
+## get_version
+
+> <InlineResponse2001> get_version
+
+Return Running Software Version.
+
+This endpoint returns the version of Ory Kratos.  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 version will never refer to the cluster state, only to a single instance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::MetadataApi.new
+
+begin
+  # Return Running Software Version.
+  result = api_instance.get_version
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->get_version: #{e}"
+end
+```
+
+#### Using the get_version_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse2001>, Integer, Hash)> get_version_with_http_info
+
+```ruby
+begin
+  # Return Running Software Version.
+  data, status_code, headers = api_instance.get_version_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse2001>
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->get_version_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_alive
+
+> <InlineResponse200> is_alive
+
+Check HTTP Server Status
+
+This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. 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-client'
+
+api_instance = OryClient::MetadataApi.new
+
+begin
+  # Check HTTP Server Status
+  result = api_instance.is_alive
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->is_alive: #{e}"
+end
+```
+
+#### Using the is_alive_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> is_alive_with_http_info
+
+```ruby
+begin
+  # Check HTTP Server Status
+  data, status_code, headers = api_instance.is_alive_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->is_alive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## is_ready
+
+> <InlineResponse200> is_ready
+
+Check HTTP Server and Database Status
+
+This endpoint returns a HTTP 200 status code when Ory Kratos 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 Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::MetadataApi.new
+
+begin
+  # Check HTTP Server and Database Status
+  result = api_instance.is_ready
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->is_ready: #{e}"
+end
+```
+
+#### Using the is_ready_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> is_ready_with_http_info
+
+```ruby
+begin
+  # Check HTTP Server and Database Status
+  data, status_code, headers = api_instance.is_ready_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->is_ready_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## prometheus
+
+> prometheus
+
+Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+
+``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::MetadataApi.new
+
+begin
+  # Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+  api_instance.prometheus
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->prometheus: #{e}"
+end
+```
+
+#### Using the prometheus_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> prometheus_with_http_info
+
+```ruby
+begin
+  # Get snapshot metrics from the service. If you're using k8s, you can then add annotations to your deployment like so:
+  data, status_code, headers = api_instance.prometheus_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling MetadataApi->prometheus_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+