Skip to content

Commit 1a73c8e

Browse files
affinidibotivan-branets-affinidi
authored andcommitted
feat: update cid client
1 parent 581ed31 commit 1a73c8e

File tree

37 files changed

+1428
-72
lines changed

37 files changed

+1428
-72
lines changed

clients/dart/consumer_iam_client/.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ doc/ConsumerAuthApi.md
88
doc/ConsumerAuthTokenEndpointInput.md
99
doc/ConsumerAuthTokenEndpointOutput.md
1010
doc/CorsConsumerAuthTokenEndpointOK.md
11+
doc/GetAccessOutput.md
1112
doc/GrantAccessInput.md
1213
doc/GrantAccessOutput.md
1314
doc/InvalidDIDError.md
@@ -39,6 +40,7 @@ lib/src/model/consumer_auth_token_endpoint_input.dart
3940
lib/src/model/consumer_auth_token_endpoint_output.dart
4041
lib/src/model/cors_consumer_auth_token_endpoint_ok.dart
4142
lib/src/model/date.dart
43+
lib/src/model/get_access_output.dart
4244
lib/src/model/grant_access_input.dart
4345
lib/src/model/grant_access_output.dart
4446
lib/src/model/invalid_did_error.dart

clients/dart/consumer_iam_client/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,21 @@ try {
7070

7171
All URIs are relative to *https://apse1.api.affinidi.io/cid*
7272

73-
| Class | Method | HTTP request | Description |
74-
| ------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------- | --------------------------------------- |
75-
| [_AuthzApi_](doc/AuthzApi.md) | [**deleteAccessVfs**](doc/AuthzApi.md#deleteaccessvfs) | **DELETE** /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
76-
| [_AuthzApi_](doc/AuthzApi.md) | [**grantAccessVfs**](doc/AuthzApi.md#grantaccessvfs) | **POST** /v1/authz/vfs/access/{granteeDid} | Grant access to the virtual file system |
77-
| [_AuthzApi_](doc/AuthzApi.md) | [**updateAccessVfs**](doc/AuthzApi.md#updateaccessvfs) | **PUT** /v1/authz/vfs/access/{granteeDid} | Update access of granteeDid |
78-
| [_ConsumerAuthApi_](doc/ConsumerAuthApi.md) | [**consumerAuthTokenEndpoint**](doc/ConsumerAuthApi.md#consumerauthtokenendpoint) | **POST** /v1/consumer/oauth2/token | The Consumer OAuth 2.0 Token Endpoint |
73+
| Class | Method | HTTP request | Description |
74+
| ------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------- | -------------------------------------------------------- |
75+
| [_AuthzApi_](doc/AuthzApi.md) | [**deleteAccessVfs**](doc/AuthzApi.md#deleteaccessvfs) | **DELETE** /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
76+
| [_AuthzApi_](doc/AuthzApi.md) | [**getAccessVfs**](doc/AuthzApi.md#getaccessvfs) | **GET** /v1/authz/vfs/access/{granteeDid} | Get permissions to the virtual file system for a subject |
77+
| [_AuthzApi_](doc/AuthzApi.md) | [**grantAccessVfs**](doc/AuthzApi.md#grantaccessvfs) | **POST** /v1/authz/vfs/access/{granteeDid} | Grant access to the virtual file system |
78+
| [_AuthzApi_](doc/AuthzApi.md) | [**updateAccessVfs**](doc/AuthzApi.md#updateaccessvfs) | **PUT** /v1/authz/vfs/access/{granteeDid} | Update access of granteeDid |
79+
| [_ConsumerAuthApi_](doc/ConsumerAuthApi.md) | [**consumerAuthTokenEndpoint**](doc/ConsumerAuthApi.md#consumerauthtokenendpoint) | **POST** /v1/consumer/oauth2/token | The Consumer OAuth 2.0 Token Endpoint |
7980
| [_WellKnownApi_](doc/WellKnownApi.md) | [**getWellKnownJwks**](doc/WellKnownApi.md#getwellknownjwks) | **GET** /.well-known/jwks.json |
8081

8182
## Documentation For Models
8283

8384
- [ConsumerAuthTokenEndpointInput](doc/ConsumerAuthTokenEndpointInput.md)
8485
- [ConsumerAuthTokenEndpointOutput](doc/ConsumerAuthTokenEndpointOutput.md)
8586
- [CorsConsumerAuthTokenEndpointOK](doc/CorsConsumerAuthTokenEndpointOK.md)
87+
- [GetAccessOutput](doc/GetAccessOutput.md)
8688
- [GrantAccessInput](doc/GrantAccessInput.md)
8789
- [GrantAccessOutput](doc/GrantAccessOutput.md)
8890
- [InvalidDIDError](doc/InvalidDIDError.md)

clients/dart/consumer_iam_client/doc/AuthzApi.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ import 'package:affinidi_tdk_consumer_iam_client/api.dart';
88

99
All URIs are relative to *https://apse1.api.affinidi.io/cid*
1010

11-
| Method | HTTP request | Description |
12-
| -------------------------------------------------- | -------------------------------------------- | --------------------------------------- |
13-
| [**deleteAccessVfs**](AuthzApi.md#deleteaccessvfs) | **DELETE** /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
14-
| [**grantAccessVfs**](AuthzApi.md#grantaccessvfs) | **POST** /v1/authz/vfs/access/{granteeDid} | Grant access to the virtual file system |
15-
| [**updateAccessVfs**](AuthzApi.md#updateaccessvfs) | **PUT** /v1/authz/vfs/access/{granteeDid} | Update access of granteeDid |
11+
| Method | HTTP request | Description |
12+
| -------------------------------------------------- | -------------------------------------------- | -------------------------------------------------------- |
13+
| [**deleteAccessVfs**](AuthzApi.md#deleteaccessvfs) | **DELETE** /v1/authz/vfs/access/{granteeDid} | delete access of granteeDid |
14+
| [**getAccessVfs**](AuthzApi.md#getaccessvfs) | **GET** /v1/authz/vfs/access/{granteeDid} | Get permissions to the virtual file system for a subject |
15+
| [**grantAccessVfs**](AuthzApi.md#grantaccessvfs) | **POST** /v1/authz/vfs/access/{granteeDid} | Grant access to the virtual file system |
16+
| [**updateAccessVfs**](AuthzApi.md#updateaccessvfs) | **PUT** /v1/authz/vfs/access/{granteeDid} | Update access of granteeDid |
1617

1718
# **deleteAccessVfs**
1819

@@ -62,6 +63,55 @@ void (empty response body)
6263

6364
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
6465

66+
# **getAccessVfs**
67+
68+
> GetAccessOutput getAccessVfs(granteeDid)
69+
70+
Get permissions to the virtual file system for a subject
71+
72+
Retrieves access rights granted to a subject for the virtual file system
73+
74+
### Example
75+
76+
```dart
77+
import 'package:affinidi_tdk_consumer_iam_client/api.dart';
78+
// TODO Configure API key authorization: ConsumerTokenAuth
79+
//defaultApiClient.getAuthentication<ApiKeyAuth>('ConsumerTokenAuth').apiKey = 'YOUR_API_KEY';
80+
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
81+
//defaultApiClient.getAuthentication<ApiKeyAuth>('ConsumerTokenAuth').apiKeyPrefix = 'Bearer';
82+
83+
final api = AffinidiTdkConsumerIamClient().getAuthzApi();
84+
final String granteeDid = granteeDid_example; // String |
85+
86+
try {
87+
final response = api.getAccessVfs(granteeDid);
88+
print(response);
89+
} catch on DioException (e) {
90+
print('Exception when calling AuthzApi->getAccessVfs: $e\n');
91+
}
92+
```
93+
94+
### Parameters
95+
96+
| Name | Type | Description | Notes |
97+
| -------------- | ---------- | ----------- | ----- |
98+
| **granteeDid** | **String** | |
99+
100+
### Return type
101+
102+
[**GetAccessOutput**](GetAccessOutput.md)
103+
104+
### Authorization
105+
106+
[ConsumerTokenAuth](../README.md#ConsumerTokenAuth)
107+
108+
### HTTP request headers
109+
110+
- **Content-Type**: Not defined
111+
- **Accept**: application/json
112+
113+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
114+
65115
# **grantAccessVfs**
66116

67117
> GrantAccessOutput grantAccessVfs(granteeDid, grantAccessInput)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# affinidi_tdk_consumer_iam_client.model.GetAccessOutput
2+
3+
## Load the model package
4+
5+
```dart
6+
import 'package:affinidi_tdk_consumer_iam_client/api.dart';
7+
```
8+
9+
## Properties
10+
11+
| Name | Type | Description | Notes |
12+
| --------------- | ------------------------------------------------ | ------------------------------------- | ----- |
13+
| **permissions** | [**BuiltList&lt;Permission&gt;**](Permission.md) | List of permissions currently granted |
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

clients/dart/consumer_iam_client/doc/Permission.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ import 'package:affinidi_tdk_consumer_iam_client/api.dart';
88

99
## Properties
1010

11-
| Name | Type | Description | Notes |
12-
| ----------- | ------------------------------------------------ | ----------- | ----- |
13-
| **rights** | [**BuiltList&lt;RightsEnum&gt;**](RightsEnum.md) | |
14-
| **nodeIds** | **BuiltList&lt;String&gt;** | |
11+
| Name | Type | Description | Notes |
12+
| ------------- | ------------------------------------------------ | ----------- | ---------- |
13+
| **rights** | [**BuiltList&lt;RightsEnum&gt;**](RightsEnum.md) | |
14+
| **nodeIds** | **BuiltList&lt;String&gt;** | |
15+
| **expiresAt** | [**DateTime**](DateTime.md) | | [optional] |
1516

1617
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

clients/dart/consumer_iam_client/lib/affinidi_tdk_consumer_iam_client.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export 'package:affinidi_tdk_consumer_iam_client/src/api/well_known_api.dart';
1717
export 'package:affinidi_tdk_consumer_iam_client/src/model/consumer_auth_token_endpoint_input.dart';
1818
export 'package:affinidi_tdk_consumer_iam_client/src/model/consumer_auth_token_endpoint_output.dart';
1919
export 'package:affinidi_tdk_consumer_iam_client/src/model/cors_consumer_auth_token_endpoint_ok.dart';
20+
export 'package:affinidi_tdk_consumer_iam_client/src/model/get_access_output.dart';
2021
export 'package:affinidi_tdk_consumer_iam_client/src/model/grant_access_input.dart';
2122
export 'package:affinidi_tdk_consumer_iam_client/src/model/grant_access_output.dart';
2223
export 'package:affinidi_tdk_consumer_iam_client/src/model/invalid_did_error.dart';

clients/dart/consumer_iam_client/lib/src/api/authz_api.dart

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import 'package:built_value/serializer.dart';
88
import 'package:dio/dio.dart';
99

1010
import 'package:affinidi_tdk_consumer_iam_client/src/api_util.dart';
11+
import 'package:affinidi_tdk_consumer_iam_client/src/model/get_access_output.dart';
1112
import 'package:affinidi_tdk_consumer_iam_client/src/model/grant_access_input.dart';
1213
import 'package:affinidi_tdk_consumer_iam_client/src/model/grant_access_output.dart';
1314
import 'package:affinidi_tdk_consumer_iam_client/src/model/update_access_input.dart';
@@ -77,6 +78,92 @@ class AuthzApi {
7778
return _response;
7879
}
7980

81+
/// Get permissions to the virtual file system for a subject
82+
/// Retrieves access rights granted to a subject for the virtual file system
83+
///
84+
/// Parameters:
85+
/// * [granteeDid]
86+
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
87+
/// * [headers] - Can be used to add additional headers to the request
88+
/// * [extras] - Can be used to add flags to the request
89+
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
90+
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
91+
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
92+
///
93+
/// Returns a [Future] containing a [Response] with a [GetAccessOutput] as data
94+
/// Throws [DioException] if API call or serialization fails
95+
Future<Response<GetAccessOutput>> getAccessVfs({
96+
required String granteeDid,
97+
CancelToken? cancelToken,
98+
Map<String, dynamic>? headers,
99+
Map<String, dynamic>? extra,
100+
ValidateStatus? validateStatus,
101+
ProgressCallback? onSendProgress,
102+
ProgressCallback? onReceiveProgress,
103+
}) async {
104+
final _path = r'/v1/authz/vfs/access/{granteeDid}'.replaceAll(
105+
'{' r'granteeDid' '}',
106+
encodeQueryParameter(_serializers, granteeDid, const FullType(String))
107+
.toString());
108+
final _options = Options(
109+
method: r'GET',
110+
headers: <String, dynamic>{
111+
...?headers,
112+
},
113+
extra: <String, dynamic>{
114+
'secure': <Map<String, String>>[
115+
{
116+
'type': 'apiKey',
117+
'name': 'ConsumerTokenAuth',
118+
'keyName': 'authorization',
119+
'where': 'header',
120+
},
121+
],
122+
...?extra,
123+
},
124+
validateStatus: validateStatus,
125+
);
126+
127+
final _response = await _dio.request<Object>(
128+
_path,
129+
options: _options,
130+
cancelToken: cancelToken,
131+
onSendProgress: onSendProgress,
132+
onReceiveProgress: onReceiveProgress,
133+
);
134+
135+
GetAccessOutput? _responseData;
136+
137+
try {
138+
final rawResponse = _response.data;
139+
_responseData = rawResponse == null
140+
? null
141+
: _serializers.deserialize(
142+
rawResponse,
143+
specifiedType: const FullType(GetAccessOutput),
144+
) as GetAccessOutput;
145+
} catch (error, stackTrace) {
146+
throw DioException(
147+
requestOptions: _response.requestOptions,
148+
response: _response,
149+
type: DioExceptionType.unknown,
150+
error: error,
151+
stackTrace: stackTrace,
152+
);
153+
}
154+
155+
return Response<GetAccessOutput>(
156+
data: _responseData,
157+
headers: _response.headers,
158+
isRedirect: _response.isRedirect,
159+
requestOptions: _response.requestOptions,
160+
redirects: _response.redirects,
161+
statusCode: _response.statusCode,
162+
statusMessage: _response.statusMessage,
163+
extra: _response.extra,
164+
);
165+
}
166+
80167
/// Grant access to the virtual file system
81168
/// Grants access rights to a subject for the virtual file system
82169
///
@@ -92,6 +179,7 @@ class AuthzApi {
92179
///
93180
/// Returns a [Future] containing a [Response] with a [GrantAccessOutput] as data
94181
/// Throws [DioException] if API call or serialization fails
182+
@Deprecated('This operation has been deprecated')
95183
Future<Response<GrantAccessOutput>> grantAccessVfs({
96184
required String granteeDid,
97185
required GrantAccessInput grantAccessInput,
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
//
2+
// AUTO-GENERATED FILE, DO NOT MODIFY!
3+
//
4+
5+
// ignore_for_file: unused_element
6+
import 'package:built_collection/built_collection.dart';
7+
import 'package:affinidi_tdk_consumer_iam_client/src/model/permission.dart';
8+
import 'package:built_value/built_value.dart';
9+
import 'package:built_value/serializer.dart';
10+
11+
part 'get_access_output.g.dart';
12+
13+
/// GetAccessOutput
14+
///
15+
/// Properties:
16+
/// * [permissions] - List of permissions currently granted
17+
@BuiltValue()
18+
abstract class GetAccessOutput
19+
implements Built<GetAccessOutput, GetAccessOutputBuilder> {
20+
/// List of permissions currently granted
21+
@BuiltValueField(wireName: r'permissions')
22+
BuiltList<Permission> get permissions;
23+
24+
GetAccessOutput._();
25+
26+
factory GetAccessOutput([void updates(GetAccessOutputBuilder b)]) =
27+
_$GetAccessOutput;
28+
29+
@BuiltValueHook(initializeBuilder: true)
30+
static void _defaults(GetAccessOutputBuilder b) => b;
31+
32+
@BuiltValueSerializer(custom: true)
33+
static Serializer<GetAccessOutput> get serializer =>
34+
_$GetAccessOutputSerializer();
35+
}
36+
37+
class _$GetAccessOutputSerializer
38+
implements PrimitiveSerializer<GetAccessOutput> {
39+
@override
40+
final Iterable<Type> types = const [GetAccessOutput, _$GetAccessOutput];
41+
42+
@override
43+
final String wireName = r'GetAccessOutput';
44+
45+
Iterable<Object?> _serializeProperties(
46+
Serializers serializers,
47+
GetAccessOutput object, {
48+
FullType specifiedType = FullType.unspecified,
49+
}) sync* {
50+
yield r'permissions';
51+
yield serializers.serialize(
52+
object.permissions,
53+
specifiedType: const FullType(BuiltList, [FullType(Permission)]),
54+
);
55+
}
56+
57+
@override
58+
Object serialize(
59+
Serializers serializers,
60+
GetAccessOutput object, {
61+
FullType specifiedType = FullType.unspecified,
62+
}) {
63+
return _serializeProperties(serializers, object,
64+
specifiedType: specifiedType)
65+
.toList();
66+
}
67+
68+
void _deserializeProperties(
69+
Serializers serializers,
70+
Object serialized, {
71+
FullType specifiedType = FullType.unspecified,
72+
required List<Object?> serializedList,
73+
required GetAccessOutputBuilder result,
74+
required List<Object?> unhandled,
75+
}) {
76+
for (var i = 0; i < serializedList.length; i += 2) {
77+
final key = serializedList[i] as String;
78+
final value = serializedList[i + 1];
79+
switch (key) {
80+
case r'permissions':
81+
final valueDes = serializers.deserialize(
82+
value,
83+
specifiedType: const FullType(BuiltList, [FullType(Permission)]),
84+
) as BuiltList<Permission>;
85+
result.permissions.replace(valueDes);
86+
break;
87+
default:
88+
unhandled.add(key);
89+
unhandled.add(value);
90+
break;
91+
}
92+
}
93+
}
94+
95+
@override
96+
GetAccessOutput deserialize(
97+
Serializers serializers,
98+
Object serialized, {
99+
FullType specifiedType = FullType.unspecified,
100+
}) {
101+
final result = GetAccessOutputBuilder();
102+
final serializedList = (serialized as Iterable<Object?>).toList();
103+
final unhandled = <Object?>[];
104+
_deserializeProperties(
105+
serializers,
106+
serialized,
107+
specifiedType: specifiedType,
108+
serializedList: serializedList,
109+
unhandled: unhandled,
110+
result: result,
111+
);
112+
return result.build();
113+
}
114+
}

0 commit comments

Comments
 (0)