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

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@dynatrace-sdk/client-classic-environment-v2",
+  "version": "0.6.1",
+  "dependencies": {
+    "@dynatrace-sdk/http-client": "^0.4.3"
+  },
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./types/index.d.ts"
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from './packages/client/classic-environment-v2/src';

package/types/packages/client/classic-environment-v2/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts

@@ -0,0 +1,75 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ActiveGateToken } from '../models/active-gate-token';
+import { ActiveGateTokenCreate } from '../models/active-gate-token-create';
+import { ActiveGateTokenCreated } from '../models/active-gate-token-created';
+import { ActiveGateTokenList } from '../models/active-gate-token-list';
+/**
+ * Manage Dynatrace ActiveGate tokens
+ */
+export declare class AccessTokensActiveGateTokensClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AccessTokensActiveGateTokensClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Lists all available ActiveGate tokens | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** environment-api:activegate-tokens: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. The response contains the list of ActiveGate tokens.
+     */
+    listTokens(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 ActiveGate tokens in a single response payload.
+         *
+         * The maximal allowed page size is 3000 and the minimal size is 100.
+         *
+         * If not set, 100 is used.
+         */ pageSize?: number;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGateTokenList>;
+    /**
+     * Creates a new ActiveGate token | maturity=EARLY_ADOPTER
+     *
+     * **One of the following scopes is required:**
+     * + environment-api:activegate-tokens:create
+     * + environment-api:activegate-tokens:write
+     * <br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
+     * @returns Success. The token has been created. The body of the response contains the token secret.
+     */
+    createToken(config: {
+        body: ActiveGateTokenCreate;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGateTokenCreated>;
+    /**
+     * Gets metadata of an ActiveGate token | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** environment-api:activegate-tokens:read<br/><br/>The token secret is **not** exposed.
+     * @returns Success. The response contains the metadata of the tokens.
+     */
+    getToken(config: {
+        /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/2903ss4) of the token. */ activeGateTokenIdentifier: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGateToken>;
+    /**
+     * Deletes an ActiveGate token | maturity=EARLY_ADOPTER
+     *
+     * **Required scope:** environment-api:activegate-tokens:write
+     */
+    revokeToken(config: {
+        /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/2903ss4) of the token to be deleted. */ activeGateTokenIdentifier: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+}
+export declare const accessTokensActiveGateTokensClient: AccessTokensActiveGateTokensClient;

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

@@ -0,0 +1,196 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ApiToken } from '../models/api-token';
+import { ApiTokenCreate } from '../models/api-token-create';
+import { ApiTokenCreated } from '../models/api-token-created';
+import { ApiTokenList } from '../models/api-token-list';
+import { ApiTokenSecret } from '../models/api-token-secret';
+import { ApiTokenUpdate } from '../models/api-token-update';
+/**
+ * Manage Dynatrace API tokens
+ */
+export declare class AccessTokensApiTokensClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AccessTokensApiTokensClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Lists all available API tokens
+     *
+     * **Required scope:** environment-api:api-tokens: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
+     */
+    listApiTokens(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 API tokens in a single response payload.
+         *
+         * The maximal allowed page size is 10000 and the minimal allowed page size is 100.
+         *
+         * If not set, 200 is used.
+         */ pageSize?: number;
+        /**
+         * Filters the resulting sets of tokens. Only tokens matching the specified criteria are included into response.
+         *
+         * You can set one or more of the following criteria:
+         *
+         * * Owner: `owner("value")`. The user that owns the token. Case-sensitive.
+         * * Personal access token: `personalAccessToken(false)`. Set to `true` to include only personal access tokens or to `false` to include only API tokens.
+         * * Token scope: `scope("scope1","scope2")`. If several values are specified, the **OR** logic applies.
+         *
+         * To set multiple criteria, separate them with commas (`,`). Only results matching **all** criteria are included into response.
+         */ apiTokenSelector?: string;
+        /**
+         * Specifies the fields to be included in the response.
+         *
+         * The following fields are included by default:
+         *
+         * * `id`
+         * * `name`
+         * * `enabled`
+         * * `owner`
+         * * `creationDate`
+         *
+         * To remove fields from the response, specify them with the minus (`-`) operator as a comma-separated list (for example, `-creationDate,-owner`).
+         *
+         * You can include additional fields:
+         *
+         * * `personalAccessToken`
+         * * `expirationDate`
+         * * `lastUsedDate`
+         * * `lastUsedIpAddress`
+         * * `modifiedDate`
+         * * `scopes`
+         *
+         * * `additionalMetadata`
+         *
+         * To add fields to the response, specify them with the plus (`+`) operator as a comma-separated list (for example, `+expirationDate,+scopes`). You can combine adding and removing of fields (for example, `+scopes,-creationDate`).
+         *
+         * Alternatively, you can define the desired set of fields in the response. Specify the required fields as a comma-separated list, without operators (for example, `creationDate,expirationDate,owner`). The ID is always included in the response.
+         *
+         * The **fields** string must be URL-encoded.
+         */ fields?: string;
+        /**
+         * Filters tokens based on the last usage time.
+         * 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
+         */ from?: string;
+        /**
+         * Filters tokens based on the last usage time.
+         * 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 sort order of the token list.
+         *
+         * You can sort by the following properties with a sign prefix for the sort order:
+         *
+         *  * `name`: token name (`+` a...z or `-` z...a)
+         *  * `lastUsedDate` last used (`+` never used tokens first `-` most recently used tokens first)
+         *  * `creationDate` (`+` oldest tokens first `-` newest tokens first)
+         *  * `expirationDate` (`+` tokens that expire soon first `-` unlimited tokens first)
+         *  * `modifiedDate` last modified (`+` never modified tokens first `-` most recently modified tokens first)
+         *
+         * If no prefix is set, + is used.
+         *
+         * If not set, tokens are sorted by creation date with newest first.
+         */ sort?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ApiTokenList>;
+    /**
+     * Creates a new API token
+     *
+     * **Required scope:** environment-api:api-tokens:write<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
+     * @returns Success. The token has been created. The body of the response contains the token secret.
+     */
+    createApiToken(config: {
+        body: ApiTokenCreate;
+        abortSignal?: AbortSignal;
+    }): Promise<ApiTokenCreated>;
+    /**
+     * Gets API token metadata by token ID
+     *
+     * **Required scope:** environment-api:api-tokens:read<br/><br/>The token secret is **not** exposed.
+     * @returns Success
+     */
+    getApiToken(config: {
+        id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ApiToken>;
+    /**
+     * Updates an API token
+     *
+     * **Required scope:** environment-api:api-tokens:write
+     */
+    updateApiToken(config: {
+        body: ApiTokenUpdate;
+        /**
+         * The ID of the token to be updated.
+         *
+         *  You can't disable the token you're using for authentication of the request.
+         */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Deletes an API token
+     *
+     * **Required scope:** environment-api:api-tokens:write
+     */
+    deleteApiToken(config: {
+        /**
+         * The ID of the token to be deleted.
+         *
+         * You can specify either the ID or the secret of the token.
+         *
+         * You can't delete the token you're using for authentication of the request.
+         */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets API token metadata by token secret
+     *
+     * **Required scope:** environment-api:api-tokens:read
+     * @returns Success
+     */
+    lookupApiToken(config: {
+        body: ApiTokenSecret;
+        abortSignal?: AbortSignal;
+    }): Promise<ApiToken>;
+}
+export declare const accessTokensApiTokensClient: AccessTokensApiTokensClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-tenant-tokens-api.d.ts

@@ -0,0 +1,36 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { TenantTokenConfig } from '../models/tenant-token-config';
+/**
+ * Rotate tenant tokens
+ */
+export declare class AccessTokensTenantTokensClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a AccessTokensTenantTokensClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Cancels tenant token rotation
+     *
+     * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     * @returns Success. Rotation process has been cancelled. The current tenant token remains valid.
+     */
+    cancelRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
+    /**
+     * Finishes tenant token rotation
+     *
+     * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     * @returns Success. The rotation process is completed. The **active** field of the response contains the new tenant token.
+     */
+    finishRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
+    /**
+     * Starts tenant token rotation
+     *
+     * **Required scope:** environment-api:tenant-token-rotation:write<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     * @returns Success. The new tenant token is created and will replace the old one. The **active** field of the response contains the new tenant token.
+     */
+    startRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
+}
+export declare const accessTokensTenantTokensClient: AccessTokensTenantTokensClient;

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

@@ -0,0 +1,93 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ActiveGate } from '../models/active-gate';
+import { ActiveGateList } from '../models/active-gate-list';
+import { GetAllActiveGatesQueryAutoUpdate } from '../models/get-all-active-gates-query-auto-update';
+import { GetAllActiveGatesQueryDisabledModuleItem } from '../models/get-all-active-gates-query-disabled-module-item';
+import { GetAllActiveGatesQueryEnabledModuleItem } from '../models/get-all-active-gates-query-enabled-module-item';
+import { GetAllActiveGatesQueryOsType } from '../models/get-all-active-gates-query-os-type';
+import { GetAllActiveGatesQueryTokenState } from '../models/get-all-active-gates-query-token-state';
+import { GetAllActiveGatesQueryType } from '../models/get-all-active-gates-query-type';
+import { GetAllActiveGatesQueryUpdateStatus } from '../models/get-all-active-gates-query-update-status';
+import { GetAllActiveGatesQueryVersionCompareType } from '../models/get-all-active-gates-query-version-compare-type';
+/**
+ * View information about your ActiveGates
+ */
+export declare class ActiveGatesClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ActiveGatesClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Lists all available ActiveGates
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:activegates:read
+     * <br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
+     * @returns Success
+     */
+    getAllActiveGates(config: {
+        /**
+         * Filters the resulting set of ActiveGates by the name of the host it's running on.
+         *
+         *  You can specify a partial name. In that case, the `CONTAINS` operator is used.
+         */ hostname?: string;
+        /** Filters the resulting set of ActiveGates by the OS type of the host it's running on. */ osType?: GetAllActiveGatesQueryOsType;
+        /**
+         * Filters the resulting set of ActiveGates by the network address.
+         *
+         *  You can specify a partial address. In that case, the `CONTAINS` operator is used.
+         */ networkAddress?: string;
+        /**
+         * Filters the resulting set of ActiveGates by the Load Balancer address.
+         *
+         *  You can specify a partial address. In that case, the `CONTAINS` operator is used.
+         */ loadBalancerAddress?: string;
+        /** Filters the resulting set of ActiveGates by the ActiveGate type. */ type?: GetAllActiveGatesQueryType;
+        /**
+         * Filters the resulting set of ActiveGates by the network zone.
+         *
+         *  You can specify a partial name. In that case, the `CONTAINS` operator is used.
+         */ networkZone?: string;
+        /** Filters the resulting set of ActiveGates by the auto-update status. */ updateStatus?: GetAllActiveGatesQueryUpdateStatus;
+        /**
+         * Filters the resulting set of ActiveGates by the specified version.
+         *
+         *  Specify the comparison operator here.
+         */ versionCompareType?: GetAllActiveGatesQueryVersionCompareType;
+        /**
+         * Filters the resulting set of ActiveGates by the specified version.
+         *
+         *  Specify the version in `<major>.<minor>.<revision>` format (for example, `1.195.0`) here.
+         */ version?: string;
+        /** Filters the resulting set of ActiveGates by the actual state of auto-update. */ autoUpdate?: GetAllActiveGatesQueryAutoUpdate;
+        /**
+         * Filters the resulting set of ActiveGates by the group.
+         *
+         *  You can specify a partial name. In that case, the `CONTAINS` operator is used.
+         */ group?: string;
+        /** Filters the resulting set of ActiveGates by the communication status. */ online?: boolean;
+        /** Filters the resulting set of ActiveGates by the enabled modules. */ enabledModule?: GetAllActiveGatesQueryEnabledModuleItem[];
+        /** Filters the resulting set of ActiveGates by the disabled modules. */ disabledModule?: GetAllActiveGatesQueryDisabledModuleItem[];
+        /** Filters the resulting set of ActiveGates to those which are running in container (`true`) or not (`false`). */ containerized?: boolean;
+        /** Filters the resulting set of ActiveGates to those with authorization token in specified state. */ tokenState?: GetAllActiveGatesQueryTokenState;
+        /** Filters the resulting set of ActiveGates to those with set expiration date for authorization token. */ tokenExpirationSet?: boolean;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGateList>;
+    /**
+     * Gets the details of the specified ActiveGate
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:activegates:read
+     * @returns Success
+     */
+    getOneActiveGateById(config: {
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGate>;
+}
+export declare const activeGatesClient: ActiveGatesClient;

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

@@ -0,0 +1,71 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ActiveGateAutoUpdateConfig } from '../models/active-gate-auto-update-config';
+import { ActiveGateGlobalAutoUpdateConfig } from '../models/active-gate-global-auto-update-config';
+/**
+ * Manage ActiveGate auto-update settings.
+ */
+export declare class ActiveGatesAutoUpdateConfigurationClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ActiveGatesAutoUpdateConfigurationClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Gets the configuration of auto-update for the specified ActiveGate
+     *
+     * **Required scope:** environment-api:activegates:read
+     * @returns Success
+     */
+    getAutoUpdateConfigById(config: {
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ActiveGateAutoUpdateConfig>;
+    /**
+     * Updates the configuration of auto-update for the specified ActiveGate
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    putAutoUpdateConfigById(config: {
+        body: ActiveGateAutoUpdateConfig;
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    validateAutoUpdateConfigById(config: {
+        body: ActiveGateAutoUpdateConfig;
+        /** The ID of the required ActiveGate. */ agId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets the global auto-update configuration of environment ActiveGates.
+     *
+     * **Required scope:** environment-api:activegates:read
+     * @returns Success
+     */
+    getGlobalAutoUpdateConfigForTenant(abortSignal?: AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
+    /**
+     * Puts the global auto-update configuration of environment ActiveGates.
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    putGlobalAutoUpdateConfigForTenant(config: {
+        body: ActiveGateGlobalAutoUpdateConfig;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Validates the payload for the `POST /activeGates/autoUpdate` request.
+     *
+     * **Required scope:** environment-api:activegates:write
+     */
+    validateGlobalAutoUpdateConfigForTenant(config: {
+        body: ActiveGateGlobalAutoUpdateConfig;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+}
+export declare const activeGatesAutoUpdateConfigurationClient: ActiveGatesAutoUpdateConfigurationClient;