@polyguard/sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/sdk.js +11630 -0
- package/package.json +33 -0
- package/scripts/regenerate-client.sh +55 -0
- package/src/PolyguardClient.js +25 -0
- package/src/PolyguardWebsocketClientImpl.js +190 -0
- package/src/generated/.babelrc +33 -0
- package/src/generated/.openapi-generator/FILES +57 -0
- package/src/generated/.openapi-generator/VERSION +1 -0
- package/src/generated/.openapi-generator-ignore +23 -0
- package/src/generated/.travis.yml +5 -0
- package/src/generated/README.md +220 -0
- package/src/generated/docs/ApiControllersPslStirCallRequest.md +18 -0
- package/src/generated/docs/ApiModelsApiCallModelsCallRequest.md +12 -0
- package/src/generated/docs/AppleApi.md +88 -0
- package/src/generated/docs/AuthApi.md +1464 -0
- package/src/generated/docs/BlockingApi.md +208 -0
- package/src/generated/docs/CallsApi.md +140 -0
- package/src/generated/docs/Certainty.md +8 -0
- package/src/generated/docs/CreateLinkRequest.md +12 -0
- package/src/generated/docs/DefaultApi.md +88 -0
- package/src/generated/docs/HTTPValidationError.md +9 -0
- package/src/generated/docs/InviteRequestModel.md +10 -0
- package/src/generated/docs/JWTRequest.md +11 -0
- package/src/generated/docs/NumberVerification.md +10 -0
- package/src/generated/docs/StartAttestationRequest.md +9 -0
- package/src/generated/docs/StartMeetingRequest.md +9 -0
- package/src/generated/docs/StirApi.md +52 -0
- package/src/generated/docs/TwilioApi.md +138 -0
- package/src/generated/docs/UsersApi.md +362 -0
- package/src/generated/docs/ValidationError.md +11 -0
- package/src/generated/docs/ValidationErrorLocInner.md +8 -0
- package/src/generated/docs/VeriffApi.md +188 -0
- package/src/generated/docs/VeriffSessionRequest.md +10 -0
- package/src/generated/docs/VerifyRequest.md +10 -0
- package/src/generated/docs/ZoomApi.md +744 -0
- package/src/generated/git_push.sh +57 -0
- package/src/generated/mocha.opts +1 -0
- package/src/generated/package.json +46 -0
- package/src/generated/src/ApiClient.js +693 -0
- package/src/generated/src/api/AppleApi.js +109 -0
- package/src/generated/src/api/AuthApi.js +1512 -0
- package/src/generated/src/api/BlockingApi.js +217 -0
- package/src/generated/src/api/CallsApi.js +164 -0
- package/src/generated/src/api/DefaultApi.js +109 -0
- package/src/generated/src/api/StirApi.js +80 -0
- package/src/generated/src/api/TwilioApi.js +158 -0
- package/src/generated/src/api/UsersApi.js +375 -0
- package/src/generated/src/api/VeriffApi.js +209 -0
- package/src/generated/src/api/ZoomApi.js +715 -0
- package/src/generated/src/index.js +223 -0
- package/src/generated/src/model/ApiControllersPslStirCallRequest.js +211 -0
- package/src/generated/src/model/ApiModelsApiCallModelsCallRequest.js +119 -0
- package/src/generated/src/model/CreateLinkRequest.js +131 -0
- package/src/generated/src/model/HTTPValidationError.js +94 -0
- package/src/generated/src/model/InviteRequestModel.js +109 -0
- package/src/generated/src/model/JWTRequest.js +113 -0
- package/src/generated/src/model/NumberVerification.js +107 -0
- package/src/generated/src/model/StartAttestationRequest.js +95 -0
- package/src/generated/src/model/StartMeetingRequest.js +95 -0
- package/src/generated/src/model/ValidationError.js +130 -0
- package/src/generated/src/model/VeriffSessionRequest.js +107 -0
- package/src/generated/src/model/VerifyRequest.js +109 -0
- package/src/generated/test/api/AppleApi.spec.js +73 -0
- package/src/generated/test/api/AuthApi.spec.js +353 -0
- package/src/generated/test/api/BlockingApi.spec.js +103 -0
- package/src/generated/test/api/CallsApi.spec.js +83 -0
- package/src/generated/test/api/DefaultApi.spec.js +73 -0
- package/src/generated/test/api/StirApi.spec.js +63 -0
- package/src/generated/test/api/TwilioApi.spec.js +83 -0
- package/src/generated/test/api/UsersApi.spec.js +133 -0
- package/src/generated/test/api/VeriffApi.spec.js +93 -0
- package/src/generated/test/api/ZoomApi.spec.js +213 -0
- package/src/generated/test/model/ApiControllersPslStirCallRequest.spec.js +119 -0
- package/src/generated/test/model/ApiModelsApiCallModelsCallRequest.spec.js +83 -0
- package/src/generated/test/model/Certainty.spec.js +59 -0
- package/src/generated/test/model/CreateLinkRequest.spec.js +83 -0
- package/src/generated/test/model/HTTPValidationError.spec.js +65 -0
- package/src/generated/test/model/InviteRequestModel.spec.js +71 -0
- package/src/generated/test/model/JWTRequest.spec.js +77 -0
- package/src/generated/test/model/NumberVerification.spec.js +71 -0
- package/src/generated/test/model/StartAttestationRequest.spec.js +65 -0
- package/src/generated/test/model/StartMeetingRequest.spec.js +65 -0
- package/src/generated/test/model/ValidationError.spec.js +77 -0
- package/src/generated/test/model/ValidationErrorLocInner.spec.js +59 -0
- package/src/generated/test/model/VeriffSessionRequest.spec.js +71 -0
- package/src/generated/test/model/VerifyRequest.spec.js +71 -0
- package/src/index.js +20 -0
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
# FastApi.BlockingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**ftcDeleteBlockingFtcDelete**](BlockingApi.md#ftcDeleteBlockingFtcDelete) | **DELETE** /blocking/ftc | Ftc Delete
|
|
8
|
+
[**ftcPullBlockingFtcpullPost**](BlockingApi.md#ftcPullBlockingFtcpullPost) | **POST** /blocking/ftcpull | Ftc Pull
|
|
9
|
+
[**fullReportBlockingFullreportGet**](BlockingApi.md#fullReportBlockingFullreportGet) | **GET** /blocking/fullreport | Full Report
|
|
10
|
+
[**fullReportBlockingFullreportPost**](BlockingApi.md#fullReportBlockingFullreportPost) | **POST** /blocking/fullreport | Full Report
|
|
11
|
+
[**fullReportHeadBlockingFullreportHead**](BlockingApi.md#fullReportHeadBlockingFullreportHead) | **HEAD** /blocking/fullreport | Full Report Head
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## ftcDeleteBlockingFtcDelete
|
|
16
|
+
|
|
17
|
+
> Object ftcDeleteBlockingFtcDelete()
|
|
18
|
+
|
|
19
|
+
Ftc Delete
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```javascript
|
|
24
|
+
import FastApi from 'fast_api';
|
|
25
|
+
|
|
26
|
+
let apiInstance = new FastApi.BlockingApi();
|
|
27
|
+
apiInstance.ftcDeleteBlockingFtcDelete((error, data, response) => {
|
|
28
|
+
if (error) {
|
|
29
|
+
console.error(error);
|
|
30
|
+
} else {
|
|
31
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
32
|
+
}
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
This endpoint does not need any parameter.
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**Object**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: Not defined
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## ftcPullBlockingFtcpullPost
|
|
55
|
+
|
|
56
|
+
> Object ftcPullBlockingFtcpullPost()
|
|
57
|
+
|
|
58
|
+
Ftc Pull
|
|
59
|
+
|
|
60
|
+
### Example
|
|
61
|
+
|
|
62
|
+
```javascript
|
|
63
|
+
import FastApi from 'fast_api';
|
|
64
|
+
|
|
65
|
+
let apiInstance = new FastApi.BlockingApi();
|
|
66
|
+
apiInstance.ftcPullBlockingFtcpullPost((error, data, response) => {
|
|
67
|
+
if (error) {
|
|
68
|
+
console.error(error);
|
|
69
|
+
} else {
|
|
70
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Parameters
|
|
76
|
+
|
|
77
|
+
This endpoint does not need any parameter.
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
**Object**
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
No authorization required
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: Not defined
|
|
90
|
+
- **Accept**: application/json
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
## fullReportBlockingFullreportGet
|
|
94
|
+
|
|
95
|
+
> Object fullReportBlockingFullreportGet()
|
|
96
|
+
|
|
97
|
+
Full Report
|
|
98
|
+
|
|
99
|
+
### Example
|
|
100
|
+
|
|
101
|
+
```javascript
|
|
102
|
+
import FastApi from 'fast_api';
|
|
103
|
+
|
|
104
|
+
let apiInstance = new FastApi.BlockingApi();
|
|
105
|
+
apiInstance.fullReportBlockingFullreportGet((error, data, response) => {
|
|
106
|
+
if (error) {
|
|
107
|
+
console.error(error);
|
|
108
|
+
} else {
|
|
109
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Parameters
|
|
115
|
+
|
|
116
|
+
This endpoint does not need any parameter.
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
**Object**
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
No authorization required
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
## fullReportBlockingFullreportPost
|
|
133
|
+
|
|
134
|
+
> Object fullReportBlockingFullreportPost()
|
|
135
|
+
|
|
136
|
+
Full Report
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
|
|
140
|
+
```javascript
|
|
141
|
+
import FastApi from 'fast_api';
|
|
142
|
+
|
|
143
|
+
let apiInstance = new FastApi.BlockingApi();
|
|
144
|
+
apiInstance.fullReportBlockingFullreportPost((error, data, response) => {
|
|
145
|
+
if (error) {
|
|
146
|
+
console.error(error);
|
|
147
|
+
} else {
|
|
148
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
149
|
+
}
|
|
150
|
+
});
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
This endpoint does not need any parameter.
|
|
156
|
+
|
|
157
|
+
### Return type
|
|
158
|
+
|
|
159
|
+
**Object**
|
|
160
|
+
|
|
161
|
+
### Authorization
|
|
162
|
+
|
|
163
|
+
No authorization required
|
|
164
|
+
|
|
165
|
+
### HTTP request headers
|
|
166
|
+
|
|
167
|
+
- **Content-Type**: Not defined
|
|
168
|
+
- **Accept**: application/json
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
## fullReportHeadBlockingFullreportHead
|
|
172
|
+
|
|
173
|
+
> Object fullReportHeadBlockingFullreportHead()
|
|
174
|
+
|
|
175
|
+
Full Report Head
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
|
|
179
|
+
```javascript
|
|
180
|
+
import FastApi from 'fast_api';
|
|
181
|
+
|
|
182
|
+
let apiInstance = new FastApi.BlockingApi();
|
|
183
|
+
apiInstance.fullReportHeadBlockingFullreportHead((error, data, response) => {
|
|
184
|
+
if (error) {
|
|
185
|
+
console.error(error);
|
|
186
|
+
} else {
|
|
187
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
188
|
+
}
|
|
189
|
+
});
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Parameters
|
|
193
|
+
|
|
194
|
+
This endpoint does not need any parameter.
|
|
195
|
+
|
|
196
|
+
### Return type
|
|
197
|
+
|
|
198
|
+
**Object**
|
|
199
|
+
|
|
200
|
+
### Authorization
|
|
201
|
+
|
|
202
|
+
No authorization required
|
|
203
|
+
|
|
204
|
+
### HTTP request headers
|
|
205
|
+
|
|
206
|
+
- **Content-Type**: Not defined
|
|
207
|
+
- **Accept**: application/json
|
|
208
|
+
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# FastApi.CallsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**cancelCallCancelCallCallIdPost**](CallsApi.md#cancelCallCancelCallCallIdPost) | **POST** /cancel_call/{call_id} | Cancel Call
|
|
8
|
+
[**joinCallJoinCallCallIdPost**](CallsApi.md#joinCallJoinCallCallIdPost) | **POST** /join_call/{call_id} | Join Call
|
|
9
|
+
[**startCallStartCallPost**](CallsApi.md#startCallStartCallPost) | **POST** /start_call/ | Start Call
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## cancelCallCancelCallCallIdPost
|
|
14
|
+
|
|
15
|
+
> Object cancelCallCancelCallCallIdPost(callId)
|
|
16
|
+
|
|
17
|
+
Cancel Call
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```javascript
|
|
22
|
+
import FastApi from 'fast_api';
|
|
23
|
+
|
|
24
|
+
let apiInstance = new FastApi.CallsApi();
|
|
25
|
+
let callId = "callId_example"; // String |
|
|
26
|
+
apiInstance.cancelCallCancelCallCallIdPost(callId, (error, data, response) => {
|
|
27
|
+
if (error) {
|
|
28
|
+
console.error(error);
|
|
29
|
+
} else {
|
|
30
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
Name | Type | Description | Notes
|
|
39
|
+
------------- | ------------- | ------------- | -------------
|
|
40
|
+
**callId** | **String**| |
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**Object**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
No authorization required
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: Not defined
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## joinCallJoinCallCallIdPost
|
|
57
|
+
|
|
58
|
+
> Object joinCallJoinCallCallIdPost(callId)
|
|
59
|
+
|
|
60
|
+
Join Call
|
|
61
|
+
|
|
62
|
+
### Example
|
|
63
|
+
|
|
64
|
+
```javascript
|
|
65
|
+
import FastApi from 'fast_api';
|
|
66
|
+
|
|
67
|
+
let apiInstance = new FastApi.CallsApi();
|
|
68
|
+
let callId = "callId_example"; // String |
|
|
69
|
+
apiInstance.joinCallJoinCallCallIdPost(callId, (error, data, response) => {
|
|
70
|
+
if (error) {
|
|
71
|
+
console.error(error);
|
|
72
|
+
} else {
|
|
73
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
Name | Type | Description | Notes
|
|
82
|
+
------------- | ------------- | ------------- | -------------
|
|
83
|
+
**callId** | **String**| |
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
**Object**
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
No authorization required
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: Not defined
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## startCallStartCallPost
|
|
100
|
+
|
|
101
|
+
> Object startCallStartCallPost(apiModelsApiCallModelsCallRequest)
|
|
102
|
+
|
|
103
|
+
Start Call
|
|
104
|
+
|
|
105
|
+
### Example
|
|
106
|
+
|
|
107
|
+
```javascript
|
|
108
|
+
import FastApi from 'fast_api';
|
|
109
|
+
|
|
110
|
+
let apiInstance = new FastApi.CallsApi();
|
|
111
|
+
let apiModelsApiCallModelsCallRequest = new FastApi.ApiModelsApiCallModelsCallRequest(); // ApiModelsApiCallModelsCallRequest |
|
|
112
|
+
apiInstance.startCallStartCallPost(apiModelsApiCallModelsCallRequest, (error, data, response) => {
|
|
113
|
+
if (error) {
|
|
114
|
+
console.error(error);
|
|
115
|
+
} else {
|
|
116
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
117
|
+
}
|
|
118
|
+
});
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
Name | Type | Description | Notes
|
|
125
|
+
------------- | ------------- | ------------- | -------------
|
|
126
|
+
**apiModelsApiCallModelsCallRequest** | [**ApiModelsApiCallModelsCallRequest**](ApiModelsApiCallModelsCallRequest.md)| |
|
|
127
|
+
|
|
128
|
+
### Return type
|
|
129
|
+
|
|
130
|
+
**Object**
|
|
131
|
+
|
|
132
|
+
### Authorization
|
|
133
|
+
|
|
134
|
+
No authorization required
|
|
135
|
+
|
|
136
|
+
### HTTP request headers
|
|
137
|
+
|
|
138
|
+
- **Content-Type**: application/json
|
|
139
|
+
- **Accept**: application/json
|
|
140
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# FastApi.CreateLinkRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**accountId** | **String** | |
|
|
8
|
+
**title** | **String** | | [optional] [default to 'Secure Meeting']
|
|
9
|
+
**requiredProofs** | **[String]** | | [optional]
|
|
10
|
+
**e2ee** | **Boolean** | | [optional] [default to false]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# FastApi.DefaultApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**rootGet**](DefaultApi.md#rootGet) | **GET** / | Root
|
|
8
|
+
[**rootHealthGet**](DefaultApi.md#rootHealthGet) | **GET** /health | Root
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## rootGet
|
|
13
|
+
|
|
14
|
+
> Object rootGet()
|
|
15
|
+
|
|
16
|
+
Root
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```javascript
|
|
21
|
+
import FastApi from 'fast_api';
|
|
22
|
+
|
|
23
|
+
let apiInstance = new FastApi.DefaultApi();
|
|
24
|
+
apiInstance.rootGet((error, data, response) => {
|
|
25
|
+
if (error) {
|
|
26
|
+
console.error(error);
|
|
27
|
+
} else {
|
|
28
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
29
|
+
}
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
This endpoint does not need any parameter.
|
|
36
|
+
|
|
37
|
+
### Return type
|
|
38
|
+
|
|
39
|
+
**Object**
|
|
40
|
+
|
|
41
|
+
### Authorization
|
|
42
|
+
|
|
43
|
+
No authorization required
|
|
44
|
+
|
|
45
|
+
### HTTP request headers
|
|
46
|
+
|
|
47
|
+
- **Content-Type**: Not defined
|
|
48
|
+
- **Accept**: application/json
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
## rootHealthGet
|
|
52
|
+
|
|
53
|
+
> Object rootHealthGet()
|
|
54
|
+
|
|
55
|
+
Root
|
|
56
|
+
|
|
57
|
+
### Example
|
|
58
|
+
|
|
59
|
+
```javascript
|
|
60
|
+
import FastApi from 'fast_api';
|
|
61
|
+
|
|
62
|
+
let apiInstance = new FastApi.DefaultApi();
|
|
63
|
+
apiInstance.rootHealthGet((error, data, response) => {
|
|
64
|
+
if (error) {
|
|
65
|
+
console.error(error);
|
|
66
|
+
} else {
|
|
67
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
68
|
+
}
|
|
69
|
+
});
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Parameters
|
|
73
|
+
|
|
74
|
+
This endpoint does not need any parameter.
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
**Object**
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
No authorization required
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: Not defined
|
|
87
|
+
- **Accept**: application/json
|
|
88
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# FastApi.JWTRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**meetingNumber** | **String** | |
|
|
8
|
+
**role** | **Number** | |
|
|
9
|
+
**expirationSeconds** | **Number** | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# FastApi.StirApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**callInitiationStirCallInitiationPost**](StirApi.md#callInitiationStirCallInitiationPost) | **POST** /stir/call_initiation | Call Initiation
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## callInitiationStirCallInitiationPost
|
|
12
|
+
|
|
13
|
+
> Object callInitiationStirCallInitiationPost(apiControllersPslStirCallRequest)
|
|
14
|
+
|
|
15
|
+
Call Initiation
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```javascript
|
|
20
|
+
import FastApi from 'fast_api';
|
|
21
|
+
|
|
22
|
+
let apiInstance = new FastApi.StirApi();
|
|
23
|
+
let apiControllersPslStirCallRequest = new FastApi.ApiControllersPslStirCallRequest(); // ApiControllersPslStirCallRequest |
|
|
24
|
+
apiInstance.callInitiationStirCallInitiationPost(apiControllersPslStirCallRequest, (error, data, response) => {
|
|
25
|
+
if (error) {
|
|
26
|
+
console.error(error);
|
|
27
|
+
} else {
|
|
28
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
29
|
+
}
|
|
30
|
+
});
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Parameters
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
Name | Type | Description | Notes
|
|
37
|
+
------------- | ------------- | ------------- | -------------
|
|
38
|
+
**apiControllersPslStirCallRequest** | [**ApiControllersPslStirCallRequest**](ApiControllersPslStirCallRequest.md)| |
|
|
39
|
+
|
|
40
|
+
### Return type
|
|
41
|
+
|
|
42
|
+
**Object**
|
|
43
|
+
|
|
44
|
+
### Authorization
|
|
45
|
+
|
|
46
|
+
No authorization required
|
|
47
|
+
|
|
48
|
+
### HTTP request headers
|
|
49
|
+
|
|
50
|
+
- **Content-Type**: application/json
|
|
51
|
+
- **Accept**: application/json
|
|
52
|
+
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# FastApi.TwilioApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**twilioCheckTwilioCheckPost**](TwilioApi.md#twilioCheckTwilioCheckPost) | **POST** /twilio/check | Twilio Check
|
|
8
|
+
[**twilioStartTwilioStartPost**](TwilioApi.md#twilioStartTwilioStartPost) | **POST** /twilio/start | Twilio Start
|
|
9
|
+
[**twilioWebhookTwilioWebhookPost**](TwilioApi.md#twilioWebhookTwilioWebhookPost) | **POST** /twilio/webhook | Twilio Webhook
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## twilioCheckTwilioCheckPost
|
|
14
|
+
|
|
15
|
+
> Object twilioCheckTwilioCheckPost(numberVerification)
|
|
16
|
+
|
|
17
|
+
Twilio Check
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```javascript
|
|
22
|
+
import FastApi from 'fast_api';
|
|
23
|
+
|
|
24
|
+
let apiInstance = new FastApi.TwilioApi();
|
|
25
|
+
let numberVerification = new FastApi.NumberVerification(); // NumberVerification |
|
|
26
|
+
apiInstance.twilioCheckTwilioCheckPost(numberVerification, (error, data, response) => {
|
|
27
|
+
if (error) {
|
|
28
|
+
console.error(error);
|
|
29
|
+
} else {
|
|
30
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
Name | Type | Description | Notes
|
|
39
|
+
------------- | ------------- | ------------- | -------------
|
|
40
|
+
**numberVerification** | [**NumberVerification**](NumberVerification.md)| |
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**Object**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
No authorization required
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: application/json
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
## twilioStartTwilioStartPost
|
|
57
|
+
|
|
58
|
+
> Object twilioStartTwilioStartPost(numberVerification)
|
|
59
|
+
|
|
60
|
+
Twilio Start
|
|
61
|
+
|
|
62
|
+
### Example
|
|
63
|
+
|
|
64
|
+
```javascript
|
|
65
|
+
import FastApi from 'fast_api';
|
|
66
|
+
|
|
67
|
+
let apiInstance = new FastApi.TwilioApi();
|
|
68
|
+
let numberVerification = new FastApi.NumberVerification(); // NumberVerification |
|
|
69
|
+
apiInstance.twilioStartTwilioStartPost(numberVerification, (error, data, response) => {
|
|
70
|
+
if (error) {
|
|
71
|
+
console.error(error);
|
|
72
|
+
} else {
|
|
73
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
74
|
+
}
|
|
75
|
+
});
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Parameters
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
Name | Type | Description | Notes
|
|
82
|
+
------------- | ------------- | ------------- | -------------
|
|
83
|
+
**numberVerification** | [**NumberVerification**](NumberVerification.md)| |
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
**Object**
|
|
88
|
+
|
|
89
|
+
### Authorization
|
|
90
|
+
|
|
91
|
+
No authorization required
|
|
92
|
+
|
|
93
|
+
### HTTP request headers
|
|
94
|
+
|
|
95
|
+
- **Content-Type**: application/json
|
|
96
|
+
- **Accept**: application/json
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## twilioWebhookTwilioWebhookPost
|
|
100
|
+
|
|
101
|
+
> Object twilioWebhookTwilioWebhookPost()
|
|
102
|
+
|
|
103
|
+
Twilio Webhook
|
|
104
|
+
|
|
105
|
+
Handle incoming webhook events from Twilio
|
|
106
|
+
|
|
107
|
+
### Example
|
|
108
|
+
|
|
109
|
+
```javascript
|
|
110
|
+
import FastApi from 'fast_api';
|
|
111
|
+
|
|
112
|
+
let apiInstance = new FastApi.TwilioApi();
|
|
113
|
+
apiInstance.twilioWebhookTwilioWebhookPost((error, data, response) => {
|
|
114
|
+
if (error) {
|
|
115
|
+
console.error(error);
|
|
116
|
+
} else {
|
|
117
|
+
console.log('API called successfully. Returned data: ' + data);
|
|
118
|
+
}
|
|
119
|
+
});
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
This endpoint does not need any parameter.
|
|
125
|
+
|
|
126
|
+
### Return type
|
|
127
|
+
|
|
128
|
+
**Object**
|
|
129
|
+
|
|
130
|
+
### Authorization
|
|
131
|
+
|
|
132
|
+
No authorization required
|
|
133
|
+
|
|
134
|
+
### HTTP request headers
|
|
135
|
+
|
|
136
|
+
- **Content-Type**: Not defined
|
|
137
|
+
- **Accept**: application/json
|
|
138
|
+
|