yellowgrid-api-ts 3.2.198 → 3.2.199-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.
Files changed (96) hide show
  1. package/.openapi-generator/FILES +309 -296
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +25 -2
  4. package/api.ts +6989 -584
  5. package/base.ts +26 -2
  6. package/common.ts +39 -16
  7. package/config.json +3 -3
  8. package/configuration.ts +21 -27
  9. package/dist/api.d.ts +5833 -84
  10. package/dist/api.js +1952 -502
  11. package/dist/base.d.ts +25 -1
  12. package/dist/base.js +21 -2
  13. package/dist/common.d.ts +36 -5
  14. package/dist/common.js +39 -17
  15. package/dist/configuration.d.ts +18 -25
  16. package/dist/configuration.js +4 -4
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/GroupEnum.d.ts +43 -0
  20. package/dist/models/GroupEnum.js +45 -0
  21. package/dist/models/HostingPriceListEnum.d.ts +5 -0
  22. package/dist/models/HostingPriceListEnum.js +5 -0
  23. package/dist/models/ReportEnum.d.ts +38 -0
  24. package/dist/models/ReportEnum.js +40 -0
  25. package/docs/AbstractItemDiscountModel.md +21 -0
  26. package/docs/AbstractOrderRequestDTO.md +1 -1
  27. package/docs/AccountsApi.md +115 -1
  28. package/docs/AdminOrderRequestDTO.md +1 -1
  29. package/docs/BillingApi.md +1 -1
  30. package/docs/CRMApi.md +1 -1
  31. package/docs/Class3CXApi.md +1 -1
  32. package/docs/Class3CXInstallationWizardApi.md +1 -1
  33. package/docs/Class3CXInstallationsApi.md +1 -1
  34. package/docs/Class3CXIntegrationsApi.md +1 -1
  35. package/docs/Class3CXMultiTenantApi.md +1 -1
  36. package/docs/CrmActivityDTO.md +3 -3
  37. package/docs/CrmDateActivitiesDTO.md +1 -1
  38. package/docs/CustomerOrderRequestDTO.md +1 -1
  39. package/docs/DetailedOrderRequestDTO.md +1 -1
  40. package/docs/GetCheckMacExists200Response.md +20 -0
  41. package/docs/MacAddressDTO.md +23 -0
  42. package/docs/MiscApi.md +63 -0
  43. package/docs/MyPBXToolsApi.md +1 -1
  44. package/docs/NumberPortModel.md +51 -0
  45. package/docs/NumberPortingApi.md +1 -1
  46. package/docs/OAuth20Api.md +1 -1
  47. package/docs/OrdersApi.md +1 -1
  48. package/docs/PartnerDTO.md +1 -1
  49. package/docs/PasswordSenderDTO.md +37 -0
  50. package/docs/PasswordSenderEntity.md +33 -0
  51. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  52. package/docs/PatchUpdateAccountNameRequest.md +20 -0
  53. package/docs/PostAddAdminNoteRequest.md +20 -0
  54. package/docs/PostGetProductRequest.md +24 -0
  55. package/docs/PricingApi.md +1 -1
  56. package/docs/ProductDetailedSummaryDTO.md +41 -0
  57. package/docs/ProductSearchDTO.md +37 -0
  58. package/docs/ProductSummaryDTO.md +1 -3
  59. package/docs/ProductsApi.md +5 -5
  60. package/docs/ProspectDTO.md +2 -2
  61. package/docs/ProspectsApi.md +1 -1
  62. package/docs/ProvisioningApi.md +167 -1
  63. package/docs/RecordingsBackupInfoDTO.md +2 -2
  64. package/docs/ReportRequestDTO.md +35 -0
  65. package/docs/ReportsApi.md +107 -0
  66. package/docs/SIPTrunksApi.md +1 -1
  67. package/docs/SMSApi.md +1 -1
  68. package/docs/ServicesApi.md +1 -1
  69. package/docs/ShipmentRequestDTO.md +2 -2
  70. package/docs/ShippingApi.md +1 -1
  71. package/docs/StockManagementApi.md +1 -1
  72. package/docs/StockReportItemModel.md +31 -0
  73. package/docs/StockReportModel.md +29 -0
  74. package/docs/SupplierItemModel.md +2 -0
  75. package/docs/SupplierItemsResultsDTO.md +21 -0
  76. package/docs/SupplierProductModel.md +25 -0
  77. package/docs/SupplierProductResultsModel.md +27 -0
  78. package/docs/SuppliersApi.md +230 -0
  79. package/docs/SystemApi.md +1 -1
  80. package/docs/TcxInstallationDetailsModel.md +45 -0
  81. package/docs/TcxInstallationModel.md +6 -0
  82. package/docs/TcxKeySummaryDTO.md +1 -1
  83. package/docs/TelephonySupportTicketModel.md +41 -0
  84. package/docs/TicketsApi.md +1 -1
  85. package/docs/WebhooksApi.md +1 -1
  86. package/getEnums.php +31 -31
  87. package/hs_err_pid16044.log +249 -0
  88. package/hs_err_pid44560.log +249 -0
  89. package/hs_err_pid53988.log +249 -0
  90. package/hs_err_pid58728.log +40 -0
  91. package/index.ts +1 -1
  92. package/models/GroupEnum.ts +44 -0
  93. package/models/HostingPriceListEnum.ts +5 -0
  94. package/models/ReportEnum.ts +39 -0
  95. package/openapitools.json +1 -1
  96. 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://bitbucket.org*
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 |
@@ -243,12 +246,17 @@ Class | Method | HTTP request | Description
243
246
  *ProspectsApi* | [**getRemoveFromProspects**](docs/ProspectsApi.md#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects
244
247
  *ProspectsApi* | [**getSetCallback**](docs/ProspectsApi.md#getsetcallback) | **GET** /accounts/prospects/{xero_id}/date | Set Call Back Date
245
248
  *ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
249
+ *ProvisioningApi* | [**deleteCheckMacExists**](docs/ProvisioningApi.md#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} |
246
250
  *ProvisioningApi* | [**deleteDeleteFanvilGroup**](docs/ProvisioningApi.md#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS
251
+ *ProvisioningApi* | [**getCheckMacExists**](docs/ProvisioningApi.md#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} |
247
252
  *ProvisioningApi* | [**getGetFanvilEncryptionKey**](docs/ProvisioningApi.md#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key
248
253
  *ProvisioningApi* | [**getGetFanvilGroupMacs**](docs/ProvisioningApi.md#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS
249
254
  *ProvisioningApi* | [**getGetGroups**](docs/ProvisioningApi.md#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID
250
255
  *ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
251
256
  *ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
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
252
260
  *SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
253
261
  *SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
254
262
  *SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
@@ -307,6 +315,10 @@ Class | Method | HTTP request | Description
307
315
  *StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
308
316
  *StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
309
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
310
322
  *SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
311
323
  *TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
312
324
  *TicketsApi* | [**getGetTicket**](docs/TicketsApi.md#getgetticket) | **GET** /tickets/support/{id} |
@@ -397,6 +409,7 @@ Class | Method | HTTP request | Description
397
409
  - [FreshdeskTicketEntity](docs/FreshdeskTicketEntity.md)
398
410
  - [FtpAccountsEntity](docs/FtpAccountsEntity.md)
399
411
  - [GenericFileModel](docs/GenericFileModel.md)
412
+ - [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
400
413
  - [GetGetPrice200Response](docs/GetGetPrice200Response.md)
401
414
  - [GetGetRecording200Response](docs/GetGetRecording200Response.md)
402
415
  - [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
@@ -416,6 +429,7 @@ Class | Method | HTTP request | Description
416
429
  - [ItemEntity](docs/ItemEntity.md)
417
430
  - [LinkedOrderEntity](docs/LinkedOrderEntity.md)
418
431
  - [MFARequiredModel](docs/MFARequiredModel.md)
432
+ - [MacAddressDTO](docs/MacAddressDTO.md)
419
433
  - [MonthlyUsageModel](docs/MonthlyUsageModel.md)
420
434
  - [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
421
435
  - [NavigationModel](docs/NavigationModel.md)
@@ -439,9 +453,12 @@ Class | Method | HTTP request | Description
439
453
  - [OrderedItemEntity](docs/OrderedItemEntity.md)
440
454
  - [OrderedItemModel](docs/OrderedItemModel.md)
441
455
  - [PartnerDTO](docs/PartnerDTO.md)
456
+ - [PasswordSenderDTO](docs/PasswordSenderDTO.md)
457
+ - [PasswordSenderEntity](docs/PasswordSenderEntity.md)
442
458
  - [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
443
459
  - [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
444
460
  - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
461
+ - [PatchUpdateAccountNameRequest](docs/PatchUpdateAccountNameRequest.md)
445
462
  - [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
446
463
  - [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
447
464
  - [PatchUpdateCreditLimitRequest](docs/PatchUpdateCreditLimitRequest.md)
@@ -460,6 +477,7 @@ Class | Method | HTTP request | Description
460
477
  - [PriceListItemModel](docs/PriceListItemModel.md)
461
478
  - [PrinterEntity](docs/PrinterEntity.md)
462
479
  - [PrizesEntity](docs/PrizesEntity.md)
480
+ - [ProductDetailedSummaryDTO](docs/ProductDetailedSummaryDTO.md)
463
481
  - [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
464
482
  - [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
465
483
  - [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
@@ -476,6 +494,7 @@ Class | Method | HTTP request | Description
476
494
  - [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
477
495
  - [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
478
496
  - [RemoteStorageDTO](docs/RemoteStorageDTO.md)
497
+ - [ReportRequestDTO](docs/ReportRequestDTO.md)
479
498
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
480
499
  - [RootAccessModel](docs/RootAccessModel.md)
481
500
  - [S3BucketEntity](docs/S3BucketEntity.md)
@@ -531,11 +550,16 @@ Class | Method | HTTP request | Description
531
550
  - [StockProductPriceModel](docs/StockProductPriceModel.md)
532
551
  - [StockProductSummariesModel](docs/StockProductSummariesModel.md)
533
552
  - [StockProductSummaryModel](docs/StockProductSummaryModel.md)
553
+ - [StockReportItemModel](docs/StockReportItemModel.md)
554
+ - [StockReportModel](docs/StockReportModel.md)
534
555
  - [StockTransactionsEntity](docs/StockTransactionsEntity.md)
535
556
  - [SupplierEntity](docs/SupplierEntity.md)
536
557
  - [SupplierItemEntity](docs/SupplierItemEntity.md)
537
558
  - [SupplierItemModel](docs/SupplierItemModel.md)
559
+ - [SupplierItemsResultsDTO](docs/SupplierItemsResultsDTO.md)
538
560
  - [SupplierModel](docs/SupplierModel.md)
561
+ - [SupplierProductModel](docs/SupplierProductModel.md)
562
+ - [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
539
563
  - [SupportTicketModel](docs/SupportTicketModel.md)
540
564
  - [TableHistoryEntity](docs/TableHistoryEntity.md)
541
565
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
@@ -544,7 +568,6 @@ Class | Method | HTTP request | Description
544
568
  - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
545
569
  - [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
546
570
  - [TcxExtsEntity](docs/TcxExtsEntity.md)
547
- - [TcxHostingPricingEntity](docs/TcxHostingPricingEntity.md)
548
571
  - [TcxInstallationModel](docs/TcxInstallationModel.md)
549
572
  - [TcxInstallationsModel](docs/TcxInstallationsModel.md)
550
573
  - [TcxKeySummaryDTO](docs/TcxKeySummaryDTO.md)