@dynatrace-sdk/client-classic-environment-v2 1.11.1 → 1.12.0

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 (35) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +1421 -1036
  3. package/cjs/index.js +1964 -927
  4. package/docs/DOCS.md +1421 -1036
  5. package/dynatrace-metadata.json +1 -1
  6. package/esm/index.js +1964 -927
  7. package/package.json +1 -1
  8. package/types/packages/client/classic-environment-v2/src/lib/apis/business-events-api.d.ts +2 -2
  9. package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +0 -2
  10. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +9 -6
  11. package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts +4 -6
  12. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +6 -1
  13. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -0
  14. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +5 -0
  15. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +6 -1
  16. package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -0
  17. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +4 -0
  18. package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.transformation.d.ts +1 -0
  19. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +4 -0
  20. package/types/packages/client/classic-environment-v2/src/lib/models/constraint.transformation.d.ts +1 -0
  21. package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +0 -4
  22. package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +49 -5
  23. package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.d.ts +4 -0
  24. package/types/packages/client/classic-environment-v2/src/lib/models/schema-constraint-rest-dto.transformation.d.ts +1 -0
  25. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.d.ts +1 -1
  26. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-dto.transformation.d.ts +1 -1
  27. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.d.ts +1 -1
  28. package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-multi-protocol-monitor-update-dto.transformation.d.ts +1 -1
  29. package/types/packages/http-client/src/index.d.ts +1 -1
  30. package/types/packages/http-client/src/lib/platform/index.d.ts +1 -0
  31. package/types/packages/http-client/src/lib/platform/oauth-http-client.d.ts +41 -0
  32. package/types/packages/client/classic-environment-v2/src/lib/models/get-execution-full-report-path-execution-id.d.ts +0 -5
  33. package/types/packages/client/classic-environment-v2/src/lib/models/get-execution-full-report-path-execution-id.transformation.d.ts +0 -4
  34. package/types/packages/client/classic-environment-v2/src/lib/models/get-execution-path-execution-id.d.ts +0 -5
  35. package/types/packages/client/classic-environment-v2/src/lib/models/get-execution-path-execution-id.transformation.d.ts +0 -4
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynatrace-sdk/client-classic-environment-v2",
3
- "version": "1.11.1",
3
+ "version": "1.12.0",
4
4
  "description": "Client for the Dynatrace Environment API v2",
5
5
  "license": "Apache-2.0",
