ory-oathkeeper-client 0.38.5.beta1 → 0.38.9.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fd2a62612937b09b2a114c2337d525efa664a932184a230fcc2fb6f105b08b4
-  data.tar.gz: fafaad09701c94255e5eedf06c3f8886e9394af8a487d500292800632f22ed9c
+  metadata.gz: f55377676e044a41f1496f05f58335497dbb14f7aba78e374400cab081323b5c
+  data.tar.gz: 3162661e0ecfcf1601f6f4f7f7ac5ce9abbe1534c89e532696392f07e96cc69b
 SHA512:
-  metadata.gz: 5e93c2cc86671963f4fa1512780cf3b91adc698c275c509aeffefcad14dc42a5415e3fb204cc7d0ffc8eae441a2aa4ef49867ec923baa9d54ee0383e37c23b67
-  data.tar.gz: aee9c86b1e2f45ac69dadd0a5611c8d5e5d3ba0b3ffb77d88ac38cd3cd42460e33c86dd45a22d45a7e99657419c2d2a1cd176257e30238376b54a4ded9bb8c28
+  metadata.gz: 7324011eb52ec71c144d1e58ee4226cc0f57f343c863d6a8b154598cb29dd7c671584dd31f70a0eec9d2bee4fd4d8ec51ac7814a614c8729f1c3efa07ec6356b
+  data.tar.gz: bc0dc287f563a49f7e47f72224ca9c33cd8d95162c9903e10ce5826023b4c356d284b8f50a27e998d717e8a8d599b22c9a0bd7620f0f4fb71624d43ac5cd7926

data/README.md

