yellowgrid-api-ts 3.2.251-dev.0 → 3.2.252-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 (25) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +14 -0
  3. package/api.ts +882 -137
  4. package/dist/api.d.ts +516 -117
  5. package/dist/api.js +784 -47
  6. package/docs/Class3CXInstallationWizardApi.md +384 -0
  7. package/docs/Class3CXIntegrationsApi.md +52 -0
  8. package/docs/EngineeredWizardRequestModel.md +23 -0
  9. package/docs/OAuth20Api.md +1 -1
  10. package/docs/OrdersApi.md +59 -0
  11. package/docs/SearchSchoolModel.md +35 -0
  12. package/docs/TcxEngineerTaskDTO.md +29 -0
  13. package/docs/TcxEngineeringDTO.md +37 -0
  14. package/docs/TcxExtsEntity.md +8 -8
  15. package/docs/TcxNumbersEntity.md +3 -3
  16. package/docs/TcxOfficeHoursEntity.md +15 -15
  17. package/docs/TcxPhoneModel.md +6 -6
  18. package/docs/TcxPhonesEntity.md +6 -6
  19. package/docs/TcxSbcEntity.md +16 -16
  20. package/docs/TcxSbcModel.md +16 -16
  21. package/docs/TcxSetupEntity.md +25 -25
  22. package/docs/TcxSipTrunksEntity.md +13 -13
  23. package/docs/TcxSummaryDTO.md +21 -0
  24. package/docs/TcxWizardModel.md +11 -9
  25. package/package.json +1 -1
package/.openapi-generator/FILES CHANGED
@@ -106,6 +106,7 @@ docs/EdTechProSchoolModel.md
106
106
  docs/EdTechProSchoolsModel.md
107
107
  docs/EdTechProSetupModel.md
108
108
  docs/EmailRequestModel.md
109
+ docs/EngineeredWizardRequestModel.md
109
110
  docs/EventDTO.md
110
111
  docs/EventRequestDTO.md
111
112
  docs/EventSubscriptionModel.md
@@ -281,6 +282,7 @@ docs/ScannedItemModel.md
281
282
  docs/ScopeModel.md
282
283
  docs/Sdr.md
283
284
  docs/SdrReferenceType.md
285
+ docs/SearchSchoolModel.md
284
286
  docs/SerialNumberRequestModel.md
285
287
  docs/SeriesDTO.md
286
288
  docs/Service.md
@@ -361,6 +363,8 @@ docs/TcxBackupModel.md
361
363
  docs/TcxBillingEntity.md
362
364
  docs/TcxBulkLicenceDetailsModel.md
363
365
  docs/TcxDeadLicenceEntity.md
366
+ docs/TcxEngineerTaskDTO.md
367
+ docs/TcxEngineeringDTO.md
364
368
  docs/TcxExtsEntity.md
365
369
  docs/TcxInstallationModel.md
366
370
  docs/TcxInstallationsModel.md
@@ -384,6 +388,7 @@ docs/TcxSbcResponseDTO.md
384
388
  docs/TcxSetupEntity.md
385
389
  docs/TcxSetupsModel.md
386
390
  docs/TcxSipTrunksEntity.md
391
+ docs/TcxSummaryDTO.md
387
392
  docs/TcxTemplateXmlEnum.md
388
393
  docs/TcxUsersEntity.md
389
394
  docs/TcxWizardConfigModel.md
