@polyguard/sdk 1.0.1 → 1.0.2

package/src/generated/docs/SecureLinksApi.md

@@ -0,0 +1,614 @@
+# FastApi.SecureLinksApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getRedirectInfoV2PreviewAppIdLinkUuidGet**](SecureLinksApi.md#getRedirectInfoV2PreviewAppIdLinkUuidGet) | **GET** /v2/preview/{app_id}/{link_uuid} | Get Redirect Info
+[**getRedirectInfoV2PreviewFormatTypeAppIdLinkUuidGet**](SecureLinksApi.md#getRedirectInfoV2PreviewFormatTypeAppIdLinkUuidGet) | **GET** /v2/preview/{format_type}/{app_id}/{link_uuid} | Get Redirect Info
+[**getRedirectInfoV2PreviewLinkUuidGet**](SecureLinksApi.md#getRedirectInfoV2PreviewLinkUuidGet) | **GET** /v2/preview/{link_uuid} | Get Redirect Info
+[**getSvgResponseV2ScanAppIdLinkUuidGet**](SecureLinksApi.md#getSvgResponseV2ScanAppIdLinkUuidGet) | **GET** /v2/scan/{app_id}/{link_uuid} | Get Svg Response
+[**getSvgResponseV2ScanFormatTypeAppIdLinkUuidGet**](SecureLinksApi.md#getSvgResponseV2ScanFormatTypeAppIdLinkUuidGet) | **GET** /v2/scan/{format_type}/{app_id}/{link_uuid} | Get Svg Response
+[**pgCompleteRedirectV2RedirectAppIdLinkUuidPost**](SecureLinksApi.md#pgCompleteRedirectV2RedirectAppIdLinkUuidPost) | **POST** /v2/redirect/{app_id}/{link_uuid} | Pg Complete Redirect
+[**pgCompleteRedirectV2RedirectFormatTypeAppIdLinkUuidPost**](SecureLinksApi.md#pgCompleteRedirectV2RedirectFormatTypeAppIdLinkUuidPost) | **POST** /v2/redirect/{format_type}/{app_id}/{link_uuid} | Pg Complete Redirect
+[**pgCompleteRedirectV2RedirectLinkUuidPost**](SecureLinksApi.md#pgCompleteRedirectV2RedirectLinkUuidPost) | **POST** /v2/redirect/{link_uuid} | Pg Complete Redirect
+[**pgLoginV2AppIdLinkUuidGet**](SecureLinksApi.md#pgLoginV2AppIdLinkUuidGet) | **GET** /v2/{app_id}/{link_uuid} | Pg Login
+[**pgLoginV2FormatTypeAppIdLinkUuidGet**](SecureLinksApi.md#pgLoginV2FormatTypeAppIdLinkUuidGet) | **GET** /v2/{format_type}/{app_id}/{link_uuid} | Pg Login
+[**pgLoginV2LinkUuidGet**](SecureLinksApi.md#pgLoginV2LinkUuidGet) | **GET** /v2/{link_uuid} | Pg Login
+[**pgPollV2PollPcreGet**](SecureLinksApi.md#pgPollV2PollPcreGet) | **GET** /v2/poll/{pcre} | Pg Poll
+
+
+
+## getRedirectInfoV2PreviewAppIdLinkUuidGet
+
+> Object getRedirectInfoV2PreviewAppIdLinkUuidGet(linkUuid, appId, opts)
+
+Get Redirect Info
+
+Get detailed information about a secure link.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+let opts = {
+  'formatType': "'A'" // String | 
+};
+apiInstance.getRedirectInfoV2PreviewAppIdLinkUuidGet(linkUuid, appId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+ **formatType** | **String**|  | [optional] [default to 'A']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getRedirectInfoV2PreviewFormatTypeAppIdLinkUuidGet
+
+> Object getRedirectInfoV2PreviewFormatTypeAppIdLinkUuidGet(formatType, linkUuid, appId)
+
+Get Redirect Info
+
+Get detailed information about a secure link.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let formatType = "formatType_example"; // String | 
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+apiInstance.getRedirectInfoV2PreviewFormatTypeAppIdLinkUuidGet(formatType, linkUuid, appId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **formatType** | **String**|  | 
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getRedirectInfoV2PreviewLinkUuidGet
+
+> Object getRedirectInfoV2PreviewLinkUuidGet(linkUuid, opts)
+
+Get Redirect Info
+
+Get detailed information about a secure link.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let opts = {
+  'formatType': "'A'", // String | 
+  'appId': "appId_example" // String | 
+};
+apiInstance.getRedirectInfoV2PreviewLinkUuidGet(linkUuid, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **formatType** | **String**|  | [optional] [default to 'A']
+ **appId** | **String**|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getSvgResponseV2ScanAppIdLinkUuidGet
+
+> Object getSvgResponseV2ScanAppIdLinkUuidGet(appId, linkUuid)
+
+Get Svg Response
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let appId = "appId_example"; // String | 
+let linkUuid = "linkUuid_example"; // String | 
+apiInstance.getSvgResponseV2ScanAppIdLinkUuidGet(appId, linkUuid, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**|  | 
+ **linkUuid** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getSvgResponseV2ScanFormatTypeAppIdLinkUuidGet
+
+> Object getSvgResponseV2ScanFormatTypeAppIdLinkUuidGet(appId, linkUuid)
+
+Get Svg Response
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let appId = "appId_example"; // String | 
+let linkUuid = "linkUuid_example"; // String | 
+apiInstance.getSvgResponseV2ScanFormatTypeAppIdLinkUuidGet(appId, linkUuid, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**|  | 
+ **linkUuid** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgCompleteRedirectV2RedirectAppIdLinkUuidPost
+
+> Object pgCompleteRedirectV2RedirectAppIdLinkUuidPost(linkUuid, appId, appattest, opts)
+
+Pg Complete Redirect
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+let appattest = "appattest_example"; // String | 
+let opts = {
+  'formatType': "'A'", // String | 
+  'pcre': "pcre_example" // String | 
+};
+apiInstance.pgCompleteRedirectV2RedirectAppIdLinkUuidPost(linkUuid, appId, appattest, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+ **appattest** | **String**|  | 
+ **formatType** | **String**|  | [optional] [default to 'A']
+ **pcre** | **String**|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgCompleteRedirectV2RedirectFormatTypeAppIdLinkUuidPost
+
+> Object pgCompleteRedirectV2RedirectFormatTypeAppIdLinkUuidPost(formatType, linkUuid, appId, appattest, opts)
+
+Pg Complete Redirect
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let formatType = "formatType_example"; // String | 
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+let appattest = "appattest_example"; // String | 
+let opts = {
+  'pcre': "pcre_example" // String | 
+};
+apiInstance.pgCompleteRedirectV2RedirectFormatTypeAppIdLinkUuidPost(formatType, linkUuid, appId, appattest, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **formatType** | **String**|  | 
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+ **appattest** | **String**|  | 
+ **pcre** | **String**|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgCompleteRedirectV2RedirectLinkUuidPost
+
+> Object pgCompleteRedirectV2RedirectLinkUuidPost(linkUuid, appattest, opts)
+
+Pg Complete Redirect
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let appattest = "appattest_example"; // String | 
+let opts = {
+  'formatType': "'A'", // String | 
+  'pcre': "pcre_example", // String | 
+  'appId': "appId_example" // String | 
+};
+apiInstance.pgCompleteRedirectV2RedirectLinkUuidPost(linkUuid, appattest, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appattest** | **String**|  | 
+ **formatType** | **String**|  | [optional] [default to 'A']
+ **pcre** | **String**|  | [optional] 
+ **appId** | **String**|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgLoginV2AppIdLinkUuidGet
+
+> Object pgLoginV2AppIdLinkUuidGet(linkUuid, appId, opts)
+
+Pg Login
+
+PRESENTS LOGIN PAGE ON DESKTOP. HIJACKED by PSL ON MOBILE and REDIRECTED BY DECORATOR.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+let opts = {
+  'formatType': "'A'" // String | 
+};
+apiInstance.pgLoginV2AppIdLinkUuidGet(linkUuid, appId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+ **formatType** | **String**|  | [optional] [default to 'A']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgLoginV2FormatTypeAppIdLinkUuidGet
+
+> Object pgLoginV2FormatTypeAppIdLinkUuidGet(linkUuid, appId, formatType)
+
+Pg Login
+
+PRESENTS LOGIN PAGE ON DESKTOP. HIJACKED by PSL ON MOBILE and REDIRECTED BY DECORATOR.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let appId = "appId_example"; // String | 
+let formatType = "formatType_example"; // String | 
+apiInstance.pgLoginV2FormatTypeAppIdLinkUuidGet(linkUuid, appId, formatType, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | 
+ **formatType** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgLoginV2LinkUuidGet
+
+> Object pgLoginV2LinkUuidGet(linkUuid, opts)
+
+Pg Login
+
+PRESENTS LOGIN PAGE ON DESKTOP. HIJACKED by PSL ON MOBILE and REDIRECTED BY DECORATOR.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let linkUuid = "linkUuid_example"; // String | 
+let opts = {
+  'appId': "appId_example", // String | 
+  'formatType': "'A'" // String | 
+};
+apiInstance.pgLoginV2LinkUuidGet(linkUuid, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **linkUuid** | **String**|  | 
+ **appId** | **String**|  | [optional] 
+ **formatType** | **String**|  | [optional] [default to 'A']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pgPollV2PollPcreGet
+
+> Object pgPollV2PollPcreGet(pcre)
+
+Pg Poll
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.SecureLinksApi();
+let pcre = "pcre_example"; // String | 
+apiInstance.pgPollV2PollPcreGet(pcre, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **pcre** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+