@memberjunction/core-entities 2.59.0 → 2.60.0

package/dist/generated/entity_subclasses.d.ts

@@ -664,6 +664,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     DriverClass: z.ZodNullable<z.ZodString>;
     IconClass: z.ZodNullable<z.ZodString>;
     ModelSelectionMode: z.ZodUnion<[z.ZodLiteral<"Agent Type">, z.ZodLiteral<"Agent">]>;
+    PayloadDownstreamPaths: z.ZodString;
+    PayloadUpstreamPaths: z.ZodString;
     Parent: z.ZodNullable<z.ZodString>;
     ContextCompressionPrompt: z.ZodNullable<z.ZodString>;
     Type: z.ZodNullable<z.ZodString>;
@@ -689,6 +691,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     ContextCompressionMessageRetentionCount?: number;
     TypeID?: string;
     ModelSelectionMode?: "Agent" | "Agent Type";
+    PayloadDownstreamPaths?: string;
+    PayloadUpstreamPaths?: string;
     ContextCompressionPrompt?: string;
 }, {
     ID?: string;
@@ -712,6 +716,8 @@ export declare const AIAgentSchema: z.ZodObject<{
     ContextCompressionMessageRetentionCount?: number;
     TypeID?: string;
     ModelSelectionMode?: "Agent" | "Agent Type";
+    PayloadDownstreamPaths?: string;
+    PayloadUpstreamPaths?: string;
     ContextCompressionPrompt?: string;
 }>;
 export type AIAgentEntityType = z.infer<typeof AIAgentSchema>;
@@ -4613,7 +4619,7 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     ID: z.ZodString;
     AgentRunID: z.ZodString;
     StepNumber: z.ZodNumber;
-    StepType: z.ZodString;
+    StepType: z.ZodUnion<[z.ZodLiteral<"Prompt">, z.ZodLiteral<"Actions">, z.ZodLiteral<"Sub-Agent">, z.ZodLiteral<"Decision">, z.ZodLiteral<"Chat">, z.ZodLiteral<"Validation">]>;
     StepName: z.ZodString;
     TargetID: z.ZodNullable<z.ZodString>;
     Status: z.ZodUnion<[z.ZodLiteral<"Running">, z.ZodLiteral<"Completed">, z.ZodLiteral<"Failed">, z.ZodLiteral<"Cancelled">]>;
@@ -4626,6 +4632,8 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
     TargetLogID: z.ZodNullable<z.ZodString>;
+    PayloadAtStart: z.ZodNullable<z.ZodString>;
+    PayloadAtEnd: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4636,13 +4644,15 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     ErrorMessage?: string;
     AgentRunID?: string;
     StepNumber?: number;
-    StepType?: string;
+    StepType?: "Prompt" | "Actions" | "Sub-Agent" | "Decision" | "Chat" | "Validation";
     StepName?: string;
     TargetID?: string;
     CompletedAt?: Date;
     InputData?: string;
     OutputData?: string;
     TargetLogID?: string;
+    PayloadAtStart?: string;
+    PayloadAtEnd?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4653,13 +4663,15 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
     ErrorMessage?: string;
     AgentRunID?: string;
     StepNumber?: number;
-    StepType?: string;
+    StepType?: "Prompt" | "Actions" | "Sub-Agent" | "Decision" | "Chat" | "Validation";
     StepName?: string;
     TargetID?: string;
     CompletedAt?: Date;
     InputData?: string;
     OutputData?: string;
     TargetLogID?: string;
+    PayloadAtStart?: string;
+    PayloadAtEnd?: string;
 }>;
 export type AIAgentRunStepEntityType = z.infer<typeof AIAgentRunStepSchema>;
 /**
@@ -4688,6 +4700,12 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptTokensUsedRollup: z.ZodNullable<z.ZodNumber>;
     TotalCompletionTokensUsedRollup: z.ZodNullable<z.ZodNumber>;
     TotalCostRollup: z.ZodNullable<z.ZodNumber>;
+    ConversationDetailID: z.ZodNullable<z.ZodString>;
+    ConversationDetailSequence: z.ZodNullable<z.ZodNumber>;
+    CancellationReason: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"User Request">, z.ZodLiteral<"Timeout">, z.ZodLiteral<"System">]>>;
+    FinalStep: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"Success">, z.ZodLiteral<"Failed">, z.ZodLiteral<"Retry">, z.ZodLiteral<"Sub-Agent">, z.ZodLiteral<"Actions">, z.ZodLiteral<"Chat">]>>;
+    FinalPayload: z.ZodNullable<z.ZodString>;
+    Message: z.ZodNullable<z.ZodString>;
     Agent: z.ZodNullable<z.ZodString>;
     Conversation: z.ZodNullable<z.ZodString>;
     User: z.ZodNullable<z.ZodString>;
@@ -4698,6 +4716,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     Status?: "Failed" | "Running" | "Completed" | "Cancelled" | "Paused";
     StartedAt?: Date;
     UserID?: string;
+    Message?: string;
     User?: string;
     AgentID?: string;
     Agent?: string;
@@ -4717,6 +4736,11 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptTokensUsedRollup?: number;
     TotalCompletionTokensUsedRollup?: number;
     TotalCostRollup?: number;
+    ConversationDetailID?: string;
+    ConversationDetailSequence?: number;
+    CancellationReason?: "System" | "User Request" | "Timeout";
+    FinalStep?: "Failed" | "Success" | "Actions" | "Sub-Agent" | "Chat" | "Retry";
+    FinalPayload?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4724,6 +4748,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     Status?: "Failed" | "Running" | "Completed" | "Cancelled" | "Paused";
     StartedAt?: Date;
     UserID?: string;
+    Message?: string;
     User?: string;
     AgentID?: string;
     Agent?: string;
@@ -4743,6 +4768,11 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptTokensUsedRollup?: number;
     TotalCompletionTokensUsedRollup?: number;
     TotalCostRollup?: number;
+    ConversationDetailID?: string;
+    ConversationDetailSequence?: number;
+    CancellationReason?: "System" | "User Request" | "Timeout";
+    FinalStep?: "Failed" | "Success" | "Actions" | "Sub-Agent" | "Chat" | "Retry";
+    FinalPayload?: string;
 }>;
 export type AIAgentRunEntityType = z.infer<typeof AIAgentRunSchema>;
 /**
@@ -6491,8 +6521,8 @@ export declare const ReportSchema: z.ZodObject<{
     DataContextID?: string;
     DataContext?: string;
     Thumbnail?: string;
-    SharingScope?: "Specific" | "None" | "Everyone";
     ConversationDetailID?: string;
+    SharingScope?: "Specific" | "None" | "Everyone";
     OutputTriggerTypeID?: string;
     OutputFormatTypeID?: string;
     OutputDeliveryTypeID?: string;
@@ -6519,8 +6549,8 @@ export declare const ReportSchema: z.ZodObject<{
     DataContextID?: string;
     DataContext?: string;
     Thumbnail?: string;
-    SharingScope?: "Specific" | "None" | "Everyone";
     ConversationDetailID?: string;
+    SharingScope?: "Specific" | "None" | "Everyone";
     OutputTriggerTypeID?: string;
     OutputFormatTypeID?: string;
     OutputDeliveryTypeID?: string;
@@ -9883,6 +9913,24 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     get ModelSelectionMode(): 'Agent Type' | 'Agent';
     set ModelSelectionMode(value: 'Agent Type' | 'Agent');
     /**
+    * * Field Name: PayloadDownstreamPaths
+    * * Display Name: Payload Downstream Paths
+    * * SQL Data Type: nvarchar(MAX)
+    * * Default Value: ["*"]
+    * * Description: JSON array of paths that define which parts of the payload should be sent downstream to sub-agents. Use ["*"] to send entire payload, or specify paths like ["customer.id", "campaign.*", "analysis.sentiment"]
+    */
+    get PayloadDownstreamPaths(): string;
+    set PayloadDownstreamPaths(value: string);
+    /**
+    * * Field Name: PayloadUpstreamPaths
+    * * Display Name: Payload Upstream Paths
+    * * SQL Data Type: nvarchar(MAX)
+    * * Default Value: ["*"]
+    * * Description: JSON array of paths that define which parts of the payload sub-agents are allowed to write back upstream. Use ["*"] to allow all writes, or specify paths like ["analysis.results", "recommendations.*"]
+    */
+    get PayloadUpstreamPaths(): string;
+    set PayloadUpstreamPaths(value: string);
+    /**
     * * Field Name: Parent
     * * Display Name: Parent
     * * SQL Data Type: nvarchar(255)
@@ -20472,10 +20520,19 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     * * Field Name: StepType
     * * Display Name: Step Type
     * * SQL Data Type: nvarchar(50)
-    * * Description: Type of execution step: prompt, tool, subagent, decision
+    * * Default Value: Prompt
+    * * Value List Type: List
+    * * Possible Values
+    *   * Prompt
+    *   * Actions
+    *   * Sub-Agent
+    *   * Decision
+    *   * Chat
+    *   * Validation
+    * * Description: Type of execution step: Prompt, Actions, Sub-Agent, Decision, Chat, Validation
     */
