@harnessio/react-integration-manager-client 0.4.9 → 0.4.10

package/dist/integration-manager/src/services/hooks/useListIntegrationEventsQuery.d.ts

@@ -1,5 +1,6 @@
 import { UseQueryOptions } from '@tanstack/react-query';
 import type { IntegrationeventIntegrationEventResponse } from '../schemas/IntegrationeventIntegrationEventResponse';
+import type { ApierrorsErrorResponse } from '../schemas/ApierrorsErrorResponse';
 import type { ResponseWithPagination } from '../helpers';
 import { FetcherOptions } from '../../../../fetcher/index.js';
 export interface ListIntegrationEventsQueryPathParams {
@@ -8,52 +9,60 @@ export interface ListIntegrationEventsQueryPathParams {
 }
 export interface ListIntegrationEventsQueryQueryParams {
     /**
-     * Filter by event type (repeatable)
+     * Filter by one or more event types (repeatable)
      */
-    event_type?: string[];
+    event_type?: Array<'entity_auto_import' | 'entity_manual_import' | 'entity_unlinked' | 'integration_created' | 'integration_disabled' | 'integration_enabled' | 'integration_updated' | 'sync_run'>;
     /**
-     * Filter by UI status: SUCCESS, FAILED, RUNNING, PARTIAL_SUCCESS (repeatable)
+     * Filter by one or more UI status values (repeatable)
      */
-    status?: string[];
+    status?: Array<'FAILED' | 'PARTIAL_SUCCESS' | 'RUNNING' | 'SUCCESS'>;
     /**
-     * Sort field: created_at or updated_at (default: updated_at)
+     * Sort field (default: updated_at)
+     * @default "updated_at"
      */
-    sort?: string;
+    sort?: 'created_at' | 'updated_at';
     /**
-     * Sort order: asc or desc (default: desc)
+     * Sort order (default: desc)
+     * @default "desc"
      */
-    order?: string;
+    order?: 'asc' | 'desc';
     /**
-     * Page number (default: 1)
+     * Page number, 0-based (default: 0)
+     * @default 0
      */
     page?: number;
     /**
-     * Page size (default: 30, max: 100)
+     * Number of items per page (default: 20, max: 100)
+     * @default 20
      */
     limit?: number;
 }
 export type ListIntegrationEventsOkResponse = ResponseWithPagination<IntegrationeventIntegrationEventResponse[]>;
-export type ListIntegrationEventsErrorResponse = unknown;
+export type ListIntegrationEventsErrorResponse = ApierrorsErrorResponse;
 export interface ListIntegrationEventsProps extends ListIntegrationEventsQueryPathParams, Omit<FetcherOptions<ListIntegrationEventsQueryQueryParams, unknown>, 'url'> {
     queryParams: ListIntegrationEventsQueryQueryParams;
 }
 export declare function listIntegrationEvents(props: ListIntegrationEventsProps): Promise<ListIntegrationEventsOkResponse>;
 /**
- * List lifecycle and sync events for an integration.
- *
- * Supports filtering by event_type and status (both repeatable query params).
- * Status values are UI-simplified: SUCCESS, FAILED, RUNNING, PARTIAL_SUCCESS.
- * Results are sorted by updated_at descending by default.
- * Pagination metadata is included in response headers (x-page, x-per-page, x-total, x-total-pages).
+ * Retrieves a paginated list of integration lifecycle events for a specific integration.
+ * Supports filtering by event_type and status (both repeatable query params), with
+ * customizable sorting and pagination. Pagination metadata is included in response
+ * headers (x-total-elements, x-page-number, x-page-size, x-total-pages).
  *
  * Event types:
- * - sync_run: Sync execution lifecycle (SCHEDULED -> SUBMITTED -> RUNNING -> COMPLETED/FAILED)
  * - integration_created: Integration was created
  * - integration_updated: Integration configuration was modified
  * - integration_enabled: Integration was enabled
  * - integration_disabled: Integration was disabled
+ * - sync_run: Sync execution lifecycle (SCHEDULED -> SUBMITTED -> RUNNING -> COMPLETED/FAILED)
+ * - entity_auto_import: Entities were auto-imported during sync
  * - entity_manual_import: Entities were manually imported (subscribed)
  * - entity_unlinked: Entities were unlinked (unsubscribed)
- * - entity_auto_import: Entities were auto-imported during sync
+ *
+ * UI Status values:
+ * - SUCCESS: Operation completed successfully (maps to COMPLETED, SUCCESS)
+ * - FAILED: Operation failed (maps to FAILED, STALE, SUPERSEDED)
+ * - RUNNING: Operation in progress (maps to SCHEDULED, SUBMITTED, RUNNING)
+ * - PARTIAL_SUCCESS: Operation completed with partial success
  */
-export declare function useListIntegrationEventsQuery(props: ListIntegrationEventsProps, options?: Omit<UseQueryOptions<ListIntegrationEventsOkResponse, ListIntegrationEventsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationEventsOkResponse, unknown>;
+export declare function useListIntegrationEventsQuery(props: ListIntegrationEventsProps, options?: Omit<UseQueryOptions<ListIntegrationEventsOkResponse, ListIntegrationEventsErrorResponse>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<ListIntegrationEventsOkResponse, ApierrorsErrorResponse>;

package/dist/integration-manager/src/services/hooks/useListIntegrationEventsQuery.js

@@ -7,22 +7,26 @@ export function listIntegrationEvents(props) {
     return fetcher(Object.assign({ url: `/api/v1/accounts/${props.accountIdentifier}/integration-configs/${props.integrationconfig_identifier}/events`, method: 'GET' }, props));
 }
 /**
- * List lifecycle and sync events for an integration.
- *
- * Supports filtering by event_type and status (both repeatable query params).
- * Status values are UI-simplified: SUCCESS, FAILED, RUNNING, PARTIAL_SUCCESS.
- * Results are sorted by updated_at descending by default.
- * Pagination metadata is included in response headers (x-page, x-per-page, x-total, x-total-pages).
+ * Retrieves a paginated list of integration lifecycle events for a specific integration.
+ * Supports filtering by event_type and status (both repeatable query params), with
+ * customizable sorting and pagination. Pagination metadata is included in response
+ * headers (x-total-elements, x-page-number, x-page-size, x-total-pages).
  *
  * Event types:
- * - sync_run: Sync execution lifecycle (SCHEDULED -> SUBMITTED -> RUNNING -> COMPLETED/FAILED)
  * - integration_created: Integration was created
  * - integration_updated: Integration configuration was modified
  * - integration_enabled: Integration was enabled
  * - integration_disabled: Integration was disabled
+ * - sync_run: Sync execution lifecycle (SCHEDULED -> SUBMITTED -> RUNNING -> COMPLETED/FAILED)
+ * - entity_auto_import: Entities were auto-imported during sync
  * - entity_manual_import: Entities were manually imported (subscribed)
  * - entity_unlinked: Entities were unlinked (unsubscribed)
- * - entity_auto_import: Entities were auto-imported during sync
+ *
+ * UI Status values:
+ * - SUCCESS: Operation completed successfully (maps to COMPLETED, SUCCESS)
+ * - FAILED: Operation failed (maps to FAILED, STALE, SUPERSEDED)
+ * - RUNNING: Operation in progress (maps to SCHEDULED, SUBMITTED, RUNNING)
+ * - PARTIAL_SUCCESS: Operation completed with partial success
  */
 export function useListIntegrationEventsQuery(props, options) {
     return useQuery([

package/dist/integration-manager/src/services/index.d.ts

@@ -126,6 +126,7 @@ export type { EnumSyncResponseStatus } from './schemas/EnumSyncResponseStatus';
 export type { EnumSyncStatus } from './schemas/EnumSyncStatus';
 export type { IntegrationconfigAirbyteIntegrationResponse } from './schemas/IntegrationconfigAirbyteIntegrationResponse';
 export type { IntegrationeventIntegrationEventResponse } from './schemas/IntegrationeventIntegrationEventResponse';
+export type { IntegrationeventPrincipalInfo } from './schemas/IntegrationeventPrincipalInfo';
 export type { IntegrationeventUiStatus } from './schemas/IntegrationeventUiStatus';
 export type { OpenapiCreateAgentRequest } from './schemas/OpenapiCreateAgentRequest';
 export type { OpenapiCreateAirbyteIntegrationConfigOrgRequest } from './schemas/OpenapiCreateAirbyteIntegrationConfigOrgRequest';

package/dist/integration-manager/src/services/schemas/IntegrationeventIntegrationEventResponse.d.ts

@@ -1,21 +1,39 @@
 import type { EnumIntegrationEventType } from '../schemas/EnumIntegrationEventType';
 import type { IntegrationeventUiStatus } from '../schemas/IntegrationeventUiStatus';
+import type { IntegrationeventPrincipalInfo } from '../schemas/IntegrationeventPrincipalInfo';
+/**
+ * Integration event with UI-friendly status mapping
+ */
 export interface IntegrationeventIntegrationEventResponse {
     /**
+     * Timestamp when the event was created
      * @format date-time
      */
-    created_at?: string;
-    event_type?: EnumIntegrationEventType;
-    id?: string;
-    integration_id?: string;
+    created_at: string;
+    event_type: EnumIntegrationEventType;
+    /**
+     * Unique identifier for the event
+     */
+    id: string;
+    /**
+     * Identifier of the integration configuration
+     */
+    integration_id: string;
+    /**
+     * Additional event-specific metadata
+     */
     metadata?: {
         [key: string]: any;
-    };
-    space_path?: string;
-    status?: IntegrationeventUiStatus;
+    } | null;
+    /**
+     * Hierarchical path to the space (account/org/project)
+     */
+    space_path: string;
+    status: IntegrationeventUiStatus;
     /**
+     * Timestamp when the event was last updated
      * @format date-time
      */
-    updated_at?: string;
-    updated_by_uid?: string;
+    updated_at: string;
+    updated_by: IntegrationeventPrincipalInfo;
 }

package/dist/integration-manager/src/services/schemas/IntegrationeventPrincipalInfo.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Information about the user or system that updated the event
+ */
+export interface IntegrationeventPrincipalInfo {
+    /**
+     * Display name of the principal
+     */
+    display_name: string;
+    /**
+     * Email address of the principal (empty for system principals)
+     */
+    email?: string;
+    /**
+     * Unique identifier of the principal
+     */
+    uid: string;
+}

package/dist/integration-manager/src/services/schemas/IntegrationeventPrincipalInfo.js

@@ -0,0 +1,4 @@
+/* eslint-disable */
+// This code is autogenerated using @harnessio/oats-cli.
+// Please do not modify this code directly.
+export {};

package/dist/integration-manager/src/services/schemas/IntegrationeventUiStatus.d.ts

@@ -1 +1,4 @@
-export type IntegrationeventUiStatus = string;
+/**
+ * Simplified UI status of an integration event
+ */
+export type IntegrationeventUiStatus = 'FAILED' | 'PARTIAL_SUCCESS' | 'RUNNING' | 'SUCCESS';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/react-integration-manager-client",
-  "version": "0.4.9",
+  "version": "0.4.10",
   "description": "Harness React integration manager client - Integration Manager APIs integrated with react hooks",
   "author": "Harness Inc",
   "license": "MIT",