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

package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts

@@ -0,0 +1,188 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { GetAllUpdateJobListQueryStartVersionCompareType } from '../models/get-all-update-job-list-query-start-version-compare-type';
+import { GetAllUpdateJobListQueryTargetVersionCompareType } from '../models/get-all-update-job-list-query-target-version-compare-type';
+import { GetAllUpdateJobListQueryUpdateType } from '../models/get-all-update-job-list-query-update-type';
+import { GetUpdateJobListByAgIdQueryStartVersionCompareType } from '../models/get-update-job-list-by-ag-id-query-start-version-compare-type';
+import { GetUpdateJobListByAgIdQueryTargetVersionCompareType } from '../models/get-update-job-list-by-ag-id-query-target-version-compare-type';
+import { GetUpdateJobListByAgIdQueryUpdateType } from '../models/get-update-job-list-by-ag-id-query-update-type';
+import { UpdateJob } from '../models/update-job';
+import { UpdateJobList } from '../models/update-job-list';
+import { UpdateJobsAll } from '../models/update-jobs-all';
+/**
+ * Manage ActiveGate auto-update jobs.
+ */
+export declare class ActiveGatesAutoUpdateJobsClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ActiveGatesAutoUpdateJobsClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * List ActiveGates with update jobs
+     *
+     * **Required scope:** environment-api:activegates:read<br/><br/>The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
+     * @returns Success
+     */
+    getAllUpdateJobList(config: {
+        /**
+         * The start of the requested timeframe for update jobs.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of one day is used (`now-1d`).
+         *
+         * Maximum timeframe is 31 days.
+         */ from?: string;
+        /**
+         * The end of the requested timeframe for update jobs.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /**
+         * Filters the resulting set of update jobs by the specified initial version.
+         *
+         *  Specify the comparison operator here.
+         */ startVersionCompareType?: GetAllUpdateJobListQueryStartVersionCompareType;
+        /** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
+        /** Filters the resulting set of update-jobs by the update type. */ updateType?: GetAllUpdateJobListQueryUpdateType;
+        /**
+         * Filters the resulting set of update jobs by the specified target version.
+         *
+         *  Specify the comparison operator here.
+         */ targetVersionCompareType?: GetAllUpdateJobListQueryTargetVersionCompareType;
+        /** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
+        /** If `true`, filters the resulting set of update jobs to the most recent update of each type. */ lastUpdates?: boolean;
+        abortSignal?: AbortSignal;
+    }): Promise<UpdateJobsAll>;
+    /**
+     * Lists update jobs for the specified ActiveGate
+     *
+     * **Required scope:** environment-api:activegates:read<br/><br/>The job can update the ActiveGate to the specified version or the latest available one.
+     * @returns Success
+     */
+    getUpdateJobListByAgId(config: {
+        /** The ID of the required ActiveGate. */ agId: string;
+        /**
+         * The start of the requested timeframe for update jobs.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of one week is used (`now-1w`).
+         *
+         * Maximum timeframe is 31 days.
+         */ from?: string;
+        /**
+         * The end of the requested timeframe for update jobs.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /**
+         * Filters the resulting set of update jobs by the specified initial version.
+         *
+         *  Specify the comparison operator here.
+         */ startVersionCompareType?: GetUpdateJobListByAgIdQueryStartVersionCompareType;
+        /** Filters the resulting set of update-jobs by the initial version (required format `<major>.<minor>.<revision>`). */ startVersion?: string;
+        /** Filters the resulting set of update-jobs by the update type. */ updateType?: GetUpdateJobListByAgIdQueryUpdateType;
+        /**
+         * Filters the resulting set of update jobs by the specified target version.
+         *
+         *  Specify the comparison operator here.
+         */ targetVersionCompareType?: GetUpdateJobListByAgIdQueryTargetVersionCompareType;
+        /** Filters the resulting set of update-jobs by the target version (required format `<major>.<minor>.<revision>`). */ targetVersion?: string;
+        /** If `true`, filters the resulting set of update jobs to the most recent update of each type. */ lastUpdates?: boolean;
+        abortSignal?: AbortSignal;
+    }): Promise<UpdateJobList>;
+    /**
+     * Creates a new update job for the specified ActiveGate
+     *
+     * **Required scope:** environment-api:activegates:write
+     * @returns Success. The update-job have been created.
+     */
+    createUpdateJobForAg(config: {
+        body: UpdateJob;
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UpdateJob>;
+    /**
+     * Gets the parameters of the specified update job
+     *
+     * **Required scope:** environment-api:activegates:read
+     * @returns Success
+     */
+    getUpdateJobByJobIdForAg(config: {
+        /** The ID of the required ActiveGate. */ agId: string;
+        /** A unique identifier for a update-job of ActiveGate. */ jobId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<UpdateJob>;
+    /**
+     * Deletes the specified update job
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    deleteUpdateJobByJobIdForAg(config: {
+        /** The ID of the required ActiveGate. */ agId: string;
+        /** A unique identifier for a update-job of ActiveGate. */ jobId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    validateUpdateJobForAg(config: {
+        body: UpdateJob;
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+}
+export declare const activeGatesAutoUpdateJobsClient: ActiveGatesAutoUpdateJobsClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/audit-logs-api.d.ts

@@ -0,0 +1,114 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { AuditLog } from '../models/audit-log';
+import { AuditLogEntry } from '../models/audit-log-entry';
+/**
+ * Read audit logs
+ */
+export declare class AuditLogsClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AuditLogsClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Gets the specified entry of the audit log | maturity=EARLY_ADOPTER
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:audit-logs:read
+     * @returns Success
+     */
+    getLog(config: {
+        /** The ID of the required log entry. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<AuditLogEntry>;
+    /**
+     * Gets the audit log of your Dynatrace environment | maturity=EARLY_ADOPTER
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:audit-logs:read
+     * <br/><br/>You can limit the output by using pagination:
+     * 1. Specify the number of results per page in the **pageSize** query parameter.
+     * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     * @returns Success
+     */
+    getLogs(config: {
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
+         */ nextPageKey?: string;
+        /**
+         * The amount of log entries in a single response payload.
+         *
+         * The maximal allowed page size is 5000.
+         *
+         * If not set, 1000 is used.
+         */ pageSize?: number;
+        /**
+         * Filters the audit log. You can use the following criteria:
+         * * User: `user("userIdentification")`. The `EQUALS` operator applies.
+         * * Event type: `eventType("value")`. The `EQUALS` operator applies.
+         * * Category of a logged operation: `category("value")`. The `EQUALS` operator applies.
+         * * Entity ID: `entityId("id")`. The `CONTAINS` operator applies.
+         *
+         * For each criterion, you can specify multiple alternatives with comma-separated values. In this case, the OR logic applies. For example, `eventType("CREATE","UPDATE")` means eventType can be "CREATE" or "UPDATE".
+         *
+         * You can specify multiple comma-separated criteria, such as `eventType("CREATE","UPDATE"),category("CONFIG")`. Only results matching **all** criteria are included in response.
+         *
+         * Specify the value of a criterion as a quoted string. The following special characters must be escaped with a tilde (`~`) inside quotes:
+         * * Tilde `~`
+         * * Quote `"`
+         */ filter?: string;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of two weeks is used (`now-2w`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /**
+         * The sorting of audit log entries:
+         * * `timestamp`: Oldest first.
+         * * `-timestamp`: Newest first.
+         *
+         * If not set, the newest first sorting is applied.
+         */ sort?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<AuditLog>;
+}
+export declare const auditLogsClient: AuditLogsClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/credential-vault-api.d.ts

@@ -0,0 +1,95 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { AbstractCredentialsResponseElement } from '../models/abstract-credentials-response-element';
+import { Credentials } from '../models/credentials';
+import { CredentialsList } from '../models/credentials-list';
+import { CredentialsResponseElement } from '../models/credentials-response-element';
+import { ListCredentialsQueryType } from '../models/list-credentials-query-type';
+/**
+ * Manage credentials for Synthetic monitors
+ */
+export declare class CredentialVaultClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a CredentialVaultClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Lists all sets of credentials for synthetic monitors stored in your environment
+     *
+     * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
+     * @returns Success
+     */
+    listCredentials(config: {
+        /** Filters the result by the specified credentials type. */ type?: ListCredentialsQueryType;
+        /** Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive. */ name?: string;
+        /** Filters credentials accessible to the user (owned by the user or the ones that are accessible for all). */ user?: string;
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
+         */ nextPageKey?: string;
+        /**
+         * The amount of credentials in a single response payload.
+         *
+         * The maximal allowed page size is 500.
+         *
+         * If not set, 100 is used.
+         */ pageSize?: number;
+        abortSignal?: AbortSignal;
+    }): Promise<CredentialsList>;
+    /**
+     * Creates a new credentials set
+     *
+     * **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
+     * @returns Success. The new credentials set has been created. The response contains the ID of the set.
+     */
+    createCredentials(config: {
+        body: Credentials;
+        abortSignal?: AbortSignal;
+    }): Promise<CredentialsResponseElement>;
+    /**
+     * Gets the metadata of the specified credentials set
+     *
+     * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
+     * @returns Success. The response contains the metadata of the credentials set.
+     */
+    getCredentials(config: {
+        /** The Dynatrace entity ID of the required credentials set. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<CredentialsResponseElement>;
+    /**
+     * Updates the specified credentials set
+     *
+     * **Required scope:** environment-api:credentials:write<br/><br/>The body must not provide an ID. The ID should be provided in the path
+     * @returns Success. The new credentials set has been created. The response contains the ID of the set.
+     */
+    updateCredentials(config: {
+        body: Credentials;
+        /** The Dynatrace entity ID of the credentials set to be updated. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<CredentialsResponseElement | void>;
+    /**
+     * Deletes the specified credentials set
+     *
+     * **Required scope:** environment-api:credentials:write<br/><br/>Provide credential ID in the path.
+     */
+    removeCredentials(config: {
+        /** The ID of the credentials set to be deleted. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets the details of the specified credentials set
+     *
+     * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set including username/certificate, password or token is included in the response.
+     * @returns Success. The response contains the details of the credentials set.
+     */
+    getCredentialsDetails(config: {
+        /** The Dynatrace entity ID of the required credentials set. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<AbstractCredentialsResponseElement>;
+}
+export declare const credentialVaultClient: CredentialVaultClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/davis-security-advisor-api.d.ts

@@ -0,0 +1,46 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { DavisSecurityAdviceList } from '../models/davis-security-advice-list';
+/**
+ * Manage Davis security advices
+ */
+export declare class DavisSecurityAdvisorClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a DavisSecurityAdvisorClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Provides advice for security problems. | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** environment-api:security-problems:read<br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
+     * @returns Success
+     */
+    getAdviceForSecurityProblems(config: {
+        /**
+         * To specify management zones, use one of the options listed below. For each option you can specify multiple comma-separated values. If several values are specified, the **OR** logic applies. All values are case-sensitive and must be quoted.
+         *
+         * * Management zone ID: ids("mzId-1", "mzId-2").
+         * * Management zone names: names("mz-1", "mz-2").
+         *
+         * You can specify several comma-separated criteria (for example, `names("myMz"),ids("9130632296508575249")`).
+         */ managementZoneFilter?: string;
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
+         */ nextPageKey?: string;
+        /**
+         * The amount of security advices in a single response payload.
+         *
+         * The maximal allowed page size is 500.
+         *
+         * If not set, 5 is used.
+         */ pageSize?: number;
+        abortSignal?: AbortSignal;
+    }): Promise<DavisSecurityAdviceList>;
+}
+export declare const davisSecurityAdvisorClient: DavisSecurityAdvisorClient;