@rossum/api-client 0.1.25 → 0.1.30

package/types/src/dedicatedEngineSchema/models/integrityValidationResults.d.ts

@@ -1,31 +0,0 @@
-type Errors = string[];
-type SourceValidateResult = Partial<{
-    schemaId: Errors;
-    queue: Errors;
-}>;
-type DatapointFieldValidateResult = Partial<{
-    engineOutputId: Errors;
-    type: Errors;
-    label: Errors;
-    description: Errors;
-    sources: Record<string, SourceValidateResult>;
-    nonFieldErrors: Errors;
-}>;
-type AllFieldsValidateResult = Partial<{
-    engineOutputId: Errors;
-    type: Errors;
-    label: Errors;
-    description: Errors;
-    sources: Record<string, SourceValidateResult>;
-    nonFieldErrors: Errors;
-    children: {
-        children: Record<string, DatapointFieldValidateResult>;
-    } | DatapointFieldValidateResult;
-}>;
-export type DedicatedEngineSchemaValidationResult = Partial<{
-    content: Partial<{
-        fields: Record<string, AllFieldsValidateResult>;
-        trainingQueues: Record<string, Errors>;
-    }>;
-}>;
-export {};

package/types/src/dedicatedEngines/models/dedicatedEngine.d.ts

@@ -1,10 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-export type DedicatedEngineStatus = 'sample_review' | 'draft' | 'schema_review' | 'annotating_initial' | 'annotating_review' | 'annotating_training' | 'training_started' | 'training_finished' | 'retraining';
-export type DedicatedEngine = {
-    id: ID;
-    name: string;
-    url: Url;
-    status: DedicatedEngineStatus;
-    schema: Url | null;
-    description: string;
-};

package/types/src/deleteRecommendations/models/deleteRecommendation.d.ts

@@ -1,10 +0,0 @@
-import { TriggerUrl } from '../../triggers/models/trigger';
-import { ID, Url } from '../../utils/codecUtils';
-export type DeleteRecommendation = {
-    id: ID;
-    enabled: boolean;
-    url: Url;
-    organization: Url;
-    queue: Url;
-    triggers: TriggerUrl[];
-};

package/types/src/deleteRecommendations/models/index.d.ts

@@ -1 +0,0 @@
-export * from './deleteRecommendation';

package/types/src/email/models/email.d.ts

@@ -1,39 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-export type EmailAddressObject = {
-    email: string;
-    name?: string | null;
-};
-export type Email = {
-    id: ID;
-    url: Url;
-    queue: Url;
-    inbox: Url | null;
-    documents: Url[];
-    parent: Url | null;
-    children: Url[];
-    createdAt: string;
-    subject: string;
-    to: Partial<EmailAddressObject>[];
-    cc: Partial<EmailAddressObject>[];
-    bcc: Partial<EmailAddressObject>[];
-    bodyTextPlain: string | null;
-    bodyTextHtml: string | null;
-    metadata?: unknown;
-    type: 'incoming' | 'outgoing';
-    annotationCounts: {
-        annotations: number;
-        annotationsProcessed: number;
-        annotationsRejected: number;
-        annotationsUnprocessed: number;
-        annotationsPurged?: number;
-    };
-    annotations: Url[];
-    creator: Url | null;
-    lastThreadEmailCreatedAt?: string;
-    filteredOutDocumentCount: number;
-    labels: string[];
-    emailThread: Url | null;
-    relatedAnnotations: Url[];
-    relatedDocuments: Url[];
-    from: EmailAddressObject;
-};

package/types/src/emailTemplatesStats/models/emailTemplateStats.d.ts

@@ -1,6 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-export type EmailTemplateStats = {
-    url: Url;
-    manualCount: number;
-    automatedCount: number;
-};

package/types/src/emailTemplatesStats/models/index.d.ts

@@ -1 +0,0 @@
-export * from './emailTemplateStats';

package/types/src/emailThreads/models/emailThreads.d.ts

