@dynatrace-sdk/client-classic-environment-v2 0.6.1 → 0.6.4

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 (110) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +9 -7
  3. package/cjs/index.js +4558 -1077
  4. package/docs/DOCS.md +3626 -420
  5. package/dynatrace-metadata.json +2 -2
  6. package/esm/index.js +4558 -1077
  7. package/package.json +2 -2
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +1 -4
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -7
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts +2 -7
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +2 -1
  12. package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +7 -23
  13. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +2 -2
  14. package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +3 -6
  15. package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts +15 -4
  16. package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +5 -17
  17. package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts +5 -17
  18. package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts +1 -3
  19. package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +2 -0
  20. package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts +6 -20
  21. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +7 -22
  22. package/types/packages/client/classic-environment-v2/src/lib/apis/settings-schemas-api.d.ts +2 -6
  23. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-client-error.d.ts +2 -0
  24. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-serializer.d.ts +3 -0
  25. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +4 -4
  26. package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/invalid-response-error.d.ts +8 -0
  27. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-list.d.ts +6 -6
  28. package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +5 -5
  29. package/types/packages/client/classic-environment-v2/src/lib/models/bm-action.d.ts +2 -2
  30. package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details-type.d.ts +14 -0
  31. package/types/packages/client/classic-environment-v2/src/lib/models/code-level-vulnerability-details.d.ts +21 -0
  32. package/types/packages/client/classic-environment-v2/src/lib/models/comments-list.d.ts +6 -6
  33. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +6 -6
  34. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +5 -5
  35. package/types/packages/client/classic-environment-v2/src/lib/models/custom-entity-tags.d.ts +5 -5
  36. package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +2 -2
  37. package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +14 -14
  38. package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-values-list.d.ts +8 -8
  39. package/types/packages/client/classic-environment-v2/src/lib/models/entity-from-relationships.d.ts +2 -2
  40. package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +7 -7
  41. package/types/packages/client/classic-environment-v2/src/lib/models/entity-properties.d.ts +2 -2
  42. package/types/packages/client/classic-environment-v2/src/lib/models/entity-to-relationships.d.ts +2 -2
  43. package/types/packages/client/classic-environment-v2/src/lib/models/enum-type.d.ts +5 -5
  44. package/types/packages/client/classic-environment-v2/src/lib/models/event-list.d.ts +6 -6
  45. package/types/packages/client/classic-environment-v2/src/lib/models/event-property-detail.d.ts +5 -5
  46. package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +6 -6
  47. package/types/packages/client/classic-environment-v2/src/lib/models/event-type-list.d.ts +6 -6
  48. package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +7 -7
  49. package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.d.ts +6 -6
  50. package/types/packages/client/classic-environment-v2/src/lib/models/extension-feature-sets-details.d.ts +2 -2
  51. package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration-value.d.ts +12 -0
  52. package/types/packages/client/classic-environment-v2/src/lib/models/extension-monitoring-configuration.d.ts +3 -5
  53. package/types/packages/client/classic-environment-v2/src/lib/models/extension-upload-response-dto-feature-sets-details.d.ts +2 -2
  54. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +7 -0
  55. package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +5 -5
  56. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +1 -1
  57. package/types/packages/client/classic-environment-v2/src/lib/models/log-record-status.d.ts +1 -0
  58. package/types/packages/client/classic-environment-v2/src/lib/models/metric-data.d.ts +5 -5
  59. package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor-collection.d.ts +5 -5
  60. package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +27 -27
  61. package/types/packages/client/classic-environment-v2/src/lib/models/metric-dimension-cardinality.d.ts +5 -5
  62. package/types/packages/client/classic-environment-v2/src/lib/models/metric-evidence.d.ts +5 -5
  63. package/types/packages/client/classic-environment-v2/src/lib/models/metric-series.d.ts +2 -2
  64. package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +1 -1
  65. package/types/packages/client/classic-environment-v2/src/lib/models/objects-list.d.ts +8 -8
  66. package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +11 -11
  67. package/types/packages/client/classic-environment-v2/src/lib/models/problem-close-result.d.ts +2 -2
  68. package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +13 -13
  69. package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +7 -7
  70. package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +15 -15
  71. package/types/packages/client/classic-environment-v2/src/lib/models/releases.d.ts +6 -6
  72. package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-enums.d.ts +2 -2
  73. package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-properties.d.ts +2 -2
  74. package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto-types.d.ts +2 -2
  75. package/types/packages/client/classic-environment-v2/src/lib/models/schema-list.d.ts +5 -5
  76. package/types/packages/client/classic-environment-v2/src/lib/models/schema-stub.d.ts +5 -5
  77. package/types/packages/client/classic-environment-v2/src/lib/models/schema-type-properties.d.ts +2 -2
  78. package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +5 -5
  79. package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-events-list.d.ts +6 -6
  80. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +5 -5
  81. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-response.d.ts +5 -5
  82. package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +25 -25
  83. package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.d.ts +6 -6
  84. package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +10 -10
  85. package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl.d.ts +24 -24
  86. package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +37 -37
  87. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-batch-status.d.ts +2 -2
  88. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request.d.ts +6 -1
  89. package/types/packages/client/classic-environment-v2/src/lib/models/transactional-evidence.d.ts +5 -5
  90. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization-insert.d.ts +12 -0
  91. package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts +6 -8
  92. package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
  93. package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +16 -16
  94. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-component.d.ts +5 -0
  95. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment-type.d.ts +14 -0
  96. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment.d.ts +20 -0
  97. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.d.ts +14 -0
  98. package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input.d.ts +21 -0
  99. package/types/packages/platform/error-handlers/src/index.d.ts +2 -0
  100. package/types/packages/platform/error-handlers/src/lib/add-global-error-serializer.d.ts +14 -0
  101. package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts +10 -0
  102. package/types/packages/platform/error-handlers/src/lib/types/dt-runtime-error-handlers.d.ts +5 -0
  103. package/types/packages/platform/error-handlers/src/lib/types/error-type.d.ts +9 -0
  104. package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts +7 -0
  105. package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts +10 -0
  106. package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts +11 -0
  107. package/types/packages/platform/error-handlers/src/lib/types/index.d.ts +5 -0
  108. package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts +8 -0
  109. package/types/packages/platform/shared/index.d.ts +1 -0
  110. package/types/packages/platform/shared/utils/get-global-with-dt-runtime.d.ts +1 -0
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "0.6.1",
3
+ "version": "0.6.4",
4
4
  "dependencies": {
5
- "@dynatrace-sdk/http-client": "^0.4.3"
5
+ "@dynatrace-sdk/http-client": "^0.4.8"
6
6
  },
