@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.3.2

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 (226) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.md +3741 -960
  3. package/cjs/index.js +12427 -7375
  4. package/dynatrace-metadata.json +2 -2
  5. package/esm/index.js +12629 -7397
  6. package/package.json +3 -2
  7. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +28 -4
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +34 -4
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +27 -6
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +36 -0
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +12 -2
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +61 -7
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +34 -4
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +12 -2
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +12 -2
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +7 -1
  17. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +35 -5
  18. package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +6 -1
  19. package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +46 -8
  20. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +158 -26
  21. package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +1 -0
  22. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +25 -5
  23. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +30 -4
  24. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +18 -3
  25. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +42 -7
  26. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +18 -3
  27. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +42 -1
  28. package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +46 -7
  29. package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +45 -5
  30. package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +6 -1
  31. package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +114 -18
  32. package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +42 -4
  33. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +6 -1
  34. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +62 -10
  35. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +12 -2
  36. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +6 -1
  37. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +103 -16
  38. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +28 -3
  39. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +54 -5
  40. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts +2 -0
  41. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/biz-event-ingest-result-error.d.ts +1 -1
  42. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-envelope-error.d.ts +1 -1
  43. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +6 -8
  44. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-array-error.d.ts +1 -1
  45. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-error.d.ts +1 -1
  46. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/validation-response-error.d.ts +1 -1
  47. package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.d.ts +14 -0
  48. package/types/packages/client/classic-environment-v2/src/lib/models/abstract-slo-alert-dto.d.ts +6 -0
  49. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-config.d.ts +10 -0
  50. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-global-auto-update-config.d.ts +8 -0
  51. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.d.ts +9 -0
  52. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.transformation.d.ts +6 -0
  53. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.d.ts +10 -0
  54. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.transformation.d.ts +7 -0
  55. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +6 -0
  56. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create.d.ts +3 -0
  57. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts +3 -0
  58. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts +3 -0
  59. package/types/packages/client/classic-environment-v2/src/lib/models/active-gate.d.ts +21 -0
  60. package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.d.ts +6 -0
  61. package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log.d.ts +3 -0
  62. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.d.ts +2 -3
  63. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.transformation.d.ts +3 -3
  64. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -5
  65. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -5
  66. package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +6 -0
  67. package/types/packages/client/classic-environment-v2/src/lib/models/applied-filter.d.ts +3 -0
  68. package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +6 -0
  69. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint-payload-item.d.ts +3 -0
  70. package/types/packages/client/classic-environment-v2/src/lib/models/attack-entrypoint.d.ts +6 -0
  71. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem-assessment-dto.d.ts +6 -0
  72. package/types/packages/client/classic-environment-v2/src/lib/models/attack-security-problem.d.ts +3 -0
  73. package/types/packages/client/classic-environment-v2/src/lib/models/attack.d.ts +30 -0
  74. package/types/packages/client/classic-environment-v2/src/lib/models/attacker.d.ts +3 -0
  75. package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts +25 -0
  76. package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.d.ts +18 -0
  77. package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.transformation.d.ts +9 -0
  78. package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.d.ts +14 -0
  79. package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.transformation.d.ts +8 -0
  80. package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details.d.ts +6 -0
  81. package/types/packages/client/classic-environment-v2/src/lib/models/code-location.d.ts +3 -0
  82. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +3 -0
  83. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +3 -0
  84. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-type.d.ts +3 -0
  85. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element.d.ts +9 -0
  86. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-type.d.ts +6 -0
  87. package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +16 -0
  88. package/types/packages/client/classic-environment-v2/src/lib/models/credentials.transformation.d.ts +6 -0
  89. package/types/packages/client/classic-environment-v2/src/lib/models/custom-device-creation.d.ts +3 -0
  90. package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-allowed-location-dto.d.ts +1 -1
  91. package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +1 -1
  92. package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +3 -0
  93. package/types/packages/client/classic-environment-v2/src/lib/models/davis-security-advice.d.ts +6 -0
  94. package/types/packages/client/classic-environment-v2/src/lib/models/entity-stub.d.ts +3 -0
  95. package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +12 -0
  96. package/types/packages/client/classic-environment-v2/src/lib/models/entry-point-usage-segment.d.ts +6 -0
  97. package/types/packages/client/classic-environment-v2/src/lib/models/entrypoint-payload.d.ts +3 -0
  98. package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +3 -0
  99. package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +3 -0
  100. package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-result.d.ts +3 -0
  101. package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest.d.ts +14 -0
  102. package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +3 -0
  103. package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +6 -0
  104. package/types/packages/client/classic-environment-v2/src/lib/models/evidence.d.ts +15 -0
  105. package/types/packages/client/classic-environment-v2/src/lib/models/execute-actions-dto.d.ts +3 -0
  106. package/types/packages/client/classic-environment-v2/src/lib/models/execution-simple-results.d.ts +2 -0
  107. package/types/packages/client/classic-environment-v2/src/lib/models/execution-step.d.ts +6 -0
  108. package/types/packages/client/classic-environment-v2/src/lib/models/extension-event-dto.d.ts +3 -0
  109. package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration.d.ts +3 -0
  110. package/types/packages/client/classic-environment-v2/src/lib/models/extension-status-dto.d.ts +3 -0
  111. package/types/packages/client/classic-environment-v2/src/lib/models/extension-upload-response-dto.d.ts +6 -0
  112. package/types/packages/client/classic-environment-v2/src/lib/models/extension.d.ts +6 -0
  113. package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts +9 -0
  114. package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +9 -0
  115. package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +26 -0
  116. package/types/packages/client/classic-environment-v2/src/lib/models/function-definition.d.ts +3 -0
  117. package/types/packages/client/classic-environment-v2/src/lib/models/http-protocol-details.d.ts +6 -0
  118. package/types/packages/client/classic-environment-v2/src/lib/models/identity-type.d.ts +8 -0
  119. package/types/packages/client/classic-environment-v2/src/lib/models/identity-type.transformation.d.ts +4 -0
  120. package/types/packages/client/classic-environment-v2/src/lib/models/identity.d.ts +14 -0
  121. package/types/packages/client/classic-environment-v2/src/lib/models/identity.transformation.d.ts +8 -0
  122. package/types/packages/client/classic-environment-v2/src/lib/models/impact.d.ts +11 -0
  123. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +14 -0
  124. package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +9 -0
  125. package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts +4 -1
  126. package/types/packages/client/classic-environment-v2/src/lib/models/location-collection-element.d.ts +14 -0
  127. package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +9 -0
  128. package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +3 -0
  129. package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +17 -0
  130. package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-definition.d.ts +3 -0
  131. package/types/packages/client/classic-environment-v2/src/lib/models/metric-dto.d.ts +3 -0
  132. package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.d.ts +4 -0
  133. package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.transformation.d.ts +1 -0
  134. package/types/packages/client/classic-environment-v2/src/lib/models/metric-query-dql-translation.d.ts +3 -0
  135. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +3 -0
  136. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -0
  137. package/types/packages/client/classic-environment-v2/src/lib/models/metric-value-type.d.ts +3 -0
  138. package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +6 -0
  139. package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-dto.d.ts +3 -0
  140. package/types/packages/client/classic-environment-v2/src/lib/models/monitoring-configuration-update-dto.d.ts +3 -0
  141. package/types/packages/client/classic-environment-v2/src/lib/models/mute-state.d.ts +3 -0
  142. package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +3 -0
  143. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +6 -0
  144. package/types/packages/client/classic-environment-v2/src/lib/models/problem-close-result.d.ts +3 -0
  145. package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +24 -0
  146. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +18 -0
  147. package/types/packages/client/classic-environment-v2/src/lib/models/protocol-details.d.ts +3 -0
  148. package/types/packages/client/classic-environment-v2/src/lib/models/related-service.d.ts +3 -0
  149. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-assessment.d.ts +15 -0
  150. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-details-item.d.ts +12 -0
  151. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state-change.d.ts +3 -0
  152. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-mute-state.d.ts +3 -0
  153. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts +3 -0
  154. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item.d.ts +12 -0
  155. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts +3 -0
  156. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts +3 -0
  157. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-update-delete-dto.d.ts +7 -0
  158. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity-assessment.d.ts +3 -0
  159. package/types/packages/client/classic-environment-v2/src/lib/models/remediation-progress-entity.d.ts +6 -0
  160. package/types/packages/client/classic-environment-v2/src/lib/models/request-information.d.ts +3 -0
  161. package/types/packages/client/classic-environment-v2/src/lib/models/resource-context.d.ts +3 -0
  162. package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +6 -0
  163. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-changes.d.ts +9 -0
  164. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-details.d.ts +26 -0
  165. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment-snapshot.d.ts +17 -0
  166. package/types/packages/client/classic-environment-v2/src/lib/models/risk-assessment.d.ts +26 -0
  167. package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.d.ts +3 -0
  168. package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +20 -0
  169. package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +6 -0
  170. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts +3 -0
  171. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +39 -0
  172. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-event.d.ts +9 -0
  173. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts +3 -0
  174. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts +3 -0
  175. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts +18 -0
  176. package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts +3 -0
  177. package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts +3 -0
  178. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.d.ts +8 -0
  179. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-by-object-id-response.transformation.d.ts +2 -0
  180. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +13 -0
  181. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.transformation.d.ts +2 -0
  182. package/types/packages/client/classic-environment-v2/src/lib/models/single-permission-request.d.ts +3 -0
  183. package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +5 -0
  184. package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +14 -0
  185. package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +23 -0
  186. package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.d.ts +30 -0
  187. package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.transformation.d.ts +12 -0
  188. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location-update.d.ts +6 -0
  189. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.d.ts +15 -1
  190. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.transformation.d.ts +1 -1
  191. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts +3 -0
  192. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-constraint-dto.d.ts +3 -0
  193. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +6 -0
  194. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-step-dto.d.ts +6 -0
  195. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +9 -0
  196. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-batch-status.d.ts +6 -0
  197. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +6 -0
  198. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request.d.ts +9 -0
  199. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +21 -0
  200. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status.d.ts +3 -0
  201. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto.d.ts +3 -0
  202. package/types/packages/client/classic-environment-v2/src/lib/models/tenant-token-config.d.ts +6 -0
  203. package/types/packages/client/classic-environment-v2/src/lib/models/token-credentials.d.ts +3 -0
  204. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.d.ts +3 -0
  205. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.d.ts +3 -0
  206. package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.d.ts +3 -0
  207. package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +12 -0
  208. package/types/packages/client/classic-environment-v2/src/lib/models/ui-table-customization.d.ts +3 -0
  209. package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +12 -0
  210. package/types/packages/client/classic-environment-v2/src/lib/models/user-password-credentials.d.ts +3 -0
  211. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerability.d.ts +9 -0
  212. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment.d.ts +3 -0
  213. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input.d.ts +3 -0
  214. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups.d.ts +9 -0
  215. package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts +1 -1
  216. package/types/packages/http-client/src/lib/types/binary.d.ts +2 -2
  217. package/types/packages/http-client/src/lib/types/http-client-response.d.ts +2 -2
  218. package/types/packages/shared-errors/src/api-client-error.d.ts +23 -0
  219. package/types/packages/shared-errors/src/api-gateway-error.d.ts +37 -0
  220. package/types/packages/shared-errors/src/client-request-error.d.ts +39 -0
  221. package/types/packages/shared-errors/src/index.d.ts +5 -0
  222. package/types/packages/shared-errors/src/invalid-response-error.d.ts +26 -0
  223. package/types/packages/shared-errors/src/types.d.ts +88 -0
  224. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-client-error.d.ts +0 -11
  225. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/client-request-error.d.ts +0 -9
  226. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/invalid-response-error.d.ts +0 -9
