@dx-do/client 5.2.49 → 5.2.50

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 (504) hide show
  1. package/dist/index.cjs.js +75923 -0
  2. package/dist/index.cjs.js.map +1 -0
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.esm.js +75590 -0
  5. package/dist/index.esm.js.map +1 -0
  6. package/dist/src/index.d.ts +196 -0
  7. package/dist/src/index.d.ts.map +1 -0
  8. package/dist/src/lib/model/acc/BundleDefinition.d.ts +18 -0
  9. package/dist/src/lib/model/acc/BundleDefinition.d.ts.map +1 -0
  10. package/dist/src/lib/model/acc/BundleDetailResponse.d.ts +53 -0
  11. package/dist/src/lib/model/acc/BundleDetailResponse.d.ts.map +1 -0
  12. package/dist/src/lib/model/acc/BundleImportResponse.d.ts +59 -0
  13. package/dist/src/lib/model/acc/BundleImportResponse.d.ts.map +1 -0
  14. package/dist/src/lib/model/acc/BundleListResponse.d.ts +22 -0
  15. package/dist/src/lib/model/acc/BundleListResponse.d.ts.map +1 -0
  16. package/dist/src/lib/model/acc/PackageBundleResponse.d.ts +59 -0
  17. package/dist/src/lib/model/acc/PackageBundleResponse.d.ts.map +1 -0
  18. package/dist/src/lib/model/acc/PackageCreateResponse.d.ts +103 -0
  19. package/dist/src/lib/model/acc/PackageCreateResponse.d.ts.map +1 -0
  20. package/dist/src/lib/model/acc/PackageCreateSimpleRequest.d.ts +25 -0
  21. package/dist/src/lib/model/acc/PackageCreateSimpleRequest.d.ts.map +1 -0
  22. package/dist/src/lib/model/acc/PackageDetailResponse.d.ts +104 -0
  23. package/dist/src/lib/model/acc/PackageDetailResponse.d.ts.map +1 -0
  24. package/dist/src/lib/model/acc/PackageListResponse.d.ts +36 -0
  25. package/dist/src/lib/model/acc/PackageListResponse.d.ts.map +1 -0
  26. package/dist/src/lib/model/acc/acc-package.d.ts +20 -0
  27. package/dist/src/lib/model/acc/acc-package.d.ts.map +1 -0
  28. package/dist/src/lib/model/agent/AgentLicensing.d.ts +21 -0
  29. package/dist/src/lib/model/agent/AgentLicensing.d.ts.map +1 -0
  30. package/dist/src/lib/model/agent/AgentSourceQuery.d.ts +34 -0
  31. package/dist/src/lib/model/agent/AgentSourceQuery.d.ts.map +1 -0
  32. package/dist/src/lib/model/agent/AgentStatusList.d.ts +20 -0
  33. package/dist/src/lib/model/agent/AgentStatusList.d.ts.map +1 -0
  34. package/dist/src/lib/model/agent/AgentTrace.d.ts +31 -0
  35. package/dist/src/lib/model/agent/AgentTrace.d.ts.map +1 -0
  36. package/dist/src/lib/model/agentnames/AgentNamesResponse.d.ts +10 -0
  37. package/dist/src/lib/model/agentnames/AgentNamesResponse.d.ts.map +1 -0
  38. package/dist/src/lib/model/agentnames/ViewAgentNamesResponse.d.ts +9 -0
  39. package/dist/src/lib/model/agentnames/ViewAgentNamesResponse.d.ts.map +1 -0
  40. package/dist/src/lib/model/alarm/alarm-enrichment-filter.d.ts +33 -0
  41. package/dist/src/lib/model/alarm/alarm-enrichment-filter.d.ts.map +1 -0
  42. package/dist/src/lib/model/alarm/alarm-enrichment.d.ts +47 -0
  43. package/dist/src/lib/model/alarm/alarm-enrichment.d.ts.map +1 -0
  44. package/dist/src/lib/model/alarm/alarm-queue.d.ts +41 -0
  45. package/dist/src/lib/model/alarm/alarm-queue.d.ts.map +1 -0
  46. package/dist/src/lib/model/alarm/related-alarms.d.ts +5 -0
  47. package/dist/src/lib/model/alarm/related-alarms.d.ts.map +1 -0
  48. package/dist/src/lib/model/alert/AlertDefinitionResponse.d.ts +43 -0
  49. package/dist/src/lib/model/alert/AlertDefinitionResponse.d.ts.map +1 -0
  50. package/dist/src/lib/model/alert/AlertRequest.d.ts +12 -0
  51. package/dist/src/lib/model/alert/AlertRequest.d.ts.map +1 -0
  52. package/dist/src/lib/model/alert/AlertResponse.d.ts +34 -0
  53. package/dist/src/lib/model/alert/AlertResponse.d.ts.map +1 -0
  54. package/dist/src/lib/model/alert/AlertResponseV2.d.ts +62 -0
  55. package/dist/src/lib/model/alert/AlertResponseV2.d.ts.map +1 -0
  56. package/dist/src/lib/model/alert/PlatformAlert.d.ts +106 -0
  57. package/dist/src/lib/model/alert/PlatformAlert.d.ts.map +1 -0
  58. package/dist/src/lib/model/apm-universe/APMUniverseResponse.d.ts +126 -0
  59. package/dist/src/lib/model/apm-universe/APMUniverseResponse.d.ts.map +1 -0
  60. package/dist/src/lib/model/apm-universe/CreateAPMUniverse.d.ts +52 -0
  61. package/dist/src/lib/model/apm-universe/CreateAPMUniverse.d.ts.map +1 -0
  62. package/dist/src/lib/model/asm/client/client/client.gen.d.ts +4 -0
  63. package/dist/src/lib/model/asm/client/client/client.gen.d.ts.map +1 -0
  64. package/dist/src/lib/model/asm/client/client/index.d.ts +9 -0
  65. package/dist/src/lib/model/asm/client/client/index.d.ts.map +1 -0
  66. package/dist/src/lib/model/asm/client/client/types.gen.d.ts +89 -0
  67. package/dist/src/lib/model/asm/client/client/types.gen.d.ts.map +1 -0
  68. package/dist/src/lib/model/asm/client/client/utils.gen.d.ts +15 -0
  69. package/dist/src/lib/model/asm/client/client/utils.gen.d.ts.map +1 -0
  70. package/dist/src/lib/model/asm/client/client.gen.d.ts +13 -0
  71. package/dist/src/lib/model/asm/client/client.gen.d.ts.map +1 -0
  72. package/dist/src/lib/model/asm/client/core/auth.gen.d.ts +19 -0
  73. package/dist/src/lib/model/asm/client/core/auth.gen.d.ts.map +1 -0
  74. package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts +26 -0
  75. package/dist/src/lib/model/asm/client/core/bodySerializer.gen.d.ts.map +1 -0
  76. package/dist/src/lib/model/asm/client/core/params.gen.d.ts +44 -0
  77. package/dist/src/lib/model/asm/client/core/params.gen.d.ts.map +1 -0
  78. package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts +34 -0
  79. package/dist/src/lib/model/asm/client/core/pathSerializer.gen.d.ts.map +1 -0
  80. package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts +19 -0
  81. package/dist/src/lib/model/asm/client/core/queryKeySerializer.gen.d.ts.map +1 -0
  82. package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts +72 -0
  83. package/dist/src/lib/model/asm/client/core/serverSentEvents.gen.d.ts.map +1 -0
  84. package/dist/src/lib/model/asm/client/core/types.gen.d.ts +79 -0
  85. package/dist/src/lib/model/asm/client/core/types.gen.d.ts.map +1 -0
  86. package/dist/src/lib/model/asm/client/core/utils.gen.d.ts +20 -0
  87. package/dist/src/lib/model/asm/client/core/utils.gen.d.ts.map +1 -0
  88. package/dist/src/lib/model/asm/client/index.d.ts +3 -0
  89. package/dist/src/lib/model/asm/client/index.d.ts.map +1 -0
  90. package/dist/src/lib/model/asm/client/schemas.gen.d.ts +4546 -0
  91. package/dist/src/lib/model/asm/client/schemas.gen.d.ts.map +1 -0
  92. package/dist/src/lib/model/asm/client/sdk.gen.d.ts +603 -0
  93. package/dist/src/lib/model/asm/client/sdk.gen.d.ts.map +1 -0
  94. package/dist/src/lib/model/asm/client/types.gen.d.ts +4934 -0
  95. package/dist/src/lib/model/asm/client/types.gen.d.ts.map +1 -0
  96. package/dist/src/lib/model/attributes/AttributesResponse.d.ts +11 -0
  97. package/dist/src/lib/model/attributes/AttributesResponse.d.ts.map +1 -0
  98. package/dist/src/lib/model/axa/Activities.d.ts +46 -0
  99. package/dist/src/lib/model/axa/Activities.d.ts.map +1 -0
  100. package/dist/src/lib/model/axa/CreateApplication.d.ts +29 -0
  101. package/dist/src/lib/model/axa/CreateApplication.d.ts.map +1 -0
  102. package/dist/src/lib/model/axa/DataCollectionProfile.d.ts +46 -0
  103. package/dist/src/lib/model/axa/DataCollectionProfile.d.ts.map +1 -0
  104. package/dist/src/lib/model/axa/SessionData.d.ts +35 -0
  105. package/dist/src/lib/model/axa/SessionData.d.ts.map +1 -0
  106. package/dist/src/lib/model/axa/SessionListResponse.d.ts +45 -0
  107. package/dist/src/lib/model/axa/SessionListResponse.d.ts.map +1 -0
  108. package/dist/src/lib/model/axa/UploadCustomBAExtJS.d.ts +6 -0
  109. package/dist/src/lib/model/axa/UploadCustomBAExtJS.d.ts.map +1 -0
  110. package/dist/src/lib/model/axa/bulk-servicify.model.d.ts +17 -0
  111. package/dist/src/lib/model/axa/bulk-servicify.model.d.ts.map +1 -0
  112. package/dist/src/lib/model/axa/crash.d.ts +87 -0
  113. package/dist/src/lib/model/axa/crash.d.ts.map +1 -0
  114. package/dist/src/lib/model/axa/data.d.ts +2 -0
  115. package/dist/src/lib/model/axa/data.d.ts.map +1 -0
  116. package/dist/src/lib/model/blob/blob.model.d.ts +19 -0
  117. package/dist/src/lib/model/blob/blob.model.d.ts.map +1 -0
  118. package/dist/src/lib/model/channel/ChannelCreateRequest.d.ts +22 -0
  119. package/dist/src/lib/model/channel/ChannelCreateRequest.d.ts.map +1 -0
  120. package/dist/src/lib/model/channel/ChannelResponse.d.ts +60 -0
  121. package/dist/src/lib/model/channel/ChannelResponse.d.ts.map +1 -0
  122. package/dist/src/lib/model/channel/PolicyResponse.d.ts +37 -0
  123. package/dist/src/lib/model/channel/PolicyResponse.d.ts.map +1 -0
  124. package/dist/src/lib/model/channel/TemplateCreateRequest.d.ts +19 -0
  125. package/dist/src/lib/model/channel/TemplateCreateRequest.d.ts.map +1 -0
  126. package/dist/src/lib/model/channel/TemplatesResponse.d.ts +33 -0
  127. package/dist/src/lib/model/channel/TemplatesResponse.d.ts.map +1 -0
  128. package/dist/src/lib/model/config/ConnectorConfig.d.ts +8 -0
  129. package/dist/src/lib/model/config/ConnectorConfig.d.ts.map +1 -0
  130. package/dist/src/lib/model/config/DXDoConfiguration.d.ts +30 -0
  131. package/dist/src/lib/model/config/DXDoConfiguration.d.ts.map +1 -0
  132. package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts +64 -0
  133. package/dist/src/lib/model/config/DXSaaSConfiguration.d.ts.map +1 -0
  134. package/dist/src/lib/model/config/DXToken.d.ts +10 -0
  135. package/dist/src/lib/model/config/DXToken.d.ts.map +1 -0
  136. package/dist/src/lib/model/dashboard/DashboardCreateFolderResponse.d.ts +18 -0
  137. package/dist/src/lib/model/dashboard/DashboardCreateFolderResponse.d.ts.map +1 -0
  138. package/dist/src/lib/model/dashboard/DashboardCreateKeyResponse.d.ts +8 -0
  139. package/dist/src/lib/model/dashboard/DashboardCreateKeyResponse.d.ts.map +1 -0
  140. package/dist/src/lib/model/dashboard/DashboardFolderListResponse.d.ts +9 -0
  141. package/dist/src/lib/model/dashboard/DashboardFolderListResponse.d.ts.map +1 -0
  142. package/dist/src/lib/model/dashboard/DashboardListKeysResponse.d.ts +9 -0
  143. package/dist/src/lib/model/dashboard/DashboardListKeysResponse.d.ts.map +1 -0
  144. package/dist/src/lib/model/dashboard/DashboardMServeResponse.d.ts +60 -0
  145. package/dist/src/lib/model/dashboard/DashboardMServeResponse.d.ts.map +1 -0
  146. package/dist/src/lib/model/dashboard/DashboardPermissionsGetResponse.d.ts +26 -0
  147. package/dist/src/lib/model/dashboard/DashboardPermissionsGetResponse.d.ts.map +1 -0
  148. package/dist/src/lib/model/dashboard/DashboardPermissionsUpdateRequest.d.ts +16 -0
  149. package/dist/src/lib/model/dashboard/DashboardPermissionsUpdateRequest.d.ts.map +1 -0
  150. package/dist/src/lib/model/dashboard/DashboardPreferenceResponse.d.ts +7 -0
  151. package/dist/src/lib/model/dashboard/DashboardPreferenceResponse.d.ts.map +1 -0
  152. package/dist/src/lib/model/dashboard/DashboardResponse.d.ts +382 -0
  153. package/dist/src/lib/model/dashboard/DashboardResponse.d.ts.map +1 -0
  154. package/dist/src/lib/model/dashboard/DashboardSearch.d.ts +7 -0
  155. package/dist/src/lib/model/dashboard/DashboardSearch.d.ts.map +1 -0
  156. package/dist/src/lib/model/dashboard/DashboardSearchResponse.d.ts +21 -0
  157. package/dist/src/lib/model/dashboard/DashboardSearchResponse.d.ts.map +1 -0
  158. package/dist/src/lib/model/dashboard/DashboardTags.d.ts +6 -0
  159. package/dist/src/lib/model/dashboard/DashboardTags.d.ts.map +1 -0
  160. package/dist/src/lib/model/dashboard/DashboardUpdate.d.ts +9 -0
  161. package/dist/src/lib/model/dashboard/DashboardUpdate.d.ts.map +1 -0
  162. package/dist/src/lib/model/dashboard/DashboardUserSearchResponse.d.ts +9 -0
  163. package/dist/src/lib/model/dashboard/DashboardUserSearchResponse.d.ts.map +1 -0
  164. package/dist/src/lib/model/dashboard/FolderResponse.d.ts +18 -0
  165. package/dist/src/lib/model/dashboard/FolderResponse.d.ts.map +1 -0
  166. package/dist/src/lib/model/datastore/audit/index.d.ts +4 -0
  167. package/dist/src/lib/model/datastore/audit/index.d.ts.map +1 -0
  168. package/dist/src/lib/model/datastore/audit/query.d.ts +26 -0
  169. package/dist/src/lib/model/datastore/audit/query.d.ts.map +1 -0
  170. package/dist/src/lib/model/datastore/audit/record.d.ts +26 -0
  171. package/dist/src/lib/model/datastore/audit/record.d.ts.map +1 -0
  172. package/dist/src/lib/model/datastore/audit/response.d.ts +52 -0
  173. package/dist/src/lib/model/datastore/audit/response.d.ts.map +1 -0
  174. package/dist/src/lib/model/datastore/blobstorage/filters.d.ts +27 -0
  175. package/dist/src/lib/model/datastore/blobstorage/filters.d.ts.map +1 -0
  176. package/dist/src/lib/model/datastore/blobstorage/index.d.ts +4 -0
  177. package/dist/src/lib/model/datastore/blobstorage/index.d.ts.map +1 -0
  178. package/dist/src/lib/model/datastore/blobstorage/query.d.ts +90 -0
  179. package/dist/src/lib/model/datastore/blobstorage/query.d.ts.map +1 -0
  180. package/dist/src/lib/model/datastore/blobstorage/response.d.ts +120 -0
  181. package/dist/src/lib/model/datastore/blobstorage/response.d.ts.map +1 -0
  182. package/dist/src/lib/model/datastore/datastore-schemas.d.ts +86 -0
  183. package/dist/src/lib/model/datastore/datastore-schemas.d.ts.map +1 -0
  184. package/dist/src/lib/model/datastore/features/feature.d.ts +71 -0
  185. package/dist/src/lib/model/datastore/features/feature.d.ts.map +1 -0
  186. package/dist/src/lib/model/datastore/features/index.d.ts +4 -0
  187. package/dist/src/lib/model/datastore/features/index.d.ts.map +1 -0
  188. package/dist/src/lib/model/datastore/features/query.d.ts +30 -0
  189. package/dist/src/lib/model/datastore/features/query.d.ts.map +1 -0
  190. package/dist/src/lib/model/datastore/features/response.d.ts +8 -0
  191. package/dist/src/lib/model/datastore/features/response.d.ts.map +1 -0
  192. package/dist/src/lib/model/datastore/index.d.ts +5 -0
  193. package/dist/src/lib/model/datastore/index.d.ts.map +1 -0
  194. package/dist/src/lib/model/datastore/metrics-metadata/attribute-name-specifier.d.ts +201 -0
  195. package/dist/src/lib/model/datastore/metrics-metadata/attribute-name-specifier.d.ts.map +1 -0
  196. package/dist/src/lib/model/datastore/metrics-metadata/folder-name-specifier.d.ts +81 -0
  197. package/dist/src/lib/model/datastore/metrics-metadata/folder-name-specifier.d.ts.map +1 -0
  198. package/dist/src/lib/model/datastore/metrics-metadata/index.d.ts +7 -0
  199. package/dist/src/lib/model/datastore/metrics-metadata/index.d.ts.map +1 -0
  200. package/dist/src/lib/model/datastore/metrics-metadata/query-specifier.d.ts +160 -0
  201. package/dist/src/lib/model/datastore/metrics-metadata/query-specifier.d.ts.map +1 -0
  202. package/dist/src/lib/model/datastore/metrics-metadata/query.d.ts +50 -0
  203. package/dist/src/lib/model/datastore/metrics-metadata/query.d.ts.map +1 -0
  204. package/dist/src/lib/model/datastore/metrics-metadata/response.d.ts +44 -0
  205. package/dist/src/lib/model/datastore/metrics-metadata/response.d.ts.map +1 -0
  206. package/dist/src/lib/model/datastore/metrics-metadata/source-name-specifier.d.ts +109 -0
  207. package/dist/src/lib/model/datastore/metrics-metadata/source-name-specifier.d.ts.map +1 -0
  208. package/dist/src/lib/model/datastore/nassql/filter-specs.d.ts +37 -0
  209. package/dist/src/lib/model/datastore/nassql/filter-specs.d.ts.map +1 -0
  210. package/dist/src/lib/model/datastore/nassql/index.d.ts +5 -0
  211. package/dist/src/lib/model/datastore/nassql/index.d.ts.map +1 -0
  212. package/dist/src/lib/model/datastore/nassql/operations.d.ts +506 -0
  213. package/dist/src/lib/model/datastore/nassql/operations.d.ts.map +1 -0
  214. package/dist/src/lib/model/datastore/nassql/query.d.ts +419 -0
  215. package/dist/src/lib/model/datastore/nassql/query.d.ts.map +1 -0
  216. package/dist/src/lib/model/datastore/nassql/response.d.ts +4 -0
  217. package/dist/src/lib/model/datastore/nassql/response.d.ts.map +1 -0
  218. package/dist/src/lib/model/datastore/states/filters.d.ts +73 -0
  219. package/dist/src/lib/model/datastore/states/filters.d.ts.map +1 -0
  220. package/dist/src/lib/model/datastore/states/index.d.ts +4 -0
  221. package/dist/src/lib/model/datastore/states/index.d.ts.map +1 -0
  222. package/dist/src/lib/model/datastore/states/query.d.ts +106 -0
  223. package/dist/src/lib/model/datastore/states/query.d.ts.map +1 -0
  224. package/dist/src/lib/model/datastore/states/response.d.ts +111 -0
  225. package/dist/src/lib/model/datastore/states/response.d.ts.map +1 -0
  226. package/dist/src/lib/model/datastore/tas/filters.d.ts +780 -0
  227. package/dist/src/lib/model/datastore/tas/filters.d.ts.map +1 -0
  228. package/dist/src/lib/model/datastore/tas/index.d.ts +4 -0
  229. package/dist/src/lib/model/datastore/tas/index.d.ts.map +1 -0
  230. package/dist/src/lib/model/datastore/tas/query.d.ts +109 -0
  231. package/dist/src/lib/model/datastore/tas/query.d.ts.map +1 -0
  232. package/dist/src/lib/model/datastore/tas/response.d.ts +459 -0
  233. package/dist/src/lib/model/datastore/tas/response.d.ts.map +1 -0
  234. package/dist/src/lib/model/datastore/tokens/index.d.ts +3 -0
  235. package/dist/src/lib/model/datastore/tokens/index.d.ts.map +1 -0
  236. package/dist/src/lib/model/datastore/tokens/query.d.ts +76 -0
  237. package/dist/src/lib/model/datastore/tokens/query.d.ts.map +1 -0
  238. package/dist/src/lib/model/datastore/tokens/response.d.ts +57 -0
  239. package/dist/src/lib/model/datastore/tokens/response.d.ts.map +1 -0
  240. package/dist/src/lib/model/datastore/views/filters.d.ts +37 -0
  241. package/dist/src/lib/model/datastore/views/filters.d.ts.map +1 -0
  242. package/dist/src/lib/model/datastore/views/index.d.ts +4 -0
  243. package/dist/src/lib/model/datastore/views/index.d.ts.map +1 -0
  244. package/dist/src/lib/model/datastore/views/query.d.ts +117 -0
  245. package/dist/src/lib/model/datastore/views/query.d.ts.map +1 -0
  246. package/dist/src/lib/model/datastore/views/response.d.ts +120 -0
  247. package/dist/src/lib/model/datastore/views/response.d.ts.map +1 -0
  248. package/dist/src/lib/model/dxchannel/DXChannel.d.ts +98 -0
  249. package/dist/src/lib/model/dxchannel/DXChannel.d.ts.map +1 -0
  250. package/dist/src/lib/model/event/event.model.d.ts +175 -0
  251. package/dist/src/lib/model/event/event.model.d.ts.map +1 -0
  252. package/dist/src/lib/model/experience/ApplicationExperienceRequest.d.ts +30 -0
  253. package/dist/src/lib/model/experience/ApplicationExperienceRequest.d.ts.map +1 -0
  254. package/dist/src/lib/model/experience/ApplicationExperienceResponse.d.ts +85 -0
  255. package/dist/src/lib/model/experience/ApplicationExperienceResponse.d.ts.map +1 -0
  256. package/dist/src/lib/model/experience/DashboardExperienceRequest.d.ts +16 -0
  257. package/dist/src/lib/model/experience/DashboardExperienceRequest.d.ts.map +1 -0
  258. package/dist/src/lib/model/experience/ExperienceSettingsResponse.d.ts +50 -0
  259. package/dist/src/lib/model/experience/ExperienceSettingsResponse.d.ts.map +1 -0
  260. package/dist/src/lib/model/filter/platform-filter.d.ts +39 -0
  261. package/dist/src/lib/model/filter/platform-filter.d.ts.map +1 -0
  262. package/dist/src/lib/model/graph/CyModel.d.ts +30 -0
  263. package/dist/src/lib/model/graph/CyModel.d.ts.map +1 -0
  264. package/dist/src/lib/model/graph/GraphElements.d.ts +10 -0
  265. package/dist/src/lib/model/graph/GraphElements.d.ts.map +1 -0
  266. package/dist/src/lib/model/graph/GraphRequest.d.ts +10 -0
  267. package/dist/src/lib/model/graph/GraphRequest.d.ts.map +1 -0
  268. package/dist/src/lib/model/graph/GraphResponse.d.ts +61 -0
  269. package/dist/src/lib/model/graph/GraphResponse.d.ts.map +1 -0
  270. package/dist/src/lib/model/graph/GraphStore.d.ts +25 -0
  271. package/dist/src/lib/model/graph/GraphStore.d.ts.map +1 -0
  272. package/dist/src/lib/model/graph/handlers.d.ts +6 -0
  273. package/dist/src/lib/model/graph/handlers.d.ts.map +1 -0
  274. package/dist/src/lib/model/inventory/attributes.d.ts +38 -0
  275. package/dist/src/lib/model/inventory/attributes.d.ts.map +1 -0
  276. package/dist/src/lib/model/inventory/inventorize.d.ts +119 -0
  277. package/dist/src/lib/model/inventory/inventorize.d.ts.map +1 -0
  278. package/dist/src/lib/model/inventory/inventory-lookup.d.ts +18 -0
  279. package/dist/src/lib/model/inventory/inventory-lookup.d.ts.map +1 -0
  280. package/dist/src/lib/model/inventory/inventory-search.d.ts +59 -0
  281. package/dist/src/lib/model/inventory/inventory-search.d.ts.map +1 -0
  282. package/dist/src/lib/model/jsextension/JavascriptExtensionsResponse.d.ts +10 -0
  283. package/dist/src/lib/model/jsextension/JavascriptExtensionsResponse.d.ts.map +1 -0
  284. package/dist/src/lib/model/log/query-body.d.ts +56 -0
  285. package/dist/src/lib/model/log/query-body.d.ts.map +1 -0
  286. package/dist/src/lib/model/managementmodule/CalculatorsResponse.d.ts +27 -0
  287. package/dist/src/lib/model/managementmodule/CalculatorsResponse.d.ts.map +1 -0
  288. package/dist/src/lib/model/managementmodule/ManagementModuleAlertList.d.ts +9 -0
  289. package/dist/src/lib/model/managementmodule/ManagementModuleAlertList.d.ts.map +1 -0
  290. package/dist/src/lib/model/managementmodule/ManagementModuleCreate.d.ts +22 -0
  291. package/dist/src/lib/model/managementmodule/ManagementModuleCreate.d.ts.map +1 -0
  292. package/dist/src/lib/model/managementmodule/ManagementModuleListRequest.d.ts +10 -0
  293. package/dist/src/lib/model/managementmodule/ManagementModuleListRequest.d.ts.map +1 -0
  294. package/dist/src/lib/model/managementmodule/ManagementModuleListResponse.d.ts +29 -0
  295. package/dist/src/lib/model/managementmodule/ManagementModuleListResponse.d.ts.map +1 -0
  296. package/dist/src/lib/model/managementmodule/ManagementModuleUpdate.d.ts +11 -0
  297. package/dist/src/lib/model/managementmodule/ManagementModuleUpdate.d.ts.map +1 -0
  298. package/dist/src/lib/model/managementmodule/PlatformManagementModule.d.ts +71 -0
  299. package/dist/src/lib/model/managementmodule/PlatformManagementModule.d.ts.map +1 -0
  300. package/dist/src/lib/model/metric/MetricAttributeResponse.d.ts +18 -0
  301. package/dist/src/lib/model/metric/MetricAttributeResponse.d.ts.map +1 -0
  302. package/dist/src/lib/model/metric/MetricBatchRequest.d.ts +35 -0
  303. package/dist/src/lib/model/metric/MetricBatchRequest.d.ts.map +1 -0
  304. package/dist/src/lib/model/metric/MetricBatchResponse.d.ts +29 -0
  305. package/dist/src/lib/model/metric/MetricBatchResponse.d.ts.map +1 -0
  306. package/dist/src/lib/model/metric/MetricQueryRequest.d.ts +27 -0
  307. package/dist/src/lib/model/metric/MetricQueryRequest.d.ts.map +1 -0
  308. package/dist/src/lib/model/metric/MetricTreeRequest.d.ts +13 -0
  309. package/dist/src/lib/model/metric/MetricTreeRequest.d.ts.map +1 -0
  310. package/dist/src/lib/model/metric/MetricTreeResponse.d.ts +13 -0
  311. package/dist/src/lib/model/metric/MetricTreeResponse.d.ts.map +1 -0
  312. package/dist/src/lib/model/metric/VertexMetricQueryResponse.d.ts +14 -0
  313. package/dist/src/lib/model/metric/VertexMetricQueryResponse.d.ts.map +1 -0
  314. package/dist/src/lib/model/metricgrouping/MetricGroupingCreate.d.ts +17 -0
  315. package/dist/src/lib/model/metricgrouping/MetricGroupingCreate.d.ts.map +1 -0
  316. package/dist/src/lib/model/metricgrouping/MetricGroupingResponse.d.ts +64 -0
  317. package/dist/src/lib/model/metricgrouping/MetricGroupingResponse.d.ts.map +1 -0
  318. package/dist/src/lib/model/metricgrouping/PlatformMetricGrouping.d.ts +107 -0
  319. package/dist/src/lib/model/metricgrouping/PlatformMetricGrouping.d.ts.map +1 -0
  320. package/dist/src/lib/model/nass/NASS.d.ts +90 -0
  321. package/dist/src/lib/model/nass/NASS.d.ts.map +1 -0
  322. package/dist/src/lib/model/notification/NotificationChannelsResponse.d.ts +18 -0
  323. package/dist/src/lib/model/notification/NotificationChannelsResponse.d.ts.map +1 -0
  324. package/dist/src/lib/model/notification/NotificationServicesResponse.d.ts +16 -0
  325. package/dist/src/lib/model/notification/NotificationServicesResponse.d.ts.map +1 -0
  326. package/dist/src/lib/model/o2-universe/CreateO2Universe.d.ts +5 -0
  327. package/dist/src/lib/model/o2-universe/CreateO2Universe.d.ts.map +1 -0
  328. package/dist/src/lib/model/o2-universe/O2Universe.d.ts +77 -0
  329. package/dist/src/lib/model/o2-universe/O2Universe.d.ts.map +1 -0
  330. package/dist/src/lib/model/oi/alarms.d.ts +188 -0
  331. package/dist/src/lib/model/oi/alarms.d.ts.map +1 -0
  332. package/dist/src/lib/model/oi/entity.d.ts +13 -0
  333. package/dist/src/lib/model/oi/entity.d.ts.map +1 -0
  334. package/dist/src/lib/model/oi/services.create.d.ts +70 -0
  335. package/dist/src/lib/model/oi/services.create.d.ts.map +1 -0
  336. package/dist/src/lib/model/oi/services.d.ts +125 -0
  337. package/dist/src/lib/model/oi/services.d.ts.map +1 -0
  338. package/dist/src/lib/model/oi/services.sample.d.ts +2 -0
  339. package/dist/src/lib/model/oi/services.sample.d.ts.map +1 -0
  340. package/dist/src/lib/model/oi/users.d.ts +10 -0
  341. package/dist/src/lib/model/oi/users.d.ts.map +1 -0
  342. package/dist/src/lib/model/postman/Postman.d.ts +58 -0
  343. package/dist/src/lib/model/postman/Postman.d.ts.map +1 -0
  344. package/dist/src/lib/model/remote/Remote.d.ts +23 -0
  345. package/dist/src/lib/model/remote/Remote.d.ts.map +1 -0
  346. package/dist/src/lib/model/request/SaaSRequestConfig.d.ts +8 -0
  347. package/dist/src/lib/model/request/SaaSRequestConfig.d.ts.map +1 -0
  348. package/dist/src/lib/model/request/SimpleHTTPError.d.ts +9 -0
  349. package/dist/src/lib/model/request/SimpleHTTPError.d.ts.map +1 -0
  350. package/dist/src/lib/model/security/ACAGroup.d.ts +13 -0
  351. package/dist/src/lib/model/security/ACAGroup.d.ts.map +1 -0
  352. package/dist/src/lib/model/security/ACAUser.d.ts +16 -0
  353. package/dist/src/lib/model/security/ACAUser.d.ts.map +1 -0
  354. package/dist/src/lib/model/security/MeResponse.d.ts +31 -0
  355. package/dist/src/lib/model/security/MeResponse.d.ts.map +1 -0
  356. package/dist/src/lib/model/service/service-detail.d.ts +46 -0
  357. package/dist/src/lib/model/service/service-detail.d.ts.map +1 -0
  358. package/dist/src/lib/model/service/service-overview.d.ts +27 -0
  359. package/dist/src/lib/model/service/service-overview.d.ts.map +1 -0
  360. package/dist/src/lib/model/service/service-search.d.ts +17 -0
  361. package/dist/src/lib/model/service/service-search.d.ts.map +1 -0
  362. package/dist/src/lib/model/service/slis.d.ts +47 -0
  363. package/dist/src/lib/model/service/slis.d.ts.map +1 -0
  364. package/dist/src/lib/model/situations/SituationLifecycle.d.ts +16 -0
  365. package/dist/src/lib/model/situations/SituationLifecycle.d.ts.map +1 -0
  366. package/dist/src/lib/model/situations/Situations.d.ts +177 -0
  367. package/dist/src/lib/model/situations/Situations.d.ts.map +1 -0
  368. package/dist/src/lib/model/situations/situation-inspect.d.ts +127 -0
  369. package/dist/src/lib/model/situations/situation-inspect.d.ts.map +1 -0
  370. package/dist/src/lib/model/situations/situation-summary.d.ts +60 -0
  371. package/dist/src/lib/model/situations/situation-summary.d.ts.map +1 -0
  372. package/dist/src/lib/model/sql/QueryResponse.d.ts +11 -0
  373. package/dist/src/lib/model/sql/QueryResponse.d.ts.map +1 -0
  374. package/dist/src/lib/model/tas/TAS.d.ts +276 -0
  375. package/dist/src/lib/model/tas/TAS.d.ts.map +1 -0
  376. package/dist/src/lib/model/tas/TASGraph.d.ts +39 -0
  377. package/dist/src/lib/model/tas/TASGraph.d.ts.map +1 -0
  378. package/dist/src/lib/model/tas/TASResponse.d.ts +44 -0
  379. package/dist/src/lib/model/tas/TASResponse.d.ts.map +1 -0
  380. package/dist/src/lib/model/trace/ThreadDump.d.ts +50 -0
  381. package/dist/src/lib/model/trace/ThreadDump.d.ts.map +1 -0
  382. package/dist/src/lib/model/trace/Trace.d.ts +94 -0
  383. package/dist/src/lib/model/trace/Trace.d.ts.map +1 -0
  384. package/dist/src/lib/model/vertex/AttributeValuesResponse.d.ts +15 -0
  385. package/dist/src/lib/model/vertex/AttributeValuesResponse.d.ts.map +1 -0
  386. package/dist/src/lib/model/vertex/BulkVertexPatch.d.ts +32 -0
  387. package/dist/src/lib/model/vertex/BulkVertexPatch.d.ts.map +1 -0
  388. package/dist/src/lib/model/vertex/Perspectives.d.ts +20 -0
  389. package/dist/src/lib/model/vertex/Perspectives.d.ts.map +1 -0
  390. package/dist/src/lib/model/vertex/RESTVertexResponse.d.ts +23 -0
  391. package/dist/src/lib/model/vertex/RESTVertexResponse.d.ts.map +1 -0
  392. package/dist/src/lib/model/vertex/VertexDefinition.d.ts +46 -0
  393. package/dist/src/lib/model/vertex/VertexDefinition.d.ts.map +1 -0
  394. package/dist/src/lib/model/vertex/VertexMappingConfiguration.d.ts +51 -0
  395. package/dist/src/lib/model/vertex/VertexMappingConfiguration.d.ts.map +1 -0
  396. package/dist/src/lib/model/vertex/VertexRequest.d.ts +20 -0
  397. package/dist/src/lib/model/vertex/VertexRequest.d.ts.map +1 -0
  398. package/dist/src/lib/model/vertex/VertexResponse.d.ts +25 -0
  399. package/dist/src/lib/model/vertex/VertexResponse.d.ts.map +1 -0
  400. package/dist/src/lib/model/vertex/VertexStateResponse.d.ts +32 -0
  401. package/dist/src/lib/model/vertex/VertexStateResponse.d.ts.map +1 -0
  402. package/dist/src/lib/model/vertex/VertexStatusChanges.d.ts +37 -0
  403. package/dist/src/lib/model/vertex/VertexStatusChanges.d.ts.map +1 -0
  404. package/dist/src/lib/services/acc.service.d.ts +193 -0
  405. package/dist/src/lib/services/acc.service.d.ts.map +1 -0
  406. package/dist/src/lib/services/agent.service.d.ts +99 -0
  407. package/dist/src/lib/services/agent.service.d.ts.map +1 -0
  408. package/dist/src/lib/services/alarm.service.d.ts +56 -0
  409. package/dist/src/lib/services/alarm.service.d.ts.map +1 -0
  410. package/dist/src/lib/services/alert.service.d.ts +54 -0
  411. package/dist/src/lib/services/alert.service.d.ts.map +1 -0
  412. package/dist/src/lib/services/apm-universe.service.d.ts +23 -0
  413. package/dist/src/lib/services/apm-universe.service.d.ts.map +1 -0
  414. package/dist/src/lib/services/asm.service.d.ts +22 -0
  415. package/dist/src/lib/services/asm.service.d.ts.map +1 -0
  416. package/dist/src/lib/services/attribute.service.d.ts +26 -0
  417. package/dist/src/lib/services/attribute.service.d.ts.map +1 -0
  418. package/dist/src/lib/services/authorization.service.d.ts +25 -0
  419. package/dist/src/lib/services/authorization.service.d.ts.map +1 -0
  420. package/dist/src/lib/services/axa.service.d.ts +69 -0
  421. package/dist/src/lib/services/axa.service.d.ts.map +1 -0
  422. package/dist/src/lib/services/blob.service.d.ts +24 -0
  423. package/dist/src/lib/services/blob.service.d.ts.map +1 -0
  424. package/dist/src/lib/services/channel.service.d.ts +43 -0
  425. package/dist/src/lib/services/channel.service.d.ts.map +1 -0
  426. package/dist/src/lib/services/dashboard.service.d.ts +75 -0
  427. package/dist/src/lib/services/dashboard.service.d.ts.map +1 -0
  428. package/dist/src/lib/services/datastore/datastore-audit.service.d.ts +47 -0
  429. package/dist/src/lib/services/datastore/datastore-audit.service.d.ts.map +1 -0
  430. package/dist/src/lib/services/datastore/datastore-auth-views.service.d.ts +72 -0
  431. package/dist/src/lib/services/datastore/datastore-auth-views.service.d.ts.map +1 -0
  432. package/dist/src/lib/services/datastore/datastore-blobstorage.service.d.ts +100 -0
  433. package/dist/src/lib/services/datastore/datastore-blobstorage.service.d.ts.map +1 -0
  434. package/dist/src/lib/services/datastore/datastore-features.service.d.ts +66 -0
  435. package/dist/src/lib/services/datastore/datastore-features.service.d.ts.map +1 -0
  436. package/dist/src/lib/services/datastore/datastore-metrics-metadata.service.d.ts +52 -0
  437. package/dist/src/lib/services/datastore/datastore-metrics-metadata.service.d.ts.map +1 -0
  438. package/dist/src/lib/services/datastore/datastore-nassql.service.d.ts +86 -0
  439. package/dist/src/lib/services/datastore/datastore-nassql.service.d.ts.map +1 -0
  440. package/dist/src/lib/services/datastore/datastore-states.service.d.ts +63 -0
  441. package/dist/src/lib/services/datastore/datastore-states.service.d.ts.map +1 -0
  442. package/dist/src/lib/services/datastore/datastore-tas.service.d.ts +112 -0
  443. package/dist/src/lib/services/datastore/datastore-tas.service.d.ts.map +1 -0
  444. package/dist/src/lib/services/datastore/datastore-tokens.service.d.ts +98 -0
  445. package/dist/src/lib/services/datastore/datastore-tokens.service.d.ts.map +1 -0
  446. package/dist/src/lib/services/dx-saas.service.d.ts +243 -0
  447. package/dist/src/lib/services/dx-saas.service.d.ts.map +1 -0
  448. package/dist/src/lib/services/dxoi.service.d.ts +27 -0
  449. package/dist/src/lib/services/dxoi.service.d.ts.map +1 -0
  450. package/dist/src/lib/services/event.service.d.ts +27 -0
  451. package/dist/src/lib/services/event.service.d.ts.map +1 -0
  452. package/dist/src/lib/services/experience.service.d.ts +42 -0
  453. package/dist/src/lib/services/experience.service.d.ts.map +1 -0
  454. package/dist/src/lib/services/graph.service.d.ts +34 -0
  455. package/dist/src/lib/services/graph.service.d.ts.map +1 -0
  456. package/dist/src/lib/services/inventory.service.d.ts +61 -0
  457. package/dist/src/lib/services/inventory.service.d.ts.map +1 -0
  458. package/dist/src/lib/services/js-extension.service.d.ts +27 -0
  459. package/dist/src/lib/services/js-extension.service.d.ts.map +1 -0
  460. package/dist/src/lib/services/logs.service.d.ts +13 -0
  461. package/dist/src/lib/services/logs.service.d.ts.map +1 -0
  462. package/dist/src/lib/services/management-module.service.d.ts +39 -0
  463. package/dist/src/lib/services/management-module.service.d.ts.map +1 -0
  464. package/dist/src/lib/services/metric-batch.service.d.ts +47 -0
  465. package/dist/src/lib/services/metric-batch.service.d.ts.map +1 -0
  466. package/dist/src/lib/services/metric-grouping.service.d.ts +34 -0
  467. package/dist/src/lib/services/metric-grouping.service.d.ts.map +1 -0
  468. package/dist/src/lib/services/nass.service.d.ts +38 -0
  469. package/dist/src/lib/services/nass.service.d.ts.map +1 -0
  470. package/dist/src/lib/services/notification.service.d.ts +13 -0
  471. package/dist/src/lib/services/notification.service.d.ts.map +1 -0
  472. package/dist/src/lib/services/o2-notification.service.d.ts +13 -0
  473. package/dist/src/lib/services/o2-notification.service.d.ts.map +1 -0
  474. package/dist/src/lib/services/o2-universe.service.d.ts +42 -0
  475. package/dist/src/lib/services/o2-universe.service.d.ts.map +1 -0
  476. package/dist/src/lib/services/perspective.service.d.ts +22 -0
  477. package/dist/src/lib/services/perspective.service.d.ts.map +1 -0
  478. package/dist/src/lib/services/platform-alert.service.d.ts +28 -0
  479. package/dist/src/lib/services/platform-alert.service.d.ts.map +1 -0
  480. package/dist/src/lib/services/platform-management-module.service.d.ts +21 -0
  481. package/dist/src/lib/services/platform-management-module.service.d.ts.map +1 -0
  482. package/dist/src/lib/services/platform-metric-grouping.service.d.ts +24 -0
  483. package/dist/src/lib/services/platform-metric-grouping.service.d.ts.map +1 -0
  484. package/dist/src/lib/services/service-monolith.d.ts +126 -0
  485. package/dist/src/lib/services/service-monolith.d.ts.map +1 -0
  486. package/dist/src/lib/services/service.service.d.ts +68 -0
  487. package/dist/src/lib/services/service.service.d.ts.map +1 -0
  488. package/dist/src/lib/services/session.service.d.ts +17 -0
  489. package/dist/src/lib/services/session.service.d.ts.map +1 -0
  490. package/dist/src/lib/services/situation.service.d.ts +38 -0
  491. package/dist/src/lib/services/situation.service.d.ts.map +1 -0
  492. package/dist/src/lib/services/sql.service.d.ts +13 -0
  493. package/dist/src/lib/services/sql.service.d.ts.map +1 -0
  494. package/dist/src/lib/services/tas.service.d.ts +24 -0
  495. package/dist/src/lib/services/tas.service.d.ts.map +1 -0
  496. package/dist/src/lib/services/vertex.service.d.ts +93 -0
  497. package/dist/src/lib/services/vertex.service.d.ts.map +1 -0
  498. package/dist/src/lib/util/config/config.d.ts +12 -0
  499. package/dist/src/lib/util/config/config.d.ts.map +1 -0
  500. package/dist/src/lib/util/regex/escape.d.ts +2 -0
  501. package/dist/src/lib/util/regex/escape.d.ts.map +1 -0
  502. package/dist/src/lib/util/vertex/vertex-search.d.ts +30 -0
  503. package/dist/src/lib/util/vertex/vertex-search.d.ts.map +1 -0
  504. package/package.json +1 -1