7
7
  "main": "./cjs/index.js",
8
8
  "module": "./esm/index.js",
@@ -42,10 +42,7 @@ export declare class AccessTokensActiveGateTokensClient {
42
42
  /**
43
43
  * Creates a new ActiveGate token | maturity=EARLY_ADOPTER
44
44
  *
45
- * **One of the following scopes is required:**
46
- * + environment-api:activegate-tokens:create
47
- * + environment-api:activegate-tokens:write
48
- * <br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
45
+ * **Required scope:** environment-api:activegate-tokens:create environment-api:activegate-tokens:write<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
49
46
  * @returns Success. The token has been created. The body of the response contains the token secret.
50
47
  */
51
48
  createToken(config: {
@@ -23,10 +23,7 @@ export declare class ActiveGatesClient {
23
23
  /**
24
24
  * Lists all available ActiveGates
25
25
  *
26
- * **One of the following scopes is required:**
27
- * + environment-api
28
- * + environment-api:activegates:read
29
- * <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
26
+ * **Required scope:** environment-api:activegates:read<br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
30
27
  * @returns Success
31
28
  */
32
29
  getAllActiveGates(config: {
@@ -80,9 +77,7 @@ export declare class ActiveGatesClient {
80
77
  /**
81
78
  * Gets the details of the specified ActiveGate
82
79
  *
83
- * **One of the following scopes is required:**
84
- * + environment-api
85
- * + environment-api:activegates:read
80
+ * **Required scope:** environment-api:activegates:read
86
81
  * @returns Success
87
82
  */
88
83
  getOneActiveGateById(config: {
@@ -15,9 +15,7 @@ export declare class AuditLogsClient {
15
15
  /**
16
16
  * Gets the specified entry of the audit log | maturity=EARLY_ADOPTER
17
17
  *
18
- * **One of the following scopes is required:**
19
- * + environment-api
20
- * + environment-api:audit-logs:read
18
+ * **Required scope:** environment-api:audit-logs:read
21
19
  * @returns Success
22
20
  */
23
21
  getLog(config: {
@@ -27,10 +25,7 @@ export declare class AuditLogsClient {
27
25
  /**
28
26
  * Gets the audit log of your Dynatrace environment | maturity=EARLY_ADOPTER
29
27
  *
30
- * **One of the following scopes is required:**
31
- * + environment-api
32
- * + environment-api:audit-logs:read
33
- * <br/><br/>You can limit the output by using pagination:
28
+ * **Required scope:** environment-api:audit-logs:read<br/><br/>You can limit the output by using pagination:
34
29
  * 1. Specify the number of results per page in the **pageSize** query parameter.
35
30
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
36
31
  * @returns Success
@@ -25,6 +25,7 @@ export declare class CredentialVaultClient {
25
25
  /** Filters the result by the specified credentials type. */ type?: ListCredentialsQueryType;
26
26
  /** Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive. */ name?: string;
27
27
  /** Filters credentials accessible to the user (owned by the user or the ones that are accessible for all). */ user?: string;
28
+ /** Filters credentials with specified scope. */ scope?: string;
28
29
  /**
29
30
  * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
30
31
  *
@@ -82,7 +83,7 @@ export declare class CredentialVaultClient {
82
83
  abortSignal?: AbortSignal;
83
84
  }): Promise<void>;
84
85
  /**
85
- * Gets the details of the specified credentials set
86
+ * Gets the details of the specified credentials set.
86
87
  *
87
88
  * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set including username/certificate, password or token is included in the response.
88
89
  * @returns Success. The response contains the details of the credentials set.
@@ -21,11 +21,7 @@ export declare class EventsClient {
21
21
  /**
22
22
  * Ingests a custom event
23
23
  *
24
- * **One of the following scopes is required:**
25
- * + environment-api
26
- * + storage:events:write
27
- * + environment-api:events:write
28
- * <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
24
+ * **Required scope:** storage:events:write environment-api:events:write<br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
29
25
  * @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
30
26
  */
31
27
  createEvent(config: {
@@ -35,9 +31,7 @@ export declare class EventsClient {
35
31
  /**
36
32
  * Gets the properties of an event
37
33
  *
38
- * **One of the following scopes is required:**
39
- * + environment-api
40
- * + environment-api:events:read
34
+ * **Required scope:** environment-api:events:read
41
35
  * @returns Success. The response contains the configuration of the event.
42
36
  */
43
37
  getEvent(config: {
@@ -47,9 +41,7 @@ export declare class EventsClient {
47
41
  /**
48
42
  * Lists all event properties
49
43
  *
50
- * **One of the following scopes is required:**
51
- * + environment-api
52
- * + environment-api:events:read
44
+ * **Required scope:** environment-api:events:read
53
45
  * @returns Success
54
46
  */
55
47
  getEventProperties(config: {
@@ -72,9 +64,7 @@ export declare class EventsClient {
72
64
  /**
73
65
  * Gets the details of an event property
74
66
  *
75
- * **One of the following scopes is required:**
76
- * + environment-api
77
- * + environment-api:events:read
67
+ * **Required scope:** environment-api:events:read
78
68
  * @returns Success
79
69
  */
80
70
  getEventProperty(config: {
@@ -84,9 +74,7 @@ export declare class EventsClient {
84
74
  /**
85
75
  * Gets the properties of an event type
86
76
  *
87
- * **One of the following scopes is required:**
88
- * + environment-api
89
- * + environment-api:events:read
77
+ * **Required scope:** environment-api:events:read
90
78
  * @returns Success
91
79
  */
92
80
  getEventType(config: {
@@ -96,9 +84,7 @@ export declare class EventsClient {
96
84
  /**
97
85
  * Lists all event types
98
86
  *
99
- * **One of the following scopes is required:**
100
- * + environment-api
101
- * + environment-api:events:read
87
+ * **Required scope:** environment-api:events:read
102
88
  * @returns Success
103
89
  */
104
90
  getEventTypes(config: {
@@ -121,9 +107,7 @@ export declare class EventsClient {
121
107
  /**
122
108
  * Lists events within the specified timeframe
123
109
  *
124
- * **One of the following scopes is required:**
125
- * + environment-api
126
- * + environment-api:events:read
110
+ * **Required scope:** environment-api:events:read
127
111
  * @returns Success. The response contains the list of events.
128
112
  */
129
113
  getEvents(config: {
@@ -100,7 +100,7 @@ export declare class Extensions_2_0Client {
100
100
  * Creates new monitoring configuration for the specified extension 2.0
101
101
  *
102
102
  * **Required scope:** environment-api:extension-configurations:write
103
- * @returns Success
103
+ * @returns Success | Multi-Status, if not all requests resulted in the same status
104
104
  */
105
105
  createMonitoringConfiguration(config: {
106
106
  body: MonitoringConfigurationDto[];
@@ -327,7 +327,7 @@ export declare class Extensions_2_0Client {
327
327
  * Uploads or verifies a new extension 2.0
328
328
  *
329
329
  * **Required scope:** environment-api:extensions:write
330
- * @returns The extension is valid
330
+ * @returns The extension is valid | Success. The extension 2.0 has been uploaded.
331
331
  */
332
332
  uploadExtension(config: {
333
333
  body: UploadExtensionBody;
@@ -19,10 +19,7 @@ export declare class LogsClient {
19
19
  /**
20
20
  * Pushes log records to Dynatrace | maturity=EARLY_ADOPTER
21
21
  *
22
- * **One of the following scopes is required:**
23
- * + environment-api
24
- * + storage:logs:write
25
- * <br/><br/>Ingested logs are stored in the indexed log storage.
22
+ * **Required scope:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
26
23
  *
27
24
  * This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
28
25
  *
@@ -142,7 +139,7 @@ export declare class LogsClient {
142
139
  /**
143
140
  * Gets aggregated log records | maturity=EARLY_ADOPTER
144
141
  *
145
- * **Required scope:** environment-api<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
142
+ * **Required scope:** storage:logs:read<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
146
143
  *
147
144
  * It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
148
145
  * @returns Success
@@ -219,7 +216,7 @@ export declare class LogsClient {
219
216
  /**
220
217
  * Reads log records | maturity=EARLY_ADOPTER
221
218
  *
222
- * **Required scope:** environment-api<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
219
+ * **Required scope:** storage:logs:read<br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
223
220
  *
224
221
  * If the query is too large to be processed in a single request, it is divided into slices. In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
225
222
  *
@@ -14,16 +14,27 @@ export declare class MetricsUnitsClient {
14
14
  */
15
15
  constructor(httpClientImplementation: HttpClient);
16
16
  /**
17
- * Converts a value of the given source unit into a given target unit if specified, or finds an appropriate unit if no target is specified, respecting the preferred number format if specified.
17
+ * Converts a value from a source unit into a target unit
18
18
  *
19
- * **Required scope:** environment-api:metrics:read
19
+ * **Required scope:** environment-api:metrics:read<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
20
20
  * @returns Success
21
21
  */
22
22
  convert(config: {
23
23
  /** The ID of the source unit. */ unitId: string;
24
24
  /** The value to be converted. */ value: number;
25
- /** The ID of the target unit. */ targetUnit?: string;
26
- /** The preferred number format. Only taken into account if no target unit is specified. */ numberFormat?: string;
25
+ /**
26
+ * The ID of the target unit.
27
+ *
28
+ * If not set, the request finds an appropriate target unit automatically, based on the specified number format.
29
+ */ targetUnit?: string;
30
+ /**
31
+ * The preferred number format of the target value. You can specify the following formats:
32
+ *
33
+ * * `binary`
34
+ * * `decimal`
35
+ *
36
+ * `Only used if the target unit if not set.
37
+ */ numberFormat?: string;
27
38
  abortSignal?: AbortSignal;
28
39
  }): Promise<UnitConversionResult>;
29
40
  /**
@@ -19,10 +19,7 @@ export declare class MonitoredEntitiesClient {
19
19
  /**
20
20
  * Gets the information about monitored entities
21
21
  *
22
- * **One of the following scopes is required:**
23
- * + environment-api
24
- * + environment-api:entities:read
25
- * <br/><br/>Lists entities observed within the specified timeframe along with their properties.
22
+ * **Required scope:** environment-api:entities:read<br/><br/>Lists entities observed within the specified timeframe along with their properties.
26
23
  *
27
24
  * When you query entities of the `SERVICE_METHOD` type, only the following requests are returned:
28
25
  *
@@ -140,9 +137,7 @@ export declare class MonitoredEntitiesClient {
140
137
  /**
141
138
  * Gets the properties of the specified monitored entity
142
139
  *
143
- * **One of the following scopes is required:**
144
- * + environment-api
145
- * + environment-api:entities:read
140
+ * **Required scope:** environment-api:entities:read
146
141
  * @returns Success
147
142
  */
148
143
  getEntity(config: {
@@ -195,9 +190,7 @@ export declare class MonitoredEntitiesClient {
195
190
  /**
196
191
  * Gets a list of properties for the specified entity type
197
192
  *
198
- * **One of the following scopes is required:**
199
- * + environment-api
200
- * + environment-api:entities:read
193
+ * **Required scope:** environment-api:entities:read
201
194
  * @returns Success
202
195
  */
203
196
  getEntityType(config: {
@@ -207,10 +200,7 @@ export declare class MonitoredEntitiesClient {
207
200
  /**
208
201
  * Gets a list of properties for all entity types
209
202
  *
210
- * **One of the following scopes is required:**
211
- * + environment-api
212
- * + environment-api:entities:read
213
- * <br/><br/>You can limit the output by using pagination:
203
+ * **Required scope:** environment-api:entities:read<br/><br/>You can limit the output by using pagination:
214
204
  * 1. Specify the number of results per page in the **pageSize** query parameter.
215
205
  * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
216
206
  * @returns Success
@@ -235,9 +225,7 @@ export declare class MonitoredEntitiesClient {
235
225
  /**
236
226
  * Creates or updates a custom device
237
227
  *
238
- * **One of the following scopes is required:**
239
- * + environment-api
240
- * + environment-api:entities:write
228
+ * **Required scope:** environment-api:entities:write
241
229
  * @returns Success
242
230
  */
243
231
  pushCustomDevice(config: {
@@ -19,9 +19,7 @@ export declare class NetworkZonesClient {
19
19
  /**
20
20
  * Gets parameters of the specified network zone
21
21
  *
22
- * **One of the following scopes is required:**
23
- * + environment-api
24
- * + environment-api:network-zones:read
22
+ * **Required scope:** environment-api:network-zones:read
25
23
  * @returns Success
26
24
  */
27
25
  getSingleNetworkZone(config: {
@@ -31,10 +29,7 @@ export declare class NetworkZonesClient {
31
29
  /**
32
30
  * Updates an existing network zone or creates a new one
33
31
  *
34
- * **One of the following scopes is required:**
35
- * + environment-api
36
- * + environment-api:network-zones:write
37
- * <br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
32
+ * **Required scope:** environment-api:network-zones:write<br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
38
33
  *
39
34
  * The ID is not case sensitive. Dynatrace stores the ID in lowercase.
40
35
  * @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
@@ -53,10 +48,7 @@ export declare class NetworkZonesClient {
53
48
  /**
54
49
  * Deletes the specified network zone
55
50
  *
56
- * **One of the following scopes is required:**
57
- * + environment-api
58
- * + environment-api:network-zones:write
59
- * <br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
51
+ * **Required scope:** environment-api:network-zones:write<br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
60
52
  *
61
53
  * If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
62
54
  */
@@ -67,18 +59,14 @@ export declare class NetworkZonesClient {
67
59
  /**
68
60
  * Lists all existing network zones
69
61
  *
70
- * **One of the following scopes is required:**
71
- * + environment-api
72
- * + environment-api:network-zones:read
62
+ * **Required scope:** environment-api:network-zones:read
73
63
  * @returns Success
74
64
  */
75
65
  getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
76
66
  /**
77
67
  * Gets the statistics about hosts using the network zone
78
68
  *
79
- * **One of the following scopes is required:**
80
- * + environment-api
81
- * + environment-api:network-zones:read
69
+ * **Required scope:** environment-api:network-zones:read
82
70
  * @returns Success
83
71
  */
84
72
  getHostStats(config: {
@@ -14,9 +14,7 @@ export declare class ReleasesClient {
14
14
  /**
15
15
  * Returns all releases
16
16
  *
17
- * **One of the following scopes is required:**
18
- * + environment-api
19
- * + environment-api:releases:read
17
+ * **Required scope:** environment-api:releases:read
20
18
  * @returns Success
21
19
  */
22
20
  getReleases(config: {
@@ -192,6 +192,7 @@ export declare class SecurityProblemsClient {
192
192
  * * Related Kubernetes workload name contains: `relatedKubernetesWorkloadNameContains("value-1")`. The `CONTAINS` operator is used.
193
193
  * * Management zone ID: `managementZoneIds("mzId-1","mzId-2")`.
194
194
  * * Management zone name: `managementZones("name-1","name-2")`. Values are case-sensitive.
195
+ * * Affected process group instance ID: `affectedPgiIds("pgiId-1", "pgiId-2")`. Specify Dynatrace entity IDs here.
195
196
  * * Affected process group ID: `affectedPgIds("pgId-1", "pgId-2")`. Specify Dynatrace entity IDs here.
196
197
  * * Affected process group name: `affectedPgNames("name-1", "name-2")`. Values are case-sensitive.
197
198
  * * Affected process group name contains: `affectedPgNameContains("name-1")`. The `CONTAINS` operator is used.
@@ -203,6 +204,7 @@ export declare class SecurityProblemsClient {
203
204
  * * Process group instance tags: `pgiTags("pgiTag-1")`. The `CONTAINS` operator is used. Maximum value length is 48 characters.
204
205
  * * Tags: `tags("tag-1")`. The `CONTAINS` operator is used. This selector picks hosts, process groups, and process group instances at the same time. Maximum value length is 48 characters.
205
206
  * * Display ID: `displayIds("S-1234","S-5678")`. The `EQUALS` operator is used.
207
+ * * Security problem ID: `securityProblemIds("12544152654387159360","5904857564184044850")`. The `EQUALS` operator is used.
206
208
  * * Technology: `technology("technology-1","technology-2")`. Find the possible values in the description of the **technology** field of the response. The `EQUALS` operator is used.
207
209
  * * Vulnerability type: `vulnerabilityType("type-1","type-2")`. Possible values are `THIRD_PARTY`, `CODE_LEVEL`, `RUNTIME`.
208
210
  *
@@ -22,9 +22,7 @@ export declare class ServiceLevelObjectivesClient {
22
22
  /**
23
23
  * Creates an alert of the provided alert type for an SLO
24
24
  *
25
- * **One of the following scopes is required:**
26
- * + environment-api
27
- * + environment-api:slo:write
25
+ * **Required scope:** environment-api:slo:write
28
26
  */
29
27
  createAlert(config: {
30
28
  body: AbstractSloAlertDto;
@@ -78,10 +76,7 @@ export declare class ServiceLevelObjectivesClient {
78
76
  /**
79
77
  * Lists all available SLOs along with calculated values
80
78
  *
81
- * **One of the following scopes is required:**
82
- * + environment-api
83
- * + environment-api:slo:read
84
- * <br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
79
+ * **Required scope:** environment-api:slo:read<br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
85
80
  *
86
81
  * 1. Set the **timeFrame** parameter to `GTF`.
87
82
  * 2. Provide the timeframe in **from** and **to** parameters.
@@ -177,9 +172,7 @@ export declare class ServiceLevelObjectivesClient {
177
172
  /**
178
173
  * Creates a new SLO
179
174
  *
180
- * **One of the following scopes is required:**
181
- * + environment-api
182
- * + environment-api:slo:write
175
+ * **Required scope:** environment-api:slo:write
183
176
  */
184
177
  createSlo(config: {
185
178
  body: SloConfigItemDtoImpl;
@@ -188,10 +181,7 @@ export declare class ServiceLevelObjectivesClient {
188
181
  /**
189
182
  * Gets parameters and calculated values of a specific SLO
190
183
  *
191
- * **One of the following scopes is required:**
192
- * + environment-api
193
- * + environment-api:slo:read
194
- * <br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
184
+ * **Required scope:** environment-api:slo:read<br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
195
185
  * @returns Success. The response contains the parameters and calculated values of the requested SLO.
196
186
  */
197
187
  getSloById(config: {
@@ -245,9 +235,7 @@ export declare class ServiceLevelObjectivesClient {
245
235
  /**
246
236
  * Updates an existing SLO
247
237
  *
248
- * **One of the following scopes is required:**
249
- * + environment-api
250
- * + environment-api:slo:write
238
+ * **Required scope:** environment-api:slo:write
251
239
  */
252
240
  updateSloById(config: {
253
241
  body: SloConfigItemDtoImpl;
@@ -257,9 +245,7 @@ export declare class ServiceLevelObjectivesClient {
257
245
  /**
258
246
  * Deletes an SLO
259
247
  *
260
- * **One of the following scopes is required:**
261
- * + environment-api
262
- * + environment-api:slo:write
248
+ * **Required scope:** environment-api:slo:write
263
249
  */
264
250
  deleteSlo(config: {
265
251
  id: string;
@@ -19,9 +19,7 @@ export declare class SettingsObjectsClient {
19
19
  /**
20
20
  * Gets the specified settings object
21
21
  *
22
- * **One of the following scopes is required:**
23
- * + environment-api
24
- * + settings:objects:read
22
+ * **Required scope:** settings:objects:read
25
23
  * @returns Success
26
24
  */
27
25
  getSettingsObjectByObjectId(config: {
@@ -31,9 +29,7 @@ export declare class SettingsObjectsClient {
31
29
  /**
32
30
  * Updates an existing settings object
33
31
  *
34
- * **One of the following scopes is required:**
35
- * + environment-api
36
- * + settings:objects:write
32
+ * **Required scope:** settings:objects:write
37
33
  * @returns Success
38
34
  */
39
35
  putSettingsObjectByObjectId(config: {
@@ -44,9 +40,7 @@ export declare class SettingsObjectsClient {
44
40
  /**
45
41
  * Deletes the specified settings object
46
42
  *
47
- * **One of the following scopes is required:**
48
- * + environment-api
49
- * + settings:objects:write
43
+ * **Required scope:** settings:objects:write
50
44
  */
51
45
  deleteSettingsObjectByObjectId(config: {
52
46
  /** The ID of the required settings object. */ objectId: string;
@@ -62,10 +56,7 @@ export declare class SettingsObjectsClient {
62
56
  /**
63
57
  * Lists effective settings values
64
58
  *
65
- * **One of the following scopes is required:**
66
- * + environment-api
67
- * + settings:objects:read
68
- * <br/><br/>Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see [/settings/objects](#/Settings%20-%20Objects/getSettingsObjects))
59
+ * **Required scope:** settings:objects:read<br/><br/>Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see [/settings/objects](#/Settings%20-%20Objects/getSettingsObjects))
69
60
  *
70
61
  * It will always return a result for a schema/scope combination, even if the schema would not be relevant to the given scope/entity.
71
62
  *
@@ -109,10 +100,7 @@ export declare class SettingsObjectsClient {
109
100
  /**
110
101
  * Lists persisted settings objects
111
102
  *
112
- * **One of the following scopes is required:**
113
- * + environment-api
114
- * + settings:objects:read
115
- * <br/><br/>Lists persisted settings objects for selected schemas at selected scopes (or entities).
103
+ * **Required scope:** settings:objects:read<br/><br/>Lists persisted settings objects for selected schemas at selected scopes (or entities).
116
104
  *
117
105
  * If nothing is persisted or if all persisted settings objects are not accessible due to missing permissions, no items will be returned.
118
106
  *
@@ -160,11 +148,8 @@ export declare class SettingsObjectsClient {
160
148
  /**
161
149
  * Creates a new settings object
162
150
  *
163
- * **One of the following scopes is required:**
164
- * + environment-api
165
- * + settings:objects:write
166
- * <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.
167
- * @returns Success
151
+ * **Required scope:** settings:objects:write<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.
152
+ * @returns Success | Multi-status: different objects in the payload resulted in different statuses.
168
153
  */
169
154
  postSettingsObjects(config: {
170
155
  body: SettingsObjectCreate[];
@@ -15,18 +15,14 @@ export declare class SettingsSchemasClient {
15
15
  /**
16
16
  * Lists available settings schemas
17
17
  *
18
- * **One of the following scopes is required:**
19
- * + environment-api
20
- * + settings:schemas:read
18
+ * **Required scope:** settings:schemas:read
21
19
  * @returns Success
22
20
  */
23
21
  getAvailableSchemaDefinitions(abortSignal?: AbortSignal): Promise<SchemaList>;
24
22
  /**
25
23
  * Gets parameters of the specified settings schema
26
24
  *
27
- * **One of the following scopes is required:**
28
- * + environment-api
29
- * + settings:schemas:read
25
+ * **Required scope:** settings:schemas:read
30
26
  * @returns Success
31
27
  */
32
28
  getSchemaDefinition(config: {
@@ -1,7 +1,9 @@
1
+ import { ErrorType } from '@dynatrace-sdk/error-handlers';
1
2
  /**
2
3
  * Error base. All client errors should extend this class.
3
4
  */
4
5
  export declare class ApiClientError extends Error {
6
+ errorType: ErrorType;
5
7
  constructor(name: string, message?: string);
6
8
  }
7
9
  export declare function isApiClientError(e: any): e is ApiClientError;
@@ -0,0 +1,3 @@
1
+ import { GlobalErrorSerializer } from '@dynatrace-sdk/error-handlers';
2
+ export declare const apiClientErrorSerializer: GlobalErrorSerializer;
3
+ export declare function registerGlobalErrorSerializer(serializer: GlobalErrorSerializer): void;
@@ -1,6 +1,6 @@
1
1
  export { isClientRequestError } from './client-request-error';
2
2
  export { isApiClientError } from './api-client-error';
3
- export { isErrorEnvelopeError } from './error-envelope-error';
4
- export { isValidationResponseError } from './validation-response-error';
5
- export { isSettingsObjectResponseError } from './settings-object-response-error';
6
- export { isSettingsObjectResponseArrayError } from './settings-object-response-array-error';
3
+ export { isErrorEnvelopeError, ErrorEnvelopeError } from './error-envelope-error';
4
+ export { isValidationResponseError, ValidationResponseError } from './validation-response-error';
5
+ export { isSettingsObjectResponseError, SettingsObjectResponseError } from './settings-object-response-error';
6
+ export { isSettingsObjectResponseArrayError, SettingsObjectResponseArrayError, } from './settings-object-response-array-error';
@@ -0,0 +1,8 @@
1
+ import { ApiClientError } from './api-client-error';
2
+ export declare class InvalidResponseError extends ApiClientError {
3
+ responseBody: any;
4
+ expectedType?: string;
5
+ nestedError?: Error;
6
+ constructor(name: string, nestedError: Error | any | undefined, body: any, expectedType?: string, message?: string);
7
+ }
8
+ export declare function isInvalidResponseError(e: any): e is InvalidResponseError;
@@ -8,9 +8,9 @@ export interface ApiTokenList {
8
8
  */
9
9
  apiTokens?: ApiToken[];
10
10
  /**
11
- * The number of entries per page.
11
+ * The total number of entries in the result.
12
12
  */
13
- pageSize?: number;
13
+ totalCount: number;
14
14
  /**
15
15
  * The cursor for the next page of results. Has the value of `null` on the last page.
16
16
  *
@@ -18,17 +18,17 @@ export interface ApiTokenList {
18
18
  */
19
19
  nextPageKey?: string;
20
20
  /**
21
- * The total number of entries in the result.
21
+ * The number of entries per page.
22
22
  */
23
- totalCount: number;
23
+ pageSize?: number;
24
24
  }
25
25
  /** @ignore */
26
26
  export declare namespace _ApiTokenListTransformation {
27
27
  interface AsJson {
28
28
  apiTokens?: _ApiTokenTransformation.AsJson[];
29
- pageSize?: number;
30
- nextPageKey?: string;
31
29
  totalCount: number;
30
+ nextPageKey?: string;
31
+ pageSize?: number;
32
32
  }
33
33
  function fromJson(model: AsJson): ApiTokenList;
34
34
  function toJson(model: ApiTokenList): AsJson;