yellowgrid-api-ts 3.2.97-dev.0 → 3.2.97

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.
Files changed (59) hide show
  1. package/.openapi-generator/FILES +264 -261
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +13 -3
  4. package/api.ts +1097 -4947
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/config.json +3 -3
  8. package/configuration.ts +25 -19
  9. package/dist/api.d.ts +438 -4468
  10. package/dist/api.js +1003 -555
  11. package/dist/base.d.ts +1 -25
  12. package/dist/base.js +2 -21
  13. package/dist/common.d.ts +5 -36
  14. package/dist/common.js +17 -39
  15. package/dist/configuration.d.ts +25 -18
  16. package/dist/configuration.js +2 -2
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/ScheduledTaskEnum.d.ts +33 -0
  20. package/dist/models/ScheduledTaskEnum.js +35 -0
  21. package/docs/AccountsApi.md +1 -1
  22. package/docs/CRMApi.md +1 -1
  23. package/docs/Class3CXApi.md +1 -1
  24. package/docs/Class3CXInstallationWizardApi.md +1 -1
  25. package/docs/Class3CXInstallationsApi.md +348 -5
  26. package/docs/Class3CXIntegrationsApi.md +1 -1
  27. package/docs/Class3CXMultiTenantApi.md +1 -1
  28. package/docs/InstallationDetailsDTO.md +39 -0
  29. package/docs/MyPBXToolsApi.md +1 -1
  30. package/docs/NumberPortingApi.md +1 -1
  31. package/docs/OAuth20Api.md +1 -1
  32. package/docs/OrdersApi.md +152 -32
  33. package/docs/PricingApi.md +1 -1
  34. package/docs/ProductSummaryDTO.md +2 -0
  35. package/docs/ProductsApi.md +1 -1
  36. package/docs/ProvisioningApi.md +1 -1
  37. package/docs/RemoteStorageDTO.md +27 -0
  38. package/docs/SIPTrunksApi.md +1 -1
  39. package/docs/SMSApi.md +1 -1
  40. package/docs/ServicesApi.md +1 -1
  41. package/docs/ShippingApi.md +1 -1
  42. package/docs/StockManagementApi.md +1 -1
  43. package/docs/SystemApi.md +1 -1
  44. package/docs/TcxSbcDTO.md +4 -0
  45. package/docs/TcxSbcResponseDTO.md +23 -0
  46. package/docs/TicketsApi.md +1 -1
  47. package/docs/WebhooksApi.md +1 -1
  48. package/getEnums.php +31 -31
  49. package/index.ts +1 -1
  50. package/models/ScheduledTaskEnum.ts +34 -0
  51. package/openapitools.json +1 -1
  52. package/package.json +2 -2
  53. package/docs/NumberPortModel.md +0 -51
  54. package/docs/TcxInstallationDetailsModel.md +0 -45
  55. package/docs/TelephonySupportTicketModel.md +0 -41
  56. package/hs_err_pid16044.log +0 -249
  57. package/hs_err_pid44560.log +0 -249
  58. package/hs_err_pid53988.log +0 -249
  59. package/hs_err_pid58728.log +0 -40
package/docs/OrdersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
9
9
  |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
10
10
  |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
11
11
  |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
12
+ |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
12
13
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
13
14
  |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
14
15
  |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
@@ -22,13 +23,14 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
22
23
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
23
24
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
24
25
  |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