@@ -31,7 +31,7 @@ export declare class SettingsObjectsClient {
31
31
  * + environment:roles:viewer
32
32
  * + settings:schemas:read
33
33
  *
34
- * @returns Success
34
+ * @returns {Promise<EffectivePermission[]>} Success
35
35
  *
36
36
  * @example <caption>Code example</caption>
37
37
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -40,6 +40,11 @@ export declare class SettingsObjectsClient {
40
40
  * await settingsObjectsClient.resolveEffectivePermissions({
41
41
  * body: {},
42
42
  * });
43
+ *
44
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. No access to any settings. | Client side error. | Server side error.
45
+ * @throws {InvalidResponseError}
46
+ * @throws {ApiClientError}
47
+ * @throws {ClientRequestError}
43
48
  */
44
49
  resolveEffectivePermissions(config: {
45
50
  body: ResolutionRequest;
@@ -58,13 +63,18 @@ export declare class SettingsObjectsClient {
58
63
  *
59
64
  * If no object along the hierarchy is persisted, the default value as defined in the schema will be returned.
60
65
  *
61
- * @returns Success
66
+ * @returns {Promise<EffectiveSettingsValuesList>} Success
62
67
  *
63
68
  * @example <caption>Code example</caption>
64
69
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
65
70
  *
66
71
  * const data =
67
72
  * await settingsObjectsClient.getEffectiveSettingsValues();
73
+ *
74
+ * @throws {ErrorEnvelopeError} Failed. The specified schema or scope is not found. | Client side error. | Server side error.
75
+ * @throws {InvalidResponseError}
76
+ * @throws {ApiClientError}
77
+ * @throws {ClientRequestError}
68
78
  */
69
79
  getEffectiveSettingsValues(config?: {
70
80
  /**
@@ -109,13 +119,18 @@ export declare class SettingsObjectsClient {
109
119
  * + environment:roles:manage-settings
110
120
  * + settings:objects:read
111
121
  *
112
- * @returns Success
122
+ * @returns {Promise<RevisionDiffPage>} Success
113
123
  *
114
124
  * @example <caption>Code example</caption>
115
125
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
116
126
  *
117
127
  * const data =
118
128
  * await settingsObjectsClient.getSettingsHistory();
129
+ *
130
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.
131
+ * @throws {InvalidResponseError}
132
+ * @throws {ApiClientError}
133
+ * @throws {ClientRequestError}
119
134
  */
120
135
  getSettingsHistory(config?: {
121
136
  /** Schema ID to which the requested revisions belong. */ schemaId?: string;
@@ -126,8 +141,17 @@ export declare class SettingsObjectsClient {
126
141
  *
127
142
  * To load the first page, when the **nextPageKey** is not set, this parameter is required.
128
143
  */ scope?: string;
129
- /** The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering). Filtering is supported on the following fields: * `objectId` * `modificationInfo.lastModifiedTime`, and the fields can only be combined with `and` as a boolean operator. If this parameter is omitted or does not include a range for **modificationInfo.lastModifiedTime**, only revisions of the last 2 weeks are returned. (optional) */ filter?: string;
130
- /** The sort parameter, as explained [here](https://dt-url.net/platform-services-filtering). Sorting is supported on the following fields: * `modificationInfo.lastModifiedTime` (optional, default to -modificationInfo.lastModifiedTime) */ sort?: string;
144
+ /**
145
+ * The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering). Filtering is supported on the following fields:
146
+ * * `objectId`
147
+ * * `modificationInfo.lastModifiedTime`
148
+ *
149
+ * The fields can only be combined with `and` as a boolean operator. If this parameter is omitted or does not include a range for **modificationInfo.lastModifiedTime**, only revisions of the last 2 weeks are returned. (optional)
150
+ */ filter?: string;
151
+ /**
152
+ * The sort parameter, as explained [here](https://dt-url.net/platform-services-filtering). Sorting is supported on the following fields:
153
+ * * `modificationInfo.lastModifiedTime` (optional, default to -modificationInfo.lastModifiedTime)
154
+ */ sort?: string;
131
155
  /** A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, **revision,modificationInfo**). Supported fields: **revision**, **jsonPatch**, **jsonBefore**, **jsonAfter**, **objectId**, **type**, **schemaVersion**, **modificationInfo**.(optional, default to revision, modificationInfo) */ fields?: string;
132
156
  /**
133
157
  * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
@@ -158,13 +182,18 @@ export declare class SettingsObjectsClient {
158
182
  *
159
183
  * To query the effective values (including schema defaults) please see [/settings/effectiveValues](#/Settings%20-%20Objects/getEffectiveSettingsValues).
160
184
  *
161
- * @returns Success. Accessible objects returned.
185
+ * @returns {Promise<ObjectsList>} Success. Accessible objects returned.
162
186
  *
163
187
  * @example <caption>Code example</caption>
164
188
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
165
189
  *
166
190
  * const data =
167
191
  * await settingsObjectsClient.getSettingsObjects();
192
+ *
193
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | Failed. The specified schema or scope is not found. | Client side error. | Server side error.
194
+ * @throws {InvalidResponseError}
195
+ * @throws {ApiClientError}
196
+ * @throws {ClientRequestError}
168
197
  */
169
198
  getSettingsObjects(config?: {
170
199
  /**
@@ -195,7 +224,7 @@ export declare class SettingsObjectsClient {
195
224
  *
196
225
  * Specify the required top-level fields, separated by commas (for example, `objectId,value`).
197
226
  *
198
- * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo` (deprecated), `resourceContext`, `schemaId`, `schemaVersion`, `value`, `externalId`.
227
+ * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo` (deprecated), `resourceContext`, `owner`, `schemaId`, `schemaVersion`, `value`, `externalId`.
199
228
  */ fields?: string;
200
229
  /**
201
230
  * The filter parameter, as explained [here](https://dt-url.net/platform-services-filtering).
@@ -250,7 +279,7 @@ export declare class SettingsObjectsClient {
250
279
  *
251
280
  * <br/><br/>You can upload several objects at once. In that case each object returns its own response code. Check the response body for details.
252
281
  *
253
- * @returns Success | Multi-status: different objects in the payload resulted in different statuses.
282
+ * @returns {Promise<SettingsObjectResponse[]>} Success | Multi-status: different objects in the payload resulted in different statuses.
254
283
  *
255
284
  * @example <caption>Code example</caption>
256
285
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -266,6 +295,12 @@ export declare class SettingsObjectsClient {
266
295
  * },
267
296
  * ],
268
297
  * });
298
+ *
299
+ * @throws {SettingsObjectResponseArrayError} Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
300
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | Client side error. | Server side error.
301
+ * @throws {InvalidResponseError}
302
+ * @throws {ApiClientError}
303
+ * @throws {ClientRequestError}
269
304
  */
270
305
  postSettingsObjects(config: {
271
306
  body: SettingsObjectCreate[];
@@ -279,7 +314,7 @@ export declare class SettingsObjectsClient {
279
314
  * + environment:roles:manage-settings
280
315
  * + settings:objects:read
281
316
  *
282
- * @returns Success
317
+ * @returns {Promise<SettingsObjectByObjectIdResponse>} Success
283
318
  *
284
319
  * @example <caption>Code example</caption>
285
320
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -288,6 +323,11 @@ export declare class SettingsObjectsClient {
288
323
  * await settingsObjectsClient.getSettingsObjectByObjectId({
289
324
  * objectId: "...",
290
325
  * });
326
+ *
327
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.
328
+ * @throws {InvalidResponseError}
329
+ * @throws {ApiClientError}
330
+ * @throws {ClientRequestError}
291
331
  */
292
332
  getSettingsObjectByObjectId(config: {
293
333
  /** The ID of the required settings object. */ objectId: string;
@@ -304,7 +344,7 @@ export declare class SettingsObjectsClient {
304
344
  *
305
345
  * Some schemas don't allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.
306
346
  *
307
- * @returns Success
347
+ * @returns {Promise<SettingsObjectResponse>} Success
308
348
  *
309
349
  * @example <caption>Code example</caption>
310
350
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -314,6 +354,12 @@ export declare class SettingsObjectsClient {
314
354
  * objectId: "...",
315
355
  * body: { value: {} },
316
356
  * });
357
+ *
358
+ * @throws {SettingsObjectResponseError} Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
359
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | Client side error. | Server side error.
360
+ * @throws {InvalidResponseError}
361
+ * @throws {ApiClientError}
362
+ * @throws {ClientRequestError}
317
363
  */
318
364
  putSettingsObjectByObjectId(config: {
319
365
  body: SettingsObjectUpdate;
@@ -335,6 +381,12 @@ export declare class SettingsObjectsClient {
335
381
  * await settingsObjectsClient.deleteSettingsObjectByObjectId(
336
382
  * { objectId: "..." },
337
383
  * );
384
+ *
385
+ * @throws {SettingsObjectResponseError} Failed. Schema validation failed. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.
386
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | Client side error. | Server side error.
387
+ * @throws {InvalidResponseError}
388
+ * @throws {ApiClientError}
389
+ * @throws {ClientRequestError}
338
390
  */
339
391
  deleteSettingsObjectByObjectId(config: {
340
392
  /** The ID of the required settings object. */ objectId: string;
@@ -19,13 +19,18 @@ export declare class SettingsSchemasClient {
19
19
  * + environment:roles:manage-settings
20
20
  * + settings:schemas:read
21
21
  *
22
- * @returns Success
22
+ * @returns {Promise<SchemaList>} Success
23
23
  *
24
24
  * @example <caption>Code example</caption>
25
25
  * import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
26
26
  *
27
27
  * const data =
28
28
  * await settingsSchemasClient.getAvailableSchemaDefinitions();
29
+ *
30
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
31
+ * @throws {InvalidResponseError}
32
+ * @throws {ApiClientError}
33
+ * @throws {ClientRequestError}
29
34
  */
30
35
  getAvailableSchemaDefinitions(config?: {
31
36
  /**
@@ -44,7 +49,7 @@ export declare class SettingsSchemasClient {
44
49
  * + environment:roles:manage-settings
45
50
  * + settings:schemas:read
46
51
  *
47
- * @returns Success
52
+ * @returns {Promise<SchemaDefinitionRestDto>} Success
48
53
  *
49
54
  * @example <caption>Code example</caption>
50
55
  * import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -53,6 +58,11 @@ export declare class SettingsSchemasClient {
53
58
  * await settingsSchemasClient.getSchemaDefinition({
54
59
  * schemaId: "...",
55
60
  * });
61
+ *
62
+ * @throws {ErrorEnvelopeError} Failed. Forbidden. | Failed. The specified schema doesn't exist. | Client side error. | Server side error.
63
+ * @throws {InvalidResponseError}
64
+ * @throws {ApiClientError}
65
+ * @throws {ClientRequestError}
56
66
  */
57
67
  getSchemaDefinition(config: {
58
68
  /** The ID of the required schema. */ schemaId: string;
@@ -14,7 +14,7 @@ export declare class SyntheticHttpMonitorExecutionsClient {
14
14
  *
15
15
  * **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
16
16
  *
17
- * @returns Success. The response contains detailed data.
17
+ * @returns {Promise<MonitorExecutionResults>} Success. The response contains detailed data.
18
18
  *
19
19
  * @example <caption>Code example</caption>
20
20
  * import { syntheticHttpMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -26,6 +26,11 @@ export declare class SyntheticHttpMonitorExecutionsClient {
26
26
  * resultType: GetExecutionResultPathResultType.Success,
27
27
  * },
28
28
  * );
29
+ *
30
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
31
+ * @throws {InvalidResponseError}
32
+ * @throws {ApiClientError}
33
+ * @throws {ClientRequestError}
29
34
  */
30
35
  getExecutionResult(config: {
31
36
  /** Identifier of the HTTP monitor for which last execution result is returned. */ monitorId: string;
@@ -24,21 +24,28 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
24
24
  *
25
25
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
26
26
  *
27
- * @returns Success. The response contains synthetic related parameters defined for whole tenant.
27
+ * @returns {Promise<SyntheticConfigDto>} Success. The response contains synthetic related parameters defined for whole tenant.
28
28
  *
29
29
  * @example <caption>Code example</caption>
30
30
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
31
31
  *
32
32
  * const data =
33
33
  * await syntheticLocationsNodesAndConfigurationClient.getConfiguration();
34
+ *
35
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
36
+ * @throws {InvalidResponseError}
37
+ * @throws {ApiClientError}
38
+ * @throws {ClientRequestError}
34
39
  */
35
- getConfiguration(abortSignal?: AbortSignal): Promise<SyntheticConfigDto>;
40
+ getConfiguration(config?: {
41
+ abortSignal?: AbortSignal;
42
+ } | AbortSignal): Promise<SyntheticConfigDto>;
36
43
  /**
37
44
  * Updates set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
38
45
  *
39
46
  * **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
40
47
  *
41
- * @returns Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
48
+ * @returns {Promise<SyntheticConfigDto>} Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
42
49
  *
43
50
  * @example <caption>Code example</caption>
44
51
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -47,6 +54,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
47
54
  * await syntheticLocationsNodesAndConfigurationClient.updateConfiguration(
48
55
  * { body: { bmMonitorTimeout: 10, bmStepTimeout: 10 } },
49
56
  * );
57
+ *
58
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
59
+ * @throws {InvalidResponseError}
60
+ * @throws {ApiClientError}
61
+ * @throws {ClientRequestError}
50
62
  */
51
63
  updateConfiguration(config: {
52
64
  body: SyntheticConfigDto;
@@ -57,13 +69,18 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
57
69
  *
58
70
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
59
71
  *
60
- * @returns Success
72
+ * @returns {Promise<SyntheticLocations>} Success
61
73
  *
62
74
  * @example <caption>Code example</caption>
63
75
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
64
76
  *
65
77
  * const data =
66
78
  * await syntheticLocationsNodesAndConfigurationClient.getLocations();
79
+ *
80
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
81
+ * @throws {InvalidResponseError}
82
+ * @throws {ApiClientError}
83
+ * @throws {ClientRequestError}
67
84
  */
68
85
  getLocations(config?: {
69
86
  /** Filters the resulting set of locations to those which are hosted on a specific cloud platform. */ cloudPlatform?: GetLocationsQueryCloudPlatform;
@@ -76,15 +93,28 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
76
93
  *
77
94
  * **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
78
95
  *
79
- * @returns Success. The private location has been created. The response contains the ID of the new location.
96
+ * @returns {Promise<SyntheticLocationIdsDto>} Success. The private location has been created. The response contains the ID of the new location.
80
97
  *
81
98
  * @example <caption>Code example</caption>
82
99
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
83
100
  *
84
101
  * const data =
85
102
  * await syntheticLocationsNodesAndConfigurationClient.addLocation(
86
- * { body: {} },
103
+ * {
104
+ * body: {
105
+ * latitude: 10,
106
+ * longitude: 10,
107
+ * name: "...",
108
+ * type: SyntheticLocationType.Cluster,
109
+ * nodes: ["..."],
110
+ * },
111
+ * },
87
112
  * );
113
+ *
114
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
115
+ * @throws {InvalidResponseError}
116
+ * @throws {ApiClientError}
117
+ * @throws {ClientRequestError}
88
118
  */
89
119
  addLocation(config: {
90
120
  body: PrivateSyntheticLocation;
@@ -95,13 +125,18 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
95
125
  *
96
126
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
97
127
  *
98
- * @returns Success. The response contains the list of commands that needs to be executed to deploy a synthetic location.
128
+ * @returns {Promise<void>} Success. The response contains the list of commands that needs to be executed to deploy a synthetic location.
99
129
  *
100
130
  * @example <caption>Code example</caption>
101
131
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
102
132
  *
103
133
  * const data =
104
134
  * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands();
135
+ *
136
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
137
+ * @throws {InvalidResponseError}
138
+ * @throws {ApiClientError}
139
+ * @throws {ClientRequestError}
105
140
  */
106
141
  getLocationDeploymentApplyCommands(config?: {
107
142
  /** Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. */ platform?: string;
@@ -114,15 +149,22 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
114
149
  *
115
150
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
116
151
  *
117
- * @returns Success. The response contains the public locations status.
152
+ * @returns {Promise<SyntheticPublicLocationsStatus>} Success. The response contains the public locations status.
118
153
  *
119
154
  * @example <caption>Code example</caption>
120
155
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
121
156
  *
122
157
  * const data =
123
158
  * await syntheticLocationsNodesAndConfigurationClient.getLocationsStatus();
159
+ *
160
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
161
+ * @throws {InvalidResponseError}
162
+ * @throws {ApiClientError}
163
+ * @throws {ClientRequestError}
124
164
  */
125
- getLocationsStatus(abortSignal?: AbortSignal): Promise<SyntheticPublicLocationsStatus>;
165
+ getLocationsStatus(config?: {
166
+ abortSignal?: AbortSignal;
167
+ } | AbortSignal): Promise<SyntheticPublicLocationsStatus>;
126
168
  /**
127
169
  * Changes the status of public synthetic locations
128
170
  *
@@ -135,6 +177,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
135
177
  * await syntheticLocationsNodesAndConfigurationClient.updateLocationsStatus(
136
178
  * { body: { publicLocationsEnabled: false } },
137
179
  * );
180
+ *
181
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
182
+ * @throws {InvalidResponseError}
183
+ * @throws {ApiClientError}
184
+ * @throws {ClientRequestError}
138
185
  */
139
186
  updateLocationsStatus(config: {
140
187
  body: SyntheticPublicLocationsStatus;
@@ -145,7 +192,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
145
192
  *
146
193
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
147
194
  *
148
- * @returns Success. The response contains parameters of the synthetic location.
195
+ * @returns {Promise<SyntheticLocation>} Success. The response contains parameters of the synthetic location.
149
196
  *
150
197
  * @example <caption>Code example</caption>
151
198
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -154,6 +201,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
154
201
  * await syntheticLocationsNodesAndConfigurationClient.getLocation(
155
202
  * { locationId: "..." },
156
203
  * );
204
+ *
205
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
206
+ * @throws {InvalidResponseError}
207
+ * @throws {ApiClientError}
208
+ * @throws {ClientRequestError}
157
209
  */
158
210
  getLocation(config: {
159
211
  /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -169,8 +221,16 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
169
221
  *
170
222
  * const data =
171
223
  * await syntheticLocationsNodesAndConfigurationClient.updateLocation(
172
- * { locationId: "...", body: {} },
224
+ * {
225
+ * locationId: "...",
226
+ * body: { type: SyntheticLocationUpdateType.Private },
227
+ * },
173
228
  * );
229
+ *
230
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
231
+ * @throws {InvalidResponseError}
232
+ * @throws {ApiClientError}
233
+ * @throws {ClientRequestError}
174
234
  */
175
235
  updateLocation(config: {
176
236
  body: SyntheticLocationUpdate;
@@ -189,6 +249,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
189
249
  * await syntheticLocationsNodesAndConfigurationClient.removeLocation(
190
250
  * { locationId: "..." },
191
251
  * );
252
+ *
253
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
254
+ * @throws {InvalidResponseError}
255
+ * @throws {ApiClientError}
256
+ * @throws {ClientRequestError}
192
257
  */
193
258
  removeLocation(config: {
194
259
  /** The Dynatrace entity ID of the private synthetic location to be deleted. */ locationId: string;
@@ -199,7 +264,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
199
264
  *
200
265
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
201
266
  *
202
- * @returns Success. The response contains the list of commands that needs to be executed to delete a synthetic location.
267
+ * @returns {Promise<void>} Success. The response contains the list of commands that needs to be executed to delete a synthetic location.
203
268
  *
204
269
  * @example <caption>Code example</caption>
205
270
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -208,6 +273,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
208
273
  * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(
209
274
  * { locationId: "..." },
210
275
  * );
276
+ *
277
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
278
+ * @throws {InvalidResponseError}
279
+ * @throws {ApiClientError}
280
+ * @throws {ClientRequestError}
211
281
  */
212
282
  getLocationDeploymentDeleteCommands(config: {
213
283
  /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -221,7 +291,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
221
291
  *
222
292
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
223
293
  *
224
- * @returns Success. The response contains the content of deployment yaml file.
294
+ * @returns {Promise<void>} Success. The response contains the content of deployment yaml file.
225
295
  *
226
296
  * @example <caption>Code example</caption>
227
297
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -230,6 +300,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
230
300
  * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(
231
301
  * { locationId: "..." },
232
302
  * );
303
+ *
304
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
305
+ * @throws {InvalidResponseError}
306
+ * @throws {ApiClientError}
307
+ * @throws {ClientRequestError}
233
308
  */
234
309
  getLocationDeploymentYaml(config: {
235
310
  /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -246,21 +321,28 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
246
321
  *
247
322
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
248
323
  *
249
- * @returns Success
324
+ * @returns {Promise<Nodes>} Success
250
325
  *
251
326
  * @example <caption>Code example</caption>
252
327
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
253
328
  *
254
329
  * const data =
255
330
  * await syntheticLocationsNodesAndConfigurationClient.getNodes();
331
+ *
332
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
333
+ * @throws {InvalidResponseError}
334
+ * @throws {ApiClientError}
335
+ * @throws {ClientRequestError}
256
336
  */
257
- getNodes(abortSignal?: AbortSignal): Promise<Nodes>;
337
+ getNodes(config?: {
338
+ abortSignal?: AbortSignal;
339
+ } | AbortSignal): Promise<Nodes>;
258
340
  /**
259
341
  * Lists properties of the specified synthetic node
260
342
  *
261
343
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
262
344
  *
263
- * @returns Success
345
+ * @returns {Promise<Node>} Success
264
346
  *
265
347
  * @example <caption>Code example</caption>
266
348
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -269,6 +351,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
269
351
  * await syntheticLocationsNodesAndConfigurationClient.getNode(
270
352
  * { nodeId: "..." },
271
353
  * );
354
+ *
355
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
356
+ * @throws {InvalidResponseError}
357
+ * @throws {ApiClientError}
358
+ * @throws {ClientRequestError}
272
359
  */
273
360
  getNode(config: {
274
361
  /** The ID of the required synthetic node. */ nodeId: string;
@@ -19,13 +19,18 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
19
19
  *
20
20
  * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
21
21
  *
22
- * @returns Success
22
+ * @returns {Promise<SyntheticMonitorListDto>} Success
23
23
  *
24
24
  * @example <caption>Code example</caption>
25
25
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
26
26
  *
27
27
  * const data =
28
28
  * await syntheticNetworkAvailabilityMonitorsClient.getMonitors();
29
+ *
30
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
31
+ * @throws {InvalidResponseError}
32
+ * @throws {ApiClientError}
33
+ * @throws {ClientRequestError}
29
34
  */
30
35
  getMonitors(config?: {
31
36
  /**
@@ -49,7 +54,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
49
54
  *
50
55
  * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
51
56
  *
52
- * @returns Success
57
+ * @returns {Promise<MonitorEntityIdDto>} Success
53
58
  *
54
59
  * @example <caption>Code example</caption>
55
60
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -58,6 +63,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
58
63
  * await syntheticNetworkAvailabilityMonitorsClient.createMonitor(
59
64
  * {},
60
65
  * );
66
+ *
67
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
68
+ * @throws {InvalidResponseError}
69
+ * @throws {ApiClientError}
70
+ * @throws {ClientRequestError}
61
71
  */
62
72
  createMonitor(config: {
63
73
  body: SyntheticMultiProtocolMonitorUpdateDto;
@@ -68,7 +78,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
68
78
  *
69
79
  * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
70
80
  *
71
- * @returns Success
81
+ * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
72
82
  *
73
83
  * @example <caption>Code example</caption>
74
84
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -77,6 +87,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
77
87
  * await syntheticNetworkAvailabilityMonitorsClient.getMonitor(
78
88
  * { monitorId: "..." },
79
89
  * );
90
+ *
91
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
92
+ * @throws {InvalidResponseError}
93
+ * @throws {ApiClientError}
94
+ * @throws {ClientRequestError}
80
95
  */
81
96
  getMonitor(config: {
82
97
  /** The identifier of the monitor. */ monitorId: string;
@@ -94,6 +109,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
94
109
  * await syntheticNetworkAvailabilityMonitorsClient.updateMonitor(
95
110
  * { monitorId: "..." },
96
111
  * );
112
+ *
113
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
114
+ * @throws {InvalidResponseError}
115
+ * @throws {ApiClientError}
116
+ * @throws {ClientRequestError}
97
117
  */
98
118
  updateMonitor(config: {
99
119
  body: SyntheticMultiProtocolMonitorUpdateDto;
@@ -112,6 +132,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
112
132
  * await syntheticNetworkAvailabilityMonitorsClient.deleteMonitor(
113
133
  * { monitorId: "..." },
114
134
  * );
135
+ *
136
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
137
+ * @throws {InvalidResponseError}
138
+ * @throws {ApiClientError}
139
+ * @throws {ClientRequestError}
115
140
  */
116
141
  deleteMonitor(config: {
117
142
  /** The identifier of the monitor. */ monitorId: string;