Skip to content

Commit 9c4d476

Browse files
mewmbageel9
andauthored
Update Connect Swagger (#1727)
Co-authored-by: geel9 <geel9@users.noreply.github.com> Co-authored-by: mewmba <mewmba@users.noreply.github.com>
1 parent 1866a46 commit 9c4d476

File tree

177 files changed

+7721
-1389
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+7721
-1389
lines changed

connect/dart/.openapi-generator/FILES

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,38 @@
44
README.md
55
analysis_options.yaml
66
doc/Address.md
7+
doc/Attachments.md
8+
doc/AttachmentsApi.md
79
doc/CancelSessionResponse.md
810
doc/CreateSessionRequest.md
911
doc/CreateSessionResponse.md
1012
doc/DisclosedFields.md
1113
doc/DisclosedFieldsRequest.md
1214
doc/DocumentData.md
15+
doc/ExchangeResultsKeyRequest.md
16+
doc/ExchangeResultsKeyResponse.md
1317
doc/FailureMessage.md
14-
doc/GetSessionResponseV1.md
15-
doc/IDVSessionState.md
18+
doc/GetSessionResponse.md
1619
doc/IdentityData.md
20+
doc/IdentityLookupResponse.md
21+
doc/Integration.md
22+
doc/ListProvidersResponse.md
1723
doc/ListSessionsResponse.md
24+
doc/NetworkApi.md
1825
doc/OrderDirection.md
1926
doc/PersonData.md
2027
doc/Session.md
2128
doc/SessionFailCode.md
2229
doc/SessionOrdering.md
30+
doc/SessionState.md
2331
doc/SessionsApi.md
2432
doc/ValidationResult.md
2533
doc/Verification.md
2634
doc/VerificationFailCode.md
27-
doc/VerificationState.md
2835
git_push.sh
2936
lib/api.dart
37+
lib/api/attachments_api.dart
38+
lib/api/network_api.dart
3039
lib/api/sessions_api.dart
3140
lib/api_client.dart
3241
lib/api_exception.dart
@@ -37,46 +46,58 @@ lib/auth/http_basic_auth.dart
3746
lib/auth/http_bearer_auth.dart
3847
lib/auth/oauth.dart
3948
lib/model/address.dart
49+
lib/model/attachments.dart
4050
lib/model/cancel_session_response.dart
4151
lib/model/create_session_request.dart
4252
lib/model/create_session_response.dart
4353
lib/model/disclosed_fields.dart
4454
lib/model/disclosed_fields_request.dart
4555
lib/model/document_data.dart
56+
lib/model/exchange_results_key_request.dart
57+
lib/model/exchange_results_key_response.dart
4658
lib/model/failure_message.dart
47-
lib/model/get_session_response_v1.dart
59+
lib/model/get_session_response.dart
4860
lib/model/identity_data.dart
49-
lib/model/idv_session_state.dart
61+
lib/model/identity_lookup_response.dart
62+
lib/model/integration.dart
63+
lib/model/list_providers_response.dart
5064
lib/model/list_sessions_response.dart
5165
lib/model/order_direction.dart
5266
lib/model/person_data.dart
5367
lib/model/session.dart
5468
lib/model/session_fail_code.dart
5569
lib/model/session_ordering.dart
70+
lib/model/session_state.dart
5671
lib/model/validation_result.dart
5772
lib/model/verification.dart
5873
lib/model/verification_fail_code.dart
59-
lib/model/verification_state.dart
6074
pubspec.yaml
6175
test/address_test.dart
76+
test/attachments_api_test.dart
77+
test/attachments_test.dart
6278
test/cancel_session_response_test.dart
6379
test/create_session_request_test.dart
6480
test/create_session_response_test.dart
6581
test/disclosed_fields_request_test.dart
6682
test/disclosed_fields_test.dart
6783
test/document_data_test.dart
84+
test/exchange_results_key_request_test.dart
85+
test/exchange_results_key_response_test.dart
6886
test/failure_message_test.dart
69-
test/get_session_response_v1_test.dart
87+
test/get_session_response_test.dart
7088
test/identity_data_test.dart
71-
test/idv_session_state_test.dart
89+
test/identity_lookup_response_test.dart
90+
test/integration_test.dart
91+
test/list_providers_response_test.dart
7292
test/list_sessions_response_test.dart
93+
test/network_api_test.dart
7394
test/order_direction_test.dart
7495
test/person_data_test.dart
7596
test/session_fail_code_test.dart
7697
test/session_ordering_test.dart
98+
test/session_state_test.dart
7799
test/session_test.dart
78100
test/sessions_api_test.dart
79101
test/validation_result_test.dart
80102
test/verification_fail_code_test.dart
81-
test/verification_state_test.dart
82103
test/verification_test.dart

connect/dart/README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,13 @@ import 'package:TrinsicConnect/api.dart';
4747
// String yourTokenGeneratorFunction() { ... }
4848
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);
4949
50-
final api_instance = SessionsApi();
51-
final sessionId = sessionId_example; // String |
50+
final api_instance = AttachmentsApi();
51+
final attachmentAccessKey = attachmentAccessKey_example; // String |
5252
5353
try {
54-
final result = api_instance.cancelSession(sessionId);
55-
print(result);
54+
api_instance.getAttachment(attachmentAccessKey);
5655
} catch (e) {
57-
print('Exception when calling SessionsApi->cancelSession: $e\n');
56+
print('Exception when calling AttachmentsApi->getAttachment: $e\n');
5857
}
5958
6059
```
@@ -65,36 +64,45 @@ All URIs are relative to *https://connect.trinsic.id*
6564

6665
Class | Method | HTTP request | Description
6766
------------ | ------------- | ------------- | -------------
68-
*SessionsApi* | [**cancelSession**](doc//SessionsApi.md#cancelsession) | **POST** /api/v1/sessions/{sessionId}/cancel |
69-
*SessionsApi* | [**createSession**](doc//SessionsApi.md#createsession) | **POST** /api/v1/sessions |
70-
*SessionsApi* | [**getSession**](doc//SessionsApi.md#getsession) | **GET** /api/v1/sessions/{sessionId} |
71-
*SessionsApi* | [**listSessions**](doc//SessionsApi.md#listsessions) | **GET** /api/v1/sessions |
72-
*SessionsApi* | [**redactSession**](doc//SessionsApi.md#redactsession) | **POST** /api/v1/sessions/{sessionId}/redact |
67+
*AttachmentsApi* | [**getAttachment**](doc//AttachmentsApi.md#getattachment) | **GET** /api/v1/attachments/fetch | Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the linked resource. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant.
68+
*NetworkApi* | [**identityLookup**](doc//NetworkApi.md#identitylookup) | **GET** /api/v1/network/identities/{phoneNumber} | Query the availability of an identity in the Trinsic Network by phone number
69+
*NetworkApi* | [**listProviders**](doc//NetworkApi.md#listproviders) | **GET** /api/v1/network/providers | List all identity providers available for use
70+
*SessionsApi* | [**cancelSession**](doc//SessionsApi.md#cancelsession) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel a Session by its ID
71+
*SessionsApi* | [**createSession**](doc//SessionsApi.md#createsession) | **POST** /api/v1/sessions | Create a Session to verify a user's identity
72+
*SessionsApi* | [**exchangeResultsKey**](doc//SessionsApi.md#exchangeresultskey) | **POST** /api/v1/sessions/{sessionId}/results | Exchange a Results Access Key for Identity Data
73+
*SessionsApi* | [**getSession**](doc//SessionsApi.md#getsession) | **GET** /api/v1/sessions/{sessionId} | Get a Session by its ID
74+
*SessionsApi* | [**listSessions**](doc//SessionsApi.md#listsessions) | **GET** /api/v1/sessions | List Sessions created by your account
75+
*SessionsApi* | [**redactSession**](doc//SessionsApi.md#redactsession) | **POST** /api/v1/sessions/{sessionId}/redact | Redact a Session, removing all identity data from Trinsic's servers. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
7376

7477

7578
## Documentation For Models
7679

7780
- [Address](doc//Address.md)
81+
- [Attachments](doc//Attachments.md)
7882
- [CancelSessionResponse](doc//CancelSessionResponse.md)
7983
- [CreateSessionRequest](doc//CreateSessionRequest.md)
8084
- [CreateSessionResponse](doc//CreateSessionResponse.md)
8185
- [DisclosedFields](doc//DisclosedFields.md)
8286
- [DisclosedFieldsRequest](doc//DisclosedFieldsRequest.md)
8387
- [DocumentData](doc//DocumentData.md)
88+
- [ExchangeResultsKeyRequest](doc//ExchangeResultsKeyRequest.md)
89+
- [ExchangeResultsKeyResponse](doc//ExchangeResultsKeyResponse.md)
8490
- [FailureMessage](doc//FailureMessage.md)
85-
- [GetSessionResponseV1](doc//GetSessionResponseV1.md)
86-
- [IDVSessionState](doc//IDVSessionState.md)
91+
- [GetSessionResponse](doc//GetSessionResponse.md)
8792
- [IdentityData](doc//IdentityData.md)
93+
- [IdentityLookupResponse](doc//IdentityLookupResponse.md)
94+
- [Integration](doc//Integration.md)
95+
- [ListProvidersResponse](doc//ListProvidersResponse.md)
8896
- [ListSessionsResponse](doc//ListSessionsResponse.md)
8997
- [OrderDirection](doc//OrderDirection.md)
9098
- [PersonData](doc//PersonData.md)
9199
- [Session](doc//Session.md)
92100
- [SessionFailCode](doc//SessionFailCode.md)
93101
- [SessionOrdering](doc//SessionOrdering.md)
102+
- [SessionState](doc//SessionState.md)
94103
- [ValidationResult](doc//ValidationResult.md)
95104
- [Verification](doc//Verification.md)
96105
- [VerificationFailCode](doc//VerificationFailCode.md)
97-
- [VerificationState](doc//VerificationState.md)
98106

99107

100108
## Documentation For Authorization

connect/dart/doc/Address.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
1515
**state** | **String** | | [optional]
1616
**postalCode** | **String** | | [optional]
1717
**country** | **String** | | [optional]
18-
**fullAddress** | **String** | | [optional]
18+
**fullAddress** | **String** | The full address as a single string | [optional]
1919

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

connect/dart/doc/Attachments.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# TrinsicConnect.model.Attachments
2+
3+
## Load the model package
4+
```dart
5+
import 'package:TrinsicConnect/api.dart';
6+
```
7+
8+
## Properties
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**selfie** | **String** | Key to access the selfie image (if relevant) for this verification | [optional]
12+
**documentFront** | **String** | Key to access the document front image (if relevant) for this verification | [optional]
13+
**documentBack** | **String** | Key to access the document back image (if relevant) for this verification | [optional]
14+
**documentPortrait** | **String** | Key to access the document portrait image (if relevant and available) for this verification. Specifically, this is a cropped version of the document front image which includes only the portrait on the document. | [optional]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
18+

connect/dart/doc/AttachmentsApi.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# TrinsicConnect.api.AttachmentsApi
2+
3+
## Load the API package
4+
```dart
5+
import 'package:TrinsicConnect/api.dart';
6+
```
7+
8+
All URIs are relative to *https://connect.trinsic.id*
9+
10+
Method | HTTP request | Description
11+
------------- | ------------- | -------------
12+
[**getAttachment**](AttachmentsApi.md#getattachment) | **GET** /api/v1/attachments/fetch | Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the linked resource. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant.
13+
14+
15+
# **getAttachment**
16+
> getAttachment(attachmentAccessKey)
17+
18+
Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the linked resource. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant.
19+
20+
### Example
21+
```dart
22+
import 'package:TrinsicConnect/api.dart';
23+
// TODO Configure HTTP Bearer authorization: Bearer
24+
// Case 1. Use String Token
25+
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken('YOUR_ACCESS_TOKEN');
26+
// Case 2. Use Function which generate token.
27+
// String yourTokenGeneratorFunction() { ... }
28+
//defaultApiClient.getAuthentication<HttpBearerAuth>('Bearer').setAccessToken(yourTokenGeneratorFunction);
29+
30+
final api_instance = AttachmentsApi();
31+
final attachmentAccessKey = attachmentAccessKey_example; // String |
32+
33+
try {
34+
api_instance.getAttachment(attachmentAccessKey);
35+
} catch (e) {
36+
print('Exception when calling AttachmentsApi->getAttachment: $e\n');
37+
}
38+
```
39+
40+
### Parameters
41+
42+
Name | Type | Description | Notes
43+
------------- | ------------- | ------------- | -------------
44+
**attachmentAccessKey** | **String**| | [optional]
45+
46+
### Return type
47+
48+
void (empty response body)
49+
50+
### Authorization
51+
52+
[Bearer](../README.md#Bearer)
53+
54+
### HTTP request headers
55+
56+
- **Content-Type**: Not defined
57+
- **Accept**: application/json
58+
59+
[[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)
60+

connect/dart/doc/CreateSessionRequest.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ import 'package:TrinsicConnect/api.dart';
88
## Properties
99
Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
11-
**fields** | [**DisclosedFieldsRequest**](DisclosedFieldsRequest.md) | | [optional]
11+
**direct** | **bool** | Whether to create this Session in Direct mode. Direct mode is used to execute a verification against a specific identity provider. Users will not be shown the Connect Widget; therefore, reuse of Connect credentials, selection of an identity provider, and saving a verification for future reuse are not available to the end user in direct mode. Sessions created in direct mode must be created with a `RedirectUrl` specified, and cannot be invoked using the frontend SDK at this time. | [optional]
12+
**redirectUrl** | **String** | The URL to redirect to after the user has completed the identity verification process. If `Direct` is set to `true`, this field is required. | [optional]
13+
**providers** | **List<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed. If `Direct` is `true`, this field must be set, and must have only a single entry. If `Direct` is not specified or is `false`, this field may have any number of entries. | [optional] [default to const []]
14+
**disclosedFields** | [**DisclosedFieldsRequest**](DisclosedFieldsRequest.md) | Specific identity attributes to request. If not provided, all available attributes will be requested. | [optional]
1215

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

connect/dart/doc/CreateSessionResponse.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ import 'package:TrinsicConnect/api.dart';
88
## Properties
99
Name | Type | Description | Notes
1010
------------ | ------------- | ------------- | -------------
11-
**session** | [**Session**](Session.md) | |
11+
**session** | [**Session**](Session.md) | The created Acceptance Session |
12+
**launchUrl** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device. If the Session was created in `direct` mode, you should redirect your user's browser to this URL. The frontend SDK cannot presently be used to invoke direct mode Sessions. If the Session was not created in `direct` mode, you should pass this URL to your user's frontend and use the frontend SDK to invoke the Session. This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional]
1213

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

connect/dart/doc/DisclosedFields.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Name | Type | Description | Notes
1616
**country** | **bool** | |
1717
**issueDate** | **bool** | |
1818
**expirationDate** | **bool** | |
19+
**documentFront** | **bool** | |
20+
**documentBack** | **bool** | |
21+
**documentPortrait** | **bool** | |
22+
**selfie** | **bool** | |
1923

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

connect/dart/doc/DisclosedFieldsRequest.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ Name | Type | Description | Notes
1616
**country** | **bool** | | [optional]
1717
**issueDate** | **bool** | | [optional]
1818
**expirationDate** | **bool** | | [optional]
19+
**documentFront** | **bool** | | [optional]
20+
**documentBack** | **bool** | | [optional]
21+
**documentPortrait** | **bool** | | [optional]
22+
**selfie** | **bool** | | [optional]
1923

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

connect/dart/doc/DocumentData.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Name | Type | Description | Notes
1313
**issueDate** | **String** | | [optional]
1414
**expirationDate** | **String** | | [optional]
1515
**issuingCountry** | **String** | | [optional]
16-
**portrait** | **String** | | [optional]
1716

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

0 commit comments

Comments
 (0)