@dynatrace-sdk/client-classic-environment-v2 3.2.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 (67) hide show
  1. package/CHANGELOG.md +24 -2
  2. package/README.md +3038 -500
  3. package/cjs/index.js +6456 -4872
  4. package/dynatrace-metadata.json +2 -2
  5. package/esm/index.js +6456 -4872
  6. package/package.json +2 -2
  7. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +8 -4
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-api-tokens-api.d.ts +4 -4
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts +12 -6
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-active-gate-groups-api.d.ts +4 -2
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts +31 -7
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts +4 -4
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/attacks-api.d.ts +2 -2
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -2
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +1 -1
  17. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +5 -5
  18. package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
  19. package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +11 -8
  20. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +28 -26
  21. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +5 -5
  22. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +4 -4
  23. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +3 -3
  24. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +7 -7
  25. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +3 -3
  26. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +1 -1
  27. package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +11 -7
  28. package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +5 -5
  29. package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -1
  30. package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +39 -18
  31. package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +12 -4
  32. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts +1 -1
  33. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +18 -9
  34. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +2 -2
  35. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts +1 -1
  36. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +33 -16
  37. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts +3 -3
  38. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +6 -6
  39. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +5 -5
  40. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.d.ts +2 -3
  41. package/types/packages/client/classic-environment-v2/src/lib/models/any-value.transformation.d.ts +3 -3
  42. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +3 -3
  43. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +3 -3
  44. package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.d.ts +18 -0
  45. package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.transformation.d.ts +9 -0
  46. package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.d.ts +14 -0
  47. package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.transformation.d.ts +8 -0
  48. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-response-element-type.d.ts +2 -0
  49. package/types/packages/client/classic-environment-v2/src/lib/models/credentials-type.d.ts +6 -0
  50. package/types/packages/client/classic-environment-v2/src/lib/models/credentials.d.ts +3 -0
  51. package/types/packages/client/classic-environment-v2/src/lib/models/credentials.transformation.d.ts +6 -0
  52. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +6 -0
  53. package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts +3 -1
  54. package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.d.ts +4 -0
  55. package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.transformation.d.ts +1 -0
  56. package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.d.ts +30 -0
  57. package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.transformation.d.ts +12 -0
  58. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.d.ts +1 -1
  59. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.transformation.d.ts +1 -1
  60. package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts +1 -1
  61. package/types/packages/shared-errors/src/api-client-error.d.ts +13 -1
  62. package/types/packages/shared-errors/src/api-gateway-error.d.ts +19 -0
  63. package/types/packages/shared-errors/src/client-request-error.d.ts +29 -0
  64. package/types/packages/shared-errors/src/index.d.ts +0 -1
  65. package/types/packages/shared-errors/src/invalid-response-error.d.ts +18 -1
  66. package/types/packages/shared-errors/src/types.d.ts +62 -5
  67. package/types/packages/shared-errors/src/sdk-error.d.ts +0 -5
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "3.2.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
8
  "@dynatrace-sdk/http-client": "^1.0.10",
9
- "@dynatrace-sdk/shared-errors": "^0.0.3"
9
+ "@dynatrace-sdk/shared-errors": "^1.0.0"
10
10
  },
11
11
  "main": "./cjs/index.js",
12
12
  "module": "./esm/index.js",
