yellowgrid-api-ts 3.0.91 → 3.0.96

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.
@@ -10,10 +10,14 @@ All URIs are relative to *http://api.yellowgrid.local*
10
10
  |[**deleteAddSbcs**](#deleteaddsbcs) | **DELETE** /tcx/wizards/sbcs | Delete 3CX Installation Wizard SBCs|
11
11
  |[**deleteGetWizard**](#deletegetwizard) | **DELETE** /tcx/wizards | Delete 3CX Installation Wizard|
12
12
  |[**getAddPhones**](#getaddphones) | **GET** /tcx/wizards/phones | Get phones on linked order and MAC addresses|
13
+ |[**getGetAreaCodesTcxWizard**](#getgetareacodestcxwizard) | **GET** /tcx/wizards/sip/trunks/area/codes | Get UK National Area Codes|
14
+ |[**getGetDdisTcxWizard**](#getgetddistcxwizard) | **GET** /tcx/wizards/sip/trunks/{id}/ddis | Get SIP Trunk DDIs|
13
15
  |[**getGetHostingPrice**](#getgethostingprice) | **GET** /tcx/wizards/price | Get Hosting Price|
14
16
  |[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
15
17
  |[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
16
18
  |[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
19
+ |[**getGetSipTrunkTcxWizard**](#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk|
20
+ |[**getGetSipTrunksTcxWizard**](#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks|
17
21
  |[**getGetWizard**](#getgetwizard) | **GET** /tcx/wizards | Get 3CX Installation Wizard|
18
22
  |[**patchAddExtensions**](#patchaddextensions) | **PATCH** /tcx/wizards/extensions | Update 3CX Installation Wizard Extensions|
19
23
  |[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
@@ -28,6 +32,9 @@ All URIs are relative to *http://api.yellowgrid.local*
28
32
  |[**postBuildInstanceFromWizard**](#postbuildinstancefromwizard) | **POST** /tcx/wizard/build | Start 3CX Installation Build Process|
29
33
  |[**postCreateInstance**](#postcreateinstance) | **POST** /tcx/wizards/instances/create | Create Instance From 3CX Installation Wizard|
30
34
  |[**postCreateInstanceFromWizard**](#postcreateinstancefromwizard) | **POST** /tcx/wizard/create | Create Hosted Instance From 3CX Installation Wizard Config|
35
+ |[**postGetDdisTcxWizard**](#postgetddistcxwizard) | **POST** /tcx/wizards/sip/trunks/{id}/ddis | Add SIP Trunk DDIs|
36
+ |[**postGetRequestedDdisTcxWizard**](#postgetrequestedddistcxwizard) | **POST** /tcx/wizards/sip/trunks/changes/ddis | Get Requested DDIs|
37
+ |[**postGetSipTrunksTcxWizard**](#postgetsiptrunkstcxwizard) | **POST** /tcx/wizards/sip/trunks | Create New SIP Trunk|
31
38
  |[**postUploadBackup**](#postuploadbackup) | **POST** /tcx/wizards/backup | |
32
39
 
33
40
  # **deleteAddExtensions**
@@ -340,6 +347,107 @@ No authorization required
340
347
 
341
348
  [[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)
342
349
 
350
+ # **getGetAreaCodesTcxWizard**
351
+ > Array<AreaCodeModel> getGetAreaCodesTcxWizard()
352
+
353
+ Get UK National Area Codes
354
+
355
+ ### Example
356
+
357
+ ```typescript
358
+ import {
359
+ Class3CXInstallationWizardApi,
360
+ Configuration
361
+ } from 'yellowgrid-api-ts';
362
+
363
+ const configuration = new Configuration();
364
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
365
+
366
+ const { status, data } = await apiInstance.getGetAreaCodesTcxWizard();
367
+ ```
368
+
369
+ ### Parameters
370
+ This endpoint does not have any parameters.
371
+
372
+
373
+ ### Return type
374
+
375
+ **Array<AreaCodeModel>**
376
+
377
+ ### Authorization
378
+
379
+ No authorization required
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: Not defined
384
+ - **Accept**: application/json
385
+
386
+
387
+ ### HTTP response details
388
+ | Status code | Description | Response headers |
389
+ |-------------|-------------|------------------|
390
+ |**200** | Area Codes | - |
391
+ |**400** | Bad Request | - |
392
+ |**401** | Unauthorised | - |
393
+ |**403** | Access Denied | - |
394
+
395
+ [[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)
396
+
397
+ # **getGetDdisTcxWizard**
398
+ > Array<string> getGetDdisTcxWizard()
399
+
400
+ Get SIP Trunk DDIs
401
+
402
+ ### Example
403
+
404
+ ```typescript
405
+ import {
406
+ Class3CXInstallationWizardApi,
407
+ Configuration
408
+ } from 'yellowgrid-api-ts';
409
+
410
+ const configuration = new Configuration();
411
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
412
+
413
+ let id: number; //SIP Trunk ID (default to undefined)
414
+
415
+ const { status, data } = await apiInstance.getGetDdisTcxWizard(
416
+ id
417
+ );
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+ |Name | Type | Description | Notes|
423
+ |------------- | ------------- | ------------- | -------------|
424
+ | **id** | [**number**] | SIP Trunk ID | defaults to undefined|
425
+
426
+
427
+ ### Return type
428
+
429
+ **Array<string>**
430
+
431
+ ### Authorization
432
+
433
+ No authorization required
434
+
435
+ ### HTTP request headers
436
+
437
+ - **Content-Type**: Not defined
438
+ - **Accept**: application/json
439
+
440
+
441
+ ### HTTP response details
442
+ | Status code | Description | Response headers |
443
+ |-------------|-------------|------------------|
444
+ |**200** | [string] | - |
445
+ |**400** | Bad Request | - |
446
+ |**401** | Unauthorised | - |
447
+ |**403** | Access Denied | - |
448
+
449
+ [[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)
450
+
343
451
  # **getGetHostingPrice**
344
452
  > number getGetHostingPrice()
345
453
 
@@ -545,6 +653,120 @@ No authorization required
545
653
 
546
654
  [[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)
547
655
 
656
+ # **getGetSipTrunkTcxWizard**
657
+ > SipTrunkEntity getGetSipTrunkTcxWizard()
658
+
659
+ Get SIP Trunk
660
+
661
+ ### Example
662
+
663
+ ```typescript
664
+ import {
665
+ Class3CXInstallationWizardApi,
666
+ Configuration
667
+ } from 'yellowgrid-api-ts';
668
+
669
+ const configuration = new Configuration();
670
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
671
+
672
+ let id: number; //SIP Trunk ID (default to undefined)
673
+
674
+ const { status, data } = await apiInstance.getGetSipTrunkTcxWizard(
675
+ id
676
+ );
677
+ ```
678
+
679
+ ### Parameters
680
+
681
+ |Name | Type | Description | Notes|
682
+ |------------- | ------------- | ------------- | -------------|
683
+ | **id** | [**number**] | SIP Trunk ID | defaults to undefined|
684
+
685
+
686
+ ### Return type
687
+
688
+ **SipTrunkEntity**
689
+
690
+ ### Authorization
691
+
692
+ No authorization required
693
+
694
+ ### HTTP request headers
695
+
696
+ - **Content-Type**: Not defined
697
+ - **Accept**: application/json
698
+
699
+
700
+ ### HTTP response details
701
+ | Status code | Description | Response headers |
702
+ |-------------|-------------|------------------|
703
+ |**200** | SIP Trunk | - |
704
+ |**400** | Bad Request | - |
705
+ |**401** | Unauthorised | - |
706
+ |**403** | Access Denied | - |
707
+
708
+ [[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)
709
+
710
+ # **getGetSipTrunksTcxWizard**
711
+ > SipTrunksResponseModel getGetSipTrunksTcxWizard()
712
+
713
+ Get SIP Trunks
714
+
715
+ ### Example
716
+
717
+ ```typescript
718
+ import {
719
+ Class3CXInstallationWizardApi,
720
+ Configuration
721
+ } from 'yellowgrid-api-ts';
722
+
723
+ const configuration = new Configuration();
724
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
725
+
726
+ let pageSize: number; //Number Of Results (optional) (default to 20)
727
+ let page: number; //Page Number (optional) (default to 1)
728
+ let search: string; //Search (optional) (default to undefined)
729
+
730
+ const { status, data } = await apiInstance.getGetSipTrunksTcxWizard(
731
+ pageSize,
732
+ page,
733
+ search
734
+ );
735
+ ```
736
+
737
+ ### Parameters
738
+
739
+ |Name | Type | Description | Notes|
740
+ |------------- | ------------- | ------------- | -------------|
741
+ | **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
742
+ | **page** | [**number**] | Page Number | (optional) defaults to 1|
743
+ | **search** | [**string**] | Search | (optional) defaults to undefined|
744
+
745
+
746
+ ### Return type
747
+
748
+ **SipTrunksResponseModel**
749
+
750
+ ### Authorization
751
+
752
+ No authorization required
753
+
754
+ ### HTTP request headers
755
+
756
+ - **Content-Type**: Not defined
757
+ - **Accept**: application/json
758
+
759
+
760
+ ### HTTP response details
761
+ | Status code | Description | Response headers |
762
+ |-------------|-------------|------------------|
763
+ |**200** | SIP Trunks | - |
764
+ |**400** | Bad Request | - |
765
+ |**401** | Unauthorised | - |
766
+ |**403** | Access Denied | - |
767
+
768
+ [[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)
769
+
548
770
  # **getGetWizard**
549
771
  > TcxWizardModel getGetWizard()
550
772
 
@@ -1299,6 +1521,174 @@ No authorization required
1299
1521
 
1300
1522
  [[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
1523
 
1524
+ # **postGetDdisTcxWizard**
1525
+ > SipTrunkChangeResponseModel postGetDdisTcxWizard()
1526
+
1527
+ Add SIP Trunk DDIs
1528
+
1529
+ ### Example
1530
+
1531
+ ```typescript
1532
+ import {
1533
+ Class3CXInstallationWizardApi,
1534
+ Configuration,
1535
+ DdiRangesRequestModel
1536
+ } from 'yellowgrid-api-ts';
1537
+
1538
+ const configuration = new Configuration();
1539
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1540
+
1541
+ let id: number; //SIP Trunk ID (default to undefined)
1542
+ let ddiRangesRequestModel: DdiRangesRequestModel; //DDI Request (optional)
1543
+
1544
+ const { status, data } = await apiInstance.postGetDdisTcxWizard(
1545
+ id,
1546
+ ddiRangesRequestModel
1547
+ );
1548
+ ```
1549
+
1550
+ ### Parameters
1551
+
1552
+ |Name | Type | Description | Notes|
1553
+ |------------- | ------------- | ------------- | -------------|
1554
+ | **ddiRangesRequestModel** | **DdiRangesRequestModel**| DDI Request | |
1555
+ | **id** | [**number**] | SIP Trunk ID | defaults to undefined|
1556
+
1557
+
1558
+ ### Return type
1559
+
1560
+ **SipTrunkChangeResponseModel**
1561
+
1562
+ ### Authorization
1563
+
1564
+ No authorization required
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: application/json
1569
+ - **Accept**: application/json
1570
+
1571
+
1572
+ ### HTTP response details
1573
+ | Status code | Description | Response headers |
1574
+ |-------------|-------------|------------------|
1575
+ |**200** | Change Response | - |
1576
+ |**400** | Bad Request | - |
1577
+ |**401** | Unauthorised | - |
1578
+ |**403** | Access Denied | - |
1579
+
1580
+ [[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)
1581
+
1582
+ # **postGetRequestedDdisTcxWizard**
1583
+ > Array<Array<string>> postGetRequestedDdisTcxWizard()
1584
+
1585
+ Get Requested DDIs
1586
+
1587
+ ### Example
1588
+
1589
+ ```typescript
1590
+ import {
1591
+ Class3CXInstallationWizardApi,
1592
+ Configuration,
1593
+ SipTrunkChangeResponseModel
1594
+ } from 'yellowgrid-api-ts';
1595
+
1596
+ const configuration = new Configuration();
1597
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1598
+
1599
+ let sipTrunkChangeResponseModel: SipTrunkChangeResponseModel; //Change Request (optional)
1600
+
1601
+ const { status, data } = await apiInstance.postGetRequestedDdisTcxWizard(
1602
+ sipTrunkChangeResponseModel
1603
+ );
1604
+ ```
1605
+
1606
+ ### Parameters
1607
+
1608
+ |Name | Type | Description | Notes|
1609
+ |------------- | ------------- | ------------- | -------------|
1610
+ | **sipTrunkChangeResponseModel** | **SipTrunkChangeResponseModel**| Change Request | |
1611
+
1612
+
1613
+ ### Return type
1614
+
1615
+ **Array<Array<string>>**
1616
+
1617
+ ### Authorization
1618
+
1619
+ No authorization required
1620
+
1621
+ ### HTTP request headers
1622
+
1623
+ - **Content-Type**: application/json
1624
+ - **Accept**: application/json
1625
+
1626
+
1627
+ ### HTTP response details
1628
+ | Status code | Description | Response headers |
1629
+ |-------------|-------------|------------------|
1630
+ |**200** | New DDIs | - |
1631
+ |**400** | Bad Request | - |
1632
+ |**401** | Unauthorised | - |
1633
+ |**403** | Access Denied | - |
1634
+
1635
+ [[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)
1636
+
1637
+ # **postGetSipTrunksTcxWizard**
1638
+ > SipTrunkChangeResponseModel postGetSipTrunksTcxWizard()
1639
+
1640
+ Create New SIP Trunk
1641
+
1642
+ ### Example
1643
+
1644
+ ```typescript
1645
+ import {
1646
+ Class3CXInstallationWizardApi,
1647
+ Configuration,
1648
+ SipTrunkCreationRequestModel
1649
+ } from 'yellowgrid-api-ts';
1650
+
1651
+ const configuration = new Configuration();
1652
+ const apiInstance = new Class3CXInstallationWizardApi(configuration);
1653
+
1654
+ let sipTrunkCreationRequestModel: SipTrunkCreationRequestModel; //New SIP Trunk Request (optional)
1655
+
1656
+ const { status, data } = await apiInstance.postGetSipTrunksTcxWizard(
1657
+ sipTrunkCreationRequestModel
1658
+ );
1659
+ ```
1660
+
1661
+ ### Parameters
1662
+
1663
+ |Name | Type | Description | Notes|
1664
+ |------------- | ------------- | ------------- | -------------|
1665
+ | **sipTrunkCreationRequestModel** | **SipTrunkCreationRequestModel**| New SIP Trunk Request | |
1666
+
1667
+
1668
+ ### Return type
1669
+
1670
+ **SipTrunkChangeResponseModel**
1671
+
1672
+ ### Authorization
1673
+
1674
+ No authorization required
1675
+
1676
+ ### HTTP request headers
1677
+
1678
+ - **Content-Type**: application/json
1679
+ - **Accept**: application/json
1680
+
1681
+
1682
+ ### HTTP response details
1683
+ | Status code | Description | Response headers |
1684
+ |-------------|-------------|------------------|
1685
+ |**200** | Change Response | - |
1686
+ |**400** | Bad Request | - |
1687
+ |**401** | Unauthorised | - |
1688
+ |**403** | Access Denied | - |
1689
+
1690
+ [[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)
1691
+
1302
1692
  # **postUploadBackup**
1303
1693
  > TcxBackupModel postUploadBackup()
1304
1694
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.0.91",
3
+ "version": "3.0.96",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {