@polyguard/sdk 1.0.0

package/src/generated/docs/ZoomApi.md

@@ -0,0 +1,744 @@
+# FastApi.ZoomApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cookietestCookietestGet**](ZoomApi.md#cookietestCookietestGet) | **GET** /cookietest | Cookietest
+[**generateMeetingReportZoomPhoneReportsMeetingPost**](ZoomApi.md#generateMeetingReportZoomPhoneReportsMeetingPost) | **POST** /zoom-phone/reports/meeting | Generate Meeting Report
+[**getMeetingDetailsZoomPhoneLogsMeetingDetailsPost**](ZoomApi.md#getMeetingDetailsZoomPhoneLogsMeetingDetailsPost) | **POST** /zoom-phone/logs/meeting/details | Get Meeting Details
+[**getTicketZoomPhoneTicketAccountIdPost**](ZoomApi.md#getTicketZoomPhoneTicketAccountIdPost) | **POST** /zoom-phone/ticket/{account_id} | Get Ticket
+[**getUserLogsZoomPhoneLogsPolyUserIdGet**](ZoomApi.md#getUserLogsZoomPhoneLogsPolyUserIdGet) | **GET** /zoom-phone/logs/{poly_user_id} | Get User Logs
+[**meetingJwtMeetingjwtPost**](ZoomApi.md#meetingJwtMeetingjwtPost) | **POST** /meetingjwt | Meeting Jwt
+[**redirectToAppStoreZoomPhoneAppStoreGet**](ZoomApi.md#redirectToAppStoreZoomPhoneAppStoreGet) | **GET** /zoom-phone/app-store | Redirect To App Store
+[**redirectToMeetingReportZoomPhoneReportsMeetingEncodedS3UrlGet**](ZoomApi.md#redirectToMeetingReportZoomPhoneReportsMeetingEncodedS3UrlGet) | **GET** /zoom-phone/reports/meeting/{encoded_s3_url} | Redirect To Meeting Report
+[**testWebsocketDisconnectZoomPhoneTestDisconnectPost**](ZoomApi.md#testWebsocketDisconnectZoomPhoneTestDisconnectPost) | **POST** /zoom-phone/test-disconnect | Test Websocket Disconnect
+[**webhookWebhookPost**](ZoomApi.md#webhookWebhookPost) | **POST** /webhook | Webhook
+[**zoomCallbackZoomCallbackPost**](ZoomApi.md#zoomCallbackZoomCallbackPost) | **POST** /zoom_callback | Zoom Callback
+[**zoomInstallInstallGet**](ZoomApi.md#zoomInstallInstallGet) | **GET** /install | Zoom Install
+[**zoomInstallInstallPost**](ZoomApi.md#zoomInstallInstallPost) | **POST** /install | Zoom Install
+[**zoomPhoneInstallZoomPhoneInstallGet**](ZoomApi.md#zoomPhoneInstallZoomPhoneInstallGet) | **GET** /zoom-phone/install | Zoom Phone Install
+[**zoomPhoneInstallZoomPhoneInstallPost**](ZoomApi.md#zoomPhoneInstallZoomPhoneInstallPost) | **POST** /zoom-phone/install | Zoom Phone Install
+[**zoomWebhookZoomPhoneWebhookPost**](ZoomApi.md#zoomWebhookZoomPhoneWebhookPost) | **POST** /zoom-phone/webhook | Zoom Webhook
+
+
+
+## cookietestCookietestGet
+
+> Object cookietestCookietestGet()
+
+Cookietest
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+apiInstance.cookietestCookietestGet((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
+
+
+## generateMeetingReportZoomPhoneReportsMeetingPost
+
+> Object generateMeetingReportZoomPhoneReportsMeetingPost()
+
+Generate Meeting Report
+
+Generate a PDF report for a meeting by collecting event data from S3.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+apiInstance.generateMeetingReportZoomPhoneReportsMeetingPost((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
+
+
+## getMeetingDetailsZoomPhoneLogsMeetingDetailsPost
+
+> Object getMeetingDetailsZoomPhoneLogsMeetingDetailsPost()
+
+Get Meeting Details
+
+Get detailed information about a specific meeting including participants and other metadata.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+apiInstance.getMeetingDetailsZoomPhoneLogsMeetingDetailsPost((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
+
+
+## getTicketZoomPhoneTicketAccountIdPost
+
+> Object getTicketZoomPhoneTicketAccountIdPost(accountId, opts)
+
+Get Ticket
+
+Get a ticket for the given account ID and uid for webhook startup.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let accountId = "accountId_example"; // String | 
+let opts = {
+  'clientSecret': "'ghFlPlwVN11IQuTIEj4nlB1i67iQQel9'", // String | 
+  'clientId': "'7c19WxdRTkyf9w0EDbbfbg'" // String | 
+};
+apiInstance.getTicketZoomPhoneTicketAccountIdPost(accountId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accountId** | **String**|  | 
+ **clientSecret** | **String**|  | [optional] [default to 'ghFlPlwVN11IQuTIEj4nlB1i67iQQel9']
+ **clientId** | **String**|  | [optional] [default to '7c19WxdRTkyf9w0EDbbfbg']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## getUserLogsZoomPhoneLogsPolyUserIdGet
+
+> Object getUserLogsZoomPhoneLogsPolyUserIdGet(polyUserId, opts)
+
+Get User Logs
+
+Get meeting and call logs for a specific user with pagination.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let polyUserId = "polyUserId_example"; // String | Polyguard user ID
+let opts = {
+  'page': 1, // Number | Page number, starting from 1
+  'pageSize': 10 // Number | Number of records per page
+};
+apiInstance.getUserLogsZoomPhoneLogsPolyUserIdGet(polyUserId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **polyUserId** | **String**| Polyguard user ID | 
+ **page** | **Number**| Page number, starting from 1 | [optional] [default to 1]
+ **pageSize** | **Number**| Number of records per page | [optional] [default to 10]
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## meetingJwtMeetingjwtPost
+
+> Object meetingJwtMeetingjwtPost(jWTRequest)
+
+Meeting Jwt
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let jWTRequest = new FastApi.JWTRequest(); // JWTRequest | 
+apiInstance.meetingJwtMeetingjwtPost(jWTRequest, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **jWTRequest** | [**JWTRequest**](JWTRequest.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## redirectToAppStoreZoomPhoneAppStoreGet
+
+> Object redirectToAppStoreZoomPhoneAppStoreGet()
+
+Redirect To App Store
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+apiInstance.redirectToAppStoreZoomPhoneAppStoreGet((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
+
+
+## redirectToMeetingReportZoomPhoneReportsMeetingEncodedS3UrlGet
+
+> Object redirectToMeetingReportZoomPhoneReportsMeetingEncodedS3UrlGet(encodedS3Url)
+
+Redirect To Meeting Report
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let encodedS3Url = "encodedS3Url_example"; // String | 
+apiInstance.redirectToMeetingReportZoomPhoneReportsMeetingEncodedS3UrlGet(encodedS3Url, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **encodedS3Url** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## testWebsocketDisconnectZoomPhoneTestDisconnectPost
+
+> Object testWebsocketDisconnectZoomPhoneTestDisconnectPost()
+
+Test Websocket Disconnect
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+apiInstance.testWebsocketDisconnectZoomPhoneTestDisconnectPost((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
+
+
+## webhookWebhookPost
+
+> Object webhookWebhookPost(xZmSignature, xZmRequestTimestamp)
+
+Webhook
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let xZmSignature = "xZmSignature_example"; // String | 
+let xZmRequestTimestamp = "xZmRequestTimestamp_example"; // String | 
+apiInstance.webhookWebhookPost(xZmSignature, xZmRequestTimestamp, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **xZmSignature** | **String**|  | 
+ **xZmRequestTimestamp** | **String**|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomCallbackZoomCallbackPost
+
+> Object zoomCallbackZoomCallbackPost(error, code)
+
+Zoom Callback
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let error = null; // Object | 
+let code = null; // Object | 
+apiInstance.zoomCallbackZoomCallbackPost(error, code, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **error** | [**Object**](.md)|  | 
+ **code** | [**Object**](.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomInstallInstallGet
+
+> Object zoomInstallInstallGet(opts)
+
+Zoom Install
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let opts = {
+  'code': null, // Object | 
+  'error': null // Object | 
+};
+apiInstance.zoomInstallInstallGet(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | [**Object**](.md)|  | [optional] 
+ **error** | [**Object**](.md)|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomInstallInstallPost
+
+> Object zoomInstallInstallPost(opts)
+
+Zoom Install
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let opts = {
+  'code': null, // Object | 
+  'error': null // Object | 
+};
+apiInstance.zoomInstallInstallPost(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | [**Object**](.md)|  | [optional] 
+ **error** | [**Object**](.md)|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomPhoneInstallZoomPhoneInstallGet
+
+> Object zoomPhoneInstallZoomPhoneInstallGet(opts)
+
+Zoom Phone Install
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let opts = {
+  'code': null, // Object | 
+  'state': null, // Object | 
+  'error': null, // Object | 
+  'redirectUri': "''" // String | 
+};
+apiInstance.zoomPhoneInstallZoomPhoneInstallGet(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | [**Object**](.md)|  | [optional] 
+ **state** | [**Object**](.md)|  | [optional] 
+ **error** | [**Object**](.md)|  | [optional] 
+ **redirectUri** | **String**|  | [optional] [default to '']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomPhoneInstallZoomPhoneInstallPost
+
+> Object zoomPhoneInstallZoomPhoneInstallPost(opts)
+
+Zoom Phone Install
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let opts = {
+  'code': null, // Object | 
+  'state': null, // Object | 
+  'error': null, // Object | 
+  'redirectUri': "''" // String | 
+};
+apiInstance.zoomPhoneInstallZoomPhoneInstallPost(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | [**Object**](.md)|  | [optional] 
+ **state** | [**Object**](.md)|  | [optional] 
+ **error** | [**Object**](.md)|  | [optional] 
+ **redirectUri** | **String**|  | [optional] [default to '']
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## zoomWebhookZoomPhoneWebhookPost
+
+> Object zoomWebhookZoomPhoneWebhookPost(opts)
+
+Zoom Webhook
+
+Handle incoming webhooks from Zoom Phone.
+
+### Example
+
+```javascript
+import FastApi from 'fast_api';
+
+let apiInstance = new FastApi.ZoomApi();
+let opts = {
+  'dependencies': null // Object | 
+};
+apiInstance.zoomWebhookZoomPhoneWebhookPost(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dependencies** | [**Object**](.md)|  | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+