@coval/sdk 0.4.2 → 0.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coval/sdk",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Typed TypeScript client for the Coval evaluation platform API.",
   "license": "MIT",
   "author": "Coval <support@coval.dev>",

package/src/CovalClient.ts

@@ -15,15 +15,15 @@ import { CovalApiError, parseErrorResponse } from './errors.js';
 import { createRetryingFetch, type RetryOptions } from './retry.js';
 import { createTransportStats, type CovalTransportStats } from './stats.js';
 import {
-  AgentsApi,
+  // sdk-api-imports:start
   APIKeysApi,
+  AgentsApi,
+  AlertEventsApi,
+  AlertsApi,
   AudioApi,
-  Configuration,
   ConversationsApi,
   DashboardsApi,
-  type FetchAPI,
   IntegrationsApi,
-  type Middleware,
   MetricOutputsApi,
   MetricsApi,
   MonitorEventsApi,
@@ -34,8 +34,8 @@ import {
   ReportsApi,
   ReviewAnnotationsApi,
   ReviewProjectsApi,
-  RunsApi,
   RunTemplatesApi,
+  RunsApi,
   ScheduledRunsApi,
   SimulationsApi,
   TagsApi,
@@ -44,6 +44,10 @@ import {
   TracesApi,
   WebhooksApi,
   WidgetsApi,
+  // sdk-api-imports:end
+  Configuration,
+  type FetchAPI,
+  type Middleware,
 } from './generated/index.js';
 
 export interface CovalClientOptions {
@@ -66,25 +70,61 @@ export interface CovalClientOptions {
 
 const DEFAULT_BASE_URL = 'https://api.coval.dev/v1';
 
+export const GENERATED_API_PROPERTY_NAMES = [
+  // sdk-api-property-names:start
+  'apiKeys',
+  'agents',
+  'alertEvents',
+  'alerts',
+  'audio',
+  'conversations',
+  'dashboards',
+  'integrations',
+  'metricOutputs',
+  'metrics',
+  'monitorEvents',
+  'monitors',
+  'mutations',
+  'organizationConversationsConfig',
+  'personas',
+  'reports',
+  'reviewAnnotations',
+  'reviewProjects',
+  'runTemplates',
+  'runs',
+  'scheduledRuns',
+  'simulations',
+  'tags',
+  'testCases',
+  'testSets',
+  'traces',
+  'webhooks',
+  'widgets',
+  // sdk-api-property-names:end
+] as const;
+
 export class CovalClient {
-  readonly agents: AgentsApi;
+  // sdk-api-properties:start
   readonly apiKeys: APIKeysApi;
+  readonly agents: AgentsApi;
+  readonly alertEvents: AlertEventsApi;
+  readonly alerts: AlertsApi;
   readonly audio: AudioApi;
   readonly conversations: ConversationsApi;
   readonly dashboards: DashboardsApi;
   readonly integrations: IntegrationsApi;
-  readonly metrics: MetricsApi;
   readonly metricOutputs: MetricOutputsApi;
-  readonly monitors: MonitorsApi;
+  readonly metrics: MetricsApi;
   readonly monitorEvents: MonitorEventsApi;
+  readonly monitors: MonitorsApi;
   readonly mutations: MutationsApi;
   readonly organizationConversationsConfig: OrganizationConversationsConfigApi;
   readonly personas: PersonasApi;
   readonly reports: ReportsApi;
   readonly reviewAnnotations: ReviewAnnotationsApi;
   readonly reviewProjects: ReviewProjectsApi;
-  readonly runs: RunsApi;
   readonly runTemplates: RunTemplatesApi;
+  readonly runs: RunsApi;
   readonly scheduledRuns: ScheduledRunsApi;
   readonly simulations: SimulationsApi;
   readonly tags: TagsApi;
@@ -93,6 +133,7 @@ export class CovalClient {
   readonly traces: TracesApi;
   readonly webhooks: WebhooksApi;
   readonly widgets: WidgetsApi;
+  // sdk-api-properties:end
 
   readonly configuration: Configuration;
 
@@ -132,24 +173,27 @@ export class CovalClient {
       middleware,
     });
 
-    this.agents = new AgentsApi(this.configuration);
+    // sdk-api-assignments:start
     this.apiKeys = new APIKeysApi(this.configuration);
+    this.agents = new AgentsApi(this.configuration);
+    this.alertEvents = new AlertEventsApi(this.configuration);
+    this.alerts = new AlertsApi(this.configuration);
     this.audio = new AudioApi(this.configuration);
     this.conversations = new ConversationsApi(this.configuration);
     this.dashboards = new DashboardsApi(this.configuration);
     this.integrations = new IntegrationsApi(this.configuration);
-    this.metrics = new MetricsApi(this.configuration);
     this.metricOutputs = new MetricOutputsApi(this.configuration);
-    this.monitors = new MonitorsApi(this.configuration);
+    this.metrics = new MetricsApi(this.configuration);
     this.monitorEvents = new MonitorEventsApi(this.configuration);
+    this.monitors = new MonitorsApi(this.configuration);
     this.mutations = new MutationsApi(this.configuration);
     this.organizationConversationsConfig = new OrganizationConversationsConfigApi(this.configuration);
     this.personas = new PersonasApi(this.configuration);
     this.reports = new ReportsApi(this.configuration);
     this.reviewAnnotations = new ReviewAnnotationsApi(this.configuration);
     this.reviewProjects = new ReviewProjectsApi(this.configuration);
-    this.runs = new RunsApi(this.configuration);
     this.runTemplates = new RunTemplatesApi(this.configuration);
+    this.runs = new RunsApi(this.configuration);
     this.scheduledRuns = new ScheduledRunsApi(this.configuration);
     this.simulations = new SimulationsApi(this.configuration);
     this.tags = new TagsApi(this.configuration);
@@ -158,6 +202,7 @@ export class CovalClient {
     this.traces = new TracesApi(this.configuration);
     this.webhooks = new WebhooksApi(this.configuration);
     this.widgets = new WidgetsApi(this.configuration);
+    // sdk-api-assignments:end
   }
 }
 

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];