cogito-client 1.0.43 → 1.0.45

package/dist/index.d.ts

@@ -158,12 +158,27 @@ export declare interface CogitoCodeSurface {
 
 export declare interface CogitoConfig {
     agents?: CogitoAgent[];
+    webhooks?: {
+        events: "message"[];
+        uri: string;
+        [k: string]: unknown;
+    }[];
     [k: string]: unknown;
 }
 
 export declare interface CogitoConversation {
     id: string;
     configuration: CogitoConfig;
+    from?: string;
+    to?: string;
+    /**
+     * The URL to use to blind transfer calls
+     */
+    phoneBlindTransferUrl?: string;
+    /**
+     * The LiveKit trunk ID for the outbound trunk
+     */
+    phoneOutboundSipTrunkId?: string;
     messages: CogitoMessage[];
     [k: string]: unknown;
 }
@@ -289,7 +304,26 @@ export declare interface CogitoFunctionTool {
 export declare interface CogitoHandoffTool {
     type: "handoff";
     description?: string;
-    targetAgentId: string;
+    targetType?: "agent" | "phone_blind" | "phone_warm";
+    /**
+     * The channel specific address of the target e.g. to transfer to another agent, use the ID of the agent, to transfer to a phone use the e164 number to transfer to
+     */
+    targetAddress?: string;
+    /**
+     * The name of the party transferring to
+     */
+    targetName?: string;
+    /**
+     * The message to say to the caller before putting them on hold during the transfer process
+     */
+    messageToCaller?: string;
+    /**
+     * A templated message to the party being transferred to. You can insert parameter values into this message e.g. 'I have {caller_name} on the line
+     */
+    messageToTransfer?: string;
+    /**
+     * The object parameters used for the tool definition that will be provided to the LLM, e.g. you could supply a caller_name and reason_for_call property to collect those from the caller
+     */
     parameters?: {
         [k: string]: unknown;
     };
@@ -428,6 +462,13 @@ export declare interface CogitoMessagePayload {
     message: CogitoMessage;
 }
 
+export declare interface CogitoMessageWebhook {
+    type?: "message";
+    role: string;
+    conversationId?: string;
+    content: string;
+}
+
 export declare interface CogitoOptionListSurface {
     type: "option-list";
     state: {
@@ -787,7 +828,7 @@ export declare interface CogitoReadyPayload {
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
  * and run json-schema-to-typescript to regenerate this file.
  */
-export declare type CogitoSchema = CogitoConfig | CogitoMessage | CogitoConversation | CogitoPayload | CogitoSurfaceDefinition | CogitoSurfaceUpdate | CogitoBuiltInSurface;
+export declare type CogitoSchema = CogitoConfig | CogitoMessage | CogitoWebhookPayload | CogitoConversation | CogitoPayload | CogitoSurfaceDefinition | CogitoSurfaceUpdate | CogitoBuiltInSurface;
 
 export declare interface CogitoStatsDisplaySurface {
     type: "stats-display";
@@ -1255,9 +1296,11 @@ export declare interface CogitoWeatherSurface {
     };
 }
 
+export declare type CogitoWebhookPayload = CogitoMessageWebhook;
+
 export declare type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'error';
 
-export declare function useCogito({ mode, server, configuration }: UseCogitoOptions): {
+export declare function useCogito({ mode, server, configuration, id }: UseCogitoOptions): {
     messages: CogitoMessage[];
     connectionState: ConnectionState;
     isLoading: boolean;
@@ -1278,6 +1321,10 @@ declare interface UseCogitoOptions {
     server: string;
     mode: ChatMode;
     configuration: string;
+    /** Optional unique identifier for localStorage conversation key.
+     *  When provided, each id gets its own conversation history.
+     *  Without it, all agents share a single global conversation. */
+    id?: string;
 }
 
 export declare type UseCogitoReturn = ReturnType<typeof useCogito>;