ory-kratos-client 0.6.1.alpha1 → 0.7.1.alpha1

data/docs/VerifiableIdentityAddress.md

@@ -0,0 +1,32 @@
+# OryHydraClient::VerifiableIdentityAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** | When this entry was created | [optional] |
+| **id** | **String** |  |  |
+| **status** | **String** | VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema |  |
+| **updated_at** | **Time** | When this entry was last updated | [optional] |
+| **value** | **String** | The address value  example foo@user.com |  |
+| **verified** | **Boolean** | Indicates if the address has already been verified |  |
+| **verified_at** | **Time** |  | [optional] |
+| **via** | **String** | VerifiableAddressType must not exceed 16 characters as that is the limitation in the SQL Schema |  |
+
+## Example
+
+```ruby
+require 'ory-kratos-client'
+
+instance = OryHydraClient::VerifiableIdentityAddress.new(
+  created_at: 2014-01-01T23:28:56.782Z,
+  id: null,
+  status: null,
+  updated_at: 2014-01-01T23:28:56.782Z,
+  value: null,
+  verified: true,
+  verified_at: null,
+  via: null
+)
+```
+

data/lib/ory-kratos-client.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests. 
 
-The version of the OpenAPI document: v0.6.1-alpha.1
+The version of the OpenAPI document: v0.7.1-alpha.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -17,6 +17,9 @@ require 'ory-kratos-client/version'
 require 'ory-kratos-client/configuration'
 
 # Models
+require 'ory-kratos-client/models/admin_create_identity_body'
+require 'ory-kratos-client/models/admin_create_self_service_recovery_link_body'
+require 'ory-kratos-client/models/admin_update_identity_body'
 require 'ory-kratos-client/models/authenticate_ok_body'
 require 'ory-kratos-client/models/container_change_response_item'
 require 'ory-kratos-client/models/container_create_created_body'
@@ -24,25 +27,21 @@ require 'ory-kratos-client/models/container_top_ok_body'
 require 'ory-kratos-client/models/container_update_ok_body'
 require 'ory-kratos-client/models/container_wait_ok_body'
 require 'ory-kratos-client/models/container_wait_ok_body_error'
-require 'ory-kratos-client/models/create_identity'
-require 'ory-kratos-client/models/create_recovery_link'
-require 'ory-kratos-client/models/error_container'
 require 'ory-kratos-client/models/error_response'
 require 'ory-kratos-client/models/generic_error'
-require 'ory-kratos-client/models/generic_error_payload'
 require 'ory-kratos-client/models/graph_driver_data'
 require 'ory-kratos-client/models/health_not_ready_status'
 require 'ory-kratos-client/models/health_status'
 require 'ory-kratos-client/models/id_response'
 require 'ory-kratos-client/models/identity'
 require 'ory-kratos-client/models/identity_credentials'
+require 'ory-kratos-client/models/identity_state'
 require 'ory-kratos-client/models/image_delete_response_item'
 require 'ory-kratos-client/models/image_summary'
 require 'ory-kratos-client/models/inline_response200'
 require 'ory-kratos-client/models/inline_response2001'
 require 'ory-kratos-client/models/inline_response503'
-require 'ory-kratos-client/models/login_flow'
-require 'ory-kratos-client/models/login_via_api_response'
+require 'ory-kratos-client/models/json_error'
 require 'ory-kratos-client/models/meta'
 require 'ory-kratos-client/models/plugin'
 require 'ory-kratos-client/models/plugin_config'
@@ -59,45 +58,54 @@ require 'ory-kratos-client/models/plugin_mount'
 require 'ory-kratos-client/models/plugin_settings'
 require 'ory-kratos-client/models/port'
 require 'ory-kratos-client/models/recovery_address'
