yellowgrid-api-ts 3.2.30 → 3.2.31-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 (242) hide show
  1. package/.openapi-generator/FILES +10 -1
  2. package/.openapi-generator/VERSION +0 -0
  3. package/.openapi-generator-ignore +0 -0
  4. package/README.md +15 -3
  5. package/api.ts +775 -240
  6. package/base.ts +1 -1
  7. package/common.ts +1 -1
  8. package/config.json +3 -3
  9. package/configuration.ts +1 -1
  10. package/dist/api.d.ts +516 -120
  11. package/dist/api.js +567 -267
  12. package/dist/base.d.ts +1 -1
  13. package/dist/base.js +1 -1
  14. package/dist/common.d.ts +1 -1
  15. package/dist/common.js +1 -1
  16. package/dist/configuration.d.ts +1 -1
  17. package/dist/configuration.js +1 -1
  18. package/dist/index.d.ts +1 -1
  19. package/dist/index.js +1 -1
  20. package/docs/AbstractEventUpdateDTO.md +23 -0
  21. package/docs/AbstractOrderRequestDTO.md +0 -0
  22. package/docs/AccountContactEntity.md +0 -0
  23. package/docs/AccountContactModel.md +0 -0
  24. package/docs/AccountContactRequestModel.md +0 -0
  25. package/docs/AccountDetailedSummaryDTO.md +0 -0
  26. package/docs/AccountRequestModel.md +0 -0
  27. package/docs/AccountSummaryDTO.md +0 -0
  28. package/docs/AccountsApi.md +0 -0
  29. package/docs/AccountsResponseModel.md +0 -0
  30. package/docs/AddressModel.md +0 -0
  31. package/docs/AddressRequestModel.md +0 -0
  32. package/docs/AdminOrderRequestDTO.md +0 -0
  33. package/docs/AdminUserModel.md +0 -0
  34. package/docs/AgentHoursGraphModel.md +0 -0
  35. package/docs/AgentHoursGraphMonthModel.md +0 -0
  36. package/docs/ApiLogEntity.md +0 -0
  37. package/docs/AreaCodeModel.md +0 -0
  38. package/docs/AttachmentModel.md +0 -0
  39. package/docs/AttributeSetEnum.md +0 -0
  40. package/docs/AuditLogEntity.md +0 -0
  41. package/docs/AuthCodeResponseModel.md +0 -0
  42. package/docs/BasicItemDTO.md +0 -0
  43. package/docs/BasicProductDTO.md +0 -0
  44. package/docs/BatchEntity.md +0 -0
  45. package/docs/CRMApi.md +0 -0
  46. package/docs/CallBarringModel.md +0 -0
  47. package/docs/Class3CXApi.md +0 -0
  48. package/docs/Class3CXInstallationWizardApi.md +0 -56
  49. package/docs/Class3CXInstallationsApi.md +0 -116
  50. package/docs/Class3CXIntegrationsApi.md +0 -0
  51. package/docs/Class3CXMultiTenantApi.md +0 -0
  52. package/docs/ClientDetailsModel.md +0 -0
  53. package/docs/ClientModel.md +0 -0
  54. package/docs/CompanyContractModel.md +0 -0
  55. package/docs/ContactInfoModel.md +0 -0
  56. package/docs/ConversationModel.md +0 -0
  57. package/docs/CourierPriceEntity.md +0 -0
  58. package/docs/CreditAccountEntity.md +0 -0
  59. package/docs/CrmContactDTO.md +0 -0
  60. package/docs/CustomerInformationModel.md +0 -0
  61. package/docs/CustomerItemRequestDTO.md +0 -0
  62. package/docs/CustomerOrderRequestDTO.md +0 -0
  63. package/docs/CustomerPriceListEnum.md +0 -0
  64. package/docs/CustomerSummaryReportDTO.md +0 -0
  65. package/docs/DdiRangeRequestModel.md +0 -0
  66. package/docs/DdiRangesRequestModel.md +0 -0
  67. package/docs/DetailedItemRequestDTO.md +0 -0
  68. package/docs/DetailedOrderRequestDTO.md +0 -0
  69. package/docs/DivertRequestModel.md +0 -0
  70. package/docs/DivertResponseModel.md +0 -0
  71. package/docs/EdTechProClientEntity.md +0 -0
  72. package/docs/EdTechProSchoolModel.md +0 -0
  73. package/docs/EdTechProSchoolsModel.md +0 -0
  74. package/docs/EdTechProSetupModel.md +0 -0
  75. package/docs/EventDTO.md +35 -0
  76. package/docs/EventRequestDTO.md +25 -0
  77. package/docs/EventSubscriptionModel.md +23 -0
  78. package/docs/EventUpdateDTO.md +27 -0
  79. package/docs/EventUpdateEntity.md +29 -0
  80. package/docs/EventUpdateRequestDTO.md +23 -0
  81. package/docs/FraudManagementModel.md +0 -0
  82. package/docs/FreshdeskCompanyTicketsModel.md +0 -0
  83. package/docs/FreshdeskTicketEntity.md +0 -0
  84. package/docs/FtpAccountsEntity.md +0 -0
  85. package/docs/GenericFileModel.md +0 -0
  86. package/docs/GetGetPrice200Response.md +0 -0
  87. package/docs/GetGetRecording200Response.md +0 -0
  88. package/docs/HostingChangeResponseModel.md +0 -0
  89. package/docs/HostingRegionDTO.md +0 -0
  90. package/docs/InstanceAutoFailoverEntity.md +0 -0
  91. package/docs/InstanceDeletionScheduleEntity.md +0 -0
  92. package/docs/InstanceEntity.md +0 -2
  93. package/docs/InstanceFailoverEntity.md +0 -0
  94. package/docs/InstanceMonitoringEntity.md +0 -0
  95. package/docs/InstanceMonitoringLogEntity.md +0 -0
  96. package/docs/InstanceScheduledTasksEntity.md +0 -0
  97. package/docs/InstanceTcxDetailsEntity.md +0 -0
  98. package/docs/InstanceUserCredentialsEntity.md +0 -0
  99. package/docs/ItemDTO.md +0 -0
  100. package/docs/ItemDiscountEntity.md +0 -0
  101. package/docs/ItemEntity.md +0 -0
  102. package/docs/LinkedOrderEntity.md +0 -0
  103. package/docs/MFARequiredModel.md +0 -0
  104. package/docs/MonthlyUsageModel.md +0 -0
  105. package/docs/MultiTenantChangeResponseModel.md +0 -0
  106. package/docs/MyPBXToolsApi.md +0 -0
  107. package/docs/NavigationModel.md +0 -0
  108. package/docs/OAuth20Api.md +0 -0
  109. package/docs/OfflineInstancesEntity.md +0 -0
  110. package/docs/OrderEntity.md +0 -0
  111. package/docs/OrderRequestModel.md +0 -0
  112. package/docs/OrderSummariesModel.md +0 -0
  113. package/docs/OrderSummaryDTO.md +0 -0
  114. package/docs/OrderTotalModel.md +0 -0
  115. package/docs/OrderedItemEntity.md +0 -0
  116. package/docs/OrdersApi.md +0 -0
  117. package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
  118. package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
  119. package/docs/PortalAccountModel.md +0 -0
  120. package/docs/PortalLoginModel.md +0 -0
  121. package/docs/PostAddWebhook200Response.md +0 -0
  122. package/docs/PostGetClientCredentialsRequest.md +0 -0
  123. package/docs/PostGetProductForCustomerRequest.md +0 -0
  124. package/docs/PostGetProductRequest.md +0 -0
  125. package/docs/PriceListItemModel.md +0 -0
  126. package/docs/PricingApi.md +0 -0
  127. package/docs/PrizesEntity.md +0 -0
  128. package/docs/ProductPriceListItemModel.md +0 -0
  129. package/docs/ProductSearchResultsModel.md +0 -0
  130. package/docs/ProductSerialInfoModel.md +0 -0
  131. package/docs/ProductSummaryDTO.md +0 -0
  132. package/docs/ProductsApi.md +0 -0
  133. package/docs/PromoCodesEntity.md +0 -0
  134. package/docs/PromoItemsEntity.md +0 -0
  135. package/docs/ProvisioningApi.md +0 -0
  136. package/docs/ProvisioningModel.md +0 -0
  137. package/docs/ProvisioningRequestEntity.md +0 -0
  138. package/docs/RecordingBackupAzureModel.md +0 -0
  139. package/docs/RecordingsBackupInfoDTO.md +0 -0
  140. package/docs/ResourceNotReadyException.md +0 -0
  141. package/docs/RootAccessModel.md +0 -0
  142. package/docs/S3BucketEntity.md +0 -0
  143. package/docs/SIPTrunksApi.md +0 -0
  144. package/docs/SMSApi.md +0 -0
  145. package/docs/ScannedItemModel.md +0 -0
  146. package/docs/ScopeModel.md +0 -0
  147. package/docs/ServiceHealthDTO.md +23 -0
  148. package/docs/ServiceStatusDTO.md +27 -0
  149. package/docs/ServicesApi.md +330 -0
  150. package/docs/ShipmentAddressEntity.md +0 -0
  151. package/docs/ShipmentEntity.md +0 -0
  152. package/docs/ShipmentItemEntity.md +0 -0
  153. package/docs/ShippingApi.md +0 -0
  154. package/docs/ShippingConsignmentModel.md +0 -0
  155. package/docs/ShippingInformationDTO.md +0 -0
  156. package/docs/ShippingServiceDTO.md +0 -0
  157. package/docs/ShippingServiceModel.md +0 -0
  158. package/docs/ShippingServicesModel.md +0 -0
  159. package/docs/SipTrunkChangeResponseModel.md +0 -0
  160. package/docs/SipTrunkCreationRequestModel.md +0 -0
  161. package/docs/SipTrunkEntity.md +0 -0
  162. package/docs/SipTrunksResponseModel.md +0 -0
  163. package/docs/SmsAccountEntity.md +0 -0
  164. package/docs/SmsDataModel.md +0 -0
  165. package/docs/SmsMessageModel.md +0 -0
  166. package/docs/SmsNumbersEntity.md +0 -0
  167. package/docs/SmsPayloadModel.md +0 -0
  168. package/docs/SmsPhoneNumberModel.md +0 -0
  169. package/docs/SmsResponseModel.md +0 -0
  170. package/docs/SmsWhitelistEntity.md +0 -0
  171. package/docs/StockManagementApi.md +0 -0
  172. package/docs/StockOrderCourierEntity.md +0 -0
  173. package/docs/StockOrderDeductionModel.md +0 -0
  174. package/docs/StockOrderDeductionRequestModel.md +0 -0
  175. package/docs/StockOrderDeductionsEntity.md +0 -0
  176. package/docs/StockOrderEntity.md +0 -0
  177. package/docs/StockOrderItemEntity.md +0 -0
  178. package/docs/StockOrderItemModel.md +0 -0
  179. package/docs/StockOrderItemRequestModel.md +0 -0
  180. package/docs/StockOrderModel.md +0 -0
  181. package/docs/StockOrderProductEntity.md +0 -0
  182. package/docs/StockOrderRequestModel.md +0 -0
  183. package/docs/StockOrderSupplierEntity.md +0 -0
  184. package/docs/StockOrderSupplierModel.md +0 -0
  185. package/docs/StockOrdersModel.md +0 -0
  186. package/docs/StockProductModel.md +0 -0
  187. package/docs/StockProductPriceModel.md +0 -0
  188. package/docs/StockProductSummariesModel.md +0 -0
  189. package/docs/StockProductSummaryModel.md +0 -0
  190. package/docs/StockTransactionsEntity.md +0 -0
  191. package/docs/SupplierEntity.md +0 -0
  192. package/docs/SupplierItemEntity.md +0 -0
  193. package/docs/SystemApi.md +0 -0
  194. package/docs/TcxBackupEntity.md +0 -0
  195. package/docs/TcxBackupModel.md +0 -0
  196. package/docs/TcxBillingEntity.md +0 -0
  197. package/docs/TcxBulkLicenceDetailsModel.md +0 -0
  198. package/docs/TcxDeadLicenceEntity.md +0 -0
  199. package/docs/TcxExtsEntity.md +0 -0
  200. package/docs/TcxHostingPricingEntity.md +0 -0
  201. package/docs/TcxInstallationDetailsModel.md +0 -0
  202. package/docs/TcxInstallationModel.md +0 -2
  203. package/docs/TcxInstallationsModel.md +0 -0
  204. package/docs/TcxKeySummaryDTO.md +0 -0
  205. package/docs/TcxKeysEntity.md +0 -0
  206. package/docs/TcxLicenceDetailsErrorModel.md +0 -0
  207. package/docs/TcxLicenceDetailsModel.md +0 -0
  208. package/docs/TcxMacsEntity.md +0 -0
  209. package/docs/TcxMultiTenantModel.md +0 -0
  210. package/docs/TcxMultiTenantUserModel.md +0 -0
  211. package/docs/TcxMultiTenantsModel.md +0 -0
  212. package/docs/TcxNumbersEntity.md +0 -0
  213. package/docs/TcxOfficeHoursEntity.md +0 -0
  214. package/docs/TcxPhoneModel.md +0 -0
  215. package/docs/TcxPhonesEntity.md +0 -0
  216. package/docs/TcxRemoteStorageModel.md +0 -0
  217. package/docs/TcxSbcDTO.md +0 -0
  218. package/docs/TcxSbcEntity.md +0 -0
  219. package/docs/TcxSbcModel.md +0 -0
  220. package/docs/TcxSetupEntity.md +0 -0
  221. package/docs/TcxSetupsModel.md +0 -0
  222. package/docs/TcxSipTrunksEntity.md +0 -0
  223. package/docs/TcxTemplateXmlEnum.md +0 -0
  224. package/docs/TcxUsersEntity.md +0 -0
  225. package/docs/TcxWizardConfigModel.md +0 -0
  226. package/docs/TcxWizardModel.md +0 -0
  227. package/docs/TechSupportCompanySummaryDTO.md +0 -0
  228. package/docs/TelephonySupportTicketModel.md +0 -0
  229. package/docs/TicketSummaryModel.md +0 -0
  230. package/docs/TicketTimeDTO.md +0 -0
  231. package/docs/TicketsApi.md +0 -0
  232. package/docs/TokenResponseModel.md +0 -0
  233. package/docs/UpgradeOrderResponseModel.md +0 -0
  234. package/docs/UpgradeRequestModel.md +0 -0
  235. package/docs/UserEntity.md +0 -0
  236. package/docs/WebhooksApi.md +0 -0
  237. package/docs/XeroLogEntity.md +0 -0
  238. package/git_push.sh +0 -0
  239. package/index.ts +1 -1
  240. package/openapitools.json +0 -0
  241. package/package.json +1 -1
  242. package/tsconfig.json +0 -0