6
6
  "dependencies": {
@@ -45,10 +45,10 @@ export declare class BusinessEventsClient {
45
45
  */
46
46
  ingest(config: ({
47
47
  body: CloudEvent;
48
- type: 'application/cloudevent+json';
48
+ type: 'application/cloudevent+json' | 'application/cloudevents+json';
49
49
  } | {
50
50
  body: CloudEvent[];
51
- type: 'application/cloudevent-batch+json';
51
+ type: 'application/cloudevent-batch+json' | 'application/cloudevents-batch+json';
52
52
  } | {
53
53
  body: IngestBody;
54
54
  type: 'application/json; charset=utf-8';
@@ -79,13 +79,11 @@ export declare class Extensions_2_0Client {
79
79
  * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
80
80
  *
81
81
  * const data = await extensions_2_0Client.uploadExtension({
82
- * type: "application/octet-stream",
83
82
  * body: new Blob(),
84
83
  * });
85
84
  */
86
85
  uploadExtension(config: {
87
86
  body: Blob;
88
- type: 'application/octet-stream' | 'multipart/form-data';
89
87
  /** Only run validation but do not persist the extension even if validation was successful. */ validateOnly?: boolean;
90
88
  abortSignal?: AbortSignal;
91
89
  }): Promise<ExtensionUploadResponseDto>;
@@ -99,9 +99,9 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
99
99
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
100
100
  *
101
101
  * const data =
102
- * await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentApplyCommands();
102
+ * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands();
103
103
  */
104
- getLocationDemploymentApplyCommands(config?: {
104
+ getLocationDeploymentApplyCommands(config?: {
105
105
  /** Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. */ platform?: string;
106
106
  /** Namespace */ namespace?: string;
107
107
  /** Filename */ filename?: string;
@@ -203,11 +203,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
203
203
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
204
204
  *
205
205
  * const data =
206
- * await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentDeleteCommands(
206
+ * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(
207
207
  * { locationId: "..." },
208
208
  * );
209
209
  */
210
- getLocationDemploymentDeleteCommands(config: {
210
+ getLocationDeploymentDeleteCommands(config: {
211
211
  /** The Dynatrace entity ID of the required location. */ locationId: string;
212
212
  /** Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. */ platform?: string;
213
213
  /** Namespace */ namespace?: string;
@@ -225,15 +225,18 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
225
225
  * import { syntheticLocationsNodesAndConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
226
226
  *
227
227
  * const data =
228
- * await syntheticLocationsNodesAndConfigurationClient.getLocationDemploymentYaml(
228
+ * await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(
229
229
  * { locationId: "..." },
230
230
  * );
231
231
  */
232
- getLocationDemploymentYaml(config: {
232
+ getLocationDeploymentYaml(config: {
233
233
  /** The Dynatrace entity ID of the required location. */ locationId: string;
234
234
  /** Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. */ platform?: string;
235
235
  /** Active gate name */ activeGateName?: string;
236
236
  /** Namespace */ namespace?: string;
237
+ /** Custom images registry prefix - this will replace 'dynatrace' in image URLs in generated yaml. */ customRegistry?: string;
238
+ /** Custom version tag for Active Gate - this will be used as desired Active Gate version in generated yaml. */ tagVersionActiveGate?: string;
239
+ /** Custom version tag for Synthetic- this will be used as desired Synthetic version in generated yaml */ tagVersionSynthetic?: string;
237
240
  abortSignal?: AbortSignal;
238
241
  }): Promise<void>;
239
242
  /**
@@ -1,6 +1,4 @@
1
1
  import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
2
- import { GetExecutionFullReportPathExecutionId } from '../models/get-execution-full-report-path-execution-id';
3
- import { GetExecutionPathExecutionId } from '../models/get-execution-path-execution-id';
4
2
  import { GetExecutionsQueryExecutionStage } from '../models/get-executions-query-execution-stage';
5
3
  import { GetExecutionsQuerySource } from '../models/get-executions-query-source';
6
4
  import { SyntheticOnDemandBatchStatus } from '../models/synthetic-on-demand-batch-status';
@@ -199,11 +197,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
199
197
  *
200
198
  * const data =
201
199
  * await syntheticOnDemandMonitorExecutionsClient.getExecution(
202
- * { executionId: {} },
200
+ * { executionId: 10 },
203
201
  * );
204
202
  */
205
203
  getExecution(config: {
206
- /** The identifier of the on-demand execution. */ executionId: GetExecutionPathExecutionId;
204
+ /** The identifier of the on-demand execution. */ executionId: number;
207
205
  abortSignal?: AbortSignal;
208
206
  }): Promise<SyntheticOnDemandExecution>;
209
207
  /**
@@ -218,11 +216,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
218
216
  *
219
217
  * const data =
220
218
  * await syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(
221
- * { executionId: {} },
219
+ * { executionId: 10 },
222
220
  * );
223
221
  */
224
222
  getExecutionFullReport(config: {
225
- /** The identifier of the on-demand execution. */ executionId: GetExecutionFullReportPathExecutionId;
223
+ /** The identifier of the on-demand execution. */ executionId: number;
226
224
  abortSignal?: AbortSignal;
227
225
  }): Promise<SyntheticOnDemandExecution>;
228
226
  }
@@ -32,6 +32,10 @@ export declare enum ApiTokenCreateScopesItem {
32
32
  ProblemsWrite = "problems.write",
33
33
  EventsRead = "events.read",
34
34
  EventsIngest = "events.ingest",
35
+ OpenpipelineEvents = "openpipeline.events",
36
+ OpenpipelineEventsCustom = "openpipeline.events.custom",
37
+ OpenpipelineEventsSecurity = "openpipeline.events.security",
38
+ OpenpipelineEventsSecurityCustom = "openpipeline.events.security.custom",
35
39
  BizeventsIngest = "bizevents.ingest",
36
40
  AnalyzersRead = "analyzers.read",
37
41
  AnalyzersWrite = "analyzers.write",
@@ -78,5 +82,6 @@ export declare enum ApiTokenCreateScopesItem {
78
82
  HubInstall = "hub.install",
79
83
  JavaScriptMappingFilesRead = "javaScriptMappingFiles.read",
80
84
  JavaScriptMappingFilesWrite = "javaScriptMappingFiles.write",
81
- ExtensionConfigurationActionsWrite = "extensionConfigurationActions.write"
85
+ ExtensionConfigurationActionsWrite = "extensionConfigurationActions.write",
86
+ AdaptiveTrafficManagementRead = "adaptiveTrafficManagement.read"
82
87
  }
@@ -68,6 +68,10 @@ 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 events.
72
+ * * `openpipeline.events.custom`: OpenPipeline custom events.
73
+ * * `openpipeline.events.security`: OpenPipeline security events.
74
+ * * `openpipeline.events.security.custom`: OpenPipeline custom security events.
71
75
  * * `bizevents.ingest`: Ingest bizevents.
72
76
  * * `analyzers.read`: Read analyzers.
73
77
  * * `analyzers.write`: Write & execute analyzers.
@@ -115,6 +119,7 @@ export interface ApiTokenCreate {
115
119
  * * `javaScriptMappingFiles.read`: Read JavaScript mapping files.
116
120
  * * `javaScriptMappingFiles.write`: Write JavaScript mapping files.
117
121
  * * `extensionConfigurationActions.write`: Actions for extension monitoring configurations.
122
+ * * `adaptiveTrafficManagement.read`: Read sampling configuration for Adaptive Traffic Management.
118
123
  */
119
124
  scopes: ApiTokenCreateScopesItem[];
120
125
  }
@@ -32,6 +32,7 @@ export declare enum ApiTokenScopesItem {
32
32
  ActiveGateTokenManagementWrite = "activeGateTokenManagement.write",
33
33
  ActiveGatesRead = "activeGates.read",
34
34
  ActiveGatesWrite = "activeGates.write",
35
+ AdaptiveTrafficManagementRead = "adaptiveTrafficManagement.read",
35
36
  AnalyzersRead = "analyzers.read",
36
37
  AnalyzersWrite = "analyzers.write",
37
38
  ApiTokensRead = "apiTokens.read",
@@ -69,6 +70,10 @@ export declare enum ApiTokenScopesItem {
69
70
  OneAgentsRead = "oneAgents.read",
70
71
  OneAgentsWrite = "oneAgents.write",
71
72
  OpenTelemetryTraceIngest = "openTelemetryTrace.ingest",
73
+ OpenpipelineEvents = "openpipeline.events",
74
+ OpenpipelineEventsCustom = "openpipeline.events.custom",
75
+ OpenpipelineEventsSecurity = "openpipeline.events.security",
76
+ OpenpipelineEventsSecurityCustom = "openpipeline.events.security.custom",
72
77
  ProblemsRead = "problems.read",
73
78
  ProblemsWrite = "problems.write",
74
79
  ReleasesRead = "releases.read",
@@ -32,6 +32,10 @@ export declare enum ApiTokenUpdateScopesItem {
32
32
  ProblemsWrite = "problems.write",
33
33
  EventsRead = "events.read",
34
34
  EventsIngest = "events.ingest",
35
+ OpenpipelineEvents = "openpipeline.events",
36
+ OpenpipelineEventsCustom = "openpipeline.events.custom",
37
+ OpenpipelineEventsSecurity = "openpipeline.events.security",
38
+ OpenpipelineEventsSecurityCustom = "openpipeline.events.security.custom",
35
39
  BizeventsIngest = "bizevents.ingest",
36
40
  AnalyzersRead = "analyzers.read",
37
41
  AnalyzersWrite = "analyzers.write",
@@ -78,5 +82,6 @@ export declare enum ApiTokenUpdateScopesItem {
78
82
  HubInstall = "hub.install",
79
83
  JavaScriptMappingFilesRead = "javaScriptMappingFiles.read",
80
84
  JavaScriptMappingFilesWrite = "javaScriptMappingFiles.write",
81
- ExtensionConfigurationActionsWrite = "extensionConfigurationActions.write"
85
+ ExtensionConfigurationActionsWrite = "extensionConfigurationActions.write",
86
+ AdaptiveTrafficManagementRead = "adaptiveTrafficManagement.read"
82
87
  }
@@ -49,6 +49,10 @@ export interface ApiTokenUpdate {
49
49
  * * `problems.write`: Write problems.
50
50
  * * `events.read`: Read events.
51
51
  * * `events.ingest`: Ingest events.
52
+ * * `openpipeline.events`: OpenPipeline events.
53
+ * * `openpipeline.events.custom`: OpenPipeline custom events.
54
+ * * `openpipeline.events.security`: OpenPipeline security events.
55
+ * * `openpipeline.events.security.custom`: OpenPipeline custom security events.
52
56
  * * `bizevents.ingest`: Ingest bizevents.
53
57
  * * `analyzers.read`: Read analyzers.
54
58
  * * `analyzers.write`: Write & execute analyzers.
@@ -96,6 +100,7 @@ export interface ApiTokenUpdate {
96
100
  * * `javaScriptMappingFiles.read`: Read JavaScript mapping files.
97
101
  * * `javaScriptMappingFiles.write`: Write JavaScript mapping files.
98
102
  * * `extensionConfigurationActions.write`: Actions for extension monitoring configurations.
103
+ * * `adaptiveTrafficManagement.read`: Read sampling configuration for Adaptive Traffic Management.
99
104
  */
100
105
  scopes?: ApiTokenUpdateScopesItem[];
101
106
  }
@@ -27,5 +27,9 @@ export interface ComplexConstraint {
27
27
  * A list of properties (defined by IDs) that are used to check the constraint.
28
28
  */
29
29
  properties?: string[];
30
+ /**
31
+ * Whether to skip validation on a change made from the UI.
32
+ */
33
+ skipAsyncValidation?: boolean;
30
34
  type: ComplexConstraintType;
31
35
  }
@@ -7,6 +7,7 @@ export interface AsJson {
7
7
  maximumPropertyCount?: number;
8
8
  minimumPropertyCount?: number;
9
9
  properties?: string[];
10
+ skipAsyncValidation?: boolean;
10
11
  type: _ComplexConstraintTypeTransformation.AsJson;
11
12
  }
12
13
  export declare function fromJson($model: AsJson): ComplexConstraint;
@@ -31,6 +31,10 @@ export interface Constraint {
31
31
  * The regular expression pattern for valid string values.
32
32
  */
33
33
  pattern?: string;
34
+ /**
35
+ * Whether to skip validation on a change made from the UI.
36
+ */
37
+ skipAsyncValidation?: boolean;
34
38
  type: ConstraintType;
35
39
  /**
36
40
  * A list of properties for which the combination of values must be unique.
@@ -8,6 +8,7 @@ export interface AsJson {
8
8
  minLength?: number;
9
9
  minimum?: number;
10
10
  pattern?: string;
11
+ skipAsyncValidation?: boolean;
11
12
  type: _ConstraintTypeTransformation.AsJson;
12
13
  uniqueProperties?: string[];
13
14
  }
@@ -456,10 +456,6 @@ export * from './get-all-update-job-list-query-update-type';
456
456
  export * as _GetAllUpdateJobListQueryUpdateTypeTransformation from './get-all-update-job-list-query-update-type.transformation';
457
457
  export * from './get-environment-configuration-events-query-status';
458
458
  export * as _GetEnvironmentConfigurationEventsQueryStatusTransformation from './get-environment-configuration-events-query-status.transformation';
459
- export * from './get-execution-full-report-path-execution-id';
460
- export * as _GetExecutionFullReportPathExecutionIdTransformation from './get-execution-full-report-path-execution-id.transformation';
461
- export * from './get-execution-path-execution-id';
462
- export * as _GetExecutionPathExecutionIdTransformation from './get-execution-path-execution-id.transformation';
463
459
  export * from './get-execution-result-path-result-type';
464
460
  export * as _GetExecutionResultPathResultTypeTransformation from './get-execution-result-path-result-type.transformation';
465
461
  export * from './get-executions-query-execution-stage';
@@ -3,14 +3,58 @@
3
3
 
4
4
  The object might contain the following types of case-insensitive keys (the possible key values are listed below):
5
5
 
6
- * Timestamp:
6
+ * **Timestamp:**
7
7
  * The earliest timestamp for a log event is the current time minus 24 hours. If the log event contains a timestamp earlier than the current time minus 24 hours, the event is dropped.
8
8
  * The timestamp for a log event is not limited to future time. If the log event contains a timestamp later than 10 minutes in the future, the timestamp of the event will be overridden by the current time on the server.
9
9
  * The following formats are supported: UTC milliseconds, RFC3339, and RFC3164. For the missing timestamp, the current timestamp is used. For the unsupported timestamp format, the current timestamp is used, and the value of the unsupported timestamp format is stored in the not indexed `unparsed_timestamp` attribute.
10
- * Severity. If not set, `NONE` is used.
11
- * Content. If the content key is not set, the whole JSON is parsed as the content.
12
- * Semantic attribute. Only values of the `String` type are supported. Semantic attributes are indexed and can be used in queries. These are also displayed in aggregations (facets). If an unsupported key occurs, it is not indexed and can't be used in indexing and aggregations.
13
- * Automatic attribute. The dt.auth.origin attribute is automatically added to every log record ingested via API. This attribute is the public part of the API key that the log source authorizes to connect to the generic log ingest API.
10
+ * **Severity.** If not set, `NONE` is used.
11
+ * **Content.** If the content key is not set, the whole JSON is parsed as the content.
12
+ * **Semantic attribute.** Only values of the `String` type are supported. Semantic attributes are indexed and can be used in queries. These are also displayed in aggregations (facets). If an unsupported key occurs, it is not indexed and can't be used in indexing and aggregations.
13
+ * **Automatic attribute.** The dt.auth.origin attribute is automatically added to every log record ingested via API. This attribute is the public part of the API key that the log source authorizes to connect to the generic log ingest API.
14
+
15
+ <br/>
16
+
17
+ **Attributes structure**
18
+
19
+ Complex objects are flattened facilitating ease of handling, and a simpler representation. The following guidelines outline the process:
20
+
21
+ 1. The keys are concatenated using a dot (.) until a simple value is reached in the hierarchy. For example:
22
+
23
+ _Base JSON:_
24
+
25
+ ` {"test": { "attribute": {"one": "value 1", "two": "value 2"}}} `
26
+
27
+ _Result:_
28
+
29
+ ` {"test.attribute.one": "value 1", "test.attribute.two": "value 2" } `
30
+
31
+ 2. When an array is encountered, a multi-value attribute is created at that level. If there are non-simple values within the array, the JSON stringified value is maintained.
32
+
33
+ 3. Name conflicts are resolved as follows:
34
+
35
+ * In case of a name conflict, where a key is overwritten, it is prefixed with "overwritten". For example:
36
+
37
+ *Base JSON:*
38
+
39
+ ` {"host.name": "abc", "host": { "name": "xyz"}} `
40
+
41
+ *Result:*
42
+
43
+ ` {"host.name": "abc", "overwritten1.host.name": "xyz"} `
44
+
45
+ * If a second conflict arises, an index is added starting with 1:
46
+
47
+ *Base JSON:*
48
+
49
+ ` {"service.instance.id": "abc", "service": { "instance.id": "xyz", "instance": { "id": "123"}}} `
50
+
51
+ *Result:*
52
+
53
+ ` {"service.instance.id": "abc", "overwritten1.service.instance.id": "xyz", "overwritten2.service.instance.id": "123" } `
54
+
55
+ <br/>
56
+
57
+ **Limitations**
14
58
 
15
59
  The object value can be a single constant or, in case of semantic attribute, an array of constants. The length of the value is limited. Any content exceeding the limit is trimmed. Default limits:
16
60
 
@@ -8,6 +8,10 @@ export interface SchemaConstraintRestDto {
8
8
  * The ID of a custom validator.
9
9
  */
10
10
  customValidatorId?: string;
11
+ /**
12
+ * Whether to skip validation on a change made from the UI.
13
+ */
14
+ skipAsyncValidation?: boolean;
11
15
  type: SchemaConstraintRestDtoType;
12
16
  /**
13
17
  * The list of properties for which the combination of values needs to be unique
@@ -3,6 +3,7 @@ import * as _SchemaConstraintRestDtoTypeTransformation from './schema-constraint
3
3
  export interface AsJson {
4
4
  customMessage?: string;
5
5
  customValidatorId?: string;
6
+ skipAsyncValidation?: boolean;
6
7
  type: _SchemaConstraintRestDtoTypeTransformation.AsJson;
7
8
  uniqueProperties?: string[];
8
9
  }
@@ -13,7 +13,7 @@ export interface SyntheticMultiProtocolMonitorDto {
13
13
  /**
14
14
  * Monitor description
15
15
  */
16
- description: string;
16
+ description?: string;
17
17
  /**
18
18
  * The entity id of the monitor.
19
19
  */
@@ -5,7 +5,7 @@ import * as _SyntheticMultiProtocolMonitorStepDtoTransformation from './syntheti
5
5
  import * as _SyntheticTagWithSourceDtoTransformation from './synthetic-tag-with-source-dto.transformation';
6
6
  export interface AsJson {
7
7
  active?: boolean;
8
- description: string;
8
+ description?: string;
9
9
  entityId: string;
10
10
  frequencyMin: number;
11
11
  locations: string[];
@@ -13,7 +13,7 @@ export interface SyntheticMultiProtocolMonitorUpdateDto {
13
13
  /**
14
14
  * Monitor description
15
15
  */
16
- description: string;
16
+ description?: string;
17
17
  /**
18
18
  * The frequency of the monitor, in minutes.
19
19
  */
@@ -5,7 +5,7 @@ import * as _SyntheticMultiProtocolMonitorUpdateDtoTypeTransformation from './sy
5
5
  import * as _SyntheticTagWithSourceDtoTransformation from './synthetic-tag-with-source-dto.transformation';
6
6
  export interface AsJson {
7
7
  active?: boolean;
8
- description: string;
8
+ description?: string;
9
9
  frequencyMin?: number;
10
10
  locations: string[];
11
11
  name: string;
@@ -1,2 +1,2 @@
1
1
  export { AbortController, AbortSignal, BaseError, Binary, BinaryFormDataRequestField, BinaryFormDataResponseField, DataTypeError, DataTypes, FormDataRequestBody, FormDataRequestField, FormDataResponseBody, FormDataResponseField, Headers, HttpClient, HttpClientAbortError, HttpClientNetworkError, HttpClientRequestError, HttpClientRequestOptions, HttpClientResponse, HttpClientResponseError, JsonFormDataRequestField, RequestBodyTypes, ResponseBodyTypes, StatusValidator, TextFormDataRequestField, TextFormDataResponseField, UnsupportedOperationError, isHttpClientResponseError, isHttpClientAbortError, isHttpClientNetworkError, isHttpClientRequestError, } from './lib/types';
2
- export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';
2
+ export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, OAuthHttpClient as _OAuthHttpClient, OAuthHttpClientConfig as _OAuthHttpClientConfig, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';
@@ -8,4 +8,5 @@ export * from './http-client-abort-error';
8
8
  export * from './http-client-request-error';
9
9
  export * from './http-client-response';
10
10
  export * from './http-client-response-error';
11
+ export * from './oauth-http-client';
11
12
  export * from './unsupported-operation-error';
@@ -0,0 +1,41 @@
1
+ import * as types from '../types';
2
+ /**
3
+ * DO NOT USE - internal use only.
4
+ */
5
+ export interface OAuthHttpClientConfig {
6
+ clientId: string;
7
+ secret: string;
8
+ scopes: string[];
9
+ environmentUrl: string;
10
+ authUrl: string;
11
+ }
12
+ export interface OAuthTokenResponse {
13
+ scope: string;
14
+ token_type: string;
15
+ expires_in: number;
16
+ access_token: string;
17
+ }
18
+ /**
19
+ * DO NOT USE - internal use only.
20
+ */
21
+ export declare class OAuthToken {
22
+ private readonly _scope;
23
+ private readonly _tokenType;
24
+ private readonly _expirationDate;
25
+ private readonly _accessToken;
26
+ constructor(oauthTokenResponse: OAuthTokenResponse);
27
+ get scope(): string;
28
+ get tokenType(): string;
29
+ isExpired(): boolean;
30
+ get accessToken(): string;
31
+ }
32
+ /**
33
+ * DO NOT USE - internal use only.
34
+ */
35
+ export declare class OAuthHttpClient implements types.HttpClient {
36
+ private readonly config;
37
+ private oauthToken?;
38
+ constructor(config: OAuthHttpClientConfig);
39
+ send<T extends keyof types.RequestBodyTypes = 'json'>(options: types.HttpClientRequestOptions<T>): Promise<types.HttpClientResponse>;
40
+ private requestToken;
41
+ }
@@ -1,5 +0,0 @@
1
- /**
2
- *
3
- * @typedef {string | number} GetExecutionFullReportPathExecutionId
4
- */
5
- export declare type GetExecutionFullReportPathExecutionId = string | number;
@@ -1,4 +0,0 @@
1
- import { GetExecutionFullReportPathExecutionId } from './get-execution-full-report-path-execution-id';
2
- export declare type AsJson = string | number;
3
- export declare function fromJson($model: AsJson): any;
4
- export declare function toJson($model: GetExecutionFullReportPathExecutionId): any;
@@ -1,5 +0,0 @@
1
- /**
2
- *
3
- * @typedef {string | number} GetExecutionPathExecutionId
4
- */
5
- export declare type GetExecutionPathExecutionId = string | number;
@@ -1,4 +0,0 @@
1
- import { GetExecutionPathExecutionId } from './get-execution-path-execution-id';
2
- export declare type AsJson = string | number;
3
- export declare function fromJson($model: AsJson): any;
4
- export declare function toJson($model: GetExecutionPathExecutionId): any;