-require 'ory-kratos-client/models/recovery_flow'
-require 'ory-kratos-client/models/recovery_link'
-require 'ory-kratos-client/models/registration_flow'
-require 'ory-kratos-client/models/registration_via_api_response'
-require 'ory-kratos-client/models/revoke_session'
+require 'ory-kratos-client/models/self_service_error'
+require 'ory-kratos-client/models/self_service_login_flow'
+require 'ory-kratos-client/models/self_service_logout_url'
+require 'ory-kratos-client/models/self_service_recovery_flow'
+require 'ory-kratos-client/models/self_service_recovery_flow_state'
+require 'ory-kratos-client/models/self_service_recovery_link'
+require 'ory-kratos-client/models/self_service_registration_flow'
+require 'ory-kratos-client/models/self_service_settings_flow'
+require 'ory-kratos-client/models/self_service_settings_flow_state'
+require 'ory-kratos-client/models/self_service_verification_flow'
+require 'ory-kratos-client/models/self_service_verification_flow_state'
 require 'ory-kratos-client/models/service_update_response'
 require 'ory-kratos-client/models/session'
-require 'ory-kratos-client/models/settings_flow'
 require 'ory-kratos-client/models/settings_profile_form_config'
-require 'ory-kratos-client/models/settings_via_api_response'
-require 'ory-kratos-client/models/submit_self_service_browser_settings_oidc_flow_payload'
-require 'ory-kratos-client/models/submit_self_service_login_flow'
-require 'ory-kratos-client/models/submit_self_service_login_flow_with_password_method'
-require 'ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method'
-require 'ory-kratos-client/models/submit_self_service_registration_flow'
-require 'ory-kratos-client/models/submit_self_service_registration_flow_with_password_method'
-require 'ory-kratos-client/models/submit_self_service_settings_flow'
-require 'ory-kratos-client/models/submit_self_service_settings_flow_with_password_method'
-require 'ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method'
-require 'ory-kratos-client/models/submit_self_service_verification_flow_with_link_method'
+require 'ory-kratos-client/models/submit_self_service_login_flow_body'
+require 'ory-kratos-client/models/submit_self_service_login_flow_with_oidc_method_body'
+require 'ory-kratos-client/models/submit_self_service_login_flow_with_password_method_body'
+require 'ory-kratos-client/models/submit_self_service_logout_flow_without_browser_body'
+require 'ory-kratos-client/models/submit_self_service_recovery_flow_body'
+require 'ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method_body'
+require 'ory-kratos-client/models/submit_self_service_registration_flow_body'
+require 'ory-kratos-client/models/submit_self_service_registration_flow_with_oidc_method_body'
+require 'ory-kratos-client/models/submit_self_service_registration_flow_with_password_method_body'
+require 'ory-kratos-client/models/submit_self_service_settings_flow_body'
+require 'ory-kratos-client/models/submit_self_service_settings_flow_with_oidc_method_body'
+require 'ory-kratos-client/models/submit_self_service_settings_flow_with_password_method_body'
+require 'ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method_body'
+require 'ory-kratos-client/models/submit_self_service_verification_flow_body'
+require 'ory-kratos-client/models/submit_self_service_verification_flow_with_link_method_body'
+require 'ory-kratos-client/models/successful_self_service_login_without_browser'
+require 'ory-kratos-client/models/successful_self_service_registration_without_browser'
+require 'ory-kratos-client/models/successful_self_service_settings_without_browser'
 require 'ory-kratos-client/models/ui_container'
 require 'ory-kratos-client/models/ui_node'
 require 'ory-kratos-client/models/ui_node_anchor_attributes'
 require 'ory-kratos-client/models/ui_node_attributes'
 require 'ory-kratos-client/models/ui_node_image_attributes'
 require 'ory-kratos-client/models/ui_node_input_attributes'
-require 'ory-kratos-client/models/ui_node_input_attributes_value'
 require 'ory-kratos-client/models/ui_node_text_attributes'
 require 'ory-kratos-client/models/ui_text'
-require 'ory-kratos-client/models/update_identity'
-require 'ory-kratos-client/models/verifiable_address'
-require 'ory-kratos-client/models/verification_flow'
+require 'ory-kratos-client/models/verifiable_identity_address'
 require 'ory-kratos-client/models/version'
 require 'ory-kratos-client/models/volume'
 require 'ory-kratos-client/models/volume_usage_data'
 
 # APIs
-require 'ory-kratos-client/api/admin_api'
-require 'ory-kratos-client/api/public_api'
+require 'ory-kratos-client/api/metadata_api'
+require 'ory-kratos-client/api/v0alpha1_api'
 
 module OryHydraClient
   class << self

