@dynatrace-sdk/client-classic-environment-v2 1.2.4 → 1.3.0

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

@@ -18,50 +18,6 @@ export declare class EventsClient {
      * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
      */
     constructor(httpClientImplementation: HttpClient);
-    /**
-     * Ingests a custom event
-     *
-     * **One of the following scopes is required:**
-     * + storage:events:write
-     * + environment-api:events:write
-     *
-     * <br/>**One of the following permissions is required:**
-     * + environment:roles:viewer
-     * + storage:events:write
-     *
-     * <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
-     *
-     * @returns 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: {} as EventIngest,
-     * });
-     */
-    createEvent(config: {
-        body: EventIngest;
-        abortSignal?: AbortSignal;
-    }): Promise<EventIngestResults>;
-    /**
-     * Gets the properties of an event
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns Success. The response contains the configuration of the event.
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEvent({
-     *   eventId: "...",
-     * });
-     */
-    getEvent(config: {
-        /** The ID of the required event. */ eventId: string;
-        abortSignal?: AbortSignal;
-    }): Promise<Event>;
     /**
      * Lists all event properties
      *
@@ -72,10 +28,7 @@ export declare class EventsClient {
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
-     * const data = await eventsClient.getEventProperties({
-     *   nextPageKey: "...",
-     *   pageSize: 123,
-     * });
+     * const data = await eventsClient.getEventProperties();
      */
     getEventProperties(config?: {
         /**
@@ -112,24 +65,6 @@ export declare class EventsClient {
         /** The event property key you're inquiring. */ propertyKey: string;
         abortSignal?: AbortSignal;
     }): Promise<EventPropertyDetails>;
-    /**
-     * Gets the properties of an event type
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns Success
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEventType({
-     *   eventType: "...",
-     * });
-     */
-    getEventType(config: {
-        /** The event type you're inquiring. */ eventType: string;
-        abortSignal?: AbortSignal;
-    }): Promise<EventType>;
     /**
      * Lists all event types
      *
@@ -140,10 +75,7 @@ export declare class EventsClient {
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
-     * const data = await eventsClient.getEventTypes({
-     *   nextPageKey: "...",
-     *   pageSize: 123,
-     * });
+     * const data = await eventsClient.getEventTypes();
      */
     getEventTypes(config?: {
         /**
@@ -162,6 +94,24 @@ export declare class EventsClient {
          */ pageSize?: number;
         abortSignal?: AbortSignal;
     }): Promise<EventTypeList>;
+    /**
+     * Gets the properties of an event type
+     *
+     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEventType({
+     *   eventType: "...",
+     * });
+     */
+    getEventType(config: {
+        /** The event type you're inquiring. */ eventType: string;
+        abortSignal?: AbortSignal;
+    }): Promise<EventType>;
     /**
      * Lists events within the specified timeframe
      *
@@ -172,14 +122,7 @@ export declare class EventsClient {
      * @example <caption>Code example</caption>
      * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
-     * const data = await eventsClient.getEvents({
-     *   nextPageKey: "...",
-     *   pageSize: 123,
-     *   from: "...",
-     *   to: "...",
-     *   eventSelector: "...",
-     *   entitySelector: "...",
-     * });
+     * const data = await eventsClient.getEvents();
      */
     getEvents(config?: {
         /**
@@ -287,5 +230,49 @@ export declare class EventsClient {
          */ entitySelector?: string;
         abortSignal?: AbortSignal;
     }): Promise<EventList>;
+    /**
+     * Ingests a custom event
+     *
+     * **One of the following scopes is required:**
+     * + storage:events:write
+     * + environment-api:events:write
+     *
+     * <br/>**One of the following permissions is required:**
+     * + environment:roles:viewer
+     * + storage:events:write
+     *
+     * <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
+     *
+     * @returns 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: "..." },
+     * });
+     */
+    createEvent(config: {
+        body: EventIngest;
+        abortSignal?: AbortSignal;
+    }): Promise<EventIngestResults>;
+    /**
+     * Gets the properties of an event
+     *
+     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success. The response contains the configuration of the event.
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEvent({
+     *   eventId: "...",
+     * });
+     */
+    getEvent(config: {
+        /** The ID of the required event. */ eventId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<Event>;
 }
 export declare const eventsClient: EventsClient;