@dynatrace-sdk/client-classic-environment-v2 0.6.4 → 0.6.8
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.
- package/CHANGELOG.md +27 -0
- package/README.md +39 -0
- package/cjs/index.js +3626 -814
- package/docs/DOCS.md +9170 -4780
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3626 -814
- package/package.json +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts +5 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts +8 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts +14 -10
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts +162 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-api.d.ts +8 -7
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts +25 -11
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts +21 -21
- package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts +59 -0
- package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/apis/security-problems-api.d.ts +77 -12
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts +3 -3
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts +5 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-created.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update-scopes-item.d.ts +0 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts +5 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/asset-schema-details-dto.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category-list.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/category.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/comments-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/complex-constraint.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint-violation-parameter-location.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/credentials-id.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-dto.d.ts +38 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts +24 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts +43 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/datasource-definition.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/deletion-constraint.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block-type.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts +36 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-value.d.ts +20 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-settings-values-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-icon.d.ts +8 -8
- package/types/packages/client/classic-environment-v2/src/lib/models/entity-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/entity.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/enum-value.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/error.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-evidence.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/event-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-properties-list.d.ts +35 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-details.d.ts +13 -16
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event-type.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/event.d.ts +23 -23
- package/types/packages/client/classic-environment-v2/src/lib/models/execution-simple-results.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/exported-log-record-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-assets-dto.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-feature-sets.d.ts +15 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-notes.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts +69 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts +28 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config-type.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-config.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault-source-auth-method.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/external-vault.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/filter.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/filtered-counts-dto.d.ts +77 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/global-counts-dto.d.ts +72 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts +27 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +57 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/invocation.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts +98 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-list.d.ts +32 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item-overview.d.ts +82 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/item.d.ts +12 -12
- package/types/packages/client/classic-environment-v2/src/lib/models/list-items-query-item-type.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/log-record.d.ts +4 -4
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-data.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-default-aggregation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-descriptor.d.ts +45 -45
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-ingest-error.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/metric-series-collection.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-state-param.d.ts +22 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-severity.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +48 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +29 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-states.d.ts +23 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/network-zone.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/objects-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/precondition.d.ts +13 -13
- package/types/packages/client/classic-environment-v2/src/lib/models/problem.d.ts +23 -23
- package/types/packages/client/classic-environment-v2/src/lib/models/property-definition.d.ts +18 -18
- package/types/packages/client/classic-environment-v2/src/lib/models/registered-extension-result-dto.d.ts +19 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item-type.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/related-item.d.ts +33 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/release-instance.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/release.d.ts +15 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/releases.d.ts +10 -10
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary-reason.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-item-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/rollup.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts +11 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/schema-type.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary-reason.d.ts +13 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-bulk-muting-summary.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-events-list.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problem.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-reason.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-reason.d.ts +12 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute-response.d.ts +18 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-unmute.d.ts +25 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +24 -17
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +14 -14
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object.d.ts +27 -22
- package/types/packages/client/classic-environment-v2/src/lib/models/sl-os.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/slo-burn-rate.d.ts +7 -7
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +47 -47
- package/types/packages/client/classic-environment-v2/src/lib/models/software-techs.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/success.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-processing-mode.d.ts +16 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution-request-monitor.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/technology-details.d.ts +17 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-customization.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-expandable-section-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/ui-tab-group-customization.d.ts +5 -5
- package/types/packages/client/classic-environment-v2/src/lib/models/update-job.d.ts +15 -15
- package/types/packages/client/classic-environment-v2/src/lib/models/upload-metadata-for-extension-body.d.ts +25 -0
- package/types/packages/platform/error-handlers/src/lib/add-global-error-serializer.d.ts +0 -1
- package/types/packages/platform/error-handlers/src/lib/types/index.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/event-property-detail.d.ts +0 -32
package/types/packages/client/classic-environment-v2/src/lib/models/remediation-items-bulk-mute.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { RemediationItemsBulkMuteReason, _RemediationItemsBulkMuteReasonTransformation } from './remediation-items-bulk-mute-reason';
|
|
2
|
+
/**
|
|
3
|
+
* Information on muting several remediation items.
|
|
4
|
+
*/
|
|
5
|
+
export interface RemediationItemsBulkMute {
|
|
6
|
+
/**
|
|
7
|
+
* The ids of the remediation items to be muted.
|
|
8
|
+
*/
|
|
9
|
+
remediationItemIds: string[];
|
|
10
|
+
reason: RemediationItemsBulkMuteReason;
|
|
11
|
+
/**
|
|
12
|
+
* A comment about the muting reason.
|
|
13
|
+
*/
|
|
14
|
+
comment?: string;
|
|
15
|
+
}
|
|
16
|
+
/** @ignore */
|
|
17
|
+
export declare namespace _RemediationItemsBulkMuteTransformation {
|
|
18
|
+
interface AsJson {
|
|
19
|
+
remediationItemIds: string[];
|
|
20
|
+
reason: _RemediationItemsBulkMuteReasonTransformation.AsJson;
|
|
21
|
+
comment?: string;
|
|
22
|
+
}
|
|
23
|
+
function fromJson(model: AsJson): RemediationItemsBulkMute;
|
|
24
|
+
function toJson(model: RemediationItemsBulkMute): AsJson;
|
|
25
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The reason for un-muting the remediation items.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum RemediationItemsBulkUnmuteReason {
|
|
5
|
+
Affected = "AFFECTED"
|
|
6
|
+
}
|
|
7
|
+
/** @ignore */
|
|
8
|
+
export declare namespace _RemediationItemsBulkUnmuteReasonTransformation {
|
|
9
|
+
type AsJson = RemediationItemsBulkUnmuteReason;
|
|
10
|
+
const toJson: (value: RemediationItemsBulkUnmuteReason) => AsJson;
|
|
11
|
+
const fromJson: (value: AsJson) => RemediationItemsBulkUnmuteReason;
|
|
12
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { RemediationItemMutingSummary, _RemediationItemMutingSummaryTransformation } from './remediation-item-muting-summary';
|
|
2
|
+
/**
|
|
3
|
+
* Response of un-muting several remediation items.
|
|
4
|
+
*/
|
|
5
|
+
export interface RemediationItemsBulkUnmuteResponse {
|
|
6
|
+
/**
|
|
7
|
+
* The summary of which remediation items were un-muted and which already were un-muted previously.
|
|
8
|
+
*/
|
|
9
|
+
summary: RemediationItemMutingSummary[];
|
|
10
|
+
}
|
|
11
|
+
/** @ignore */
|
|
12
|
+
export declare namespace _RemediationItemsBulkUnmuteResponseTransformation {
|
|
13
|
+
interface AsJson {
|
|
14
|
+
summary: _RemediationItemMutingSummaryTransformation.AsJson[];
|
|
15
|
+
}
|
|
16
|
+
function fromJson(model: AsJson): RemediationItemsBulkUnmuteResponse;
|
|
17
|
+
function toJson(model: RemediationItemsBulkUnmuteResponse): AsJson;
|
|
18
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { RemediationItemsBulkUnmuteReason, _RemediationItemsBulkUnmuteReasonTransformation } from './remediation-items-bulk-unmute-reason';
|
|
2
|
+
/**
|
|
3
|
+
* Information on un-muting several remediation items.
|
|
4
|
+
*/
|
|
5
|
+
export interface RemediationItemsBulkUnmute {
|
|
6
|
+
/**
|
|
7
|
+
* The ids of the remediation items to be un-muted.
|
|
8
|
+
*/
|
|
9
|
+
remediationItemIds: string[];
|
|
10
|
+
reason: RemediationItemsBulkUnmuteReason;
|
|
11
|
+
/**
|
|
12
|
+
* A comment about the un-muting reason.
|
|
13
|
+
*/
|
|
14
|
+
comment?: string;
|
|
15
|
+
}
|
|
16
|
+
/** @ignore */
|
|
17
|
+
export declare namespace _RemediationItemsBulkUnmuteTransformation {
|
|
18
|
+
interface AsJson {
|
|
19
|
+
remediationItemIds: string[];
|
|
20
|
+
reason: _RemediationItemsBulkUnmuteReasonTransformation.AsJson;
|
|
21
|
+
comment?: string;
|
|
22
|
+
}
|
|
23
|
+
function fromJson(model: AsJson): RemediationItemsBulkUnmute;
|
|
24
|
+
function toJson(model: RemediationItemsBulkUnmute): AsJson;
|
|
25
|
+
}
|
|
@@ -3,14 +3,14 @@ import { RollupType, _RollupTypeTransformation } from './rollup-type';
|
|
|
3
3
|
* A way of viewing a series as a single value for the purpose of sorting or series-based filters.
|
|
4
4
|
*/
|
|
5
5
|
export interface Rollup {
|
|
6
|
-
type?: RollupType;
|
|
7
6
|
parameter?: number;
|
|
7
|
+
type?: RollupType;
|
|
8
8
|
}
|
|
9
9
|
/** @ignore */
|
|
10
10
|
export declare namespace _RollupTransformation {
|
|
11
11
|
interface AsJson {
|
|
12
|
-
type?: _RollupTypeTransformation.AsJson;
|
|
13
12
|
parameter?: number;
|
|
13
|
+
type?: _RollupTypeTransformation.AsJson;
|
|
14
14
|
}
|
|
15
15
|
function fromJson(model: AsJson): Rollup;
|
|
16
16
|
function toJson(model: Rollup): AsJson;
|
package/types/packages/client/classic-environment-v2/src/lib/models/schema-definition-rest-dto.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { ComplexConstraint, _ComplexConstraintTransformation } from './complex-constraint';
|
|
2
|
+
import { DeletionConstraint, _DeletionConstraintTransformation } from './deletion-constraint';
|
|
2
3
|
import { SchemaDefinitionRestDtoEnums, _SchemaDefinitionRestDtoEnumsTransformation } from './schema-definition-rest-dto-enums';
|
|
3
4
|
import { SchemaDefinitionRestDtoMetadata, _SchemaDefinitionRestDtoMetadataTransformation } from './schema-definition-rest-dto-metadata';
|
|
4
5
|
import { SchemaDefinitionRestDtoProperties, _SchemaDefinitionRestDtoPropertiesTransformation } from './schema-definition-rest-dto-properties';
|
|
@@ -53,6 +54,10 @@ export interface SchemaDefinitionRestDto {
|
|
|
53
54
|
* A list of scopes where the schema can be used.
|
|
54
55
|
*/
|
|
55
56
|
allowedScopes: string[];
|
|
57
|
+
/**
|
|
58
|
+
* Name of the key property in this schema.
|
|
59
|
+
*/
|
|
60
|
+
keyProperty?: string;
|
|
56
61
|
enums: SchemaDefinitionRestDtoEnums;
|
|
57
62
|
types: SchemaDefinitionRestDtoTypes;
|
|
58
63
|
properties: SchemaDefinitionRestDtoProperties;
|
|
@@ -61,6 +66,10 @@ export interface SchemaDefinitionRestDto {
|
|
|
61
66
|
*/
|
|
62
67
|
constraints?: ComplexConstraint[];
|
|
63
68
|
metadata?: SchemaDefinitionRestDtoMetadata;
|
|
69
|
+
/**
|
|
70
|
+
* Constraints limiting the values to be deleted.
|
|
71
|
+
*/
|
|
72
|
+
deletionConstraints?: DeletionConstraint[];
|
|
64
73
|
uiCustomization?: UiCustomization;
|
|
65
74
|
}
|
|
66
75
|
/** @ignore */
|
|
@@ -77,11 +86,13 @@ export declare namespace _SchemaDefinitionRestDtoTransformation {
|
|
|
77
86
|
ordered?: boolean;
|
|
78
87
|
maxObjects: number;
|
|
79
88
|
allowedScopes: string[];
|
|
89
|
+
keyProperty?: string;
|
|
80
90
|
enums: _SchemaDefinitionRestDtoEnumsTransformation.AsJson;
|
|
81
91
|
types: _SchemaDefinitionRestDtoTypesTransformation.AsJson;
|
|
82
92
|
properties: _SchemaDefinitionRestDtoPropertiesTransformation.AsJson;
|
|
83
93
|
constraints?: _ComplexConstraintTransformation.AsJson[];
|
|
84
94
|
metadata?: _SchemaDefinitionRestDtoMetadataTransformation.AsJson;
|
|
95
|
+
deletionConstraints?: _DeletionConstraintTransformation.AsJson[];
|
|
85
96
|
uiCustomization?: _UiCustomizationTransformation.AsJson;
|
|
86
97
|
}
|
|
87
98
|
function fromJson(model: AsJson): SchemaDefinitionRestDto;
|
|
@@ -22,11 +22,11 @@ export interface SchemaType {
|
|
|
22
22
|
* The version of the type.
|
|
23
23
|
*/
|
|
24
24
|
version: string;
|
|
25
|
-
properties: SchemaTypeProperties;
|
|
26
25
|
/**
|
|
27
26
|
* A list of constraints limiting the values to be accepted.
|
|
28
27
|
*/
|
|
29
28
|
constraints?: ComplexConstraint[];
|
|
29
|
+
properties: SchemaTypeProperties;
|
|
30
30
|
/**
|
|
31
31
|
* An extended description and/or links to documentation.
|
|
32
32
|
*/
|
|
@@ -47,8 +47,8 @@ export declare namespace _SchemaTypeTransformation {
|
|
|
47
47
|
searchPattern?: string;
|
|
48
48
|
versionInfo?: string;
|
|
49
49
|
version: string;
|
|
50
|
-
properties: _SchemaTypePropertiesTransformation.AsJson;
|
|
51
50
|
constraints?: _ComplexConstraintTransformation.AsJson[];
|
|
51
|
+
properties: _SchemaTypePropertiesTransformation.AsJson;
|
|
52
52
|
documentation: string;
|
|
53
53
|
displayName?: string;
|
|
54
54
|
description: string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Contains a reason, in case the requested operation was not executed.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum SecurityProblemBulkMutingSummaryReason {
|
|
5
|
+
AlreadyMuted = "ALREADY_MUTED",
|
|
6
|
+
AlreadyUnmuted = "ALREADY_UNMUTED"
|
|
7
|
+
}
|
|
8
|
+
/** @ignore */
|
|
9
|
+
export declare namespace _SecurityProblemBulkMutingSummaryReasonTransformation {
|
|
10
|
+
type AsJson = SecurityProblemBulkMutingSummaryReason;
|
|
11
|
+
const toJson: (value: SecurityProblemBulkMutingSummaryReason) => AsJson;
|
|
12
|
+
const fromJson: (value: AsJson) => SecurityProblemBulkMutingSummaryReason;
|
|
13
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { SecurityProblemBulkMutingSummaryReason, _SecurityProblemBulkMutingSummaryReasonTransformation } from './security-problem-bulk-muting-summary-reason';
|
|
2
|
+
/**
|
|
3
|
+
* Summary of (un-)muting a security problem.
|
|
4
|
+
*/
|
|
5
|
+
export interface SecurityProblemBulkMutingSummary {
|
|
6
|
+
/**
|
|
7
|
+
* The id of the security problem that was (un-)muted.
|
|
8
|
+
*/
|
|
9
|
+
securityProblemId: string;
|
|
10
|
+
/**
|
|
11
|
+
* Whether a mute state change for the given security problem was triggered by this request.
|
|
12
|
+
*/
|
|
13
|
+
muteStateChangeTriggered: boolean;
|
|
14
|
+
reason?: SecurityProblemBulkMutingSummaryReason;
|
|
15
|
+
}
|
|
16
|
+
/** @ignore */
|
|
17
|
+
export declare namespace _SecurityProblemBulkMutingSummaryTransformation {
|
|
18
|
+
interface AsJson {
|
|
19
|
+
securityProblemId: string;
|
|
20
|
+
muteStateChangeTriggered: boolean;
|
|
21
|
+
reason?: _SecurityProblemBulkMutingSummaryReasonTransformation.AsJson;
|
|
22
|
+
}
|
|
23
|
+
function fromJson(model: AsJson): SecurityProblemBulkMutingSummary;
|
|
24
|
+
function toJson(model: SecurityProblemBulkMutingSummary): AsJson;
|
|
25
|
+
}
|
package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-details.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { CodeLevelVulnerabilityDetails, _CodeLevelVulnerabilityDetailsTransformation } from './code-level-vulnerability-details';
|
|
2
|
+
import { FilteredCountsDto, _FilteredCountsDtoTransformation } from './filtered-counts-dto';
|
|
3
|
+
import { GlobalCountsDto, _GlobalCountsDtoTransformation } from './global-counts-dto';
|
|
2
4
|
import { ManagementZone, _ManagementZoneTransformation } from './management-zone';
|
|
3
5
|
import { RelatedAttacksList, _RelatedAttacksListTransformation } from './related-attacks-list';
|
|
4
6
|
import { RelatedEntitiesList, _RelatedEntitiesListTransformation } from './related-entities-list';
|
|
@@ -65,6 +67,8 @@ export interface SecurityProblemDetails {
|
|
|
65
67
|
* A list of CVE IDs of the security problem.
|
|
66
68
|
*/
|
|
67
69
|
cveIds?: string[];
|
|
70
|
+
globalCounts?: GlobalCountsDto;
|
|
71
|
+
filteredCounts?: FilteredCountsDto;
|
|
68
72
|
codeLevelVulnerabilityDetails?: CodeLevelVulnerabilityDetails;
|
|
69
73
|
/**
|
|
70
74
|
* An ordered (newest first) list of events of the security problem.
|
|
@@ -126,6 +130,8 @@ export declare namespace _SecurityProblemDetailsTransformation {
|
|
|
126
130
|
riskAssessment?: _RiskAssessmentTransformation.AsJson;
|
|
127
131
|
managementZones?: _ManagementZoneTransformation.AsJson[];
|
|
128
132
|
cveIds?: string[];
|
|
133
|
+
globalCounts?: _GlobalCountsDtoTransformation.AsJson;
|
|
134
|
+
filteredCounts?: _FilteredCountsDtoTransformation.AsJson;
|
|
129
135
|
codeLevelVulnerabilityDetails?: _CodeLevelVulnerabilityDetailsTransformation.AsJson;
|
|
130
136
|
events?: _SecurityProblemEventTransformation.AsJson[];
|
|
131
137
|
vulnerableComponents?: _VulnerableComponentTransformation.AsJson[];
|
|
@@ -11,24 +11,24 @@ export interface SecurityProblemEventsList {
|
|
|
11
11
|
* The total number of entries in the result.
|
|
12
12
|
*/
|
|
13
13
|
totalCount: number;
|
|
14
|
+
/**
|
|
15
|
+
* The number of entries per page.
|
|
16
|
+
*/
|
|
17
|
+
pageSize?: number;
|
|
14
18
|
/**
|
|
15
19
|
* The cursor for the next page of results. Has the value of `null` on the last page.
|
|
16
20
|
*
|
|
17
21
|
* Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
|
|
18
22
|
*/
|
|
19
23
|
nextPageKey?: string;
|
|
20
|
-
/**
|
|
21
|
-
* The number of entries per page.
|
|
22
|
-
*/
|
|
23
|
-
pageSize?: number;
|
|
24
24
|
}
|
|
25
25
|
/** @ignore */
|
|
26
26
|
export declare namespace _SecurityProblemEventsListTransformation {
|
|
27
27
|
interface AsJson {
|
|
28
28
|
events?: _SecurityProblemEventTransformation.AsJson[];
|
|
29
29
|
totalCount: number;
|
|
30
|
-
nextPageKey?: string;
|
|
31
30
|
pageSize?: number;
|
|
31
|
+
nextPageKey?: string;
|
|
32
32
|
}
|
|
33
33
|
function fromJson(model: AsJson): SecurityProblemEventsList;
|
|
34
34
|
function toJson(model: SecurityProblemEventsList): AsJson;
|
package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-mute.d.ts
CHANGED
|
@@ -7,13 +7,13 @@ export interface SecurityProblemMute {
|
|
|
7
7
|
/**
|
|
8
8
|
* A comment about the muting reason.
|
|
9
9
|
*/
|
|
10
|
-
comment
|
|
10
|
+
comment?: string;
|
|
11
11
|
}
|
|
12
12
|
/** @ignore */
|
|
13
13
|
export declare namespace _SecurityProblemMuteTransformation {
|
|
14
14
|
interface AsJson {
|
|
15
15
|
reason: _SecurityProblemMuteReasonTransformation.AsJson;
|
|
16
|
-
comment
|
|
16
|
+
comment?: string;
|
|
17
17
|
}
|
|
18
18
|
function fromJson(model: AsJson): SecurityProblemMute;
|
|
19
19
|
function toJson(model: SecurityProblemMute): AsJson;
|
package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts
CHANGED
|
@@ -7,13 +7,13 @@ export interface SecurityProblemUnmute {
|
|
|
7
7
|
/**
|
|
8
8
|
* A comment about the un-muting reason.
|
|
9
9
|
*/
|
|
10
|
-
comment
|
|
10
|
+
comment?: string;
|
|
11
11
|
}
|
|
12
12
|
/** @ignore */
|
|
13
13
|
export declare namespace _SecurityProblemUnmuteTransformation {
|
|
14
14
|
interface AsJson {
|
|
15
15
|
reason: _SecurityProblemUnmuteReasonTransformation.AsJson;
|
|
16
|
-
comment
|
|
16
|
+
comment?: string;
|
|
17
17
|
}
|
|
18
18
|
function fromJson(model: AsJson): SecurityProblemUnmute;
|
|
19
19
|
function toJson(model: SecurityProblemUnmute): AsJson;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { CodeLevelVulnerabilityDetails, _CodeLevelVulnerabilityDetailsTransformation } from './code-level-vulnerability-details';
|
|
2
|
+
import { GlobalCountsDto, _GlobalCountsDtoTransformation } from './global-counts-dto';
|
|
2
3
|
import { ManagementZone, _ManagementZoneTransformation } from './management-zone';
|
|
3
4
|
import { RiskAssessment, _RiskAssessmentTransformation } from './risk-assessment';
|
|
4
5
|
import { SecurityProblemStatus, _SecurityProblemStatusTransformation } from './security-problem-status';
|
|
@@ -56,6 +57,7 @@ export interface SecurityProblem {
|
|
|
56
57
|
* A list of CVE IDs of the security problem.
|
|
57
58
|
*/
|
|
58
59
|
cveIds?: string[];
|
|
60
|
+
globalCounts?: GlobalCountsDto;
|
|
59
61
|
codeLevelVulnerabilityDetails?: CodeLevelVulnerabilityDetails;
|
|
60
62
|
}
|
|
61
63
|
/** @ignore */
|
|
@@ -76,6 +78,7 @@ export declare namespace _SecurityProblemTransformation {
|
|
|
76
78
|
riskAssessment?: _RiskAssessmentTransformation.AsJson;
|
|
77
79
|
managementZones?: _ManagementZoneTransformation.AsJson[];
|
|
78
80
|
cveIds?: string[];
|
|
81
|
+
globalCounts?: _GlobalCountsDtoTransformation.AsJson;
|
|
79
82
|
codeLevelVulnerabilityDetails?: _CodeLevelVulnerabilityDetailsTransformation.AsJson;
|
|
80
83
|
}
|
|
81
84
|
function fromJson(model: AsJson): SecurityProblem;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The reason for muting the security problems.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum SecurityProblemsBulkMuteReason {
|
|
5
|
+
ConfigurationNotAffected = "CONFIGURATION_NOT_AFFECTED",
|
|
6
|
+
FalsePositive = "FALSE_POSITIVE",
|
|
7
|
+
Ignore = "IGNORE",
|
|
8
|
+
Other = "OTHER",
|
|
9
|
+
VulnerableCodeNotInUse = "VULNERABLE_CODE_NOT_IN_USE"
|
|
10
|
+
}
|
|
11
|
+
/** @ignore */
|
|
12
|
+
export declare namespace _SecurityProblemsBulkMuteReasonTransformation {
|
|
13
|
+
type AsJson = SecurityProblemsBulkMuteReason;
|
|
14
|
+
const toJson: (value: SecurityProblemsBulkMuteReason) => AsJson;
|
|
15
|
+
const fromJson: (value: AsJson) => SecurityProblemsBulkMuteReason;
|
|
16
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { SecurityProblemBulkMutingSummary, _SecurityProblemBulkMutingSummaryTransformation } from './security-problem-bulk-muting-summary';
|
|
2
|
+
/**
|
|
3
|
+
* Response of muting several security problems.
|
|
4
|
+
*/
|
|
5
|
+
export interface SecurityProblemsBulkMuteResponse {
|
|
6
|
+
/**
|
|
7
|
+
* The summary of which security problems were muted and which already were muted previously.
|
|
8
|
+
*/
|
|
9
|
+
summary: SecurityProblemBulkMutingSummary[];
|
|
10
|
+
}
|
|
11
|
+
/** @ignore */
|
|
12
|
+
export declare namespace _SecurityProblemsBulkMuteResponseTransformation {
|
|
13
|
+
interface AsJson {
|
|
14
|
+
summary: _SecurityProblemBulkMutingSummaryTransformation.AsJson[];
|
|
15
|
+
}
|
|
16
|
+
function fromJson(model: AsJson): SecurityProblemsBulkMuteResponse;
|
|
17
|
+
function toJson(model: SecurityProblemsBulkMuteResponse): AsJson;
|
|
18
|
+
}
|
package/types/packages/client/classic-environment-v2/src/lib/models/security-problems-bulk-mute.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { SecurityProblemsBulkMuteReason, _SecurityProblemsBulkMuteReasonTransformation } from './security-problems-bulk-mute-reason';
|
|
2
|
+
/**
|
|
3
|
+
* Information on muting several security problems.
|
|
4
|
+
*/
|
|
5
|
+
export interface SecurityProblemsBulkMute {
|
|
6
|
+
/**
|
|
7
|
+
* The ids of the security problems to be muted.
|
|
8
|
+
*/
|
|
9
|
+
securityProblemIds: string[];
|
|
10
|
+
reason: SecurityProblemsBulkMuteReason;
|
|
11
|
+
/**
|
|
12
|
+
* A comment about the muting reason.
|
|
13
|
+
*/
|
|
14
|
+
comment?: string;
|
|
15
|
+
}
|
|
16
|
+
/** @ignore */
|
|
17
|
+
export declare namespace _SecurityProblemsBulkMuteTransformation {
|
|
18
|
+
interface AsJson {
|
|
19
|
+
securityProblemIds: string[];
|
|
20
|
+
reason: _SecurityProblemsBulkMuteReasonTransformation.AsJson;
|
|
21
|
+
comment?: string;
|
|
22
|
+
}
|
|
23
|
+
function fromJson(model: AsJson): SecurityProblemsBulkMute;
|
|
24
|
+
function toJson(model: SecurityProblemsBulkMute): AsJson;
|
|
25
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The reason for un-muting the security problems.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum SecurityProblemsBulkUnmuteReason {
|
|
5
|
+
Affected = "AFFECTED"
|
|
6
|
+
}
|
|
7
|
+
/** @ignore */
|
|
8
|
+
export declare namespace _SecurityProblemsBulkUnmuteReasonTransformation {
|
|
9
|
+
type AsJson = SecurityProblemsBulkUnmuteReason;
|
|
10
|
+
const toJson: (value: SecurityProblemsBulkUnmuteReason) => AsJson;
|
|
11
|
+
const fromJson: (value: AsJson) => SecurityProblemsBulkUnmuteReason;
|
|
12
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { SecurityProblemBulkMutingSummary, _SecurityProblemBulkMutingSummaryTransformation } from './security-problem-bulk-muting-summary';
|
|
2
|
+
/**
|
|
3
|
+
* Response of un-muting several security problems.
|
|
4
|
+
*/
|
|
5
|
+
export interface SecurityProblemsBulkUnmuteResponse {
|
|
6
|
+
/**
|
|
7
|
+
* The summary of which security problems were un-muted and which already were un-muted previously.
|
|
8
|
+
*/
|
|
9
|
+
summary: SecurityProblemBulkMutingSummary[];
|
|
10
|
+
}
|
|
11
|
+
/** @ignore */
|
|
12
|
+
export declare namespace _SecurityProblemsBulkUnmuteResponseTransformation {
|
|
13
|
+
interface AsJson {
|
|
14
|
+
summary: _SecurityProblemBulkMutingSummaryTransformation.AsJson[];
|
|
15
|
+
}
|
|
16
|
+
function fromJson(model: AsJson): SecurityProblemsBulkUnmuteResponse;
|
|
17
|
+
function toJson(model: SecurityProblemsBulkUnmuteResponse): AsJson;
|
|
18
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { SecurityProblemsBulkUnmuteReason, _SecurityProblemsBulkUnmuteReasonTransformation } from './security-problems-bulk-unmute-reason';
|
|
2
|
+
/**
|
|
3
|
+
* Information on un-muting several security problems.
|
|
4
|
+
*/
|
|
5
|
+
export interface SecurityProblemsBulkUnmute {
|
|
6
|
+
/**
|
|
7
|
+
* The ids of the security problems to be un-muted.
|
|
8
|
+
*/
|
|
9
|
+
securityProblemIds: string[];
|
|
10
|
+
reason: SecurityProblemsBulkUnmuteReason;
|
|
11
|
+
/**
|
|
12
|
+
* A comment about the un-muting reason.
|
|
13
|
+
*/
|
|
14
|
+
comment?: string;
|
|
15
|
+
}
|
|
16
|
+
/** @ignore */
|
|
17
|
+
export declare namespace _SecurityProblemsBulkUnmuteTransformation {
|
|
18
|
+
interface AsJson {
|
|
19
|
+
securityProblemIds: string[];
|
|
20
|
+
reason: _SecurityProblemsBulkUnmuteReasonTransformation.AsJson;
|
|
21
|
+
comment?: string;
|
|
22
|
+
}
|
|
23
|
+
function fromJson(model: AsJson): SecurityProblemsBulkUnmute;
|
|
24
|
+
function toJson(model: SecurityProblemsBulkUnmute): AsJson;
|
|
25
|
+
}
|
package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts
CHANGED
|
@@ -4,43 +4,50 @@ import { SettingsValue, _SettingsValueTransformation } from './settings-value';
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SettingsObjectCreate {
|
|
6
6
|
/**
|
|
7
|
-
* The
|
|
8
|
-
*
|
|
9
|
-
* If `null`, the new object will be placed in the last position.
|
|
10
|
-
*
|
|
11
|
-
* If set to empty string, the new object will be placed in the first position.
|
|
7
|
+
* The ID of the settings object that should be replaced.
|
|
12
8
|
*
|
|
13
|
-
* Only applicable
|
|
9
|
+
* Only applicable if an external identifier is provided.
|
|
14
10
|
*/
|
|
15
|
-
|
|
11
|
+
objectId?: string;
|
|
12
|
+
/**
|
|
13
|
+
* The schema on which the object is based.
|
|
14
|
+
*/
|
|
15
|
+
schemaId: string;
|
|
16
16
|
/**
|
|
17
17
|
* External identifier for the object being created
|
|
18
18
|
*/
|
|
19
19
|
externalId?: string;
|
|
20
20
|
/**
|
|
21
|
-
* The
|
|
21
|
+
* The scope that the object targets.
|
|
22
|
+
*
|
|
23
|
+
* If omitted on creation of a new object and if the schema supports scope generation, the operation will generate a scope from the provided value.
|
|
22
24
|
*/
|
|
23
|
-
|
|
25
|
+
scope?: string;
|
|
24
26
|
/**
|
|
25
|
-
* The schema on which the object is based.
|
|
27
|
+
* The version of the schema on which the object is based.
|
|
26
28
|
*/
|
|
27
|
-
|
|
29
|
+
schemaVersion?: string;
|
|
28
30
|
/**
|
|
29
|
-
* The
|
|
31
|
+
* The position of the new object. The new object will be added after the specified one.
|
|
30
32
|
*
|
|
31
|
-
* If
|
|
33
|
+
* If `null`, the new object will be placed in the last position.
|
|
34
|
+
*
|
|
35
|
+
* If set to empty string, the new object will be placed in the first position.
|
|
36
|
+
*
|
|
37
|
+
* Only applicable for objects based on schemas with ordered objects (schema's `ordered` parameter is set to `true`).
|
|
32
38
|
*/
|
|
33
|
-
|
|
39
|
+
insertAfter?: string;
|
|
34
40
|
value: SettingsValue;
|
|
35
41
|
}
|
|
36
42
|
/** @ignore */
|
|
37
43
|
export declare namespace _SettingsObjectCreateTransformation {
|
|
38
44
|
interface AsJson {
|
|
39
|
-
|
|
40
|
-
externalId?: string;
|
|
41
|
-
schemaVersion?: string;
|
|
45
|
+
objectId?: string;
|
|
42
46
|
schemaId: string;
|
|
47
|
+
externalId?: string;
|
|
43
48
|
scope?: string;
|
|
49
|
+
schemaVersion?: string;
|
|
50
|
+
insertAfter?: string;
|
|
44
51
|
value: _SettingsValueTransformation.AsJson;
|
|
45
52
|
}
|
|
46
53
|
function fromJson(model: AsJson): SettingsObjectCreate;
|
package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts
CHANGED
|
@@ -3,6 +3,18 @@ import { SettingsValue, _SettingsValueTransformation } from './settings-value';
|
|
|
3
3
|
* An update of a settings object.
|
|
4
4
|
*/
|
|
5
5
|
export interface SettingsObjectUpdate {
|
|
6
|
+
/**
|
|
7
|
+
* The version of the schema on which the object is based.
|
|
8
|
+
*/
|
|
9
|
+
schemaVersion?: string;
|
|
10
|
+
/**
|
|
11
|
+
* The update token of the object. You can use it to detect simultaneous modifications by different users.
|
|
12
|
+
*
|
|
13
|
+
* It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|
|
14
|
+
*
|
|
15
|
+
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
16
|
+
*/
|
|
17
|
+
updateToken?: string;
|
|
6
18
|
/**
|
|
7
19
|
* The position of the updated object. The new object will be moved behind the specified one.
|
|
8
20
|
*
|
|
@@ -27,27 +39,15 @@ export interface SettingsObjectUpdate {
|
|
|
27
39
|
* Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
|
|
28
40
|
*/
|
|
29
41
|
insertBefore?: string;
|
|
30
|
-
/**
|
|
31
|
-
* The version of the schema on which the object is based.
|
|
32
|
-
*/
|
|
33
|
-
schemaVersion?: string;
|
|
34
|
-
/**
|
|
35
|
-
* The update token of the object. You can use it to detect simultaneous modifications by different users.
|
|
36
|
-
*
|
|
37
|
-
* It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|
|
38
|
-
*
|
|
39
|
-
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
40
|
-
*/
|
|
41
|
-
updateToken?: string;
|
|
42
42
|
value: SettingsValue;
|
|
43
43
|
}
|
|
44
44
|
/** @ignore */
|
|
45
45
|
export declare namespace _SettingsObjectUpdateTransformation {
|
|
46
46
|
interface AsJson {
|
|
47
|
-
insertAfter?: string;
|
|
48
|
-
insertBefore?: string;
|
|
49
47
|
schemaVersion?: string;
|
|
50
48
|
updateToken?: string;
|
|
49
|
+
insertAfter?: string;
|
|
50
|
+
insertBefore?: string;
|
|
51
51
|
value: _SettingsValueTransformation.AsJson;
|
|
52
52
|
}
|
|
53
53
|
function fromJson(model: AsJson): SettingsObjectUpdate;
|
|
@@ -3,26 +3,34 @@ import { SettingsValue, _SettingsValueTransformation } from './settings-value';
|
|
|
3
3
|
* A settings object.
|
|
4
4
|
*/
|
|
5
5
|
export interface SettingsObject {
|
|
6
|
-
/**
|
|
7
|
-
* The ID of the settings object.
|
|
8
|
-
*/
|
|
9
|
-
objectId?: string;
|
|
10
6
|
/**
|
|
11
7
|
* The timestamp of the creation.
|
|
12
8
|
*/
|
|
13
9
|
created?: number;
|
|
14
10
|
/**
|
|
15
|
-
* The
|
|
11
|
+
* The schema on which the object is based.
|
|
16
12
|
*/
|
|
17
|
-
|
|
13
|
+
schemaId?: string;
|
|
14
|
+
/**
|
|
15
|
+
* The timestamp of the last modification.
|
|
16
|
+
*/
|
|
17
|
+
modified?: number;
|
|
18
18
|
/**
|
|
19
19
|
* The user (identified by a user ID or a public token ID) who performed that most recent modification.
|
|
20
20
|
*/
|
|
21
21
|
author?: string;
|
|
22
22
|
/**
|
|
23
|
-
* The
|
|
23
|
+
* The external identifier of the settings object.
|
|
24
24
|
*/
|
|
25
|
-
|
|
25
|
+
externalId?: string;
|
|
26
|
+
/**
|
|
27
|
+
* The scope that the object targets.
|
|
28
|
+
*/
|
|
29
|
+
scope?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The ID of the settings object.
|
|
32
|
+
*/
|
|
33
|
+
objectId?: string;
|
|
26
34
|
/**
|
|
27
35
|
* The version of the schema on which the object is based.
|
|
28
36
|
*/
|
|
@@ -36,33 +44,30 @@ export interface SettingsObject {
|
|
|
36
44
|
*/
|
|
37
45
|
updateToken?: string;
|
|
38
46
|
/**
|
|
39
|
-
*
|
|
47
|
+
* A searchable summary string of the setting value. Plain text without Markdown.
|
|
40
48
|
*/
|
|
41
|
-
|
|
49
|
+
searchSummary?: string;
|
|
42
50
|
/**
|
|
43
|
-
*
|
|
44
|
-
*/
|
|
45
|
-
scope?: string;
|
|
46
|
-
value?: SettingsValue;
|
|
47
|
-
/**
|
|
48
|
-
* A short summary of settings.
|
|
51
|
+
* A short summary of settings. This can contain Markdown and will be escaped accordingly.
|
|
49
52
|
*/
|
|
50
53
|
summary?: string;
|
|
54
|
+
value?: SettingsValue;
|
|
51
55
|
}
|
|
52
56
|
/** @ignore */
|
|
53
57
|
export declare namespace _SettingsObjectTransformation {
|
|
54
58
|
interface AsJson {
|
|
55
|
-
objectId?: string;
|
|
56
59
|
created?: number;
|
|
57
|
-
|
|
58
|
-
author?: string;
|
|
60
|
+
schemaId?: string;
|
|
59
61
|
modified?: number;
|
|
62
|
+
author?: string;
|
|
63
|
+
externalId?: string;
|
|
64
|
+
scope?: string;
|
|
65
|
+
objectId?: string;
|
|
60
66
|
schemaVersion?: string;
|
|
61
67
|
updateToken?: string;
|
|
62
|
-
|
|
63
|
-
scope?: string;
|
|
64
|
-
value?: _SettingsValueTransformation.AsJson;
|
|
68
|
+
searchSummary?: string;
|
|
65
69
|
summary?: string;
|
|
70
|
+
value?: _SettingsValueTransformation.AsJson;
|
|
66
71
|
}
|
|
67
72
|
function fromJson(model: AsJson): SettingsObject;
|
|
68
73
|
function toJson(model: SettingsObject): AsJson;
|