@@ -21,7 +21,7 @@ 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";
@@ -60,14 +60,18 @@ export declare class AccessTokensActiveGateTokensClient {
60
60
  *
61
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.
62
62
  *
63
- * @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.
64
64
  *
65
65
  * @example <caption>Code example</caption>
66
66
  * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
67
67
  *
68
68
  * const data =
69
69
  * await accessTokensActiveGateTokensClient.createToken({
70
- * body: { name: "myToken" },
70
+ * body: {
71
+ * activeGateType:
72
+ * ActiveGateTokenCreateActiveGateType.Environment,
73
+ * name: "myToken",
74
+ * },
71
75
  * });
72
76
  *
73
77
  * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
@@ -84,7 +88,7 @@ export declare class AccessTokensActiveGateTokensClient {
84
88
  *
85
89
  * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The token secret is **not** exposed.
86
90
  *
87
- * @returns Success. The response contains the metadata of the tokens.
91
+ * @returns {Promise<ActiveGateToken>} Success. The response contains the metadata of the tokens.
88
92
  *
89
93
  * @example <caption>Code example</caption>
90
94
  * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -23,7 +23,7 @@ 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";
@@ -152,7 +152,7 @@ export declare class AccessTokensApiTokensClient {
152
152
  *
153
153
  * Creating personal access tokens requires the `environment:roles:viewer` permission. Creating access tokens requires the `environment:roles:manage-settings` permission.
154
154
  *
155
- * @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.
156
156
  *
157
157
  * @example <caption>Code example</caption>
158
158
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -176,7 +176,7 @@ export declare class AccessTokensApiTokensClient {
176
176
  *
177
177
  * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer
178
178
  *
179
- * @returns Success
179
+ * @returns {Promise<ApiToken>} Success
180
180
  *
181
181
  * @example <caption>Code example</caption>
182
182
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -203,7 +203,7 @@ export declare class AccessTokensApiTokensClient {
203
203
  *
204
204
  * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The token secret is **not** exposed.
205
205
  *
206
- * @returns Success
206
+ * @returns {Promise<ApiToken>} Success
207
207
  *
208
208
  * @example <caption>Code example</caption>
209
209
  * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -16,7 +16,7 @@ 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";
@@ -29,13 +29,15 @@ export declare class AccessTokensTenantTokensClient {
29
29
  * @throws {ApiClientError}
30
30
  * @throws {ClientRequestError}
31
31
  */
32
- cancelRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
32
+ cancelRotation(config?: {
33
+ abortSignal?: AbortSignal;
34
+ } | AbortSignal): Promise<TenantTokenConfig>;
33
35
  /**
34
36
  * Finishes tenant token rotation
35
37
  *
36
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.
37
39
  *
38
- * @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.
39
41
  *
40
42
  * @example <caption>Code example</caption>
41
43
  * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -48,13 +50,15 @@ export declare class AccessTokensTenantTokensClient {
48
50
  * @throws {ApiClientError}
49
51
  * @throws {ClientRequestError}
50
52
  */
51
- finishRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
53
+ finishRotation(config?: {
54
+ abortSignal?: AbortSignal;
55
+ } | AbortSignal): Promise<TenantTokenConfig>;
52
56
  /**
53
57
  * Starts tenant token rotation
54
58
  *
55
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.
56
60
  *
57
- * @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.
58
62
  *
59
63
  * @example <caption>Code example</caption>
60
64
  * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -67,6 +71,8 @@ export declare class AccessTokensTenantTokensClient {
67
71
  * @throws {ApiClientError}
68
72
  * @throws {ClientRequestError}
69
73
  */
70
- startRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
74
+ startRotation(config?: {
75
+ abortSignal?: AbortSignal;
76
+ } | AbortSignal): Promise<TenantTokenConfig>;
71
77
  }
72
78
  export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;
@@ -16,7 +16,7 @@ export declare class ActiveGatesActiveGateGroupsClient {
16
16
  *
17
17
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
18
18
  *
19
- * @returns Success
19
+ * @returns {Promise<ActiveGateGroups>} Success
20
20
  *
21
21
  * @example <caption>Code example</caption>
22
22
  * import { activeGatesActiveGateGroupsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -29,6 +29,8 @@ export declare class ActiveGatesActiveGateGroupsClient {
29
29
  * @throws {ApiClientError}
30
30
  * @throws {ClientRequestError}
31
31
  */
32
- getActiveGateGroups(abortSignal?: AbortSignal): Promise<ActiveGateGroups>;
32
+ getActiveGateGroups(config?: {
33
+ abortSignal?: AbortSignal;
34
+ } | AbortSignal): Promise<ActiveGateGroups>;
33
35
  }
34
36
  export declare const activeGatesActiveGateGroupsClient: ActiveGatesActiveGateGroupsClient;
@@ -26,7 +26,7 @@ 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";
@@ -92,7 +92,7 @@ export declare class ActiveGatesClient {
92
92
  *
93
93
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
94
94
  *
95
- * @returns Success
95
+ * @returns {Promise<ActiveGate>} Success
96
96
  *
97
97
  * @example <caption>Code example</caption>
98
98
  * import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -17,7 +17,7 @@ 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";
@@ -30,7 +30,9 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
30
30
  * @throws {ApiClientError}
31
31
  * @throws {ClientRequestError}
32
32
  */
33
- getGlobalAutoUpdateConfigForTenant(abortSignal?: AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
33
+ getGlobalAutoUpdateConfigForTenant(config?: {
34
+ abortSignal?: AbortSignal;
35
+ } | AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
34
36
  /**
35
37
  * Puts the global auto-update configuration of environment ActiveGates.
36
38
  *
@@ -41,7 +43,12 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
41
43
  *
42
44
  * const data =
43
45
  * await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
44
- * { body: {} },
46
+ * {
47
+ * body: {
48
+ * globalSetting:
49
+ * ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
50
+ * },
51
+ * },
45
52
  * );
46
53
  *
47
54
  * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
@@ -63,7 +70,12 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
63
70
  *
64
71
  * const data =
65
72
  * await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
66
- * { body: {} },
73
+ * {
74
+ * body: {
75
+ * globalSetting:
76
+ * ActiveGateGlobalAutoUpdateConfigGlobalSetting.Enabled,
77
+ * },
78
+ * },
67
79
  * );
68
80
  *
69
81
  * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
@@ -80,7 +92,7 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
80
92
  *
81
93
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
82
94
  *
83
- * @returns Success
95
+ * @returns {Promise<ActiveGateAutoUpdateConfig>} Success
84
96
  *
85
97
  * @example <caption>Code example</caption>
86
98
  * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -109,7 +121,13 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
109
121
  *
110
122
  * const data =
111
123
  * await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
112
- * { agId: "...", body: {} },
124
+ * {
125
+ * agId: "...",
126
+ * body: {
127
+ * setting:
128
+ * ActiveGateAutoUpdateConfigSetting.Inherited,
129
+ * },
130
+ * },
113
131
  * );
114
132
  *
115
133
  * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
@@ -132,7 +150,13 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
132
150
  *
133
151
  * const data =
134
152
  * await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
135
- * { agId: "...", body: {} },
153
+ * {
154
+ * agId: "...",
155
+ * body: {
156
+ * setting:
157
+ * ActiveGateAutoUpdateConfigSetting.Inherited,
158
+ * },
159
+ * },
136
160
  * );
137
161
  *
138
162
  * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
@@ -24,7 +24,7 @@ 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";
@@ -97,7 +97,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
97
97
  *
98
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.
99
99
  *
100
- * @returns Success
100
+ * @returns {Promise<UpdateJobList>} Success
101
101
  *
102
102
  * @example <caption>Code example</caption>
103
103
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -173,7 +173,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
173
173
  *
174
174
  * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
175
175
  *
176
- * @returns Success. The update-job have been created.
176
+ * @returns {Promise<UpdateJob>} Success. The update-job have been created.
177
177
  *
178
178
  * @example <caption>Code example</caption>
179
179
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -227,7 +227,7 @@ export declare class ActiveGatesAutoUpdateJobsClient {
227
227
  *
228
228
  * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
229
229
  *
230
- * @returns Success
230
+ * @returns {Promise<UpdateJob>} Success
231
231
  *
232
232
  * @example <caption>Code example</caption>
233
233
  * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -19,7 +19,7 @@ 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";
@@ -141,7 +141,7 @@ export declare class AttacksClient {
141
141
  * + environment:roles:manage-security-problems
142
142
  * + environment:roles:view-security-problems
143
143
  *
144
- * @returns Success
144
+ * @returns {Promise<Attack>} Success
145
145
  *
146
146
  * @example <caption>Code example</caption>
147
147
  * import { attacksClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -19,7 +19,7 @@ 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";
@@ -115,7 +115,7 @@ export declare class AuditLogsClient {
115
115
  *
116
116
  * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings
117
117
  *
118
- * @returns Success
118
+ * @returns {Promise<AuditLogEntry>} Success
119
119
  *
120
120
  * @example <caption>Code example</caption>
121
121
  * import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -16,7 +16,7 @@ export declare class BusinessEventsClient {
16
16
  *
17
17
  * The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
18
18
  *
19
- * @returns The provided business events are all accepted and will be processed.
19
+ * @returns {Promise<void>} The provided business events are all accepted and will be processed.
20
20
  *
21
21
  * @example <caption>Code example</caption>
22
22
  * import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -21,7 +21,7 @@ export declare class CredentialVaultClient {
21
21
  *
22
22
  * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
23
23
  *
24
- * @returns Success
24
+ * @returns {Promise<CredentialsList>} Success
25
25
  *
26
26
  * @example <caption>Code example</caption>
27
27
  * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -59,7 +59,7 @@ export declare class CredentialVaultClient {
59
59
  *
60
60
  * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
61
61
  *
62
- * @returns Success. The new credentials set has been created. The response contains the ID of the set.
62
+ * @returns {Promise<CredentialsId>} Success. The new credentials set has been created. The response contains the ID of the set.
63
63
  *
64
64
  * @example <caption>Code example</caption>
65
65
  * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -85,7 +85,7 @@ export declare class CredentialVaultClient {
85
85
  *
86
86
  * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
87
87
  *
88
- * @returns Success. The response contains the metadata of the credentials set.
88
+ * @returns {Promise<CredentialsResponseElement>} Success. The response contains the metadata of the credentials set.
89
89
  *
90
90
  * @example <caption>Code example</caption>
91
91
  * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -108,7 +108,7 @@ export declare class CredentialVaultClient {
108
108
  *
109
109
  * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. The ID should be provided in the path.
110
110
  *
111
- * @returns Success. The new credentials set has been created. The response contains the ID of the set.
111
+ * @returns {Promise<CredentialsId | void>} Success. The new credentials set has been created. The response contains the ID of the set.
112
112
  *
113
113
  * @example <caption>Code example</caption>
114
114
  * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -157,7 +157,7 @@ export declare class CredentialVaultClient {
157
157
  *
158
158
  * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set including username/certificate, password or token is included in the response.
159
159
  *
160
- * @returns Success. The response contains the details of the credentials set.
160
+ * @returns {Promise<AbstractCredentialsResponseElement>} Success. The response contains the details of the credentials set.
161
161
  *
162
162
  * @example <caption>Code example</caption>
163
163
  * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -20,7 +20,7 @@ export declare class DavisSecurityAdvisorClient {
20
20
  *
21
21
  * <br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
22
22
  *
23
- * @returns Success
23
+ * @returns {Promise<DavisSecurityAdviceList>} Success
24
24
  *
25
25
  * @example <caption>Code example</caption>
26
26
  * import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -23,7 +23,7 @@ export declare class EventsClient {
23
23
  *
24
24
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
25
25
  *
26
- * @returns Success
26
+ * @returns {Promise<EventPropertiesList>} Success
27
27
  *
28
28
  * @example <caption>Code example</caption>
29
29
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -57,7 +57,7 @@ export declare class EventsClient {
57
57
  *
58
58
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
59
59
  *
60
- * @returns Success
60
+ * @returns {Promise<EventPropertyDetails>} Success
61
61
  *
62
62
  * @example <caption>Code example</caption>
63
63
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -80,7 +80,7 @@ export declare class EventsClient {
80
80
  *
81
81
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
82
82
  *
83
- * @returns Success
83
+ * @returns {Promise<EventTypeList>} Success
84
84
  *
85
85
  * @example <caption>Code example</caption>
86
86
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -114,7 +114,7 @@ export declare class EventsClient {
114
114
  *
115
115
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
116
116
  *
117
- * @returns Success
117
+ * @returns {Promise<EventType>} Success
118
118
  *
119
119
  * @example <caption>Code example</caption>
120
120
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -137,7 +137,7 @@ export declare class EventsClient {
137
137
  *
138
138
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
139
139
  *
140
- * @returns Success. The response contains the list of events.
140
+ * @returns {Promise<EventList>} Success. The response contains the list of events.
141
141
  *
142
142
  * @example <caption>Code example</caption>
143
143
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -268,13 +268,16 @@ export declare class EventsClient {
268
268
  *
269
269
  * <br/><br/>The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
270
270
  *
271
- * @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
271
+ * @returns {Promise<EventIngestResults>} The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
272
272
  *
273
273
  * @example <caption>Code example</caption>
274
274
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
275
275
  *
276
276
  * const data = await eventsClient.createEvent({
277
- * body: { title: "..." },
277
+ * body: {
278
+ * eventType: EventIngestEventType.AvailabilityEvent,
279
+ * title: "...",
280
+ * },
278
281
  * });
279
282
  *
280
283
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -291,7 +294,7 @@ export declare class EventsClient {
291
294
  *
292
295
  * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
293
296
  *
294
- * @returns Success. The response contains the configuration of the event.
297
+ * @returns {Promise<Event>} Success. The response contains the configuration of the event.
295
298
  *
296
299
  * @example <caption>Code example</caption>
297
300
  * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";