yellowgrid-api-ts 3.2.68-dev.0 → 3.2.70-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 +7 -2
- package/README.md +21 -2
- package/api.ts +1703 -199
- package/dist/api.d.ts +1018 -139
- package/dist/api.js +1379 -97
- package/dist/models/EventStatusEnum.d.ts +18 -0
- package/dist/models/EventStatusEnum.js +20 -0
- package/dist/models/PortStatusEnum.d.ts +18 -0
- package/dist/models/PortStatusEnum.js +20 -0
- package/docs/Class3CXMultiTenantApi.md +55 -0
- package/docs/NumberPortDTO.md +55 -0
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortRangeDTO.md +33 -0
- package/docs/NumberPortRangeRequestDTO.md +27 -0
- package/docs/NumberPortingApi.md +668 -0
- package/docs/NumberPortsModel.md +27 -0
- package/docs/OAuth20Api.md +3 -3
- package/docs/OrdersApi.md +14 -14
- package/docs/SIPTrunksApi.md +55 -0
- package/docs/ShipmentDTO.md +2 -0
- package/docs/SupportTicketModel.md +41 -0
- package/docs/TicketsApi.md +8 -8
- package/models/EventStatusEnum.ts +19 -0
- package/models/PortStatusEnum.ts +19 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
.gitignore
|
|
2
2
|
.npmignore
|
|
3
|
-
.openapi-generator-ignore
|
|
4
3
|
README.md
|
|
5
4
|
api.ts
|
|
6
5
|
base.ts
|
|
@@ -99,6 +98,12 @@ docs/MonthlyUsageModel.md
|
|
|
99
98
|
docs/MultiTenantChangeResponseModel.md
|
|
100
99
|
docs/MyPBXToolsApi.md
|
|
101
100
|
docs/NavigationModel.md
|
|
101
|
+
docs/NumberPortDTO.md
|
|
102
|
+
docs/NumberPortModel.md
|
|
103
|
+
docs/NumberPortRangeDTO.md
|
|
104
|
+
docs/NumberPortRangeRequestDTO.md
|
|
105
|
+
docs/NumberPortingApi.md
|
|
106
|
+
docs/NumberPortsModel.md
|
|
102
107
|
docs/OAuth20Api.md
|
|
103
108
|
docs/OfflineInstancesEntity.md
|
|
104
109
|
docs/OrderDetailsDTO.md
|
|
@@ -200,6 +205,7 @@ docs/SupplierEntity.md
|
|
|
200
205
|
docs/SupplierItemEntity.md
|
|
201
206
|
docs/SupplierItemModel.md
|
|
202
207
|
docs/SupplierModel.md
|
|
208
|
+
docs/SupportTicketModel.md
|
|
203
209
|
docs/SystemApi.md
|
|
204
210
|
docs/TcxBackupEntity.md
|
|
205
211
|
docs/TcxBackupModel.md
|
|
@@ -235,7 +241,6 @@ docs/TcxUsersEntity.md
|
|
|
235
241
|
docs/TcxWizardConfigModel.md
|
|
236
242
|
docs/TcxWizardModel.md
|
|
237
243
|
docs/TechSupportCompanySummaryDTO.md
|
|
238
|
-
docs/TelephonySupportTicketModel.md
|
|
239
244
|
docs/TicketSummaryModel.md
|
|
240
245
|
docs/TicketTimeDTO.md
|
|
241
246
|
docs/TicketsApi.md
|
package/README.md
CHANGED
|
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
|
|
|
127
127
|
*Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders |
|
|
128
128
|
*Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades |
|
|
129
129
|
*Class3CXMultiTenantApi* | [**deleteGetTenant**](docs/Class3CXMultiTenantApi.md#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant
|
|
130
|
+
*Class3CXMultiTenantApi* | [**getGetAdminTenants**](docs/Class3CXMultiTenantApi.md#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants
|
|
130
131
|
*Class3CXMultiTenantApi* | [**getGetTenant**](docs/Class3CXMultiTenantApi.md#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant
|
|
131
132
|
*Class3CXMultiTenantApi* | [**getGetTenants**](docs/Class3CXMultiTenantApi.md#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants
|
|
132
133
|
*Class3CXMultiTenantApi* | [**postAddMtDdi**](docs/Class3CXMultiTenantApi.md#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI
|
|
@@ -134,14 +135,24 @@ Class | Method | HTTP request | Description
|
|
|
134
135
|
*Class3CXMultiTenantApi* | [**postGetTenants**](docs/Class3CXMultiTenantApi.md#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant
|
|
135
136
|
*Class3CXMultiTenantApi* | [**postTrackMtChange**](docs/Class3CXMultiTenantApi.md#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change
|
|
136
137
|
*MyPBXToolsApi* | [**getGetRecording**](docs/MyPBXToolsApi.md#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance
|
|
138
|
+
*NumberPortingApi* | [**deleteGetAdminNumberPort**](docs/NumberPortingApi.md#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} |
|
|
139
|
+
*NumberPortingApi* | [**getCreateNumberPort**](docs/NumberPortingApi.md#getcreatenumberport) | **GET** /sip/numbers/ports |
|
|
140
|
+
*NumberPortingApi* | [**getGetAdminNumberPort**](docs/NumberPortingApi.md#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} |
|
|
141
|
+
*NumberPortingApi* | [**getGetAdminNumberPorts**](docs/NumberPortingApi.md#getgetadminnumberports) | **GET** /admin/sip/numbers/ports |
|
|
142
|
+
*NumberPortingApi* | [**getUpdateNumberPort**](docs/NumberPortingApi.md#getupdatenumberport) | **GET** /sip/numbers/ports/{id} |
|
|
143
|
+
*NumberPortingApi* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close |
|
|
144
|
+
*NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports |
|
|
145
|
+
*NumberPortingApi* | [**postSubmitNumberPort**](docs/NumberPortingApi.md#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit |
|
|
146
|
+
*NumberPortingApi* | [**postUpdateNumberPort**](docs/NumberPortingApi.md#postupdatenumberport) | **POST** /sip/numbers/ports/{id} |
|
|
147
|
+
*NumberPortingApi* | [**putGetAdminNumberPort**](docs/NumberPortingApi.md#putgetadminnumberport) | **PUT** /admin/sip/numbers/ports/{id} |
|
|
137
148
|
*OAuth20Api* | [**getGetMfaQrCode**](docs/OAuth20Api.md#getgetmfaqrcode) | **GET** /oauth2/qr/code | Get MFA QR Code
|
|
138
149
|
*OAuth20Api* | [**getGetScopes**](docs/OAuth20Api.md#getgetscopes) | **GET** /oauth2/scopes | Get Scopes
|
|
139
150
|
*OAuth20Api* | [**postAccessToken**](docs/OAuth20Api.md#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token
|
|
140
151
|
*OAuth20Api* | [**postAuthorise**](docs/OAuth20Api.md#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code
|
|
141
152
|
*OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
|
|
142
153
|
*OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
|
|
143
|
-
*OrdersApi* | [**deleteCreateShipment**](docs/OrdersApi.md#deletecreateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments | Delete Shipment (Admin)
|
|
144
154
|
*OrdersApi* | [**deleteDeleteBatch**](docs/OrdersApi.md#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} |
|
|
155
|
+
*OrdersApi* | [**deleteDeleteShipment**](docs/OrdersApi.md#deletedeleteshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)
|
|
145
156
|
*OrdersApi* | [**deleteUpdateOrder**](docs/OrdersApi.md#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)
|
|
146
157
|
*OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
|
|
147
158
|
*OrdersApi* | [**getGetAdminOrderDetails**](docs/OrdersApi.md#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)
|
|
@@ -183,6 +194,7 @@ Class | Method | HTTP request | Description
|
|
|
183
194
|
*SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
|
|
184
195
|
*SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
|
|
185
196
|
*SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
|
|
197
|
+
*SIPTrunksApi* | [**getGetAdminSipTrunks**](docs/SIPTrunksApi.md#getgetadminsiptrunks) | **GET** /sip/trunks/admin |
|
|
186
198
|
*SIPTrunksApi* | [**getGetAreaCodes**](docs/SIPTrunksApi.md#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes
|
|
187
199
|
*SIPTrunksApi* | [**getGetCliFlexibility**](docs/SIPTrunksApi.md#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status
|
|
188
200
|
*SIPTrunksApi* | [**getGetDdis**](docs/SIPTrunksApi.md#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs
|
|
@@ -333,6 +345,11 @@ Class | Method | HTTP request | Description
|
|
|
333
345
|
- [MonthlyUsageModel](docs/MonthlyUsageModel.md)
|
|
334
346
|
- [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
|
|
335
347
|
- [NavigationModel](docs/NavigationModel.md)
|
|
348
|
+
- [NumberPortDTO](docs/NumberPortDTO.md)
|
|
349
|
+
- [NumberPortModel](docs/NumberPortModel.md)
|
|
350
|
+
- [NumberPortRangeDTO](docs/NumberPortRangeDTO.md)
|
|
351
|
+
- [NumberPortRangeRequestDTO](docs/NumberPortRangeRequestDTO.md)
|
|
352
|
+
- [NumberPortsModel](docs/NumberPortsModel.md)
|
|
336
353
|
- [OfflineInstancesEntity](docs/OfflineInstancesEntity.md)
|
|
337
354
|
- [OrderDetailsDTO](docs/OrderDetailsDTO.md)
|
|
338
355
|
- [OrderEntity](docs/OrderEntity.md)
|
|
@@ -424,6 +441,7 @@ Class | Method | HTTP request | Description
|
|
|
424
441
|
- [SupplierItemEntity](docs/SupplierItemEntity.md)
|
|
425
442
|
- [SupplierItemModel](docs/SupplierItemModel.md)
|
|
426
443
|
- [SupplierModel](docs/SupplierModel.md)
|
|
444
|
+
- [SupportTicketModel](docs/SupportTicketModel.md)
|
|
427
445
|
- [TcxBackupEntity](docs/TcxBackupEntity.md)
|
|
428
446
|
- [TcxBackupModel](docs/TcxBackupModel.md)
|
|
429
447
|
- [TcxBillingEntity](docs/TcxBillingEntity.md)
|
|
@@ -458,7 +476,6 @@ Class | Method | HTTP request | Description
|
|
|
458
476
|
- [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)
|
|
459
477
|
- [TcxWizardModel](docs/TcxWizardModel.md)
|
|
460
478
|
- [TechSupportCompanySummaryDTO](docs/TechSupportCompanySummaryDTO.md)
|
|
461
|
-
- [TelephonySupportTicketModel](docs/TelephonySupportTicketModel.md)
|
|
462
479
|
- [TicketSummaryModel](docs/TicketSummaryModel.md)
|
|
463
480
|
- [TicketTimeDTO](docs/TicketTimeDTO.md)
|
|
464
481
|
- [TokenResponseModel](docs/TokenResponseModel.md)
|
|
@@ -487,6 +504,8 @@ Authentication schemes defined for the API:
|
|
|
487
504
|
- **tcx_wizard**: 3CX Installation Wizard
|
|
488
505
|
- **accounts.read**: Accounts (Read)
|
|
489
506
|
- **accounts.write**: Accounts (Write)
|
|
507
|
+
- **number_porting.read**: Number Porting (Read)
|
|
508
|
+
- **number_porting.write**: Number Porting (Write)
|
|
490
509
|
- **pricing.read**: Pricing (Read)
|
|
491
510
|
- **orders.read**: Orders (Read)
|
|
492
511
|
- **orders.write**: Orders (Write)
|