twenty-sdk 2.55.0 → 2.56.0

package/dist/logic-function/index.d.ts

@@ -18,34 +18,6 @@ type AgentJsonResponseFormat = {
 };
 type AgentResponseFormat = AgentTextResponseFormat | AgentJsonResponseFormat;
 
-declare enum FieldMetadataType {
-    ACTOR = "ACTOR",
-    ADDRESS = "ADDRESS",
-    ARRAY = "ARRAY",
-    BOOLEAN = "BOOLEAN",
-    CURRENCY = "CURRENCY",
-    DATE = "DATE",
-    DATE_TIME = "DATE_TIME",
-    EMAILS = "EMAILS",
-    FILES = "FILES",
-    FULL_NAME = "FULL_NAME",
-    LINKS = "LINKS",
-    MORPH_RELATION = "MORPH_RELATION",
-    MULTI_SELECT = "MULTI_SELECT",
-    NUMBER = "NUMBER",
-    NUMERIC = "NUMERIC",
-    PHONES = "PHONES",
-    POSITION = "POSITION",
-    RATING = "RATING",
-    RAW_JSON = "RAW_JSON",
-    RELATION = "RELATION",
-    RICH_TEXT = "RICH_TEXT",
-    SELECT = "SELECT",
-    TEXT = "TEXT",
-    TS_VECTOR = "TS_VECTOR",
-    UUID = "UUID"
-}
-
 type _JSONSchema = boolean | JSONSchema;
 type SchemaType = "object" | "array" | "string" | "number" | "boolean" | "null" | "integer";
 type JSONSchema = {
@@ -2084,6 +2056,11 @@ interface ZodString extends _ZodString<$ZodStringInternals<string>> {
     duration(params?: string | $ZodCheckISODurationParams): this;
 }
 declare const ZodString: $constructor<ZodString>;
+interface _ZodBoolean<T extends $ZodBooleanInternals = $ZodBooleanInternals> extends _ZodType<T> {
+}
+interface ZodBoolean extends _ZodBoolean<$ZodBooleanInternals<boolean>> {
+}
+declare const ZodBoolean: $constructor<ZodBoolean>;
 interface ZodAny extends _ZodType<$ZodAnyInternals> {
 }
 declare const ZodAny: $constructor<ZodAny>;
@@ -2231,6 +2208,34 @@ interface ZodReadonly<T extends SomeType = $ZodType> extends _ZodType<$ZodReadon
 }
 declare const ZodReadonly: $constructor<ZodReadonly>;
 
