ory-hydra-client 1.9.2 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870ff5b608f51e0c3a8e5757925d9eae1a40ed197f72b5a7cfd60c3c20a28569
-  data.tar.gz: 4fd5ceedbd9f82838a1caa54314b025ed99c5c5246226337ce721ea23a896e60
+  metadata.gz: 8d42760ac122ae7a0147329e31b06c6ae8e927c030c7d9a5f68e4ced7d0043f3
+  data.tar.gz: 8d04c0e6c1c19950c2f16a29ed8ef9a747ac71658a071f1b8c88d9d13a0d901f
 SHA512:
-  metadata.gz: 511fd64f5c377c07d5236ce6716a3395211597e239de5c77abf16d01255c4860b6d26a497974610f76d8f2cfcf99bafd72171eec4107e57780a8a20f2d62b939
-  data.tar.gz: fa8770e6687c6a2166dd1b152897c942b5263c901ab3fd1d3201b1c986b2861f1e67269746fbcf860f56220e7e942d20e319ce5d9545d3fef4b4e326e89cd743
+  metadata.gz: e822b1bd7bb9a74e9379ff6b2bf214659fe79a8427b28d998cd28c12d3831acc3db9aa292d8ce013087c83ae577bf7deabcbcd8bb1b383630a53436db9b44e7c
+  data.tar.gz: 7b303a0ab5794aec4fcdbab6f5f4b70b2f4f7e5a1bab6b6148ab840346cbd42c2c308fa6f2ce4f21fc524a35c3bbd98de268af21998db85a815d113395174bba

data/README.md

@@ -6,8 +6,8 @@ Welcome to the ORY Hydra HTTP API documentation. You will find documentation for
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v1.9.2
-- Package version: v1.9.2
+- API version: v1.10.2
+- Package version: v1.10.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build ory-hydra-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-hydra-client-v1.9.2.gem
+gem install ./ory-hydra-client-v1.10.2.gem
 ```
 
-(for development, run `gem install --dev ./ory-hydra-client-v1.9.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-hydra-client-v1.10.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ory-hydra-client', '~> v1.9.2'
+    gem 'ory-hydra-client', '~> v1.10.2'
 
 ### Install from Git
 
