yellowgrid-api-ts 3.0.79

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 (201) hide show
  1. package/.openapi-generator/FILES +189 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +385 -0
  5. package/api.ts +20310 -0
  6. package/base.ts +86 -0
  7. package/common.ts +150 -0
  8. package/config.json +3 -0
  9. package/configuration.ts +115 -0
  10. package/dist/api.d.ts +14136 -0
  11. package/dist/api.js +14123 -0
  12. package/dist/base.d.ts +66 -0
  13. package/dist/base.js +86 -0
  14. package/dist/common.d.ts +65 -0
  15. package/dist/common.js +253 -0
  16. package/dist/configuration.d.ts +91 -0
  17. package/dist/configuration.js +57 -0
  18. package/dist/index.d.ts +13 -0
  19. package/dist/index.js +31 -0
  20. package/docs/AccountContactEntity.md +45 -0
  21. package/docs/AccountContactModel.md +45 -0
  22. package/docs/AccountContactRequestModel.md +37 -0
  23. package/docs/AccountRequestModel.md +53 -0
  24. package/docs/AccountSummaryDTO.md +25 -0
  25. package/docs/AccountsApi.md +948 -0
  26. package/docs/AccountsResponseModel.md +27 -0
  27. package/docs/AddressModel.md +45 -0
  28. package/docs/AddressRequestModel.md +27 -0
  29. package/docs/AgentHoursGraphModel.md +27 -0
  30. package/docs/AgentHoursGraphMonthModel.md +23 -0
  31. package/docs/ApiLogEntity.md +43 -0
  32. package/docs/AreaCodeModel.md +23 -0
  33. package/docs/AttachmentModel.md +29 -0
  34. package/docs/AttributeSetEnum.md +23 -0
  35. package/docs/AuthCodeResponseModel.md +25 -0
  36. package/docs/BatchEntity.md +53 -0
  37. package/docs/CallBarringModel.md +29 -0
  38. package/docs/Class3CXApi.md +172 -0
  39. package/docs/Class3CXInstallationWizardApi.md +1355 -0
  40. package/docs/Class3CXInstallationsApi.md +651 -0
  41. package/docs/Class3CXIntegrationsApi.md +344 -0
  42. package/docs/Class3CXMultiTenantApi.md +404 -0
  43. package/docs/ClientDetailsModel.md +35 -0
  44. package/docs/ClientModel.md +27 -0
  45. package/docs/CompanyContractModel.md +29 -0
  46. package/docs/ContactInfoModel.md +29 -0
  47. package/docs/ConversationModel.md +35 -0
  48. package/docs/CreditAccountEntity.md +61 -0
  49. package/docs/CustomerInformationModel.md +33 -0
  50. package/docs/CustomerPriceListEnum.md +23 -0
  51. package/docs/CustomerSummaryReportDTO.md +31 -0
  52. package/docs/DdiRangeRequestModel.md +25 -0
  53. package/docs/DdiRangesRequestModel.md +21 -0
  54. package/docs/DivertRequestModel.md +23 -0
  55. package/docs/DivertResponseModel.md +25 -0
  56. package/docs/EdTechProClientEntity.md +29 -0
  57. package/docs/EdTechProSchoolModel.md +47 -0
  58. package/docs/EdTechProSchoolsModel.md +27 -0
  59. package/docs/EdTechProSetupModel.md +29 -0
  60. package/docs/FraudManagementModel.md +23 -0
  61. package/docs/FreshdeskCompanyTicketsModel.md +27 -0
  62. package/docs/FreshdeskTicketEntity.md +33 -0
  63. package/docs/FtpAccountsEntity.md +29 -0
  64. package/docs/GenericFileModel.md +25 -0
  65. package/docs/GetGetPasswordHash200Response.md +20 -0
  66. package/docs/GetGetPrice200Response.md +20 -0
  67. package/docs/GetGetRecording200Response.md +20 -0
  68. package/docs/HostingChangeResponseModel.md +29 -0
  69. package/docs/InstanceAutoFailoverEntity.md +29 -0
  70. package/docs/InstanceDeletionScheduleEntity.md +27 -0
  71. package/docs/InstanceEntity.md +59 -0
  72. package/docs/InstanceFailoverEntity.md +41 -0
  73. package/docs/InstanceMonitoringEntity.md +25 -0
  74. package/docs/InstanceMonitoringLogEntity.md +31 -0
  75. package/docs/InstanceScheduledTasksEntity.md +31 -0
  76. package/docs/InstanceTcxDetailsEntity.md +39 -0
  77. package/docs/InstanceUserCredentialsEntity.md +29 -0
  78. package/docs/ItemDTO.md +41 -0
  79. package/docs/ItemEntity.md +61 -0
  80. package/docs/MFARequiredModel.md +23 -0
  81. package/docs/MonthlyUsageModel.md +23 -0
  82. package/docs/MultiTenantChangeResponseModel.md +27 -0
  83. package/docs/MyPBXToolsApi.md +65 -0
  84. package/docs/NavigationModel.md +27 -0
  85. package/docs/OAuth20Api.md +368 -0
  86. package/docs/OfflineInstancesEntity.md +29 -0
  87. package/docs/OrderEntity.md +135 -0
  88. package/docs/OrderRequestModel.md +45 -0
  89. package/docs/OrderSummariesModel.md +27 -0
  90. package/docs/OrderSummaryDTO.md +43 -0
  91. package/docs/OrderTotalModel.md +33 -0
  92. package/docs/OrderedItemEntity.md +47 -0
  93. package/docs/OrdersApi.md +135 -0
  94. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  95. package/docs/PatchUpdateAccountContactPasswordRequest.md +20 -0
  96. package/docs/PortalAccountModel.md +67 -0
  97. package/docs/PortalLoginModel.md +33 -0
  98. package/docs/PostAddWebhook200Response.md +20 -0
  99. package/docs/PostGetClientCredentialsRequest.md +20 -0
  100. package/docs/PriceListItemModel.md +29 -0
  101. package/docs/PricingApi.md +138 -0
  102. package/docs/PrizesEntity.md +31 -0
  103. package/docs/ProductSearchResultsModel.md +21 -0
  104. package/docs/ProductSerialInfoModel.md +27 -0
  105. package/docs/ProductSummaryModel.md +31 -0
  106. package/docs/ProductsApi.md +315 -0
  107. package/docs/PromoCodesEntity.md +43 -0
  108. package/docs/PromoItemsEntity.md +35 -0
  109. package/docs/ProvisioningApi.md +402 -0
  110. package/docs/ProvisioningEntity.md +29 -0
  111. package/docs/ProvisioningRequestEntity.md +25 -0
  112. package/docs/ResourceNotReadyException.md +25 -0
  113. package/docs/RootAccessModel.md +25 -0
  114. package/docs/SIPTrunksApi.md +1258 -0
  115. package/docs/SMSApi.md +66 -0
  116. package/docs/ScannedItemModel.md +29 -0
  117. package/docs/ScopeModel.md +23 -0
  118. package/docs/ShipmentAddressEntity.md +41 -0
  119. package/docs/ShipmentEntity.md +43 -0
  120. package/docs/ShipmentItemEntity.md +29 -0
  121. package/docs/SipTrunkChangeResponseModel.md +29 -0
  122. package/docs/SipTrunkCreationRequestModel.md +31 -0
  123. package/docs/SipTrunkEntity.md +43 -0
  124. package/docs/SipTrunksResponseModel.md +27 -0
  125. package/docs/SmsAccountEntity.md +33 -0
  126. package/docs/SmsDataModel.md +21 -0
  127. package/docs/SmsMessageModel.md +25 -0
  128. package/docs/SmsNumbersEntity.md +23 -0
  129. package/docs/SmsPayloadModel.md +25 -0
  130. package/docs/SmsPhoneNumberModel.md +23 -0
  131. package/docs/SmsResponseModel.md +29 -0
  132. package/docs/SmsWhitelistEntity.md +23 -0
  133. package/docs/StockManagementApi.md +1380 -0
  134. package/docs/StockOrderCourierEntity.md +27 -0
  135. package/docs/StockOrderDeductionModel.md +27 -0
  136. package/docs/StockOrderDeductionRequestModel.md +23 -0
  137. package/docs/StockOrderDeductionsEntity.md +27 -0
  138. package/docs/StockOrderEntity.md +63 -0
  139. package/docs/StockOrderItemEntity.md +33 -0
  140. package/docs/StockOrderItemModel.md +37 -0
  141. package/docs/StockOrderItemRequestModel.md +27 -0
  142. package/docs/StockOrderModel.md +49 -0
  143. package/docs/StockOrderProductEntity.md +31 -0
  144. package/docs/StockOrderRequestModel.md +25 -0
  145. package/docs/StockOrderSupplierEntity.md +37 -0
  146. package/docs/StockOrderSupplierModel.md +37 -0
  147. package/docs/StockOrdersModel.md +27 -0
  148. package/docs/StockProductModel.md +49 -0
  149. package/docs/StockProductPriceModel.md +23 -0
  150. package/docs/StockProductSummariesModel.md +27 -0
  151. package/docs/StockProductSummaryModel.md +33 -0
  152. package/docs/StockTransactionsEntity.md +35 -0
  153. package/docs/SupplierEntity.md +37 -0
  154. package/docs/SupplierItemEntity.md +35 -0
  155. package/docs/SystemApi.md +80 -0
  156. package/docs/TcxBackupEntity.md +37 -0
  157. package/docs/TcxBackupModel.md +55 -0
  158. package/docs/TcxBillingEntity.md +39 -0
  159. package/docs/TcxBulkLicenceDetailsModel.md +23 -0
  160. package/docs/TcxDeadLicenceEntity.md +25 -0
  161. package/docs/TcxExtsEntity.md +35 -0
  162. package/docs/TcxHostingPricingEntity.md +35 -0
  163. package/docs/TcxInstallationDetailsModel.md +45 -0
  164. package/docs/TcxInstallationModel.md +75 -0
  165. package/docs/TcxInstallationsModel.md +27 -0
  166. package/docs/TcxKeySummaryDTO.md +29 -0
  167. package/docs/TcxKeysEntity.md +31 -0
  168. package/docs/TcxLicenceDetailsErrorModel.md +27 -0
  169. package/docs/TcxLicenceDetailsModel.md +41 -0
  170. package/docs/TcxMacsEntity.md +25 -0
  171. package/docs/TcxMultiTenantModel.md +47 -0
  172. package/docs/TcxMultiTenantUserModel.md +25 -0
  173. package/docs/TcxMultiTenantsModel.md +27 -0
  174. package/docs/TcxNumbersEntity.md +25 -0
  175. package/docs/TcxOfficeHoursEntity.md +49 -0
  176. package/docs/TcxPhoneModel.md +32 -0
  177. package/docs/TcxPhonesEntity.md +31 -0
  178. package/docs/TcxSbcEntity.md +51 -0
  179. package/docs/TcxSetupEntity.md +71 -0
  180. package/docs/TcxSetupsModel.md +27 -0
  181. package/docs/TcxSipTrunksEntity.md +45 -0
  182. package/docs/TcxTemplateXmlEnum.md +23 -0
  183. package/docs/TcxUsersEntity.md +31 -0
  184. package/docs/TcxWizardConfigModel.md +23 -0
  185. package/docs/TcxWizardModel.md +47 -0
  186. package/docs/TechSupportCompanySummaryDTO.md +29 -0
  187. package/docs/TelephonySupportTicketModel.md +41 -0
  188. package/docs/TicketSummaryModel.md +35 -0
  189. package/docs/TicketTimeDTO.md +36 -0
  190. package/docs/TicketsApi.md +300 -0
  191. package/docs/TokenResponseModel.md +25 -0
  192. package/docs/UpgradeOrderResponseModel.md +23 -0
  193. package/docs/UpgradeRequestModel.md +27 -0
  194. package/docs/UserEntity.md +39 -0
  195. package/docs/WebhooksApi.md +117 -0
  196. package/docs/XeroLogEntity.md +39 -0
  197. package/git_push.sh +57 -0
  198. package/index.ts +18 -0
  199. package/openapitools.json +7 -0
  200. package/package.json +31 -0
  201. package/tsconfig.json +21 -0
