yellowgrid-api-ts 3.2.256-dev.0 → 3.2.257-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 +1 -4
- package/README.md +1 -11
- package/api.ts +20 -596
- package/dist/api.d.ts +15 -319
- package/dist/api.js +19 -595
- package/docs/Class3CXInstallationWizardApi.md +0 -336
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +0 -59
- package/docs/PatchApproveRmaRequest.md +20 -0
- package/docs/RMAApi.md +7 -3
- package/docs/SearchSchoolModel.md +1 -1
- package/docs/TcxWizardModel.md +0 -2
- package/package.json +1 -1
|
@@ -25,13 +25,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
|
25
25
|
|[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
|
|
26
26
|
|[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
|
|
27
27
|
|[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
|
|
28
|
-
|[**patchAllocateEngineer**](#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer | |
|
|
29
28
|
|[**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 | |
|
|
35
29
|
|[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
|
|
36
30
|
|[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
|
|
37
31
|
|[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
|
|
@@ -1133,60 +1127,6 @@ No authorization required
|
|
|
1133
1127
|
|
|
1134
1128
|
[[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)
|
|
1135
1129
|
|
|
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
|
-
|
|
1190
1130
|
# **patchGetWizard**
|
|
1191
1131
|
> TcxWizardModel patchGetWizard()
|
|
1192
1132
|
|
|
@@ -1242,282 +1182,6 @@ No authorization required
|
|
|
1242
1182
|
|
|
1243
1183
|
[[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)
|
|
1244
1184
|
|
|
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
|
-
|
|
1521
1185
|
# **postAddExtensions**
|
|
1522
1186
|
> Array<TcxExtsEntity> postAddExtensions()
|
|
1523
1187
|
|
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' | '
|
|
167
|
+
| **tokenExchangeType** | [**string**]**Array<'tcx_wizard' | '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,7 +22,6 @@ 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 | |
|
|
26
25
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
27
26
|
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
28
27
|
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
@@ -1072,64 +1071,6 @@ No authorization required
|
|
|
1072
1071
|
|
|
1073
1072
|
[[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)
|
|
1074
1073
|
|
|
1075
|
-
# **postCreateWizardFromOrder**
|
|
1076
|
-
> TcxSummaryDTO 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
|
-
**TcxSummaryDTO**
|
|
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
|
-
|
|
1133
1074
|
# **postGetOrders**
|
|
1134
1075
|
> Array<OrderSummaryDTO> postGetOrders()
|
|
1135
1076
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchApproveRmaRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sendEmail** | **boolean** | Send email to customer | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchApproveRmaRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchApproveRmaRequest = {
|
|
16
|
+
sendEmail,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/RMAApi.md
CHANGED
|
@@ -603,16 +603,19 @@ Approve an RMA
|
|
|
603
603
|
```typescript
|
|
604
604
|
import {
|
|
605
605
|
RMAApi,
|
|
606
|
-
Configuration
|
|
606
|
+
Configuration,
|
|
607
|
+
PatchApproveRmaRequest
|
|
607
608
|
} from 'yellowgrid-api-ts';
|
|
608
609
|
|
|
609
610
|
const configuration = new Configuration();
|
|
610
611
|
const apiInstance = new RMAApi(configuration);
|
|
611
612
|
|
|
612
613
|
let id: number; // (default to undefined)
|
|
614
|
+
let patchApproveRmaRequest: PatchApproveRmaRequest; // (optional)
|
|
613
615
|
|
|
614
616
|
const { status, data } = await apiInstance.patchApproveRma(
|
|
615
|
-
id
|
|
617
|
+
id,
|
|
618
|
+
patchApproveRmaRequest
|
|
616
619
|
);
|
|
617
620
|
```
|
|
618
621
|
|
|
@@ -620,6 +623,7 @@ const { status, data } = await apiInstance.patchApproveRma(
|
|
|
620
623
|
|
|
621
624
|
|Name | Type | Description | Notes|
|
|
622
625
|
|------------- | ------------- | ------------- | -------------|
|
|
626
|
+
| **patchApproveRmaRequest** | **PatchApproveRmaRequest**| | |
|
|
623
627
|
| **id** | [**number**] | | defaults to undefined|
|
|
624
628
|
|
|
625
629
|
|
|
@@ -633,7 +637,7 @@ No authorization required
|
|
|
633
637
|
|
|
634
638
|
### HTTP request headers
|
|
635
639
|
|
|
636
|
-
- **Content-Type**:
|
|
640
|
+
- **Content-Type**: application/json
|
|
637
641
|
- **Accept**: Not defined
|
|
638
642
|
|
|
639
643
|
|
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**name** | **string** | School Name | [default to undefined]
|
|
13
13
|
**phaseOfEducation** | **string** | Phase of Education | [default to undefined]
|
|
14
14
|
**text** | **string** | Text Display | [default to undefined]
|
|
15
|
-
**mis** | **string** | MIS | [default to undefined]
|
|
15
|
+
**mis** | **string** | MIS | [optional] [default to undefined]
|
|
16
16
|
**address** | **string** | Address | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
package/docs/TcxWizardModel.md
CHANGED
|
@@ -18,7 +18,6 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) | | [optional] [default to undefined]
|
|
19
19
|
**sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) | | [optional] [default to undefined]
|
|
20
20
|
**installationStatus** | **string** | | [optional] [default to undefined]
|
|
21
|
-
**engineering** | [**TcxEngineeringDTO**](TcxEngineeringDTO.md) | | [optional] [default to undefined]
|
|
22
21
|
**setup** | [**TcxSetupEntity**](TcxSetupEntity.md) | | [optional] [default to undefined]
|
|
23
22
|
**endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
|
|
24
23
|
|
|
@@ -40,7 +39,6 @@ const instance: TcxWizardModel = {
|
|
|
40
39
|
sbcs,
|
|
41
40
|
sipTrunk,
|
|
42
41
|
installationStatus,
|
|
43
|
-
engineering,
|
|
44
42
|
setup,
|
|
45
43
|
endUserView,
|
|
46
44
|
};
|