26
+ |[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
25
27
  |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
26
28
  |[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
27
29
  |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
28
30
  |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
29
31
  |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
30
- |[**putDeleteBatch**](#putdeletebatch) | **PUT** /admin/orders/{id}/batches/{batch_id} | Update Batch Item (Admin)|
31
32
  |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
33
+ |[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
32
34
  |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
33
35
  |[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
34
36
  |[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
@@ -312,6 +314,66 @@ No authorization required
312
314
 
313
315
  [[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)
314
316
 
317
+ # **getGetCommercialInvoice**
318
+ > File getGetCommercialInvoice()
319
+
320
+ Get Commercial Invoice PDF
321
+
322
+ ### Example
323
+
324
+ ```typescript
325
+ import {
326
+ OrdersApi,
327
+ Configuration
328
+ } from 'yellowgrid-api-ts';
329
+
330
+ const configuration = new Configuration();
331
+ const apiInstance = new OrdersApi(configuration);
332
+
333
+ let id: number; //Order ID (default to undefined)
334
+ let batchId: number; //Batch ID (default to undefined)
335
+ let shipmentId: number; //Shipment ID (default to undefined)
336
+
337
+ const { status, data } = await apiInstance.getGetCommercialInvoice(
338
+ id,
339
+ batchId,
340
+ shipmentId
341
+ );
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ |Name | Type | Description | Notes|
347
+ |------------- | ------------- | ------------- | -------------|
348
+ | **id** | [**number**] | Order ID | defaults to undefined|
349
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
350
+ | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
351
+
352
+
353
+ ### Return type
354
+
355
+ **File**
356
+
357
+ ### Authorization
358
+
359
+ No authorization required
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: Not defined
364
+ - **Accept**: application/pdf
365
+
366
+
367
+ ### HTTP response details
368
+ | Status code | Description | Response headers |
369
+ |-------------|-------------|------------------|
370
+ |**200** | Order PDF | - |
371
+ |**400** | Bad Request | - |
372
+ |**401** | Unauthorised | - |
373
+ |**403** | Access Denied | - |
374
+
375
+ [[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)
376
+
315
377
  # **getGetEditableOrder**
316
378
  > DetailedOrderRequestDTO getGetEditableOrder()
317
379
 
@@ -1058,13 +1120,71 @@ No authorization required
1058
1120
  ### HTTP request headers
1059
1121
 
1060
1122
  - **Content-Type**: Not defined
1061
- - **Accept**: text/html, application/json
1123
+ - **Accept**: text/html
1062
1124
 
1063
1125
 
1064
1126
  ### HTTP response details
1065
1127
  | Status code | Description | Response headers |
1066
1128
  |-------------|-------------|------------------|
1067
1129
  |**200** | Shipping Label | - |
1130
+ |**204** | No Response | - |
1131
+ |**400** | Bad Request | - |
1132
+ |**401** | Unauthorised | - |
1133
+ |**403** | Access Denied | - |
1134
+
1135
+ [[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
+
1137
+ # **postProcessTcxLicences**
1138
+ > OrderDetailsDTO postProcessTcxLicences()
1139
+
1140
+ Process 3CX Licences (Admin)
1141
+
1142
+ ### Example
1143
+
1144
+ ```typescript
1145
+ import {
1146
+ OrdersApi,
1147
+ Configuration
1148
+ } from 'yellowgrid-api-ts';
1149
+
1150
+ const configuration = new Configuration();
1151
+ const apiInstance = new OrdersApi(configuration);
1152
+
1153
+ let id: number; //Order ID (default to undefined)
1154
+ let batchId: number; //Batch ID (default to undefined)
1155
+
1156
+ const { status, data } = await apiInstance.postProcessTcxLicences(
1157
+ id,
1158
+ batchId
1159
+ );
1160
+ ```
1161
+
1162
+ ### Parameters
1163
+
1164
+ |Name | Type | Description | Notes|
1165
+ |------------- | ------------- | ------------- | -------------|
1166
+ | **id** | [**number**] | Order ID | defaults to undefined|
1167
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1168
+
1169
+
1170
+ ### Return type
1171
+
1172
+ **OrderDetailsDTO**
1173
+
1174
+ ### Authorization
1175
+
1176
+ No authorization required
1177
+
1178
+ ### HTTP request headers
1179
+
1180
+ - **Content-Type**: Not defined
1181
+ - **Accept**: application/json
1182
+
1183
+
1184
+ ### HTTP response details
1185
+ | Status code | Description | Response headers |
1186
+ |-------------|-------------|------------------|
1187
+ |**200** | Order Details | - |
1068
1188
  |**400** | Bad Request | - |
1069
1189
  |**401** | Unauthorised | - |
1070
1190
  |**403** | Access Denied | - |
@@ -1367,10 +1487,10 @@ No authorization required
1367
1487
 
1368
1488
  [[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)
1369
1489
 
1370
- # **putDeleteBatch**
1371
- > OrderedItemModel putDeleteBatch()
1490
+ # **putUpdateAdminOrder**
1491
+ > Array<OrderSummaryDTO> putUpdateAdminOrder()
1372
1492
 
1373
- Update Batch Item (Admin)
1493
+ Update An Order (Admin)
1374
1494
 
1375
1495
  ### Example
1376
1496
 
@@ -1378,22 +1498,20 @@ Update Batch Item (Admin)
1378
1498
  import {
1379
1499
  OrdersApi,
1380
1500
  Configuration,
1381
- OrderedItemModel
1501
+ AdminOrderRequestDTO
1382
1502
  } from 'yellowgrid-api-ts';
1383
1503
 
1384
1504
  const configuration = new Configuration();
1385
1505
  const apiInstance = new OrdersApi(configuration);
1386
1506
 
1387
1507
  let id: number; //Order ID (default to undefined)
1388
- let batchId: number; //Batch ID (default to undefined)
1389
- let itemId: number; //Ordered Item ID (default to undefined)
1390
- let orderedItemModel: OrderedItemModel; //Batch Item (optional)
1508
+ let readonly: boolean; //Readonly Order (optional) (default to undefined)
1509
+ let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
1391
1510
 
1392
- const { status, data } = await apiInstance.putDeleteBatch(
1511
+ const { status, data } = await apiInstance.putUpdateAdminOrder(
1393
1512
  id,
1394
- batchId,
1395
- itemId,
1396
- orderedItemModel
1513
+ readonly,
1514
+ adminOrderRequestDTO
1397
1515
  );
1398
1516
  ```
1399
1517
 
@@ -1401,15 +1519,14 @@ const { status, data } = await apiInstance.putDeleteBatch(
1401
1519
 
1402
1520
  |Name | Type | Description | Notes|
1403
1521
  |------------- | ------------- | ------------- | -------------|
1404
- | **orderedItemModel** | **OrderedItemModel**| Batch Item | |
1522
+ | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
1405
1523
  | **id** | [**number**] | Order ID | defaults to undefined|
1406
- | **batchId** | [**number**] | Batch ID | defaults to undefined|
1407
- | **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
1524
+ | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
1408
1525
 
1409
1526
 
1410
1527
  ### Return type
1411
1528
 
1412
- **OrderedItemModel**
1529
+ **Array<OrderSummaryDTO>**
1413
1530
 
1414
1531
  ### Authorization
1415
1532
 
@@ -1424,17 +1541,17 @@ No authorization required
1424
1541
  ### HTTP response details
1425
1542
  | Status code | Description | Response headers |
1426
1543
  |-------------|-------------|------------------|
1427
- |**200** | Ordered Item | - |
1544
+ |**200** | Order Summaries | - |
1428
1545
  |**400** | Bad Request | - |
1429
1546
  |**401** | Unauthorised | - |
1430
1547
  |**403** | Access Denied | - |
1431
1548
 
1432
1549
  [[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)
1433
1550
 
1434
- # **putUpdateAdminOrder**
1435
- > Array<OrderSummaryDTO> putUpdateAdminOrder()
1551
+ # **putUpdateBatchItem**
1552
+ > OrderedItemModel putUpdateBatchItem()
1436
1553
 
1437
- Update An Order (Admin)
1554
+ Update Batch Item (Admin)
1438
1555
 
1439
1556
  ### Example
1440
1557
 
@@ -1442,20 +1559,22 @@ Update An Order (Admin)
1442
1559
  import {
1443
1560
  OrdersApi,
1444
1561
  Configuration,
1445
- AdminOrderRequestDTO
1562
+ OrderedItemModel
1446
1563
  } from 'yellowgrid-api-ts';
1447
1564
 
1448
1565
  const configuration = new Configuration();
1449
1566
  const apiInstance = new OrdersApi(configuration);
1450
1567
 
1451
1568
  let id: number; //Order ID (default to undefined)
1452
- let readonly: boolean; //Readonly Order (optional) (default to undefined)
1453
- let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
1569
+ let batchId: number; //Batch ID (default to undefined)
1570
+ let itemId: number; //Ordered Item ID (default to undefined)
1571
+ let orderedItemModel: OrderedItemModel; //Batch Item (optional)
1454
1572
 
1455
- const { status, data } = await apiInstance.putUpdateAdminOrder(
1573
+ const { status, data } = await apiInstance.putUpdateBatchItem(
1456
1574
  id,
1457
- readonly,
1458
- adminOrderRequestDTO
1575
+ batchId,
1576
+ itemId,
1577
+ orderedItemModel
1459
1578
  );
1460
1579
  ```
1461
1580
 
@@ -1463,14 +1582,15 @@ const { status, data } = await apiInstance.putUpdateAdminOrder(
1463
1582
 
1464
1583
  |Name | Type | Description | Notes|
1465
1584
  |------------- | ------------- | ------------- | -------------|
1466
- | **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
1585
+ | **orderedItemModel** | **OrderedItemModel**| Batch Item | |
1467
1586
  | **id** | [**number**] | Order ID | defaults to undefined|
1468
- | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
1587
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1588
+ | **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
1469
1589
 
1470
1590
 
1471
1591
  ### Return type
1472
1592
 
1473
- **Array<OrderSummaryDTO>**
1593
+ **OrderedItemModel**
1474
1594
 
1475
1595
  ### Authorization
1476
1596
 
@@ -1485,7 +1605,7 @@ No authorization required
1485
1605
  ### HTTP response details
1486
1606
  | Status code | Description | Response headers |
1487
1607
  |-------------|-------------|------------------|
1488
- |**200** | Order Summaries | - |
1608
+ |**200** | Ordered Item | - |
1489
1609
  |**400** | Bad Request | - |
1490
1610
  |**401** | Unauthorised | - |
1491
1611
  |**403** | Access Denied | - |
@@ -1,6 +1,6 @@
1
1
  # PricingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **title** | **string** | Title | [optional] [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
+ **dueDate** | **string** | Date Time | [optional] [default to undefined]
13
14
  **price** | **number** | Price | [optional] [default to undefined]
14
15
  **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
15
16
  **rrp** | **number** | RRP Price | [optional] [default to undefined]
@@ -26,6 +27,7 @@ const instance: ProductSummaryDTO = {
26
27
  title,
27
28
  quantity,
28
29
  stockProduct,
30
+ dueDate,
29
31
  price,
30
32
  cartonSize,
31
33
  rrp,
@@ -1,6 +1,6 @@
1
1
  # ProductsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # ProvisioningApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,27 @@
1
+ # RemoteStorageDTO
2
+
3
+ Remote Storage
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | AWS ID | [optional] [default to undefined]
10
+ **secret** | **string** | AWS Secret | [optional] [default to undefined]
11
+ **name** | **string** | AWS Bucket Name | [optional] [default to undefined]
12
+ **region** | **string** | AWS Region | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { RemoteStorageDTO } from 'yellowgrid-api-ts';
18
+
19
+ const instance: RemoteStorageDTO = {
20
+ id,
21
+ secret,
22
+ name,
23
+ region,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,6 +1,6 @@
1
1
  # SIPTrunksApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/SMSApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SMSApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # ServicesApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # ShippingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # StockManagementApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/SystemApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SystemApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/TcxSbcDTO.md CHANGED
@@ -6,12 +6,14 @@ SBC Data
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | ID | [optional] [default to undefined]
9
10
  **ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
10
11
  **defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
11
12
  **netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
12
13
  **dns** | **string** | DNS | [optional] [default to undefined]
13
14
  **tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
14
15
  **tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
16
+ **configured** | **boolean** | 3CX SBC Configured | [optional] [default to undefined]
15
17
 
16
18
  ## Example
17
19
 
@@ -19,12 +21,14 @@ Name | Type | Description | Notes
19
21
  import { TcxSbcDTO } from 'yellowgrid-api-ts';
20
22
 
21
23
  const instance: TcxSbcDTO = {
24
+ id,
22
25
  ipAddress,
23
26
  defaultGateway,
24
27
  netmask,
25
28
  dns,
26
29
  tcxUrl,
27
30
  tcxKey,
31
+ configured,
28
32
  };
29
33
  ```
30
34
 
@@ -0,0 +1,23 @@
1
+ # TcxSbcResponseDTO
2
+
3
+ 3CX SBC Response
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **status** | **string** | Status | [optional] [default to undefined]
10
+ **message** | **string** | Message | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { TcxSbcResponseDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: TcxSbcResponseDTO = {
18
+ status,
19
+ message,
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)
@@ -1,6 +1,6 @@
1
1
  # TicketsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # WebhooksApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/getEnums.php CHANGED
@@ -1,31 +1,31 @@
1
- <?php
2
-
3
- use App\Contracts\Enums\PublicEnumInterface;
4
-
5
- require_once __DIR__."/../../../../vendor/autoload.php";
6
-
7
- $dir = __DIR__."/models";
8
- if (!is_dir($dir)) {
9
- mkdir($dir);
10
- }
11
- foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
12
- $ref = new ReflectionEnum($publicEnum->value);
13
- $cases = [];
14
- foreach ($ref->getCases() as $c) {
15
- /** @var BackedEnum $enum */
16
- $enum = $c->getEnum()->getName();
17
- $value = $c->getBackingValue();
18
- /** @var PublicEnumInterface $case */
19
- $case = $enum::from($value);
20
- $cases[$c->getName()] = [
21
- "name" => $case->name,
22
- "value" => $case->value,
23
- "publicValue" => $case->getPublicValue()
24
- ];
25
- }
26
- $enumName = $ref->getShortName();
27
- $enumString = json_encode($cases, JSON_PRETTY_PRINT);
28
- $content = "export const $enumName = $enumString as const;".
29
- "\n\n export type $enumName = typeof $enumName;";
30
- file_put_contents("$dir/$enumName.ts", $content);
31
- }
1
+ <?php
2
+
3
+ use App\Contracts\Enums\PublicEnumInterface;
4
+
5
+ require_once __DIR__."/../../../../vendor/autoload.php";
6
+
7
+ $dir = __DIR__."/models";
8
+ if (!is_dir($dir)) {
9
+ mkdir($dir);
10
+ }
11
+ foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
12
+ $ref = new ReflectionEnum($publicEnum->value);
13
+ $cases = [];
14
+ foreach ($ref->getCases() as $c) {
15
+ /** @var BackedEnum $enum */
16
+ $enum = $c->getEnum()->getName();
17
+ $value = $c->getBackingValue();
18
+ /** @var PublicEnumInterface $case */
19
+ $case = $enum::from($value);
20
+ $cases[$c->getName()] = [
21
+ "name" => $case->name,
22
+ "value" => $case->value,
23
+ "publicValue" => $case->getPublicValue()
24
+ ];
25
+ }
26
+ $enumName = $ref->getShortName();
27
+ $enumString = json_encode($cases, JSON_PRETTY_PRINT);
28
+ $content = "export const $enumName = $enumString as const;".
29
+ "\n\n export type $enumName = typeof $enumName;";
30
+ file_put_contents("$dir/$enumName.ts", $content);
31
+ }
package/index.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Yellowgrid
5
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://api.local.yellowgrid.co.uk` For questions or technical support, please contact support@yellowgrid.co.uk.
5
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
6
6
  *
7
7
  * The version of the OpenAPI document: 0
8
8
  *
@@ -0,0 +1,34 @@
1
+ export const ScheduledTaskEnum = {
2
+ "SUSPEND_INSTANCE": {
3
+ "name": "SUSPEND_INSTANCE",
4
+ "value": "Suspend",
5
+ "publicValue": "Suspend"
6
+ },
7
+ "RESIZE_INSTANCE": {
8
+ "name": "RESIZE_INSTANCE",
9
+ "value": "Resize",
10
+ "publicValue": "Resize"
11
+ },
12
+ "EXTEND_DISK": {
13
+ "name": "EXTEND_DISK",
14
+ "value": "Extend Disk",
15
+ "publicValue": "Extend Disk"
16
+ },
17
+ "TCX_UPGRADE_DEBIAN": {
18
+ "name": "TCX_UPGRADE_DEBIAN",
19
+ "value": "Upgrade Debian",
20
+ "publicValue": "Upgrade Debian"
21
+ },
22
+ "TCX_RESTART_SERVICES": {
23
+ "name": "TCX_RESTART_SERVICES",
24
+ "value": "Restart Services",
25
+ "publicValue": "Restart Services"
26
+ },
27
+ "REBOOT": {
28
+ "name": "REBOOT",
29
+ "value": "Reboot",
30
+ "publicValue": "Reboot"
31
+ }
32
+ } as const;
33
+
34
+ export type ScheduledTaskEnum = typeof ScheduledTaskEnum;
package/openapitools.json CHANGED
@@ -2,6 +2,6 @@
2
2
  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
3
  "spaces": 2,
4
4
  "generator-cli": {
5
- "version": "7.14.0"
5
+ "version": "7.21.0"
6
6
  }
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.97-dev.0",
3
+ "version": "3.2.97",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -22,7 +22,7 @@
22
22
  "prepare": "npm run build"
23
23
  },
24
24
  "dependencies": {
25
- "axios": "^1.6.1"
25
+ "axios": "^1.13.5"
26
26
  },
27
27
  "devDependencies": {
28
28
  "@types/node": "12.11.5 - 12.20.42",