@@ -1,32 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-export type EmailThread = {
-    id: ID;
-    url: Url;
-    organization: Url;
-    queue: Url;
-    rootEmail: Url | null;
-    hasReplies: boolean;
-    hasNewReplies: boolean;
-    rootEmailRead: boolean;
-    lastEmailCreatedAt: string | null;
-    subject?: string | null;
-    createdAt?: string | null;
-    from: {
-        email: string;
-        name?: string;
-    } | null;
-    labels?: string[];
-    annotationCounts: {
-        annotations: number;
-        annotationsProcessed: number;
-        annotationsRejected: number;
-        annotationsUnprocessed: number;
-        annotationsPurged: number | null;
-        relatedAnnotations: number | null;
-    };
-};
-export type EmailThreadCounts = {
-    withReplies: number;
-    withNewReplies: number;
-    recentWithNoDocumentsNotReplied: number;
-};

package/types/src/genericEngines/models/genericEngine.d.ts

@@ -1,9 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-export type GenericEngine = {
-    id: ID;
-    name: string;
-    url: Url;
-    schema: Url | null;
-    description: string;
-    documentationUrl: string | null;
-};

package/types/src/groups/models/group.d.ts

@@ -1,7 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-export type GroupUrl = Url;
-export type Group = {
-    id: ID;
-    name: string;
-    url: GroupUrl;
-};

package/types/src/groups/models/index.d.ts

@@ -1 +0,0 @@
-export * from './group';

package/types/src/hookTemplates/models/hookTemplate.d.ts

@@ -1,40 +0,0 @@
-import { FunctionConfig, WebhookConfig } from '../../hooks/models/hookConfig';
-import { ExtensionEvent, ExtensionSource } from '../../hooks/models/hookUtils';
-import { Url } from '../../utils/codecUtils';
-type SettingsDescription = Partial<{
-    name: string;
-    description: string;
-    tooltip: string;
-}>;
-type HookTemplateBase = {
-    name: string;
-    url: Url;
-    events: ExtensionEvent[];
-    sideload: string[];
-    metadata?: unknown;
-    test?: unknown;
-    description: string;
-    extensionSource: ExtensionSource;
-    settings?: Record<string, unknown>;
-    guide: string;
-    readMoreUrl: Url | null;
-    extensionImageUrl: Url | null;
-    settingsDescription: SettingsDescription[];
-    storeDescription: string;
-    externalUrl: Url;
-    useTokenOwner: boolean;
-    order: number;
-} & Partial<{
-    id: number;
-    installAction: string;
-}>;
-type WebhookTemplate = HookTemplateBase & {
-    type: 'webhook';
-    config: WebhookConfig;
-};
-type FunctionTemplate = HookTemplateBase & {
-    type: 'function';
-    config: FunctionConfig;
-};
-export type HookTemplate = WebhookTemplate | FunctionTemplate;
-export {};

package/types/src/hooks/endpoints/logs.d.ts