-    get StepType(): string;
-    set StepType(value: string);
+    get StepType(): 'Prompt' | 'Actions' | 'Sub-Agent' | 'Decision' | 'Chat' | 'Validation';
+    set StepType(value: 'Prompt' | 'Actions' | 'Sub-Agent' | 'Decision' | 'Chat' | 'Validation');
     /**
     * * Field Name: StepName
     * * Display Name: Step Name
@@ -20578,6 +20635,22 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     */
     get TargetLogID(): string | null;
     set TargetLogID(value: string | null);
+    /**
+    * * Field Name: PayloadAtStart
+    * * Display Name: Payload At Start
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON serialization of the Payload state at the start of this step
+    */
+    get PayloadAtStart(): string | null;
+    set PayloadAtStart(value: string | null);
+    /**
+    * * Field Name: PayloadAtEnd
+    * * Display Name: Payload At End
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON serialization of the Payload state at the end of this step
+    */
+    get PayloadAtEnd(): string | null;
+    set PayloadAtEnd(value: string | null);
 }
 /**
  * MJ: AI Agent Runs - strongly typed entity sub-class
@@ -20707,7 +20780,8 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
     /**
     * * Field Name: AgentState
     * * Display Name: Agent State
-    * * SQL Data Type: nvarchar(MAX)
+    * *
+    * * @deprecated This field is deprecated and will be removed in a future version. Using it will result in console warnings.SQL Data Type: nvarchar(MAX)
     * * Description: JSON serialization of the complete agent state, including conversation context, variables, and execution state. Enables pause/resume functionality.
     */
     get AgentState(): string | null;