data/lib/ory-kratos-client/api/admin_api.rb

@@ -3,7 +3,7 @@
 
 #Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests. 
 
-The version of the OpenAPI document: v0.6.1-alpha.1
+The version of the OpenAPI document: v0.6.3-alpha.1
 Contact: hi@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.1
@@ -332,7 +332,7 @@ module OryHydraClient
     # This endpoint returns the error associated with a user-facing self service errors.  This endpoint supports stub values to help you implement the error UI:  `?error=stub:500` - returns a stub 500 (Internal Server Error) error.  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).
     # @param error [String] Error is the container's ID
     # @param [Hash] opts the optional parameters
-    # @return [ErrorContainer]
+    # @return [SelfServiceErrorContainer]
     def get_self_service_error(error, opts = {})
       data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
       data
@@ -342,7 +342,7 @@ module OryHydraClient
     # This endpoint returns the error associated with a user-facing self service errors.  This endpoint supports stub values to help you implement the error UI:  `?error=stub:500` - returns a stub 500 (Internal Server Error) error.  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).
     # @param error [String] Error is the container's ID
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
+    # @return [Array<(SelfServiceErrorContainer, Integer, Hash)>] SelfServiceErrorContainer data, response status code and response headers
     def get_self_service_error_with_http_info(error, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
@@ -370,7 +370,7 @@ module OryHydraClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ErrorContainer'
+      return_type = opts[:debug_return_type] || 'SelfServiceErrorContainer'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || []
@@ -588,6 +588,7 @@ module OryHydraClient
     # When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy.  You can access this endpoint without credentials when using Ory Kratos' Admin API.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
     # @param id [String] ID is the Settings Flow ID  The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
     # @return [SettingsFlow]
     def get_self_service_settings_flow(id, opts = {})
       data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
@@ -598,6 +599,7 @@ module OryHydraClient
     # When accessing this endpoint through Ory Kratos&#39; Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy.  You can access this endpoint without credentials when using Ory Kratos&#39; Admin API.  More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
     # @param id [String] ID is the Settings Flow ID  The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
     # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
     def get_self_service_settings_flow_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -618,6 +620,7 @@ module OryHydraClient
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

data/lib/ory-kratos-client/api/metadata_api.rb

@@ -0,0 +1,248 @@
+=begin
+#Ory Kratos API
+
+#Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests. 
+
+The version of the OpenAPI document: v0.7.1-alpha.1
+Contact: hi@ory.sh
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'cgi'
+
+module OryHydraClient
+  class MetadataApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse2001]
+    def get_version(opts = {})
+      data, _status_code, _headers = get_version_with_http_info(opts)
+      data
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
+    def get_version_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetadataApi.get_version ...'
+      end
+      # resource path
+      local_var_path = '/version'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse2001'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"MetadataApi.get_version",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetadataApi#get_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse200]
+    def is_alive(opts = {})
+      data, _status_code, _headers = is_alive_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
+    def is_alive_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetadataApi.is_alive ...'
+      end
+      # resource path
+      local_var_path = '/health/alive'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse200'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"MetadataApi.is_alive",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetadataApi#is_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse200]
+    def is_ready(opts = {})
+      data, _status_code, _headers = is_ready_with_http_info(opts)
+      data
+    end
+
+    # 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 &#x60;X-Forwarded-Proto&#x60; 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.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
+    def is_ready_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetadataApi.is_ready ...'
+      end
+      # resource path
+      local_var_path = '/health/ready'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse200'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"MetadataApi.is_ready",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetadataApi#is_ready\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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\" ```
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def prometheus(opts = {})
+      prometheus_with_http_info(opts)
+      nil
+    end
+
+    # Get snapshot metrics from the service. If you&#39;re using k8s, you can then add annotations to your deployment like so:
+    # &#x60;&#x60;&#x60; metadata: annotations: prometheus.io/port: \&quot;4434\&quot; prometheus.io/path: \&quot;/metrics/prometheus\&quot; &#x60;&#x60;&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def prometheus_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetadataApi.prometheus ...'
+      end
+      # resource path
+      local_var_path = '/metrics/prometheus'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"MetadataApi.prometheus",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetadataApi#prometheus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end