yellowgrid-api-ts 3.2.208 → 3.2.209-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 +317 -299
- package/.openapi-generator/VERSION +1 -1
- package/README.md +28 -2
- package/api.ts +7152 -665
- 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 +6013 -120
- package/dist/api.js +1861 -522
- 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 +13 -0
- package/dist/models/GraphTypeEnum.js +15 -0
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/HostingPriceListEnum.d.ts +10 -0
- package/dist/models/HostingPriceListEnum.js +10 -0
- package/dist/models/ReportEnum.d.ts +53 -0
- package/dist/models/ReportEnum.js +55 -0
- package/docs/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +1 -1
- package/docs/AccountsApi.md +163 -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/CustomerCoordinatesDTO.md +31 -0
- package/docs/CustomerOrderRequestDTO.md +1 -1
- package/docs/DetailedOrderRequestDTO.md +1 -1
- package/docs/GraphDTO.md +33 -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/PostGenerateReport200Response.md +36 -0
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PricingApi.md +1 -1
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSummaryDTO.md +1 -1
- package/docs/ProductsApi.md +1 -1
- 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/TableDTO.md +25 -0
- package/docs/TableDataDTO.md +21 -0
- package/docs/TableRowDTO.md +21 -0
- 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 +14 -0
- package/models/GroupEnum.ts +44 -0
- package/models/HostingPriceListEnum.ts +10 -0
- package/models/ReportEnum.ts +54 -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
|
------------ | ------------- | ------------- | -------------
|
|
@@ -64,8 +64,10 @@ Class | Method | HTTP request | Description
|
|
|
64
64
|
*AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
|
|
65
65
|
*AccountsApi* | [**getGetCustomerAccountsList**](docs/AccountsApi.md#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list |
|
|
66
66
|
*AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
|
|
67
|
+
*AccountsApi* | [**getGetCustomerMap**](docs/AccountsApi.md#getgetcustomermap) | **GET** /admin/accounts/customer/map |
|
|
67
68
|
*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
|
|
68
69
|
*AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
|
|
70
|
+
*AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
|
|
69
71
|
*AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner |
|
|
70
72
|
*AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
|
|
71
73
|
*AccountsApi* | [**patchSetAccountStatus**](docs/AccountsApi.md#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} |
|
|
@@ -76,6 +78,7 @@ Class | Method | HTTP request | Description
|
|
|
76
78
|
*AccountsApi* | [**patchUpdateAccountCname**](docs/AccountsApi.md#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname |
|
|
77
79
|
*AccountsApi* | [**patchUpdateAccountCompanyNumber**](docs/AccountsApi.md#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber |
|
|
78
80
|
*AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
|
|
81
|
+
*AccountsApi* | [**patchUpdateAccountName**](docs/AccountsApi.md#patchupdateaccountname) | **PATCH** /admin/accounts/{id}/name |
|
|
79
82
|
*AccountsApi* | [**patchUpdateAccountPhone**](docs/AccountsApi.md#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone |
|
|
80
83
|
*AccountsApi* | [**patchUpdateAccountVatNumber**](docs/AccountsApi.md#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber |
|
|
81
84
|
*AccountsApi* | [**patchUpdateCreditLimit**](docs/AccountsApi.md#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit |
|
|
@@ -175,6 +178,7 @@ Class | Method | HTTP request | Description
|
|
|
175
178
|
*Class3CXMultiTenantApi* | [**postGetMtNewDdis**](docs/Class3CXMultiTenantApi.md#postgetmtnewddis) | **POST** /tcx/mt/changes/ddis | Get 3CX MT New DDIs
|
|
176
179
|
*Class3CXMultiTenantApi* | [**postGetTenants**](docs/Class3CXMultiTenantApi.md#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant
|
|
177
180
|
*Class3CXMultiTenantApi* | [**postTrackMtChange**](docs/Class3CXMultiTenantApi.md#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change
|
|
181
|
+
*MiscApi* | [**postSendPassword**](docs/MiscApi.md#postsendpassword) | **POST** /admin/password/send |
|
|
178
182
|
*MyPBXToolsApi* | [**getGetRecording**](docs/MyPBXToolsApi.md#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance
|
|
179
183
|
*NumberPortingApi* | [**deleteGetAdminNumberPort**](docs/NumberPortingApi.md#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} |
|
|
180
184
|
*NumberPortingApi* | [**getCreateNumberPort**](docs/NumberPortingApi.md#getcreatenumberport) | **GET** /sip/numbers/ports |
|
|
@@ -252,6 +256,8 @@ Class | Method | HTTP request | Description
|
|
|
252
256
|
*ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
|
|
253
257
|
*ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
|
|
254
258
|
*ProvisioningApi* | [**postCreateMac**](docs/ProvisioningApi.md#postcreatemac) | **POST** /admin/provisioning/fanvil/macs |
|
|
259
|
+
*ReportsApi* | [**getGetStockReport**](docs/ReportsApi.md#getgetstockreport) | **GET** /reports/stock |
|
|
260
|
+
*ReportsApi* | [**postGenerateReport**](docs/ReportsApi.md#postgeneratereport) | **POST** /reports | Generate Reports
|
|
255
261
|
*SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
|
|
256
262
|
*SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
|
|
257
263
|
*SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
|
|
@@ -310,6 +316,10 @@ Class | Method | HTTP request | Description
|
|
|
310
316
|
*StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
|
|
311
317
|
*StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
|
|
312
318
|
*StockManagementApi* | [**putReceiveStockOrderItem**](docs/StockManagementApi.md#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item
|
|
319
|
+
*SuppliersApi* | [**getGetSupplierItem**](docs/SuppliersApi.md#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item
|
|
320
|
+
*SuppliersApi* | [**getGetSupplierItems**](docs/SuppliersApi.md#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items
|
|
321
|
+
*SuppliersApi* | [**getGetSuppliers**](docs/SuppliersApi.md#getgetsuppliers) | **GET** /suppliers | Get Suppliers
|
|
322
|
+
*SuppliersApi* | [**putGetSupplierItem**](docs/SuppliersApi.md#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product
|
|
313
323
|
*SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
|
|
314
324
|
*TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
|
|
315
325
|
*TicketsApi* | [**getGetTicket**](docs/TicketsApi.md#getgetticket) | **GET** /tickets/support/{id} |
|
|
@@ -346,6 +356,7 @@ Class | Method | HTTP request | Description
|
|
|
346
356
|
- [AttributeSetEnum](docs/AttributeSetEnum.md)
|
|
347
357
|
- [AuditLogEntity](docs/AuditLogEntity.md)
|
|
348
358
|
- [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
|
|
359
|
+
- [AxisDataDTO](docs/AxisDataDTO.md)
|
|
349
360
|
- [BasicItemDTO](docs/BasicItemDTO.md)
|
|
350
361
|
- [BasicProductDTO](docs/BasicProductDTO.md)
|
|
351
362
|
- [BatchDTO](docs/BatchDTO.md)
|
|
@@ -372,6 +383,7 @@ Class | Method | HTTP request | Description
|
|
|
372
383
|
- [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
|
|
373
384
|
- [CrmNoteEntity](docs/CrmNoteEntity.md)
|
|
374
385
|
- [CrmNoteModel](docs/CrmNoteModel.md)
|
|
386
|
+
- [CustomerCoordinatesDTO](docs/CustomerCoordinatesDTO.md)
|
|
375
387
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
376
388
|
- [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
|
|
377
389
|
- [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)
|
|
@@ -403,6 +415,7 @@ Class | Method | HTTP request | Description
|
|
|
403
415
|
- [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
|
|
404
416
|
- [GetGetPrice200Response](docs/GetGetPrice200Response.md)
|
|
405
417
|
- [GetGetRecording200Response](docs/GetGetRecording200Response.md)
|
|
418
|
+
- [GraphDTO](docs/GraphDTO.md)
|
|
406
419
|
- [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
|
|
407
420
|
- [HostingRegionDTO](docs/HostingRegionDTO.md)
|
|
408
421
|
- [InstallationDetailsDTO](docs/InstallationDetailsDTO.md)
|
|
@@ -444,9 +457,12 @@ Class | Method | HTTP request | Description
|
|
|
444
457
|
- [OrderedItemEntity](docs/OrderedItemEntity.md)
|
|
445
458
|
- [OrderedItemModel](docs/OrderedItemModel.md)
|
|
446
459
|
- [PartnerDTO](docs/PartnerDTO.md)
|
|
460
|
+
- [PasswordSenderDTO](docs/PasswordSenderDTO.md)
|
|
461
|
+
- [PasswordSenderEntity](docs/PasswordSenderEntity.md)
|
|
447
462
|
- [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
|
|
448
463
|
- [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
|
|
449
464
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
|
465
|
+
- [PatchUpdateAccountNameRequest](docs/PatchUpdateAccountNameRequest.md)
|
|
450
466
|
- [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
|
|
451
467
|
- [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
|
|
452
468
|
- [PatchUpdateCreditLimitRequest](docs/PatchUpdateCreditLimitRequest.md)
|
|
@@ -458,6 +474,7 @@ Class | Method | HTTP request | Description
|
|
|
458
474
|
- [PortalLoginModel](docs/PortalLoginModel.md)
|
|
459
475
|
- [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
|
|
460
476
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
477
|
+
- [PostGenerateReport200Response](docs/PostGenerateReport200Response.md)
|
|
461
478
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
462
479
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
463
480
|
- [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
|
|
@@ -482,12 +499,14 @@ Class | Method | HTTP request | Description
|
|
|
482
499
|
- [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
|
|
483
500
|
- [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
|
|
484
501
|
- [RemoteStorageDTO](docs/RemoteStorageDTO.md)
|
|
502
|
+
- [ReportRequestDTO](docs/ReportRequestDTO.md)
|
|
485
503
|
- [ResourceNotReadyException](docs/ResourceNotReadyException.md)
|
|
486
504
|
- [RootAccessModel](docs/RootAccessModel.md)
|
|
487
505
|
- [S3BucketEntity](docs/S3BucketEntity.md)
|
|
488
506
|
- [SbcDTO](docs/SbcDTO.md)
|
|
489
507
|
- [ScannedItemModel](docs/ScannedItemModel.md)
|
|
490
508
|
- [ScopeModel](docs/ScopeModel.md)
|
|
509
|
+
- [SeriesDTO](docs/SeriesDTO.md)
|
|
491
510
|
- [ServiceHealthDTO](docs/ServiceHealthDTO.md)
|
|
492
511
|
- [ServiceStatusDTO](docs/ServiceStatusDTO.md)
|
|
493
512
|
- [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
|
|
@@ -537,20 +556,27 @@ Class | Method | HTTP request | Description
|
|
|
537
556
|
- [StockProductPriceModel](docs/StockProductPriceModel.md)
|
|
538
557
|
- [StockProductSummariesModel](docs/StockProductSummariesModel.md)
|
|
539
558
|
- [StockProductSummaryModel](docs/StockProductSummaryModel.md)
|
|
559
|
+
- [StockReportItemModel](docs/StockReportItemModel.md)
|
|
560
|
+
- [StockReportModel](docs/StockReportModel.md)
|
|
540
561
|
- [StockTransactionsEntity](docs/StockTransactionsEntity.md)
|
|
541
562
|
- [SupplierEntity](docs/SupplierEntity.md)
|
|
542
563
|
- [SupplierItemEntity](docs/SupplierItemEntity.md)
|
|
543
564
|
- [SupplierItemModel](docs/SupplierItemModel.md)
|
|
565
|
+
- [SupplierItemsResultsDTO](docs/SupplierItemsResultsDTO.md)
|
|
544
566
|
- [SupplierModel](docs/SupplierModel.md)
|
|
567
|
+
- [SupplierProductModel](docs/SupplierProductModel.md)
|
|
568
|
+
- [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
|
|
545
569
|
- [SupportTicketModel](docs/SupportTicketModel.md)
|
|
570
|
+
- [TableDTO](docs/TableDTO.md)
|
|
571
|
+
- [TableDataDTO](docs/TableDataDTO.md)
|
|
546
572
|
- [TableHistoryEntity](docs/TableHistoryEntity.md)
|
|
573
|
+
- [TableRowDTO](docs/TableRowDTO.md)
|
|
547
574
|
- [TcxBackupEntity](docs/TcxBackupEntity.md)
|
|
548
575
|
- [TcxBackupModel](docs/TcxBackupModel.md)
|
|
549
576
|
- [TcxBillingEntity](docs/TcxBillingEntity.md)
|
|
550
577
|
- [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
|
|
551
578
|
- [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
|
|
552
579
|
- [TcxExtsEntity](docs/TcxExtsEntity.md)
|
|
553
|
-
- [TcxHostingPricingEntity](docs/TcxHostingPricingEntity.md)
|
|
554
580
|
- [TcxInstallationModel](docs/TcxInstallationModel.md)
|
|
555
581
|
- [TcxInstallationsModel](docs/TcxInstallationsModel.md)
|
|
556
582
|
- [TcxKeySummaryDTO](docs/TcxKeySummaryDTO.md)
|