@polyguard/sdk 1.0.0

package/src/generated/docs/UsersApi.md

@@ -0,0 +1,362 @@
+# FastApi.UsersApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**beginAppAttestBeginAppAttestPost**](UsersApi.md#beginAppAttestBeginAppAttestPost) | **POST** /begin_app_attest/ | Begin App Attest
+[**checkUpdateNeededCheckUpdateNeededPost**](UsersApi.md#checkUpdateNeededCheckUpdateNeededPost) | **POST** /check_update_needed/ | Check Update Needed
+[**deleteUserDeleteUserPost**](UsersApi.md#deleteUserDeleteUserPost) | **POST** /delete_user/ | Delete User
+[**fetchRegisteredUsersFetchRegisteredUsersPost**](UsersApi.md#fetchRegisteredUsersFetchRegisteredUsersPost) | **POST** /fetch_registered_users/ | Fetch Registered Users
+[**inviteUserInviteUserPost**](UsersApi.md#inviteUserInviteUserPost) | **POST** /invite_user/ | Invite User
+[**registerUserRegisterUserPost**](UsersApi.md#registerUserRegisterUserPost) | **POST** /register_user/ | Register User
+[**updateUserUpdateUserPut**](UsersApi.md#updateUserUpdateUserPut) | **PUT** /update_user/ | Update User
+[**verifyAppAttestVerifyAppPost**](UsersApi.md#verifyAppAttestVerifyAppPost) | **POST** /verify_app/ | Verify App Attest
+
+
+
+## beginAppAttestBeginAppAttestPost
+
+> Object beginAppAttestBeginAppAttestPost(startAttestationRequest)
+
+Begin App Attest
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let startAttestationRequest = new FastApi.StartAttestationRequest(); // StartAttestationRequest | 
+apiInstance.beginAppAttestBeginAppAttestPost(startAttestationRequest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **startAttestationRequest** | [**StartAttestationRequest**](StartAttestationRequest.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## checkUpdateNeededCheckUpdateNeededPost
+
+> Object checkUpdateNeededCheckUpdateNeededPost(appattest)
+
+Check Update Needed
+
+Check if a user needs to call update_user by finding phones without alerts_device_tokens.  Args:     user: The user to check     session: Database session      Returns:     Dict containing:     - needs_update: bool indicating if update is needed     - phone_numbers: list of phone numbers that need alerts_device_tokens
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let appattest = "appattest_example"; // String | 
+apiInstance.checkUpdateNeededCheckUpdateNeededPost(appattest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appattest** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## deleteUserDeleteUserPost
+
+> Object deleteUserDeleteUserPost(appattest)
+
+Delete User
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let appattest = "appattest_example"; // String | 
+apiInstance.deleteUserDeleteUserPost(appattest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appattest** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## fetchRegisteredUsersFetchRegisteredUsersPost
+
+> [Object] fetchRegisteredUsersFetchRegisteredUsersPost(appattest)
+
+Fetch Registered Users
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let appattest = "appattest_example"; // String | 
+apiInstance.fetchRegisteredUsersFetchRegisteredUsersPost(appattest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appattest** | **String**|  | 
+
+### Return type
+
+**[Object]**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## inviteUserInviteUserPost
+
+> Object inviteUserInviteUserPost(inviteRequestModel)
+
+Invite User
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let inviteRequestModel = new FastApi.InviteRequestModel(); // InviteRequestModel | 
+apiInstance.inviteUserInviteUserPost(inviteRequestModel, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inviteRequestModel** | [**InviteRequestModel**](InviteRequestModel.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## registerUserRegisterUserPost
+
+> Object registerUserRegisterUserPost(appattest)
+
+Register User
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let appattest = "appattest_example"; // String | 
+apiInstance.registerUserRegisterUserPost(appattest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appattest** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## updateUserUpdateUserPut
+
+> Object updateUserUpdateUserPut(appattest)
+
+Update User
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let appattest = "appattest_example"; // String | 
+apiInstance.updateUserUpdateUserPut(appattest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appattest** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verifyAppAttestVerifyAppPost
+
+> Object verifyAppAttestVerifyAppPost(verifyRequest)
+
+Verify App Attest
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.UsersApi();
+let verifyRequest = new FastApi.VerifyRequest(); // VerifyRequest | 
+apiInstance.verifyAppAttestVerifyAppPost(verifyRequest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verifyRequest** | [**VerifyRequest**](VerifyRequest.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/src/generated/docs/ValidationError.md

@@ -0,0 +1,11 @@
+# FastApi.ValidationError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**loc** | [**[ValidationErrorLocInner]**](ValidationErrorLocInner.md) |  | 
+**msg** | **String** |  | 
+**type** | **String** |  | 
+
+

package/src/generated/docs/ValidationErrorLocInner.md

@@ -0,0 +1,8 @@
+# FastApi.ValidationErrorLocInner
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

package/src/generated/docs/VeriffApi.md

@@ -0,0 +1,188 @@
+# FastApi.VeriffApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createVeriffSessionVeriffSessionPost**](VeriffApi.md#createVeriffSessionVeriffSessionPost) | **POST** /veriff/session/ | Create Veriff Session
+[**pollVeriffSessionVeriffPollSessionSessionIdPatch**](VeriffApi.md#pollVeriffSessionVeriffPollSessionSessionIdPatch) | **PATCH** /veriff/poll-session/{session_id} | Poll Veriff Session
+[**uploadVeriffMediaVeriffUploadMediaSessionIdPost**](VeriffApi.md#uploadVeriffMediaVeriffUploadMediaSessionIdPost) | **POST** /veriff/upload-media/{session_id} | Upload Veriff Media
+[**veriffWebhookVeriffWebhookPost**](VeriffApi.md#veriffWebhookVeriffWebhookPost) | **POST** /veriff/webhook | Veriff Webhook
+
+
+
+## createVeriffSessionVeriffSessionPost
+
+> Object createVeriffSessionVeriffSessionPost(veriffSessionRequest)
+
+Create Veriff Session
+
+Create verification session
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.VeriffApi();
+let veriffSessionRequest = new FastApi.VeriffSessionRequest(); // VeriffSessionRequest | 
+apiInstance.createVeriffSessionVeriffSessionPost(veriffSessionRequest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **veriffSessionRequest** | [**VeriffSessionRequest**](VeriffSessionRequest.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pollVeriffSessionVeriffPollSessionSessionIdPatch
+
+> Object pollVeriffSessionVeriffPollSessionSessionIdPatch(sessionId)
+
+Poll Veriff Session
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.VeriffApi();
+let sessionId = "sessionId_example"; // String | 
+apiInstance.pollVeriffSessionVeriffPollSessionSessionIdPatch(sessionId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sessionId** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## uploadVeriffMediaVeriffUploadMediaSessionIdPost
+
+> Object uploadVeriffMediaVeriffUploadMediaSessionIdPost(sessionId, files)
+
+Upload Veriff Media
+
+Upload media to specific session
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.VeriffApi();
+let sessionId = "sessionId_example"; // String | 
+let files = ["null"]; // [File] | 
+apiInstance.uploadVeriffMediaVeriffUploadMediaSessionIdPost(sessionId, files, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sessionId** | **String**|  | 
+ **files** | **[File]**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## veriffWebhookVeriffWebhookPost
+
+> Object veriffWebhookVeriffWebhookPost()
+
+Veriff Webhook
+
+Handle incoming webhook events from Veriff
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.VeriffApi();
+apiInstance.veriffWebhookVeriffWebhookPost((error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

package/src/generated/docs/VeriffSessionRequest.md

@@ -0,0 +1,10 @@
+# FastApi.VeriffSessionRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userDocument** | **String** |  | 
+**documentType** | **String** |  | [optional] 
+
+

package/src/generated/docs/VerifyRequest.md

@@ -0,0 +1,10 @@
+# FastApi.VerifyRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attestation** | **String** |  | 
+**keyId** | **String** |  | 
+
+