@limai.io/cli 0.4.0 → 0.4.1

package/dist/index.d.ts

@@ -12,8 +12,12 @@ declare class HttpClient {
     private getRetryDelay;
     private request;
     get<T>(apiPath: string, params?: Record<string, string | undefined>, timeoutMs?: number): Promise<T>;
-    post<T>(apiPath: string, body?: unknown, timeoutMs?: number): Promise<T>;
-    patch<T>(apiPath: string, body?: unknown): Promise<T>;
+    post<T>(apiPath: string, body?: unknown, timeoutMs?: number, opts?: {
+        retry?: boolean;
+    }): Promise<T>;
+    patch<T>(apiPath: string, body?: unknown, opts?: {
+        retry?: boolean;
+    }): Promise<T>;
     del<T>(apiPath: string, body?: unknown): Promise<T>;
     putRaw(url: string, body: Uint8Array | Buffer | Blob, contentType: string, onProgress?: (uploaded: number, total: number) => void): Promise<void>;
     putFile(url: string, filePath: string, contentType: string, onProgress?: (uploaded: number, total: number) => void): Promise<number>;
@@ -85,6 +89,7 @@ type FileValidationCheck = {
     completedAt: string | null;
 };
 type FileValidations = {
+    status: "pending" | "passed" | "failed" | "error" | null;
     failCount: number | null;
     checks: FileValidationCheck[];
     rules: {
@@ -113,13 +118,68 @@ type Row = {
     cells: Record<string, CellValue>;
     childTables?: Record<string, TableData>;
 };
+type ColumnLabel = {
+    id: string;
+    name: string;
+    color: string;
+};
+type ColumnUnit = {
+    id: string;
+    name: string;
+};
 type Column = {
     id: string;
     name: string;
     slug?: string | null;
     type: string;
-    description?: string;
+    description?: string | null;
     sharedColumnId?: string;
+    isKey?: boolean;
+    isList?: boolean;
+    dateFormat?: string | null;
+    measurementType?: string;
+    excludedFromExtraction?: boolean;
+    defaultValue?: unknown;
+    defaultValueEnabled?: boolean;
+    autoGenerateLabels?: boolean;
+    autoGenerateUnits?: boolean;
+    pinned?: boolean;
+    size?: number;
+    sharedId?: string | null;
+    index?: number;
+    tableId?: string;
+    labels?: ColumnLabel[];
+    units?: ColumnUnit[];
+    createdAt?: string;
+    updatedAt?: string;
+};
+type ColumnInput = {
+    name: string;
+    slug?: string;
+    type?: string;
+    description?: string | null;
+    isKey?: boolean;
+    isList?: boolean;
+    dateFormat?: string;
+    measurementType?: string;
+    excludedFromExtraction?: boolean;
+    pinned?: boolean;
+    size?: number;
+    defaultValue?: unknown;
+    defaultValueEnabled?: boolean;
+    autoGenerateLabels?: boolean;
+    autoGenerateUnits?: boolean;
+    labels?: Array<{
+        name: string;
+        color?: string;
+    }>;
+    units?: Array<{
+        name: string;
+    }>;
+};
+type ColumnUpdateInput = Partial<Omit<ColumnInput, "name">> & {
+    name?: string;
+    confirmSlugChange?: boolean;
 };
 type TableData = {
     id: string;
@@ -188,6 +248,7 @@ type FlatRow = {
     $index: string;
 } & Record<string, unknown>;
 type FlatFileValidations = {
+    status: "pending" | "passed" | "failed" | "error" | null;
     failCount: number | null;
     checks: {
         key: string;
@@ -256,6 +317,7 @@ type DeploymentConfig = {
     temperature?: number;
     instructions?: string;
     bigTableExtraction?: string;
+    useDynamicMapping?: boolean;
     bboxTier?: "OFF" | "FAST" | "BALANCED" | "PRO";
     enableConfidenceScore?: boolean;
     enableLLMConfidence?: boolean;
@@ -372,6 +434,7 @@ type ExtractionSchema = {
     instructions?: string;
     temperature?: number;
     bigTableExtraction?: string;
+    useDynamicMapping?: boolean;
     bboxTier?: "OFF" | "FAST" | "BALANCED" | "PRO";
     enableConfidenceScore?: boolean;
 };
@@ -507,10 +570,12 @@ type AgentSkill = {
     updatedAt: string;
     linkedFiles?: AgentSkillLinkedFile[];
 };
+type AgentRole = "GENERAL" | "VALIDATOR";
 type Agent = {
     id: string;
     name: string;
     status: AgentStatus;
+    role?: AgentRole;
     tier?: "STANDARD" | "STANDARD_PLUS" | "MAX";
     processContent: string;
     triggerTypes: AgentTriggerType[];
@@ -576,6 +641,45 @@ type AgentRunConversation = {
     unavailable?: boolean;
     source?: "s3" | "sandbox" | "unavailable";
 };
+type AgentRunInferenceLog = {
+    id: string;
+    createdAt: string;
+    processingLogId: string | null;
+    serviceType: string | null;
+    callType: string;
+    model: string;
+    temperature: number | null;
+    stepNumber: number | null;
+    attemptNumber: number | null;
+    tableName: string | null;
+    durationMs: number;
+    inputTokens: number | null;
+    outputTokens: number | null;
+    cachedInputTokens: number | null;
+    reasoningTokens: number | null;
+    status: string;
+    errorMessage: string | null;
+    files: Array<{
+        filename: string;
+        mediaType: string;
+        role?: string;
+    }>;
+};
+type AgentRunInferenceLogSummary = {
+    totalCalls: number;
+    successCount: number;
+    errorCount: number;
+    totalInputTokens: number;
+    totalOutputTokens: number;
+    totalDurationMs: number;
+};
+type AgentRunInferenceLogs = {
+    runId: string;
+    data: AgentRunInferenceLog[];
+    summary: AgentRunInferenceLogSummary;
+    truncated: boolean;
+    redactions: Record<string, number>;
+};
 
 declare class QueueResource {
     private http;
@@ -618,6 +722,11 @@ type CreateProjectBody = {
     teamId?: string;
     icon?: string;
 };
+type DeleteProjectResponse = {
+    success: boolean;
+    id: string;
+    name: string;
+};
 type NotificationChannelType = "SLACK" | "TEAMS_CHANNEL" | "TEAMS_CHAT" | "EMAIL_ADDRESS";
 type NotificationIntegrationProvider = "SLACK" | "TEAMS" | "SHAREPOINT" | "GOOGLE_DRIVE";
 type NotificationRoute = {
@@ -679,7 +788,7 @@ declare class ProjectsResource {
     constructor(http: HttpClient);
     list(): Promise<Project[]>;
     create(body: CreateProjectBody): Promise<Project>;
-    getSchema(projectId: string): Promise<unknown>;
+    delete(projectId: string): Promise<DeleteProjectResponse>;
     getSharedColumnIds(projectId: string): Promise<unknown>;
     listDeployments(projectId: string): Promise<unknown>;
     listBenchmarks(projectId: string): Promise<unknown>;
@@ -741,6 +850,17 @@ declare class TablesResource {
     }): Promise<Table>;
 }
 
+declare class ColumnsResource {
+    private http;
+    constructor(http: HttpClient);
+    list(tableId: string): Promise<Column[]>;
+    get(columnId: string): Promise<Column>;
+    create(tableId: string, body: ColumnInput | {
+        columns: ColumnInput[];
+    }): Promise<Column[]>;
+    update(columnId: string, body: ColumnUpdateInput): Promise<Column>;
+}
+
 type OffsetFetcher<T> = (limit: number, offset: number) => Promise<{
     data: T[];
     pagination: {
@@ -786,10 +906,38 @@ declare class ExtractionsResource {
     }): Promise<ExtractionRow[]>;
 }
 
+type ClassifierRouteProject = {
+    id: string;
+    name: string;
+};
+type ClassifierDeploymentRoute = {
+    id: string;
+    name: string;
+    description: string;
+    deploymentId: string;
+    deployment?: {
+        id: string;
+        name: string;
+        type: string;
+        projectId: string;
+        project?: ClassifierRouteProject;
+    };
+};
+type ClassifierSummary = {
+    id: string;
+    name: string;
+    projectId: string | null;
+    isGlobal?: boolean;
+    routeProjects?: ClassifierRouteProject[];
+    deploymentRoutes?: ClassifierDeploymentRoute[];
+    classificationCount?: number;
+    createdAt: string;
+    updatedAt: string;
+};
 declare class ClassifyResource {
     private http;
     constructor(http: HttpClient);
-    list(projectId: string): Promise<unknown>;
+    list(projectId: string): Promise<ClassifierSummary[]>;
     getUploadUrl(classifierId: string, filename: string): Promise<GetUrlResponse>;
     classify(classifierId: string, fileId: string): Promise<ClassificationResult>;
     classifyAsync(classifierId: string, fileId: string): Promise<ClassificationAsyncResponse>;
@@ -829,7 +977,7 @@ declare class SchemaResource {
     private http;
     constructor(http: HttpClient);
     get(extractionSchemaId: string): Promise<ExtractionSchema>;
-    update(extractionSchemaId: string, body: Partial<DeploymentConfig>): Promise<void>;
+    update(extractionSchemaId: string, body: Partial<DeploymentConfig>): Promise<DeploymentConfig>;
     getAllData(extractionSchemaId: string): Promise<unknown>;
 }
 
@@ -871,6 +1019,8 @@ declare class AgentsResource {
             enabled?: boolean;
             config?: Record<string, unknown>;
         }>;
+        tier?: string;
+        role?: string;
         emailLocalPart?: string;
     }): Promise<AgentDetail>;
     update(projectId: string, agentId: string, body: {
@@ -887,6 +1037,7 @@ declare class AgentsResource {
         }>;
         status?: string;
         tier?: string;
+        role?: string;
         emailLocalPart?: string;
     }): Promise<Agent>;
     delete(projectId: string, agentId: string): Promise<void>;
@@ -932,6 +1083,10 @@ declare class AgentsResource {
     getRunConversation(projectId: string, agentId: string, runId: string, opts?: {
         stepId?: string;
     }): Promise<AgentRunConversation>;
+    getRunInferenceLogs(projectId: string, agentId: string, runId: string, opts?: {
+        limit?: number;
+        status?: string;
+    }): Promise<AgentRunInferenceLogs>;
     createRun(projectId: string, agentId: string, body: {
         triggerEventId: string;
         triggerType: string;
@@ -1097,6 +1252,38 @@ declare class VisionResource {
     ask(projectId: string, body: VisionAskBody): Promise<VisionAskResponse>;
 }
 
+type ValidationScript = {
+    id: string;
+    extractionSchemaId: string;
+    key: string;
+    name: string;
+    description: string | null;
+    behavior: "SURFACE" | "RESEND";
+    s3Key: string;
+    version: number;
+    contentHash: string;
+    enabled: boolean;
+    timeoutMs: number;
+    createdAt: string;
+    updatedAt: string;
+    source?: string;
+};
+type PushValidationScriptBody = {
+    key: string;
+    name: string;
+    description?: string | null;
+    behavior?: "SURFACE" | "RESEND";
+    source: string;
+    enabled?: boolean;
+    timeoutMs?: number;
+};
+type UpdateValidationScriptBody = {
+    name?: string;
+    description?: string | null;
+    behavior?: "SURFACE" | "RESEND";
+    enabled?: boolean;
+    timeoutMs?: number;
+};
 declare class ValidationsResource {
     private http;
     constructor(http: HttpClient);
@@ -1107,6 +1294,20 @@ declare class ValidationsResource {
         newRows?: unknown;
         strict?: boolean;
     }): Promise<unknown>;
+    listScripts(extractionSchemaId: string): Promise<ValidationScript[]>;
+    getScript(extractionSchemaId: string, key: string, opts?: {
+        includeSource?: boolean;
+    }): Promise<ValidationScript>;
+    pushScript(extractionSchemaId: string, body: PushValidationScriptBody): Promise<{
+        action: string;
+        script: ValidationScript;
+    }>;
+    updateScript(extractionSchemaId: string, key: string, body: UpdateValidationScriptBody): Promise<ValidationScript>;
+    deleteScript(extractionSchemaId: string, key: string): Promise<{
+        deleted: boolean;
+        key: string;
+        deletedResults: number;
+    }>;
 }
 
 type LabelListResponse = {
@@ -1144,6 +1345,163 @@ declare class LabelsResource {
     }): Promise<LabelSearchResponse>;
 }
 
+declare const WEBHOOK_EVENT_TYPES: readonly ["DOCUMENT_EXTRACTED", "DOCUMENT_REVIEWED", "DOCUMENT_EXTRACTION_FAILED", "DOCUMENT_VALIDATED", "DOCUMENT_VALIDATION_STARTED", "DOCUMENT_VALIDATION_FAILED", "DOCUMENT_CLASSIFIED", "DOCUMENT_CLASSIFICATION_FAILED", "DOCUMENT_SPLIT", "DOCUMENT_SPLIT_FAILED", "AGENT_RUN_STARTED", "AGENT_RUN_COMPLETED", "AGENT_RUN_FAILED", "AGENT_RUN_WAITING_HUMAN"];
+type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
+declare const WEBHOOK_DELIVERY_STATUSES: readonly ["success", "failed", "dead_lettered", "retrying", "pending"];
+type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
+declare const WEBHOOK_METRICS_WINDOWS: readonly ["24h", "7d", "30d"];
+type WebhookMetricsWindow = (typeof WEBHOOK_METRICS_WINDOWS)[number];
+declare const WEBHOOK_METRICS_BUCKETS: readonly ["hour", "day"];
+type WebhookMetricsBucket = (typeof WEBHOOK_METRICS_BUCKETS)[number];
+type WebhookRouteFamily = "deployment" | "agent" | "classifier" | "splitter";
+type WebhookDeploymentRoute = {
+    id: string;
+    name: string;
+    type: string;
+};
+type WebhookNamedRoute = {
+    id: string;
+    name: string;
+};
+type Webhook = {
+    id: string;
+    projectId: string;
+    url: string;
+    events: WebhookEventType[];
+    isActive: boolean;
+    isVerified: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deployments: WebhookDeploymentRoute[];
+    agents: WebhookNamedRoute[];
+    classifiers: WebhookNamedRoute[];
+    splitters: WebhookNamedRoute[];
+};
+type WebhookWithSecret = Webhook & {
+    secretKey: string;
+};
+type WebhookListResponse = {
+    webhooks: Webhook[];
+};
+type WebhookRouteIdsInput = {
+    deploymentIds?: string[];
+    agentIds?: string[];
+    classifierIds?: string[];
+    splitterIds?: string[];
+};
+type CreateWebhookInput = WebhookRouteIdsInput & {
+    url?: string;
+    events?: WebhookEventType[];
+};
+type UpdateWebhookInput = CreateWebhookInput & {
+    isActive?: boolean;
+};
+type WebhookDelivery = {
+    eventId: string;
+    subscriptionId: string;
+    eventType: string;
+    timestamp: string;
+    url: string;
+    status: WebhookDeliveryStatus;
+    responseCode?: number;
+    responseBody?: string;
+    errorType?: string;
+    durationMs?: number;
+    retryCount: number;
+    routeFamily?: WebhookRouteFamily;
+    deploymentId?: string;
+    deploymentName?: string;
+    agentId?: string;
+    agentName?: string;
+    classifierId?: string;
+    classifierName?: string;
+    splitterId?: string;
+    splitterName?: string;
+};
+type WebhookDeliveriesResponse = {
+    deliveries: WebhookDelivery[];
+    total: number;
+    limit: number;
+    offset: number;
+};
+type WebhookDeliveriesQuery = {
+    status?: string;
+    eventType?: string;
+    deploymentId?: string;
+    agentId?: string;
+    classifierId?: string;
+    splitterId?: string;
+    limit?: number;
+    offset?: number;
+};
+type WebhookRouteMetrics = {
+    routeFamily: WebhookRouteFamily;
+    routeId: string;
+    routeName: string;
+    totalEvents: number;
+    successfulEvents: number;
+    failedEvents: number;
+    pendingEvents: number;
+    successRate: number;
+};
+type WebhookDeliveryPoint = {
+    bucket: string;
+    successful: number;
+    failed: number;
+    pending: number;
+};
+type WebhookMetrics = {
+    organizationId: string;
+    totalEvents: number;
+    successfulEvents: number;
+    failedEvents: number;
+    pendingEvents: number;
+    successRate: number;
+    averageResponseTime?: number;
+    perRoute: WebhookRouteMetrics[];
+    series: WebhookDeliveryPoint[];
+    window: WebhookMetricsWindow;
+    bucket: WebhookMetricsBucket;
+};
+type WebhookMetricsQuery = {
+    window?: WebhookMetricsWindow;
+    bucket?: WebhookMetricsBucket;
+};
+type WebhookVerifyResponse = {
+    success: boolean;
+    message: string;
+};
+type WebhookRetryDelivery = {
+    eventId: string;
+    url: string;
+};
+type WebhookRetrySkip = WebhookRetryDelivery & {
+    reason: string;
+};
+type WebhookRetryResponse = {
+    retriedCount: number;
+    retried: WebhookRetryDelivery[];
+    skipped: WebhookRetrySkip[];
+    message: string;
+};
+declare class WebhooksResource {
+    private http;
+    constructor(http: HttpClient);
+    private basePath;
+    list(projectId: string): Promise<WebhookListResponse>;
+    get(projectId: string, webhookId: string): Promise<Webhook>;
+    create(projectId: string, input: CreateWebhookInput): Promise<WebhookWithSecret>;
+    update(projectId: string, webhookId: string, input: UpdateWebhookInput): Promise<Webhook>;
+    delete(projectId: string, webhookId: string): Promise<void>;
+    pause(projectId: string, webhookId: string): Promise<Webhook>;
+    resume(projectId: string, webhookId: string): Promise<Webhook>;
+    verify(projectId: string, webhookId: string): Promise<WebhookVerifyResponse>;
+    rotateSecret(projectId: string, webhookId: string): Promise<WebhookWithSecret>;
+    deliveries(projectId: string, webhookId: string, query?: WebhookDeliveriesQuery): Promise<WebhookDeliveriesResponse>;
+    metrics(projectId: string, webhookId: string, query?: WebhookMetricsQuery): Promise<WebhookMetrics>;
+    retry(projectId: string, webhookId: string, eventIds: string[]): Promise<WebhookRetryResponse>;
+}
+
 type LimaiClientConfig = {
     apiUrl: string;
     token: string;
@@ -1155,6 +1513,7 @@ declare class LimaiClient {
     readonly projects: ProjectsResource;
     readonly deployments: DeploymentsResource;
     readonly tables: TablesResource;
+    readonly columns: ColumnsResource;
     readonly extractions: ExtractionsResource;
     readonly queue: QueueResource;
     readonly classify: ClassifyResource;
@@ -1165,6 +1524,7 @@ declare class LimaiClient {
     readonly vision: VisionResource;
     readonly validations: ValidationsResource;
     readonly labels: LabelsResource;
+    readonly webhooks: WebhooksResource;
     constructor(config: LimaiClientConfig);
     uploadFile(extractionSchemaId: string, filePath: string, onProgress?: (uploaded: number, total: number) => void): Promise<UploadResult>;
     uploadFolder(extractionSchemaId: string, dirPath: string, opts?: {
@@ -1290,4 +1650,4 @@ declare class UploadError extends LimaiError {
 }
 declare function mapHttpError(status: number, message: string, details?: unknown): LimaiError;
 
-export { type Agent, type AgentDeploymentRoute, type AgentDetail, type AgentFile, type AgentIntegrationConfig, type AgentRowData, type AgentRun, type AgentRunConversation, type AgentRunDetail, type AgentRunStatus, type AgentSkill, type AgentSkillLinkedFile, type AgentStatus, type AgentStep, type AgentStepType, type AgentSubmission, type AgentTriggerType, AuthError, type Bucket, type BucketFile, type BulkFileResult, type BulkFlatDocumentDataResponse, type BulkGetFilesDataResponse, type BulkProcessResponse, type BulkProcessResult, type BulkUploadFileStatus, type BulkUploadResult, type CellBoundingBox, type CellConfidence, type CellValidation, type CellValue, type ClassificationAsyncResponse, type ClassificationResult, type ClassificationStatus, type Column, ConflictError, type CreateRowInput, type CreateRowsRequest, type CreateRowsResponse, type DeleteRowsRequest, type DeleteRowsResponse, type Deployment, type DeploymentConfig, type DeploymentStatus, type DeploymentType, type Document, type ExtractionRow, type ExtractionSchema, type ExtractionsResponse, type FileData, type FileStatus, type FileValidationCheck, type FileValidations, type FlatCellData, type FlatCellValidation, type FlatDocumentDataResponse, type FlatDocumentEntry, type FlatFileValidations, type FlatRow, ForbiddenError, type GetUrlResponse, HttpClient, type IncludeOption, type JobContext, type JobContextColumn, type JobContextTable, JobPoller, type JobStatus, type JobStatusValue, LimaiClient, type LimaiClientConfig, type LimaiConfig, LimaiError, NotFoundError, type OffsetPaginatedResponse, type OffsetPagination, type PagePaginatedResponse, type PagePagination, type PaginationOptions, type PollOptions, type ProcessFileAsyncResponse, type ProcessOptions, type Project, RateLimitError, type Row, SSEClient, ServerError, type SplitAsyncResponse, type SplitResult, type SplitSegment, type SplitStatus, type StageStatus, type Table, type TableData, TimeoutError, type UpdateStatusRequest, type UpdateStatusResponse, UploadError, type UploadResult, ValidationError, type ValidationResult, collectAll, getDeploymentId, getFileId, getJobId, loadConfig, loadJobContext, mapHttpError, paginateOffset, paginatePage, requireConfig, saveConfig, validateSubmission };
+export { type Agent, type AgentDeploymentRoute, type AgentDetail, type AgentFile, type AgentIntegrationConfig, type AgentRole, type AgentRowData, type AgentRun, type AgentRunConversation, type AgentRunDetail, type AgentRunInferenceLog, type AgentRunInferenceLogSummary, type AgentRunInferenceLogs, type AgentRunStatus, type AgentSkill, type AgentSkillLinkedFile, type AgentStatus, type AgentStep, type AgentStepType, type AgentSubmission, type AgentTriggerType, AuthError, type Bucket, type BucketFile, type BulkFileResult, type BulkFlatDocumentDataResponse, type BulkGetFilesDataResponse, type BulkProcessResponse, type BulkProcessResult, type BulkUploadFileStatus, type BulkUploadResult, type CellBoundingBox, type CellConfidence, type CellValidation, type CellValue, type ClassificationAsyncResponse, type ClassificationResult, type ClassificationStatus, type Column, type ColumnInput, type ColumnLabel, type ColumnUnit, type ColumnUpdateInput, ConflictError, type CreateRowInput, type CreateRowsRequest, type CreateRowsResponse, type DeleteRowsRequest, type DeleteRowsResponse, type Deployment, type DeploymentConfig, type DeploymentStatus, type DeploymentType, type Document, type ExtractionRow, type ExtractionSchema, type ExtractionsResponse, type FileData, type FileStatus, type FileValidationCheck, type FileValidations, type FlatCellData, type FlatCellValidation, type FlatDocumentDataResponse, type FlatDocumentEntry, type FlatFileValidations, type FlatRow, ForbiddenError, type GetUrlResponse, HttpClient, type IncludeOption, type JobContext, type JobContextColumn, type JobContextTable, JobPoller, type JobStatus, type JobStatusValue, LimaiClient, type LimaiClientConfig, type LimaiConfig, LimaiError, NotFoundError, type OffsetPaginatedResponse, type OffsetPagination, type PagePaginatedResponse, type PagePagination, type PaginationOptions, type PollOptions, type ProcessFileAsyncResponse, type ProcessOptions, type Project, RateLimitError, type Row, SSEClient, ServerError, type SplitAsyncResponse, type SplitResult, type SplitSegment, type SplitStatus, type StageStatus, type Table, type TableData, TimeoutError, type UpdateStatusRequest, type UpdateStatusResponse, UploadError, type UploadResult, ValidationError, type ValidationResult, collectAll, getDeploymentId, getFileId, getJobId, loadConfig, loadJobContext, mapHttpError, paginateOffset, paginatePage, requireConfig, saveConfig, validateSubmission };