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
package/git_push.sh ADDED
@@ -0,0 +1,57 @@
1
+ #!/bin/sh
2
+ # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3
+ #
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5
+
6
+ git_user_id=$1
7
+ git_repo_id=$2
8
+ release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
15
+
16
+ if [ "$git_user_id" = "" ]; then
17
+ git_user_id="GIT_USER_ID"
18
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
+ fi
20
+
21
+ if [ "$git_repo_id" = "" ]; then
22
+ git_repo_id="GIT_REPO_ID"
23
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
+ fi
25
+
26
+ if [ "$release_note" = "" ]; then
27
+ release_note="Minor update"
28
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29
+ fi
30
+
31
+ # Initialize the local directory as a Git repository
32
+ git init
33
+
34
+ # Adds the files in the local repository and stages them for commit.
35
+ git add .
36
+
37
+ # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
+ git commit -m "$release_note"
39
+
40
+ # Sets the new remote
41
+ git_remote=$(git remote)
42
+ if [ "$git_remote" = "" ]; then # git remote not defined
43
+
44
+ if [ "$GIT_TOKEN" = "" ]; then
45
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47
+ else
48
+ git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49
+ fi
50
+
51
+ fi
52
+
53
+ git pull origin master
54
+
55
+ # Pushes (Forces) the changes in the local repository up to the remote repository
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57
+ git push origin master 2>&1 | grep -v 'To https'
package/index.ts ADDED
@@ -0,0 +1,18 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Yellowgrid
5
+ * 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
+ *
7
+ * The version of the OpenAPI document: 0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ export * from "./api";
17
+ export * from "./configuration";
18
+
@@ -0,0 +1,7 @@
1
+ {
2
+ "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
3
+ "spaces": 2,
4
+ "generator-cli": {
5
+ "version": "7.14.0"
6
+ }
7
+ }
package/package.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "yellowgrid-api-ts",
3
+ "version": "3.0.79",
4
+ "description": "OpenAPI client for yellowgrid-api-ts",
5
+ "author": "OpenAPI-Generator Contributors",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
9
+ },
10
+ "keywords": [
11
+ "axios",
12
+ "typescript",
13
+ "openapi-client",
14
+ "openapi-generator",
15
+ "yellowgrid-api-ts"
16
+ ],
17
+ "license": "Unlicense",
18
+ "main": "./dist/index.js",
19
+ "typings": "./dist/index.d.ts",
20
+ "scripts": {
21
+ "build": "tsc",
22
+ "prepare": "npm run build"
23
+ },
24
+ "dependencies": {
25
+ "axios": "^1.6.1"
26
+ },
27
+ "devDependencies": {
28
+ "@types/node": "12.11.5 - 12.20.42",
29
+ "typescript": "^4.0 || ^5.0"
30
+ }
31
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,21 @@
1
+ {
2
+ "compilerOptions": {
3
+ "declaration": true,
4
+ "target": "ES5",
5
+ "module": "commonjs",
6
+ "noImplicitAny": true,
7
+ "outDir": "dist",
8
+ "rootDir": ".",
9
+ "lib": [
10
+ "es6",
11
+ "dom"
12
+ ],
13
+ "typeRoots": [
14
+ "node_modules/@types"
15
+ ]
16
+ },
17
+ "exclude": [
18
+ "dist",
19
+ "node_modules"
20
+ ]
21
+ }