@coval/sdk 0.4.1 → 0.4.3

package/src/generated/apis/AlertEventsApi.ts

@@ -0,0 +1,152 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Coval Agents API
+ *  Manage configurations for simulations and evaluations. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@coval.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime.js';
+import {
+    type CovalAlertsAPIErrorResponse,
+    CovalAlertsAPIErrorResponseFromJSON,
+    CovalAlertsAPIErrorResponseToJSON,
+} from '../models/CovalAlertsAPIErrorResponse.js';
+import {
+    type CovalAlertsAPIListAlertEventsResponse,
+    CovalAlertsAPIListAlertEventsResponseFromJSON,
+    CovalAlertsAPIListAlertEventsResponseToJSON,
+} from '../models/CovalAlertsAPIListAlertEventsResponse.js';
+
+export interface ListAlertEventsRequest {
+    alertId: string;
+    outcome?: ListAlertEventsOutcomeEnum;
+    pageSize?: number;
+    pageToken?: string;
+}
+
+/**
+ * AlertEventsApi - interface
+ * 
+ * @export
+ * @interface AlertEventsApiInterface
+ */
+export interface AlertEventsApiInterface {
+    /**
+     * Creates request options for listAlertEvents without sending the request
+     * @param {string} alertId Alert ULID
+     * @param {'TRIGGERED' | 'NOT_MET' | 'SUPPRESSED' | 'ERROR'} [outcome] Filter events by outcome
+     * @param {number} [pageSize] Number of results per page
+     * @param {string} [pageToken] Token for fetching the next page of results
+     * @throws {RequiredError}
+     * @memberof AlertEventsApiInterface
+     */
+    listAlertEventsRequestOpts(requestParameters: ListAlertEventsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns evaluation events for an alert, ordered by most recent first.  Every run completion that evaluates this alert produces an event, regardless of outcome (TRIGGERED, NOT_MET, SUPPRESSED, ERROR). 
+     * @summary List alert events
+     * @param {string} alertId Alert ULID
+     * @param {'TRIGGERED' | 'NOT_MET' | 'SUPPRESSED' | 'ERROR'} [outcome] Filter events by outcome
+     * @param {number} [pageSize] Number of results per page
+     * @param {string} [pageToken] Token for fetching the next page of results
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AlertEventsApiInterface
+     */
+    listAlertEventsRaw(requestParameters: ListAlertEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIListAlertEventsResponse>>;
+
+    /**
+     * Returns evaluation events for an alert, ordered by most recent first.  Every run completion that evaluates this alert produces an event, regardless of outcome (TRIGGERED, NOT_MET, SUPPRESSED, ERROR). 
+     * List alert events
+     */
+    listAlertEvents(requestParameters: ListAlertEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIListAlertEventsResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AlertEventsApi extends runtime.BaseAPI implements AlertEventsApiInterface {
+
+    /**
+     * Creates request options for listAlertEvents without sending the request
+     */
+    async listAlertEventsRequestOpts(requestParameters: ListAlertEventsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['alertId'] == null) {
+            throw new runtime.RequiredError(
+                'alertId',
+                'Required parameter "alertId" was null or undefined when calling listAlertEvents().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['outcome'] != null) {
+            queryParameters['outcome'] = requestParameters['outcome'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['pageToken'] != null) {
+            queryParameters['page_token'] = requestParameters['pageToken'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-Key"] = await this.configuration.apiKey("X-API-Key"); // Coval_Alerts_API_ApiKeyAuth authentication
+        }
+
+
+        let urlPath = `/alerts/{alert_id}/events`;
+        urlPath = urlPath.replace('{alert_id}', encodeURIComponent(String(requestParameters['alertId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns evaluation events for an alert, ordered by most recent first.  Every run completion that evaluates this alert produces an event, regardless of outcome (TRIGGERED, NOT_MET, SUPPRESSED, ERROR). 
+     * List alert events
+     */
+    async listAlertEventsRaw(requestParameters: ListAlertEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CovalAlertsAPIListAlertEventsResponse>> {
+        const requestOptions = await this.listAlertEventsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CovalAlertsAPIListAlertEventsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns evaluation events for an alert, ordered by most recent first.  Every run completion that evaluates this alert produces an event, regardless of outcome (TRIGGERED, NOT_MET, SUPPRESSED, ERROR). 
+     * List alert events
+     */
+    async listAlertEvents(requestParameters: ListAlertEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CovalAlertsAPIListAlertEventsResponse> {
+        const response = await this.listAlertEventsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const ListAlertEventsOutcomeEnum = {
+    Triggered: 'TRIGGERED',
+    NotMet: 'NOT_MET',
+    Suppressed: 'SUPPRESSED',
+    Error: 'ERROR'
+} as const;
+export type ListAlertEventsOutcomeEnum = typeof ListAlertEventsOutcomeEnum[keyof typeof ListAlertEventsOutcomeEnum];