yellowgrid-api-ts 3.2.251-dev.0 → 3.2.252-dev.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/.openapi-generator/FILES +5 -0
- package/README.md +14 -0
- package/api.ts +882 -137
- package/dist/api.d.ts +516 -117
- package/dist/api.js +784 -47
- package/docs/Class3CXInstallationWizardApi.md +384 -0
- package/docs/Class3CXIntegrationsApi.md +52 -0
- package/docs/EngineeredWizardRequestModel.md +23 -0
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +59 -0
- package/docs/SearchSchoolModel.md +35 -0
- package/docs/TcxEngineerTaskDTO.md +29 -0
- package/docs/TcxEngineeringDTO.md +37 -0
- package/docs/TcxExtsEntity.md +8 -8
- package/docs/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSetupEntity.md +25 -25
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxSummaryDTO.md +21 -0
- package/docs/TcxWizardModel.md +11 -9
- package/package.json +1 -1
|
@@ -16,6 +16,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
16
16
|
|[**getGetHostingRegions**](#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions|
|
|
17
17
|
|[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
|
|
18
18
|
|[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
|
|
19
|
+
|[**getGetOrderItems**](#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\'s licence key|
|
|
19
20
|
|[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
|
|
20
21
|
|[**getGetSipTrunkTcxWizard**](#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk|
|
|
21
22
|
|[**getGetSipTrunksTcxWizard**](#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks|
|
|
@@ -24,7 +25,13 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
24
25
|
|[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
|
|
25
26
|
|[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
|
|
26
27
|
|[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
|
|
28
|
+
|[**patchAllocateEngineer**](#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer | |
|
|
27
29
|
|[**patchGetWizard**](#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard|
|
|
30
|
+
|[**patchMarkEngineerTaskAsComplete**](#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete | |
|
|
31
|
+
|[**patchUpdateEngineerTaskNote**](#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note | |
|
|
32
|
+
|[**patchUpdateGoLiveDate**](#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date | |
|
|
33
|
+
|[**patchUpdateNote**](#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note | |
|
|
34
|
+
|[**patchUpdateSpec**](#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec | |
|
|
28
35
|
|[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
|
|
29
36
|
|[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
|
|
30
37
|
|[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
|
|
@@ -654,6 +661,53 @@ No authorization required
|
|
|
654
661
|
|
|
655
662
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
656
663
|
|
|
664
|
+
# **getGetOrderItems**
|
|
665
|
+
> Array<ItemEntity> getGetOrderItems()
|
|
666
|
+
|
|
667
|
+
Get all items on the order linked to the wizard licence key
|
|
668
|
+
|
|
669
|
+
### Example
|
|
670
|
+
|
|
671
|
+
```typescript
|
|
672
|
+
import {
|
|
673
|
+
Class3CXInstallationWizardApi,
|
|
674
|
+
Configuration
|
|
675
|
+
} from 'yellowgrid-api-ts';
|
|
676
|
+
|
|
677
|
+
const configuration = new Configuration();
|
|
678
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
679
|
+
|
|
680
|
+
const { status, data } = await apiInstance.getGetOrderItems();
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
### Parameters
|
|
684
|
+
This endpoint does not have any parameters.
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
### Return type
|
|
688
|
+
|
|
689
|
+
**Array<ItemEntity>**
|
|
690
|
+
|
|
691
|
+
### Authorization
|
|
692
|
+
|
|
693
|
+
No authorization required
|
|
694
|
+
|
|
695
|
+
### HTTP request headers
|
|
696
|
+
|
|
697
|
+
- **Content-Type**: Not defined
|
|
698
|
+
- **Accept**: application/json
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
### HTTP response details
|
|
702
|
+
| Status code | Description | Response headers |
|
|
703
|
+
|-------------|-------------|------------------|
|
|
704
|
+
|**200** | Order Items | - |
|
|
705
|
+
|**400** | Bad Request | - |
|
|
706
|
+
|**401** | Unauthorised | - |
|
|
707
|
+
|**403** | Access Denied | - |
|
|
708
|
+
|
|
709
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
710
|
+
|
|
657
711
|
# **getGetPbxIpAddress**
|
|
658
712
|
> string getGetPbxIpAddress()
|
|
659
713
|
|
|
@@ -1079,6 +1133,60 @@ No authorization required
|
|
|
1079
1133
|
|
|
1080
1134
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1081
1135
|
|
|
1136
|
+
# **patchAllocateEngineer**
|
|
1137
|
+
> patchAllocateEngineer()
|
|
1138
|
+
|
|
1139
|
+
Allocate Wizard Engineer
|
|
1140
|
+
|
|
1141
|
+
### Example
|
|
1142
|
+
|
|
1143
|
+
```typescript
|
|
1144
|
+
import {
|
|
1145
|
+
Class3CXInstallationWizardApi,
|
|
1146
|
+
Configuration
|
|
1147
|
+
} from 'yellowgrid-api-ts';
|
|
1148
|
+
|
|
1149
|
+
const configuration = new Configuration();
|
|
1150
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1151
|
+
|
|
1152
|
+
let engineerId: number; //Engineer ID (default to undefined)
|
|
1153
|
+
|
|
1154
|
+
const { status, data } = await apiInstance.patchAllocateEngineer(
|
|
1155
|
+
engineerId
|
|
1156
|
+
);
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
### Parameters
|
|
1160
|
+
|
|
1161
|
+
|Name | Type | Description | Notes|
|
|
1162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1163
|
+
| **engineerId** | [**number**] | Engineer ID | defaults to undefined|
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
### Return type
|
|
1167
|
+
|
|
1168
|
+
void (empty response body)
|
|
1169
|
+
|
|
1170
|
+
### Authorization
|
|
1171
|
+
|
|
1172
|
+
No authorization required
|
|
1173
|
+
|
|
1174
|
+
### HTTP request headers
|
|
1175
|
+
|
|
1176
|
+
- **Content-Type**: Not defined
|
|
1177
|
+
- **Accept**: Not defined
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
### HTTP response details
|
|
1181
|
+
| Status code | Description | Response headers |
|
|
1182
|
+
|-------------|-------------|------------------|
|
|
1183
|
+
|**204** | No Response | - |
|
|
1184
|
+
|**400** | Bad Request | - |
|
|
1185
|
+
|**401** | Unauthorised | - |
|
|
1186
|
+
|**403** | Access Denied | - |
|
|
1187
|
+
|
|
1188
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1189
|
+
|
|
1082
1190
|
# **patchGetWizard**
|
|
1083
1191
|
> TcxWizardModel patchGetWizard()
|
|
1084
1192
|
|
|
@@ -1134,6 +1242,282 @@ No authorization required
|
|
|
1134
1242
|
|
|
1135
1243
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1136
1244
|
|
|
1245
|
+
# **patchMarkEngineerTaskAsComplete**
|
|
1246
|
+
> patchMarkEngineerTaskAsComplete()
|
|
1247
|
+
|
|
1248
|
+
Update Wizard Engineer Task Complete Status
|
|
1249
|
+
|
|
1250
|
+
### Example
|
|
1251
|
+
|
|
1252
|
+
```typescript
|
|
1253
|
+
import {
|
|
1254
|
+
Class3CXInstallationWizardApi,
|
|
1255
|
+
Configuration
|
|
1256
|
+
} from 'yellowgrid-api-ts';
|
|
1257
|
+
|
|
1258
|
+
const configuration = new Configuration();
|
|
1259
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1260
|
+
|
|
1261
|
+
let taskId: number; //Task ID (default to undefined)
|
|
1262
|
+
let complete: 'true' | 'false'; //Complete Status (default to undefined)
|
|
1263
|
+
|
|
1264
|
+
const { status, data } = await apiInstance.patchMarkEngineerTaskAsComplete(
|
|
1265
|
+
taskId,
|
|
1266
|
+
complete
|
|
1267
|
+
);
|
|
1268
|
+
```
|
|
1269
|
+
|
|
1270
|
+
### Parameters
|
|
1271
|
+
|
|
1272
|
+
|Name | Type | Description | Notes|
|
|
1273
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1274
|
+
| **taskId** | [**number**] | Task ID | defaults to undefined|
|
|
1275
|
+
| **complete** | [**'true' | 'false'**]**Array<'true' | 'false'>** | Complete Status | defaults to undefined|
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
### Return type
|
|
1279
|
+
|
|
1280
|
+
void (empty response body)
|
|
1281
|
+
|
|
1282
|
+
### Authorization
|
|
1283
|
+
|
|
1284
|
+
No authorization required
|
|
1285
|
+
|
|
1286
|
+
### HTTP request headers
|
|
1287
|
+
|
|
1288
|
+
- **Content-Type**: Not defined
|
|
1289
|
+
- **Accept**: Not defined
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
### HTTP response details
|
|
1293
|
+
| Status code | Description | Response headers |
|
|
1294
|
+
|-------------|-------------|------------------|
|
|
1295
|
+
|**204** | No Response | - |
|
|
1296
|
+
|**400** | Bad Request | - |
|
|
1297
|
+
|**401** | Unauthorised | - |
|
|
1298
|
+
|**403** | Access Denied | - |
|
|
1299
|
+
|
|
1300
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1301
|
+
|
|
1302
|
+
# **patchUpdateEngineerTaskNote**
|
|
1303
|
+
> patchUpdateEngineerTaskNote()
|
|
1304
|
+
|
|
1305
|
+
Update Wizard Engineer Task Note
|
|
1306
|
+
|
|
1307
|
+
### Example
|
|
1308
|
+
|
|
1309
|
+
```typescript
|
|
1310
|
+
import {
|
|
1311
|
+
Class3CXInstallationWizardApi,
|
|
1312
|
+
Configuration
|
|
1313
|
+
} from 'yellowgrid-api-ts';
|
|
1314
|
+
|
|
1315
|
+
const configuration = new Configuration();
|
|
1316
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1317
|
+
|
|
1318
|
+
let taskId: number; //Task ID (default to undefined)
|
|
1319
|
+
let note: string; //note (default to undefined)
|
|
1320
|
+
|
|
1321
|
+
const { status, data } = await apiInstance.patchUpdateEngineerTaskNote(
|
|
1322
|
+
taskId,
|
|
1323
|
+
note
|
|
1324
|
+
);
|
|
1325
|
+
```
|
|
1326
|
+
|
|
1327
|
+
### Parameters
|
|
1328
|
+
|
|
1329
|
+
|Name | Type | Description | Notes|
|
|
1330
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1331
|
+
| **taskId** | [**number**] | Task ID | defaults to undefined|
|
|
1332
|
+
| **note** | [**string**] | note | defaults to undefined|
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
### Return type
|
|
1336
|
+
|
|
1337
|
+
void (empty response body)
|
|
1338
|
+
|
|
1339
|
+
### Authorization
|
|
1340
|
+
|
|
1341
|
+
No authorization required
|
|
1342
|
+
|
|
1343
|
+
### HTTP request headers
|
|
1344
|
+
|
|
1345
|
+
- **Content-Type**: Not defined
|
|
1346
|
+
- **Accept**: Not defined
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
### HTTP response details
|
|
1350
|
+
| Status code | Description | Response headers |
|
|
1351
|
+
|-------------|-------------|------------------|
|
|
1352
|
+
|**204** | No Response | - |
|
|
1353
|
+
|**400** | Bad Request | - |
|
|
1354
|
+
|**401** | Unauthorised | - |
|
|
1355
|
+
|**403** | Access Denied | - |
|
|
1356
|
+
|
|
1357
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1358
|
+
|
|
1359
|
+
# **patchUpdateGoLiveDate**
|
|
1360
|
+
> patchUpdateGoLiveDate()
|
|
1361
|
+
|
|
1362
|
+
Update Wizard Go Live Date
|
|
1363
|
+
|
|
1364
|
+
### Example
|
|
1365
|
+
|
|
1366
|
+
```typescript
|
|
1367
|
+
import {
|
|
1368
|
+
Class3CXInstallationWizardApi,
|
|
1369
|
+
Configuration
|
|
1370
|
+
} from 'yellowgrid-api-ts';
|
|
1371
|
+
|
|
1372
|
+
const configuration = new Configuration();
|
|
1373
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1374
|
+
|
|
1375
|
+
let goLiveDate: string; //Go Live Date (default to undefined)
|
|
1376
|
+
|
|
1377
|
+
const { status, data } = await apiInstance.patchUpdateGoLiveDate(
|
|
1378
|
+
goLiveDate
|
|
1379
|
+
);
|
|
1380
|
+
```
|
|
1381
|
+
|
|
1382
|
+
### Parameters
|
|
1383
|
+
|
|
1384
|
+
|Name | Type | Description | Notes|
|
|
1385
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1386
|
+
| **goLiveDate** | [**string**] | Go Live Date | defaults to undefined|
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
### Return type
|
|
1390
|
+
|
|
1391
|
+
void (empty response body)
|
|
1392
|
+
|
|
1393
|
+
### Authorization
|
|
1394
|
+
|
|
1395
|
+
No authorization required
|
|
1396
|
+
|
|
1397
|
+
### HTTP request headers
|
|
1398
|
+
|
|
1399
|
+
- **Content-Type**: Not defined
|
|
1400
|
+
- **Accept**: Not defined
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
### HTTP response details
|
|
1404
|
+
| Status code | Description | Response headers |
|
|
1405
|
+
|-------------|-------------|------------------|
|
|
1406
|
+
|**204** | No Response | - |
|
|
1407
|
+
|**400** | Bad Request | - |
|
|
1408
|
+
|**401** | Unauthorised | - |
|
|
1409
|
+
|**403** | Access Denied | - |
|
|
1410
|
+
|
|
1411
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1412
|
+
|
|
1413
|
+
# **patchUpdateNote**
|
|
1414
|
+
> patchUpdateNote()
|
|
1415
|
+
|
|
1416
|
+
Update Wizard Engineer Note
|
|
1417
|
+
|
|
1418
|
+
### Example
|
|
1419
|
+
|
|
1420
|
+
```typescript
|
|
1421
|
+
import {
|
|
1422
|
+
Class3CXInstallationWizardApi,
|
|
1423
|
+
Configuration
|
|
1424
|
+
} from 'yellowgrid-api-ts';
|
|
1425
|
+
|
|
1426
|
+
const configuration = new Configuration();
|
|
1427
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1428
|
+
|
|
1429
|
+
let note: string; //Note (default to undefined)
|
|
1430
|
+
|
|
1431
|
+
const { status, data } = await apiInstance.patchUpdateNote(
|
|
1432
|
+
note
|
|
1433
|
+
);
|
|
1434
|
+
```
|
|
1435
|
+
|
|
1436
|
+
### Parameters
|
|
1437
|
+
|
|
1438
|
+
|Name | Type | Description | Notes|
|
|
1439
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1440
|
+
| **note** | [**string**] | Note | defaults to undefined|
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
### Return type
|
|
1444
|
+
|
|
1445
|
+
void (empty response body)
|
|
1446
|
+
|
|
1447
|
+
### Authorization
|
|
1448
|
+
|
|
1449
|
+
No authorization required
|
|
1450
|
+
|
|
1451
|
+
### HTTP request headers
|
|
1452
|
+
|
|
1453
|
+
- **Content-Type**: Not defined
|
|
1454
|
+
- **Accept**: Not defined
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
### HTTP response details
|
|
1458
|
+
| Status code | Description | Response headers |
|
|
1459
|
+
|-------------|-------------|------------------|
|
|
1460
|
+
|**204** | No Response | - |
|
|
1461
|
+
|**400** | Bad Request | - |
|
|
1462
|
+
|**401** | Unauthorised | - |
|
|
1463
|
+
|**403** | Access Denied | - |
|
|
1464
|
+
|
|
1465
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1466
|
+
|
|
1467
|
+
# **patchUpdateSpec**
|
|
1468
|
+
> patchUpdateSpec()
|
|
1469
|
+
|
|
1470
|
+
Update Wizard Engineer Spec
|
|
1471
|
+
|
|
1472
|
+
### Example
|
|
1473
|
+
|
|
1474
|
+
```typescript
|
|
1475
|
+
import {
|
|
1476
|
+
Class3CXInstallationWizardApi,
|
|
1477
|
+
Configuration
|
|
1478
|
+
} from 'yellowgrid-api-ts';
|
|
1479
|
+
|
|
1480
|
+
const configuration = new Configuration();
|
|
1481
|
+
const apiInstance = new Class3CXInstallationWizardApi(configuration);
|
|
1482
|
+
|
|
1483
|
+
let spec: string; //Spec (default to undefined)
|
|
1484
|
+
|
|
1485
|
+
const { status, data } = await apiInstance.patchUpdateSpec(
|
|
1486
|
+
spec
|
|
1487
|
+
);
|
|
1488
|
+
```
|
|
1489
|
+
|
|
1490
|
+
### Parameters
|
|
1491
|
+
|
|
1492
|
+
|Name | Type | Description | Notes|
|
|
1493
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1494
|
+
| **spec** | [**string**] | Spec | defaults to undefined|
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
### Return type
|
|
1498
|
+
|
|
1499
|
+
void (empty response body)
|
|
1500
|
+
|
|
1501
|
+
### Authorization
|
|
1502
|
+
|
|
1503
|
+
No authorization required
|
|
1504
|
+
|
|
1505
|
+
### HTTP request headers
|
|
1506
|
+
|
|
1507
|
+
- **Content-Type**: Not defined
|
|
1508
|
+
- **Accept**: Not defined
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
### HTTP response details
|
|
1512
|
+
| Status code | Description | Response headers |
|
|
1513
|
+
|-------------|-------------|------------------|
|
|
1514
|
+
|**204** | No Response | - |
|
|
1515
|
+
|**400** | Bad Request | - |
|
|
1516
|
+
|**401** | Unauthorised | - |
|
|
1517
|
+
|**403** | Access Denied | - |
|
|
1518
|
+
|
|
1519
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1520
|
+
|
|
1137
1521
|
# **postAddExtensions**
|
|
1138
1522
|
> Array<TcxExtsEntity> postAddExtensions()
|
|
1139
1523
|
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
7
7
|
|[**getGetPrice**](#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | |
|
|
8
8
|
|[**getGetSchools**](#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | |
|
|
9
9
|
|[**getGetTrusts**](#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | |
|
|
10
|
+
|[**getSearchSchools**](#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | |
|
|
10
11
|
|[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
|
|
11
12
|
|[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
|
|
12
13
|
|[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
|
|
@@ -172,6 +173,57 @@ No authorization required
|
|
|
172
173
|
|
|
173
174
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
174
175
|
|
|
176
|
+
# **getSearchSchools**
|
|
177
|
+
> Array<SearchSchoolModel> getSearchSchools()
|
|
178
|
+
|
|
179
|
+
Seach EdTechPro Schools
|
|
180
|
+
|
|
181
|
+
### Example
|
|
182
|
+
|
|
183
|
+
```typescript
|
|
184
|
+
import {
|
|
185
|
+
Class3CXIntegrationsApi,
|
|
186
|
+
Configuration
|
|
187
|
+
} from 'yellowgrid-api-ts';
|
|
188
|
+
|
|
189
|
+
const configuration = new Configuration();
|
|
190
|
+
const apiInstance = new Class3CXIntegrationsApi(configuration);
|
|
191
|
+
|
|
192
|
+
let search: string; //School Name, Dfe code or URN (default to undefined)
|
|
193
|
+
|
|
194
|
+
const { status, data } = await apiInstance.getSearchSchools(
|
|
195
|
+
search
|
|
196
|
+
);
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Parameters
|
|
200
|
+
|
|
201
|
+
|Name | Type | Description | Notes|
|
|
202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
203
|
+
| **search** | [**string**] | School Name, Dfe code or URN | defaults to undefined|
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Return type
|
|
207
|
+
|
|
208
|
+
**Array<SearchSchoolModel>**
|
|
209
|
+
|
|
210
|
+
### Authorization
|
|
211
|
+
|
|
212
|
+
No authorization required
|
|
213
|
+
|
|
214
|
+
### HTTP request headers
|
|
215
|
+
|
|
216
|
+
- **Content-Type**: Not defined
|
|
217
|
+
- **Accept**: application/json
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
### HTTP response details
|
|
221
|
+
| Status code | Description | Response headers |
|
|
222
|
+
|-------------|-------------|------------------|
|
|
223
|
+
|**200** | EdTechPro Schools | - |
|
|
224
|
+
|
|
225
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
226
|
+
|
|
175
227
|
# **patchUpdateEtpOrderReference**
|
|
176
228
|
> patchUpdateEtpOrderReference()
|
|
177
229
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# EngineeredWizardRequestModel
|
|
2
|
+
|
|
3
|
+
Engineered Wizard Request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**customer** | **string** | Customer Name | [default to undefined]
|
|
10
|
+
**engineerId** | **number** | Engineer ID | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { EngineeredWizardRequestModel } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: EngineeredWizardRequestModel = {
|
|
18
|
+
customer,
|
|
19
|
+
engineerId,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OAuth20Api.md
CHANGED
|
@@ -164,7 +164,7 @@ const { status, data } = await apiInstance.postAccessToken(
|
|
|
164
164
|
| **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
|
|
165
165
|
| **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
|
|
166
166
|
| **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
167
|
-
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
167
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | 'tcx_wizard_admin' | 'portal'>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
168
168
|
| **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
169
169
|
| **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
|
|
170
170
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
22
22
|
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
23
23
|
|[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
|
|
24
24
|
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
25
|
+
|[**postCreateWizardFromOrder**](#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard | |
|
|
25
26
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
26
27
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
27
28
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
@@ -1071,6 +1072,64 @@ No authorization required
|
|
|
1071
1072
|
|
|
1072
1073
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1073
1074
|
|
|
1075
|
+
# **postCreateWizardFromOrder**
|
|
1076
|
+
> TcxWizardModel postCreateWizardFromOrder()
|
|
1077
|
+
|
|
1078
|
+
Create Engineered Wizard
|
|
1079
|
+
|
|
1080
|
+
### Example
|
|
1081
|
+
|
|
1082
|
+
```typescript
|
|
1083
|
+
import {
|
|
1084
|
+
OrdersApi,
|
|
1085
|
+
Configuration,
|
|
1086
|
+
EngineeredWizardRequestModel
|
|
1087
|
+
} from 'yellowgrid-api-ts';
|
|
1088
|
+
|
|
1089
|
+
const configuration = new Configuration();
|
|
1090
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1091
|
+
|
|
1092
|
+
let id: number; //Order ID (default to undefined)
|
|
1093
|
+
let engineeredWizardRequestModel: EngineeredWizardRequestModel; //Engineered Wizard Request (optional)
|
|
1094
|
+
|
|
1095
|
+
const { status, data } = await apiInstance.postCreateWizardFromOrder(
|
|
1096
|
+
id,
|
|
1097
|
+
engineeredWizardRequestModel
|
|
1098
|
+
);
|
|
1099
|
+
```
|
|
1100
|
+
|
|
1101
|
+
### Parameters
|
|
1102
|
+
|
|
1103
|
+
|Name | Type | Description | Notes|
|
|
1104
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1105
|
+
| **engineeredWizardRequestModel** | **EngineeredWizardRequestModel**| Engineered Wizard Request | |
|
|
1106
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
### Return type
|
|
1110
|
+
|
|
1111
|
+
**TcxWizardModel**
|
|
1112
|
+
|
|
1113
|
+
### Authorization
|
|
1114
|
+
|
|
1115
|
+
No authorization required
|
|
1116
|
+
|
|
1117
|
+
### HTTP request headers
|
|
1118
|
+
|
|
1119
|
+
- **Content-Type**: application/json
|
|
1120
|
+
- **Accept**: application/json
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
### HTTP response details
|
|
1124
|
+
| Status code | Description | Response headers |
|
|
1125
|
+
|-------------|-------------|------------------|
|
|
1126
|
+
|**200** | Wizard Details | - |
|
|
1127
|
+
|**400** | Bad Request | - |
|
|
1128
|
+
|**401** | Unauthorised | - |
|
|
1129
|
+
|**403** | Access Denied | - |
|
|
1130
|
+
|
|
1131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1132
|
+
|
|
1074
1133
|
# **postGetOrders**
|
|
1075
1134
|
> Array<OrderSummaryDTO> postGetOrders()
|
|
1076
1135
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# SearchSchoolModel
|
|
2
|
+
|
|
3
|
+
EdTechPro School Information
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | School ID | [default to undefined]
|
|
10
|
+
**urn** | **string** | URN Number | [default to undefined]
|
|
11
|
+
**dfe** | **string** | DFE Code | [default to undefined]
|
|
12
|
+
**name** | **string** | School Name | [default to undefined]
|
|
13
|
+
**phaseOfEducation** | **string** | Phase of Education | [default to undefined]
|
|
14
|
+
**text** | **string** | Text Display | [default to undefined]
|
|
15
|
+
**mis** | **string** | MIS | [default to undefined]
|
|
16
|
+
**address** | **string** | Address | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { SearchSchoolModel } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: SearchSchoolModel = {
|
|
24
|
+
id,
|
|
25
|
+
urn,
|
|
26
|
+
dfe,
|
|
27
|
+
name,
|
|
28
|
+
phaseOfEducation,
|
|
29
|
+
text,
|
|
30
|
+
mis,
|
|
31
|
+
address,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TcxEngineerTaskDTO
|
|
2
|
+
|
|
3
|
+
3CX Engineer Task
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**taskId** | **number** | Task ID | [default to undefined]
|
|
10
|
+
**title** | **string** | Title | [default to undefined]
|
|
11
|
+
**description** | **string** | Description | [default to undefined]
|
|
12
|
+
**complete** | **number** | Completion Status | [default to undefined]
|
|
13
|
+
**note** | **string** | Note | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { TcxEngineerTaskDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: TcxEngineerTaskDTO = {
|
|
21
|
+
taskId,
|
|
22
|
+
title,
|
|
23
|
+
description,
|
|
24
|
+
complete,
|
|
25
|
+
note,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# TcxEngineeringDTO
|
|
2
|
+
|
|
3
|
+
3CX Engineering
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Engineering ID | [default to undefined]
|
|
10
|
+
**wizardId** | **number** | Wizard ID | [default to undefined]
|
|
11
|
+
**engineerId** | **number** | Engineer ID | [default to undefined]
|
|
12
|
+
**engineerName** | **string** | Engineer Name | [default to undefined]
|
|
13
|
+
**ticketUrl** | **string** | Ticket URL | [default to undefined]
|
|
14
|
+
**goLiveDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
|
+
**spec** | **string** | Spec | [optional] [default to undefined]
|
|
16
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
17
|
+
**tasks** | [**Array<TcxEngineerTaskDTO>**](TcxEngineerTaskDTO.md) | Tasks | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { TcxEngineeringDTO } from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: TcxEngineeringDTO = {
|
|
25
|
+
id,
|
|
26
|
+
wizardId,
|
|
27
|
+
engineerId,
|
|
28
|
+
engineerName,
|
|
29
|
+
ticketUrl,
|
|
30
|
+
goLiveDate,
|
|
31
|
+
spec,
|
|
32
|
+
note,
|
|
33
|
+
tasks,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|