@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
@@ -36,7 +36,7 @@ export declare class SecurityProblemsClient {
36
36
  * + environment:roles:manage-security-problems
37
37
  * + environment:roles:view-security-problems
38
38
  *
39
- * @returns Success. The response contains the list of security problems.
39
+ * @returns {Promise<SecurityProblemList>} Success. The response contains the list of security problems.
40
40
  *
41
41
  * @example <caption>Code example</caption>
42
42
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -209,14 +209,18 @@ export declare class SecurityProblemsClient {
209
209
  *
210
210
  * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
211
211
  *
212
- * @returns Success. The security problem(s) have been muted.
212
+ * @returns {Promise<SecurityProblemsBulkMuteResponse>} Success. The security problem(s) have been muted.
213
213
  *
214
214
  * @example <caption>Code example</caption>
215
215
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
216
216
  *
217
217
  * const data =
218
218
  * await securityProblemsClient.bulkMuteSecurityProblems({
219
- * body: { securityProblemIds: ["..."] },
219
+ * body: {
220
+ * reason:
221
+ * SecurityProblemsBulkMuteReason.ConfigurationNotAffected,
222
+ * securityProblemIds: ["..."],
223
+ * },
220
224
  * });
221
225
  *
222
226
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -233,14 +237,17 @@ export declare class SecurityProblemsClient {
233
237
  *
234
238
  * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
235
239
  *
236
- * @returns Success. The security problem(s) have been un-muted.
240
+ * @returns {Promise<SecurityProblemsBulkUnmuteResponse>} Success. The security problem(s) have been un-muted.
237
241
  *
238
242
  * @example <caption>Code example</caption>
239
243
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
240
244
  *
241
245
  * const data =
242
246
  * await securityProblemsClient.bulkUnmuteSecurityProblems({
243
- * body: { securityProblemIds: ["..."] },
247
+ * body: {
248
+ * reason: SecurityProblemsBulkUnmuteReason.Affected,
249
+ * securityProblemIds: ["..."],
250
+ * },
244
251
  * });
245
252
  *
246
253
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -259,7 +266,7 @@ export declare class SecurityProblemsClient {
259
266
  * + environment:roles:manage-security-problems
260
267
  * + environment:roles:view-security-problems
261
268
  *
262
- * @returns Success. The response contains parameters of the security problem.
269
+ * @returns {Promise<SecurityProblemDetails>} Success. The response contains parameters of the security problem.
263
270
  *
264
271
  * @example <caption>Code example</caption>
265
272
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -336,7 +343,7 @@ export declare class SecurityProblemsClient {
336
343
  * + environment:roles:manage-security-problems
337
344
  * + environment:roles:view-security-problems
338
345
  *
339
- * @returns Success. The response contains the list of security problem events.
346
+ * @returns {Promise<SecurityProblemEventsList>} Success. The response contains the list of security problem events.
340
347
  *
341
348
  * @example <caption>Code example</caption>
342
349
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -402,7 +409,10 @@ export declare class SecurityProblemsClient {
402
409
  * const data =
403
410
  * await securityProblemsClient.muteSecurityProblem({
404
411
  * id: "...",
405
- * body: {},
412
+ * body: {
413
+ * reason:
414
+ * SecurityProblemMuteReason.ConfigurationNotAffected,
415
+ * },
406
416
  * });
407
417
  *
408
418
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -422,7 +432,7 @@ export declare class SecurityProblemsClient {
422
432
  * + environment:roles:manage-security-problems
423
433
  * + environment:roles:view-security-problems
424
434
  *
425
- * @returns Success. The response contains the list of remediation items of a problem.
435
+ * @returns {Promise<RemediationItemList>} Success. The response contains the list of remediation items of a problem.
426
436
  *
427
437
  * @example <caption>Code example</caption>
428
438
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -468,7 +478,7 @@ export declare class SecurityProblemsClient {
468
478
  *
469
479
  * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
470
480
  *
471
- * @returns Success. The remediation item(s) have been muted.
481
+ * @returns {Promise<RemediationItemsBulkMuteResponse>} Success. The remediation item(s) have been muted.
472
482
  *
473
483
  * @example <caption>Code example</caption>
474
484
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -476,7 +486,11 @@ export declare class SecurityProblemsClient {
476
486
  * const data =
477
487
  * await securityProblemsClient.bulkMuteRemediationItems({
478
488
  * id: "...",
479
- * body: { remediationItemIds: ["..."] },
489
+ * body: {
490
+ * reason:
491
+ * RemediationItemsBulkMuteReason.ConfigurationNotAffected,
492
+ * remediationItemIds: ["..."],
493
+ * },
480
494
  * });
481
495
  *
482
496
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -517,7 +531,7 @@ export declare class SecurityProblemsClient {
517
531
  *
518
532
  * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
519
533
  *
520
- * @returns Success. The remediation item(s) have been un-muted.
534
+ * @returns {Promise<RemediationItemsBulkUnmuteResponse>} Success. The remediation item(s) have been un-muted.
521
535
  *
522
536
  * @example <caption>Code example</caption>
523
537
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -525,7 +539,10 @@ export declare class SecurityProblemsClient {
525
539
  * const data =
526
540
  * await securityProblemsClient.bulkUnmuteRemediationItems({
527
541
  * id: "...",
528
- * body: { remediationItemIds: ["..."] },
542
+ * body: {
543
+ * reason: RemediationItemsBulkUnmuteReason.Affected,
544
+ * remediationItemIds: ["..."],
545
+ * },
529
546
  * });
530
547
  *
531
548
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -545,7 +562,7 @@ export declare class SecurityProblemsClient {
545
562
  * + environment:roles:manage-security-problems
546
563
  * + environment:roles:view-security-problems
547
564
  *
548
- * @returns Success. The response contains details of a single remediation item of a security problem.
565
+ * @returns {Promise<RemediationDetailsItem>} Success. The response contains details of a single remediation item of a security problem.
549
566
  *
550
567
  * @example <caption>Code example</caption>
551
568
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -578,7 +595,11 @@ export declare class SecurityProblemsClient {
578
595
  * await securityProblemsClient.setRemediationItemMuteState({
579
596
  * id: "...",
580
597
  * remediationItemId: "...",
581
- * body: { comment: "...", muted: false },
598
+ * body: {
599
+ * comment: "...",
600
+ * muted: false,
601
+ * reason: RemediationItemMuteStateChangeReason.Ignore,
602
+ * },
582
603
  * });
583
604
  *
584
605
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -599,7 +620,7 @@ export declare class SecurityProblemsClient {
599
620
  * + environment:roles:manage-security-problems
600
621
  * + environment:roles:view-security-problems
601
622
  *
602
- * @returns Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.
623
+ * @returns {Promise<RemediationProgressEntityList>} Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.
603
624
  *
604
625
  * @example <caption>Code example</caption>
605
626
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -647,7 +668,7 @@ export declare class SecurityProblemsClient {
647
668
  * const data =
648
669
  * await securityProblemsClient.unmuteSecurityProblem({
649
670
  * id: "...",
650
- * body: {},
671
+ * body: { reason: SecurityProblemUnmuteReason.Affected },
651
672
  * });
652
673
  *
653
674
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -667,7 +688,7 @@ export declare class SecurityProblemsClient {
667
688
  * + environment:roles:manage-security-problems
668
689
  * + environment:roles:view-security-problems
669
690
  *
670
- * @returns Success. The response contains the list of vulnerable functions.
691
+ * @returns {Promise<VulnerableFunctionsContainer>} Success. The response contains the list of vulnerable functions.
671
692
  *
672
693
  * @example <caption>Code example</caption>
673
694
  * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -32,7 +32,7 @@ export declare class ServiceLevelObjectivesClient {
32
32
  * 1. Set the **timeFrame** parameter to `GTF`.
33
33
  * 2. Provide the timeframe in **from** and **to** parameters.
34
34
  *
35
- * @returns Success. The response contains the parameters and calculated values of the requested SLO.
35
+ * @returns {Promise<SLOs>} Success. The response contains the parameters and calculated values of the requested SLO.
36
36
  *
37
37
  * @example <caption>Code example</caption>
38
38
  * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -147,6 +147,8 @@ export declare class ServiceLevelObjectivesClient {
147
147
  *
148
148
  * const data = await serviceLevelObjectivesClient.createSlo({
149
149
  * body: {
150
+ * evaluationType:
151
+ * SloConfigItemDtoImplEvaluationType.Aggregate,
150
152
  * name: "Payment service availability",
151
153
  * target: 95,
152
154
  * timeframe: "-1d",
@@ -172,7 +174,7 @@ export declare class ServiceLevelObjectivesClient {
172
174
  *
173
175
  * <br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
174
176
  *
175
- * @returns Success. The response contains the parameters and calculated values of the requested SLO.
177
+ * @returns {Promise<SLO>} Success. The response contains the parameters and calculated values of the requested SLO.
176
178
  *
177
179
  * @example <caption>Code example</caption>
178
180
  * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -248,6 +250,8 @@ export declare class ServiceLevelObjectivesClient {
248
250
  * await serviceLevelObjectivesClient.updateSloById({
249
251
  * id: "...",
250
252
  * body: {
253
+ * evaluationType:
254
+ * SloConfigItemDtoImplEvaluationType.Aggregate,
251
255
  * name: "Payment service availability",
252
256
  * target: 95,
253
257
  * timeframe: "-1d",
@@ -295,7 +299,7 @@ export declare class ServiceLevelObjectivesClient {
295
299
  * + environment:roles:manage-settings
296
300
  * + settings:objects:write
297
301
  *
298
- * @returns Success. The new alert has been created. The response contains the parameters of the new alert. The **location** response header contains the ID of the new alert.
302
+ * @returns {Promise<EntityShortRepresentation>} Success. The new alert has been created. The response contains the parameters of the new alert. The **location** response header contains the ID of the new alert.
299
303
  *
300
304
  * @example <caption>Code example</caption>
301
305
  * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -303,7 +307,11 @@ export declare class ServiceLevelObjectivesClient {
303
307
  * const data = await serviceLevelObjectivesClient.createAlert(
304
308
  * {
305
309
  * id: "...",
306
- * body: { alertName: "...", alertThreshold: 10 },
310
+ * body: {
311
+ * alertName: "...",
312
+ * alertThreshold: 10,
313
+ * alertType: AbstractSloAlertDtoAlertType.BurnRate,
314
+ * },
307
315
  * },
308
316
  * );
309
317
  *
@@ -20,7 +20,7 @@ export declare class SettingsManagementZonesClient {
20
20
  *
21
21
  * <br/><br/>Allows to convert from an objectId to the ID of the management zone, and can serve as a replacement for [the old config endpoint](index.jsp?urls.primaryName=Configuration%20API#/Management%20zones) for that purpose.
22
22
  *
23
- * @returns Success
23
+ * @returns {Promise<ManagementZoneDetails>} Success
24
24
  *
25
25
  * @example <caption>Code example</caption>
26
26
  * import { settingsManagementZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -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";
@@ -63,7 +63,7 @@ export declare class SettingsObjectsClient {
63
63
  *
64
64
  * If no object along the hierarchy is persisted, the default value as defined in the schema will be returned.
65
65
  *
66
- * @returns Success
66
+ * @returns {Promise<EffectiveSettingsValuesList>} Success
67
67
  *
68
68
  * @example <caption>Code example</caption>
69
69
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -119,7 +119,7 @@ export declare class SettingsObjectsClient {
119
119
  * + environment:roles:manage-settings
120
120
  * + settings:objects:read
121
121
  *
122
- * @returns Success
122
+ * @returns {Promise<RevisionDiffPage>} Success
123
123
  *
124
124
  * @example <caption>Code example</caption>
125
125
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -141,8 +141,17 @@ export declare class SettingsObjectsClient {
141
141
  *
142
142
  * To load the first page, when the **nextPageKey** is not set, this parameter is required.
143
143
  */ scope?: string;
144
- /** 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;
145
- /** 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;
146
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;
147
156
  /**
148
157
  * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
@@ -173,7 +182,7 @@ export declare class SettingsObjectsClient {
173
182
  *
174
183
  * To query the effective values (including schema defaults) please see [/settings/effectiveValues](#/Settings%20-%20Objects/getEffectiveSettingsValues).
175
184
  *
176
- * @returns Success. Accessible objects returned.
185
+ * @returns {Promise<ObjectsList>} Success. Accessible objects returned.
177
186
  *
178
187
  * @example <caption>Code example</caption>
179
188
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -270,7 +279,7 @@ export declare class SettingsObjectsClient {
270
279
  *
271
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.
272
281
  *
273
- * @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.
274
283
  *
275
284
  * @example <caption>Code example</caption>
276
285
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -305,7 +314,7 @@ export declare class SettingsObjectsClient {
305
314
  * + environment:roles:manage-settings
306
315
  * + settings:objects:read
307
316
  *
308
- * @returns Success
317
+ * @returns {Promise<SettingsObjectByObjectIdResponse>} Success
309
318
  *
310
319
  * @example <caption>Code example</caption>
311
320
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -335,7 +344,7 @@ export declare class SettingsObjectsClient {
335
344
  *
336
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.
337
346
  *
338
- * @returns Success
347
+ * @returns {Promise<SettingsObjectResponse>} Success
339
348
  *
340
349
  * @example <caption>Code example</caption>
341
350
  * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -19,7 +19,7 @@ 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";
@@ -49,7 +49,7 @@ export declare class SettingsSchemasClient {
49
49
  * + environment:roles:manage-settings
50
50
  * + settings:schemas:read
51
51
  *
52
- * @returns Success
52
+ * @returns {Promise<SchemaDefinitionRestDto>} Success
53
53
  *
54
54
  * @example <caption>Code example</caption>
55
55
  * import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -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";
@@ -24,7 +24,7 @@ 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";
@@ -37,13 +37,15 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
37
37
  * @throws {ApiClientError}
38
38
  * @throws {ClientRequestError}
39
39
  */
40
- getConfiguration(abortSignal?: AbortSignal): Promise<SyntheticConfigDto>;
40
+ getConfiguration(config?: {
41
+ abortSignal?: AbortSignal;
42
+ } | AbortSignal): Promise<SyntheticConfigDto>;
41
43
  /**
42
44
  * Updates set of synthetic related parameters defined for whole tenant (affects all monitors and all private locations). | maturity=EARLY_ADOPTER
43
45
  *
44
46
  * **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
45
47
  *
46
- * @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.
47
49
  *
48
50
  * @example <caption>Code example</caption>
49
51
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -67,7 +69,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
67
69
  *
68
70
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
69
71
  *
70
- * @returns Success
72
+ * @returns {Promise<SyntheticLocations>} Success
71
73
  *
72
74
  * @example <caption>Code example</caption>
73
75
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -91,14 +93,22 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
91
93
  *
92
94
  * **Required scope:** environment-api:synthetic:write<br/>**Required permission:** environment:roles:manage-settings
93
95
  *
94
- * @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.
95
97
  *
96
98
  * @example <caption>Code example</caption>
97
99
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
98
100
  *
99
101
  * const data =
100
102
  * await syntheticLocationsNodesAndConfigurationClient.addLocation(
101
- * { body: {} },
103
+ * {
104
+ * body: {
105
+ * latitude: 10,
106
+ * longitude: 10,
107
+ * name: "...",
108
+ * type: SyntheticLocationType.Cluster,
109
+ * nodes: ["..."],
110
+ * },
111
+ * },
102
112
  * );
103
113
  *
104
114
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -115,7 +125,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
115
125
  *
116
126
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
117
127
  *
118
- * @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.
119
129
  *
120
130
  * @example <caption>Code example</caption>
121
131
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -139,7 +149,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
139
149
  *
140
150
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
141
151
  *
142
- * @returns Success. The response contains the public locations status.
152
+ * @returns {Promise<SyntheticPublicLocationsStatus>} Success. The response contains the public locations status.
143
153
  *
144
154
  * @example <caption>Code example</caption>
145
155
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -152,7 +162,9 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
152
162
  * @throws {ApiClientError}
153
163
  * @throws {ClientRequestError}
154
164
  */
155
- getLocationsStatus(abortSignal?: AbortSignal): Promise<SyntheticPublicLocationsStatus>;
165
+ getLocationsStatus(config?: {
166
+ abortSignal?: AbortSignal;
167
+ } | AbortSignal): Promise<SyntheticPublicLocationsStatus>;
156
168
  /**
157
169
  * Changes the status of public synthetic locations
158
170
  *
@@ -180,7 +192,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
180
192
  *
181
193
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
182
194
  *
183
- * @returns Success. The response contains parameters of the synthetic location.
195
+ * @returns {Promise<SyntheticLocation>} Success. The response contains parameters of the synthetic location.
184
196
  *
185
197
  * @example <caption>Code example</caption>
186
198
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -209,7 +221,10 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
209
221
  *
210
222
  * const data =
211
223
  * await syntheticLocationsNodesAndConfigurationClient.updateLocation(
212
- * { locationId: "...", body: {} },
224
+ * {
225
+ * locationId: "...",
226
+ * body: { type: SyntheticLocationUpdateType.Private },
227
+ * },
213
228
  * );
214
229
  *
215
230
  * @throws {ErrorEnvelopeError} Client side error. | Server side error.
@@ -249,7 +264,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
249
264
  *
250
265
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
251
266
  *
252
- * @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.
253
268
  *
254
269
  * @example <caption>Code example</caption>
255
270
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -276,7 +291,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
276
291
  *
277
292
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
278
293
  *
279
- * @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.
280
295
  *
281
296
  * @example <caption>Code example</caption>
282
297
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -306,7 +321,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
306
321
  *
307
322
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
308
323
  *
309
- * @returns Success
324
+ * @returns {Promise<Nodes>} Success
310
325
  *
311
326
  * @example <caption>Code example</caption>
312
327
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -319,13 +334,15 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
319
334
  * @throws {ApiClientError}
320
335
  * @throws {ClientRequestError}
321
336
  */
322
- getNodes(abortSignal?: AbortSignal): Promise<Nodes>;
337
+ getNodes(config?: {
338
+ abortSignal?: AbortSignal;
339
+ } | AbortSignal): Promise<Nodes>;
323
340
  /**
324
341
  * Lists properties of the specified synthetic node
325
342
  *
326
343
  * **Required scope:** environment-api:synthetic:read<br/>**Required permission:** environment:roles:manage-settings
327
344
  *
328
- * @returns Success
345
+ * @returns {Promise<Node>} Success
329
346
  *
330
347
  * @example <caption>Code example</caption>
331
348
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -19,7 +19,7 @@ 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";
@@ -54,7 +54,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
54
54
  *
55
55
  * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
56
56
  *
57
- * @returns Success
57
+ * @returns {Promise<MonitorEntityIdDto>} Success
58
58
  *
59
59
  * @example <caption>Code example</caption>
60
60
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -78,7 +78,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
78
78
  *
79
79
  * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
80
80
  *
81
- * @returns Success
81
+ * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
82
82
  *
83
83
  * @example <caption>Code example</caption>
84
84
  * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -22,7 +22,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
22
22
  *
23
23
  * **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
24
24
  *
25
- * @returns Success
25
+ * @returns {Promise<SyntheticOnDemandExecutions>} Success
26
26
  *
27
27
  * @example <caption>Code example</caption>
28
28
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -157,7 +157,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
157
157
  *
158
158
  * **Required scope:** environment-api:synthetic-execution:write<br/>**Required permission:** environment:roles:viewer
159
159
  *
160
- * @returns Success. The monitor's execution response details
160
+ * @returns {Promise<SyntheticOnDemandExecutionResult>} Success. The monitor's execution response details
161
161
  *
162
162
  * @example <caption>Code example</caption>
163
163
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -181,7 +181,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
181
181
  *
182
182
  * **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
183
183
  *
184
- * @returns Success
184
+ * @returns {Promise<SyntheticOnDemandBatchStatus>} Success
185
185
  *
186
186
  * @example <caption>Code example</caption>
187
187
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -205,7 +205,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
205
205
  *
206
206
  * **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
207
207
  *
208
- * @returns Success. The response contains basic information about the on-demand execution.
208
+ * @returns {Promise<SyntheticOnDemandExecution>} Success. The response contains basic information about the on-demand execution.
209
209
  *
210
210
  * @example <caption>Code example</caption>
211
211
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -229,7 +229,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
229
229
  *
230
230
  * **Required scope:** environment-api:synthetic-execution:write<br/>**Required permission:** environment:roles:viewer
231
231
  *
232
- * @returns Success. The monitor's execution response details
232
+ * @returns {Promise<SyntheticOnDemandExecutionResult>} Success. The monitor's execution response details
233
233
  *
234
234
  * @example <caption>Code example</caption>
235
235
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -253,7 +253,7 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
253
253
  *
254
254
  * **Required scope:** environment-api:synthetic-execution:read<br/>**Required permission:** environment:roles:viewer
255
255
  *
256
- * @returns Success. The response contains detailed information about the on-demand execution.
256
+ * @returns {Promise<SyntheticOnDemandExecution>} Success. The response contains detailed information about the on-demand execution.
257
257
  *
258
258
  * @example <caption>Code example</caption>
259
259
  * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -1,6 +1,6 @@
1
1
  export { ApiClientError, ApiGatewayError, ClientRequestError, InvalidResponseError, isApiClientError, isApiGatewayError, isClientRequestError, isInvalidResponseError, } from '@dynatrace-sdk/shared-errors';
2
- export { isErrorEnvelopeError } from './error-envelope-error';
3
- export { isBizEventIngestResultError } from './biz-event-ingest-result-error';
4
- export { isValidationResponseError } from './validation-response-error';
5
- export { isSettingsObjectResponseArrayError } from './settings-object-response-array-error';
6
- export { isSettingsObjectResponseError } from './settings-object-response-error';
2
+ export { ErrorEnvelopeError, isErrorEnvelopeError } from './error-envelope-error';
3
+ export { BizEventIngestResultError, isBizEventIngestResultError } from './biz-event-ingest-result-error';
4
+ export { ValidationResponseError, isValidationResponseError } from './validation-response-error';
5
+ export { SettingsObjectResponseArrayError, isSettingsObjectResponseArrayError, } from './settings-object-response-array-error';
6
+ export { SettingsObjectResponseError, isSettingsObjectResponseError } from './settings-object-response-error';
@@ -1,6 +1,5 @@
1
1
  /**
2
2
  * A schema representing an arbitrary value type.
3
- * This is just an alias for a type any.
4
- * @typedef {any} AnyValue
3
+ * @typedef {string | number | number | boolean | any[] | Record<string, any>} AnyValue
5
4
  */
6
- export type AnyValue = any;
5
+ export type AnyValue = string | number | number | boolean | any[] | Record<string, any>;
@@ -1,4 +1,4 @@
1
1
  import { AnyValue } from './any-value';
2
- export type AsJson = any;
3
- export declare function fromJson($model: AsJson): AnyValue;
4
- export declare function toJson($model: AnyValue): AsJson;
2
+ export type AsJson = string | number | number | boolean | any[] | Record<string, any>;
3
+ export declare function fromJson($model: AsJson): any;
4
+ export declare function toJson($model: AnyValue): any;
@@ -68,12 +68,12 @@ export interface ApiTokenCreate {
68
68
  * * `problems.write`: Write problems.
69
69
  * * `events.read`: Read events.
70
70
  * * `events.ingest`: Ingest events.
71
- * * `openpipeline.events`: OpenPipeline - Ingest Events.
71
+ * * `openpipeline.events`: OpenPipeline - Ingest Events (Built-in).
72
72
  * * `openpipeline.events.custom`: OpenPipeline - Ingest Events (Custom).
73
73
  * * `openpipeline.events_security`: OpenPipeline - Ingest Security Events (Built-in).
74
74
  * * `openpipeline.events_security.custom`: OpenPipeline - Ingest Security Events (Custom).
75
- * * `openpipeline.events_sdlc`: OpenPipeline - Ingest Events, Software Development Lifecycle.
76
- * * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Events, Software Development Lifecycle (Custom).
75
+ * * `openpipeline.events_sdlc`: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).
76
+ * * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).
77
77
  * * `bizevents.ingest`: Ingest bizevents.
78
78
  * * `analyzers.read`: Read analyzers.
79
79
  * * `analyzers.write`: Write & execute analyzers.