yellowgrid-api-ts 3.2.202 → 3.2.203-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 +312 -298
- package/.openapi-generator/VERSION +1 -1
- package/README.md +23 -2
- package/api.ts +6929 -612
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +3 -3
- package/configuration.ts +21 -27
- package/dist/api.d.ts +5849 -89
- package/dist/api.js +1798 -567
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/GraphTypeEnum.d.ts +8 -0
- package/dist/models/GraphTypeEnum.js +10 -0
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/HostingPriceListEnum.d.ts +5 -0
- package/dist/models/HostingPriceListEnum.js +5 -0
- package/dist/models/ReportEnum.d.ts +43 -0
- package/dist/models/ReportEnum.js +45 -0
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +115 -1
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/AxisDataDTO.md +25 -0
- package/docs/BillingApi.md +1 -1
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CrmActivityDTO.md +3 -3
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/GraphDTO.md +29 -0
- package/docs/MiscApi.md +63 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +1 -1
- package/docs/PartnerDTO.md +1 -1
- package/docs/PasswordSenderDTO.md +37 -0
- package/docs/PasswordSenderEntity.md +33 -0
- package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
- package/docs/PatchUpdateAccountNameRequest.md +20 -0
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductDetailedSummaryDTO.md +41 -0
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSummaryDTO.md +1 -5
- package/docs/ProductsApi.md +5 -5
- package/docs/ProspectDTO.md +2 -2
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/ReportRequestDTO.md +37 -0
- package/docs/ReportsApi.md +107 -0
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/SeriesDTO.md +27 -0
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentRequestDTO.md +2 -2
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockReportItemModel.md +31 -0
- package/docs/StockReportModel.md +29 -0
- package/docs/SupplierItemModel.md +2 -0
- package/docs/SupplierItemsResultsDTO.md +21 -0
- package/docs/SupplierProductModel.md +25 -0
- package/docs/SupplierProductResultsModel.md +27 -0
- package/docs/SuppliersApi.md +230 -0
- package/docs/SystemApi.md +1 -1
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxInstallationModel.md +6 -0
- package/docs/TcxKeySummaryDTO.md +1 -1
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/GraphTypeEnum.ts +9 -0
- package/models/GroupEnum.ts +44 -0
- package/models/HostingPriceListEnum.ts +5 -0
- package/models/ReportEnum.ts +44 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ npm install PATH_TO_GENERATED_PACKAGE --save
|
|
|
47
47
|
|
|
48
48
|
### Documentation for API Endpoints
|
|
49
49
|
|
|
50
|
-
All URIs are relative to *https://
|
|
50
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
@@ -66,6 +66,7 @@ Class | Method | HTTP request | Description
|
|
|
66
66
|
*AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
|
|
67
67
|
*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
|
|
68
68
|
*AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
|
|
69
|
+
*AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
|
|
69
70
|
*AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner |
|
|
70
71
|
*AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
|
|
71
72
|
*AccountsApi* | [**patchSetAccountStatus**](docs/AccountsApi.md#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} |
|
|
@@ -76,6 +77,7 @@ Class | Method | HTTP request | Description
|
|
|
76
77
|
*AccountsApi* | [**patchUpdateAccountCname**](docs/AccountsApi.md#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname |
|
|
77
78
|
*AccountsApi* | [**patchUpdateAccountCompanyNumber**](docs/AccountsApi.md#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber |
|
|
78
79
|
*AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
|
|
80
|
+
*AccountsApi* | [**patchUpdateAccountName**](docs/AccountsApi.md#patchupdateaccountname) | **PATCH** /admin/accounts/{id}/name |
|
|
79
81
|
*AccountsApi* | [**patchUpdateAccountPhone**](docs/AccountsApi.md#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone |
|
|
80
82
|
*AccountsApi* | [**patchUpdateAccountVatNumber**](docs/AccountsApi.md#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber |
|
|
81
83
|
*AccountsApi* | [**patchUpdateCreditLimit**](docs/AccountsApi.md#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit |
|
|
@@ -175,6 +177,7 @@ Class | Method | HTTP request | Description
|
|
|
175
177
|
*Class3CXMultiTenantApi* | [**postGetMtNewDdis**](docs/Class3CXMultiTenantApi.md#postgetmtnewddis) | **POST** /tcx/mt/changes/ddis | Get 3CX MT New DDIs
|
|
176
178
|
*Class3CXMultiTenantApi* | [**postGetTenants**](docs/Class3CXMultiTenantApi.md#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant
|
|
177
179
|
*Class3CXMultiTenantApi* | [**postTrackMtChange**](docs/Class3CXMultiTenantApi.md#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change
|
|
180
|
+
*MiscApi* | [**postSendPassword**](docs/MiscApi.md#postsendpassword) | **POST** /admin/password/send |
|
|
178
181
|
*MyPBXToolsApi* | [**getGetRecording**](docs/MyPBXToolsApi.md#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance
|
|
179
182
|
*NumberPortingApi* | [**deleteGetAdminNumberPort**](docs/NumberPortingApi.md#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} |
|
|
180
183
|
*NumberPortingApi* | [**getCreateNumberPort**](docs/NumberPortingApi.md#getcreatenumberport) | **GET** /sip/numbers/ports |
|
|
@@ -252,6 +255,8 @@ Class | Method | HTTP request | Description
|
|
|
252
255
|
*ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
|
|
253
256
|
*ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
|
|
254
257
|
*ProvisioningApi* | [**postCreateMac**](docs/ProvisioningApi.md#postcreatemac) | **POST** /admin/provisioning/fanvil/macs |
|
|
258
|
+
*ReportsApi* | [**getGetStockReport**](docs/ReportsApi.md#getgetstockreport) | **GET** /reports/stock |
|
|
259
|
+
*ReportsApi* | [**postGenerateReport**](docs/ReportsApi.md#postgeneratereport) | **POST** /reports | Generate Reports
|
|
255
260
|
*SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
|
|
256
261
|
*SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
|
|
257
262
|
*SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
|
|
@@ -310,6 +315,10 @@ Class | Method | HTTP request | Description
|
|
|
310
315
|
*StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
|
|
311
316
|
*StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
|
|
312
317
|
*StockManagementApi* | [**putReceiveStockOrderItem**](docs/StockManagementApi.md#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item
|
|
318
|
+
*SuppliersApi* | [**getGetSupplierItem**](docs/SuppliersApi.md#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item
|
|
319
|
+
*SuppliersApi* | [**getGetSupplierItems**](docs/SuppliersApi.md#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items
|
|
320
|
+
*SuppliersApi* | [**getGetSuppliers**](docs/SuppliersApi.md#getgetsuppliers) | **GET** /suppliers | Get Suppliers
|
|
321
|
+
*SuppliersApi* | [**putGetSupplierItem**](docs/SuppliersApi.md#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product
|
|
313
322
|
*SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
|
|
314
323
|
*TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
|
|
315
324
|
*TicketsApi* | [**getGetTicket**](docs/TicketsApi.md#getgetticket) | **GET** /tickets/support/{id} |
|
|
@@ -346,6 +355,7 @@ Class | Method | HTTP request | Description
|
|
|
346
355
|
- [AttributeSetEnum](docs/AttributeSetEnum.md)
|
|
347
356
|
- [AuditLogEntity](docs/AuditLogEntity.md)
|
|
348
357
|
- [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
|
|
358
|
+
- [AxisDataDTO](docs/AxisDataDTO.md)
|
|
349
359
|
- [BasicItemDTO](docs/BasicItemDTO.md)
|
|
350
360
|
- [BasicProductDTO](docs/BasicProductDTO.md)
|
|
351
361
|
- [BatchDTO](docs/BatchDTO.md)
|
|
@@ -403,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
403
413
|
- [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
|
|
404
414
|
- [GetGetPrice200Response](docs/GetGetPrice200Response.md)
|
|
405
415
|
- [GetGetRecording200Response](docs/GetGetRecording200Response.md)
|
|
416
|
+
- [GraphDTO](docs/GraphDTO.md)
|
|
406
417
|
- [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
|
|
407
418
|
- [HostingRegionDTO](docs/HostingRegionDTO.md)
|
|
408
419
|
- [InstallationDetailsDTO](docs/InstallationDetailsDTO.md)
|
|
@@ -444,9 +455,12 @@ Class | Method | HTTP request | Description
|
|
|
444
455
|
- [OrderedItemEntity](docs/OrderedItemEntity.md)
|
|
445
456
|
- [OrderedItemModel](docs/OrderedItemModel.md)
|
|
446
457
|
- [PartnerDTO](docs/PartnerDTO.md)
|
|
458
|
+
- [PasswordSenderDTO](docs/PasswordSenderDTO.md)
|
|
459
|
+
- [PasswordSenderEntity](docs/PasswordSenderEntity.md)
|
|
447
460
|
- [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
|
|
448
461
|
- [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
|
|
449
462
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
|
463
|
+
- [PatchUpdateAccountNameRequest](docs/PatchUpdateAccountNameRequest.md)
|
|
450
464
|
- [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
|
|
451
465
|
- [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
|
|
452
466
|
- [PatchUpdateCreditLimitRequest](docs/PatchUpdateCreditLimitRequest.md)
|
|
@@ -465,6 +479,7 @@ Class | Method | HTTP request | Description
|
|
|
465
479
|
- [PriceListItemModel](docs/PriceListItemModel.md)
|
|
466
480
|
- [PrinterEntity](docs/PrinterEntity.md)
|
|
467
481
|
- [PrizesEntity](docs/PrizesEntity.md)
|
|
482
|
+
- [ProductDetailedSummaryDTO](docs/ProductDetailedSummaryDTO.md)
|
|
468
483
|
- [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
|
|
469
484
|
- [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
|
|
470
485
|
- [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
|
|
@@ -481,12 +496,14 @@ Class | Method | HTTP request | Description
|
|
|
481
496
|
- [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
|
|
482
497
|
- [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
|
|
483
498
|
- [RemoteStorageDTO](docs/RemoteStorageDTO.md)
|
|
499
|
+
- [ReportRequestDTO](docs/ReportRequestDTO.md)
|
|
484
500
|
- [ResourceNotReadyException](docs/ResourceNotReadyException.md)
|
|
485
501
|
- [RootAccessModel](docs/RootAccessModel.md)
|
|
486
502
|
- [S3BucketEntity](docs/S3BucketEntity.md)
|
|
487
503
|
- [SbcDTO](docs/SbcDTO.md)
|
|
488
504
|
- [ScannedItemModel](docs/ScannedItemModel.md)
|
|
489
505
|
- [ScopeModel](docs/ScopeModel.md)
|
|
506
|
+
- [SeriesDTO](docs/SeriesDTO.md)
|
|
490
507
|
- [ServiceHealthDTO](docs/ServiceHealthDTO.md)
|
|
491
508
|
- [ServiceStatusDTO](docs/ServiceStatusDTO.md)
|
|
492
509
|
- [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
|
|
@@ -536,11 +553,16 @@ Class | Method | HTTP request | Description
|
|
|
536
553
|
- [StockProductPriceModel](docs/StockProductPriceModel.md)
|
|
537
554
|
- [StockProductSummariesModel](docs/StockProductSummariesModel.md)
|
|
538
555
|
- [StockProductSummaryModel](docs/StockProductSummaryModel.md)
|
|
556
|
+
- [StockReportItemModel](docs/StockReportItemModel.md)
|
|
557
|
+
- [StockReportModel](docs/StockReportModel.md)
|
|
539
558
|
- [StockTransactionsEntity](docs/StockTransactionsEntity.md)
|
|
540
559
|
- [SupplierEntity](docs/SupplierEntity.md)
|
|
541
560
|
- [SupplierItemEntity](docs/SupplierItemEntity.md)
|
|
542
561
|
- [SupplierItemModel](docs/SupplierItemModel.md)
|
|
562
|
+
- [SupplierItemsResultsDTO](docs/SupplierItemsResultsDTO.md)
|
|
543
563
|
- [SupplierModel](docs/SupplierModel.md)
|
|
564
|
+
- [SupplierProductModel](docs/SupplierProductModel.md)
|
|
565
|
+
- [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
|
|
544
566
|
- [SupportTicketModel](docs/SupportTicketModel.md)
|
|
545
567
|
- [TableHistoryEntity](docs/TableHistoryEntity.md)
|
|
546
568
|
- [TcxBackupEntity](docs/TcxBackupEntity.md)
|
|
@@ -549,7 +571,6 @@ Class | Method | HTTP request | Description
|
|
|
549
571
|
- [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
|
|
550
572
|
- [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
|
|
551
573
|
- [TcxExtsEntity](docs/TcxExtsEntity.md)
|
|
552
|
-
- [TcxHostingPricingEntity](docs/TcxHostingPricingEntity.md)
|
|
553
574
|
- [TcxInstallationModel](docs/TcxInstallationModel.md)
|
|
554
575
|
- [TcxInstallationsModel](docs/TcxInstallationsModel.md)
|
|
555
576
|
- [TcxKeySummaryDTO](docs/TcxKeySummaryDTO.md)
|