package/dist/base.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
3
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
3
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
package/dist/base.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Yellowgrid
6
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
6
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
package/dist/common.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
3
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
3
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
package/dist/common.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Yellowgrid
6
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
6
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
3
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
3
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Yellowgrid
6
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
6
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
3
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
3
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
package/dist/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  /* eslint-disable */
4
4
  /**
5
5
  * Yellowgrid
6
- * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
6
+ * Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
@@ -0,0 +1,23 @@
1
+ # AbstractEventUpdateDTO
2
+
3
+ Abstract Event Update DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | Service Event Update Message | [optional] [default to undefined]
10
+ **type** | **number** | Service Event Update Type | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AbstractEventUpdateDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: AbstractEventUpdateDTO = {
18
+ message,
19
+ type,
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)
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
package/docs/CRMApi.md CHANGED
File without changes
File without changes
File without changes
@@ -36,7 +36,6 @@ All URIs are relative to *http://api.yellowgrid.local*
36
36
  |[**postGetDdisTcxWizard**](#postgetddistcxwizard) | **POST** /tcx/wizards/sip/trunks/{id}/ddis | Add SIP Trunk DDIs|
37
37
  |[**postGetRequestedDdisTcxWizard**](#postgetrequestedddistcxwizard) | **POST** /tcx/wizards/sip/trunks/changes/ddis | Get Requested DDIs|
38
38
  |[**postGetSipTrunksTcxWizard**](#postgetsiptrunkstcxwizard) | **POST** /tcx/wizards/sip/trunks | Create New SIP Trunk|
39
- |[**postTrackChangeTcxWizard**](#posttrackchangetcxwizard) | **POST** /tcx/wizards/sip/trunks/changes/track | Track SIP Trunk Change Request|
40
39
  |[**postUploadBackup**](#postuploadbackup) | **POST** /tcx/wizards/backup | |
41
40
 
42
41
  # **deleteAddExtensions**
@@ -1714,61 +1713,6 @@ const { status, data } = await apiInstance.postGetSipTrunksTcxWizard(
1714
1713
  | **sipTrunkCreationRequestModel** | **SipTrunkCreationRequestModel**| New SIP Trunk Request | |
1715
1714
 
1716
1715
 
1717
- ### Return type
1718
-
1719
- **SipTrunkChangeResponseModel**
1720
-
1721
- ### Authorization
1722
-
1723
- No authorization required
1724
-
1725
- ### HTTP request headers
1726
-
1727
- - **Content-Type**: application/json
1728
- - **Accept**: application/json
1729
-
1730
-
1731
- ### HTTP response details
1732
- | Status code | Description | Response headers |
1733
- |-------------|-------------|------------------|
1734
- |**200** | Change Response | - |
1735
- |**400** | Bad Request | - |
1736
- |**401** | Unauthorised | - |
1737
- |**403** | Access Denied | - |
1738
-
1739
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1740
-
1741
- # **postTrackChangeTcxWizard**
1742
- > SipTrunkChangeResponseModel postTrackChangeTcxWizard()
1743
-
1744
- Track SIP Trunk Change Request
1745
-
1746
- ### Example
1747
-
1748
- ```typescript
1749
- import {
1750
- Class3CXInstallationWizardApi,
1751
- Configuration,
1752
- SipTrunkChangeResponseModel
1753
- } from 'yellowgrid-api-ts';
1754
-
1755
- const configuration = new Configuration();
1756
- const apiInstance = new Class3CXInstallationWizardApi(configuration);
1757
-
1758
- let sipTrunkChangeResponseModel: SipTrunkChangeResponseModel; //Change Request (optional)
1759
-
1760
- const { status, data } = await apiInstance.postTrackChangeTcxWizard(
1761
- sipTrunkChangeResponseModel
1762
- );
1763
- ```
1764
-
1765
- ### Parameters
1766
-
1767
- |Name | Type | Description | Notes|
1768
- |------------- | ------------- | ------------- | -------------|
1769
- | **sipTrunkChangeResponseModel** | **SipTrunkChangeResponseModel**| Change Request | |
1770
-
1771
-
1772
1716
  ### Return type
1773
1717
 
1774
1718
  **SipTrunkChangeResponseModel**
@@ -6,8 +6,6 @@ All URIs are relative to *http://api.yellowgrid.local*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
8
8
  |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
9
- |[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
10
- |[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
11
9
  |[**postCreateSshUser**](#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user|
12
10
  |[**postDeleteInstance**](#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance|
13
11
  |[**postExtendDisk**](#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance|
@@ -144,120 +142,6 @@ No authorization required
144
142
 
145
143
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
146
144
 
147
- # **patchUpdateAutoFailover**
148
- > patchUpdateAutoFailover()
149
-
150
- Update 3CX Instance Auto Failover
151
-
152
- ### Example
153
-
154
- ```typescript
155
- import {
156
- Class3CXInstallationsApi,
157
- Configuration
158
- } from 'yellowgrid-api-ts';
159
-
160
- const configuration = new Configuration();
161
- const apiInstance = new Class3CXInstallationsApi(configuration);
162
-
163
- let instanceId: string; //Instance ID (default to undefined)
164
- let enable: boolean; //Enable (default to undefined)
165
-
166
- const { status, data } = await apiInstance.patchUpdateAutoFailover(
167
- instanceId,
168
- enable
169
- );
170
- ```
171
-
172
- ### Parameters
173
-
174
- |Name | Type | Description | Notes|
175
- |------------- | ------------- | ------------- | -------------|
176
- | **instanceId** | [**string**] | Instance ID | defaults to undefined|
177
- | **enable** | [**boolean**] | Enable | defaults to undefined|
178
-
179
-
180
- ### Return type
181
-
182
- void (empty response body)
183
-
184
- ### Authorization
185
-
186
- No authorization required
187
-
188
- ### HTTP request headers
189
-
190
- - **Content-Type**: Not defined
191
- - **Accept**: Not defined
192
-
193
-
194
- ### HTTP response details
195
- | Status code | Description | Response headers |
196
- |-------------|-------------|------------------|
197
- |**200** | No Response | - |
198
- |**400** | Bad Request | - |
199
- |**401** | Unauthorised | - |
200
- |**403** | Access Denied | - |
201
-
202
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
203
-
204
- # **postAddDisk**
205
- > postAddDisk()
206
-
207
- Add additional disk on 3CX Instance
208
-
209
- ### Example
210
-
211
- ```typescript
212
- import {
213
- Class3CXInstallationsApi,
214
- Configuration
215
- } from 'yellowgrid-api-ts';
216
-
217
- const configuration = new Configuration();
218
- const apiInstance = new Class3CXInstallationsApi(configuration);
219
-
220
- let instanceId: string; //Instance ID (default to undefined)
221
- let gigabytes: number; //Disk Space (GB) (default to undefined)
222
-
223
- const { status, data } = await apiInstance.postAddDisk(
224
- instanceId,
225
- gigabytes
226
- );
227
- ```
228
-
229
- ### Parameters
230
-
231
- |Name | Type | Description | Notes|
232
- |------------- | ------------- | ------------- | -------------|
233
- | **instanceId** | [**string**] | Instance ID | defaults to undefined|
234
- | **gigabytes** | [**number**] | Disk Space (GB) | defaults to undefined|
235
-
236
-
237
- ### Return type
238
-
239
- void (empty response body)
240
-
241
- ### Authorization
242
-
243
- No authorization required
244
-
245
- ### HTTP request headers
246
-
247
- - **Content-Type**: Not defined
248
- - **Accept**: Not defined
249
-
250
-
251
- ### HTTP response details
252
- | Status code | Description | Response headers |
253
- |-------------|-------------|------------------|
254
- |**200** | No Response | - |
255
- |**400** | Bad Request | - |
256
- |**401** | Unauthorised | - |
257
- |**403** | Access Denied | - |
258
-
259
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
260
-
261
145
  # **postCreateSshUser**
262
146
  > RootAccessModel postCreateSshUser()
263
147
 
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -0,0 +1,35 @@
1
+ # EventDTO
2
+
3
+ Service Event DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **title** | **string** | Service Event Title | [optional] [default to undefined]
10
+ **type** | **number** | Service Event Type | [optional] [default to undefined]
11
+ **service** | **number** | Service Impacted | [optional] [default to undefined]
12
+ **statusName** | **string** | Event Status Description | [optional] [default to undefined]
13
+ **typeName** | **string** | Event Type Description | [optional] [default to undefined]
14
+ **id** | **number** | Service Event ID | [optional] [default to undefined]
15
+ **status** | **number** | Service Event Status | [optional] [default to undefined]
16
+ **updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { EventDTO } from 'yellowgrid-api-ts';
22
+
23
+ const instance: EventDTO = {
24
+ title,
25
+ type,
26
+ service,
27
+ statusName,
28
+ typeName,
29
+ id,
30
+ status,
31
+ updates,
32
+ };
33
+ ```
34
+
35
+ [[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
+ # EventRequestDTO
2
+
3
+ Service Event Request DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **title** | **string** | Service Event Title | [optional] [default to undefined]
10
+ **type** | **number** | Service Event Type | [optional] [default to undefined]
11
+ **service** | **number** | Service Impacted | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { EventRequestDTO } from 'yellowgrid-api-ts';
17
+
18
+ const instance: EventRequestDTO = {
19
+ title,
20
+ type,
21
+ service,
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,23 @@
1
+ # EventSubscriptionModel
2
+
3
+ Service Event Subscribption Model
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id | [optional] [default to undefined]
10
+ **email** | **string** | email | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { EventSubscriptionModel } from 'yellowgrid-api-ts';
16
+
17
+ const instance: EventSubscriptionModel = {
18
+ id,
19
+ email,
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,27 @@
1
+ # EventUpdateDTO
2
+
3
+ Service Event Update DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | Service Event Update Message | [optional] [default to undefined]
10
+ **type** | **number** | Service Event Update Type | [optional] [default to undefined]
11
+ **typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
12
+ **createdAt** | **string** | Date Time | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { EventUpdateDTO } from 'yellowgrid-api-ts';
18
+
19
+ const instance: EventUpdateDTO = {
20
+ message,
21
+ type,
22
+ typeName,
23
+ createdAt,
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,29 @@
1
+ # EventUpdateEntity
2
+
3
+ Event Update Entity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **eventId** | **number** | eventId | [optional] [default to undefined]
11
+ **message** | **string** | message | [optional] [default to undefined]
12
+ **type** | **number** | type | [optional] [default to undefined]
13
+ **createdAt** | **string** | createdAt | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { EventUpdateEntity } from 'yellowgrid-api-ts';
19
+
20
+ const instance: EventUpdateEntity = {
21
+ id,
22
+ eventId,
23
+ message,
24
+ type,
25
+ createdAt,
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)
@@ -0,0 +1,23 @@
1
+ # EventUpdateRequestDTO
2
+
3
+ Service Event Update Request DTO
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | Service Event Update Message | [optional] [default to undefined]
10
+ **type** | **number** | Service Event Update Type | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { EventUpdateRequestDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: EventUpdateRequestDTO = {
18
+ message,
19
+ type,
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)
File without changes
File without changes
File without changes
File without changes
File without changes