@@ -99,6 +99,7 @@ Class | Method | HTTP request | Description
 *OryHydraClient::AdminApi* | [**is_instance_alive**](docs/AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status
 *OryHydraClient::AdminApi* | [**list_o_auth2_clients**](docs/AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients
 *OryHydraClient::AdminApi* | [**list_subject_consent_sessions**](docs/AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject
+*OryHydraClient::AdminApi* | [**patch_o_auth2_client**](docs/AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client
 *OryHydraClient::AdminApi* | [**prometheus**](docs/AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service.
 *OryHydraClient::AdminApi* | [**reject_consent_request**](docs/AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request
 *OryHydraClient::AdminApi* | [**reject_login_request**](docs/AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request
@@ -139,6 +140,7 @@ Class | Method | HTTP request | Description
  - [OryHydraClient::OAuth2TokenIntrospection](docs/OAuth2TokenIntrospection.md)
  - [OryHydraClient::Oauth2TokenResponse](docs/Oauth2TokenResponse.md)
  - [OryHydraClient::OpenIDConnectContext](docs/OpenIDConnectContext.md)
+ - [OryHydraClient::PatchDocument](docs/PatchDocument.md)
  - [OryHydraClient::PluginConfig](docs/PluginConfig.md)
  - [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md)
  - [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md)
@@ -153,8 +155,10 @@ Class | Method | HTTP request | Description
  - [OryHydraClient::PluginSettings](docs/PluginSettings.md)
  - [OryHydraClient::PreviousConsentSession](docs/PreviousConsentSession.md)
  - [OryHydraClient::RejectRequest](docs/RejectRequest.md)
+ - [OryHydraClient::RequestWasHandledResponse](docs/RequestWasHandledResponse.md)
  - [OryHydraClient::UserinfoResponse](docs/UserinfoResponse.md)
  - [OryHydraClient::Version](docs/Version.md)
+ - [OryHydraClient::Volume](docs/Volume.md)
  - [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
  - [OryHydraClient::WellKnown](docs/WellKnown.md)
 

data/docs/AdminApi.md

@@ -25,6 +25,7 @@ All URIs are relative to *http://localhost*
 | [**is_instance_alive**](AdminApi.md#is_instance_alive) | **GET** /health/alive | Check Alive Status |
 | [**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients |
 | [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject |
+| [**patch_o_auth2_client**](AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client |
 | [**prometheus**](AdminApi.md#prometheus) | **GET** /metrics/prometheus | Get Snapshot Metrics from the Hydra Service. |
 | [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request |
 | [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request |
@@ -1395,6 +1396,72 @@ No authorization required
 - **Accept**: application/json
 
 
+## patch_o_auth2_client
+
+> <OAuth2Client> patch_o_auth2_client(id, body)
+
+Patch an OAuth 2.0 Client
+
+Patch an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-hydra-client'
+
+api_instance = OryHydraClient::AdminApi.new
+id = 'id_example' # String | 
+body = [OryHydraClient::PatchDocument.new({op: '"replace"', path: '"/name"'})] # Array<PatchDocument> | 
+
+begin
+  # Patch an OAuth 2.0 Client
+  result = api_instance.patch_o_auth2_client(id, body)
+  p result
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling AdminApi->patch_o_auth2_client: #{e}"
+end
+```
+
+#### Using the patch_o_auth2_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuth2Client>, Integer, Hash)> patch_o_auth2_client_with_http_info(id, body)
+
+```ruby
+begin
+  # Patch an OAuth 2.0 Client
+  data, status_code, headers = api_instance.patch_o_auth2_client_with_http_info(id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuth2Client>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling AdminApi->patch_o_auth2_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **body** | [**Array&lt;PatchDocument&gt;**](PatchDocument.md) |  |  |
+
+### Return type
+
+[**OAuth2Client**](OAuth2Client.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## prometheus
 
 > prometheus

data/docs/LogoutRequest.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **challenge** | **String** | Challenge is the identifier (\"logout challenge\") of the logout authentication request. It is used to identify the session. | [optional] |
 | **request_url** | **String** | RequestURL is the original Logout URL requested. | [optional] |
 | **rp_initiated** | **Boolean** | RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client. | [optional] |
 | **sid** | **String** | SessionID is the login session ID that was requested to log out. | [optional] |
@@ -15,6 +16,7 @@
 require 'ory-hydra-client'
 
 instance = OryHydraClient::LogoutRequest.new(
+  challenge: null,
   request_url: null,
   rp_initiated: null,
   sid: null,

data/docs/PatchDocument.md

@@ -0,0 +1,24 @@
+# OryHydraClient::PatchDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | **String** | A JSON-pointer | [optional] |
+| **op** | **String** | The operation to be performed |  |
+| **path** | **String** | A JSON-pointer |  |
+| **value** | **Object** | The value to be used within the operations | [optional] |
+
+## Example
+
+```ruby
+require 'ory-hydra-client'
+
+instance = OryHydraClient::PatchDocument.new(
+  from: null,
+  op: "replace",
+  path: "/name",
+  value: null
+)
+```
+

data/docs/RequestWasHandledResponse.md

@@ -0,0 +1,18 @@
+# OryHydraClient::RequestWasHandledResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redirect_to** | **String** | Original request URL to which you should redirect the user if request was already handled. |  |
+
+## Example
+
+```ruby
+require 'ory-hydra-client'
+
+instance = OryHydraClient::RequestWasHandledResponse.new(
+  redirect_to: null
+)
+```
+

data/docs/Volume.md

@@ -0,0 +1,34 @@
+# OryHydraClient::Volume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | Date/Time the volume was created. | [optional] |
+| **driver** | **String** | Name of the volume driver used by the volume. |  |
+| **labels** | **Hash<String, String>** | User-defined key/value metadata. |  |
+| **mountpoint** | **String** | Mount path of the volume on the host. |  |
+| **name** | **String** | Name of the volume. |  |
+| **options** | **Hash<String, String>** | The driver specific options used when creating the volume. |  |
+| **scope** | **String** | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. |  |
+| **status** | **Object** | Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`.  The `Status` field is optional, and is omitted if the volume driver does not support this feature. | [optional] |
+| **usage_data** | [**VolumeUsageData**](VolumeUsageData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-hydra-client'
+
+instance = OryHydraClient::Volume.new(
+  created_at: null,
+  driver: null,
+  labels: null,
+  mountpoint: null,
+  name: null,
+  options: null,
+  scope: null,
+  status: null,
+  usage_data: null
+)
+```
+

data/lib/ory-hydra-client.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -36,6 +36,7 @@ require 'ory-hydra-client/models/o_auth2_client'
 require 'ory-hydra-client/models/o_auth2_token_introspection'
 require 'ory-hydra-client/models/oauth2_token_response'
 require 'ory-hydra-client/models/open_id_connect_context'
+require 'ory-hydra-client/models/patch_document'
 require 'ory-hydra-client/models/plugin_config'
 require 'ory-hydra-client/models/plugin_config_args'
 require 'ory-hydra-client/models/plugin_config_interface'
@@ -50,8 +51,10 @@ require 'ory-hydra-client/models/plugin_mount'
 require 'ory-hydra-client/models/plugin_settings'
 require 'ory-hydra-client/models/previous_consent_session'
 require 'ory-hydra-client/models/reject_request'
+require 'ory-hydra-client/models/request_was_handled_response'
 require 'ory-hydra-client/models/userinfo_response'
 require 'ory-hydra-client/models/version'
+require 'ory-hydra-client/models/volume'
 require 'ory-hydra-client/models/volume_usage_data'
 require 'ory-hydra-client/models/well_known'
 

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

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -1368,6 +1368,77 @@ module OryHydraClient
       return data, status_code, headers
     end
 
+    # Patch an OAuth 2.0 Client
+    # Patch an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
+    # @param id [String] 
+    # @param body [Array<PatchDocument>] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuth2Client]
+    def patch_o_auth2_client(id, body, opts = {})
+      data, _status_code, _headers = patch_o_auth2_client_with_http_info(id, body, opts)
+      data
+    end
+
+    # Patch an OAuth 2.0 Client
+    # Patch an existing OAuth 2.0 Client. If you pass &#x60;client_secret&#x60; the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe.  OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
+    # @param id [String] 
+    # @param body [Array<PatchDocument>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuth2Client, Integer, Hash)>] OAuth2Client data, response status code and response headers
+    def patch_o_auth2_client_with_http_info(id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdminApi.patch_o_auth2_client ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.patch_o_auth2_client"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling AdminApi.patch_o_auth2_client"
+      end
+      # resource path
+      local_var_path = '/clients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuth2Client'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AdminApi.patch_o_auth2_client",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdminApi#patch_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Snapshot Metrics from the Hydra Service.
     # If you're using k8s, you can then add annotations to your deployment like so:  ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```  If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
     # @param [Hash] opts the optional parameters

data/lib/ory-hydra-client/api/public_api.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/ory-hydra-client/api_client.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -308,7 +308,7 @@ module OryHydraClient
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end

data/lib/ory-hydra-client/api_error.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 

data/lib/ory-hydra-client/configuration.rb

@@ -3,10 +3,10 @@
 
 #Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
 
-The version of the OpenAPI document: v1.9.2
+The version of the OpenAPI document: v1.10.2
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.1.0
 
 =end
 
@@ -197,11 +197,13 @@ module OryHydraClient
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -234,7 +236,7 @@ module OryHydraClient
     def server_settings
       [
         {
-          url: "/",
+          url: "",
           description: "No description provided",
         }
       ]