package/README.md CHANGED
@@ -196,6 +196,7 @@ Class | Method | HTTP request | Description
196
196
  *Class3CXInstallationWizardApi* | [**getGetHostingRegions**](docs/Class3CXInstallationWizardApi.md#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions
197
197
  *Class3CXInstallationWizardApi* | [**getGetInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status
198
198
  *Class3CXInstallationWizardApi* | [**getGetInstanceInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status
199
+ *Class3CXInstallationWizardApi* | [**getGetOrderItems**](docs/Class3CXInstallationWizardApi.md#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\'s licence key
199
200
  *Class3CXInstallationWizardApi* | [**getGetPbxIpAddress**](docs/Class3CXInstallationWizardApi.md#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address
200
201
  *Class3CXInstallationWizardApi* | [**getGetSipTrunkTcxWizard**](docs/Class3CXInstallationWizardApi.md#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk
201
202
  *Class3CXInstallationWizardApi* | [**getGetSipTrunksTcxWizard**](docs/Class3CXInstallationWizardApi.md#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks
@@ -204,7 +205,13 @@ Class | Method | HTTP request | Description
204
205
  *Class3CXInstallationWizardApi* | [**patchAddNumbers**](docs/Class3CXInstallationWizardApi.md#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers
205
206
  *Class3CXInstallationWizardApi* | [**patchAddPhones**](docs/Class3CXInstallationWizardApi.md#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones
206
207
  *Class3CXInstallationWizardApi* | [**patchAddSbcs**](docs/Class3CXInstallationWizardApi.md#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs
208
+ *Class3CXInstallationWizardApi* | [**patchAllocateEngineer**](docs/Class3CXInstallationWizardApi.md#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer |
207
209
  *Class3CXInstallationWizardApi* | [**patchGetWizard**](docs/Class3CXInstallationWizardApi.md#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard
210
+ *Class3CXInstallationWizardApi* | [**patchMarkEngineerTaskAsComplete**](docs/Class3CXInstallationWizardApi.md#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete |
211
+ *Class3CXInstallationWizardApi* | [**patchUpdateEngineerTaskNote**](docs/Class3CXInstallationWizardApi.md#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note |
212
+ *Class3CXInstallationWizardApi* | [**patchUpdateGoLiveDate**](docs/Class3CXInstallationWizardApi.md#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date |
213
+ *Class3CXInstallationWizardApi* | [**patchUpdateNote**](docs/Class3CXInstallationWizardApi.md#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note |
214
+ *Class3CXInstallationWizardApi* | [**patchUpdateSpec**](docs/Class3CXInstallationWizardApi.md#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec |
208
215
  *Class3CXInstallationWizardApi* | [**postAddExtensions**](docs/Class3CXInstallationWizardApi.md#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard
209
216
  *Class3CXInstallationWizardApi* | [**postAddNumbers**](docs/Class3CXInstallationWizardApi.md#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard
210
217
  *Class3CXInstallationWizardApi* | [**postAddPhones**](docs/Class3CXInstallationWizardApi.md#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard
@@ -241,6 +248,7 @@ Class | Method | HTTP request | Description
241
248
  *Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices |
242
249
  *Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools |
243
250
  *Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts |
251
+ *Class3CXIntegrationsApi* | [**getSearchSchools**](docs/Class3CXIntegrationsApi.md#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools |
244
252
  *Class3CXIntegrationsApi* | [**patchUpdateEtpOrderReference**](docs/Class3CXIntegrationsApi.md#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference |
245
253
  *Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders |
246
254
  *Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades |
@@ -291,6 +299,7 @@ Class | Method | HTTP request | Description
291
299
  *OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
292
300
  *OrdersApi* | [**postCreatePortalOrderLegacy**](docs/OrdersApi.md#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal
293
301
  *OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
302
+ *OrdersApi* | [**postCreateWizardFromOrder**](docs/OrdersApi.md#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard |
294
303
  *OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
295
304
  *OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
296
305
  *OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
@@ -534,6 +543,7 @@ Class | Method | HTTP request | Description
534
543
  - [EdTechProSchoolsModel](docs/EdTechProSchoolsModel.md)
535
544
  - [EdTechProSetupModel](docs/EdTechProSetupModel.md)
536
545
  - [EmailRequestModel](docs/EmailRequestModel.md)
546
+ - [EngineeredWizardRequestModel](docs/EngineeredWizardRequestModel.md)
537
547
  - [EventDTO](docs/EventDTO.md)
538
548
  - [EventRequestDTO](docs/EventRequestDTO.md)
539
549
  - [EventSubscriptionModel](docs/EventSubscriptionModel.md)
@@ -695,6 +705,7 @@ Class | Method | HTTP request | Description
695
705
  - [ScopeModel](docs/ScopeModel.md)
696
706
  - [Sdr](docs/Sdr.md)
697
707
  - [SdrReferenceType](docs/SdrReferenceType.md)
708
+ - [SearchSchoolModel](docs/SearchSchoolModel.md)
698
709
  - [SerialNumberRequestModel](docs/SerialNumberRequestModel.md)
699
710
  - [SeriesDTO](docs/SeriesDTO.md)
700
711
  - [Service](docs/Service.md)
@@ -770,6 +781,8 @@ Class | Method | HTTP request | Description
770
781
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
771
782
  - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
772
783
  - [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
784
+ - [TcxEngineerTaskDTO](docs/TcxEngineerTaskDTO.md)
785
+ - [TcxEngineeringDTO](docs/TcxEngineeringDTO.md)
773
786
  - [TcxExtsEntity](docs/TcxExtsEntity.md)
774
787
  - [TcxInstallationModel](docs/TcxInstallationModel.md)
775
788
  - [TcxInstallationsModel](docs/TcxInstallationsModel.md)
@@ -793,6 +806,7 @@ Class | Method | HTTP request | Description
793
806
  - [TcxSetupEntity](docs/TcxSetupEntity.md)
794
807
  - [TcxSetupsModel](docs/TcxSetupsModel.md)
795
808
  - [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
809
+ - [TcxSummaryDTO](docs/TcxSummaryDTO.md)
796
810
  - [TcxTemplateXmlEnum](docs/TcxTemplateXmlEnum.md)
797
811
  - [TcxUsersEntity](docs/TcxUsersEntity.md)
798
812
  - [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)