@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.3.2

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

@@ -16,7 +16,7 @@ export declare class BusinessEventsClient {
      *
      * The ingestion of business events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
      *
-     * @returns The provided business events are all accepted and will be processed.
+     * @returns {Promise<void>} The provided business events are all accepted and will be processed.
      *
      * @example <caption>Code example</caption>
      * import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -42,6 +42,12 @@ export declare class BusinessEventsClient {
      *     },
      *   },
      * });
+     *
+     * @throws {BizEventIngestResultError} Some business events are invalid. Valid business events are accepted and will be processed. | Content too large | Too many requests | Service is temporarily unavailable
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     ingest(config: ({
         body: CloudEvent;

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

@@ -21,12 +21,17 @@ export declare class CredentialVaultClient {
      *
      * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
      *
-     * @returns Success
+     * @returns {Promise<CredentialsList>} Success
      *
      * @example <caption>Code example</caption>
      * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await credentialVaultClient.listCredentials();
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     listCredentials(config?: {
         /** Filters the result by the specified credentials type. */ type?: ListCredentialsQueryType;
@@ -54,7 +59,7 @@ export declare class CredentialVaultClient {
      *
      * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<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.
+     * @returns {Promise<CredentialsId>} Success. The new credentials set has been created. The response contains the ID of the set.
      *
      * @example <caption>Code example</caption>
      * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -65,6 +70,11 @@ export declare class CredentialVaultClient {
      *     scopes: [CredentialsScopesItem.AppEngine],
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     createCredentials(config: {
         body: Credentials;
@@ -75,7 +85,7 @@ export declare class CredentialVaultClient {
      *
      * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<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.
+     * @returns {Promise<CredentialsResponseElement>} Success. The response contains the metadata of the credentials set.
      *
      * @example <caption>Code example</caption>
      * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -83,6 +93,11 @@ export declare class CredentialVaultClient {
      * const data = await credentialVaultClient.getCredentials({
      *   id: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getCredentials(config: {
         /** The Dynatrace entity ID of the required credentials set. */ id: string;
@@ -93,7 +108,7 @@ export declare class CredentialVaultClient {
      *
      * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<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.
+     * @returns {Promise<CredentialsId | void>} Success. The new credentials set has been created. The response contains the ID of the set.
      *
      * @example <caption>Code example</caption>
      * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -105,6 +120,11 @@ export declare class CredentialVaultClient {
      *     scopes: [CredentialsScopesItem.AppEngine],
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateCredentials(config: {
         body: Credentials;
@@ -122,6 +142,11 @@ export declare class CredentialVaultClient {
      * const data = await credentialVaultClient.removeCredentials({
      *   id: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     removeCredentials(config: {
         /** The ID of the credentials set to be deleted. */ id: string;
@@ -132,7 +157,7 @@ export declare class CredentialVaultClient {
      *
      * **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.
+     * @returns {Promise<AbstractCredentialsResponseElement>} Success. The response contains the details of the credentials set.
      *
      * @example <caption>Code example</caption>
      * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -141,6 +166,11 @@ export declare class CredentialVaultClient {
      *   await credentialVaultClient.getCredentialsDetails({
      *     id: "...",
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. E.g. Requested credentials with unsupported scope. Only APP_ENGINE scope is supported. | Failed. Requested credentials belong to another user.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getCredentialsDetails(config: {
         /** The Dynatrace entity ID of the required credentials set. */ id: string;

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

@@ -20,13 +20,18 @@ export declare class DavisSecurityAdvisorClient {
      *
      * <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
+     * @returns {Promise<DavisSecurityAdviceList>} Success
      *
      * @example <caption>Code example</caption>
      * import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data =
      *   await davisSecurityAdvisorClient.getAdviceForSecurityProblems();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getAdviceForSecurityProblems(config?: {
         /**

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

@@ -23,12 +23,17 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<EventPropertiesList>} Success
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await eventsClient.getEventProperties();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEventProperties(config?: {
         /**
@@ -52,7 +57,7 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<EventPropertyDetails>} Success
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -60,6 +65,11 @@ export declare class EventsClient {
      * const data = await eventsClient.getEventProperty({
      *   propertyKey: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEventProperty(config: {
         /** The event property key you're inquiring. */ propertyKey: string;
@@ -70,12 +80,17 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<EventTypeList>} Success
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await eventsClient.getEventTypes();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEventTypes(config?: {
         /**
@@ -99,7 +114,7 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<EventType>} Success
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -107,6 +122,11 @@ export declare class EventsClient {
      * const data = await eventsClient.getEventType({
      *   eventType: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEventType(config: {
         /** The event type you're inquiring. */ eventType: string;
@@ -117,12 +137,17 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success. The response contains the list of events.
+     * @returns {Promise<EventList>} Success. The response contains the list of events.
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await eventsClient.getEvents();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEvents(config?: {
         /**
@@ -243,14 +268,22 @@ export declare class EventsClient {
      *
      * <br/><br/>The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
      *
-     * @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
+     * @returns {Promise<EventIngestResults>} The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await eventsClient.createEvent({
-     *   body: { title: "..." },
+     *   body: {
+     *     eventType: EventIngestEventType.AvailabilityEvent,
+     *     title: "...",
+     *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     createEvent(config: {
         body: EventIngest;
@@ -261,7 +294,7 @@ export declare class EventsClient {
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success. The response contains the configuration of the event.
+     * @returns {Promise<Event>} Success. The response contains the configuration of the event.
      *
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -269,6 +302,11 @@ export declare class EventsClient {
      * const data = await eventsClient.getEvent({
      *   eventId: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEvent(config: {
         /** The ID of the required event. */ eventId: string;