@@ -0,0 +1,41 @@
1
+ # TcxLicenceDetailsModel
2
+
3
+ 3CX Licence Details
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **key** | **string** | Licence Key | [optional] [default to undefined]
10
+ **edition** | **string** | Edition | [optional] [default to undefined]
11
+ **sc** | **number** | Simultaneous Calls | [optional] [default to undefined]
12
+ **extensions** | **number** | SMB Extensions | [optional] [default to undefined]
13
+ **expiry** | **string** | Licence Expiry | [optional] [default to undefined]
14
+ **hostingExpiry** | **string** | Hosting Expiry | [optional] [default to undefined]
15
+ **nfr** | **boolean** | NFR Licence | [optional] [default to undefined]
16
+ **free** | **boolean** | Free Licence | [optional] [default to undefined]
17
+ **dead** | **boolean** | Dead Licence | [optional] [default to undefined]
18
+ **customerName** | **string** | End User Name | [optional] [default to undefined]
19
+ **ygHosted** | **boolean** | Yellowgrid Hosted | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { TcxLicenceDetailsModel } from 'yellowgrid-api-ts';
25
+
26
+ const instance: TcxLicenceDetailsModel = {
27
+ key,
28
+ edition,
29
+ sc,
30
+ extensions,
31
+ expiry,
32
+ hostingExpiry,
33
+ nfr,
34
+ free,
35
+ dead,
36
+ customerName,
37
+ ygHosted,
38
+ };
39
+ ```
40
+
41
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # TcxMacsEntity
2
+
3
+ 3CX Wizard MAC
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **ext** | **string** | Extension Number | [optional] [default to undefined]
11
+ **mac** | **string** | MAC Address | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TcxMacsEntity } from 'yellowgrid-api-ts';
17
+
18
+ const instance: TcxMacsEntity = {
19
+ id,
20
+ ext,
21
+ mac,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,47 @@
1
+ # TcxMultiTenantModel
2
+
3
+ 3CX Multi-Tenant Tenant
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **server** | **string** | Host Server | [optional] [default to undefined]
10
+ **reference** | **string** | Tenant Reference | [optional] [default to undefined]
11
+ **_package** | **string** | Tenant Package | [optional] [default to undefined]
12
+ **price** | **number** | Price Per User | [optional] [default to undefined]
13
+ **username** | **string** | Admin Username | [optional] [default to undefined]
14
+ **password** | **string** | Admin Password | [optional] [default to undefined]
15
+ **companyName** | **string** | Tenant Name | [optional] [default to undefined]
16
+ **address1** | **string** | Address Line 1 | [optional] [default to undefined]
17
+ **address2** | **string** | Address Line 2 | [optional] [default to undefined]
18
+ **city** | **string** | City | [optional] [default to undefined]
19
+ **postalCode** | **string** | Postal Code | [optional] [default to undefined]
20
+ **mainNumber** | **string** | Tenant Main Number | [optional] [default to undefined]
21
+ **numbers** | **Array<string>** | Tenant Numbers | [optional] [default to undefined]
22
+ **users** | [**Array<TcxMultiTenantUserModel>**](TcxMultiTenantUserModel.md) | Tenant Users | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { TcxMultiTenantModel } from 'yellowgrid-api-ts';
28
+
29
+ const instance: TcxMultiTenantModel = {
30
+ server,
31
+ reference,
32
+ _package,
33
+ price,
34
+ username,
35
+ password,
36
+ companyName,
37
+ address1,
38
+ address2,
39
+ city,
40
+ postalCode,
41
+ mainNumber,
42
+ numbers,
43
+ users,
44
+ };
45
+ ```
46
+
47
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # TcxMultiTenantUserModel
2
+
3
+ 3CX Multi-Tenant User
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **firstName** | **string** | User Name | [optional] [default to undefined]
10
+ **lastName** | **string** | User Surname | [optional] [default to undefined]
11
+ **email** | **string** | User Email Address | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TcxMultiTenantUserModel } from 'yellowgrid-api-ts';
17
+
18
+ const instance: TcxMultiTenantUserModel = {
19
+ firstName,
20
+ lastName,
21
+ email,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # TcxMultiTenantsModel
2
+
3
+ 3CX Multi Tenants
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **results** | [**Array<TcxMultiTenantModel>**](TcxMultiTenantModel.md) | Results | [optional] [default to undefined]
10
+ **page** | **number** | Page | [optional] [default to undefined]
11
+ **perPage** | **number** | Per Page | [optional] [default to undefined]
12
+ **totalResults** | **number** | Total Results | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { TcxMultiTenantsModel } from 'yellowgrid-api-ts';
18
+
19
+ const instance: TcxMultiTenantsModel = {
20
+ results,
21
+ page,
22
+ perPage,
23
+ totalResults,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # TcxNumbersEntity
2
+
3
+ 3CX Wizard Number
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **number** | **string** | Number | [optional] [default to undefined]
11
+ **label** | **string** | Label | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { TcxNumbersEntity } from 'yellowgrid-api-ts';
17
+
18
+ const instance: TcxNumbersEntity = {
19
+ id,
20
+ number,
21
+ label,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,49 @@
1
+ # TcxOfficeHoursEntity
2
+
3
+ 3CX Wizard Office Hours
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **mondayFrom** | **string** | Monday Hours From | [optional] [default to undefined]
11
+ **mondayTo** | **string** | Monday Hours To | [optional] [default to undefined]
12
+ **tuesdayFrom** | **string** | Tuesday Hours From | [optional] [default to undefined]
13
+ **tuesdayTo** | **string** | Tuesday Hours To | [optional] [default to undefined]
14
+ **wednesdayFrom** | **string** | Wednesday Hours From | [optional] [default to undefined]
15
+ **wednesdayTo** | **string** | Wednesday Hours To | [optional] [default to undefined]
16
+ **thursdayFrom** | **string** | Thursday Hours From | [optional] [default to undefined]
17
+ **thursdayTo** | **string** | Thursday Hours To | [optional] [default to undefined]
18
+ **fridayFrom** | **string** | Friday Hours From | [optional] [default to undefined]
19
+ **fridayTo** | **string** | Friday Hours To | [optional] [default to undefined]
20
+ **saturdayFrom** | **string** | Saturday Hours From | [optional] [default to undefined]
21
+ **saturdayTo** | **string** | Saturday Hours To | [optional] [default to undefined]
22
+ **sundayFrom** | **string** | Sunday Hours From | [optional] [default to undefined]
23
+ **sundayTo** | **string** | Sunday Hours To | [optional] [default to undefined]
24
+
25
+ ## Example
26
+
27
+ ```typescript
28
+ import { TcxOfficeHoursEntity } from 'yellowgrid-api-ts';
29
+
30
+ const instance: TcxOfficeHoursEntity = {
31
+ id,
32
+ mondayFrom,
33
+ mondayTo,
34
+ tuesdayFrom,
35
+ tuesdayTo,
36
+ wednesdayFrom,
37
+ wednesdayTo,
38
+ thursdayFrom,
39
+ thursdayTo,
40
+ fridayFrom,
41
+ fridayTo,
42
+ saturdayFrom,
43
+ saturdayTo,
44
+ sundayFrom,
45
+ sundayTo,
46
+ };
47
+ ```
48
+
49
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # TcxPhoneModel
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | id | [optional] [default to undefined]
9
+ **phone** | **string** | Phone Model | [optional] [default to undefined]
10
+ **mac** | **string** | MAC Address | [optional] [default to undefined]
11
+ **sku** | **string** | SKU | [optional] [default to undefined]
12
+ **extNo** | **string** | Extension Number | [optional] [default to undefined]
13
+ **sbcId** | **string** | SBC ID | [optional] [default to undefined]
14
+ **fromOrder** | **boolean** | Phone exists on order | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { TcxPhoneModel } from 'yellowgrid-api-ts';
20
+
21
+ const instance: TcxPhoneModel = {
22
+ id,
23
+ phone,
24
+ mac,
25
+ sku,
26
+ extNo,
27
+ sbcId,
28
+ fromOrder,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # TcxPhonesEntity
2
+
3
+ 3CX Wizard Phone
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **phone** | **string** | Phone Model | [optional] [default to undefined]
11
+ **mac** | **string** | MAC Address | [optional] [default to undefined]
12
+ **sku** | **string** | SKU | [optional] [default to undefined]
13
+ **extNo** | **string** | Extension Number | [optional] [default to undefined]
14
+ **sbcId** | **string** | SBC ID | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { TcxPhonesEntity } from 'yellowgrid-api-ts';
20
+
21
+ const instance: TcxPhonesEntity = {
22
+ id,
23
+ phone,
24
+ mac,
25
+ sku,
26
+ extNo,
27
+ sbcId,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,51 @@
1
+ # TcxSbcEntity
2
+
3
+ 3CX Wizard SBC
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **sbcId** | **number** | SBC ID | [optional] [default to undefined]
11
+ **tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
12
+ **tcxKey** | **string** | 3CX SBC Auth Key | [optional] [default to undefined]
13
+ **label** | **string** | Label | [optional] [default to undefined]
14
+ **ipAddress** | **string** | IP Address | [optional] [default to undefined]
15
+ **netmask** | **string** | Subnet Mask | [optional] [default to undefined]
16
+ **defaultGateway** | **string** | Default Gateway | [optional] [default to undefined]
17
+ **dns1** | **string** | DNS 1 | [optional] [default to undefined]
18
+ **dns2** | **string** | DNS 2 | [optional] [default to undefined]
19
+ **address1** | **string** | Site Address Line 1 | [optional] [default to undefined]
20
+ **address2** | **string** | Site Address Line 2 | [optional] [default to undefined]
21
+ **city** | **string** | Site City | [optional] [default to undefined]
22
+ **postalCode** | **string** | Site Postal Code | [optional] [default to undefined]
23
+ **primaryContact** | **string** | Site Primary Contact | [optional] [default to undefined]
24
+ **technicalContact** | **string** | Site Technical Contact | [optional] [default to undefined]
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import { TcxSbcEntity } from 'yellowgrid-api-ts';
30
+
31
+ const instance: TcxSbcEntity = {
32
+ id,
33
+ sbcId,
34
+ tcxUrl,
35
+ tcxKey,
36
+ label,
37
+ ipAddress,
38
+ netmask,
39
+ defaultGateway,
40
+ dns1,
41
+ dns2,
42
+ address1,
43
+ address2,
44
+ city,
45
+ postalCode,
46
+ primaryContact,
47
+ technicalContact,
48
+ };
49
+ ```
50
+
51
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,71 @@
1
+ # TcxSetupEntity
2
+
3
+ 3CX Wizard Setup Config
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **creation** | **string** | Creation Date | [optional] [default to undefined]
10
+ **installType** | **string** | Install Type | [optional] [default to undefined]
11
+ **installVersion** | **number** | 3CX Install Version | [optional] [default to 20]
12
+ **orderId** | **number** | Linked Order ID | [optional] [default to undefined]
13
+ **customerId** | **number** | Customer ID | [optional] [default to undefined]
14
+ **username** | **string** | 3CX System Owner Username | [optional] [default to undefined]
15
+ **password** | **string** | 3CX System Owner Password | [optional] [default to undefined]
16
+ **primaryContactName** | **string** | Primary Contact Name | [optional] [default to undefined]
17
+ **primaryContactNumber** | **string** | Primary Contact Number | [optional] [default to undefined]
18
+ **technicalContactName** | **string** | Technical Contact Name | [optional] [default to undefined]
19
+ **technicalContactNumber** | **string** | Technical Contact Number | [optional] [default to undefined]
20
+ **companyName** | **string** | Company Name | [optional] [default to undefined]
21
+ **email** | **string** | 3CX Admin Email Address | [optional] [default to undefined]
22
+ **phone** | **string** | Contact Phone Number | [optional] [default to undefined]
23
+ **additionalDisk** | **number** | Additional Disk Space | [optional] [default to undefined]
24
+ **licencekey** | **string** | 3CX Licence Key | [optional] [default to undefined]
25
+ **hostname** | **string** | 3CX Hostname | [optional] [default to undefined]
26
+ **suffix** | **string** | 3CX DNS Suffix | [optional] [default to undefined]
27
+ **extLength** | **number** | Extension Length | [optional] [default to undefined]
28
+ **address1** | **string** | Address Line 1 | [optional] [default to undefined]
29
+ **address2** | **string** | Address Line 2 | [optional] [default to undefined]
30
+ **city** | **string** | City | [optional] [default to undefined]
31
+ **postCode** | **string** | Postal Code | [optional] [default to undefined]
32
+ **region** | **string** | Region | [optional] [default to undefined]
33
+ **status** | **number** | Status | [optional] [default to undefined]
34
+ **instanceId** | **string** | Instance ID | [optional] [default to undefined]
35
+
36
+ ## Example
37
+
38
+ ```typescript
39
+ import { TcxSetupEntity } from 'yellowgrid-api-ts';
40
+
41
+ const instance: TcxSetupEntity = {
42
+ creation,
43
+ installType,
44
+ installVersion,
45
+ orderId,
46
+ customerId,
47
+ username,
48
+ password,
49
+ primaryContactName,
50
+ primaryContactNumber,
51
+ technicalContactName,
52
+ technicalContactNumber,
53
+ companyName,
54
+ email,
55
+ phone,
56
+ additionalDisk,
57
+ licencekey,
58
+ hostname,
59
+ suffix,
60
+ extLength,
61
+ address1,
62
+ address2,
63
+ city,
64
+ postCode,
65
+ region,
66
+ status,
67
+ instanceId,
68
+ };
69
+ ```
70
+
71
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # TcxSetupsModel
2
+
3
+ 3CX Setups
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **results** | [**Array<TcxSetupEntity>**](TcxSetupEntity.md) | Results | [optional] [default to undefined]
10
+ **page** | **number** | Page | [optional] [default to undefined]
11
+ **perPage** | **number** | Per Page | [optional] [default to undefined]
12
+ **totalResults** | **number** | Total Results | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { TcxSetupsModel } from 'yellowgrid-api-ts';
18
+
19
+ const instance: TcxSetupsModel = {
20
+ results,
21
+ page,
22
+ perPage,
23
+ totalResults,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,45 @@
1
+ # TcxSipTrunksEntity
2
+
3
+ 3CX Wizard SIP Trunk
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **provider** | **string** | Provider | [optional] [default to undefined]
11
+ **serviceId** | **number** | Service ID (YG Trunks Only) | [optional] [default to undefined]
12
+ **authType** | **string** | Auth Type | [optional] [default to undefined]
13
+ **server** | **string** | Registrar Address | [optional] [default to undefined]
14
+ **username** | **string** | Username | [optional] [default to undefined]
15
+ **password** | **string** | Password | [optional] [default to undefined]
16
+ **channels** | **number** | Channels | [optional] [default to undefined]
17
+ **port** | **number** | SIP Port | [optional] [default to undefined]
18
+ **proxy** | **string** | Proxy Address | [optional] [default to undefined]
19
+ **password2** | **string** | Secondary Authentication Password | [optional] [default to undefined]
20
+ **number** | **string** | Main Trunk Number | [optional] [default to undefined]
21
+ **ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { TcxSipTrunksEntity } from 'yellowgrid-api-ts';
27
+
28
+ const instance: TcxSipTrunksEntity = {
29
+ id,
30
+ provider,
31
+ serviceId,
32
+ authType,
33
+ server,
34
+ username,
35
+ password,
36
+ channels,
37
+ port,
38
+ proxy,
39
+ password2,
40
+ number,
41
+ ipAddress,
42
+ };
43
+ ```
44
+
45
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # TcxTemplateXmlEnum
2
+
3
+ 3CX Template
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | Attribute ID | [optional] [default to undefined]
10
+ **name** | **string** | Template Filename | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { TcxTemplateXmlEnum } from 'yellowgrid-api-ts';
16
+
17
+ const instance: TcxTemplateXmlEnum = {
18
+ id,
19
+ name,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,31 @@
1
+ # TcxUsersEntity
2
+
3
+ TcxUsersEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **instanceId** | **string** | instanceId | [optional] [default to undefined]
11
+ **extension** | **string** | extension | [optional] [default to undefined]
12
+ **username** | **string** | username | [optional] [default to undefined]
13
+ **password** | **string** | password | [optional] [default to undefined]
14
+ **secret** | **string** | secret | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { TcxUsersEntity } from 'yellowgrid-api-ts';
20
+
21
+ const instance: TcxUsersEntity = {
22
+ id,
23
+ instanceId,
24
+ extension,
25
+ username,
26
+ password,
27
+ secret,
28
+ };
29
+ ```
30
+
31
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # TcxWizardConfigModel
2
+
3
+ 3CX Wizard Config
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **logo** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
10
+ **hex** | **string** | Hex Colour | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { TcxWizardConfigModel } from 'yellowgrid-api-ts';
16
+
17
+ const instance: TcxWizardConfigModel = {
18
+ logo,
19
+ hex,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,47 @@
1
+ # TcxWizardModel
2
+
3
+ 3CX Installation Wizard
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | 3CX Installation Wizard ID | [optional] [default to undefined]
10
+ **config** | [**TcxWizardConfigModel**](TcxWizardConfigModel.md) | | [optional] [default to undefined]
11
+ **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
12
+ **installType** | **string** | Install Type | [optional] [default to undefined]
13
+ **backup** | [**TcxBackupModel**](TcxBackupModel.md) | | [optional] [default to undefined]
14
+ **extensions** | [**Array<TcxExtsEntity>**](TcxExtsEntity.md) | | [optional] [default to undefined]
15
+ **numbers** | [**Array<TcxNumbersEntity>**](TcxNumbersEntity.md) | | [optional] [default to undefined]
16
+ **officeHours** | [**TcxOfficeHoursEntity**](TcxOfficeHoursEntity.md) | | [optional] [default to undefined]
17
+ **phones** | [**Array<TcxPhoneModel>**](TcxPhoneModel.md) | | [optional] [default to undefined]
18
+ **sbcs** | [**Array<TcxSbcEntity>**](TcxSbcEntity.md) | | [optional] [default to undefined]
19
+ **sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) | | [optional] [default to undefined]
20
+ **installationStatus** | **string** | | [optional] [default to undefined]
21
+ **setup** | [**TcxSetupEntity**](TcxSetupEntity.md) | | [optional] [default to undefined]
22
+ **endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { TcxWizardModel } from 'yellowgrid-api-ts';
28
+
29
+ const instance: TcxWizardModel = {
30
+ id,
31
+ config,
32
+ licenceKey,
33
+ installType,
34
+ backup,
35
+ extensions,
36
+ numbers,
37
+ officeHours,
38
+ phones,
39
+ sbcs,
40
+ sipTrunk,
41
+ installationStatus,
42
+ setup,
43
+ endUserView,
44
+ };
45
+ ```
46
+
47
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,29 @@
1
+ # TechSupportCompanySummaryDTO
2
+
3
+ Tech Support Company Summary
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **companyId** | **number** | Company ID | [optional] [default to undefined]
10
+ **companyName** | **string** | Company Name | [optional] [default to undefined]
11
+ **contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [optional] [default to undefined]
12
+ **reportUrl** | **string** | Report URL | [optional] [default to undefined]
13
+ **monthlyReportEmailAddress** | **string** | Monthly Report Email Address | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { TechSupportCompanySummaryDTO } from 'yellowgrid-api-ts';
19
+
20
+ const instance: TechSupportCompanySummaryDTO = {
21
+ companyId,
22
+ companyName,
23
+ contract,
24
+ reportUrl,
25
+ monthlyReportEmailAddress,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)