@nangohq/types/dist/logs/api.d.ts

Types used in Nango applications

import type { Endpoint } from '../api';
import type { PickFromUnion } from '../utils';
import type { MessageRow, OperationList, OperationRow, OperationState } from './messages';
type Concat<T extends OperationList> = T extends {
    action: string;
} ? `${T['type']}:${T['action']}` : never;
export type ConcatOperationList = Concat<OperationList>;
export type ConcatOperationListWithGroup = OperationList['type'] | ConcatOperationList;
export type SearchOperations = Endpoint<{
    Method: 'POST';
    Path: '/api/v1/logs/operations';
    Querystring: {
        env: string;
    };
    Body: {
        search?: string | undefined;
        limit?: number;
        states?: SearchOperationsState[];
        types?: SearchOperationsType[];
        integrations?: SearchOperationsIntegration[] | undefined;
        connections?: SearchOperationsConnection[] | undefined;
        syncs?: SearchOperationsSync[] | undefined;
        period?: SearchPeriod | undefined;
        cursor?: string | null | undefined;
    };
    Success: {
        data: OperationRow[];
        pagination: {
            total: number;
            cursor: string | null;
        };
    };
}>;
export type SearchOperationsState = 'all' | OperationState;
export type SearchOperationsType = 'all' | ConcatOperationListWithGroup;
export type SearchOperationsIntegration = 'all' | string;
export type SearchOperationsConnection = 'all' | string;
export type SearchOperationsSync = 'all' | string;
export interface SearchPeriod {
    from: string;
    to: string;
}
export type SearchOperationsData = SearchOperations['Success']['data'][0];
export type GetOperation = Endpoint<{
    Method: 'GET';
    Path: `/api/v1/logs/operations/:operationId`;
    Querystring: {
        env: string;
    };
    Params: {
        operationId: string;
    };
    Success: {
        data: OperationRow;
    };
}>;
export type SearchMessages = Endpoint<{
    Method: 'POST';
    Path: '/api/v1/logs/messages';
    Querystring: {
        env: string;
    };
    Body: {
        operationId: string;
        limit?: number;
        states?: SearchOperationsState[];
        search?: string | undefined;
        cursorBefore?: string | null | undefined;
        cursorAfter?: string | null | undefined;
        period?: SearchPeriod | undefined;
    };
    Success: {
        data: MessageRow[];
        pagination: {
            total: number;
            cursorBefore: string | null;
            cursorAfter: string | null;
        };
    };
}>;
export type SearchMessagesData = SearchMessages['Success']['data'][0];
export type SearchFilters = Endpoint<{
    Method: 'POST';
    Path: '/api/v1/logs/filters';
    Querystring: {
        env: string;
    };
    Body: {
        category: 'integration' | 'syncConfig' | 'connection';
        search?: string | undefined;
    };
    Success: {
        data: {
            key: string;
            doc_count: number;
        }[];
    };
}>;
export type SearchFiltersData = SearchMessages['Success']['data'][0];
export type PostInsights = Endpoint<{
    Method: 'POST';
    Path: '/api/v1/logs/insights';
    Querystring: {
        env: string;
    };
    Body: {
        type: PickFromUnion<ConcatOperationListWithGroup, 'action' | 'sync:run' | 'proxy' | 'webhook:incoming' | 'auth:create_connection'>;
    };
    Success: {
        data: {
            histogram: InsightsHistogramEntry[];
        };
    };
}>;
export interface InsightsHistogramEntry {
    key: string;
    total: number;
    success: number;
    failure: number;
    cancelled: number;
    expired: number;
    running: number;
}
export {};