@polyguard/sdk 1.4.2 → 1.5.1

package/src/generated/docs/StirApi.md

@@ -1,52 +0,0 @@
-# FastApi.StirApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**callInitiationStirCallInitiationPost**](StirApi.md#callInitiationStirCallInitiationPost) | **POST** /stir/call_initiation | Call Initiation
-
-
-
-## callInitiationStirCallInitiationPost
-
-> Object callInitiationStirCallInitiationPost(apiControllersPslStirCallRequest)
-
-Call Initiation
-
-### Example
-
-```javascript
-import FastApi from 'fast_api';
-
-let apiInstance = new FastApi.StirApi();
-let apiControllersPslStirCallRequest = new FastApi.ApiControllersPslStirCallRequest(); // ApiControllersPslStirCallRequest | 
-apiInstance.callInitiationStirCallInitiationPost(apiControllersPslStirCallRequest, (error, data, response) => {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-});
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **apiControllersPslStirCallRequest** | [**ApiControllersPslStirCallRequest**](ApiControllersPslStirCallRequest.md)|  | 
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

package/src/generated/docs/TwilioApi.md

@@ -1,138 +0,0 @@
-# FastApi.TwilioApi
-
-All URIs are relative to *http://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**twilioCheckTwilioCheckPost**](TwilioApi.md#twilioCheckTwilioCheckPost) | **POST** /twilio/check | Twilio Check
-[**twilioStartTwilioStartPost**](TwilioApi.md#twilioStartTwilioStartPost) | **POST** /twilio/start | Twilio Start
-[**twilioWebhookTwilioWebhookPost**](TwilioApi.md#twilioWebhookTwilioWebhookPost) | **POST** /twilio/webhook | Twilio Webhook
-
-
-
-## twilioCheckTwilioCheckPost
-
-> Object twilioCheckTwilioCheckPost(numberVerification)
-
-Twilio Check
-
-### Example
-
-```javascript
-import FastApi from 'fast_api';
-
-let apiInstance = new FastApi.TwilioApi();
-let numberVerification = new FastApi.NumberVerification(); // NumberVerification | 
-apiInstance.twilioCheckTwilioCheckPost(numberVerification, (error, data, response) => {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-});
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **numberVerification** | [**NumberVerification**](NumberVerification.md)|  | 
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## twilioStartTwilioStartPost
-
-> Object twilioStartTwilioStartPost(numberVerification)
-
-Twilio Start
-
-### Example
-
-```javascript
-import FastApi from 'fast_api';
-
-let apiInstance = new FastApi.TwilioApi();
-let numberVerification = new FastApi.NumberVerification(); // NumberVerification | 
-apiInstance.twilioStartTwilioStartPost(numberVerification, (error, data, response) => {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-});
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **numberVerification** | [**NumberVerification**](NumberVerification.md)|  | 
-
-### Return type
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## twilioWebhookTwilioWebhookPost
-
-> Object twilioWebhookTwilioWebhookPost()
-
-Twilio Webhook
-
-Handle incoming webhook events from Twilio
-
-### Example
-
-```javascript
-import FastApi from 'fast_api';
-
-let apiInstance = new FastApi.TwilioApi();
-apiInstance.twilioWebhookTwilioWebhookPost((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/UsersApi.md

@@ -1,362 +0,0 @@
-# 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

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

package/src/generated/docs/ValidationErrorLocInner.md

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