@@ -6,8 +6,8 @@ ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validit
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v0.38.5-beta.1
-- Package version: v0.38.5-beta.1
+- API version: v0.38.9-beta.1
+- Package version: v0.38.9-beta.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.ory.am](https://www.ory.am)
 
@@ -24,16 +24,16 @@ gem build ory-oathkeeper-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-oathkeeper-client-v0.38.5-beta.1.gem
+gem install ./ory-oathkeeper-client-v0.38.9-beta.1.gem
 ```
 
-(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.5-beta.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-oathkeeper-client-v0.38.9-beta.1.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-oathkeeper-client', '~> v0.38.5-beta.1'
+    gem 'ory-oathkeeper-client', '~> v0.38.9-beta.1'
 
 ### Install from Git
 

data/docs/ApiApi.md

@@ -2,13 +2,12 @@
 
 All URIs are relative to *http://localhost*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
-[**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule
-[**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
-[**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**decisions**](ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API |
+| [**get_rule**](ApiApi.md#get_rule) | **GET** /rules/{id} | Retrieve a rule |
+| [**get_well_known_json_web_keys**](ApiApi.md#get_well_known_json_web_keys) | **GET** /.well-known/jwks.json | Lists cryptographic keys |
+| [**list_rules**](ApiApi.md#list_rules) | **GET** /rules | List all rules |
 
 
 ## decisions
@@ -19,19 +18,37 @@ Access Control Decision API
 
 > This endpoint works with all HTTP Methods (GET, POST, PUT, ...) and matches every path prefixed with /decision.  This endpoint mirrors the proxy capability of ORY Oathkeeper's proxy functionality but instead of forwarding the request to the upstream server, returns 200 (request should be allowed), 401 (unauthorized), or 403 (forbidden) status codes. This endpoint can be used to integrate with other API Proxies like Ambassador, Kong, Envoy, and many more.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 
 begin
-  #Access Control Decision API
+  # Access Control Decision API
   api_instance.decisions
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->decisions: #{e}"
+  puts "Error when calling ApiApi->decisions: #{e}"
+end
+```
+
+#### Using the decisions_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)> decisions_with_http_info
+
+```ruby
+begin
+  # Access Control Decision API
+  data, status_code, headers = api_instance.decisions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->decisions_with_http_info: #{e}"
 end
 ```
 
@@ -55,36 +72,53 @@ No authorization required
 
 ## get_rule
 
-> Rule get_rule(id)
+> <Rule> get_rule(id)
 
 Retrieve a rule
 
 Use this method to retrieve a rule from the storage. If it does not exist you will receive a 404 error.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 id = 'id_example' # String | 
 
 begin
-  #Retrieve a rule
+  # Retrieve a rule
   result = api_instance.get_rule(id)
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->get_rule: #{e}"
+  puts "Error when calling ApiApi->get_rule: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_rule_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Rule>, Integer, Hash)> get_rule_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve a rule
+  data, status_code, headers = api_instance.get_rule_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Rule>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_rule_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
 
 ### Return type
 
@@ -102,26 +136,44 @@ No authorization required
 
 ## get_well_known_json_web_keys
 
-> JsonWebKeySet get_well_known_json_web_keys
+> <JsonWebKeySet> get_well_known_json_web_keys
 
 Lists cryptographic keys
 
 This endpoint returns cryptographic keys that are required to, for example, verify signatures of ID Tokens.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 
 begin
-  #Lists cryptographic keys
+  # Lists cryptographic keys
   result = api_instance.get_well_known_json_web_keys
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->get_well_known_json_web_keys: #{e}"
+  puts "Error when calling ApiApi->get_well_known_json_web_keys: #{e}"
+end
+```
+
+#### Using the get_well_known_json_web_keys_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> get_well_known_json_web_keys_with_http_info
+
+```ruby
+begin
+  # Lists cryptographic keys
+  data, status_code, headers = api_instance.get_well_known_json_web_keys_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->get_well_known_json_web_keys_with_http_info: #{e}"
 end
 ```
 
@@ -145,40 +197,57 @@ No authorization required
 
 ## list_rules
 
-> Array&lt;Rule&gt; list_rules(opts)
+> <Array<Rule>> list_rules(opts)
 
 List all rules
 
 This method returns an array of all rules that are stored in the backend. This is useful if you want to get a full view of what rules you have currently in place.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'ory-oathkeeper-client'
 
 api_instance = OryHydraClient::ApiApi.new
 opts = {
-  limit: 56, # Integer | The maximum amount of rules returned.
-  offset: 56 # Integer | The offset from where to start looking.
+  limit: 789, # Integer | The maximum amount of rules returned.
+  offset: 789 # Integer | The offset from where to start looking.
 }
 
 begin
-  #List all rules
+  # List all rules
   result = api_instance.list_rules(opts)
   p result
 rescue OryHydraClient::ApiError => e
-  puts "Exception when calling ApiApi->list_rules: #{e}"
+  puts "Error when calling ApiApi->list_rules: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_rules_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Rule>>, Integer, Hash)> list_rules_with_http_info(opts)
+
+```ruby
+begin
+  # List all rules
+  data, status_code, headers = api_instance.list_rules_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Rule>>
+rescue OryHydraClient::ApiError => e
+  puts "Error when calling ApiApi->list_rules_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| The maximum amount of rules returned. | [optional] 
- **offset** | **Integer**| The offset from where to start looking. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | The maximum amount of rules returned. | [optional] |
+| **offset** | **Integer** | The offset from where to start looking. | [optional] |
 
 ### Return type
 

data/docs/CreateRuleCreated.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**SwaggerRule**](SwaggerRule.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::CreateRuleCreated.new(payload: null)
+instance = OryHydraClient::CreateRuleCreated.new(
+  payload: null
+)
 ```
 
-

data/docs/CreateRuleForbidden.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**CreateRuleForbiddenBody**](CreateRuleForbiddenBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**CreateRuleForbiddenBody**](CreateRuleForbiddenBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::CreateRuleForbidden.new(payload: null)
+instance = OryHydraClient::CreateRuleForbidden.new(
+  payload: null
+)
 ```
 
-

data/docs/CreateRuleForbiddenBody.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Integer** | code | [optional] 
-**details** | **Array<Hash<String, Object>>** | details | [optional] 
-**message** | **String** | message | [optional] 
-**reason** | **String** | reason | [optional] 
-**request** | **String** | request | [optional] 
-**status** | **String** | status | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::CreateRuleForbiddenBody.new(code: null,
-                                 details: null,
-                                 message: null,
-                                 reason: null,
-                                 request: null,
-                                 status: null)
+instance = OryHydraClient::CreateRuleForbiddenBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
 ```
 
-

data/docs/CreateRuleInternalServerError.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**payload** | [**CreateRuleInternalServerErrorBody**](CreateRuleInternalServerErrorBody.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**CreateRuleInternalServerErrorBody**](CreateRuleInternalServerErrorBody.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::CreateRuleInternalServerError.new(payload: null)
+instance = OryHydraClient::CreateRuleInternalServerError.new(
+  payload: null
+)
 ```
 
-

data/docs/CreateRuleInternalServerErrorBody.md

@@ -2,26 +2,27 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**code** | **Integer** | code | [optional] 
-**details** | **Array<Hash<String, Object>>** | details | [optional] 
-**message** | **String** | message | [optional] 
-**reason** | **String** | reason | [optional] 
-**request** | **String** | request | [optional] 
-**status** | **String** | status | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** | code | [optional] |
+| **details** | **Array<Object>** | details | [optional] |
+| **message** | **String** | message | [optional] |
+| **reason** | **String** | reason | [optional] |
+| **request** | **String** | request | [optional] |
+| **status** | **String** | status | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'OryHydraClient'
+require 'ory-oathkeeper-client'
 
-instance = OryHydraClient::CreateRuleInternalServerErrorBody.new(code: null,
-                                 details: null,
-                                 message: null,
-                                 reason: null,
-                                 request: null,
-                                 status: null)
+instance = OryHydraClient::CreateRuleInternalServerErrorBody.new(
+  code: null,
+  details: null,
+  message: null,
+  reason: null,
+  request: null,
+  status: null
+)
 ```
 
-