@@ -1,411 +0,0 @@
-import { Log } from '../models/log';
-export type LogsQuery = {
-    timestampAfter?: string;
-    timestampBefore?: string;
-    search?: string;
-    hook?: Array<string>;
-    requestId?: string;
-    logLevel?: string;
-    statusCode?: Array<string>;
-    queue?: Array<string>;
-    annotation?: Array<string>;
-    email?: Array<string>;
-    pageSize?: string;
-};
-export type Logs = {
-    results: Array<Log>;
-};
-export declare const logs: (query?: LogsQuery) => {
-    readonly endpoint: "/hooks/logs";
-    readonly method: "GET";
-    readonly responseSchema: import("zod").ZodObject<{
-        results: import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodIntersection<import("zod").ZodObject<{
-            hookId: import("zod").ZodNumber;
-            hookType: import("zod").ZodUnion<[import("zod").ZodLiteral<"webhook">, import("zod").ZodLiteral<"function">]>;
-            logLevel: import("zod").ZodUnion<[import("zod").ZodLiteral<"INFO">, import("zod").ZodLiteral<"WARNING">, import("zod").ZodLiteral<"ERROR">]>;
-            message: import("zod").ZodString;
-            queueId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            request: import("zod").ZodNullable<import("zod").ZodString>;
-            requestId: import("zod").ZodString;
-            response: import("zod").ZodNullable<import("zod").ZodString>;
-            timestamp: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }>, import("zod").ZodObject<{
-            annotationId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            event: import("zod").ZodLiteral<"annotation_content">;
-            action: import("zod").ZodUnion<[import("zod").ZodLiteral<"confirm">, import("zod").ZodLiteral<"export">, import("zod").ZodLiteral<"initialize">, import("zod").ZodLiteral<"started">, import("zod").ZodLiteral<"updated">, import("zod").ZodLiteral<"user_update">]>;
-        }, "strip", import("zod").ZodTypeAny, {
-            event: "annotation_content";
-            action: "started" | "confirm" | "export" | "initialize" | "updated" | "user_update";
-            annotationId?: number | null | undefined;
-        }, {
-            event: "annotation_content";
-            action: "started" | "confirm" | "export" | "initialize" | "updated" | "user_update";
-            annotationId?: number | null | undefined;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            hookId: import("zod").ZodNumber;
-            hookType: import("zod").ZodUnion<[import("zod").ZodLiteral<"webhook">, import("zod").ZodLiteral<"function">]>;
-            logLevel: import("zod").ZodUnion<[import("zod").ZodLiteral<"INFO">, import("zod").ZodLiteral<"WARNING">, import("zod").ZodLiteral<"ERROR">]>;
-            message: import("zod").ZodString;
-            queueId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            request: import("zod").ZodNullable<import("zod").ZodString>;
-            requestId: import("zod").ZodString;
-            response: import("zod").ZodNullable<import("zod").ZodString>;
-            timestamp: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }>, import("zod").ZodObject<{
-            annotationId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            event: import("zod").ZodLiteral<"annotation_status">;
-            action: import("zod").ZodLiteral<"changed">;
-        }, "strip", import("zod").ZodTypeAny, {
-            event: "annotation_status";
-            action: "changed";
-            annotationId?: number | null | undefined;
-        }, {
-            event: "annotation_status";
-            action: "changed";
-            annotationId?: number | null | undefined;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            hookId: import("zod").ZodNumber;
-            hookType: import("zod").ZodUnion<[import("zod").ZodLiteral<"webhook">, import("zod").ZodLiteral<"function">]>;
-            logLevel: import("zod").ZodUnion<[import("zod").ZodLiteral<"INFO">, import("zod").ZodLiteral<"WARNING">, import("zod").ZodLiteral<"ERROR">]>;
-            message: import("zod").ZodString;
-            queueId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            request: import("zod").ZodNullable<import("zod").ZodString>;
-            requestId: import("zod").ZodString;
-            response: import("zod").ZodNullable<import("zod").ZodString>;
-            timestamp: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }>, import("zod").ZodObject<{
-            emailId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            event: import("zod").ZodLiteral<"upload">;
-            action: import("zod").ZodLiteral<"created">;
-        }, "strip", import("zod").ZodTypeAny, {
-            event: "upload";
-            action: "created";
-            emailId?: number | null | undefined;
-        }, {
-            event: "upload";
-            action: "created";
-            emailId?: number | null | undefined;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            hookId: import("zod").ZodNumber;
-            hookType: import("zod").ZodUnion<[import("zod").ZodLiteral<"webhook">, import("zod").ZodLiteral<"function">]>;
-            logLevel: import("zod").ZodUnion<[import("zod").ZodLiteral<"INFO">, import("zod").ZodLiteral<"WARNING">, import("zod").ZodLiteral<"ERROR">]>;
-            message: import("zod").ZodString;
-            queueId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            request: import("zod").ZodNullable<import("zod").ZodString>;
-            requestId: import("zod").ZodString;
-            response: import("zod").ZodNullable<import("zod").ZodString>;
-            timestamp: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }>, import("zod").ZodObject<{
-            emailId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            event: import("zod").ZodLiteral<"email">;
-            action: import("zod").ZodLiteral<"received">;
-        }, "strip", import("zod").ZodTypeAny, {
-            event: "email";
-            action: "received";
-            emailId?: number | null | undefined;
-        }, {
-            event: "email";
-            action: "received";
-            emailId?: number | null | undefined;
-        }>>, import("zod").ZodIntersection<import("zod").ZodObject<{
-            hookId: import("zod").ZodNumber;
-            hookType: import("zod").ZodUnion<[import("zod").ZodLiteral<"webhook">, import("zod").ZodLiteral<"function">]>;
-            logLevel: import("zod").ZodUnion<[import("zod").ZodLiteral<"INFO">, import("zod").ZodLiteral<"WARNING">, import("zod").ZodLiteral<"ERROR">]>;
-            message: import("zod").ZodString;
-            queueId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodNumber>>;
-            request: import("zod").ZodNullable<import("zod").ZodString>;
-            requestId: import("zod").ZodString;
-            response: import("zod").ZodNullable<import("zod").ZodString>;
-            timestamp: import("zod").ZodString;
-        }, "strip", import("zod").ZodTypeAny, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }, {
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        }>, import("zod").ZodObject<{
-            event: import("zod").ZodLiteral<"invocation">;
-            action: import("zod").ZodUnion<[import("zod").ZodLiteral<"manual">, import("zod").ZodLiteral<"scheduled">]>;
-        }, "strip", import("zod").ZodTypeAny, {
-            event: "invocation";
-            action: "manual" | "scheduled";
-        }, {
-            event: "invocation";
-            action: "manual" | "scheduled";
-        }>>]>, "many">;
-    }, "strip", import("zod").ZodTypeAny, {
-        results: (({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "annotation_content";
-            action: "started" | "confirm" | "export" | "initialize" | "updated" | "user_update";
-            annotationId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "annotation_status";
-            action: "changed";
-            annotationId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "upload";
-            action: "created";
-            emailId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "email";
-            action: "received";
-            emailId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "invocation";
-            action: "manual" | "scheduled";
-        }))[];
-    }, {
-        results: (({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "annotation_content";
-            action: "started" | "confirm" | "export" | "initialize" | "updated" | "user_update";
-            annotationId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "annotation_status";
-            action: "changed";
-            annotationId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "upload";
-            action: "created";
-            emailId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "email";
-            action: "received";
-            emailId?: number | null | undefined;
-        }) | ({
-            message: string;
-            hookId: number;
-            requestId: string;
-            timestamp: string;
-            hookType: "function" | "webhook";
-            logLevel: "INFO" | "WARNING" | "ERROR";
-            request: string | null;
-            response: string | null;
-            queueId?: number | null | undefined;
-        } & {
-            event: "invocation";
-            action: "manual" | "scheduled";
-        }))[];
-    }>;
-    readonly query: LogsQuery;
-    readonly querySchema: import("zod").ZodObject<{
-        timestampAfter: import("zod").ZodOptional<import("zod").ZodString>;
-        timestampBefore: import("zod").ZodOptional<import("zod").ZodString>;
-        search: import("zod").ZodOptional<import("zod").ZodString>;
-        hook: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        requestId: import("zod").ZodOptional<import("zod").ZodString>;
-        logLevel: import("zod").ZodOptional<import("zod").ZodString>;
-        statusCode: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        queue: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        annotation: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        email: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
-        pageSize: import("zod").ZodOptional<import("zod").ZodString>;
-    }, "strip", import("zod").ZodTypeAny, {
-        timestampAfter?: string | undefined;
-        timestampBefore?: string | undefined;
-        search?: string | undefined;
-        hook?: string[] | undefined;
-        requestId?: string | undefined;
-        logLevel?: string | undefined;
-        statusCode?: string[] | undefined;
-        queue?: string[] | undefined;
-        annotation?: string[] | undefined;
-        email?: string[] | undefined;
-        pageSize?: string | undefined;
-    }, {
-        timestampAfter?: string | undefined;
-        timestampBefore?: string | undefined;
-        search?: string | undefined;
-        hook?: string[] | undefined;
-        requestId?: string | undefined;
-        logLevel?: string | undefined;
-        statusCode?: string[] | undefined;
-        queue?: string[] | undefined;
-        annotation?: string[] | undefined;
-        email?: string[] | undefined;
-        pageSize?: string | undefined;
-    }>;
-};