@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
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "3.0.0",
3
+ "version": "3.3.2",
4
4
  "description": "Client for the Dynatrace Environment API v2",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
7
7
  "@dynatrace-sdk/error-handlers": "^1.2.0",
8
- "@dynatrace-sdk/http-client": "^1.0.10"
8
+ "@dynatrace-sdk/http-client": "^1.0.10",
9
+ "@dynatrace-sdk/shared-errors": "^1.0.0"
9
10
  },
10
11
  "main": "./cjs/index.js",
11
12
  "module": "./esm/index.js",
@@ -21,13 +21,18 @@ export declare class AccessTokensActiveGateTokensClient {
21
21
  * 1. Specify the number of results per page in the **pageSize** query parameter.
22
22
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
23
23
  *
24
- * @returns Success. The response contains the list of ActiveGate tokens.
24
+ * @returns {Promise<ActiveGateTokenList>} Success. The response contains the list of ActiveGate tokens.
25
25
  *
26
26
  * @example <caption>Code example</caption>
27
27
  * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
28
28
  *
29
29
  * const data =
30
30
  * await accessTokensActiveGateTokensClient.listTokens();
31
+ *
32
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.
33
+ * @throws {InvalidResponseError}
34
+ * @throws {ApiClientError}
35
+ * @throws {ClientRequestError}
31
36
  */
32
37
  listTokens(config?: {
33
38
  /**
@@ -55,15 +60,24 @@ export declare class AccessTokensActiveGateTokensClient {
55
60
  *
56
61
  * <br/>**Required permission:** environment:roles:manage-settings<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
57
62
  *
58
- * @returns Success. The token has been created. The body of the response contains the token secret.
63
+ * @returns {Promise<ActiveGateTokenCreated>} Success. The token has been created. The body of the response contains the token secret.
59
64
  *
60
65
  * @example <caption>Code example</caption>
61
66
  * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
62
67
  *
63
68
  * const data =
64
69
  * await accessTokensActiveGateTokensClient.createToken({
65
- * body: { name: "myToken" },
70
+ * body: {
71
+ * activeGateType:
72
+ * ActiveGateTokenCreateActiveGateType.Environment,
73
+ * name: "myToken",
74
+ * },
66
75
  * });
76
+ *
77
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
78
+ * @throws {InvalidResponseError}
79
+ * @throws {ApiClientError}
80
+ * @throws {ClientRequestError}
67
81
  */
68
82
  createToken(config: {
69
83
  body: ActiveGateTokenCreate;
@@ -74,7 +88,7 @@ export declare class AccessTokensActiveGateTokensClient {
74
88
  *
75
89
  * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The token secret is **not** exposed.
76
90
  *
77
- * @returns Success. The response contains the metadata of the tokens.
91
+ * @returns {Promise<ActiveGateToken>} Success. The response contains the metadata of the tokens.
78
92
  *
79
93
  * @example <caption>Code example</caption>
80
94
  * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -83,6 +97,11 @@ export declare class AccessTokensActiveGateTokensClient {
83
97
  * await accessTokensActiveGateTokensClient.getToken({
84
98
  * activeGateTokenIdentifier: "...",
85
99
  * });
100
+ *
101
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.
102
+ * @throws {InvalidResponseError}
103
+ * @throws {ApiClientError}
104
+ * @throws {ClientRequestError}
86
105
  */
87
106
  getToken(config: {
88
107
  /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token. */ activeGateTokenIdentifier: string;
@@ -100,6 +119,11 @@ export declare class AccessTokensActiveGateTokensClient {
100
119
  * await accessTokensActiveGateTokensClient.revokeToken({
101
120
  * activeGateTokenIdentifier: "...",
102
121
  * });
122
+ *
123
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.
124
+ * @throws {InvalidResponseError}
125
+ * @throws {ApiClientError}
126
+ * @throws {ClientRequestError}
103
127
  */
104
128
  revokeToken(config: {
105
129
  /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token to be deleted. */ activeGateTokenIdentifier: string;
@@ -23,13 +23,18 @@ export declare class AccessTokensApiTokensClient {
23
23
  * 1. Specify the number of results per page in the **pageSize** query parameter.
24
24
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
25
25
  *
26
- * @returns Success
26
+ * @returns {Promise<ApiTokenList>} Success
27
27
  *
28
28
  * @example <caption>Code example</caption>
29
29
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
30
30
  *
31
31
  * const data =
32
32
  * await accessTokensApiTokensClient.listApiTokens();
33
+ *
34
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
35
+ * @throws {InvalidResponseError}
36
+ * @throws {ApiClientError}
37
+ * @throws {ClientRequestError}
33
38
  */
34
39
  listApiTokens(config?: {
35
40
  /**
@@ -147,7 +152,7 @@ export declare class AccessTokensApiTokensClient {
147
152
  *
148
153
  * Creating personal access tokens requires the `environment:roles:viewer` permission. Creating access tokens requires the `environment:roles:manage-settings` permission.
149
154
  *
150
- * @returns Success. The token has been created. The body of the response contains the token secret.
155
+ * @returns {Promise<ApiTokenCreated>} Success. The token has been created. The body of the response contains the token secret.
151
156
  *
152
157
  * @example <caption>Code example</caption>
153
158
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -156,6 +161,11 @@ export declare class AccessTokensApiTokensClient {
156
161
  * await accessTokensApiTokensClient.createApiToken({
157
162
  * body: { name: "tokenName", scopes: ["metrics.read"] },
158
163
  * });
164
+ *
165
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
166
+ * @throws {InvalidResponseError}
167
+ * @throws {ApiClientError}
168
+ * @throws {ClientRequestError}
159
169
  */
160
170
  createApiToken(config: {
161
171
  body: ApiTokenCreate;
@@ -166,7 +176,7 @@ export declare class AccessTokensApiTokensClient {
166
176
  *
167
177
  * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer
168
178
  *
169
- * @returns Success
179
+ * @returns {Promise<ApiToken>} Success
170
180
  *
171
181
  * @example <caption>Code example</caption>
172
182
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -178,6 +188,11 @@ export declare class AccessTokensApiTokensClient {
178
188
  * "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM",
179
189
  * },
180
190
  * });
191
+ *
192
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
193
+ * @throws {InvalidResponseError}
194
+ * @throws {ApiClientError}
195
+ * @throws {ClientRequestError}
181
196
  */
182
197
  lookupApiToken(config: {
183
198
  body: ApiTokenSecret;
@@ -188,7 +203,7 @@ export declare class AccessTokensApiTokensClient {
188
203
  *
189
204
  * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The token secret is **not** exposed.
190
205
  *
191
- * @returns Success
206
+ * @returns {Promise<ApiToken>} Success
192
207
  *
193
208
  * @example <caption>Code example</caption>
194
209
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -196,6 +211,11 @@ export declare class AccessTokensApiTokensClient {
196
211
  * const data = await accessTokensApiTokensClient.getApiToken({
197
212
  * id: "...",
198
213
  * });
214
+ *
215
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
216
+ * @throws {InvalidResponseError}
217
+ * @throws {ApiClientError}
218
+ * @throws {ClientRequestError}
199
219
  */
200
220
  getApiToken(config: {
201
221
  id: string;
@@ -214,6 +234,11 @@ export declare class AccessTokensApiTokensClient {
214
234
  * id: "...",
215
235
  * body: {},
216
236
  * });
237
+ *
238
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
239
+ * @throws {InvalidResponseError}
240
+ * @throws {ApiClientError}
241
+ * @throws {ClientRequestError}
217
242
  */
218
243
  updateApiToken(config: {
219
244
  body: ApiTokenUpdate;
@@ -236,6 +261,11 @@ export declare class AccessTokensApiTokensClient {
236
261
  * await accessTokensApiTokensClient.deleteApiToken({
237
262
  * id: "...",
238
263
  * });
264
+ *
265
+ * @throws {ErrorEnvelopeError} Failed. You can't delete the token you're using for authentication of the request. | Client side error. | Server side error.
266
+ * @throws {InvalidResponseError}
267
+ * @throws {ApiClientError}
268
+ * @throws {ClientRequestError}
239
269
  */
240
270
  deleteApiToken(config: {
241
271
  /**
@@ -16,42 +16,63 @@ export declare class AccessTokensTenantTokensClient {
16
16
  *
17
17
  * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
18
18
  *
19
- * @returns Success. Rotation process has been cancelled. The current tenant token remains valid.
19
+ * @returns {Promise<TenantTokenConfig>} Success. Rotation process has been cancelled. The current tenant token remains valid.
20
20
  *
21
21
  * @example <caption>Code example</caption>
22
22
  * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
23
23
  *
24
24
  * const data =
25
25
  * await accessTokensTenantTokensClient.cancelRotation();
26
+ *
27
+ * @throws {ErrorEnvelopeError} Failed. There is no ongoing rotation process. | Client side error. | Server side error.
28
+ * @throws {InvalidResponseError}
29
+ * @throws {ApiClientError}
30
+ * @throws {ClientRequestError}
26
31
  */
27
- cancelRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
32
+ cancelRotation(config?: {
33
+ abortSignal?: AbortSignal;
34
+ } | AbortSignal): Promise<TenantTokenConfig>;
28
35
  /**
29
36
  * Finishes tenant token rotation
30
37
  *
31
38
  * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
32
39
  *
33
- * @returns Success. The rotation process is completed. The **active** field of the response contains the new tenant token.
40
+ * @returns {Promise<TenantTokenConfig>} Success. The rotation process is completed. The **active** field of the response contains the new tenant token.
34
41
  *
35
42
  * @example <caption>Code example</caption>
36
43
  * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
37
44
  *
38
45
  * const data =
39
46
  * await accessTokensTenantTokensClient.finishRotation();
47
+ *
48
+ * @throws {ErrorEnvelopeError} No ongoing rotation process. | Client side error. | Server side error.
49
+ * @throws {InvalidResponseError}
50
+ * @throws {ApiClientError}
51
+ * @throws {ClientRequestError}
40
52
  */
41
- finishRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
53
+ finishRotation(config?: {
54
+ abortSignal?: AbortSignal;
55
+ } | AbortSignal): Promise<TenantTokenConfig>;
42
56
  /**
43
57
  * Starts tenant token rotation
44
58
  *
45
59
  * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
46
60
  *
47
- * @returns Success. The new tenant token is created and will replace the old one. The **active** field of the response contains the new tenant token.
61
+ * @returns {Promise<TenantTokenConfig>} Success. The new tenant token is created and will replace the old one. The **active** field of the response contains the new tenant token.
48
62
  *
49
63
  * @example <caption>Code example</caption>
50
64
  * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
51
65
  *
52
66
  * const data =
53
67
  * await accessTokensTenantTokensClient.startRotation();
68
+ *
69
+ * @throws {ErrorEnvelopeError} Failed. Another rotation process is already in progress. | Client side error. | Server side error.
70
+ * @throws {InvalidResponseError}
71
+ * @throws {ApiClientError}
72
+ * @throws {ClientRequestError}
54
73
  */
55
- startRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
74
+ startRotation(config?: {
75
+ abortSignal?: AbortSignal;
76
+ } | AbortSignal): Promise<TenantTokenConfig>;
56
77
  }
57
78
  export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;
@@ -0,0 +1,36 @@
1
+ import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
2
+ import { ActiveGateGroups } from '../models/active-gate-groups';
3
+ /**
4
+ * View information about ActiveGate groups
5
+ */
6
+ export declare class ActiveGatesActiveGateGroupsClient {
7
+ private httpClient;
8
+ /**
9
+ * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ActiveGatesActiveGateGroupsClient. Custom http client should implement {HttpClient} interface.
10
+ * @example
11
+ * const activeGatesActiveGateGroupsClientNodeJs = new ActiveGatesActiveGateGroupsClient(yourCustomImplementation);
12
+ */
13
+ constructor(httpClientImplementation: HttpClient);
14
+ /**
15
+ * Lists ActiveGate groups
16
+ *
17
+ * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
18
+ *
19
+ * @returns {Promise<ActiveGateGroups>} Success
20
+ *
21
+ * @example <caption>Code example</caption>
22
+ * import { activeGatesActiveGateGroupsClient } from "@dynatrace-sdk/client-classic-environment-v2";
23
+ *
24
+ * const data =
25
+ * await activeGatesActiveGateGroupsClient.getActiveGateGroups();
26
+ *
27
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
28
+ * @throws {InvalidResponseError}
29
+ * @throws {ApiClientError}
30
+ * @throws {ClientRequestError}
31
+ */
32
+ getActiveGateGroups(config?: {
33
+ abortSignal?: AbortSignal;
34
+ } | AbortSignal): Promise<ActiveGateGroups>;
35
+ }
36
+ export declare const activeGatesActiveGateGroupsClient: ActiveGatesActiveGateGroupsClient;
@@ -26,12 +26,17 @@ export declare class ActiveGatesClient {
26
26
  *
27
27
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
28
28
  *
29
- * @returns Success
29
+ * @returns {Promise<ActiveGateList>} Success
30
30
  *
31
31
  * @example <caption>Code example</caption>
32
32
  * import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
33
33
  *
34
34
  * const data = await activeGatesClient.getAllActiveGates();
35
+ *
36
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
37
+ * @throws {InvalidResponseError}
38
+ * @throws {ApiClientError}
39
+ * @throws {ClientRequestError}
35
40
  */
36
41
  getAllActiveGates(config?: {
37
42
  /**
@@ -87,7 +92,7 @@ export declare class ActiveGatesClient {
87
92
  *
88
93
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
89
94
  *
90
- * @returns Success
95
+ * @returns {Promise<ActiveGate>} Success
91
96
  *
92
97
  * @example <caption>Code example</caption>
93
98
  * import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -95,6 +100,11 @@ export declare class ActiveGatesClient {
95
100
  * const data = await activeGatesClient.getOneActiveGateById({
96
101
  * agId: "...",
97
102
  * });
103
+ *
104
+ * @throws {ErrorEnvelopeError} Not found. See response body for details. | Client side error. | Server side error.
105
+ * @throws {InvalidResponseError}
106
+ * @throws {ApiClientError}
107
+ * @throws {ClientRequestError}
98
108
  */
99
109
  getOneActiveGateById(config: {
100
110
  /** The ID of the required ActiveGate. */ agId: string;
@@ -17,15 +17,22 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
17
17
  *
18
18
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
19
19
  *
20
- * @returns Success
20
+ * @returns {Promise<ActiveGateGlobalAutoUpdateConfig>} Success
21
21
  *
22
22
  * @example <caption>Code example</caption>
23
23
  * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
24
24
  *
25
25
  * const data =
26
26
  * await activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant();
27
+ *
28
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
29
+ * @throws {InvalidResponseError}
30
+ * @throws {ApiClientError}
31
+ * @throws {ClientRequestError}
27
32
  */
28
- getGlobalAutoUpdateConfigForTenant(abortSignal?: AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
33
+ getGlobalAutoUpdateConfigForTenant(config?: {
34
+ abortSignal?: AbortSignal;
35
+ } | AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
29
36
  /**
30
37
  * Puts the global auto-update configuration of environment ActiveGates.
31
38
  *
@@ -36,8 +43,18 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
36
43
  *
37
44
  * const data =
38
45
  * await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
39
- * { body: {} },
46
+ * {
47
+ * body: {
48
+ * globalSetting:
49
+ * ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
50
+ * },
51
+ * },
40
52
  * );
53
+ *
54
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
55
+ * @throws {InvalidResponseError}
56
+ * @throws {ApiClientError}
57
+ * @throws {ClientRequestError}
41
58
  */
42
59
  putGlobalAutoUpdateConfigForTenant(config: {
43
60
  body: ActiveGateGlobalAutoUpdateConfig;
@@ -53,8 +70,18 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
53
70
  *
54
71
  * const data =
55
72
  * await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
56
- * { body: {} },
73
+ * {
74
+ * body: {
75
+ * globalSetting:
76
+ * ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
77
+ * },
78
+ * },
57
79
  * );
80
+ *
81
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
82
+ * @throws {InvalidResponseError}
83
+ * @throws {ApiClientError}
84
+ * @throws {ClientRequestError}
58
85
  */
59
86
  validateGlobalAutoUpdateConfigForTenant(config: {
60
87
  body: ActiveGateGlobalAutoUpdateConfig;
@@ -65,7 +92,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
65
92
  *
66
93
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
67
94
  *
68
- * @returns Success
95
+ * @returns {Promise<ActiveGateAutoUpdateConfig>} Success
69
96
  *
70
97
  * @example <caption>Code example</caption>
71
98
  * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -74,6 +101,11 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
74
101
  * await activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(
75
102
  * { agId: "..." },
76
103
  * );
104
+ *
105
+ * @throws {ErrorEnvelopeError} Not found. See response body for details. | Client side error. | Server side error.
106
+ * @throws {InvalidResponseError}
107
+ * @throws {ApiClientError}
108
+ * @throws {ClientRequestError}
77
109
  */
78
110
  getAutoUpdateConfigById(config: {
79
111
  /** The ID of the required ActiveGate. */ agId: string;
@@ -89,8 +121,19 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
89
121
  *
90
122
  * const data =
91
123
  * await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
92
- * { agId: "...", body: {} },
124
+ * {
125
+ * agId: "...",
126
+ * body: {
127
+ * setting:
128
+ * ActiveGateAutoUpdateConfigSetting.Inherited,
129
+ * },
130
+ * },
93
131
  * );
132
+ *
133
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
134
+ * @throws {InvalidResponseError}
135
+ * @throws {ApiClientError}
136
+ * @throws {ClientRequestError}
94
137
  */
95
138
  putAutoUpdateConfigById(config: {
96
139
  body: ActiveGateAutoUpdateConfig;
@@ -107,8 +150,19 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
107
150
  *
108
151
  * const data =
109
152
  * await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
110
- * { agId: "...", body: {} },
153
+ * {
154
+ * agId: "...",
155
+ * body: {
156
+ * setting:
157
+ * ActiveGateAutoUpdateConfigSetting.Inherited,
158
+ * },
159
+ * },
111
160
  * );
161
+ *
162
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
163
+ * @throws {InvalidResponseError}
164
+ * @throws {ApiClientError}
165
+ * @throws {ClientRequestError}
112
166
  */
113
167
  validateAutoUpdateConfigById(config: {
114
168
  body: ActiveGateAutoUpdateConfig;
@@ -24,13 +24,18 @@ export declare class ActiveGatesAutoUpdateJobsClient {
24
24
  *
25
25
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
26
26
  *
27
- * @returns Success
27
+ * @returns {Promise<UpdateJobsAll>} Success
28
28
  *
29
29
  * @example <caption>Code example</caption>
30
30
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
31
31
  *
32
32
  * const data =
33
33
  * await activeGatesAutoUpdateJobsClient.getAllUpdateJobList();
34
+ *
35
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
36
+ * @throws {InvalidResponseError}
37
+ * @throws {ApiClientError}
38
+ * @throws {ClientRequestError}
34
39
  */
35
40
  getAllUpdateJobList(config?: {
36
41
  /**
@@ -92,7 +97,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
92
97
  *
93
98
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The job can update the ActiveGate to the specified version or the latest available one.
94
99
  *
95
- * @returns Success
100
+ * @returns {Promise<UpdateJobList>} Success
96
101
  *
97
102
  * @example <caption>Code example</caption>
98
103
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -101,6 +106,11 @@ export declare class ActiveGatesAutoUpdateJobsClient {
101
106
  * await activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(
102
107
  * { agId: "..." },
103
108
  * );
109
+ *
110
+ * @throws {ErrorEnvelopeError} Not found. See response body for details. | Client side error. | Server side error.
111
+ * @throws {InvalidResponseError}
112
+ * @throws {ApiClientError}
113
+ * @throws {ClientRequestError}
104
114
  */
105
115
  getUpdateJobListByAgId(config: {
106
116
  /** The ID of the required ActiveGate. */ agId: string;
@@ -163,7 +173,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
163
173
  *
164
174
  * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
165
175
  *
166
- * @returns Success. The update-job have been created.
176
+ * @returns {Promise<UpdateJob>} Success. The update-job have been created.
167
177
  *
168
178
  * @example <caption>Code example</caption>
169
179
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -175,6 +185,11 @@ export declare class ActiveGatesAutoUpdateJobsClient {
175
185
  * body: { targetVersion: "1.190.0.20200301-130000" },
176
186
  * },
177
187
  * );
188
+ *
189
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
190
+ * @throws {InvalidResponseError}
191
+ * @throws {ApiClientError}
192
+ * @throws {ClientRequestError}
178
193
  */
179
194
  createUpdateJobForAg(config: {
180
195
  body: UpdateJob;
@@ -196,6 +211,11 @@ export declare class ActiveGatesAutoUpdateJobsClient {
196
211
  * body: { targetVersion: "1.190.0.20200301-130000" },
197
212
  * },
198
213
  * );
214
+ *
215
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
216
+ * @throws {InvalidResponseError}
217
+ * @throws {ApiClientError}
218
+ * @throws {ClientRequestError}
199
219
  */
200
220
  validateUpdateJobForAg(config: {
201
221
  body: UpdateJob;
@@ -207,7 +227,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
207
227
  *
208
228
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
209
229
  *
210
- * @returns Success
230
+ * @returns {Promise<UpdateJob>} Success
211
231
  *
212
232
  * @example <caption>Code example</caption>
213
233
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -216,6 +236,11 @@ export declare class ActiveGatesAutoUpdateJobsClient {
216
236
  * await activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(
217
237
  * { agId: "...", jobId: "..." },
218
238
  * );
239
+ *
240
+ * @throws {ErrorEnvelopeError} Not found. See response body for details. | Client side error. | Server side error.
241
+ * @throws {InvalidResponseError}
242
+ * @throws {ApiClientError}
243
+ * @throws {ClientRequestError}
219
244
  */
220
245
  getUpdateJobByJobIdForAg(config: {
221
246
  /** The ID of the required ActiveGate. */ agId: string;
@@ -234,6 +259,11 @@ export declare class ActiveGatesAutoUpdateJobsClient {
234
259
  * await activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg(
235
260
  * { agId: "...", jobId: "..." },
236
261
  * );
262
+ *
263
+ * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Not found. See response body for details. | Client side error. | Server side error.
264
+ * @throws {InvalidResponseError}
265
+ * @throws {ApiClientError}
266
+ * @throws {ClientRequestError}
237
267
  */
238
268
  deleteUpdateJobByJobIdForAg(config: {
239
269
  /** The ID of the required ActiveGate. */ agId: string;
@@ -19,12 +19,17 @@ export declare class AttacksClient {
19
19
  * + environment:roles:manage-security-problems
20
20
  * + environment:roles:view-security-problems
21
21
  *
22
- * @returns Success
22
+ * @returns {Promise<AttackList>} Success
23
23
  *
24
24
  * @example <caption>Code example</caption>
25
25
  * import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
26
26
  *
27
27
  * const data = await attacksClient.getAttacks();
28
+ *
29
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
30
+ * @throws {InvalidResponseError}
31
+ * @throws {ApiClientError}
32
+ * @throws {ClientRequestError}
28
33
  */
29
34
  getAttacks(config?: {
30
35
  /**
@@ -136,12 +141,17 @@ export declare class AttacksClient {
136
141
  * + environment:roles:manage-security-problems
137
142
  * + environment:roles:view-security-problems
138
143
  *
139
- * @returns Success
144
+ * @returns {Promise<Attack>} Success
140
145
  *
141
146
  * @example <caption>Code example</caption>
142
147
  * import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
143
148
  *
144
149
  * const data = await attacksClient.getAttack({ id: "..." });
150
+ *
151
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
152
+ * @throws {InvalidResponseError}
153
+ * @throws {ApiClientError}
154
+ * @throws {ClientRequestError}
145
155
  */
146
156
  getAttack(config: {
147
157
  /** The ID of the attack. */ id: string;
@@ -19,12 +19,17 @@ export declare class AuditLogsClient {
19
19
  * 1. Specify the number of results per page in the **pageSize** query parameter.
20
20
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
21
21
  *
22
- * @returns Success
22
+ * @returns {Promise<AuditLog>} Success
23
23
  *
24
24
  * @example <caption>Code example</caption>
25
25
  * import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
26
26
  *
27
27
  * const data = await auditLogsClient.getLogs();
28
+ *
29
+ * @throws {ErrorEnvelopeError} Client side error. | Server side error.
30
+ * @throws {InvalidResponseError}
31
+ * @throws {ApiClientError}
32
+ * @throws {ClientRequestError}
28
33
  */
29
34
  getLogs(config?: {
30
35
  /**
@@ -110,12 +115,17 @@ export declare class AuditLogsClient {
110
115
  *
111
116
  * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings
112
117
  *
113
- * @returns Success
118
+ * @returns {Promise<AuditLogEntry>} Success
114
119
  *
115
120
  * @example <caption>Code example</caption>
116
121
  * import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
117
122
  *
118
123
  * const data = await auditLogsClient.getLog({ id: "..." });
124
+ *
125
+ * @throws {ErrorEnvelopeError} Failed. Invalid ID format. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.
126
+ * @throws {InvalidResponseError}
127
+ * @throws {ApiClientError}
128
+ * @throws {ClientRequestError}
119
129
  */
120
130
  getLog(config: {
121
131
  /** The ID of the required log entry. */ id: string;