chore: regenerate OpenAPI client v0.39.0

kevgo-ory · Jun 27, 2022 · 9014975 · 9014975
1 parent bf4d32a
commit 9014975
Show file tree

Hide file tree

Showing 295 changed files with 2,296 additions and 2,549 deletions.
diff --git a/clients/oathkeeper/dart/.openapi-generator/FILES b/clients/oathkeeper/dart/.openapi-generator/FILES
@@ -3,39 +3,43 @@
 README.md
 analysis_options.yaml
 doc/ApiApi.md
+doc/GetWellKnownJSONWebKeys500Response.md
 doc/HealthNotReadyStatus.md
 doc/HealthStatus.md
-doc/InlineResponse500.md
 doc/JsonWebKey.md
 doc/JsonWebKeySet.md
 doc/Rule.md
 doc/RuleHandler.md
 doc/RuleMatch.md
 doc/Upstream.md
 doc/Version.md
-lib/api.dart
-lib/api/api_api.dart
-lib/api_util.dart
-lib/auth/api_key_auth.dart
-lib/auth/auth.dart
-lib/auth/basic_auth.dart
-lib/auth/oauth.dart
-lib/model/health_not_ready_status.dart
-lib/model/health_status.dart
-lib/model/inline_response500.dart
-lib/model/json_web_key.dart
-lib/model/json_web_key_set.dart
-lib/model/rule.dart
-lib/model/rule_handler.dart
-lib/model/rule_match.dart
-lib/model/upstream.dart
-lib/model/version.dart
-lib/serializers.dart
+lib/ory_oathkeeper_client.dart
+lib/src/api.dart
+lib/src/api/api_api.dart
+lib/src/api_util.dart
+lib/src/auth/api_key_auth.dart
+lib/src/auth/auth.dart
+lib/src/auth/basic_auth.dart
+lib/src/auth/bearer_auth.dart
+lib/src/auth/oauth.dart
+lib/src/date_serializer.dart
+lib/src/model/date.dart
+lib/src/model/get_well_known_json_web_keys500_response.dart
+lib/src/model/health_not_ready_status.dart
+lib/src/model/health_status.dart
+lib/src/model/json_web_key.dart
+lib/src/model/json_web_key_set.dart
+lib/src/model/rule.dart
+lib/src/model/rule_handler.dart
+lib/src/model/rule_match.dart
+lib/src/model/upstream.dart
+lib/src/model/version.dart
+lib/src/serializers.dart
 pubspec.yaml
 test/api_api_test.dart
+test/get_well_known_json_web_keys500_response_test.dart
 test/health_not_ready_status_test.dart
 test/health_status_test.dart
-test/inline_response500_test.dart
 test/json_web_key_set_test.dart
 test/json_web_key_test.dart
 test/rule_handler_test.dart

diff --git a/clients/oathkeeper/dart/.openapi-generator/VERSION b/clients/oathkeeper/dart/.openapi-generator/VERSION
@@ -1 +1 @@
-5.4.0
+6.0.0
diff --git a/clients/oathkeeper/dart/README.md b/clients/oathkeeper/dart/README.md
@@ -1,33 +1,39 @@
-# ory_oathkeeper_client
+# ory_oathkeeper_client (EXPERIMENTAL)
 ORY Oathkeeper is a reverse proxy that checks the HTTP Authorization for validity against a set of rules. This service uses Hydra to validate access tokens and policies.
 
 This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v0.38.25-beta.1