+declare enum FieldMetadataType {
+    ACTOR = "ACTOR",
+    ADDRESS = "ADDRESS",
+    ARRAY = "ARRAY",
+    BOOLEAN = "BOOLEAN",
+    CURRENCY = "CURRENCY",
+    DATE = "DATE",
+    DATE_TIME = "DATE_TIME",
+    EMAILS = "EMAILS",
+    FILES = "FILES",
+    FULL_NAME = "FULL_NAME",
+    LINKS = "LINKS",
+    MORPH_RELATION = "MORPH_RELATION",
+    MULTI_SELECT = "MULTI_SELECT",
+    NUMBER = "NUMBER",
+    NUMERIC = "NUMERIC",
+    PHONES = "PHONES",
+    POSITION = "POSITION",
+    RATING = "RATING",
+    RAW_JSON = "RAW_JSON",
+    RELATION = "RELATION",
+    RICH_TEXT = "RICH_TEXT",
+    SELECT = "SELECT",
+    TEXT = "TEXT",
+    TS_VECTOR = "TS_VECTOR",
+    UUID = "UUID"
+}
+
 declare enum HTTPMethod {
     GET = "GET",
     POST = "POST",
@@ -2385,6 +2390,11 @@ type HttpRouteTriggerSettings = {
     forwardedRequestHeaders?: string[];
 };
 
+type AiRunUsage = {
+    inputTokens: number;
+    outputTokens: number;
+};
+
 type AppConnectionBase = {
     id: string;
     providerName: string;
@@ -2499,6 +2509,15 @@ type JobStatusResult = {
     finishedAt?: number | null;
 };
 
+type GenerateResult = {
+    success: boolean;
+    text: string | null;
+    object: Record<string, unknown> | null;
+    error: string | null;
+    runId: string;
+    usage: AiRunUsage;
+};
+
 type IdentifyAccountPayload = {
     connectionProviderId: string;
     connectionProviderName: string;
@@ -2568,6 +2587,7 @@ type RunAgentInput = {
 });
 type RunAgentResult = {
     threadId: string;
+    runId: string;
     status: 'COMPLETED' | 'SUSPENDED' | 'FAILED' | 'RUNNING';
     result: object | null;
     error: string | null;
@@ -2907,6 +2927,135 @@ declare const syncMessageFolders: (input: SyncMessageFoldersInput) => Promise<Ap
 
 declare const runAgent: ({ input, ...rest }: RunAgentInput) => Promise<RunAgentResult>;
 
+type AgentConversationInput = {
+    agentUniversalIdentifier: string;
+    threadKey: string;
+};
+type AgentConversationMessage = {
+    id: string;
+    role: 'system' | 'user' | 'assistant';
+    parts: ({
+        type: string;
+    } & Record<string, unknown>)[];
+    metadata?: {
+        createdAt?: string;
+        startedAt?: string;
+        finishedAt?: string;
+        senderWorkspaceMemberId?: string | null;
+        turnId?: string | null;
+    };
+};
+type AgentConversationHistory = {
+    messages: AgentConversationMessage[];
+    streamCatchup: {
+        chunks: Record<string, unknown>[];
+        maxSeq: number;
+        error: {
+            code: string;
+            message: string;
+        } | null;
+    };
+};
+
+declare const listConversationMessages: (conversation: AgentConversationInput) => Promise<AgentConversationHistory>;
+
+type AgentMessageReactionSummary = {
+    emoji: string;
+    workspaceMemberIds: string[];
+    agentIds: string[];
+    hasAssistantReacted: boolean;
+};
+
+type AgentChatSubscriptionEvent = {
+    type: 'stream-chunk';
+    chunk: Record<string, unknown>;
+    seq?: number;
+} | {
+    type: 'message-persisted';
+    messageId: string;
+    turnId?: string;
+} | {
+    type: 'stream-ended';
+} | {
+    type: 'run-finished';
+    turnId: string;
+} | {
+    type: 'message-added';
+    messageId: string;
+} | {
+    type: 'queue-updated';
+} | {
+    type: 'tool-call-resolved';
+    toolCallId: string;
+} | {
+    type: 'message-reactions-updated';
+    messageId: string;
+    reactions: AgentMessageReactionSummary[];
+    revision: number;
+} | {
+    type: 'stream-error';
+    code: string;
+    message: string;
+} | {
+    type: 'credits-exhausted';
+    turnId?: string;
+} | {
+    type: 'user-credits-exhausted';
+    workspaceMemberId: string;
+    isFallingBackToWorkspaceCredits: boolean;
+    renewsAt: string;
+} | {
+    type: 'keepalive';
+};
+
+declare const aiRunScopeSchema: ZodObject<{
+    canReadAllObjectRecords: ZodOptional<ZodBoolean>;
+    canUpdateAllObjectRecords: ZodOptional<ZodBoolean>;
+    canSoftDeleteAllObjectRecords: ZodOptional<ZodBoolean>;
+    canDestroyAllObjectRecords: ZodOptional<ZodBoolean>;
+    canUpdateAllSettings: ZodOptional<ZodBoolean>;
+    canAccessAllTools: ZodOptional<ZodBoolean>;
+    objectPermissions: ZodOptional<ZodArray<ZodObject<{
+        objectUniversalIdentifier: ZodString;
+        canReadObjectRecords: ZodOptional<ZodBoolean>;
+        canUpdateObjectRecords: ZodOptional<ZodBoolean>;
+        canSoftDeleteObjectRecords: ZodOptional<ZodBoolean>;
+        canDestroyObjectRecords: ZodOptional<ZodBoolean>;
+    }, $strict>>>;
+    fieldPermissions: ZodOptional<ZodArray<ZodObject<{
+        objectUniversalIdentifier: ZodString;
+        fieldUniversalIdentifier: ZodString;
+        canReadFieldValue: ZodOptional<ZodBoolean>;
+        canUpdateFieldValue: ZodOptional<ZodBoolean>;
+    }, $strict>>>;
+    permissionFlagUniversalIdentifiers: ZodOptional<ZodArray<ZodString>>;
+}, $strict>;
+
+type AiRunScope = output<typeof aiRunScopeSchema>;
+
+declare const isAgentChatTurnEndEvent: (event: AgentChatSubscriptionEvent) => boolean;
+
+type StreamConversationInput = AgentConversationInput & {
+    signal?: AbortSignal;
+};
+declare const streamConversation: ({ signal, ...conversation }: StreamConversationInput) => AsyncGenerator<AgentChatSubscriptionEvent>;
+
+type GenerateChunk = {
+    type: string;
+} & Record<string, unknown>;
+type GenerateInput = {
+    input: string | RunAgentMessage[];
+    instructions?: string | null;
+    modelId?: string | null;
+    responseFormat?: AgentResponseFormat | null;
+    scope?: AiRunScope | null;
+    onChunk?: (chunk: GenerateChunk) => void | Promise<void>;
+    signal?: AbortSignal;
+};
+declare const ai: {
+    generate: ({ input, onChunk, signal, ...rest }: GenerateInput) => Promise<GenerateResult>;
+};
+
 declare const sendInboxMessage: (input: SendInboxMessageInput) => Promise<SendInboxMessageResult>;
 
 declare const inboxMention: ({ workspaceMemberId, }: {
@@ -2976,5 +3125,5 @@ declare class Response implements LogicFunctionHttpResponse {
     constructor(body: unknown, init?: ResponseInit);
 }
 
-export { AppConnectionAuthFailedError, INBOX_ASSISTANT_MENTION, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, Response, RetryableLogicFunctionError, attachRecordToInboxThread, createMessageChannel, createTimelineActivity, deleteMessageChannel, detachRecordFromInboxThread, enqueueJob, enqueueJobs, findConnectionForRequest, getConnection, getJobs, inboxMention, inboxReferenceRecord, ingestMessages, jsonSchemaToInputSchema, kv, listConnections, listMessageChannels, listMessageFolders, reportConnectionAuthFailure, runAgent, sendInboxMessage, syncMessageFolders, updateMessageChannel };
-export type { AppConnection, AppKeyValue, AppKeyValueScope, AppMessageChannel, AppMessageFolder, AuthorizeConnectionPayload, AuthorizeConnectionResult, ConnectionCallbackPayload, ConnectionCallbackResult, CreateMessageChannelInput, CreateTimelineActivityInput, CreatedTimelineActivity, CronPayload, DatabaseEventBatchPayload, DatabaseEventPayload, EnqueueJobInput, EnqueueJobItem, EnqueueJobOptions, EnqueueJobResult, EnqueueJobsInput, EnqueueJobsResult, IdentifyAccountPayload, IdentifyAccountResult, InboxThreadRecordInput, IngestMessage, IngestMessageParticipant, IngestedMessage, InputJsonSchema, InstallHandler, InstallPayload, JobStatusResult, JobStatusState, ListConnectionsFilter, ListMessageChannelsFilter, ListMessageFoldersFilter, LogicFunctionConfig, LogicFunctionExecutionContext, LogicFunctionHandler, ObjectRecordEvent, ResponseInit, LogicFunctionEvent as RoutePayload, RunAgentInput, RunAgentResult, SendAppMessagePayload, SendAppMessageRecipient, SendAppMessageResult, SendInboxMessageInput, SendInboxMessageResult, ServerRouteDispatchResult, ServerRouteResolverResult, SyncMessageFoldersInput, UninstallHandler, UninstallPayload, UpdateMessageChannelInput };
+export { AppConnectionAuthFailedError, INBOX_ASSISTANT_MENTION, ObjectRecordBaseEvent, ObjectRecordCreateEvent, ObjectRecordDeleteEvent, ObjectRecordDestroyEvent, ObjectRecordRestoreEvent, ObjectRecordUpdateEvent, ObjectRecordUpsertEvent, Response, RetryableLogicFunctionError, ai, attachRecordToInboxThread, createMessageChannel, createTimelineActivity, deleteMessageChannel, detachRecordFromInboxThread, enqueueJob, enqueueJobs, findConnectionForRequest, getConnection, getJobs, inboxMention, inboxReferenceRecord, ingestMessages, isAgentChatTurnEndEvent, jsonSchemaToInputSchema, kv, listConnections, listConversationMessages, listMessageChannels, listMessageFolders, reportConnectionAuthFailure, runAgent, sendInboxMessage, streamConversation, syncMessageFolders, updateMessageChannel };
+export type { AgentChatSubscriptionEvent, AgentConversationHistory, AgentConversationInput, AgentConversationMessage, AiRunScope, AppConnection, AppKeyValue, AppKeyValueScope, AppMessageChannel, AppMessageFolder, AuthorizeConnectionPayload, AuthorizeConnectionResult, ConnectionCallbackPayload, ConnectionCallbackResult, CreateMessageChannelInput, CreateTimelineActivityInput, CreatedTimelineActivity, CronPayload, DatabaseEventBatchPayload, DatabaseEventPayload, EnqueueJobInput, EnqueueJobItem, EnqueueJobOptions, EnqueueJobResult, EnqueueJobsInput, EnqueueJobsResult, GenerateInput, GenerateResult, IdentifyAccountPayload, IdentifyAccountResult, InboxThreadRecordInput, IngestMessage, IngestMessageParticipant, IngestedMessage, InputJsonSchema, InstallHandler, InstallPayload, JobStatusResult, JobStatusState, ListConnectionsFilter, ListMessageChannelsFilter, ListMessageFoldersFilter, LogicFunctionConfig, LogicFunctionExecutionContext, LogicFunctionHandler, ObjectRecordEvent, ResponseInit, LogicFunctionEvent as RoutePayload, RunAgentInput, RunAgentResult, SendAppMessagePayload, SendAppMessageRecipient, SendAppMessageResult, SendInboxMessageInput, SendInboxMessageResult, ServerRouteDispatchResult, ServerRouteResolverResult, StreamConversationInput, SyncMessageFoldersInput, UninstallHandler, UninstallPayload, UpdateMessageChannelInput };