edge-impulse-api 1.93.10 → 1.93.12

package/build/browser/edge-impulse-api.d.ts

@@ -95,7 +95,7 @@ export interface RequestDetailedFile {
     };
 }
 export type RequestFile = RequestDetailedFile;
-export const APIS: (typeof AdminApi | typeof AuthApi | typeof CDNApi | typeof CanaryApi | typeof ClassifyApi | typeof DSPApi | typeof DatasetVersionsApi | typeof DeploymentApi | typeof DevicesApi | typeof EmailVerificationApi | typeof ExportApi | typeof FeatureFlagsApi | typeof HealthApi | typeof ImpulseApi | typeof IntegrationsApi | typeof JobsApi | typeof LearnApi | typeof LoginApi | typeof MetricsApi | typeof OptimizationApi | typeof OrganizationBlocksApi | typeof OrganizationCreateProjectApi | typeof OrganizationDataApi | typeof OrganizationDataCampaignsApi | typeof OrganizationJobsApi | typeof OrganizationPipelinesApi | typeof OrganizationPortalsApi | typeof OrganizationsApi | typeof PerformanceCalibrationApi | typeof PostProcessingApi | typeof ProjectsApi | typeof RawDataApi | typeof TestApi | typeof ThemesApi | typeof ThirdPartyAuthApi | typeof UploadPortalApi | typeof UserApi | typeof VlmApi | typeof WhitelabelsApi)[];
+export const APIS: (typeof AdminApi | typeof AuthApi | typeof CDNApi | typeof CanaryApi | typeof ClassifyApi | typeof DSPApi | typeof DatasetVersionsApi | typeof DeploymentApi | typeof DevicesApi | typeof EmailVerificationApi | typeof ExportApi | typeof FeatureFlagsApi | typeof HealthApi | typeof ImpulseApi | typeof IntegrationsApi | typeof JobsApi | typeof LearnApi | typeof LoginApi | typeof MetricsApi | typeof MonitoringApi | typeof OptimizationApi | typeof OrganizationBlocksApi | typeof OrganizationCreateProjectApi | typeof OrganizationDataApi | typeof OrganizationDataCampaignsApi | typeof OrganizationJobsApi | typeof OrganizationPipelinesApi | typeof OrganizationPortalsApi | typeof OrganizationsApi | typeof PerformanceCalibrationApi | typeof PostProcessingApi | typeof ProjectsApi | typeof RawDataApi | typeof TestApi | typeof ThemesApi | typeof ThirdPartyAuthApi | typeof UploadPortalApi | typeof UserApi | typeof VlmApi | typeof WhitelabelsApi)[];
 
 
 /**
@@ -4524,6 +4524,195 @@ export class MetricsApi {
 }
 
 
+/**
+ * Edge Impulse API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export enum MonitoringApiApiKeys {
+    ApiKeyAuthentication = 0,
+    JWTAuthentication = 1,
+    JWTHttpHeaderAuthentication = 2
+}
+type listMonitoringEventsQueryParams = {
+    limit?: number;
+};
+export type MonitoringApiOpts = {
+    extraHeaders?: Record<string, string>;
+};
+export class MonitoringApi {
+    protected _basePath: string;
+    protected defaultHeaders: Record<string, string>;
+    protected _opts: MonitoringApiOpts;
+    protected authentications: {
+        default: Authentication;
+        ApiKeyAuthentication: ApiKeyAuth;
+        OAuth2: OAuth;
+        JWTAuthentication: ApiKeyAuth;
+        JWTHttpHeaderAuthentication: ApiKeyAuth;
+    };
+    protected handleResponse(response: Response | Response, returnType: string | undefined): Promise<any>;
+    constructor(basePath?: string, opts?: MonitoringApiOpts);
+    set basePath(basePath: string);
+    get basePath(): string;
+    set opts(opts: MonitoringApiOpts);
+    get opts(): MonitoringApiOpts;
+    setDefaultAuthentication(auth: Authentication): void;
+    setApiKey(key: MonitoringApiApiKeys, value: string | undefined): void;
+    set accessToken(token: string);
+    /**
+     * Create a monitoring event subscription for this project.
+     * @summary Create event subscription
+     * @param projectId Project ID
+     * @param createEventSubscriptionRequest
+     */
+    createEventSubscription(projectId: number, createEventSubscriptionRequest: CreateEventSubscriptionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateEventSubscriptionResponse>;
+    /**
+     * Create a new webhook destination for this project.
+     * @summary Create a new webhook destination
+     * @param projectId Project ID
+     * @param createWebhookDestinationRequest
+     */
+    createWebhookDestination(projectId: number, createWebhookDestinationRequest: CreateWebhookDestinationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<CreateWebhookDestinationResponse>;
+    /**
+     * Delete a monitoring event subscription.
+     * @summary Delete event subscription
+     * @param projectId Project ID
+     * @param eventSubscriptionId Event subscription ID
+     */
+    deleteEventSubscription(projectId: number, eventSubscriptionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Delete a webhook destination.
+     * @summary Delete webhook destination
+     * @param projectId Project ID
+     * @param webhookId Webhook destination ID
+     */
+    deleteWebhookDestination(projectId: number, webhookId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Get details about a monitoring event subscription.
+     * @summary Get event subscription
+     * @param projectId Project ID
+     * @param eventSubscriptionId Event subscription ID
+     */
+    getEventSubscription(projectId: number, eventSubscriptionId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetEventSubscriptionResponse>;
+    /**
+     * Get details about a webhook destination.
+     * @summary Get webhook destination
+     * @param projectId Project ID
+     * @param webhookId Webhook destination ID
+     */
+    getWebhookDestination(projectId: number, webhookId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GetWebhookDestinationResponse>;
+    /**
+     * List all monitoring event subscriptions for this project.
+     * @summary List event subscriptions
+     * @param projectId Project ID
+     */
+    listEventSubscriptions(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListEventSubscriptionsResponse>;
+    /**
+     * List recent monitoring events generated for this project.
+     * @summary List recent monitoring events
+     * @param projectId Project ID
+     * @param limit Number of recent events to fetch. Maximum is 100. Defaults to 20.
+     */
+    listMonitoringEvents(projectId: number, queryParams?: listMonitoringEventsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListMonitoringEventsResponse>;
+    /**
+     * List all webhook destinations for this project.
+     * @summary List webhook destinations
+     * @param projectId Project ID
+     */
+    listWebhookDestinations(projectId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<ListWebhookDestinationsResponse>;
+    /**
+     * Rotate the signing secret for a webhook destination. Note that rotating the secret does not reset consecutive_failures, and does not re-enable a disabled webhook. Use the update endpoint for that.
+     * @summary Rotate webhook destination secret
+     * @param projectId Project ID
+     * @param webhookId Webhook destination ID
+     */
+    rotateWebhookDestinationSecret(projectId: number, webhookId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<RotateWebhookDestinationSecretResponse>;
+    /**
+     * Send a test webhook to the configured URL for this destination. This is useful for testing if the webhook is configured correctly.
+     * @summary Test webhook destination
+     * @param projectId Project ID
+     * @param webhookId Webhook destination ID
+     */
+    testWebhookDestination(projectId: number, webhookId: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<TestWebhookDestinationResponse>;
+    /**
+     * Update a monitoring event subscription.
+     * @summary Update event subscription
+     * @param projectId Project ID
+     * @param eventSubscriptionId Event subscription ID
+     * @param updateEventSubscriptionRequest
+     */
+    updateEventSubscription(projectId: number, eventSubscriptionId: number, updateEventSubscriptionRequest: UpdateEventSubscriptionRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+    /**
+     * Update the details of a webhook destination. Note that re-enabling a previously auto-disabled webhook resets consecutive_failures to 0. Note that only the rotate-secret endpoint can update the signing secret.
+     * @summary Update webhook destination
+     * @param projectId Project ID
+     * @param webhookId Webhook destination ID
+     * @param updateWebhookDestinationRequest
+     */
+    updateWebhookDestination(projectId: number, webhookId: string, updateWebhookDestinationRequest: UpdateWebhookDestinationRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
+}
+export {};
+
+
 /**
  * Edge Impulse API
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
@@ -14048,6 +14237,45 @@ export type CreateEnterpriseTrialUserRequestUserHasMLModelsInProductionEnum = 'y
 export const CreateEnterpriseTrialUserRequestUserHasMLModelsInProductionEnumValues: string[];
 
 
+export type CreateEventSubscriptionRequest = {
+    /**
+    * Monitoring event type to subscribe to.
+    */
+    eventType: string;
+    /**
+    * Optional webhook destination ID to route this event subscription to. Set to null to detach.
+    */
+    webhookId?: string | null;
+    /**
+    * Optional description for this event subscription.
+    */
+    description?: string;
+    /**
+    * Whether this event subscription is enabled. If not set, it will default to true.
+    */
+    enabled?: boolean;
+    /**
+    * Optional key-value pair filters applied to event metadata for this destination.
+    */
+    metadataFilters?: {
+        [key: string]: string;
+    };
+};
+
+
+export type CreateEventSubscriptionResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    subscription: EventSubscription;
+};
+
+
 export type CreateImpulseRequest = {
     /**
     * Name for this impulse (optional). If no name is provided one is created based on your blocks.
@@ -14593,6 +14821,40 @@ export type CreateUserThirdPartyResponseStatusEnum = 'userWasCreated' | 'userNot
 export const CreateUserThirdPartyResponseStatusEnumValues: string[];
 
 
+export type CreateWebhookDestinationRequest = {
+    /**
+    * The URL to send the webhook POST requests to. Must start with https://.
+    */
+    url: string;
+    /**
+    * Optional description for the webhook destination.
+    */
+    description?: string;
+};
+
+
+export type CreateWebhookDestinationResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    /**
+    * The unique identifier of the created webhook destination. This ID is used to manage the destination (e.g., update
+    * or delete it).
+    */
+    id: string;
+    /**
+    * A secret key used to verify the authenticity of the webhook requests sent to the specified URL. It can only be
+    * retrieved once at the time of subscription creation, so make sure to store it securely.
+    */
+    signingSecret: string;
+};
+
+
 export type CreateWhitelabelRequest = {
     /**
     * The name of the white label.
@@ -16724,6 +16986,40 @@ export type EvaluateResultValue = {
 };
 
 
+export type EventSubscription = {
+    /**
+    * Numeric ID of the event subscription.
+    */
+    id: number;
+    /**
+    * Monitoring event type.
+    */
+    eventType: string;
+    /**
+    * Optional webhook destination ID this event subscription is attached to.
+    */
+    webhookId?: string | null;
+    /**
+    * Optional description for this event subscription.
+    */
+    description?: string;
+    /**
+    * Whether this event subscription is enabled.
+    */
+    enabled: boolean;
+    /**
+    * Timestamp of when the event subscription was created.
+    */
+    created: Date;
+    /**
+    * Optional key-value pair filters applied to event metadata for this destination.
+    */
+    metadataFilters?: {
+        [key: string]: string;
+    };
+};
+
+
 /**
 * EXPERIMENTAL: Training processor for the impulse-specific-gpu rollout. This field is currently gated by a project
 * experiment and may change in future API versions.
@@ -17344,6 +17640,19 @@ export type GetEmailVerificationStatusResponse = {
 };
 
 
+export type GetEventSubscriptionResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    subscription: EventSubscription;
+};
+
+
 export type GetFeatureFlagsResponse = {
     /**
     * Whether the operation succeeded
@@ -18659,6 +18968,19 @@ export type GetUserResponse = {
 };
 
 
+export type GetWebhookDestinationResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    webhook: WebhookDestination;
+};
+
+
 export type GetWhitelabelDomainResponse = {
     /**
     * Whether the operation succeeded
@@ -20075,6 +20397,19 @@ export type ListEnterpriseTrialsResponse = {
 };
 
 
+export type ListEventSubscriptionsResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    subscriptions: EventSubscription[];
+};
+
+
 export type ListHmacKeysResponse = {
     /**
     * Whether the operation succeeded
@@ -20124,6 +20459,19 @@ export type ListModelsResponse = {
 };
 
 
+export type ListMonitoringEventsResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    events: MonitoringEvent[];
+};
+
+
 export type ListOrganizationApiKeysResponse = {
     /**
     * Whether the operation succeeded
@@ -20608,6 +20956,19 @@ export type ListVersionsResponse = {
 };
 
 
+export type ListWebhookDestinationsResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    webhooks: WebhookDestination[];
+};
+
+
 export type LogAnalyticsEventRequest = {
     /**
     * Optional session ID for users who have not signed in yet. Helps match anonymous activity with user activity once
@@ -20830,6 +21191,42 @@ export type ModelVariantStats = {
 };
 
 
+export type MonitoringEvent = {
+    /**
+    * Numeric ID of the monitoring event row.
+    */
+    id: number;
+    /**
+    * Stable event identifier.
+    */
+    eventId: string;
+    /**
+    * Monitoring event type.
+    */
+    eventType: string;
+    /**
+    * Event payload.
+    */
+    payload: {
+        [key: string]: object;
+    };
+    /**
+    * Processing status for this event.
+    */
+    status: MonitoringEventStatusEnum;
+    /**
+    * Timestamp of when this event was created.
+    */
+    created: Date;
+    /**
+    * Timestamp of when this event was processed.
+    */
+    processedAt?: Date | null;
+};
+export type MonitoringEventStatusEnum = 'pending' | 'processing' | 'delivered' | 'failed';
+export const MonitoringEventStatusEnumValues: string[];
+
+
 export type MoveRawDataRequest = {
     newCategory: RawDataCategory;
 };
@@ -20894,7 +21291,7 @@ export type NeighborsScore = {
 };
 
 
-export type OAuthScope = 'deployments:create' | 'deployments:delete' | 'deployments:read' | 'deployments:update' | 'devices:create' | 'devices:delete' | 'devices:read' | 'devices:update' | 'jobs:read' | 'organizations:read' | 'projects:apikeys:ingestiononly:create' | 'projects:apikeys:ingestiononly:delete' | 'projects:create' | 'projects:delete' | 'projects:read' | 'projects:update' | 'user:read' | 'user:update';
+export type OAuthScope = 'deployments:create' | 'deployments:delete' | 'deployments:read' | 'deployments:update' | 'devices:create' | 'devices:delete' | 'devices:read' | 'devices:update' | 'jobs:read' | 'organizations:read' | 'projects:apikeys:ingestiononly:create' | 'projects:apikeys:ingestiononly:delete' | 'projects:create' | 'projects:delete' | 'projects:monitoring:write' | 'projects:monitoring:update' | 'projects:monitoring:read' | 'projects:monitoring:delete' | 'projects:read' | 'projects:update' | 'user:read' | 'user:update';
 export const OAuthScopeValues: string[];
 
 
@@ -24704,6 +25101,23 @@ export type RestoreProjectRequest = {
 };
 
 
+export type RotateWebhookDestinationSecretResponse = {
+    /**
+    * Whether the operation succeeded
+    */
+    success: boolean;
+    /**
+    * Optional error description (set if 'success' was false)
+    */
+    error?: string;
+    /**
+    * A new secret key used to verify the authenticity of the webhook requests sent to the specified URL. It can only be
+    * retrieved once at the time of rotation, so make sure to store it securely.
+    */
+    signingSecret: string;
+};
+
+
 export type RunOrganizationPipelineResponse = {
     /**
     * Whether the operation succeeded
@@ -25865,6 +26279,28 @@ export type TestPretrainedModelResponseAllOfFreeformResultOutputTensorsDataTypeE
 export const TestPretrainedModelResponseAllOfFreeformResultOutputTensorsDataTypeEnumValues: string[];
 
 
+export type TestWebhookDestinationResponse = {
+    /**
+    * Whether the test webhook request was successfully sent and received by the endpoint.
+    */
+    success: boolean;
+    /**
+    * If the test webhook request failed, this field contains the error message or reason for failure.
+    */
+    error?: string;
+    /**
+    * The delivery status of the test webhook request (e.g., 200 for success, 400 for bad request, etc.). If the request
+    * failed to be sent at all (e.g., due to network error), this field may be null and the 'error' field will contain
+    * the error message.
+    */
+    deliveryStatus: number;
+    /**
+    * The response time of the endpoint in milliseconds.
+    */
+    responseTimeMs: number;
+};
+
+
 export type Theme = {
     id: number;
     ownerUserId?: number;
@@ -26274,6 +26710,32 @@ export type UpdateDatasetVersionRequest = {
 };
 
 
+export type UpdateEventSubscriptionRequest = {
+    /**
+    * Monitoring event type to subscribe to.
+    */
+    eventType?: string;
+    /**
+    * Optional webhook destination ID to route this event subscription to. Set to null to detach.
+    */
+    webhookId?: string | null;
+    /**
+    * Optional description for this event subscription.
+    */
+    description?: string;
+    /**
+    * Whether this event subscription is enabled.
+    */
+    enabled?: boolean;
+    /**
+    * Optional key-value pair filters applied to event metadata for this destination.
+    */
+    metadataFilters?: {
+        [key: string]: string;
+    };
+};
+
+
 export type UpdateImpulseRequest = {
     name?: string;
     tags?: string[];
@@ -26931,6 +27393,22 @@ export type UpdateVersionRequest = {
 };
 
 
+export type UpdateWebhookDestinationRequest = {
+    /**
+    * The URL to send the webhook POST requests to. Must start with https://.
+    */
+    url?: string;
+    /**
+    * Optional description for the webhook destination.
+    */
+    description?: string;
+    /**
+    * Whether the webhook destination is currently enabled.
+    */
+    enabled?: boolean;
+};
+
+
 export type UpdateWhitelabelDefaultDeploymentTargetRequest = {
     /**
     * Name of the default deployment target
@@ -27845,6 +28323,34 @@ export type VlmPromptConfigParameters = {
 export type VlmSetConfigResponse = GenericApiResponse;
 
 
+export type WebhookDestination = {
+    /**
+    * The unique identifier of the webhook destination.
+    */
+    id: string;
+    /**
+    * The URL to which the webhook POST requests are sent.
+    */
+    url: string;
+    /**
+    * Description for the webhook destination.
+    */
+    description?: string;
+    /**
+    * Whether the webhook destination is currently enabled.
+    */
+    enabled?: boolean;
+    /**
+    * Number of consecutive failed webhook deliveries. This can be used to monitor the health of the webhook endpoint.
+    */
+    consecutiveFailures?: number;
+    /**
+    * Timestamp of when the webhook destination was created.
+    */
+    created?: Date;
+};
+
+
 export type Whitelabel = {
     id: number;
     name: string;