@@ -0,0 +1,4934 @@
1
+ export type ClientOptions = {
2
+ baseURL: `${string}://${string}/{version}` | (string & {});
3
+ };
4
+ export type ApiTokenNotFound = {
5
+ status?: string;
6
+ message?: string;
7
+ };
8
+ export type ApiToken = {
9
+ id?: number;
10
+ name?: string;
11
+ valid_until?: string | null;
12
+ created?: string;
13
+ };
14
+ export type ContactAuth = {
15
+ /**
16
+ * The supported authentication method.
17
+ */
18
+ type: "basic" | "bearer";
19
+ /**
20
+ * User name if the authentication type requires it
21
+ */
22
+ user?: string | null;
23
+ /**
24
+ * The authentication secret or token. This value is not sent in GET requests, it can only be created or updated.
25
+ */
26
+ secret?: string | null;
27
+ };
28
+ export type ContactCatalogue = {
29
+ folders: Array<ResourceGroupItemWithPermission>;
30
+ contacts: Array<ContactItem>;
31
+ };
32
+ export type ContactItem = {
33
+ id: number;
34
+ name: string;
35
+ /**
36
+ * Group contacts are containers for standard contacts - members.
37
+ */
38
+ type: "email" | "sms" | "phone" | "action" | "rss" | "group";
39
+ /**
40
+ * Not used for group contact type
41
+ */
42
+ address?: string;
43
+ /**
44
+ * 0=invalid,1=unconfirmed,2=active,3=blocked,4=inactive
45
+ */
46
+ status: 0 | 1 | 2 | 3 | 4;
47
+ default: boolean;
48
+ ownerId?: number;
49
+ folderId?: number | null;
50
+ /**
51
+ * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted.
52
+ */
53
+ workingFrom?: string;
54
+ /**
55
+ * Time HH:ss in contact's time zone; workingFrom and workingTo represent time interval when the contact can be alerted.
56
+ */
57
+ workingTo?: string;
58
+ /**
59
+ * Days when the contact can be used for alerting. 0 = Monday ... 6 = Sunday
60
+ */
61
+ workingDays?: Array<number>;
62
+ /**
63
+ * This time zone is used both for date formating in alert messages
64
+ * and for the contact's working hours (workingFrom, workingTo). If
65
+ * empty the time zone of the account is assumed.
66
+ */
67
+ timezone?: string | null;
68
+ /**
69
+ * For contact groups it contains list of members. For all but contact groups it contains list of groups this contact is member of.
70
+ */
71
+ members?: Array<ContactGroupMemberItem>;
72
+ /**
73
+ * Authentication details. Authentication can be added for the action url contact type only.
74
+ */
75
+ auth?: ContactAuth | {
76
+ [key: string]: unknown;
77
+ } | null;
78
+ /**
79
+ * Special flags specific for the contact type. Currently, only action contact type supports specifications.
80
+ * Json changes the content type for the action url to send message as a json instead of standard application/x-www-form-urlencoded.
81
+ * gchat changes both content type and message form to send message to a Google chat webhook.
82
+ */
83
+ specification?: "json" | "gchat";
84
+ };
85
+ export type ContactItemCreate = ContactItemUpdate & {
86
+ type: "email" | "sms" | "phone" | "action" | "rss" | "group";
87
+ };
88
+ export type ContactItemUpdate = {
89
+ name?: string | null;
90
+ /**
91
+ * Address of the contact. The scheme depends on the contact type.
92
+ */
93
+ address?: string | null;
94
+ /**
95
+ * Is this contact the default account contact? Only one contact can be default.
96
+ */
97
+ default?: boolean | null;
98
+ /**
99
+ * ID of the folder this contact should be assigned to
100
+ */
101
+ folderId?: number | null;
102
+ /**
103
+ * Time HH:ss in contact's time zone; workingFrom and workingTo represent time
104
+ * interval when the contact can be alerted. Do not use for contact groups.
105
+ */
106
+ workingFrom?: string;
107
+ /**
108
+ * Time HH:ss in contact's time zone; workingFrom and workingTo represent time
109
+ * interval when the contact can be alerted. Do not use for contact groups.
110
+ */
111
+ workingTo?: string | null;
112
+ /**
113
+ * Days when the contact can be alerted. Do not use for contact groups.
114
+ */
115
+ workingDays?: Array<number> | null;
116
+ /**
117
+ * This time zone is used both for date formating in alert messages and for the
118
+ * contact's working hours (workingFrom, workingTo). Set the time zone only if
119
+ * you want another TZ for this particular contact, the time zone of the account
120
+ * is assumed by default. For updating use null to reset TZ, omit completely to
121
+ * keep the current value. Do not use for contact groups.
122
+ */
123
+ timezone?: string | null;
124
+ /**
125
+ * For all contact types but group this parameter must be empty. For contact groups
126
+ * it is required and must contain list of member contact IDs.
127
+ */
128
+ members?: Array<ContactGroupMemberCreate> | null;
129
+ /**
130
+ * Authentication details. Authentication can be added for the action url contact type only.
131
+ */
132
+ auth?: ContactAuth | {
133
+ [key: string]: unknown;
134
+ } | null;
135
+ /**
136
+ * Special flags specific for the contact type. Currently, only action contact type supports specifications.
137
+ * Json changes the content type for the action url to send message as a json instead
138
+ * of standard application/x-www-form-urlencoded.
139
+ * gchat changes both content type and message form to send message to a Google chat webhook.
140
+ */
141
+ specification?: "json" | "gchat";
142
+ };
143
+ export type ContactGroupMemberItem = {
144
+ /**
145
+ * ID of the contact (member of the group)
146
+ */
147
+ contactId: number;
148
+ /**
149
+ * ID of the group (contact of type group) the contact is member of
150
+ */
151
+ groupId: number;
152
+ /**
153
+ * Send alert after (alertAfter-1) errors. 0 means alert immediately (after 1 error), 1 after 2 errors, etc.
154
+ */
155
+ alertAfter: 0 | 1 | 2 | 3 | 4;
156
+ };
157
+ export type ContactGroupMemberCreate = {
158
+ /**
159
+ * ID of the contact (member of the group)
160
+ */
161
+ contactId: number;
162
+ /**
163
+ * Send alert after (alertAfter-1) errors. 0 means alert immediately (after 1 error), 1 after 2 errors, etc.
164
+ */
165
+ alertAfter: 0 | 1 | 2 | 3 | 4;
166
+ };
167
+ export type MaintenanceCatalogue = {
168
+ folders: Array<ResourceGroupItemWithPermission>;
169
+ maintenances: Array<MaintenanceItem>;
170
+ };
171
+ export type MaintenanceItem = {
172
+ id: number;
173
+ name: string;
174
+ timezone: string;
175
+ ruleCount: number;
176
+ description?: string;
177
+ persistent?: boolean;
178
+ windows?: Array<MaintenanceWindowItem>;
179
+ permission?: PermissionItem;
180
+ ownerId?: number;
181
+ folderId?: number | null;
182
+ monitorIds?: Array<number>;
183
+ immediateForRuleId?: number | null;
184
+ };
185
+ export type MaintenanceItemCreate = {
186
+ name?: string;
187
+ timezone?: string;
188
+ description?: string;
189
+ persistent?: boolean;
190
+ windows?: Array<WindowItemCreate>;
191
+ folderId?: number | null;
192
+ monitorIds?: Array<number>;
193
+ };
194
+ export type MaintenanceItemImmediateCreate = {
195
+ /**
196
+ * Start of the maintenance window, current time if empty. Format: ISO 8601 date
197
+ * and time with or without timezone. Current user's timezone is used by default.
198
+ */
199
+ from?: string | null;
200
+ /**
201
+ * Duration of the immediate maintenance window, format [H][H]H:MM
202
+ */
203
+ duration: string;
204
+ /**
205
+ * Ids of monitors this maintenance should be assigned to. You need update permission for these monitors
206
+ */
207
+ monitorIds: Array<number>;
208
+ };
209
+ export type MaintenanceWindowItem = {
210
+ id?: number | null;
211
+ type: "fixed" | "daily" | "weekly" | "monthly";
212
+ status: "active" | "waiting" | "passed";
213
+ from: string;
214
+ to?: string;
215
+ effectiveTo?: string;
216
+ /**
217
+ * For repeating time windows means repeat every N (days, weeks, months).
218
+ */
219
+ repeat?: number | null;
220
+ /**
221
+ * For weekly recurring time window: 0 - Monday, 6 - Sunday
222
+ */
223
+ dow?: Array<number> | null;
224
+ };
225
+ export type WindowItemCreate = {
226
+ /**
227
+ * This parameter is always required
228
+ */
229
+ type?: "fixed" | "daily" | "weekly" | "montly";
230
+ /**
231
+ * This parameter is always required. The time can either be specified without the
232
+ * time zone or with timezone. In the first case, the maintenance window TZ is used,
233
+ * in the latter case the time zone is respected but translated to the TZ of the maintenance window.
234
+ */
235
+ from?: string;
236
+ /**
237
+ * End time of this window applicability. Required for these types: fixed
238
+ */
239
+ to?: string;
240
+ /**
241
+ * For repeating time windows means repeat every N (days, weeks, months). Required for all but fixed type.
242
+ */
243
+ repeat?: number | null;
244
+ /**
245
+ * The end time for repeatable time windows. This value is
246
+ * in the same TZ as the from field (either explicit or inherited from the maintenance
247
+ * window it belongs to). Required for these types: daily, weekly, monthly.
248
+ */
249
+ endTime?: string | null;
250
+ /**
251
+ * For weekly recurring time window applicable days: 0 - Monday, 6 - Sunday.
252
+ */
253
+ dow?: Array<number> | null;
254
+ };
255
+ export type MessageItem = {
256
+ id: number;
257
+ entered: string;
258
+ sent?: string | null;
259
+ /**
260
+ * Monitor ID
261
+ */
262
+ monitorId?: number | null;
263
+ /**
264
+ * Contact ID
265
+ */
266
+ contactId?: number | null;
267
+ /**
268
+ * Contact type
269
+ */
270
+ type: "email" | "sms" | "phone" | "action" | "rss";
271
+ /**
272
+ * Monitor ID
273
+ */
274
+ address?: string;
275
+ /**
276
+ * Message delivery status
277
+ */
278
+ status: "deleted" | "queued" | "gateway" | "provider" | "device" | "accepted" | "queued-no-fallback" | "undeliverable" | "suppressed";
279
+ /**
280
+ * Monitor log event uuid
281
+ */
282
+ eventId?: string | null;
283
+ /**
284
+ * Text of the message
285
+ */
286
+ message?: string;
287
+ };
288
+ /**
289
+ * This schema is used to return a page from the list of monitors with additional pagination information
290
+ */
291
+ export type MonitorsPage = {
292
+ /**
293
+ * List of monitors.
294
+ */
295
+ monitors?: Array<Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver>;
296
+ /**
297
+ * Number of monitors returned in the monitors array.
298
+ */
299
+ numMonitors?: number;
300
+ /**
301
+ * Number of unique folders returned the returned monitors belong to. These folders are also attached in the folders array.
302
+ */
303
+ numFolders?: number;
304
+ /**
305
+ * Number of monitors out of folder in the response
306
+ */
307
+ numNotInFolder?: number;
308
+ /**
309
+ * Total number of monitors that would be returned if no limit/offset restriction is applied
310
+ */
311
+ totalMonitors?: number;
312
+ /**
313
+ * Total number of folders that would be returned if no limit/offset restriction is applied
314
+ */
315
+ totalFolders?: number;
316
+ /**
317
+ * Total number of monitors out of folder if no limit/offset restriction is applied
318
+ */
319
+ totalNotInFolder?: number;
320
+ folders?: FolderItem;
321
+ };
322
+ export type OauthClientCredentialsNotFound = {
323
+ status?: string;
324
+ message?: string;
325
+ };
326
+ export type OauthClientCredentialsItem = {
327
+ id?: number;
328
+ name?: string;
329
+ client_id?: string;
330
+ valid_until?: string | null;
331
+ access_token_validity?: number | null;
332
+ refresh_token_validity?: number | null;
333
+ };
334
+ export type OauthToken = {
335
+ id?: number;
336
+ /**
337
+ * Client ID this token is assigned to.
338
+ */
339
+ clientId?: number;
340
+ /**
341
+ * Date and time when the token expires
342
+ */
343
+ expires?: string;
344
+ };
345
+ export type PermissionItem = {
346
+ type: string;
347
+ level: string;
348
+ };
349
+ export type ResourceGroupItem = {
350
+ id?: number;
351
+ name?: string;
352
+ ownerId?: number;
353
+ };
354
+ export type ResourceGroupItemWithPermission = ResourceGroupItem & {
355
+ resourceCount?: number;
356
+ permission?: PermissionItem;
357
+ };
358
+ export type BulkResponseMetadata = {
359
+ /**
360
+ * A bulk response containing multiple sub-responses for bulk operations
361
+ */
362
+ success?: number;
363
+ redirect?: number;
364
+ client_errors?: number;
365
+ server_errors?: number;
366
+ };
367
+ export type BulkResponse = {
368
+ metadata?: BulkResponseMetadata;
369
+ responses?: Array<BulkResponsePart>;
370
+ };
371
+ /**
372
+ * One part of a multi-part response
373
+ *
374
+ * When performing bulk operations, each item has its own response
375
+ * This class represents response for one item
376
+ *
377
+ * It is merged in BulkResponse
378
+ */
379
+ export type BulkResponsePart = {
380
+ /**
381
+ * ID of the entity this response is connected to (user ID, folder ID...)
382
+ */
383
+ id: string | number;
384
+ /**
385
+ * This property is renamed in BulkResponse::getCompleteResponse()
386
+ */
387
+ status: number;
388
+ /**
389
+ * This property is renamed in BulkResponse::getCompleteResponse()
390
+ */
391
+ resource?: {
392
+ [key: string]: unknown;
393
+ };
394
+ /**
395
+ * The subresponse HTTP message
396
+ */
397
+ message?: string | null;
398
+ };
399
+ export type FolderItem = FolderRequestItem & {
400
+ id: number;
401
+ monitorCount: number;
402
+ permission?: PermissionItem;
403
+ specificPermission?: PermissionItem;
404
+ ownerId?: number;
405
+ };
406
+ export type FolderRequestItem = {
407
+ name: string;
408
+ isActive: boolean;
409
+ notifyOn: boolean;
410
+ };
411
+ export type Forbidden = {
412
+ status?: string;
413
+ message?: string;
414
+ };
415
+ export type SettingsItem = {
416
+ name: string;
417
+ type?: "bool" | "integer" | "string" | "secret" | "integers";
418
+ value: string | number | boolean | Array<number>;
419
+ };
420
+ export type StationAgent = {
421
+ /**
422
+ * Monitor type
423
+ */
424
+ type?: string;
425
+ /**
426
+ * Agent name
427
+ */
428
+ agent?: string;
429
+ };
430
+ export type StationAgents = {
431
+ /**
432
+ * Number of ccagents
433
+ */
434
+ ccagent?: number | null;
435
+ /**
436
+ * Number of cbot agents
437
+ */
438
+ cbot?: number | null;
439
+ /**
440
+ * Number of full-page agents
441
+ */
442
+ fpm?: number | null;
443
+ /**
444
+ * Number of jmeter2 agents
445
+ */
446
+ jmeter2?: number | null;
447
+ /**
448
+ * Number of jmeter4 agents
449
+ */
450
+ jmeter4?: number | null;
451
+ /**
452
+ * Number of jmeter5 agents
453
+ */
454
+ jmeter5?: number | null;
455
+ /**
456
+ * Number of webdriver agents
457
+ */
458
+ webdriver?: number | null;
459
+ };
460
+ export type StationItem = {
461
+ id?: number;
462
+ /**
463
+ * The unique host name of this monitoring station
464
+ */
465
+ alias?: string;
466
+ /**
467
+ * The location ID this station belongs to
468
+ */
469
+ locationId?: number;
470
+ /**
471
+ * True if the monitoring station is public.
472
+ */
473
+ isPublic?: boolean;
474
+ /**
475
+ * ID of the monitoring station owner. Public stations have no owners.
476
+ */
477
+ ownerId?: number | null;
478
+ /**
479
+ * The short code assigned during installation - deprecated
480
+ */
481
+ locode?: string;
482
+ /**
483
+ * Status of the monitoring station:
484
+ * 1 - planned, 2 - active, 3 - in maintenance, 4 - blocked,
485
+ * 5 - installation in progress, 6 = broken - installation failed.
486
+ */
487
+ status?: 1 | 2 | 3 | 4 | 5 | 6;
488
+ /**
489
+ * The IP address of this monitoring station
490
+ */
491
+ host?: string | null;
492
+ city?: string;
493
+ latitude?: number;
494
+ longitude?: number;
495
+ /**
496
+ * Weight of the station in the location.
497
+ */
498
+ weight?: number;
499
+ /**
500
+ * The version of the OS
501
+ */
502
+ osVersion?: string;
503
+ /**
504
+ * The version of the ASM station installed
505
+ */
506
+ version?: string;
507
+ /**
508
+ * Custom text description.
509
+ */
510
+ description?: string;
511
+ /**
512
+ * Engine used for orchestration - kubernetes, docker-composer, etc.
513
+ */
514
+ engine?: string;
515
+ /**
516
+ * Use ccagent instead of cbot
517
+ */
518
+ useCcagent?: boolean;
519
+ };
520
+ export type StationItemCreate = {
521
+ /**
522
+ * The host name of this monitoring station
523
+ */
524
+ alias?: string;
525
+ /**
526
+ * The location ID this station belongs to
527
+ */
528
+ locationId?: number;
529
+ /**
530
+ * Status of the monitoring station: 1 - planned, 2 - active, 3 - in maintenance, 4 - blocked.
531
+ */
532
+ status?: 1 | 2 | 3 | 4;
533
+ /**
534
+ * The IP address of this monitoring station
535
+ */
536
+ host?: string | null;
537
+ city?: string;
538
+ latitude?: number;
539
+ longitude?: number;
540
+ /**
541
+ * Weight of the station in the location.
542
+ */
543
+ weight?: number;
544
+ /**
545
+ * The version of the OS
546
+ */
547
+ osVersion?: string;
548
+ /**
549
+ * The version of the ASM station installed
550
+ */
551
+ version?: string;
552
+ /**
553
+ * This secret is used to encrypt station debug information (status, config, logs). If not provided, the debug information is not available.
554
+ */
555
+ secret?: string;
556
+ /**
557
+ * Custom text description.
558
+ */
559
+ description?: string;
560
+ /**
561
+ * Metadata for the installer (json encoded). Internal use only.
562
+ */
563
+ installerMetadata?: string;
564
+ /**
565
+ * Engine used for orchestration - kubernetes, docker-composer, etc.
566
+ */
567
+ engine?: string;
568
+ /**
569
+ * Use ccagent instead of cbot
570
+ */
571
+ useCcagent?: boolean;
572
+ agents?: StationAgents | {
573
+ [key: string]: unknown;
574
+ } | null;
575
+ };
576
+ export type StationItemDetail = StationItem & {
577
+ /**
578
+ * Tunnel ID.
579
+ */
580
+ tunnelId?: string;
581
+ /**
582
+ * Installation token - it is generated when monitoring station is created or updated or if you request one station details.
583
+ */
584
+ token?: string | null;
585
+ /**
586
+ * Metadata for the installer (json encoded).
587
+ */
588
+ installerMetadata?: string;
589
+ agents?: StationAgents | {
590
+ [key: string]: unknown;
591
+ } | null;
592
+ };
593
+ export type StationLatest = {
594
+ /**
595
+ * The current version of the station
596
+ */
597
+ version?: string;
598
+ /**
599
+ * The current version of the installer
600
+ */
601
+ installer?: string;
602
+ };
603
+ export type TimezoneItem = {
604
+ /**
605
+ * The name of this timezone
606
+ */
607
+ name?: string;
608
+ /**
609
+ * [+-]HH:mm offset to UTC
610
+ */
611
+ offset?: string;
612
+ /**
613
+ * True if the timezone observes/observed DST for the year of the call
614
+ */
615
+ hasDst?: boolean;
616
+ /**
617
+ * True if the timezone is in DST at the time of the call
618
+ */
619
+ isDst?: boolean;
620
+ };
621
+ /**
622
+ * Class User
623
+ */
624
+ export type User = UserCreate & {
625
+ id: number;
626
+ /**
627
+ * Date time of last login
628
+ */
629
+ lastseen?: string;
630
+ /**
631
+ * Status (read only)
632
+ * 1 ... unconfirmed
633
+ * 2 ... active
634
+ * 3 ... blocked
635
+ * 4 ... unsubscribing
636
+ * 5 ... on hold
637
+ */
638
+ status?: number;
639
+ /**
640
+ * List of custom roles the user is member of (read only)
641
+ */
642
+ roles?: Array<Role>;
643
+ /**
644
+ * Is account locked?
645
+ */
646
+ locked?: boolean;
647
+ /**
648
+ * True/false if user can login as parent account (owner), null if not evaulated
649
+ */
650
+ canLoginAsParent?: boolean | null;
651
+ };
652
+ /**
653
+ * Class UserCreate
654
+ */
655
+ export type UserCreate = {
656
+ email: string;
657
+ name: string;
658
+ company?: string;
659
+ website?: string;
660
+ address?: string;
661
+ city?: string;
662
+ zip?: string;
663
+ state?: string;
664
+ /**
665
+ * ISO 3166-1 alpha-2 country code
666
+ */
667
+ country?: string;
668
+ lang?: string;
669
+ timezone?: string;
670
+ };
671
+ export type Role = RoleCreate & {
672
+ /**
673
+ * Unique role ID
674
+ */
675
+ id?: number;
676
+ /**
677
+ * Unique role name. Use role ID instead, this value is deprecated.
678
+ */
679
+ name: string;
680
+ };
681
+ export type RoleCreate = {
682
+ description: string;
683
+ };
684
+ /**
685
+ * Class Location
686
+ */
687
+ export type Location = LocationDraft & {
688
+ /**
689
+ * Unique ID of the location.
690
+ */
691
+ id: number;
692
+ /**
693
+ * Parent location ID.
694
+ */
695
+ parent: number | null;
696
+ /**
697
+ * Iso code of the country this location belongs to or null.
698
+ */
699
+ country?: string;
700
+ /**
701
+ * If true, it is a private (on-premise) location. Otherwise it is a public one.
702
+ */
703
+ isPrivate?: boolean;
704
+ /**
705
+ * Can the user create nested locations to this location?
706
+ */
707
+ canCreateLocations?: boolean;
708
+ /**
709
+ * Can the user create private monitoring stations in this location?
710
+ */
711
+ canCreateStations?: boolean;
712
+ /**
713
+ * Location region details
714
+ */
715
+ region?: Region | {
716
+ [key: string]: unknown;
717
+ } | null;
718
+ };
719
+ /**
720
+ * Class LocationDraft
721
+ */
722
+ export type LocationDraft = {
723
+ /**
724
+ * Name of the location.
725
+ */
726
+ name: string;
727
+ /**
728
+ * Parent location ID or country 2-char iso code.
729
+ */
730
+ parent: string;
731
+ /**
732
+ * Latitude of the location - position can be used to find the nearest location in scheduler.
733
+ */
734
+ latitude?: number;
735
+ /**
736
+ * Longitude of the location - position can be used to find the nearest location in scheduler.
737
+ */
738
+ longitude?: number;
739
+ /**
740
+ * Weight is used to prefer or disfavor this group.
741
+ */
742
+ weight?: number;
743
+ };
744
+ /**
745
+ * Class Region
746
+ */
747
+ export type Region = {
748
+ /**
749
+ * ID of the region.
750
+ */
751
+ id?: number;
752
+ /**
753
+ * Name of the region.
754
+ */
755
+ name?: string | null;
756
+ };
757
+ /**
758
+ * Add support for certificates to converters
759
+ */
760
+ export type AllowDenyTrait = {
761
+ browserRestriction?: "own" | "everywhere" | "custom";
762
+ /**
763
+ * Comma-separated whitelisted domains. This will be an array in the future
764
+ */
765
+ browserAllow?: string;
766
+ /**
767
+ * Comma-separated blacklisted domains. This will be an array in the future
768
+ */
769
+ browserDeny?: string;
770
+ };
771
+ export type UseCertificatesTrait = {
772
+ useClientCert?: boolean;
773
+ useCaCert?: boolean;
774
+ certificates?: MonitorCertificates | {
775
+ [key: string]: unknown;
776
+ } | null;
777
+ };
778
+ /**
779
+ * Encryption-settable monitor
780
+ */
781
+ export type EncryptionTrait = {
782
+ cipherList?: "ALL" | "HIGH" | "MEDIUM" | "";
783
+ /**
784
+ * TODO: "" = negotiate? why nullable then? see in initializeEncryption
785
+ */
786
+ encryption?: "tls" | "tlsv1.0" | "tlsv1.1" | "tlsv1.2" | "sslv3" | "";
787
+ };
788
+ /**
789
+ * Add host:port support to the monitor schema - this may seem odd, but there are URL monitors, host:port monitors and script monitors
790
+ *
791
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
792
+ */
793
+ export type HostPortTrait = {
794
+ host?: string;
795
+ port?: number;
796
+ };
797
+ /**
798
+ * Add IP version selection support to the monitor schema
799
+ *
800
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
801
+ */
802
+ export type IpVersionTrait = {
803
+ ipVersion?: 0 | 4 | 6;
804
+ };
805
+ /**
806
+ * Add login support to the monitor schema
807
+ *
808
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
809
+ */
810
+ export type LoginTrait = {
811
+ username?: string;
812
+ password?: string;
813
+ };
814
+ /**
815
+ * Add match string/regex support to the monitor schema
816
+ *
817
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
818
+ */
819
+ export type MatchStringTrait = {
820
+ matchString?: string;
821
+ };
822
+ /**
823
+ * Add post data support to the monitor schema
824
+ *
825
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
826
+ */
827
+ export type PostDataTrait = {
828
+ /**
829
+ * Enable this option if POST, PUT or PATCH data is in a binary form. This value is disregarded on OPMS before 10.7.
830
+ */
831
+ binary?: boolean;
832
+ /**
833
+ * Data sent with the PUT, POST and PATCH requests. Binary data must be base64 encoded.
834
+ */
835
+ data?: string;
836
+ };
837
+ /**
838
+ * Add proxy support to the monitor schema
839
+ */
840
+ export type ProxyTrait = {
841
+ useProxy?: boolean;
842
+ /**
843
+ * The proxy protocol. Not all monitor types can make use of all proxy protocols.
844
+ * useProxy=true and proxyProtocol=null means 'use system proxy' on OPMS
845
+ */
846
+ proxyProtocol?: "http" | "https" | "socks5";
847
+ proxyAddress?: string | null;
848
+ proxyPort?: number | null;
849
+ proxyUsername?: string | null;
850
+ proxyPassword?: string | null;
851
+ };
852
+ export type RequestHeadersTrait = {
853
+ requestHeaders?: string;
854
+ };
855
+ export type TransactionPatternsTrait = {
856
+ transactionPatterns?: string | null;
857
+ };
858
+ /**
859
+ * Add host:port support to the monitor schema - this may seem odd, but there are URL monitors, host:port monitors and script monitors
860
+ *
861
+ * Use in \Cm\Lib\Monitor\Schema\AbstractMonitor and its descendants
862
+ */
863
+ export type UrlTrait = {
864
+ url?: string;
865
+ };
866
+ /**
867
+ * User-Agent-settable monitor
868
+ */
869
+ export type UserAgentTrait = {
870
+ /**
871
+ * Free format user agent to be used with requests, default empty string = native for the agent
872
+ */
873
+ userAgent?: string;
874
+ };
875
+ /**
876
+ * monitor allowing verify certificate setting
877
+ */
878
+ export type VerifyCertificateTrait = {
879
+ verifyCertificate?: boolean;
880
+ };
881
+ /**
882
+ * Common fields present for all monitors
883
+ */
884
+ export type Monitor = MonitorCreate & {
885
+ id?: number;
886
+ /**
887
+ * Status of the monitor (read only). The status of the folder is not reflected.
888
+ */
889
+ status?: "deleted" | "inactive" | "active" | "unconfirmed" | "locked" | "error";
890
+ /**
891
+ * Health status of the monitoring station pool (read only). This flag is true if the number of monitoring stations in insufficient.
892
+ */
893
+ unhealthy?: boolean | null;
894
+ /**
895
+ * Is monitor currently in maintenance mode? (read only)
896
+ */
897
+ inMaintenance?: boolean | null;
898
+ };
899
+ /**
900
+ * Common fields for creating any monitor
901
+ */
902
+ export type MonitorCreate = MonitorUpdate & {
903
+ /**
904
+ * The monitor type.
905
+ */
906
+ type: "http" | "https" | "connect" | "dns" | "dnsa" | "dnsns" | "domain" | "ftp" | "ftps" | "imap" | "ldap" | "ping" | "plugin" | "pop3" | "scp" | "sftp" | "sip" | "smtp" | "telnet" | "browser" | "script" | "tls" | "websocket";
907
+ };
908
+ /**
909
+ * Common updatable fields for all monitors
910
+ */
911
+ export type MonitorUpdate = {
912
+ name?: string;
913
+ /**
914
+ * The folder id where the monitor will be put. 0 means no folder.
915
+ */
916
+ folderId?: number;
917
+ maintenanceGroupIds?: Array<number>;
918
+ tagNames?: Array<string>;
919
+ transactionTag?: string;
920
+ userNote?: string;
921
+ /**
922
+ * This time zone is used for the monitor's run hours (check/periodFrom,
923
+ * check/periodTo and check/days). If empty the time zone of the owner account is used.
924
+ */
925
+ timezone?: string | null;
926
+ check?: MonitorCheck;
927
+ alert?: MonitorAlert;
928
+ checkpoint?: MonitorCheckpoint;
929
+ /**
930
+ * Enable this option if monitor should not be scheduled in maintenance.
931
+ * By default, monitor is scheduled but results are flagged and not used for alerting and SLA calculation.
932
+ */
933
+ noScheduleOnMaintenance?: boolean | null;
934
+ /**
935
+ * Enable this option if a failing monitor should not be rescheduled.
936
+ * By default, the monitoring interval is changed to 5 minutes if a monitor starts
937
+ * failing and the interval is longer than 5 minutes. Once the monitor is OK the
938
+ * original interval is restored.
939
+ */
940
+ noRescheduleOnFailure?: boolean | null;
941
+ };
942
+ /**
943
+ * Class Alert
944
+ */
945
+ export type MonitorAlert = {
946
+ timeWarn?: number;
947
+ timePoor?: number;
948
+ timeOut?: number;
949
+ alertAfter?: -1 | 0 | 1 | 2 | 3 | 4;
950
+ /**
951
+ * Currently has no effect
952
+ */
953
+ dontDoPostMortem?: boolean;
954
+ contactId?: number | null;
955
+ notifyWhenUp?: boolean;
956
+ quietPeriod?: "00:10:00" | "00:15:00" | "00:20:00" | "00:30:00" | "01:00:00" | "02:00:00" | "03:00:00" | "06:00:00" | "12:00:00" | "18:00:00" | "24:00:00";
957
+ checkThreshold?: 1 | 2 | 3 | 4 | 5;
958
+ };
959
+ /**
960
+ * Class Certificate
961
+ */
962
+ export type MonitorCertificates = {
963
+ /**
964
+ * CA certificate or chain for peer verification, either in PKCS12 or PEM format
965
+ */
966
+ ca?: string;
967
+ /**
968
+ * Client certificate for authentication, either in PKCS12 or PEM format.
969
+ * Client certificate consists of public (cert) and private (key) parts. Both parts must be included here.
970
+ */
971
+ client?: string;
972
+ clientPassword?: string;
973
+ };
974
+ /**
975
+ * Class Check
976
+ */
977
+ export type MonitorCheck = {
978
+ /**
979
+ * Scheduler modes - 0(sequential), 1(multi), 4(sequential asynchronous), 5(multi asynchronous). If unsure, use 0
980
+ */
981
+ mode?: 0 | 1 | 4 | 5;
982
+ interval?: string;
983
+ periodFrom?: string;
984
+ periodTo?: string;
985
+ days?: Array<number>;
986
+ };
987
+ /**
988
+ * Class Checkpoint
989
+ */
990
+ export type MonitorCheckpoint = {
991
+ usePublic?: boolean;
992
+ groupIds?: Array<number> | null;
993
+ algorithm?: "master" | "random" | "seq" | "sticky";
994
+ defaultGroupId?: number | null;
995
+ };
996
+ /**
997
+ * Common FTP/S monitors' fields
998
+ */
999
+ export type FtpCommonTrait = {
1000
+ path?: string;
1001
+ connectionMode?: 0 | 1 | 2;
1002
+ };
1003
+ /**
1004
+ * Common HTTP/S monitors' fields
1005
+ */
1006
+ export type HttpCommonTrait = UrlTrait & ProxyTrait & LoginTrait & MatchStringTrait & IpVersionTrait & RequestHeadersTrait & UserAgentTrait & PostDataTrait & {
1007
+ /**
1008
+ * HTTP method. If empty, GET (data is empty) or POST (data is not empty) is used. This value is disregarded on OPMS before 10.7.
1009
+ */
1010
+ httpMethod?: "" | "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS";
1011
+ acceptedHttpCodes?: string;
1012
+ avoidCompression?: boolean;
1013
+ useNtlm?: boolean;
1014
+ redirectLimit?: number;
1015
+ };
1016
+ export type Browser = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & Monitor & {
1017
+ url: string;
1018
+ jsErrorReport?: boolean;
1019
+ elemErrorReport?: boolean;
1020
+ toggleQuiescence?: boolean;
1021
+ postVariables?: string;
1022
+ };
1023
+ export type BrowserCreate = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorCreate & {
1024
+ url: string;
1025
+ jsErrorReport?: boolean;
1026
+ elemErrorReport?: boolean;
1027
+ toggleQuiescence?: boolean;
1028
+ postVariables?: string;
1029
+ };
1030
+ export type BrowserUpdate = ProxyTrait & LoginTrait & MatchStringTrait & RequestHeadersTrait & IpVersionTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorUpdate & {
1031
+ url?: string;
1032
+ jsErrorReport?: boolean;
1033
+ elemErrorReport?: boolean;
1034
+ toggleQuiescence?: boolean;
1035
+ postVariables?: string;
1036
+ };
1037
+ export type Connect = HostPortTrait & MatchStringTrait & Monitor;
1038
+ export type ConnectCreate = HostPortTrait & MatchStringTrait & MonitorCreate;
1039
+ export type ConnectUpdate = HostPortTrait & MatchStringTrait & MonitorUpdate;
1040
+ /**
1041
+ * Class Dns
1042
+ */
1043
+ export type Dns = Monitor & {
1044
+ domainName: string;
1045
+ port: number;
1046
+ recordType?: "A" | "AAAA" | "MX" | "NS" | "CNAME" | "PTR" | "SOA" | "TXT";
1047
+ /**
1048
+ * Comma-separated expected RR values. This will be an array in the future
1049
+ */
1050
+ expectedResult?: string;
1051
+ retries?: 0 | 1 | 2 | 3;
1052
+ match?: -1 | 0 | 1;
1053
+ protocol?: "tcp" | "udp";
1054
+ target?: string;
1055
+ respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1056
+ delimiter?: "" | "," | "|" | ";" | "#|#" | "#;#" | "#ASM_ITEM_DELIMITER#";
1057
+ };
1058
+ /**
1059
+ * Class Dns
1060
+ */
1061
+ export type DnsCreate = MonitorCreate & {
1062
+ domainName: string;
1063
+ port: number;
1064
+ recordType?: "A" | "AAAA" | "MX" | "NS" | "CNAME" | "PTR" | "SOA" | "TXT";
1065
+ /**
1066
+ * Comma-separated expected RR values. This will be an array in the future
1067
+ */
1068
+ expectedResult?: string;
1069
+ retries?: 0 | 1 | 2 | 3;
1070
+ match?: -1 | 0 | 1;
1071
+ protocol?: "tcp" | "udp";
1072
+ target?: string;
1073
+ respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1074
+ delimiter?: "" | "," | "|" | ";" | "#|#" | "#;#" | "#ASM_ITEM_DELIMITER#";
1075
+ };
1076
+ /**
1077
+ * Class Monitor
1078
+ */
1079
+ export type DnsUpdate = MonitorUpdate & {
1080
+ domainName?: string;
1081
+ port?: number;
1082
+ recordType?: "A" | "AAAA" | "MX" | "NS" | "CNAME" | "PTR" | "SOA" | "TXT";
1083
+ /**
1084
+ * Comma-separated expected RR values. This will be an array in the future
1085
+ */
1086
+ expectedResult?: string;
1087
+ retries?: 0 | 1 | 2 | 3;
1088
+ match?: -1 | 0 | 1;
1089
+ protocol?: "tcp" | "udp";
1090
+ target?: string;
1091
+ respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1092
+ delimiter?: "" | "," | "|" | ";" | "#|#" | "#;#" | "#ASM_ITEM_DELIMITER#";
1093
+ };
1094
+ export type Dnsa = HostPortTrait & Monitor & {
1095
+ path: string;
1096
+ maxQueries: number;
1097
+ };
1098
+ export type DnsaCreate = HostPortTrait & MonitorCreate & {
1099
+ path: string;
1100
+ maxQueries: number;
1101
+ };
1102
+ export type DnsaUpdate = HostPortTrait & MonitorUpdate & {
1103
+ path?: string;
1104
+ maxQueries?: number;
1105
+ };
1106
+ export type Dnsns = HostPortTrait & Monitor & {
1107
+ path: string;
1108
+ maxQueries: number;
1109
+ };
1110
+ export type DnsnsCreate = HostPortTrait & MonitorCreate & {
1111
+ path: string;
1112
+ maxQueries: number;
1113
+ };
1114
+ export type DnsnsUpdate = HostPortTrait & MonitorUpdate & {
1115
+ path?: string;
1116
+ maxQueries?: number;
1117
+ };
1118
+ /**
1119
+ * Class Domain
1120
+ */
1121
+ export type Domain = Monitor & {
1122
+ domainName: string;
1123
+ port: number;
1124
+ retries: 0 | 1 | 2 | 3;
1125
+ protocol: "tcp" | "udp";
1126
+ target: string;
1127
+ respondThreshold: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1128
+ doZoneTransfer?: boolean;
1129
+ };
1130
+ /**
1131
+ * Class Domain
1132
+ */
1133
+ export type DomainCreate = MonitorCreate & {
1134
+ domainName: string;
1135
+ port: number;
1136
+ retries: 0 | 1 | 2 | 3;
1137
+ protocol: "tcp" | "udp";
1138
+ target: string;
1139
+ respondThreshold: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1140
+ doZoneTransfer?: boolean;
1141
+ };
1142
+ /**
1143
+ * Class Monitor
1144
+ */
1145
+ export type DomainUpdate = MonitorUpdate & {
1146
+ domainName?: string;
1147
+ port?: number;
1148
+ retries?: 0 | 1 | 2 | 3;
1149
+ protocol?: "tcp" | "udp";
1150
+ target?: string;
1151
+ respondThreshold?: 1 | 2 | 3 | 4 | 5 | 6 | 7;
1152
+ doZoneTransfer?: boolean;
1153
+ };
1154
+ /**
1155
+ * FTP monitor
1156
+ */
1157
+ export type Ftp = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & Monitor;
1158
+ export type FtpCreate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorCreate;
1159
+ export type FtpUpdate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorUpdate;
1160
+ export type Ftps = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & Monitor;
1161
+ export type FtpsCreate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorCreate;
1162
+ export type FtpsUpdate = FtpCommonTrait & HostPortTrait & MatchStringTrait & LoginTrait & IpVersionTrait & MonitorUpdate;
1163
+ /**
1164
+ * The definition of HTTP monitor type
1165
+ */
1166
+ export type Http = HttpCommonTrait & Monitor;
1167
+ export type HttpCreate = HttpCommonTrait & MonitorCreate;
1168
+ export type HttpUpdate = HttpCommonTrait & MonitorUpdate;
1169
+ export type Https = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & Http;
1170
+ export type HttpsCreate = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & MonitorCreate;
1171
+ export type HttpsUpdate = HttpCommonTrait & UseCertificatesTrait & EncryptionTrait & VerifyCertificateTrait & MonitorUpdate;
1172
+ export type Imap = HostPortTrait & LoginTrait & VerifyCertificateTrait & Monitor & {
1173
+ path?: string;
1174
+ sslEncryption?: boolean;
1175
+ emailAddress?: string;
1176
+ };
1177
+ export type ImapCreate = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorCreate & {
1178
+ path?: string;
1179
+ sslEncryption?: boolean;
1180
+ emailAddress?: string;
1181
+ };
1182
+ export type ImapUpdate = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorUpdate & {
1183
+ path?: string;
1184
+ sslEncryption?: boolean;
1185
+ emailAddress?: string;
1186
+ };
1187
+ export type Ldap = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & Monitor & {
1188
+ /**
1189
+ * The search base and filter. Spaces in the filter must be replaced with %20
1190
+ */
1191
+ path?: string;
1192
+ sslEncryption?: boolean;
1193
+ };
1194
+ export type LdapCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & MonitorCreate & {
1195
+ /**
1196
+ * The search base and filter. Spaces in the filter must be replaced with %20
1197
+ */
1198
+ path?: string;
1199
+ sslEncryption?: boolean;
1200
+ };
1201
+ export type LdapUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & VerifyCertificateTrait & MonitorUpdate & {
1202
+ /**
1203
+ * The search base and filter. Spaces in the filter must be replaced with %20
1204
+ */
1205
+ path?: string;
1206
+ sslEncryption?: boolean;
1207
+ };
1208
+ export type Ping = IpVersionTrait & Monitor & {
1209
+ host: string;
1210
+ /**
1211
+ * Packet loss in % (1-100)
1212
+ */
1213
+ packetLossThreshold: number;
1214
+ };
1215
+ export type PingCreate = IpVersionTrait & MonitorCreate & {
1216
+ host: string;
1217
+ /**
1218
+ * Packet loss in % (1-100)
1219
+ */
1220
+ packetLossThreshold: number;
1221
+ };
1222
+ export type PingUpdate = IpVersionTrait & MonitorUpdate & {
1223
+ host?: string;
1224
+ /**
1225
+ * Packet loss in % (1-100)
1226
+ */
1227
+ packetLossThreshold?: number;
1228
+ };
1229
+ export type Plugin = UrlTrait & LoginTrait & Monitor & {
1230
+ parameters?: string;
1231
+ };
1232
+ export type PluginCreate = UrlTrait & LoginTrait & MonitorCreate & {
1233
+ parameters?: string;
1234
+ };
1235
+ export type PluginUpdate = UrlTrait & LoginTrait & MonitorUpdate & {
1236
+ parameters?: string;
1237
+ };
1238
+ export type Pop3 = HostPortTrait & LoginTrait & VerifyCertificateTrait & Monitor & {
1239
+ sslEncryption?: boolean;
1240
+ emailAddress?: string;
1241
+ };
1242
+ export type Pop3Create = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorCreate & {
1243
+ sslEncryption?: boolean;
1244
+ emailAddress?: string;
1245
+ };
1246
+ export type Pop3Update = HostPortTrait & LoginTrait & VerifyCertificateTrait & MonitorUpdate & {
1247
+ sslEncryption?: boolean;
1248
+ emailAddress?: string;
1249
+ };
1250
+ export type Scp = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & Monitor & {
1251
+ path?: string;
1252
+ };
1253
+ export type ScpCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorCreate & {
1254
+ path?: string;
1255
+ };
1256
+ export type ScpUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorUpdate & {
1257
+ path?: string;
1258
+ };
1259
+ export type Script = UseCertificatesTrait & ProxyTrait & LoginTrait & Monitor & {
1260
+ host: string;
1261
+ port: number;
1262
+ path?: string;
1263
+ encryption?: "tls" | "tlsv1.0" | "tlsv1.1" | "tlsv1.2" | "sslv3";
1264
+ assertOnly?: boolean;
1265
+ responseContent?: boolean;
1266
+ scriptFile?: MonitorScript;
1267
+ };
1268
+ export type ScriptCreate = UseCertificatesTrait & ProxyTrait & LoginTrait & MonitorCreate & {
1269
+ host?: string;
1270
+ port?: number;
1271
+ path?: string;
1272
+ encryption?: "tls" | "tlsv1.0" | "tlsv1.1" | "tlsv1.2" | "sslv3";
1273
+ assertOnly?: boolean;
1274
+ responseContent?: boolean;
1275
+ scriptFile?: MonitorScriptCreate | {
1276
+ [key: string]: unknown;
1277
+ } | null;
1278
+ };
1279
+ export type ScriptUpdate = UseCertificatesTrait & ProxyTrait & LoginTrait & MonitorUpdate & {
1280
+ host?: string;
1281
+ port?: number;
1282
+ path?: string;
1283
+ encryption?: "tls" | "tlsv1.0" | "tlsv1.1" | "tlsv1.2" | "sslv3";
1284
+ assertOnly?: boolean;
1285
+ responseContent?: boolean;
1286
+ scriptFile?: MonitorScriptCreate | {
1287
+ [key: string]: unknown;
1288
+ } | null;
1289
+ };
1290
+ export type Sftp = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & Monitor & {
1291
+ path?: string;
1292
+ };
1293
+ export type SftpCreate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorCreate & {
1294
+ path?: string;
1295
+ };
1296
+ export type SftpUpdate = HostPortTrait & LoginTrait & MatchStringTrait & IpVersionTrait & MonitorUpdate & {
1297
+ path?: string;
1298
+ };
1299
+ export type Sip = HostPortTrait & Monitor;
1300
+ export type SipCreate = HostPortTrait & MonitorCreate;
1301
+ export type SipUpdate = HostPortTrait & MonitorUpdate;
1302
+ export type Smtp = HostPortTrait & Monitor;
1303
+ export type SmtpCreate = HostPortTrait & MonitorCreate;
1304
+ export type SmtpUpdate = HostPortTrait & MonitorUpdate;
1305
+ export type Telnet = HostPortTrait & Monitor;
1306
+ export type TelnetCreate = HostPortTrait & MonitorCreate;
1307
+ export type TelnetUpdate = HostPortTrait & MonitorUpdate;
1308
+ /**
1309
+ * TLS monitor for server certificate monitoring
1310
+ */
1311
+ export type Tls = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & Monitor & {
1312
+ expirationShift?: number;
1313
+ };
1314
+ export type TlsCreate = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & MonitorCreate & {
1315
+ expirationShift?: number;
1316
+ };
1317
+ export type TlsUpdate = HostPortTrait & UseCertificatesTrait & ProxyTrait & IpVersionTrait & EncryptionTrait & MonitorUpdate & {
1318
+ expirationShift?: number;
1319
+ };
1320
+ export type Webdriver = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & Monitor & {
1321
+ host?: string;
1322
+ elemErrorReport?: boolean;
1323
+ toggleQuiescence?: boolean;
1324
+ /**
1325
+ * Enable this option if monitor is monitoring page leveraging additionaly the browser
1326
+ * agent and webdriver is expected to wait for the browser agent to send the metrics
1327
+ * before executing the next step. Do not enable it unless you know what you are doing.
1328
+ * If browser is NOT present and this value is enabled, monitor will timeout on the first
1329
+ * step waiting for browser agent confirmation.
1330
+ */
1331
+ browserAgent?: boolean | null;
1332
+ proxyExcludeHosts?: string;
1333
+ /**
1334
+ * Comma-separated, colon-separated domain pairs. This will be an array in the future
1335
+ */
1336
+ remapHosts?: string;
1337
+ blockHtml5Media?: boolean;
1338
+ browser?: string;
1339
+ authenticationType?: string;
1340
+ scriptFile?: MonitorScript;
1341
+ };
1342
+ export type WebdriverCreate = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorCreate & {
1343
+ host?: string;
1344
+ elemErrorReport?: boolean;
1345
+ toggleQuiescence?: boolean;
1346
+ /**
1347
+ * Enable this option if monitor is monitoring page leveraging additionaly
1348
+ * the browser agent and webdriver is expected to wait for the browser agent
1349
+ * to send the metrics before executing the next step. Do not enable it unless
1350
+ * you know what you are doing. If browser is NOT present and this value is enabled,
1351
+ * monitor will timeout on the first step waiting for browser agent confirmation.
1352
+ */
1353
+ browserAgent?: boolean | null;
1354
+ proxyExcludeHosts?: string;
1355
+ /**
1356
+ * Comma-separated, colon-separated domain pairs. This will be an array in the future
1357
+ */
1358
+ remapHosts?: string;
1359
+ blockHtml5Media?: boolean;
1360
+ browser?: string;
1361
+ authenticationType?: string;
1362
+ scriptFile?: MonitorScriptCreate | {
1363
+ [key: string]: unknown;
1364
+ } | null;
1365
+ };
1366
+ export type WebdriverUpdate = ProxyTrait & UseCertificatesTrait & LoginTrait & UserAgentTrait & VerifyCertificateTrait & AllowDenyTrait & TransactionPatternsTrait & MonitorUpdate & {
1367
+ host?: string;
1368
+ elemErrorReport?: boolean;
1369
+ toggleQuiescence?: boolean;
1370
+ /**
1371
+ * Enable this option if monitor is monitoring page leveraging additionaly the
1372
+ * browser agent and webdriver is expected to wait for the browser agent to send
1373
+ * the metrics before executing the next step. Do not enable it unless you know
1374
+ * what you are doing. If browser is NOT present and this value is enabled, monitor
1375
+ * will timeout on the first step waiting for browser agent confirmation.
1376
+ */
1377
+ browserAgent?: boolean | null;
1378
+ proxyExcludeHosts?: string;
1379
+ /**
1380
+ * Comma-separated, colon-separated domain pairs. This will be an array in the future
1381
+ */
1382
+ remapHosts?: string;
1383
+ blockHtml5Media?: boolean;
1384
+ browser?: string;
1385
+ authenticationType?: string;
1386
+ scriptFile?: MonitorScriptCreate | {
1387
+ [key: string]: unknown;
1388
+ } | null;
1389
+ };
1390
+ export type Websocket = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & Monitor & {
1391
+ healthCheck?: boolean;
1392
+ idleDelay?: number;
1393
+ };
1394
+ export type WebsocketCreate = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & MonitorCreate & {
1395
+ healthCheck?: boolean;
1396
+ idleDelay?: number;
1397
+ };
1398
+ export type WebsocketUpdate = UrlTrait & ProxyTrait & UseCertificatesTrait & VerifyCertificateTrait & LoginTrait & MatchStringTrait & IpVersionTrait & PostDataTrait & RequestHeadersTrait & UserAgentTrait & MonitorUpdate & {
1399
+ healthCheck?: boolean;
1400
+ idleDelay?: number;
1401
+ };
1402
+ /**
1403
+ * Class MonitorFrame
1404
+ * This schema is used in the APIv3 to get list of monitors when the performance matters.
1405
+ * To retrieve full list of monitor properties lots of per-monitor queries must be executed which is time consuming (e.g. maintenance status).
1406
+ * This schema contains only parameters that needs no extra queries and/or lengthy calculations.
1407
+ * These parameters should be sufficient to get list of monitors for charts, selection dropboxes etc.
1408
+ */
1409
+ export type MonitorFrame = {
1410
+ id?: number;
1411
+ /**
1412
+ * The monitor type.
1413
+ */
1414
+ type?: "http" | "https" | "connect" | "dns" | "dnsa" | "dnsns" | "domain" | "ftp" | "ftps" | "imap" | "ldap" | "ping" | "plugin" | "pop3" | "scp" | "sftp" | "sip" | "smtp" | "telnet" | "browser" | "script";
1415
+ name?: string;
1416
+ folderId?: number;
1417
+ /**
1418
+ * Status of the monitor (read only). The status of the folder is not reflected.
1419
+ */
1420
+ status?: "deleted" | "inactive" | "active" | "unconfirmed" | "locked" | "error";
1421
+ /**
1422
+ * Health status of the monitoring station pool (read only). This flag is true if the number of monitoring stations in insufficient.
1423
+ */
1424
+ unhealthy?: boolean | null;
1425
+ };
1426
+ /**
1427
+ * Class ScriptFile
1428
+ */
1429
+ export type MonitorScript = MonitorScriptCreate & {
1430
+ /**
1431
+ * ID of the script
1432
+ */
1433
+ scriptId?: number;
1434
+ content?: string | null;
1435
+ };
1436
+ /**
1437
+ * Class ScriptFileCreate
1438
+ */
1439
+ export type MonitorScriptCreate = {
1440
+ /**
1441
+ * If you want to reuse a previously uploaded script, send this ID
1442
+ * but not the new script content. This feature is deprecated, will
1443
+ * be removed in the future releases without notice.
1444
+ */
1445
+ scriptId?: number | null;
1446
+ contentArchive?: string | null;
1447
+ parameters?: string | null;
1448
+ stages?: string | null;
1449
+ };
1450
+ export type MonitorTag = {
1451
+ id?: number;
1452
+ name?: string;
1453
+ };
1454
+ export type EventAsset = {
1455
+ url?: string;
1456
+ type?: "jtl" | "har" | "http" | "image" | "video" | "log" | "console_log";
1457
+ };
1458
+ export type LogEvent = {
1459
+ id?: string;
1460
+ monitor?: StatisticResource;
1461
+ location?: StatisticResource;
1462
+ folder?: StatisticResource;
1463
+ start?: string;
1464
+ duration?: number;
1465
+ interval?: number;
1466
+ monitor_type?: string;
1467
+ result?: EventResult;
1468
+ metrics?: LogEventMetrics;
1469
+ assets?: Array<EventAsset> | null;
1470
+ probeMetrics?: ProbeMetrics | {
1471
+ [key: string]: unknown;
1472
+ } | null;
1473
+ };
1474
+ export type LogEventMetrics = {
1475
+ /**
1476
+ * Resolve time (ms)
1477
+ */
1478
+ rtime?: number;
1479
+ /**
1480
+ * Connect time (ms)
1481
+ */
1482
+ ctime?: number;
1483
+ /**
1484
+ * First byte time (ms)
1485
+ */
1486
+ ptime?: number;
1487
+ /**
1488
+ * Download time (ms)
1489
+ */
1490
+ dtime?: number;
1491
+ /**
1492
+ * User interaction time (ms)
1493
+ */
1494
+ utime?: number;
1495
+ /**
1496
+ * Download size (bytes)
1497
+ */
1498
+ dsize?: number;
1499
+ /**
1500
+ * Number of multi-check probes performed, including internal errors
1501
+ */
1502
+ multi_probes_all?: number;
1503
+ /**
1504
+ * Number of multi-check probes performed, excluding internal errors
1505
+ */
1506
+ multi_probes?: number;
1507
+ /**
1508
+ * Number of multi-check probes failed, excluding internal errors
1509
+ */
1510
+ multi_probes_failed?: number;
1511
+ };
1512
+ export type MetricResource = {
1513
+ probes?: number;
1514
+ probe_ok?: number;
1515
+ probe_errors?: number;
1516
+ checks?: number;
1517
+ check_errors?: number;
1518
+ checks_maint?: number;
1519
+ maint_errors?: number;
1520
+ rtime?: number;
1521
+ ctime?: number;
1522
+ ptime?: number;
1523
+ utime?: number;
1524
+ dtime?: number;
1525
+ rtime_ok?: number;
1526
+ ctime_ok?: number;
1527
+ ptime_ok?: number;
1528
+ utime_ok?: number;
1529
+ dtime_ok?: number;
1530
+ dsize?: number;
1531
+ dev_rtime?: number;
1532
+ dev_ctime?: number;
1533
+ dev_ptime?: number;
1534
+ dev_utime?: number;
1535
+ dev_dtime?: number;
1536
+ dev_dsize?: number;
1537
+ xtime?: number;
1538
+ xtime_ok?: number;
1539
+ xspeed?: number;
1540
+ upstatus?: number;
1541
+ perfstatus?: number;
1542
+ score?: number;
1543
+ spi_score?: number;
1544
+ spi_penalty?: number;
1545
+ uptime?: number;
1546
+ downtime?: number;
1547
+ ttime?: number;
1548
+ ttime_ok?: number;
1549
+ dspeed?: number;
1550
+ slawarn?: number;
1551
+ slapoor?: number;
1552
+ apdex?: number;
1553
+ };
1554
+ export type ProbeMetrics = {
1555
+ id?: string;
1556
+ startTime?: string;
1557
+ duration?: number;
1558
+ failed?: boolean | null;
1559
+ statusCode?: number | null;
1560
+ statusString?: string | null;
1561
+ domain?: string | null;
1562
+ performance?: "good" | "poor" | "bad";
1563
+ metrics?: StageMetrics;
1564
+ stages?: Array<Stage>;
1565
+ };
1566
+ export type EventResult = {
1567
+ code?: number;
1568
+ description?: string;
1569
+ type?: "ok" | "unconfirmed_error" | "confirmed_error" | "maintenance" | "unscheduled";
1570
+ /**
1571
+ * For successful checks this value is calculated based on total time and monitor thresholds
1572
+ */
1573
+ performance?: "good" | "poor" | "bad";
1574
+ };
1575
+ export type Stage = {
1576
+ name?: string;
1577
+ startTime?: string;
1578
+ duration?: number;
1579
+ failed?: boolean | null;
1580
+ statusCode?: number | null;
1581
+ statusString?: string | null;
1582
+ CorID?: string | null;
1583
+ metrics?: StageMetrics;
1584
+ transactions?: Array<Transaction>;
1585
+ };
1586
+ export type StageMetrics = {
1587
+ /**
1588
+ * Time spent in HTTP client's queue before starting the request (ms)
1589
+ */
1590
+ blocked?: number | null;
1591
+ /**
1592
+ * Time spent on the TLS handshake (ms)
1593
+ */
1594
+ tls?: number | null;
1595
+ /**
1596
+ * Time spent on resolution of the IP address from the URI (ms)
1597
+ */
1598
+ dns?: number | null;
1599
+ /**
1600
+ * Time spent on establishing connection to the monitored service (ms)
1601
+ */
1602
+ connect?: number | null;
1603
+ /**
1604
+ * Time spent on sending request (ms)
1605
+ */
1606
+ upload?: number | null;
1607
+ /**
1608
+ * Time since upload was completed until the server starts sending response (ms)
1609
+ */
1610
+ firstByte?: number | null;
1611
+ /**
1612
+ * Time spent on receiving response (ms)
1613
+ */
1614
+ download?: number | null;
1615
+ /**
1616
+ * Size of request, including headers (bytes)
1617
+ */
1618
+ uploadSize?: number | null;
1619
+ /**
1620
+ * Size of response, including headers (bytes)
1621
+ */
1622
+ downloadSize?: number | null;
1623
+ /**
1624
+ * Size of request headers (bytes)
1625
+ */
1626
+ uploadHeadersSize?: number | null;
1627
+ /**
1628
+ * Size of response headers (bytes)
1629
+ */
1630
+ downloadHeadersSize?: number | null;
1631
+ /**
1632
+ * Time since start of the stage until the onContentLoad event (ms)
1633
+ */
1634
+ onContentLoad?: number | null;
1635
+ /**
1636
+ * Time since start of the stage until the onLoad event (ms)
1637
+ */
1638
+ onLoad?: number | null;
1639
+ /**
1640
+ * Number of transactions in this stage
1641
+ */
1642
+ requestCount?: number | null;
1643
+ /**
1644
+ * Number of failed transactions
1645
+ */
1646
+ failedCount?: number | null;
1647
+ /**
1648
+ * Time spent executing transactions (ms)
1649
+ */
1650
+ totalTime?: number | null;
1651
+ /**
1652
+ * Number of HTTP redirects
1653
+ */
1654
+ redirectCount?: number | null;
1655
+ /**
1656
+ * Total time spent on HTTP redirects
1657
+ */
1658
+ redirectTime?: number | null;
1659
+ };
1660
+ export type StatisticItem = {
1661
+ timestamp: string;
1662
+ monitors: Array<StatisticResource>;
1663
+ locations: Array<StatisticResource>;
1664
+ metrics?: MetricResource;
1665
+ };
1666
+ export type StatisticResource = {
1667
+ id: number;
1668
+ name: string;
1669
+ };
1670
+ export type Transaction = {
1671
+ /**
1672
+ * URI of the monitored service
1673
+ */
1674
+ uri?: string;
1675
+ /**
1676
+ * IP address of the monitored service
1677
+ */
1678
+ serverIp?: string;
1679
+ startTime?: string;
1680
+ duration?: number;
1681
+ failed?: boolean | null;
1682
+ statusCode?: number | null;
1683
+ statusString?: string | null;
1684
+ metrics?: TransactionMetrics;
1685
+ };
1686
+ export type TransactionMetrics = {
1687
+ /**
1688
+ * Time spent in HTTP client's queue before starting the request (ms)
1689
+ */
1690
+ blocked?: number | null;
1691
+ /**
1692
+ * Time spent on the TLS handshake (ms)
1693
+ */
1694
+ tls?: number | null;
1695
+ /**
1696
+ * Time spent on resolution of the IP address from the URI (ms)
1697
+ */
1698
+ dns?: number | null;
1699
+ /**
1700
+ * Time spent on establishing connection to the monitored service (ms)
1701
+ */
1702
+ connect?: number | null;
1703
+ /**
1704
+ * Time spent on sending request (ms)
1705
+ */
1706
+ upload?: number | null;
1707
+ /**
1708
+ * Time since upload was completed until the server starts sending response (ms)
1709
+ */
1710
+ firstByte?: number | null;
1711
+ /**
1712
+ * Time spent on receiving response (ms)
1713
+ */
1714
+ download?: number | null;
1715
+ /**
1716
+ * Size of request, including headers (bytes)
1717
+ */
1718
+ uploadSize?: number | null;
1719
+ /**
1720
+ * Size of response, including headers (bytes)
1721
+ */
1722
+ downloadSize?: number | null;
1723
+ /**
1724
+ * Size of request headers (bytes)
1725
+ */
1726
+ uploadHeadersSize?: number | null;
1727
+ /**
1728
+ * Size of response headers (bytes)
1729
+ */
1730
+ downloadHeadersSize?: number | null;
1731
+ };
1732
+ export type ApiTokenListData = {
1733
+ body?: never;
1734
+ path?: never;
1735
+ query?: never;
1736
+ url: "/api-token";
1737
+ };
1738
+ export type ApiTokenListErrors = {
1739
+ /**
1740
+ * Not permitted to access
1741
+ */
1742
+ 403: Forbidden;
1743
+ };
1744
+ export type ApiTokenListError = ApiTokenListErrors[keyof ApiTokenListErrors];
1745
+ export type ApiTokenListResponses = {
1746
+ /**
1747
+ * Success
1748
+ */
1749
+ 200: Array<ApiToken>;
1750
+ };
1751
+ export type ApiTokenListResponse = ApiTokenListResponses[keyof ApiTokenListResponses];
1752
+ export type ApiTokenCreateData = {
1753
+ body: {
1754
+ name?: string;
1755
+ valid_until?: string;
1756
+ };
1757
+ path?: never;
1758
+ query?: never;
1759
+ url: "/api-token";
1760
+ };
1761
+ export type ApiTokenCreateErrors = {
1762
+ /**
1763
+ * Not permitted to access
1764
+ */
1765
+ 403: Forbidden;
1766
+ };
1767
+ export type ApiTokenCreateError = ApiTokenCreateErrors[keyof ApiTokenCreateErrors];
1768
+ export type ApiTokenCreateResponses = {
1769
+ /**
1770
+ * Success
1771
+ */
1772
+ 201: {
1773
+ status?: string;
1774
+ data?: {
1775
+ id?: number;
1776
+ name?: string;
1777
+ token?: string;
1778
+ valid_until?: string;
1779
+ };
1780
+ };
1781
+ };
1782
+ export type ApiTokenCreateResponse = ApiTokenCreateResponses[keyof ApiTokenCreateResponses];
1783
+ export type ApiTokenDeleteData = {
1784
+ body?: never;
1785
+ path: {
1786
+ /**
1787
+ * The ID of the token to delete
1788
+ */
1789
+ id: number;
1790
+ };
1791
+ query?: never;
1792
+ url: "/api-token/{id}";
1793
+ };
1794
+ export type ApiTokenDeleteErrors = {
1795
+ /**
1796
+ * Not permitted to access
1797
+ */
1798
+ 403: Forbidden;
1799
+ /**
1800
+ * Token not found
1801
+ */
1802
+ 404: ApiTokenNotFound;
1803
+ };
1804
+ export type ApiTokenDeleteError = ApiTokenDeleteErrors[keyof ApiTokenDeleteErrors];
1805
+ export type ApiTokenDeleteResponses = {
1806
+ /**
1807
+ * Success
1808
+ */
1809
+ 200: {
1810
+ message?: string;
1811
+ };
1812
+ };
1813
+ export type ApiTokenDeleteResponse = ApiTokenDeleteResponses[keyof ApiTokenDeleteResponses];
1814
+ export type ApiTokenGetData = {
1815
+ body?: never;
1816
+ path: {
1817
+ /**
1818
+ * Token ID
1819
+ */
1820
+ id: number;
1821
+ };
1822
+ query?: never;
1823
+ url: "/api-token/{id}";
1824
+ };
1825
+ export type ApiTokenGetErrors = {
1826
+ /**
1827
+ * Not permitted to access
1828
+ */
1829
+ 403: Forbidden;
1830
+ /**
1831
+ * Token not found
1832
+ */
1833
+ 404: ApiTokenNotFound;
1834
+ };
1835
+ export type ApiTokenGetError = ApiTokenGetErrors[keyof ApiTokenGetErrors];
1836
+ export type ApiTokenGetResponses = {
1837
+ /**
1838
+ * Success
1839
+ */
1840
+ 200: ApiToken;
1841
+ };
1842
+ export type ApiTokenGetResponse = ApiTokenGetResponses[keyof ApiTokenGetResponses];
1843
+ export type ApiTokenUpdateData = {
1844
+ /**
1845
+ * The request body for updating token. Name is mandatory, valid_until is
1846
+ * optional and defaults to null (valid indefinitely), can be any valid datetime string.
1847
+ */
1848
+ body: {
1849
+ name?: string;
1850
+ valid_until?: string;
1851
+ };
1852
+ path: {
1853
+ /**
1854
+ * The ID of the item to update
1855
+ */
1856
+ id: number;
1857
+ };
1858
+ query?: never;
1859
+ url: "/api-token/{id}";
1860
+ };
1861
+ export type ApiTokenUpdateErrors = {
1862
+ /**
1863
+ * Not permitted to access
1864
+ */
1865
+ 403: Forbidden;
1866
+ /**
1867
+ * Token not found
1868
+ */
1869
+ 404: ApiTokenNotFound;
1870
+ };
1871
+ export type ApiTokenUpdateError = ApiTokenUpdateErrors[keyof ApiTokenUpdateErrors];
1872
+ export type ApiTokenUpdateResponses = {
1873
+ /**
1874
+ * Success
1875
+ */
1876
+ 200: {
1877
+ message?: string;
1878
+ data?: ApiToken;
1879
+ };
1880
+ };
1881
+ export type ApiTokenUpdateResponse = ApiTokenUpdateResponses[keyof ApiTokenUpdateResponses];
1882
+ export type CheckGetData = {
1883
+ body?: never;
1884
+ path: {
1885
+ /**
1886
+ * Monitor ID.
1887
+ */
1888
+ monitor: string;
1889
+ };
1890
+ query?: never;
1891
+ url: "/check/{monitor}";
1892
+ };
1893
+ export type CheckGetErrors = {
1894
+ /**
1895
+ * No subscription available to run this monitor.
1896
+ */
1897
+ 402: {
1898
+ message?: string;
1899
+ };
1900
+ /**
1901
+ * Access to the monitor denied.
1902
+ */
1903
+ 403: {
1904
+ message?: string;
1905
+ };
1906
+ /**
1907
+ * Monitor not found.
1908
+ */
1909
+ 404: {
1910
+ message?: string;
1911
+ };
1912
+ /**
1913
+ * Check executed too soon, try again later
1914
+ */
1915
+ 429: {
1916
+ message?: string;
1917
+ };
1918
+ /**
1919
+ * Other error
1920
+ */
1921
+ 500: {
1922
+ message?: string;
1923
+ };
1924
+ /**
1925
+ * Temporary error, try again later
1926
+ */
1927
+ 503: {
1928
+ message?: string;
1929
+ };
1930
+ };
1931
+ export type CheckGetError = CheckGetErrors[keyof CheckGetErrors];
1932
+ export type CheckGetResponses = {
1933
+ /**
1934
+ * Success
1935
+ */
1936
+ 200: LogEvent;
1937
+ };
1938
+ export type CheckGetResponse = CheckGetResponses[keyof CheckGetResponses];
1939
+ export type ContactsGetData = {
1940
+ body?: never;
1941
+ path?: never;
1942
+ query?: never;
1943
+ url: "/contacts";
1944
+ };
1945
+ export type ContactsGetErrors = {
1946
+ /**
1947
+ * Access to the resource was denied.
1948
+ */
1949
+ 403: {
1950
+ message?: string;
1951
+ };
1952
+ };
1953
+ export type ContactsGetError = ContactsGetErrors[keyof ContactsGetErrors];
1954
+ export type ContactsGetResponses = {
1955
+ /**
1956
+ * Success
1957
+ */
1958
+ 200: ContactCatalogue;
1959
+ };
1960
+ export type ContactsGetResponse = ContactsGetResponses[keyof ContactsGetResponses];
1961
+ export type ContactsCreateData = {
1962
+ body?: ContactItemCreate;
1963
+ path?: never;
1964
+ query?: never;
1965
+ url: "/contacts";
1966
+ };
1967
+ export type ContactsCreateErrors = {
1968
+ /**
1969
+ * Unsupported contact type
1970
+ */
1971
+ 400: {
1972
+ message?: string;
1973
+ };
1974
+ /**
1975
+ * You don't have permission to create a contact in this folder
1976
+ */
1977
+ 403: {
1978
+ message?: string;
1979
+ };
1980
+ };
1981
+ export type ContactsCreateError = ContactsCreateErrors[keyof ContactsCreateErrors];
1982
+ export type ContactsCreateResponses = {
1983
+ /**
1984
+ * Success
1985
+ */
1986
+ 201: ContactItem;
1987
+ };
1988
+ export type ContactsCreateResponse = ContactsCreateResponses[keyof ContactsCreateResponses];
1989
+ export type ContactDeleteData = {
1990
+ body?: never;
1991
+ path: {
1992
+ /**
1993
+ * Contact id
1994
+ */
1995
+ id: number;
1996
+ };
1997
+ query?: never;
1998
+ url: "/contacts/{id}";
1999
+ };
2000
+ export type ContactDeleteErrors = {
2001
+ /**
2002
+ * The channel is used for alerting.
2003
+ */
2004
+ 400: {
2005
+ message?: string;
2006
+ };
2007
+ /**
2008
+ * Access to the contact was denied.
2009
+ */
2010
+ 403: {
2011
+ message?: string;
2012
+ };
2013
+ /**
2014
+ * Contact not found or or insufficient privileges
2015
+ */
2016
+ 404: {
2017
+ message?: string;
2018
+ };
2019
+ };
2020
+ export type ContactDeleteError = ContactDeleteErrors[keyof ContactDeleteErrors];
2021
+ export type ContactDeleteResponses = {
2022
+ /**
2023
+ * Success
2024
+ */
2025
+ 204: void;
2026
+ };
2027
+ export type ContactDeleteResponse = ContactDeleteResponses[keyof ContactDeleteResponses];
2028
+ export type ContactsGetDetailData = {
2029
+ body?: never;
2030
+ path: {
2031
+ /**
2032
+ * The ID of the contact
2033
+ */
2034
+ id: number;
2035
+ };
2036
+ query?: never;
2037
+ url: "/contacts/{id}";
2038
+ };
2039
+ export type ContactsGetDetailErrors = {
2040
+ /**
2041
+ * Access to the contact was denied.
2042
+ */
2043
+ 403: {
2044
+ message?: string;
2045
+ };
2046
+ /**
2047
+ * Contact not found or or insufficient privileges
2048
+ */
2049
+ 404: {
2050
+ message?: string;
2051
+ };
2052
+ };
2053
+ export type ContactsGetDetailError = ContactsGetDetailErrors[keyof ContactsGetDetailErrors];
2054
+ export type ContactsGetDetailResponses = {
2055
+ /**
2056
+ * Success
2057
+ */
2058
+ 200: ContactItem;
2059
+ };
2060
+ export type ContactsGetDetailResponse = ContactsGetDetailResponses[keyof ContactsGetDetailResponses];
2061
+ export type ContactsUpdateData = {
2062
+ body?: ContactItemUpdate;
2063
+ path: {
2064
+ /**
2065
+ * The ID of the contact
2066
+ */
2067
+ id: number;
2068
+ };
2069
+ query?: never;
2070
+ url: "/contacts/{id}";
2071
+ };
2072
+ export type ContactsUpdateErrors = {
2073
+ /**
2074
+ * Email address is not valid
2075
+ */
2076
+ 400: {
2077
+ message?: string;
2078
+ };
2079
+ /**
2080
+ * Insufficient privileges to update the contact
2081
+ */
2082
+ 403: {
2083
+ message?: string;
2084
+ };
2085
+ /**
2086
+ * Contact not found or or insufficient privileges
2087
+ */
2088
+ 404: {
2089
+ message?: string;
2090
+ };
2091
+ };
2092
+ export type ContactsUpdateError = ContactsUpdateErrors[keyof ContactsUpdateErrors];
2093
+ export type ContactsUpdateResponses = {
2094
+ /**
2095
+ * Success
2096
+ */
2097
+ 200: ContactItem;
2098
+ };
2099
+ export type ContactsUpdateResponse = ContactsUpdateResponses[keyof ContactsUpdateResponses];
2100
+ export type ContactTestSendData = {
2101
+ body?: never;
2102
+ path: {
2103
+ /**
2104
+ * Contact id
2105
+ */
2106
+ id: number;
2107
+ };
2108
+ query?: never;
2109
+ url: "/contacts/test/{id}";
2110
+ };
2111
+ export type ContactTestSendErrors = {
2112
+ /**
2113
+ * Contact has invalid status for sending a test message
2114
+ */
2115
+ 400: {
2116
+ message?: string;
2117
+ };
2118
+ /**
2119
+ * Access to the contact was denied.
2120
+ */
2121
+ 403: {
2122
+ message?: string;
2123
+ };
2124
+ /**
2125
+ * Contact not found or or insufficient privileges
2126
+ */
2127
+ 404: {
2128
+ message?: string;
2129
+ };
2130
+ /**
2131
+ * Message not sent
2132
+ */
2133
+ 409: {
2134
+ message?: string;
2135
+ };
2136
+ /**
2137
+ * Max number of test messages per day already sent
2138
+ */
2139
+ 429: {
2140
+ message?: string;
2141
+ };
2142
+ };
2143
+ export type ContactTestSendError = ContactTestSendErrors[keyof ContactTestSendErrors];
2144
+ export type ContactTestSendResponses = {
2145
+ /**
2146
+ * Success
2147
+ */
2148
+ 200: {
2149
+ message?: string;
2150
+ };
2151
+ };
2152
+ export type ContactTestSendResponse = ContactTestSendResponses[keyof ContactTestSendResponses];
2153
+ export type ContactActivateData = {
2154
+ body?: never;
2155
+ path: {
2156
+ /**
2157
+ * ID of the contact to activate
2158
+ */
2159
+ id: number;
2160
+ };
2161
+ query?: never;
2162
+ url: "/contacts/{id}/activate";
2163
+ };
2164
+ export type ContactActivateErrors = {
2165
+ /**
2166
+ * The contact is not in inactive status, cannot be activated
2167
+ */
2168
+ 400: {
2169
+ message?: string;
2170
+ };
2171
+ /**
2172
+ * Access to the contact was denied.
2173
+ */
2174
+ 403: {
2175
+ message?: string;
2176
+ };
2177
+ /**
2178
+ * Contact not found or or insufficient privileges
2179
+ */
2180
+ 404: {
2181
+ message?: string;
2182
+ };
2183
+ };
2184
+ export type ContactActivateError = ContactActivateErrors[keyof ContactActivateErrors];
2185
+ export type ContactActivateResponses = {
2186
+ /**
2187
+ * Success
2188
+ */
2189
+ 204: void;
2190
+ };
2191
+ export type ContactActivateResponse = ContactActivateResponses[keyof ContactActivateResponses];
2192
+ export type ContactsConfirmData = {
2193
+ /**
2194
+ * The code to activate the contact is sent in request body
2195
+ */
2196
+ body?: {
2197
+ code?: string;
2198
+ };
2199
+ path: {
2200
+ /**
2201
+ * The contact ID
2202
+ */
2203
+ id: number;
2204
+ };
2205
+ query?: never;
2206
+ url: "/contacts/confirm/{id}";
2207
+ };
2208
+ export type ContactsConfirmErrors = {
2209
+ /**
2210
+ * The confirmation code is missing
2211
+ */
2212
+ 400: {
2213
+ message?: string;
2214
+ };
2215
+ /**
2216
+ * The confirmation code is invalid
2217
+ */
2218
+ 403: {
2219
+ message?: string;
2220
+ };
2221
+ /**
2222
+ * Contact not found or or insufficient privileges
2223
+ */
2224
+ 404: {
2225
+ message?: string;
2226
+ };
2227
+ /**
2228
+ * The contact is not waiting for confirmation
2229
+ */
2230
+ 409: {
2231
+ message?: string;
2232
+ };
2233
+ };
2234
+ export type ContactsConfirmError = ContactsConfirmErrors[keyof ContactsConfirmErrors];
2235
+ export type ContactsConfirmResponses = {
2236
+ /**
2237
+ * Success
2238
+ */
2239
+ 204: void;
2240
+ };
2241
+ export type ContactsConfirmResponse = ContactsConfirmResponses[keyof ContactsConfirmResponses];
2242
+ export type ContactsRequestConfirmationCodeData = {
2243
+ body?: never;
2244
+ path: {
2245
+ /**
2246
+ * The ID of the contact
2247
+ */
2248
+ id: number;
2249
+ };
2250
+ query?: never;
2251
+ url: "/contacts/request-confirmation-code/{id}";
2252
+ };
2253
+ export type ContactsRequestConfirmationCodeErrors = {
2254
+ /**
2255
+ * This contact type does not support confirmation codes
2256
+ */
2257
+ 400: {
2258
+ message?: string;
2259
+ };
2260
+ /**
2261
+ * Access to the contact was denied.
2262
+ */
2263
+ 403: {
2264
+ message?: string;
2265
+ };
2266
+ /**
2267
+ * Contact not found or or insufficient privileges
2268
+ */
2269
+ 404: {
2270
+ message?: string;
2271
+ };
2272
+ /**
2273
+ * The contact is not waiting for confirmation
2274
+ */
2275
+ 409: {
2276
+ message?: string;
2277
+ };
2278
+ /**
2279
+ * You can request a confirmation code for one contact once every 300 seconds
2280
+ */
2281
+ 429: {
2282
+ message?: string;
2283
+ };
2284
+ };
2285
+ export type ContactsRequestConfirmationCodeError = ContactsRequestConfirmationCodeErrors[keyof ContactsRequestConfirmationCodeErrors];
2286
+ export type ContactsRequestConfirmationCodeResponses = {
2287
+ /**
2288
+ * Success
2289
+ */
2290
+ 204: void;
2291
+ };
2292
+ export type ContactsRequestConfirmationCodeResponse = ContactsRequestConfirmationCodeResponses[keyof ContactsRequestConfirmationCodeResponses];
2293
+ export type ContactsBlockDeleteData = {
2294
+ body?: never;
2295
+ path: {
2296
+ /**
2297
+ * ID of the contact to unblock
2298
+ */
2299
+ id: number;
2300
+ };
2301
+ query?: never;
2302
+ url: "/contacts/block/{id}";
2303
+ };
2304
+ export type ContactsBlockDeleteErrors = {
2305
+ /**
2306
+ * You cannot change contact status to this value
2307
+ */
2308
+ 400: {
2309
+ message?: string;
2310
+ };
2311
+ /**
2312
+ * Access to the contact was denied.
2313
+ */
2314
+ 403: {
2315
+ message?: string;
2316
+ };
2317
+ /**
2318
+ * Contact not found or or insufficient privileges
2319
+ */
2320
+ 404: {
2321
+ message?: string;
2322
+ };
2323
+ };
2324
+ export type ContactsBlockDeleteError = ContactsBlockDeleteErrors[keyof ContactsBlockDeleteErrors];
2325
+ export type ContactsBlockDeleteResponses = {
2326
+ /**
2327
+ * Success
2328
+ */
2329
+ 204: void;
2330
+ };
2331
+ export type ContactsBlockDeleteResponse = ContactsBlockDeleteResponses[keyof ContactsBlockDeleteResponses];
2332
+ export type ContactsBlockPutData = {
2333
+ body?: never;
2334
+ path: {
2335
+ /**
2336
+ * ID of the contact to block
2337
+ */
2338
+ id: number;
2339
+ };
2340
+ query?: never;
2341
+ url: "/contacts/block/{id}";
2342
+ };
2343
+ export type ContactsBlockPutErrors = {
2344
+ /**
2345
+ * You cannot change contact status to this value
2346
+ */
2347
+ 400: {
2348
+ message?: string;
2349
+ };
2350
+ /**
2351
+ * Access to the contact was denied.
2352
+ */
2353
+ 403: {
2354
+ message?: string;
2355
+ };
2356
+ /**
2357
+ * Contact not found or or insufficient privileges
2358
+ */
2359
+ 404: {
2360
+ message?: string;
2361
+ };
2362
+ };
2363
+ export type ContactsBlockPutError = ContactsBlockPutErrors[keyof ContactsBlockPutErrors];
2364
+ export type ContactsBlockPutResponses = {
2365
+ /**
2366
+ * Success
2367
+ */
2368
+ 204: void;
2369
+ };
2370
+ export type ContactsBlockPutResponse = ContactsBlockPutResponses[keyof ContactsBlockPutResponses];
2371
+ export type ContactsReplaceNotificationsWithData = {
2372
+ body?: never;
2373
+ path: {
2374
+ /**
2375
+ * ID of the (old) contact being replaced
2376
+ */
2377
+ id: number;
2378
+ /**
2379
+ * ID of the (new) contact being used instead of the old one
2380
+ */
2381
+ to: number;
2382
+ };
2383
+ query?: never;
2384
+ url: "/contacts/{id}/replaceInNotificationsWith/{to}";
2385
+ };
2386
+ export type ContactsReplaceNotificationsWithErrors = {
2387
+ /**
2388
+ * The old and new contact IDs are the same
2389
+ */
2390
+ 400: {
2391
+ message?: string;
2392
+ };
2393
+ /**
2394
+ * Access to the contact was denied.
2395
+ */
2396
+ 403: {
2397
+ message?: string;
2398
+ };
2399
+ /**
2400
+ * Contact not found or or insufficient privileges
2401
+ */
2402
+ 404: {
2403
+ message?: string;
2404
+ };
2405
+ };
2406
+ export type ContactsReplaceNotificationsWithError = ContactsReplaceNotificationsWithErrors[keyof ContactsReplaceNotificationsWithErrors];
2407
+ export type ContactsReplaceNotificationsWithResponses = {
2408
+ /**
2409
+ * Success
2410
+ */
2411
+ 204: void;
2412
+ };
2413
+ export type ContactsReplaceNotificationsWithResponse = ContactsReplaceNotificationsWithResponses[keyof ContactsReplaceNotificationsWithResponses];
2414
+ export type FoldersListData = {
2415
+ body?: never;
2416
+ path?: never;
2417
+ query?: never;
2418
+ url: "/folders";
2419
+ };
2420
+ export type FoldersListErrors = {
2421
+ /**
2422
+ * Not permitted to access
2423
+ */
2424
+ 403: Forbidden;
2425
+ };
2426
+ export type FoldersListError = FoldersListErrors[keyof FoldersListErrors];
2427
+ export type FoldersListResponses = {
2428
+ /**
2429
+ * Success
2430
+ */
2431
+ 200: Array<FolderItem>;
2432
+ };
2433
+ export type FoldersListResponse = FoldersListResponses[keyof FoldersListResponses];
2434
+ export type FolderPostData = {
2435
+ /**
2436
+ * Folder attributes
2437
+ */
2438
+ body: FolderRequestItem;
2439
+ path?: never;
2440
+ query?: never;
2441
+ url: "/folders";
2442
+ };
2443
+ export type FolderPostErrors = {
2444
+ /**
2445
+ * Invalid data
2446
+ */
2447
+ 400: {
2448
+ message?: string;
2449
+ };
2450
+ /**
2451
+ * Not permitted to create
2452
+ */
2453
+ 403: Forbidden;
2454
+ };
2455
+ export type FolderPostError = FolderPostErrors[keyof FolderPostErrors];
2456
+ export type FolderPostResponses = {
2457
+ /**
2458
+ * Success
2459
+ */
2460
+ 201: FolderItem;
2461
+ };
2462
+ export type FolderPostResponse = FolderPostResponses[keyof FolderPostResponses];
2463
+ export type FolderDeleteData = {
2464
+ body?: never;
2465
+ path: {
2466
+ /**
2467
+ * Folder id
2468
+ */
2469
+ id: number;
2470
+ };
2471
+ query?: never;
2472
+ url: "/folders/{id}";
2473
+ };
2474
+ export type FolderDeleteErrors = {
2475
+ /**
2476
+ * Not permitted to delete
2477
+ */
2478
+ 403: Forbidden;
2479
+ /**
2480
+ * Folder not found
2481
+ */
2482
+ 404: {
2483
+ message?: string;
2484
+ };
2485
+ };
2486
+ export type FolderDeleteError = FolderDeleteErrors[keyof FolderDeleteErrors];
2487
+ export type FolderDeleteResponses = {
2488
+ /**
2489
+ * Success
2490
+ */
2491
+ 204: void;
2492
+ };
2493
+ export type FolderDeleteResponse = FolderDeleteResponses[keyof FolderDeleteResponses];
2494
+ export type FolderGetData = {
2495
+ body?: never;
2496
+ path: {
2497
+ /**
2498
+ * Folder id
2499
+ */
2500
+ id: number;
2501
+ };
2502
+ query?: never;
2503
+ url: "/folders/{id}";
2504
+ };
2505
+ export type FolderGetErrors = {
2506
+ /**
2507
+ * Not permitted to access
2508
+ */
2509
+ 403: Forbidden;
2510
+ /**
2511
+ * Folder not found
2512
+ */
2513
+ 404: {
2514
+ message?: string;
2515
+ };
2516
+ };
2517
+ export type FolderGetError = FolderGetErrors[keyof FolderGetErrors];
2518
+ export type FolderGetResponses = {
2519
+ /**
2520
+ * Success
2521
+ */
2522
+ 200: FolderItem;
2523
+ };
2524
+ export type FolderGetResponse = FolderGetResponses[keyof FolderGetResponses];
2525
+ export type FolderUpdateData = {
2526
+ /**
2527
+ * Folder attributes
2528
+ */
2529
+ body: FolderRequestItem;
2530
+ path: {
2531
+ /**
2532
+ * Folder id
2533
+ */
2534
+ id: number;
2535
+ };
2536
+ query?: never;
2537
+ url: "/folders/{id}";
2538
+ };
2539
+ export type FolderUpdateErrors = {
2540
+ /**
2541
+ * Invalid data
2542
+ */
2543
+ 400: {
2544
+ message?: string;
2545
+ };
2546
+ /**
2547
+ * Not permitted to update
2548
+ */
2549
+ 403: Forbidden;
2550
+ /**
2551
+ * Folder not found
2552
+ */
2553
+ 404: {
2554
+ message?: string;
2555
+ };
2556
+ };
2557
+ export type FolderUpdateError = FolderUpdateErrors[keyof FolderUpdateErrors];
2558
+ export type FolderUpdateResponses = {
2559
+ /**
2560
+ * Success
2561
+ */
2562
+ 200: FolderItem;
2563
+ };
2564
+ export type FolderUpdateResponse = FolderUpdateResponses[keyof FolderUpdateResponses];
2565
+ export type FolderAccessGetData = {
2566
+ body?: never;
2567
+ path: {
2568
+ /**
2569
+ * User id permissions are fetched for
2570
+ */
2571
+ user: number;
2572
+ };
2573
+ query?: never;
2574
+ url: "/folders/access/{user}";
2575
+ };
2576
+ export type FolderAccessGetErrors = {
2577
+ /**
2578
+ * Not permitted to access
2579
+ */
2580
+ 403: Forbidden;
2581
+ /**
2582
+ * Not found
2583
+ */
2584
+ 404: {
2585
+ message?: string;
2586
+ };
2587
+ };
2588
+ export type FolderAccessGetError = FolderAccessGetErrors[keyof FolderAccessGetErrors];
2589
+ export type FolderAccessGetResponses = {
2590
+ /**
2591
+ * Success
2592
+ */
2593
+ 200: Array<FolderItem>;
2594
+ };
2595
+ export type FolderAccessGetResponse = FolderAccessGetResponses[keyof FolderAccessGetResponses];
2596
+ export type LocationsDeleteData = {
2597
+ body?: never;
2598
+ path: {
2599
+ /**
2600
+ * Location ID
2601
+ */
2602
+ id: number;
2603
+ };
2604
+ query?: never;
2605
+ url: "/locations/{id}";
2606
+ };
2607
+ export type LocationsDeleteErrors = {
2608
+ /**
2609
+ * Invalid location - cannot be deleted (is not empty or is used)
2610
+ */
2611
+ 400: {
2612
+ message?: string;
2613
+ };
2614
+ /**
2615
+ * Not permitted to access
2616
+ */
2617
+ 403: Forbidden;
2618
+ /**
2619
+ * Not found
2620
+ */
2621
+ 404: {
2622
+ message?: string;
2623
+ };
2624
+ };
2625
+ export type LocationsDeleteError = LocationsDeleteErrors[keyof LocationsDeleteErrors];
2626
+ export type LocationsDeleteResponses = {
2627
+ /**
2628
+ * Success
2629
+ */
2630
+ 204: void;
2631
+ };
2632
+ export type LocationsDeleteResponse = LocationsDeleteResponses[keyof LocationsDeleteResponses];
2633
+ export type LocationsGetData = {
2634
+ body?: never;
2635
+ path: {
2636
+ /**
2637
+ * Location ID
2638
+ */
2639
+ id: number;
2640
+ };
2641
+ query?: never;
2642
+ url: "/locations/{id}";
2643
+ };
2644
+ export type LocationsGetErrors = {
2645
+ /**
2646
+ * Not permitted to access
2647
+ */
2648
+ 403: Forbidden;
2649
+ /**
2650
+ * Not found
2651
+ */
2652
+ 404: {
2653
+ message?: string;
2654
+ };
2655
+ };
2656
+ export type LocationsGetError = LocationsGetErrors[keyof LocationsGetErrors];
2657
+ export type LocationsGetResponses = {
2658
+ /**
2659
+ * Success
2660
+ */
2661
+ 200: Location;
2662
+ };
2663
+ export type LocationsGetResponse = LocationsGetResponses[keyof LocationsGetResponses];
2664
+ export type LocationsPostData = {
2665
+ /**
2666
+ * Location object.
2667
+ */
2668
+ body: LocationDraft;
2669
+ path: {
2670
+ /**
2671
+ * Location ID
2672
+ */
2673
+ id: number;
2674
+ };
2675
+ query?: never;
2676
+ url: "/locations/{id}";
2677
+ };
2678
+ export type LocationsPostErrors = {
2679
+ /**
2680
+ * Invalid request - missing or invalid data
2681
+ */
2682
+ 400: {
2683
+ message?: string;
2684
+ };
2685
+ /**
2686
+ * Not permitted to access
2687
+ */
2688
+ 403: Forbidden;
2689
+ /**
2690
+ * Parent location not found
2691
+ */
2692
+ 404: {
2693
+ message?: string;
2694
+ };
2695
+ };
2696
+ export type LocationsPostError = LocationsPostErrors[keyof LocationsPostErrors];
2697
+ export type LocationsPostResponses = {
2698
+ /**
2699
+ * Success
2700
+ */
2701
+ 200: Location;
2702
+ };
2703
+ export type LocationsPostResponse = LocationsPostResponses[keyof LocationsPostResponses];
2704
+ export type LocationsGetByTypeData = {
2705
+ body?: never;
2706
+ path: {
2707
+ /**
2708
+ * Location type filter
2709
+ */
2710
+ type: "private" | "public" | "all";
2711
+ };
2712
+ query?: never;
2713
+ url: "/locations/{type}";
2714
+ };
2715
+ export type LocationsGetByTypeErrors = {
2716
+ /**
2717
+ * Not permitted to access
2718
+ */
2719
+ 403: Forbidden;
2720
+ };
2721
+ export type LocationsGetByTypeError = LocationsGetByTypeErrors[keyof LocationsGetByTypeErrors];
2722
+ export type LocationsGetByTypeResponses = {
2723
+ /**
2724
+ * Success
2725
+ */
2726
+ 200: Array<Location>;
2727
+ };
2728
+ export type LocationsGetByTypeResponse = LocationsGetByTypeResponses[keyof LocationsGetByTypeResponses];
2729
+ export type LocationsGetAllData = {
2730
+ body?: never;
2731
+ path?: never;
2732
+ query?: never;
2733
+ url: "/locations";
2734
+ };
2735
+ export type LocationsGetAllErrors = {
2736
+ /**
2737
+ * Not permitted to access
2738
+ */
2739
+ 403: Forbidden;
2740
+ };
2741
+ export type LocationsGetAllError = LocationsGetAllErrors[keyof LocationsGetAllErrors];
2742
+ export type LocationsGetAllResponses = {
2743
+ /**
2744
+ * Success
2745
+ */
2746
+ 200: Array<Location>;
2747
+ };
2748
+ export type LocationsGetAllResponse = LocationsGetAllResponses[keyof LocationsGetAllResponses];
2749
+ export type LocationsCreateData = {
2750
+ /**
2751
+ * Location object.
2752
+ */
2753
+ body: LocationDraft;
2754
+ path?: never;
2755
+ query?: never;
2756
+ url: "/locations";
2757
+ };
2758
+ export type LocationsCreateErrors = {
2759
+ /**
2760
+ * Invalid request - missing or invalid data
2761
+ */
2762
+ 400: {
2763
+ message?: string;
2764
+ };
2765
+ /**
2766
+ * Not permitted to access
2767
+ */
2768
+ 403: Forbidden;
2769
+ /**
2770
+ * Parent location not found
2771
+ */
2772
+ 404: {
2773
+ message?: string;
2774
+ };
2775
+ };
2776
+ export type LocationsCreateError = LocationsCreateErrors[keyof LocationsCreateErrors];
2777
+ export type LocationsCreateResponses = {
2778
+ /**
2779
+ * Success
2780
+ */
2781
+ 200: Location;
2782
+ };
2783
+ export type LocationsCreateResponse = LocationsCreateResponses[keyof LocationsCreateResponses];
2784
+ export type LocationsLeafGetFilterData = {
2785
+ body?: never;
2786
+ path: {
2787
+ /**
2788
+ * Location filter
2789
+ */
2790
+ filter: "private" | "public" | "all";
2791
+ };
2792
+ query?: never;
2793
+ url: "/locations/leaf/{filter}";
2794
+ };
2795
+ export type LocationsLeafGetFilterErrors = {
2796
+ /**
2797
+ * Invalid request - invalid filter
2798
+ */
2799
+ 400: {
2800
+ message?: string;
2801
+ };
2802
+ /**
2803
+ * Not permitted to access
2804
+ */
2805
+ 403: Forbidden;
2806
+ };
2807
+ export type LocationsLeafGetFilterError = LocationsLeafGetFilterErrors[keyof LocationsLeafGetFilterErrors];
2808
+ export type LocationsLeafGetFilterResponses = {
2809
+ /**
2810
+ * Success
2811
+ */
2812
+ 200: Array<Location>;
2813
+ };
2814
+ export type LocationsLeafGetFilterResponse = LocationsLeafGetFilterResponses[keyof LocationsLeafGetFilterResponses];
2815
+ export type LogGetData = {
2816
+ body?: never;
2817
+ path?: never;
2818
+ query?: {
2819
+ /**
2820
+ * List of monitors to query. If both 'monitors' and 'folders' are omitted,
2821
+ * query all monitors. Format: Monitor name (string) or monitor ID (integer).
2822
+ */
2823
+ monitor?: Array<string>;
2824
+ /**
2825
+ * List of folders to query. If both 'monitors' and 'folders' are omitted,
2826
+ * query all monitors. Format: Folder name (string) or folder ID (integer).
2827
+ */
2828
+ folder?: Array<string>;
2829
+ /**
2830
+ * List of locations to filter by. Format: Location name (string) or location ID (integer).
2831
+ */
2832
+ location?: Array<string>;
2833
+ /**
2834
+ * Start of interval. Format: ISO 8601 date and time or event ID.
2835
+ */
2836
+ from?: string;
2837
+ /**
2838
+ * End of interval. Format: ISO 8601 date and time or event ID.
2839
+ */
2840
+ to?: string;
2841
+ /**
2842
+ * Filter results by status.
2843
+ */
2844
+ status?: "error" | "confirmed_error";
2845
+ /**
2846
+ * Show extended results.
2847
+ */
2848
+ extended?: boolean;
2849
+ /**
2850
+ * Limit number of results.
2851
+ */
2852
+ limit?: number;
2853
+ };
2854
+ url: "/log";
2855
+ };
2856
+ export type LogGetErrors = {
2857
+ /**
2858
+ * Bad request
2859
+ */
2860
+ 400: {
2861
+ message?: string;
2862
+ };
2863
+ /**
2864
+ * Not permitted to access
2865
+ */
2866
+ 403: Forbidden;
2867
+ };
2868
+ export type LogGetError = LogGetErrors[keyof LogGetErrors];
2869
+ export type LogGetResponses = {
2870
+ /**
2871
+ * Success
2872
+ */
2873
+ 200: Array<LogEvent>;
2874
+ };
2875
+ export type LogGetResponse = LogGetResponses[keyof LogGetResponses];
2876
+ export type LogGetEventData = {
2877
+ body?: never;
2878
+ path: {
2879
+ /**
2880
+ * Event ID
2881
+ */
2882
+ id: string;
2883
+ };
2884
+ query?: never;
2885
+ url: "/log/{id}";
2886
+ };
2887
+ export type LogGetEventErrors = {
2888
+ /**
2889
+ * Bad request
2890
+ */
2891
+ 400: {
2892
+ message?: string;
2893
+ };
2894
+ /**
2895
+ * Not permitted to access
2896
+ */
2897
+ 403: Forbidden;
2898
+ };
2899
+ export type LogGetEventError = LogGetEventErrors[keyof LogGetEventErrors];
2900
+ export type LogGetEventResponses = {
2901
+ /**
2902
+ * Success
2903
+ */
2904
+ 200: LogEvent;
2905
+ };
2906
+ export type LogGetEventResponse = LogGetEventResponses[keyof LogGetEventResponses];
2907
+ export type MaintenanceGetData = {
2908
+ body?: never;
2909
+ path?: never;
2910
+ query?: {
2911
+ /**
2912
+ * Include also expired maintenance windows.
2913
+ */
2914
+ includeExpired?: boolean;
2915
+ };
2916
+ url: "/maintenances";
2917
+ };
2918
+ export type MaintenanceGetErrors = {
2919
+ /**
2920
+ * Insufficient permissions
2921
+ */
2922
+ 403: {
2923
+ message?: string;
2924
+ };
2925
+ };
2926
+ export type MaintenanceGetError = MaintenanceGetErrors[keyof MaintenanceGetErrors];
2927
+ export type MaintenanceGetResponses = {
2928
+ /**
2929
+ * Success
2930
+ */
2931
+ 200: MaintenanceCatalogue;
2932
+ };
2933
+ export type MaintenanceGetResponse = MaintenanceGetResponses[keyof MaintenanceGetResponses];
2934
+ export type MaintenancesCreateData = {
2935
+ /**
2936
+ * `name` and `windows` is required.
2937
+ */
2938
+ body: MaintenanceItemCreate;
2939
+ path?: never;
2940
+ query?: never;
2941
+ url: "/maintenances";
2942
+ };
2943
+ export type MaintenancesCreateErrors = {
2944
+ /**
2945
+ * Wrong values were passed
2946
+ */
2947
+ 400: {
2948
+ message?: string;
2949
+ };
2950
+ /**
2951
+ * Insufficient permissions
2952
+ */
2953
+ 403: {
2954
+ message?: string;
2955
+ };
2956
+ };
2957
+ export type MaintenancesCreateError = MaintenancesCreateErrors[keyof MaintenancesCreateErrors];
2958
+ export type MaintenancesCreateResponses = {
2959
+ /**
2960
+ * Success
2961
+ */
2962
+ 201: MaintenanceItem;
2963
+ };
2964
+ export type MaintenancesCreateResponse = MaintenancesCreateResponses[keyof MaintenancesCreateResponses];
2965
+ export type MaintenanceDeleteData = {
2966
+ body?: never;
2967
+ path: {
2968
+ /**
2969
+ * Maintenance ID
2970
+ */
2971
+ id: number;
2972
+ };
2973
+ query?: never;
2974
+ url: "/maintenances/{id}";
2975
+ };
2976
+ export type MaintenanceDeleteErrors = {
2977
+ /**
2978
+ * Not permitted to access
2979
+ */
2980
+ 403: Forbidden;
2981
+ /**
2982
+ * Maintenance not found
2983
+ */
2984
+ 404: {
2985
+ message?: string;
2986
+ };
2987
+ };
2988
+ export type MaintenanceDeleteError = MaintenanceDeleteErrors[keyof MaintenanceDeleteErrors];
2989
+ export type MaintenanceDeleteResponses = {
2990
+ /**
2991
+ * Success
2992
+ */
2993
+ 204: void;
2994
+ };
2995
+ export type MaintenanceDeleteResponse = MaintenanceDeleteResponses[keyof MaintenanceDeleteResponses];
2996
+ export type MaintenanceGetDetailData = {
2997
+ body?: never;
2998
+ path: {
2999
+ /**
3000
+ * The maintenance window ID
3001
+ */
3002
+ id: number;
3003
+ };
3004
+ query?: never;
3005
+ url: "/maintenances/{id}";
3006
+ };
3007
+ export type MaintenanceGetDetailErrors = {
3008
+ /**
3009
+ * Not permitted to access
3010
+ */
3011
+ 403: Forbidden;
3012
+ /**
3013
+ * Not Found
3014
+ */
3015
+ 404: {
3016
+ message?: string;
3017
+ };
3018
+ };
3019
+ export type MaintenanceGetDetailError = MaintenanceGetDetailErrors[keyof MaintenanceGetDetailErrors];
3020
+ export type MaintenanceGetDetailResponses = {
3021
+ /**
3022
+ * Success
3023
+ */
3024
+ 200: MaintenanceItem;
3025
+ };
3026
+ export type MaintenanceGetDetailResponse = MaintenanceGetDetailResponses[keyof MaintenanceGetDetailResponses];
3027
+ export type MaintenancesUpdateData = {
3028
+ /**
3029
+ * Values not specified are not modified
3030
+ */
3031
+ body: MaintenanceItem;
3032
+ path: {
3033
+ /**
3034
+ * The maintenance window ID
3035
+ */
3036
+ id: number;
3037
+ };
3038
+ query?: never;
3039
+ url: "/maintenances/{id}";
3040
+ };
3041
+ export type MaintenancesUpdateErrors = {
3042
+ /**
3043
+ * Wrong values were passed
3044
+ */
3045
+ 400: {
3046
+ message?: string;
3047
+ };
3048
+ /**
3049
+ * Insufficient permissions
3050
+ */
3051
+ 403: {
3052
+ message?: string;
3053
+ };
3054
+ };
3055
+ export type MaintenancesUpdateError = MaintenancesUpdateErrors[keyof MaintenancesUpdateErrors];
3056
+ export type MaintenancesUpdateResponses = {
3057
+ /**
3058
+ * Success
3059
+ */
3060
+ 200: MaintenanceItem;
3061
+ };
3062
+ export type MaintenancesUpdateResponse = MaintenancesUpdateResponses[keyof MaintenancesUpdateResponses];
3063
+ export type MaintenanceGetWindowsData = {
3064
+ body?: never;
3065
+ path: {
3066
+ /**
3067
+ * The maintenance window ID
3068
+ */
3069
+ id: number;
3070
+ };
3071
+ query?: never;
3072
+ url: "/maintenances/{id}/windows";
3073
+ };
3074
+ export type MaintenanceGetWindowsErrors = {
3075
+ /**
3076
+ * Not Found
3077
+ */
3078
+ 404: {
3079
+ message?: string;
3080
+ };
3081
+ };
3082
+ export type MaintenanceGetWindowsError = MaintenanceGetWindowsErrors[keyof MaintenanceGetWindowsErrors];
3083
+ export type MaintenanceGetWindowsResponses = {
3084
+ /**
3085
+ * Success
3086
+ */
3087
+ 200: Array<MaintenanceWindowItem>;
3088
+ };
3089
+ export type MaintenanceGetWindowsResponse = MaintenanceGetWindowsResponses[keyof MaintenanceGetWindowsResponses];
3090
+ export type MaintenancesPostWindowsData = {
3091
+ body?: WindowItemCreate;
3092
+ path: {
3093
+ /**
3094
+ * The ID of the maintenance window
3095
+ */
3096
+ id: number;
3097
+ };
3098
+ query?: never;
3099
+ url: "/maintenances/{id}/windows";
3100
+ };
3101
+ export type MaintenancesPostWindowsErrors = {
3102
+ /**
3103
+ * Wrong values were passed
3104
+ */
3105
+ 400: {
3106
+ message?: string;
3107
+ };
3108
+ /**
3109
+ * Insufficient permissions
3110
+ */
3111
+ 403: {
3112
+ message?: string;
3113
+ };
3114
+ /**
3115
+ * Not Found
3116
+ */
3117
+ 404: {
3118
+ message?: string;
3119
+ };
3120
+ };
3121
+ export type MaintenancesPostWindowsError = MaintenancesPostWindowsErrors[keyof MaintenancesPostWindowsErrors];
3122
+ export type MaintenancesPostWindowsResponses = {
3123
+ /**
3124
+ * Success
3125
+ */
3126
+ 201: MaintenanceWindowItem;
3127
+ };
3128
+ export type MaintenancesPostWindowsResponse = MaintenancesPostWindowsResponses[keyof MaintenancesPostWindowsResponses];
3129
+ export type MaintenanceDeleteWindowsData = {
3130
+ body?: never;
3131
+ path: {
3132
+ /**
3133
+ * The maintenance window ID that the time window belongs to
3134
+ */
3135
+ maintenanceWindowId: number;
3136
+ /**
3137
+ * The time window to delete
3138
+ */
3139
+ timeWindowId: number;
3140
+ };
3141
+ query?: never;
3142
+ url: "/maintenances/{maintenanceWindowId}/windows/{timeWindowId}";
3143
+ };
3144
+ export type MaintenanceDeleteWindowsErrors = {
3145
+ /**
3146
+ * Insufficient permissions
3147
+ */
3148
+ 403: {
3149
+ message?: string;
3150
+ };
3151
+ /**
3152
+ * Not Found
3153
+ */
3154
+ 404: {
3155
+ message?: string;
3156
+ };
3157
+ };
3158
+ export type MaintenanceDeleteWindowsError = MaintenanceDeleteWindowsErrors[keyof MaintenanceDeleteWindowsErrors];
3159
+ export type MaintenanceDeleteWindowsResponses = {
3160
+ /**
3161
+ * Success
3162
+ */
3163
+ 204: void;
3164
+ };
3165
+ export type MaintenanceDeleteWindowsResponse = MaintenanceDeleteWindowsResponses[keyof MaintenanceDeleteWindowsResponses];
3166
+ export type MaintenanceGetWindowsDetailData = {
3167
+ body?: never;
3168
+ path: {
3169
+ /**
3170
+ * The maintenance window ID
3171
+ */
3172
+ maintenanceWindowId: number;
3173
+ /**
3174
+ * The time window ID
3175
+ */
3176
+ timeWindowId: number;
3177
+ };
3178
+ query?: never;
3179
+ url: "/maintenances/{maintenanceWindowId}/windows/{timeWindowId}";
3180
+ };
3181
+ export type MaintenanceGetWindowsDetailErrors = {
3182
+ /**
3183
+ * Not Found
3184
+ */
3185
+ 404: {
3186
+ message?: string;
3187
+ };
3188
+ };
3189
+ export type MaintenanceGetWindowsDetailError = MaintenanceGetWindowsDetailErrors[keyof MaintenanceGetWindowsDetailErrors];
3190
+ export type MaintenanceGetWindowsDetailResponses = {
3191
+ /**
3192
+ * Success
3193
+ */
3194
+ 200: MaintenanceWindowItem;
3195
+ };
3196
+ export type MaintenanceGetWindowsDetailResponse = MaintenanceGetWindowsDetailResponses[keyof MaintenanceGetWindowsDetailResponses];
3197
+ export type MaintenanceUpdateWindowsDetailData = {
3198
+ body?: WindowItemCreate;
3199
+ path: {
3200
+ /**
3201
+ * The maintenance window ID
3202
+ */
3203
+ maintenanceWindowId: number;
3204
+ /**
3205
+ * The individual window ID
3206
+ */
3207
+ timeWindowId: number;
3208
+ };
3209
+ query?: never;
3210
+ url: "/maintenances/{maintenanceWindowId}/windows/{timeWindowId}";
3211
+ };
3212
+ export type MaintenanceUpdateWindowsDetailErrors = {
3213
+ /**
3214
+ * Not Found
3215
+ */
3216
+ 404: {
3217
+ message?: string;
3218
+ };
3219
+ };
3220
+ export type MaintenanceUpdateWindowsDetailError = MaintenanceUpdateWindowsDetailErrors[keyof MaintenanceUpdateWindowsDetailErrors];
3221
+ export type MaintenanceUpdateWindowsDetailResponses = {
3222
+ /**
3223
+ * Success
3224
+ */
3225
+ 200: MaintenanceWindowItem;
3226
+ };
3227
+ export type MaintenanceUpdateWindowsDetailResponse = MaintenanceUpdateWindowsDetailResponses[keyof MaintenanceUpdateWindowsDetailResponses];
3228
+ export type MaintenancesImmediateDeleteData = {
3229
+ /**
3230
+ * Ids of monitors the immediate maintenance should be finished. You need update permission for these monitors
3231
+ */
3232
+ body: Array<number>;
3233
+ path?: never;
3234
+ query?: never;
3235
+ url: "/maintenances/immediate";
3236
+ };
3237
+ export type MaintenancesImmediateDeleteErrors = {
3238
+ /**
3239
+ * Wrong values were passed
3240
+ */
3241
+ 400: {
3242
+ message?: string;
3243
+ };
3244
+ /**
3245
+ * Insufficient permissions
3246
+ */
3247
+ 403: Forbidden;
3248
+ };
3249
+ export type MaintenancesImmediateDeleteError = MaintenancesImmediateDeleteErrors[keyof MaintenancesImmediateDeleteErrors];
3250
+ export type MaintenancesImmediateDeleteResponses = {
3251
+ /**
3252
+ * Success
3253
+ */
3254
+ 204: void;
3255
+ };
3256
+ export type MaintenancesImmediateDeleteResponse = MaintenancesImmediateDeleteResponses[keyof MaintenancesImmediateDeleteResponses];
3257
+ export type MaintenancesImmediatePutData = {
3258
+ /**
3259
+ * Immediate maintenance window
3260
+ */
3261
+ body: MaintenanceItemImmediateCreate;
3262
+ path?: never;
3263
+ query?: never;
3264
+ url: "/maintenances/immediate";
3265
+ };
3266
+ export type MaintenancesImmediatePutErrors = {
3267
+ /**
3268
+ * Wrong values were passed
3269
+ */
3270
+ 400: {
3271
+ message?: string;
3272
+ };
3273
+ /**
3274
+ * Insufficient permissions
3275
+ */
3276
+ 403: Forbidden;
3277
+ };
3278
+ export type MaintenancesImmediatePutError = MaintenancesImmediatePutErrors[keyof MaintenancesImmediatePutErrors];
3279
+ export type MaintenancesImmediatePutResponses = {
3280
+ /**
3281
+ * Success
3282
+ */
3283
+ 204: void;
3284
+ };
3285
+ export type MaintenancesImmediatePutResponse = MaintenancesImmediatePutResponses[keyof MaintenancesImmediatePutResponses];
3286
+ export type MessagesListData = {
3287
+ body?: never;
3288
+ path?: never;
3289
+ query?: {
3290
+ /**
3291
+ * Filter alerts related to a monitor.
3292
+ */
3293
+ monitorId?: number;
3294
+ /**
3295
+ * Filter alerts related to monitors in a folder.
3296
+ */
3297
+ folderId?: number;
3298
+ /**
3299
+ * Select messages that represent some monitor alert or not. Note: expire
3300
+ * certificate notifications are not alerts - they are not bound to a particular monitor or contact.
3301
+ */
3302
+ isAlert?: boolean;
3303
+ /**
3304
+ * Contact ID. You need contact update permission to filter by the contact.
3305
+ */
3306
+ contactId?: number;
3307
+ /**
3308
+ * Select messages by message type.
3309
+ */
3310
+ type?: "email" | "sms" | "phone" | "action" | "rss";
3311
+ /**
3312
+ * Select messages by message status.
3313
+ */
3314
+ status?: "deleted" | "queued" | "gateway" | "provider" | "device" | "accepted" | "queued-no-fallback" | "undeliverable" | "suppressed";
3315
+ /**
3316
+ * Select messages by date and time when it was sent. It can also be provided as positive integer - the oldest message ID.
3317
+ */
3318
+ from?: string;
3319
+ /**
3320
+ * Select messages by date and time when it was sent. It can also be provided as positive integer - the newest message ID.
3321
+ */
3322
+ to?: string;
3323
+ /**
3324
+ * Max number of results to return.
3325
+ */
3326
+ limit?: number;
3327
+ };
3328
+ url: "/messages";
3329
+ };
3330
+ export type MessagesListErrors = {
3331
+ /**
3332
+ * Bad request
3333
+ */
3334
+ 400: unknown;
3335
+ /**
3336
+ * Not permitted to access
3337
+ */
3338
+ 403: Forbidden;
3339
+ /**
3340
+ * Not found
3341
+ */
3342
+ 404: unknown;
3343
+ };
3344
+ export type MessagesListError = MessagesListErrors[keyof MessagesListErrors];
3345
+ export type MessagesListResponses = {
3346
+ /**
3347
+ * Success
3348
+ */
3349
+ 200: Array<MessageItem>;
3350
+ };
3351
+ export type MessagesListResponse = MessagesListResponses[keyof MessagesListResponses];
3352
+ export type MessageGetData = {
3353
+ body?: never;
3354
+ path: {
3355
+ /**
3356
+ * Message id
3357
+ */
3358
+ id: number;
3359
+ };
3360
+ query?: never;
3361
+ url: "/messages/{id}";
3362
+ };
3363
+ export type MessageGetErrors = {
3364
+ /**
3365
+ * Not permitted to access
3366
+ */
3367
+ 403: Forbidden;
3368
+ };
3369
+ export type MessageGetError = MessageGetErrors[keyof MessageGetErrors];
3370
+ export type MessageGetResponses = {
3371
+ /**
3372
+ * Success
3373
+ */
3374
+ 200: MessageItem;
3375
+ };
3376
+ export type MessageGetResponse = MessageGetResponses[keyof MessageGetResponses];
3377
+ export type MonitorGetAllData = {
3378
+ body?: never;
3379
+ path?: never;
3380
+ query?: {
3381
+ /**
3382
+ * Flag for reading the simple and fast list of monitor frames. If true, the
3383
+ * simple monitor schemas (MonitorFrame) are returned in the response (which
3384
+ * should be slightly faster), the full schema (Monitor) otherwise
3385
+ */
3386
+ framesOnly?: boolean;
3387
+ /**
3388
+ * Flag for sending response together with the pagination information. If true,
3389
+ * the MonitorsPage schema is returned with pagination information, the simple
3390
+ * array of matching monitors otherwise.
3391
+ */
3392
+ pagination?: boolean;
3393
+ /**
3394
+ * Monitor ID or comma separated list of monitor IDs.
3395
+ */
3396
+ monitorId?: string;
3397
+ /**
3398
+ * Folder ID. Use 0 for monitors out of folder.
3399
+ */
3400
+ folderId?: number;
3401
+ /**
3402
+ * Select monitors user has this level of access.
3403
+ */
3404
+ accessLevel?: "view" | "update" | "create-delete";
3405
+ /**
3406
+ * Select monitors by type.
3407
+ */
3408
+ type?: "browser" | "connect" | "dnsa" | "dnsns" | "dns" | "domain" | "ftp" | "ftps" | "http" | "https" | "imap" | "ldap" | "ping" | "plugin" | "pop3" | "scp" | "script" | "sftp" | "sip" | "smtp" | "telnet" | "webdriver";
3409
+ /**
3410
+ * Flag for filtering active monitors only.
3411
+ */
3412
+ isActive?: boolean;
3413
+ /**
3414
+ * Flag for filtering failing monitors only. With false both the active non-failing monitors and inactive monitors are returned.
3415
+ */
3416
+ inError?: boolean;
3417
+ /**
3418
+ * Flag for filtering monitors with unhealthy pool of stations.
3419
+ */
3420
+ isUnhealthy?: boolean;
3421
+ /**
3422
+ * Flag for filtering monitors configured to use a proxy or not.
3423
+ */
3424
+ proxy?: "none" | "system" | "custom";
3425
+ /**
3426
+ * Flag for filtering monitors with authentication enabled.
3427
+ */
3428
+ hasAuthentication?: boolean;
3429
+ /**
3430
+ * Select monitors by username used in authentication.
3431
+ */
3432
+ username?: string;
3433
+ /**
3434
+ * Select monitors that are tagged by one of this tags (pipe separated list).
3435
+ */
3436
+ tag?: string;
3437
+ /**
3438
+ * Select monitors by name. See also the nameMatchType option below.
3439
+ */
3440
+ name?: string;
3441
+ /**
3442
+ * Match type for the monitor-by-name filtering. I nameMatchType is 'full'
3443
+ * (or empty as this is default) the name must be equal to the filter value,
3444
+ * if 'partial' the name must contain the filter value.
3445
+ */
3446
+ nameMatchType?: "full" | "partial";
3447
+ /**
3448
+ * Monitoring location ID.
3449
+ */
3450
+ locationId?: number;
3451
+ /**
3452
+ * Monitoring station ID.
3453
+ */
3454
+ stationId?: number;
3455
+ /**
3456
+ * Flag for filtering by station or monitor ID. If true, find only monitors
3457
+ * explicitly configured for the location, i.e. do not select monitors with
3458
+ * empty (default) pool. Default is false for public stations / locations, true for OPMS.
3459
+ */
3460
+ explicitPoolOnly?: boolean;
3461
+ /**
3462
+ * Low monitor ID limit for pagination (needs sorting by monitor ID)
3463
+ */
3464
+ from?: number;
3465
+ /**
3466
+ * High monitor ID limit for pagination (needs sorting by monitor ID)
3467
+ */
3468
+ to?: number;
3469
+ /**
3470
+ * Max number of results to return.
3471
+ */
3472
+ limit?: number;
3473
+ /**
3474
+ * Zero based offset for pagination. Limit is required if offset is set.
3475
+ */
3476
+ offset?: number;
3477
+ /**
3478
+ * Order by string.
3479
+ */
3480
+ order?: string;
3481
+ };
3482
+ url: "/monitors";
3483
+ };
3484
+ export type MonitorGetAllErrors = {
3485
+ /**
3486
+ * Not permitted to access
3487
+ */
3488
+ 403: Forbidden;
3489
+ /**
3490
+ * Not found
3491
+ */
3492
+ 404: {
3493
+ message?: string;
3494
+ };
3495
+ };
3496
+ export type MonitorGetAllError = MonitorGetAllErrors[keyof MonitorGetAllErrors];
3497
+ export type MonitorGetAllResponses = {
3498
+ /**
3499
+ * Success. The result returned depends on the framesOnly and pagination parameters.
3500
+ */
3501
+ 200: MonitorsPage | Array<Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver | MonitorFrame>;
3502
+ };
3503
+ export type MonitorGetAllResponse = MonitorGetAllResponses[keyof MonitorGetAllResponses];
3504
+ export type MonitorCreateData = {
3505
+ /**
3506
+ * Monitor settings
3507
+ */
3508
+ body: BrowserCreate | ConnectCreate | DnsCreate | DnsaCreate | DnsnsCreate | DomainCreate | FtpCreate | FtpsCreate | HttpCreate | HttpsCreate | ImapCreate | LdapCreate | PingCreate | PluginCreate | Pop3Create | ScpCreate | ScriptCreate | SftpCreate | SipCreate | SmtpCreate | TelnetCreate | WebdriverCreate;
3509
+ path?: never;
3510
+ query?: never;
3511
+ url: "/monitors";
3512
+ };
3513
+ export type MonitorCreateErrors = {
3514
+ /**
3515
+ * Bad request
3516
+ */
3517
+ 400: {
3518
+ status?: string;
3519
+ message?: string;
3520
+ data?: {
3521
+ details?: unknown;
3522
+ };
3523
+ };
3524
+ /**
3525
+ * Not permitted to access
3526
+ */
3527
+ 403: Forbidden;
3528
+ };
3529
+ export type MonitorCreateError = MonitorCreateErrors[keyof MonitorCreateErrors];
3530
+ export type MonitorCreateResponses = {
3531
+ /**
3532
+ * Success
3533
+ */
3534
+ 201: {
3535
+ monitorId?: number;
3536
+ };
3537
+ };
3538
+ export type MonitorCreateResponse = MonitorCreateResponses[keyof MonitorCreateResponses];
3539
+ export type MonitorDeleteData = {
3540
+ body?: never;
3541
+ path: {
3542
+ /**
3543
+ * Monitor ID
3544
+ */
3545
+ id: number;
3546
+ };
3547
+ query?: never;
3548
+ url: "/monitors/{id}";
3549
+ };
3550
+ export type MonitorDeleteErrors = {
3551
+ /**
3552
+ * Not permitted to access
3553
+ */
3554
+ 403: Forbidden;
3555
+ /**
3556
+ * Not found
3557
+ */
3558
+ 404: unknown;
3559
+ };
3560
+ export type MonitorDeleteError = MonitorDeleteErrors[keyof MonitorDeleteErrors];
3561
+ export type MonitorDeleteResponses = {
3562
+ /**
3563
+ * Success
3564
+ */
3565
+ 200: unknown;
3566
+ };
3567
+ export type MonitorGetData = {
3568
+ body?: never;
3569
+ path: {
3570
+ /**
3571
+ * Monitor ID
3572
+ */
3573
+ id: number;
3574
+ };
3575
+ query?: never;
3576
+ url: "/monitors/{id}";
3577
+ };
3578
+ export type MonitorGetErrors = {
3579
+ /**
3580
+ * Not permitted to access
3581
+ */
3582
+ 403: Forbidden;
3583
+ };
3584
+ export type MonitorGetError = MonitorGetErrors[keyof MonitorGetErrors];
3585
+ export type MonitorGetResponses = {
3586
+ /**
3587
+ * Success
3588
+ */
3589
+ 200: Browser | Connect | Dns | Dnsa | Dnsns | Domain | Ftp | Ftps | Http | Https | Imap | Ldap | Ping | Plugin | Pop3 | Scp | Script | Sftp | Sip | Smtp | Telnet | Webdriver;
3590
+ };
3591
+ export type MonitorGetResponse = MonitorGetResponses[keyof MonitorGetResponses];
3592
+ export type MonitorUpdateData = {
3593
+ /**
3594
+ * Monitor settings
3595
+ */
3596
+ body: BrowserUpdate | ConnectUpdate | DnsUpdate | DnsaUpdate | DnsnsUpdate | DomainUpdate | FtpUpdate | FtpsUpdate | HttpUpdate | HttpsUpdate | ImapUpdate | LdapUpdate | PingUpdate | PluginUpdate | Pop3Update | ScpUpdate | ScriptUpdate | SftpUpdate | SipUpdate | SmtpUpdate | TelnetUpdate | WebdriverUpdate;
3597
+ path: {
3598
+ /**
3599
+ * Monitor ID
3600
+ */
3601
+ id: number;
3602
+ };
3603
+ query?: never;
3604
+ url: "/monitors/{id}";
3605
+ };
3606
+ export type MonitorUpdateErrors = {
3607
+ /**
3608
+ * Bad request
3609
+ */
3610
+ 400: {
3611
+ status?: string;
3612
+ message?: string;
3613
+ data?: {
3614
+ details?: unknown;
3615
+ };
3616
+ };
3617
+ /**
3618
+ * Not permitted to access
3619
+ */
3620
+ 403: Forbidden;
3621
+ };
3622
+ export type MonitorUpdateError = MonitorUpdateErrors[keyof MonitorUpdateErrors];
3623
+ export type MonitorUpdateResponses = {
3624
+ /**
3625
+ * Success
3626
+ */
3627
+ 200: {
3628
+ message?: string;
3629
+ };
3630
+ };
3631
+ export type MonitorUpdateResponse = MonitorUpdateResponses[keyof MonitorUpdateResponses];
3632
+ export type MonitorActivateData = {
3633
+ body?: never;
3634
+ path?: never;
3635
+ query: {
3636
+ /**
3637
+ * List of monitors to activate. Format: Comma-separated monitor IDs or monitor names
3638
+ */
3639
+ monitor: Array<string>;
3640
+ };
3641
+ url: "/monitors/activate";
3642
+ };
3643
+ export type MonitorActivateErrors = {
3644
+ /**
3645
+ * Bad request
3646
+ */
3647
+ 400: unknown;
3648
+ /**
3649
+ * Subscription not enough for activation
3650
+ */
3651
+ 402: unknown;
3652
+ /**
3653
+ * Not permitted
3654
+ */
3655
+ 403: unknown;
3656
+ /**
3657
+ * Not found
3658
+ */
3659
+ 404: unknown;
3660
+ };
3661
+ export type MonitorActivateResponses = {
3662
+ /**
3663
+ * Successful activation
3664
+ */
3665
+ 200: {
3666
+ responses?: Array<{
3667
+ id?: unknown;
3668
+ status?: number;
3669
+ resource?: unknown;
3670
+ message?: string;
3671
+ }>;
3672
+ metadata?: BulkResponseMetadata;
3673
+ };
3674
+ /**
3675
+ * Multiple results. If the results in the bulk response have a mix of different HTTP
3676
+ * codes, the final HTTP code will be 207 Multi-status. In that case check the results
3677
+ * carefully one by one.
3678
+ */
3679
+ 207: {
3680
+ status?: string;
3681
+ message?: string;
3682
+ data?: BulkResponse;
3683
+ };
3684
+ };
3685
+ export type MonitorActivateResponse = MonitorActivateResponses[keyof MonitorActivateResponses];
3686
+ export type MonitorDeactivateData = {
3687
+ body?: never;
3688
+ path?: never;
3689
+ query: {
3690
+ /**
3691
+ * List of monitors to deactivate. Format: Comma-separated monitor IDs or monitor names
3692
+ */
3693
+ monitor: Array<string>;
3694
+ };
3695
+ url: "/monitors/deactivate";
3696
+ };
3697
+ export type MonitorDeactivateErrors = {
3698
+ /**
3699
+ * Bad request
3700
+ */
3701
+ 400: unknown;
3702
+ /**
3703
+ * Not permitted
3704
+ */
3705
+ 403: unknown;
3706
+ /**
3707
+ * Not found
3708
+ */
3709
+ 404: unknown;
3710
+ };
3711
+ export type MonitorDeactivateResponses = {
3712
+ /**
3713
+ * A successful deactivation
3714
+ */
3715
+ 200: {
3716
+ responses?: Array<{
3717
+ id?: unknown;
3718
+ status?: number;
3719
+ resource?: unknown;
3720
+ message?: string;
3721
+ }>;
3722
+ metadata?: BulkResponseMetadata;
3723
+ };
3724
+ /**
3725
+ * Multiple results. If the results in the bulk response have a mix of different HTTP codes,
3726
+ *
3727
+ * the final HTTP code will be 207 Multi-status. In that case check the results carefully one by one.
3728
+ */
3729
+ 207: {
3730
+ status?: string;
3731
+ message?: string;
3732
+ data?: BulkResponse;
3733
+ };
3734
+ };
3735
+ export type MonitorDeactivateResponse = MonitorDeactivateResponses[keyof MonitorDeactivateResponses];
3736
+ export type OauthClientTokensListData = {
3737
+ body?: never;
3738
+ path?: never;
3739
+ query?: never;
3740
+ url: "/oauth2";
3741
+ };
3742
+ export type OauthClientTokensListErrors = {
3743
+ /**
3744
+ * Not permitted to access
3745
+ */
3746
+ 403: Forbidden;
3747
+ };
3748
+ export type OauthClientTokensListError = OauthClientTokensListErrors[keyof OauthClientTokensListErrors];
3749
+ export type OauthClientTokensListResponses = {
3750
+ /**
3751
+ * Success
3752
+ */
3753
+ 200: Array<OauthClientCredentialsItem>;
3754
+ };
3755
+ export type OauthClientTokensListResponse = OauthClientTokensListResponses[keyof OauthClientTokensListResponses];
3756
+ export type OauthClientTokensCreateData = {
3757
+ /**
3758
+ * The request body. Name is required, everything else is optional.
3759
+ */
3760
+ body: {
3761
+ name?: string;
3762
+ valid_until?: string;
3763
+ access_token_validity?: number;
3764
+ refresh_token_validity?: number;
3765
+ };
3766
+ path?: never;
3767
+ query?: never;
3768
+ url: "/oauth2";
3769
+ };
3770
+ export type OauthClientTokensCreateErrors = {
3771
+ /**
3772
+ * Not permitted to access
3773
+ */
3774
+ 403: Forbidden;
3775
+ };
3776
+ export type OauthClientTokensCreateError = OauthClientTokensCreateErrors[keyof OauthClientTokensCreateErrors];
3777
+ export type OauthClientTokensCreateResponses = {
3778
+ /**
3779
+ * Success
3780
+ */
3781
+ 201: {
3782
+ status?: string;
3783
+ data?: {
3784
+ id?: number;
3785
+ name?: string;
3786
+ client_id?: string;
3787
+ valid_until?: string;
3788
+ access_token_validity?: number;
3789
+ refresh_token_validity?: number;
3790
+ client_secret?: string;
3791
+ };
3792
+ };
3793
+ };
3794
+ export type OauthClientTokensCreateResponse = OauthClientTokensCreateResponses[keyof OauthClientTokensCreateResponses];
3795
+ export type OauthClientTokensDeleteData = {
3796
+ body?: never;
3797
+ path: {
3798
+ /**
3799
+ * The ID of the credentials to delete
3800
+ */
3801
+ id: number;
3802
+ };
3803
+ query?: never;
3804
+ url: "/oauth2/{id}";
3805
+ };
3806
+ export type OauthClientTokensDeleteErrors = {
3807
+ /**
3808
+ * Not permitted to access
3809
+ */
3810
+ 403: Forbidden;
3811
+ /**
3812
+ * Not found
3813
+ */
3814
+ 404: OauthClientCredentialsNotFound;
3815
+ };
3816
+ export type OauthClientTokensDeleteError = OauthClientTokensDeleteErrors[keyof OauthClientTokensDeleteErrors];
3817
+ export type OauthClientTokensDeleteResponses = {
3818
+ /**
3819
+ * Success
3820
+ */
3821
+ 200: {
3822
+ message?: string;
3823
+ };
3824
+ };
3825
+ export type OauthClientTokensDeleteResponse = OauthClientTokensDeleteResponses[keyof OauthClientTokensDeleteResponses];
3826
+ export type OauthClientTokensGetData = {
3827
+ body?: never;
3828
+ path: {
3829
+ /**
3830
+ * The ID of the credentials
3831
+ */
3832
+ id: number;
3833
+ };
3834
+ query?: never;
3835
+ url: "/oauth2/{id}";
3836
+ };
3837
+ export type OauthClientTokensGetErrors = {
3838
+ /**
3839
+ * Not permitted to access
3840
+ */
3841
+ 403: Forbidden;
3842
+ /**
3843
+ * Not found
3844
+ */
3845
+ 404: OauthClientCredentialsNotFound;
3846
+ };
3847
+ export type OauthClientTokensGetError = OauthClientTokensGetErrors[keyof OauthClientTokensGetErrors];
3848
+ export type OauthClientTokensGetResponses = {
3849
+ /**
3850
+ * Success
3851
+ */
3852
+ 200: OauthClientCredentialsItem;
3853
+ };
3854
+ export type OauthClientTokensGetResponse = OauthClientTokensGetResponses[keyof OauthClientTokensGetResponses];
3855
+ export type OauthClientTokensUpdateData = {
3856
+ /**
3857
+ * The request body. Name is required, everything else is optional.
3858
+ */
3859
+ body: {
3860
+ name?: string;
3861
+ valid_until?: string;
3862
+ access_token_validity?: number;
3863
+ refresh_token_validity?: number;
3864
+ };
3865
+ path: {
3866
+ /**
3867
+ * The ID of the credentials to update
3868
+ */
3869
+ id: number;
3870
+ };
3871
+ query?: never;
3872
+ url: "/oauth2/{id}";
3873
+ };
3874
+ export type OauthClientTokensUpdateErrors = {
3875
+ /**
3876
+ * Not permitted to access
3877
+ */
3878
+ 403: Forbidden;
3879
+ /**
3880
+ * Not found
3881
+ */
3882
+ 404: OauthClientCredentialsNotFound;
3883
+ };
3884
+ export type OauthClientTokensUpdateError = OauthClientTokensUpdateErrors[keyof OauthClientTokensUpdateErrors];
3885
+ export type OauthClientTokensUpdateResponses = {
3886
+ /**
3887
+ * Success
3888
+ */
3889
+ 200: {
3890
+ message?: string;
3891
+ data?: OauthClientCredentialsItem;
3892
+ };
3893
+ };
3894
+ export type OauthClientTokensUpdateResponse = OauthClientTokensUpdateResponses[keyof OauthClientTokensUpdateResponses];
3895
+ export type OauthTokenDeleteCurrentData = {
3896
+ body?: never;
3897
+ path?: never;
3898
+ query?: never;
3899
+ url: "/oauth2/token";
3900
+ };
3901
+ export type OauthTokenDeleteCurrentErrors = {
3902
+ /**
3903
+ * Bad request
3904
+ */
3905
+ 400: {
3906
+ error?: string;
3907
+ };
3908
+ };
3909
+ export type OauthTokenDeleteCurrentError = OauthTokenDeleteCurrentErrors[keyof OauthTokenDeleteCurrentErrors];
3910
+ export type OauthTokenDeleteCurrentResponses = {
3911
+ /**
3912
+ * Success
3913
+ */
3914
+ 200: unknown;
3915
+ };
3916
+ export type OauthGetTokenListData = {
3917
+ body?: never;
3918
+ path?: never;
3919
+ query?: {
3920
+ /**
3921
+ * Flag for including expired tokens. By default expired tokens are not returned.
3922
+ */
3923
+ expired?: boolean;
3924
+ };
3925
+ url: "/oauth2/token";
3926
+ };
3927
+ export type OauthGetTokenListErrors = {
3928
+ /**
3929
+ * Not permitted to access
3930
+ */
3931
+ 403: unknown;
3932
+ };
3933
+ export type OauthGetTokenListResponses = {
3934
+ /**
3935
+ * Success
3936
+ */
3937
+ 200: Array<OauthToken>;
3938
+ };
3939
+ export type OauthGetTokenListResponse = OauthGetTokenListResponses[keyof OauthGetTokenListResponses];
3940
+ export type OauthCreateTokenData = {
3941
+ body?: {
3942
+ /**
3943
+ * The grant type according to OAuth2 specification
3944
+ */
3945
+ grant_type: "authorization_code" | "client_credentials" | "refresh_token";
3946
+ /**
3947
+ * The client ID, required for client_credentials and authorization_code grants.
3948
+ */
3949
+ client_id?: string;
3950
+ /**
3951
+ * The client secret, required for client_credentials, optional for authorization_code.
3952
+ */
3953
+ client_secret?: string;
3954
+ /**
3955
+ * Refresh token user for refresh_token grant.
3956
+ */
3957
+ refresh_token?: string;
3958
+ /**
3959
+ * Authorization code used in authorization_code grant.
3960
+ */
3961
+ code?: string;
3962
+ /**
3963
+ * Redirect URI used in authorization_code grant.
3964
+ */
3965
+ redirect_uri?: string;
3966
+ };
3967
+ path?: never;
3968
+ query?: never;
3969
+ url: "/oauth2/token";
3970
+ };
3971
+ export type OauthCreateTokenErrors = {
3972
+ /**
3973
+ * Invalid data sent
3974
+ */
3975
+ 400: {
3976
+ /**
3977
+ * The error code
3978
+ */
3979
+ error?: string;
3980
+ /**
3981
+ * The error message
3982
+ */
3983
+ error_description?: string;
3984
+ };
3985
+ /**
3986
+ * Invalid credentials
3987
+ */
3988
+ 401: {
3989
+ /**
3990
+ * The error code
3991
+ */
3992
+ error?: string;
3993
+ /**
3994
+ * The error message
3995
+ */
3996
+ error_description?: string;
3997
+ };
3998
+ };
3999
+ export type OauthCreateTokenError = OauthCreateTokenErrors[keyof OauthCreateTokenErrors];
4000
+ export type OauthCreateTokenResponses = {
4001
+ /**
4002
+ * Success - refresh_token and client_credentials grants.
4003
+ */
4004
+ 200: {
4005
+ /**
4006
+ * The new access token
4007
+ */
4008
+ access_token?: string;
4009
+ /**
4010
+ * Always 'bearer'
4011
+ */
4012
+ token_type?: string;
4013
+ /**
4014
+ * The remaining time in seconds until access token expires
4015
+ */
4016
+ expires_in?: number;
4017
+ /**
4018
+ * A token that can be used to refresh the access token
4019
+ */
4020
+ refresh_token?: string;
4021
+ /**
4022
+ * The remaining time in seconds until refresh token expires
4023
+ */
4024
+ refresh_token_expires_in?: number;
4025
+ };
4026
+ };
4027
+ export type OauthCreateTokenResponse = OauthCreateTokenResponses[keyof OauthCreateTokenResponses];
4028
+ export type OauthGetRefreshTokenListData = {
4029
+ body?: never;
4030
+ path?: never;
4031
+ query?: {
4032
+ /**
4033
+ * Flag for including expired tokens. By default expired tokens are not returned.
4034
+ */
4035
+ expired?: boolean;
4036
+ };
4037
+ url: "/oauth2/refreshtoken";
4038
+ };
4039
+ export type OauthGetRefreshTokenListErrors = {
4040
+ /**
4041
+ * Not permitted to access
4042
+ */
4043
+ 403: unknown;
4044
+ };
4045
+ export type OauthGetRefreshTokenListResponses = {
4046
+ /**
4047
+ * Success
4048
+ */
4049
+ 200: Array<OauthToken>;
4050
+ };
4051
+ export type OauthGetRefreshTokenListResponse = OauthGetRefreshTokenListResponses[keyof OauthGetRefreshTokenListResponses];
4052
+ export type OauthTokenDeleteData = {
4053
+ body?: never;
4054
+ path: {
4055
+ /**
4056
+ * The access token or the ID of access token to invalidate
4057
+ */
4058
+ token: string | number;
4059
+ };
4060
+ query?: never;
4061
+ url: "/oauth2/token/{token}";
4062
+ };
4063
+ export type OauthTokenDeleteErrors = {
4064
+ /**
4065
+ * Bad request
4066
+ */
4067
+ 400: {
4068
+ error?: string;
4069
+ };
4070
+ };
4071
+ export type OauthTokenDeleteError = OauthTokenDeleteErrors[keyof OauthTokenDeleteErrors];
4072
+ export type OauthTokenDeleteResponses = {
4073
+ /**
4074
+ * Success
4075
+ */
4076
+ 200: unknown;
4077
+ };
4078
+ export type OauthRefreshTokenDeleteIdData = {
4079
+ body?: never;
4080
+ path: {
4081
+ id: number;
4082
+ };
4083
+ query?: never;
4084
+ url: "/oauth2/refreshtoken/{id}";
4085
+ };
4086
+ export type OauthRefreshTokenDeleteIdErrors = {
4087
+ /**
4088
+ * Bad request
4089
+ */
4090
+ 400: unknown;
4091
+ /**
4092
+ * Not found
4093
+ */
4094
+ 404: unknown;
4095
+ };
4096
+ export type OauthRefreshTokenDeleteIdResponses = {
4097
+ /**
4098
+ * Success
4099
+ */
4100
+ 200: unknown;
4101
+ };
4102
+ export type OauthTokenCognateDeleteCurrentData = {
4103
+ body?: never;
4104
+ path?: never;
4105
+ query?: never;
4106
+ url: "/oauth2/cognate-tokens";
4107
+ };
4108
+ export type OauthTokenCognateDeleteCurrentErrors = {
4109
+ /**
4110
+ * Bad request
4111
+ */
4112
+ 400: {
4113
+ error?: string;
4114
+ };
4115
+ };
4116
+ export type OauthTokenCognateDeleteCurrentError = OauthTokenCognateDeleteCurrentErrors[keyof OauthTokenCognateDeleteCurrentErrors];
4117
+ export type OauthTokenCognateDeleteCurrentResponses = {
4118
+ /**
4119
+ * Success
4120
+ */
4121
+ 200: unknown;
4122
+ };
4123
+ export type OauthTokenCognateDeleteData = {
4124
+ body?: never;
4125
+ path: {
4126
+ /**
4127
+ * The access token, if empty access token from current request is used
4128
+ */
4129
+ token: string;
4130
+ };
4131
+ query?: never;
4132
+ url: "/oauth2/cognate-tokens/{token}";
4133
+ };
4134
+ export type OauthTokenCognateDeleteErrors = {
4135
+ /**
4136
+ * Bad request
4137
+ */
4138
+ 400: {
4139
+ error?: string;
4140
+ };
4141
+ };
4142
+ export type OauthTokenCognateDeleteError = OauthTokenCognateDeleteErrors[keyof OauthTokenCognateDeleteErrors];
4143
+ export type OauthTokenCognateDeleteResponses = {
4144
+ /**
4145
+ * Success
4146
+ */
4147
+ 200: unknown;
4148
+ };
4149
+ export type SettingsGetData = {
4150
+ body?: never;
4151
+ path?: never;
4152
+ query?: never;
4153
+ url: "/settings";
4154
+ };
4155
+ export type SettingsGetErrors = {
4156
+ /**
4157
+ * Not permitted to access
4158
+ */
4159
+ 403: Forbidden;
4160
+ };
4161
+ export type SettingsGetError = SettingsGetErrors[keyof SettingsGetErrors];
4162
+ export type SettingsGetResponses = {
4163
+ /**
4164
+ * Success
4165
+ */
4166
+ 200: Array<SettingsItem>;
4167
+ };
4168
+ export type SettingsGetResponse = SettingsGetResponses[keyof SettingsGetResponses];
4169
+ export type SettingsGetDetailData = {
4170
+ body?: never;
4171
+ path: {
4172
+ /**
4173
+ * The setting name
4174
+ */
4175
+ name: string;
4176
+ };
4177
+ query?: never;
4178
+ url: "/settings/{name}";
4179
+ };
4180
+ export type SettingsGetDetailErrors = {
4181
+ /**
4182
+ * Invalid parameter name
4183
+ */
4184
+ 400: {
4185
+ message?: string;
4186
+ };
4187
+ /**
4188
+ * Not permitted to access
4189
+ */
4190
+ 403: Forbidden;
4191
+ };
4192
+ export type SettingsGetDetailError = SettingsGetDetailErrors[keyof SettingsGetDetailErrors];
4193
+ export type SettingsGetDetailResponses = {
4194
+ /**
4195
+ * Success
4196
+ */
4197
+ 200: SettingsItem;
4198
+ };
4199
+ export type SettingsGetDetailResponse = SettingsGetDetailResponses[keyof SettingsGetDetailResponses];
4200
+ export type SettingsUpdateData = {
4201
+ /**
4202
+ * The settings value
4203
+ */
4204
+ body?: unknown;
4205
+ path: {
4206
+ /**
4207
+ * The settigns name
4208
+ */
4209
+ name: string;
4210
+ };
4211
+ query?: never;
4212
+ url: "/settings/{name}";
4213
+ };
4214
+ export type SettingsUpdateErrors = {
4215
+ /**
4216
+ * Wrong parameter name or value was passed
4217
+ */
4218
+ 400: {
4219
+ message?: string;
4220
+ };
4221
+ /**
4222
+ * Insufficient permissions
4223
+ */
4224
+ 403: {
4225
+ message?: string;
4226
+ };
4227
+ };
4228
+ export type SettingsUpdateError = SettingsUpdateErrors[keyof SettingsUpdateErrors];
4229
+ export type SettingsUpdateResponses = {
4230
+ /**
4231
+ * Success
4232
+ */
4233
+ 204: void;
4234
+ };
4235
+ export type SettingsUpdateResponse = SettingsUpdateResponses[keyof SettingsUpdateResponses];
4236
+ export type StationsListData = {
4237
+ body?: never;
4238
+ path?: never;
4239
+ query?: never;
4240
+ url: "/stations";
4241
+ };
4242
+ export type StationsListErrors = {
4243
+ /**
4244
+ * Not permitted to access
4245
+ */
4246
+ 403: Forbidden;
4247
+ };
4248
+ export type StationsListError = StationsListErrors[keyof StationsListErrors];
4249
+ export type StationsListResponses = {
4250
+ /**
4251
+ * Success
4252
+ */
4253
+ 200: Array<StationItem>;
4254
+ };
4255
+ export type StationsListResponse = StationsListResponses[keyof StationsListResponses];
4256
+ export type StationsCreateData = {
4257
+ body?: StationItemCreate;
4258
+ path?: never;
4259
+ query?: never;
4260
+ url: "/stations";
4261
+ };
4262
+ export type StationsCreateErrors = {
4263
+ /**
4264
+ * Bad request
4265
+ */
4266
+ 400: {
4267
+ status?: string;
4268
+ message?: string;
4269
+ data?: {
4270
+ details?: string;
4271
+ };
4272
+ };
4273
+ /**
4274
+ * Not permitted to access
4275
+ */
4276
+ 403: Forbidden;
4277
+ };
4278
+ export type StationsCreateError = StationsCreateErrors[keyof StationsCreateErrors];
4279
+ export type StationsCreateResponses = {
4280
+ /**
4281
+ * Success
4282
+ */
4283
+ 201: StationItemDetail;
4284
+ };
4285
+ export type StationsCreateResponse = StationsCreateResponses[keyof StationsCreateResponses];
4286
+ export type StationDeleteData = {
4287
+ body?: never;
4288
+ path: {
4289
+ /**
4290
+ * Monitoring station id
4291
+ */
4292
+ id: number;
4293
+ };
4294
+ query?: never;
4295
+ url: "/stations/{id}";
4296
+ };
4297
+ export type StationDeleteErrors = {
4298
+ /**
4299
+ * Not permitted to access
4300
+ */
4301
+ 403: Forbidden;
4302
+ /**
4303
+ * Monitoring station not found or insufficient privileges
4304
+ */
4305
+ 404: {
4306
+ message?: string;
4307
+ };
4308
+ };
4309
+ export type StationDeleteError = StationDeleteErrors[keyof StationDeleteErrors];
4310
+ export type StationDeleteResponses = {
4311
+ /**
4312
+ * Success
4313
+ */
4314
+ 204: void;
4315
+ };
4316
+ export type StationDeleteResponse = StationDeleteResponses[keyof StationDeleteResponses];
4317
+ export type StationsGetData = {
4318
+ body?: never;
4319
+ path: {
4320
+ /**
4321
+ * The station ID
4322
+ */
4323
+ id: number;
4324
+ };
4325
+ query?: never;
4326
+ url: "/stations/{id}";
4327
+ };
4328
+ export type StationsGetErrors = {
4329
+ /**
4330
+ * Not permitted to access
4331
+ */
4332
+ 403: Forbidden;
4333
+ /**
4334
+ * Not found or not permitted to view
4335
+ */
4336
+ 404: {
4337
+ message?: string;
4338
+ };
4339
+ };
4340
+ export type StationsGetError = StationsGetErrors[keyof StationsGetErrors];
4341
+ export type StationsGetResponses = {
4342
+ /**
4343
+ * Success
4344
+ */
4345
+ 200: StationItemDetail;
4346
+ };
4347
+ export type StationsGetResponse = StationsGetResponses[keyof StationsGetResponses];
4348
+ export type StationsUpdateData = {
4349
+ body?: StationItemCreate;
4350
+ path: {
4351
+ /**
4352
+ * The ID of the station
4353
+ */
4354
+ id: number;
4355
+ };
4356
+ query?: never;
4357
+ url: "/stations/{id}";
4358
+ };
4359
+ export type StationsUpdateErrors = {
4360
+ /**
4361
+ * Bad request
4362
+ */
4363
+ 400: {
4364
+ status?: string;
4365
+ message?: string;
4366
+ data?: {
4367
+ details?: string;
4368
+ };
4369
+ };
4370
+ /**
4371
+ * Not permitted to access
4372
+ */
4373
+ 403: Forbidden;
4374
+ };
4375
+ export type StationsUpdateError = StationsUpdateErrors[keyof StationsUpdateErrors];
4376
+ export type StationsUpdateResponses = {
4377
+ /**
4378
+ * Success
4379
+ */
4380
+ 201: StationItemDetail;
4381
+ };
4382
+ export type StationsUpdateResponse = StationsUpdateResponses[keyof StationsUpdateResponses];
4383
+ export type StationsDeleteMaintenanceData = {
4384
+ body?: never;
4385
+ path: {
4386
+ /**
4387
+ * The ID of the station
4388
+ */
4389
+ id: number;
4390
+ };
4391
+ query?: never;
4392
+ url: "/stations/maintenance/{id}";
4393
+ };
4394
+ export type StationsDeleteMaintenanceErrors = {
4395
+ /**
4396
+ * Bad request
4397
+ */
4398
+ 400: {
4399
+ status?: string;
4400
+ message?: string;
4401
+ data?: {
4402
+ details?: string;
4403
+ };
4404
+ };
4405
+ /**
4406
+ * Not permitted to access
4407
+ */
4408
+ 403: Forbidden;
4409
+ };
4410
+ export type StationsDeleteMaintenanceError = StationsDeleteMaintenanceErrors[keyof StationsDeleteMaintenanceErrors];
4411
+ export type StationsDeleteMaintenanceResponses = {
4412
+ /**
4413
+ * Success
4414
+ */
4415
+ 204: void;
4416
+ };
4417
+ export type StationsDeleteMaintenanceResponse = StationsDeleteMaintenanceResponses[keyof StationsDeleteMaintenanceResponses];
4418
+ export type StationsPutMaintenanceData = {
4419
+ body?: never;
4420
+ path: {
4421
+ /**
4422
+ * The ID of the station
4423
+ */
4424
+ id: number;
4425
+ };
4426
+ query?: never;
4427
+ url: "/stations/maintenance/{id}";
4428
+ };
4429
+ export type StationsPutMaintenanceErrors = {
4430
+ /**
4431
+ * Bad request
4432
+ */
4433
+ 400: {
4434
+ status?: string;
4435
+ message?: string;
4436
+ data?: {
4437
+ details?: string;
4438
+ };
4439
+ };
4440
+ /**
4441
+ * Not permitted to access
4442
+ */
4443
+ 403: Forbidden;
4444
+ };
4445
+ export type StationsPutMaintenanceError = StationsPutMaintenanceErrors[keyof StationsPutMaintenanceErrors];
4446
+ export type StationsPutMaintenanceResponses = {
4447
+ /**
4448
+ * Success
4449
+ */
4450
+ 204: void;
4451
+ };
4452
+ export type StationsPutMaintenanceResponse = StationsPutMaintenanceResponses[keyof StationsPutMaintenanceResponses];
4453
+ export type StationsOnpremiseListData = {
4454
+ body?: never;
4455
+ path?: never;
4456
+ query?: never;
4457
+ url: "/stations/onpremise";
4458
+ };
4459
+ export type StationsOnpremiseListErrors = {
4460
+ /**
4461
+ * Not permitted to access
4462
+ */
4463
+ 403: Forbidden;
4464
+ };
4465
+ export type StationsOnpremiseListError = StationsOnpremiseListErrors[keyof StationsOnpremiseListErrors];
4466
+ export type StationsOnpremiseListResponses = {
4467
+ /**
4468
+ * Success
4469
+ */
4470
+ 200: Array<StationItem>;
4471
+ };
4472
+ export type StationsOnpremiseListResponse = StationsOnpremiseListResponses[keyof StationsOnpremiseListResponses];
4473
+ export type StationsOnpremiseConnectedData = {
4474
+ body?: never;
4475
+ path?: never;
4476
+ query?: never;
4477
+ url: "/stations/onpremise/connected";
4478
+ };
4479
+ export type StationsOnpremiseConnectedErrors = {
4480
+ /**
4481
+ * Not permitted to access
4482
+ */
4483
+ 403: Forbidden;
4484
+ };
4485
+ export type StationsOnpremiseConnectedError = StationsOnpremiseConnectedErrors[keyof StationsOnpremiseConnectedErrors];
4486
+ export type StationsOnpremiseConnectedResponses = {
4487
+ /**
4488
+ * Success
4489
+ */
4490
+ 200: Array<StationItem>;
4491
+ };
4492
+ export type StationsOnpremiseConnectedResponse = StationsOnpremiseConnectedResponses[keyof StationsOnpremiseConnectedResponses];
4493
+ export type StationsOnpremiseConnectedAllData = {
4494
+ body?: never;
4495
+ path?: never;
4496
+ query?: never;
4497
+ url: "/stations/onpremise/connected/all";
4498
+ };
4499
+ export type StationsOnpremiseConnectedAllErrors = {
4500
+ /**
4501
+ * Not permitted to access
4502
+ */
4503
+ 403: Forbidden;
4504
+ };
4505
+ export type StationsOnpremiseConnectedAllError = StationsOnpremiseConnectedAllErrors[keyof StationsOnpremiseConnectedAllErrors];
4506
+ export type StationsOnpremiseConnectedAllResponses = {
4507
+ /**
4508
+ * Success
4509
+ */
4510
+ 200: Array<StationItem>;
4511
+ };
4512
+ export type StationsOnpremiseConnectedAllResponse = StationsOnpremiseConnectedAllResponses[keyof StationsOnpremiseConnectedAllResponses];
4513
+ export type StationsLatestData = {
4514
+ body?: never;
4515
+ path?: never;
4516
+ query?: never;
4517
+ url: "/stations/latest";
4518
+ };
4519
+ export type StationsLatestResponses = {
4520
+ /**
4521
+ * Success
4522
+ */
4523
+ 200: Array<StationLatest>;
4524
+ };
4525
+ export type StationsLatestResponse = StationsLatestResponses[keyof StationsLatestResponses];
4526
+ export type StationsAgentTypeData = {
4527
+ body?: never;
4528
+ path: {
4529
+ /**
4530
+ * The new agent to use
4531
+ */
4532
+ agent: "ccagent" | "cbot";
4533
+ /**
4534
+ * The ID of the station
4535
+ */
4536
+ id: number;
4537
+ };
4538
+ query?: never;
4539
+ url: "/stations/{agent}/{id}";
4540
+ };
4541
+ export type StationsAgentTypeErrors = {
4542
+ /**
4543
+ * Not permitted to access
4544
+ */
4545
+ 403: Forbidden;
4546
+ /**
4547
+ * Not found or not permitted to view
4548
+ */
4549
+ 404: {
4550
+ message?: string;
4551
+ };
4552
+ };
4553
+ export type StationsAgentTypeError = StationsAgentTypeErrors[keyof StationsAgentTypeErrors];
4554
+ export type StationsAgentTypeResponses = {
4555
+ /**
4556
+ * Success
4557
+ */
4558
+ 204: void;
4559
+ };
4560
+ export type StationsAgentTypeResponse = StationsAgentTypeResponses[keyof StationsAgentTypeResponses];
4561
+ export type StationsGetAgentsData = {
4562
+ body?: never;
4563
+ path: {
4564
+ /**
4565
+ * The ID of the station
4566
+ */
4567
+ id: number;
4568
+ };
4569
+ query?: never;
4570
+ url: "/stations/agents/{id}";
4571
+ };
4572
+ export type StationsGetAgentsErrors = {
4573
+ /**
4574
+ * Not permitted to access
4575
+ */
4576
+ 403: Forbidden;
4577
+ /**
4578
+ * Not found or not permitted to view
4579
+ */
4580
+ 404: {
4581
+ message?: string;
4582
+ };
4583
+ };
4584
+ export type StationsGetAgentsError = StationsGetAgentsErrors[keyof StationsGetAgentsErrors];
4585
+ export type StationsGetAgentsResponses = {
4586
+ /**
4587
+ * Success
4588
+ */
4589
+ 200: Array<StationAgent>;
4590
+ };
4591
+ export type StationsGetAgentsResponse = StationsGetAgentsResponses[keyof StationsGetAgentsResponses];
4592
+ export type StatisticData = {
4593
+ body?: never;
4594
+ path?: never;
4595
+ query: {
4596
+ /**
4597
+ * List of monitors to query. If both 'monitors' and 'folders' are omitted,
4598
+ * query all monitors. Format: Monitor name (string) or monitor ID (integer).
4599
+ */
4600
+ monitor?: Array<string>;
4601
+ /**
4602
+ * List of folders to query. If both 'monitors' and 'folders' are omitted,
4603
+ * query all monitors. Format: Folder name (string) or folder ID (integer).
4604
+ */
4605
+ folder?: Array<string>;
4606
+ /**
4607
+ * List of locations to filter by. Format: Location name (string) or location ID (integer).
4608
+ */
4609
+ location?: Array<string>;
4610
+ /**
4611
+ * Start of interval. Format: ISO 8601 date and time.
4612
+ */
4613
+ from: string;
4614
+ /**
4615
+ * End of interval. Format: ISO 8601 date and time. Default is the current time.
4616
+ */
4617
+ to?: string;
4618
+ /**
4619
+ * Return a time series with a given period between data points. Format: ISO 8601 duration. If omitted, return a single value.
4620
+ */
4621
+ period?: string;
4622
+ /**
4623
+ * Group results by monitor or location.
4624
+ */
4625
+ groupBy?: "monitor" | "location";
4626
+ /**
4627
+ * List of metrics to return. If omitted, return all metrics.
4628
+ */
4629
+ metric?: Array<string>;
4630
+ };
4631
+ url: "/statistic";
4632
+ };
4633
+ export type StatisticErrors = {
4634
+ /**
4635
+ * Bad request.
4636
+ */
4637
+ 400: unknown;
4638
+ /**
4639
+ * Not permitted to access
4640
+ */
4641
+ 403: Forbidden;
4642
+ };
4643
+ export type StatisticError = StatisticErrors[keyof StatisticErrors];
4644
+ export type StatisticResponses = {
4645
+ /**
4646
+ * Success
4647
+ */
4648
+ 200: Array<StatisticItem>;
4649
+ };
4650
+ export type StatisticResponse = StatisticResponses[keyof StatisticResponses];
4651
+ export type TagsGetAllData = {
4652
+ body?: never;
4653
+ path?: never;
4654
+ query?: never;
4655
+ url: "/tags";
4656
+ };
4657
+ export type TagsGetAllErrors = {
4658
+ /**
4659
+ * Access to the resource was denied.
4660
+ */
4661
+ 403: {
4662
+ message?: string;
4663
+ };
4664
+ };
4665
+ export type TagsGetAllError = TagsGetAllErrors[keyof TagsGetAllErrors];
4666
+ export type TagsGetAllResponses = {
4667
+ /**
4668
+ * Success
4669
+ */
4670
+ 200: Array<MonitorTag>;
4671
+ };
4672
+ export type TagsGetAllResponse = TagsGetAllResponses[keyof TagsGetAllResponses];
4673
+ export type TimezonesListData = {
4674
+ body?: never;
4675
+ path?: never;
4676
+ query?: never;
4677
+ url: "/timezones";
4678
+ };
4679
+ export type TimezonesListErrors = {
4680
+ /**
4681
+ * Access to the resource was denied.
4682
+ */
4683
+ 403: {
4684
+ message?: string;
4685
+ };
4686
+ };
4687
+ export type TimezonesListError = TimezonesListErrors[keyof TimezonesListErrors];
4688
+ export type TimezonesListResponses = {
4689
+ /**
4690
+ * Success
4691
+ */
4692
+ 200: Array<TimezoneItem>;
4693
+ };
4694
+ export type TimezonesListResponse = TimezonesListResponses[keyof TimezonesListResponses];
4695
+ export type UserGetData = {
4696
+ body?: never;
4697
+ path?: never;
4698
+ query?: never;
4699
+ url: "/user";
4700
+ };
4701
+ export type UserGetErrors = {
4702
+ /**
4703
+ * Not permitted to access
4704
+ */
4705
+ 403: Forbidden;
4706
+ };
4707
+ export type UserGetError = UserGetErrors[keyof UserGetErrors];
4708
+ export type UserGetResponses = {
4709
+ /**
4710
+ * Success
4711
+ */
4712
+ 200: User;
4713
+ };
4714
+ export type UserGetResponse = UserGetResponses[keyof UserGetResponses];
4715
+ export type UserSubaccountsGetData = {
4716
+ body?: never;
4717
+ path?: never;
4718
+ query?: never;
4719
+ url: "/user/subaccounts";
4720
+ };
4721
+ export type UserSubaccountsGetErrors = {
4722
+ /**
4723
+ * Not permitted to access
4724
+ */
4725
+ 403: Forbidden;
4726
+ };
4727
+ export type UserSubaccountsGetError = UserSubaccountsGetErrors[keyof UserSubaccountsGetErrors];
4728
+ export type UserSubaccountsGetResponses = {
4729
+ /**
4730
+ * Success
4731
+ */
4732
+ 200: Array<User>;
4733
+ };
4734
+ export type UserSubaccountsGetResponse = UserSubaccountsGetResponses[keyof UserSubaccountsGetResponses];
4735
+ export type UserSubaccountsPostData = {
4736
+ /**
4737
+ * User data
4738
+ */
4739
+ body: UserCreate;
4740
+ path?: never;
4741
+ query?: never;
4742
+ url: "/user/subaccounts";
4743
+ };
4744
+ export type UserSubaccountsPostErrors = {
4745
+ /**
4746
+ * Bad request
4747
+ */
4748
+ 400: {
4749
+ message?: string;
4750
+ };
4751
+ /**
4752
+ * Not permitted to access
4753
+ */
4754
+ 403: Forbidden;
4755
+ };
4756
+ export type UserSubaccountsPostError = UserSubaccountsPostErrors[keyof UserSubaccountsPostErrors];
4757
+ export type UserSubaccountsPostResponses = {
4758
+ /**
4759
+ * Success
4760
+ */
4761
+ 201: User;
4762
+ };
4763
+ export type UserSubaccountsPostResponse = UserSubaccountsPostResponses[keyof UserSubaccountsPostResponses];
4764
+ export type UserBlockDeleteData = {
4765
+ body?: never;
4766
+ path: {
4767
+ /**
4768
+ * ID of the account to unblock
4769
+ */
4770
+ id: number;
4771
+ };
4772
+ query?: never;
4773
+ url: "/user/block/{id}";
4774
+ };
4775
+ export type UserBlockDeleteErrors = {
4776
+ /**
4777
+ * Bad request
4778
+ */
4779
+ 400: {
4780
+ message?: string;
4781
+ };
4782
+ /**
4783
+ * Not permitted to access
4784
+ */
4785
+ 403: Forbidden;
4786
+ };
4787
+ export type UserBlockDeleteError = UserBlockDeleteErrors[keyof UserBlockDeleteErrors];
4788
+ export type UserBlockDeleteResponses = {
4789
+ /**
4790
+ * Success
4791
+ */
4792
+ 200: unknown;
4793
+ /**
4794
+ * Not needed - account not blocked
4795
+ */
4796
+ 204: void;
4797
+ };
4798
+ export type UserBlockDeleteResponse = UserBlockDeleteResponses[keyof UserBlockDeleteResponses];
4799
+ export type UserBlockPutData = {
4800
+ body?: never;
4801
+ path: {
4802
+ /**
4803
+ * ID of the account to block
4804
+ */
4805
+ id: number;
4806
+ };
4807
+ query?: never;
4808
+ url: "/user/block/{id}";
4809
+ };
4810
+ export type UserBlockPutErrors = {
4811
+ /**
4812
+ * Bad request
4813
+ */
4814
+ 400: {
4815
+ message?: string;
4816
+ };
4817
+ /**
4818
+ * Not permitted to access
4819
+ */
4820
+ 403: Forbidden;
4821
+ };
4822
+ export type UserBlockPutError = UserBlockPutErrors[keyof UserBlockPutErrors];
4823
+ export type UserBlockPutResponses = {
4824
+ /**
4825
+ * Success
4826
+ */
4827
+ 200: unknown;
4828
+ /**
4829
+ * Not needed - account already blocked
4830
+ */
4831
+ 204: void;
4832
+ };
4833
+ export type UserBlockPutResponse = UserBlockPutResponses[keyof UserBlockPutResponses];
4834
+ export type UserLockDeleteData = {
4835
+ body?: never;
4836
+ path: {
4837
+ /**
4838
+ * ID of the account to unlock
4839
+ */
4840
+ id: number;
4841
+ };
4842
+ query?: never;
4843
+ url: "/user/lock/{id}";
4844
+ };
4845
+ export type UserLockDeleteErrors = {
4846
+ /**
4847
+ * Bad request
4848
+ */
4849
+ 400: {
4850
+ message?: string;
4851
+ };
4852
+ /**
4853
+ * Not permitted to access
4854
+ */
4855
+ 403: Forbidden;
4856
+ };
4857
+ export type UserLockDeleteError = UserLockDeleteErrors[keyof UserLockDeleteErrors];
4858
+ export type UserLockDeleteResponses = {
4859
+ /**
4860
+ * Success
4861
+ */
4862
+ 200: unknown;
4863
+ /**
4864
+ * Not needed - account not locked
4865
+ */
4866
+ 204: void;
4867
+ };
4868
+ export type UserLockDeleteResponse = UserLockDeleteResponses[keyof UserLockDeleteResponses];
4869
+ export type UserDeleteData = {
4870
+ body?: never;
4871
+ path: {
4872
+ /**
4873
+ * ID of the account to remove
4874
+ */
4875
+ id: number;
4876
+ };
4877
+ query?: never;
4878
+ url: "/user/{id}";
4879
+ };
4880
+ export type UserDeleteErrors = {
4881
+ /**
4882
+ * Bad request
4883
+ */
4884
+ 400: {
4885
+ message?: string;
4886
+ };
4887
+ /**
4888
+ * Not permitted to access
4889
+ */
4890
+ 403: Forbidden;
4891
+ };
4892
+ export type UserDeleteError = UserDeleteErrors[keyof UserDeleteErrors];
4893
+ export type UserDeleteResponses = {
4894
+ /**
4895
+ * Success
4896
+ */
4897
+ 204: void;
4898
+ };
4899
+ export type UserDeleteResponse = UserDeleteResponses[keyof UserDeleteResponses];
4900
+ export type UserPutData = {
4901
+ /**
4902
+ * User data
4903
+ */
4904
+ body: UserCreate;
4905
+ path: {
4906
+ /**
4907
+ * The ID of the account
4908
+ */
4909
+ id: number;
4910
+ };
4911
+ query?: never;
4912
+ url: "/user/{id}";
4913
+ };
4914
+ export type UserPutErrors = {
4915
+ /**
4916
+ * Bad request
4917
+ */
4918
+ 400: {
4919
+ message?: string;
4920
+ };
4921
+ /**
4922
+ * Not permitted to access
4923
+ */
4924
+ 403: Forbidden;
4925
+ };
4926
+ export type UserPutError = UserPutErrors[keyof UserPutErrors];
4927
+ export type UserPutResponses = {
4928
+ /**
4929
+ * Success
4930
+ */
4931
+ 201: User;
4932
+ };
4933
+ export type UserPutResponse = UserPutResponses[keyof UserPutResponses];
4934
+ //# sourceMappingURL=types.gen.d.ts.map