+- API version: v0.39.0
 - Build package: org.openapitools.codegen.languages.DartDioClientCodegen
 For more information, please visit [https://www.ory.am](https://www.ory.am)
 
 ## Requirements
 
-Dart 2.7.0 or later OR Flutter 1.12 or later
+* Dart 2.12.0 or later OR Flutter 1.26.0 or later
+* Dio 4.0.0+
 
 ## Installation & Usage
 
+### pub.dev
+To use the package from [pub.dev](https://pub.dev), please include the following in pubspec.yaml
+```yaml
+dependencies:
+  ory_oathkeeper_client: 0.39.0
+```
+
 ### Github
 If this Dart package is published to Github, please include the following in pubspec.yaml
-```
-name: ory_oathkeeper_client
-version: 0.38.25-beta.1
-description: OpenAPI API client
+```yaml
 dependencies:
   ory_oathkeeper_client:
-    git: https://github.com/ory/sdk.git
-      version: 'any'
+    git:
+      url: https://github.com/ory/sdk.git
+      #ref: main
 ```
 
-### Local
-To use the package in your local drive, please include the following in pubspec.yaml
-```
+### Local development
+To use the package from your local drive, please include the following in pubspec.yaml
+```yaml
 dependencies:
   ory_oathkeeper_client:
     path: /path/to/ory_oathkeeper_client
@@ -38,14 +44,14 @@ dependencies:
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```dart
-import 'package:ory_oathkeeper_client/api.dart';
+import 'package:ory_oathkeeper_client/ory_oathkeeper_client.dart';
 
 
-final api = ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
     api.decisions();
-} catch (e) {
+} catch on DioError (e) {
     print("Exception when calling ApiApi->decisions: $e\n");
 }
 
@@ -57,20 +63,20 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*ApiApi* | [**decisions**](doc/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
-*ApiApi* | [**getRule**](doc/ApiApi.md#getrule) | **GET** /rules/{id} | Retrieve a rule
-*ApiApi* | [**getVersion**](doc/ApiApi.md#getversion) | **GET** /version | Get service version
-*ApiApi* | [**getWellKnownJSONWebKeys**](doc/ApiApi.md#getwellknownjsonwebkeys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
-*ApiApi* | [**isInstanceAlive**](doc/ApiApi.md#isinstancealive) | **GET** /health/alive | Check alive status
-*ApiApi* | [**isInstanceReady**](doc/ApiApi.md#isinstanceready) | **GET** /health/ready | Check readiness status
-*ApiApi* | [**listRules**](doc/ApiApi.md#listrules) | **GET** /rules | List all rules
+[*ApiApi*](doc/ApiApi.md) | [**decisions**](doc/ApiApi.md#decisions) | **GET** /decisions | Access Control Decision API
+[*ApiApi*](doc/ApiApi.md) | [**getRule**](doc/ApiApi.md#getrule) | **GET** /rules/{id} | Retrieve a rule
+[*ApiApi*](doc/ApiApi.md) | [**getVersion**](doc/ApiApi.md#getversion) | **GET** /version | Get service version
+[*ApiApi*](doc/ApiApi.md) | [**getWellKnownJSONWebKeys**](doc/ApiApi.md#getwellknownjsonwebkeys) | **GET** /.well-known/jwks.json | Lists cryptographic keys
+[*ApiApi*](doc/ApiApi.md) | [**isInstanceAlive**](doc/ApiApi.md#isinstancealive) | **GET** /health/alive | Check alive status
+[*ApiApi*](doc/ApiApi.md) | [**isInstanceReady**](doc/ApiApi.md#isinstanceready) | **GET** /health/ready | Check readiness status
+[*ApiApi*](doc/ApiApi.md) | [**listRules**](doc/ApiApi.md#listrules) | **GET** /rules | List all rules
 
 
 ## Documentation For Models
 
+ - [GetWellKnownJSONWebKeys500Response](doc/GetWellKnownJSONWebKeys500Response.md)
  - [HealthNotReadyStatus](doc/HealthNotReadyStatus.md)
  - [HealthStatus](doc/HealthStatus.md)
- - [InlineResponse500](doc/InlineResponse500.md)
  - [JsonWebKey](doc/JsonWebKey.md)
  - [JsonWebKeySet](doc/JsonWebKeySet.md)
  - [Rule](doc/Rule.md)

diff --git a/clients/oathkeeper/dart/doc/ApiApi.md b/clients/oathkeeper/dart/doc/ApiApi.md
@@ -29,11 +29,11 @@ Access Control Decision API
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
-    api_instance.decisions();
-} catch (e) {
+    api.decisions();
+} catch on DioError (e) {
     print('Exception when calling ApiApi->decisions: $e\n');
 }
 ```
@@ -67,13 +67,13 @@ Use this method to retrieve a rule from the storage. If it does not exist you wi
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
-var id = id_example; // String | 
+final api = OryOathkeeperClient().getApiApi();
+final String id = id_example; // String | 
 
 try {
-    var result = api_instance.getRule(id);
-    print(result);
-} catch (e) {
+    final response = api.getRule(id);
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->getRule: $e\n');
 }
 ```
@@ -110,12 +110,12 @@ This endpoint returns the service version typically notated using semantic versi
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
-    var result = api_instance.getVersion();
-    print(result);
-} catch (e) {
+    final response = api.getVersion();
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->getVersion: $e\n');
 }
 ```
@@ -149,12 +149,12 @@ This endpoint returns cryptographic keys that are required to, for example, veri
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
-    var result = api_instance.getWellKnownJSONWebKeys();
-    print(result);
-} catch (e) {
+    final response = api.getWellKnownJSONWebKeys();
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->getWellKnownJSONWebKeys: $e\n');
 }
 ```
@@ -188,12 +188,12 @@ This endpoint returns a 200 status code when the HTTP server is up running. This
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
-    var result = api_instance.isInstanceAlive();
-    print(result);
-} catch (e) {
+    final response = api.isInstanceAlive();
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->isInstanceAlive: $e\n');
 }
 ```
@@ -227,12 +227,12 @@ This endpoint returns a 200 status code when the HTTP server is up running and t
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
+final api = OryOathkeeperClient().getApiApi();
 
 try {
-    var result = api_instance.isInstanceReady();
-    print(result);
-} catch (e) {
+    final response = api.isInstanceReady();
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->isInstanceReady: $e\n');
 }
 ```
@@ -266,14 +266,14 @@ This method returns an array of all rules that are stored in the backend. This i
 ```dart
 import 'package:ory_oathkeeper_client/api.dart';
 
-var api_instance = new ApiApi();
-var limit = 789; // int | The maximum amount of rules returned.
-var offset = 789; // int | The offset from where to start looking.
+final api = OryOathkeeperClient().getApiApi();
+final int limit = 789; // int | The maximum amount of rules returned.
+final int offset = 789; // int | The offset from where to start looking.
 
 try {
-    var result = api_instance.listRules(limit, offset);
-    print(result);
-} catch (e) {
+    final response = api.listRules(limit, offset);
+    print(response);
+} catch on DioError (e) {
     print('Exception when calling ApiApi->listRules: $e\n');
 }
 ```
@@ -287,7 +287,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**BuiltList<Rule>**](Rule.md)
+[**BuiltList&lt;Rule&gt;**](Rule.md)
 
 ### Authorization
 

diff --git a/.../oathkeeper/dart/doc/InlineResponse500.md → ...doc/GetWellKnownJSONWebKeys500Response.md b/.../oathkeeper/dart/doc/InlineResponse500.md → ...doc/GetWellKnownJSONWebKeys500Response.md
@@ -1,4 +1,4 @@
-# ory_oathkeeper_client.model.InlineResponse500
+# ory_oathkeeper_client.model.GetWellKnownJSONWebKeys500Response
 
 ## Load the model package
 ```dart
@@ -9,7 +9,7 @@ import 'package:ory_oathkeeper_client/api.dart';
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **code** | **int** |  | [optional] 
-**details** | [**BuiltList<JsonObject>**](JsonObject.md) |  | [optional] 
+**details** | [**BuiltList&lt;JsonObject&gt;**](JsonObject.md) |  | [optional] 
 **message** | **String** |  | [optional] 
 **reason** | **String** |  | [optional] 
 **request** | **String** |  | [optional] 

diff --git a/clients/oathkeeper/dart/doc/HealthNotReadyStatus.md b/clients/oathkeeper/dart/doc/HealthNotReadyStatus.md
@@ -8,7 +8,7 @@ import 'package:ory_oathkeeper_client/api.dart';
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errors** | **BuiltMap<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional] 
+**errors** | **BuiltMap&lt;String, String&gt;** | Errors contains a list of errors that caused the not ready status. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/clients/oathkeeper/dart/doc/JsonWebKey.md b/clients/oathkeeper/dart/doc/JsonWebKey.md
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
 **qi** | **String** |  | [optional] 
 **use** | **String** | The \"use\" (public key use) parameter identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption). | [optional] 
 **x** | **String** |  | [optional] 
-**x5c** | **BuiltList<String>** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280].  The certificate chain is represented as a JSON array of certificate value strings.  Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional] 
+**x5c** | **BuiltList&lt;String&gt;** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280].  The certificate chain is represented as a JSON array of certificate value strings.  Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional] 
 **y** | **String** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/clients/oathkeeper/dart/doc/JsonWebKeySet.md b/clients/oathkeeper/dart/doc/JsonWebKeySet.md
@@ -8,7 +8,7 @@ import 'package:ory_oathkeeper_client/api.dart';
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**keys** | [**BuiltList<JsonWebKey>**](JsonWebKey.md) | The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional] 
+**keys** | [**BuiltList&lt;JsonWebKey&gt;**](JsonWebKey.md) | The value of the \"keys\" parameter is an array of JWK values.  By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/clients/oathkeeper/dart/doc/Rule.md b/clients/oathkeeper/dart/doc/Rule.md
@@ -8,12 +8,12 @@ import 'package:ory_oathkeeper_client/api.dart';
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**authenticators** | [**BuiltList<RuleHandler>**](RuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] 
+**authenticators** | [**BuiltList&lt;RuleHandler&gt;**](RuleHandler.md) | Authenticators is a list of authentication handlers that will try and authenticate the provided credentials. Authenticators are checked iteratively from index 0 to n and if the first authenticator to return a positive result will be the one used.  If you want the rule to first check a specific authenticator  before \"falling back\" to others, have that authenticator as the first item in the array. | [optional] 
 **authorizer** | [**RuleHandler**](RuleHandler.md) |  | [optional] 
 **description** | **String** | Description is a human readable description of this rule. | [optional] 
 **id** | **String** | ID is the unique id of the rule. It can be at most 190 characters long, but the layout of the ID is up to you. You will need this ID later on to update or delete the rule. | [optional] 
 **match** | [**RuleMatch**](RuleMatch.md) |  | [optional] 
-**mutators** | [**BuiltList<RuleHandler>**](RuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] 
+**mutators** | [**BuiltList&lt;RuleHandler&gt;**](RuleHandler.md) | Mutators is a list of mutation handlers that transform the HTTP request. A common use case is generating a new set of credentials (e.g. JWT) which then will be forwarded to the upstream server.  Mutations are performed iteratively from index 0 to n and should all succeed in order for the HTTP request to be forwarded. | [optional] 
 **upstream** | [**Upstream**](Upstream.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/clients/oathkeeper/dart/doc/RuleMatch.md b/clients/oathkeeper/dart/doc/RuleMatch.md
@@ -8,7 +8,7 @@ import 'package:ory_oathkeeper_client/api.dart';
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**methods** | **BuiltList<String>** | An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match. | [optional] 
+**methods** | **BuiltList&lt;String&gt;** | An array of HTTP methods (e.g. GET, POST, PUT, DELETE, ...). When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the HTTP method of the incoming request with the HTTP methods of each rules. If a match is found, the rule is considered a partial match. If the matchesUrl field is satisfied as well, the rule is considered a full match. | [optional] 
 **url** | **String** | This field represents the URL pattern this rule matches. When ORY Oathkeeper searches for rules to decide what to do with an incoming request to the proxy server, it compares the full request URL (e.g. https://mydomain.com/api/resource) without query parameters of the incoming request with this field. If a match is found, the rule is considered a partial match. If the matchesMethods field is satisfied as well, the rule is considered a full match.  You can use regular expressions in this field to match more than one url. Regular expressions are encapsulated in brackets < and >. The following example matches all paths of the domain `mydomain.com`: `https://mydomain.com/<.*>`. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)