@@ -20793,6 +20867,68 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
     get TotalCostRollup(): number | null;
     set TotalCostRollup(value: number | null);
     /**
+    * * Field Name: ConversationDetailID
+    * * Display Name: Conversation Detail ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Conversation Details (vwConversationDetails.ID)
+    * * Description: Optional tracking of a specific conversation detail (e.g. a specific message) that spawned this agent run
+    */
+    get ConversationDetailID(): string | null;
+    set ConversationDetailID(value: string | null);
+    /**
+    * * Field Name: ConversationDetailSequence
+    * * Display Name: Conversation Detail Sequence
+    * * SQL Data Type: int
+    * * Description: If a conversation detail spawned multiple agent runs, tracks the order of their spawn/execution
+    */
+    get ConversationDetailSequence(): number | null;
+    set ConversationDetailSequence(value: number | null);
+    /**
+    * * Field Name: CancellationReason
+    * * Display Name: Cancellation Reason
+    * * SQL Data Type: nvarchar(30)
+    * * Value List Type: List
+    * * Possible Values
+    *   * User Request
+    *   * Timeout
+    *   * System
+    * * Description: Reason for cancellation if the agent run was cancelled
+    */
+    get CancellationReason(): 'User Request' | 'Timeout' | 'System' | null;
+    set CancellationReason(value: 'User Request' | 'Timeout' | 'System' | null);
+    /**
+    * * Field Name: FinalStep
+    * * Display Name: Final Step
+    * * SQL Data Type: nvarchar(30)
+    * * Value List Type: List
+    * * Possible Values
+    *   * Success
+    *   * Failed
+    *   * Retry
+    *   * Sub-Agent
+    *   * Actions
+    *   * Chat
+    * * Description: The final step type that concluded the agent run
+    */
+    get FinalStep(): 'Success' | 'Failed' | 'Retry' | 'Sub-Agent' | 'Actions' | 'Chat' | null;
+    set FinalStep(value: 'Success' | 'Failed' | 'Retry' | 'Sub-Agent' | 'Actions' | 'Chat' | null);
+    /**
+    * * Field Name: FinalPayload
+    * * Display Name: Final Payload
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON serialization of the final Payload state at the end of the agent run
+    */
+    get FinalPayload(): string | null;
+    set FinalPayload(value: string | null);
+    /**
+    * * Field Name: Message
+    * * Display Name: Message
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Final message from the agent to the end user at the end of a run
+    */
+    get Message(): string | null;
+    set Message(value: string | null);
+    /**
     * * Field Name: Agent
     * * Display Name: Agent
     * * SQL Data Type: nvarchar(255)