@memberjunction/core-entities 4.1.0 → 4.3.0

package/dist/generated/entity_subclasses.d.ts

@@ -12171,6 +12171,8 @@ export declare const SchemaInfoSchema: z.ZodObject<{
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
     Description: z.ZodNullable<z.ZodString>;
+    EntityNamePrefix: z.ZodNullable<z.ZodString>;
+    EntityNameSuffix: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     Comments?: string;
@@ -12180,6 +12182,8 @@ export declare const SchemaInfoSchema: z.ZodObject<{
     SchemaName?: string;
     EntityIDMin?: number;
     EntityIDMax?: number;
+    EntityNamePrefix?: string;
+    EntityNameSuffix?: string;
 }, {
     ID?: string;
     Comments?: string;
@@ -12189,6 +12193,8 @@ export declare const SchemaInfoSchema: z.ZodObject<{
     SchemaName?: string;
     EntityIDMin?: number;
     EntityIDMax?: number;
+    EntityNamePrefix?: string;
+    EntityNameSuffix?: string;
 }>;
 export type SchemaInfoEntityType = z.infer<typeof SchemaInfoSchema>;
 /**
@@ -14187,6 +14193,16 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Actions - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof ActionEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -15491,6 +15507,16 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * AI Agents - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIAgentEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for AI Agents entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * DefaultPromptEffortLevel: This rule ensures that if a default prompt effort level is specified, it must be a number between 1 and 100, inclusive.
     * * MaxExecutionsPerRun: This rule ensures that if 'MaxExecutionsPerRun' is provided, it must be a value greater than zero. If it is left blank, that's acceptable.
@@ -16734,6 +16760,16 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * AI Prompts - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIPromptEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for AI Prompts entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * CacheSimilarityThreshold: This rule ensures that the "CacheSimilarityThreshold" value, if provided, must be between 0 and 1 (including both 0 and 1). If it is not set, there is no restriction.
     * * CacheTTLSeconds: This rule ensures that if a cache time-to-live (CacheTTLSeconds) value is provided, it must be greater than zero. If it is not set, that's allowed.
@@ -22059,7 +22095,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
     set ID(value: string);
     /**
     * * Field Name: DuplicateRunID
-    * * Display Name: Duplicate Run ID
+    * * Display Name: Duplicate Run
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Duplicate Runs (vwDuplicateRuns.ID)
     */
@@ -22520,7 +22556,7 @@ export declare class EmployeeSkillEntity extends BaseEntity<EmployeeSkillEntityT
     set EmployeeID(value: string);
     /**
     * * Field Name: SkillID
-    * * Display Name: Skill ID
+    * * Display Name: Skill
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Skills (vwSkills.ID)
     */
@@ -22548,7 +22584,7 @@ export declare class EmployeeSkillEntity extends BaseEntity<EmployeeSkillEntityT
     get Employee(): string | null;
     /**
     * * Field Name: Skill
-    * * Display Name: Skill
+    * * Display Name: Skill Name
     * * SQL Data Type: nvarchar(50)
     */
     get Skill(): string;
@@ -23309,7 +23345,7 @@ export declare class EntityActionFilterEntity extends BaseEntity<EntityActionFil
     set ID(value: string);
     /**
     * * Field Name: EntityActionID
-    * * Display Name: Entity Action
+    * * Display Name: Entity Action ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Entity Actions (vwEntityActions.ID)
     */
@@ -23317,7 +23353,7 @@ export declare class EntityActionFilterEntity extends BaseEntity<EntityActionFil
     set EntityActionID(value: string);
     /**
     * * Field Name: ActionFilterID
-    * * Display Name: Action Filter
+    * * Display Name: Action Filter ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Action Filters (vwActionFilters.ID)
     */
@@ -23478,7 +23514,7 @@ export declare class EntityActionInvocationEntity extends BaseEntity<EntityActio
     set ID(value: string);
     /**
     * * Field Name: EntityActionID
-    * * Display Name: Entity Action
+    * * Display Name: Entity Action ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Entity Actions (vwEntityActions.ID)
     */
@@ -23486,7 +23522,7 @@ export declare class EntityActionInvocationEntity extends BaseEntity<EntityActio
     set EntityActionID(value: string);
     /**
     * * Field Name: InvocationTypeID
-    * * Display Name: Invocation Type
+    * * Display Name: Invocation Type ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Entity Action Invocation Types (vwEntityActionInvocationTypes.ID)
     */
@@ -23522,13 +23558,13 @@ export declare class EntityActionInvocationEntity extends BaseEntity<EntityActio
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: EntityAction
-    * * Display Name: Action Name
+    * * Display Name: Entity Action
     * * SQL Data Type: nvarchar(425)
     */
     get EntityAction(): string;
     /**
     * * Field Name: InvocationType
-    * * Display Name: Invocation Type Name
+    * * Display Name: Invocation Type
     * * SQL Data Type: nvarchar(255)
     */
     get InvocationType(): string;
@@ -23633,7 +23669,7 @@ export declare class EntityActionParamEntity extends BaseEntity<EntityActionPara
     get EntityAction(): string;
     /**
     * * Field Name: ActionParam
-    * * Display Name: Action Parameter
+    * * Display Name: Parameter Name
     * * SQL Data Type: nvarchar(255)
     */
     get ActionParam(): string;
@@ -23976,7 +24012,7 @@ export declare class EntityCommunicationFieldEntity extends BaseEntity<EntityCom
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: EntityCommunicationMessageType
-    * * Display Name: Message Type
+    * * Display Name: Entity Communication Message Type
     * * SQL Data Type: nvarchar(100)
     */
     get EntityCommunicationMessageType(): string;
@@ -25993,7 +26029,7 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
     set CompanyIntegrationRunDetailID(value: string | null);
     /**
     * * Field Name: Code
-    * * Display Name: Code
+    * * Display Name: Error Code
     * * SQL Data Type: nchar(20)
     * * Description: Error code for categorizing and handling specific error types.
     */
@@ -26001,7 +26037,7 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
     set Code(value: string | null);
     /**
     * * Field Name: Message
-    * * Display Name: Message
+    * * Display Name: Error Message
     * * SQL Data Type: nvarchar(MAX)
     * * Description: The primary error message describing what went wrong.
     */
@@ -26018,14 +26054,14 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
     set CreatedBy(value: string | null);
     /**
     * * Field Name: Status
-    * * Display Name: Status
+    * * Display Name: Error Status
     * * SQL Data Type: nvarchar(10)
     */
     get Status(): string | null;
     set Status(value: string | null);
     /**
     * * Field Name: Category
-    * * Display Name: Category
+    * * Display Name: Error Category
     * * SQL Data Type: nvarchar(20)
     * * Description: High-level category for grouping related errors (Database, API, Validation, etc.).
     */
@@ -26033,7 +26069,7 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
     set Category(value: string | null);
     /**
     * * Field Name: Details
-    * * Display Name: Details
+    * * Display Name: Error Details
     * * SQL Data Type: nvarchar(MAX)
     * * Description: Full error details including stack trace, inner exceptions, and context data.
     */
@@ -26055,13 +26091,13 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: CompanyIntegrationRun
-    * * Display Name: Integration Run
+    * * Display Name: Company Integration Run
     * * SQL Data Type: nvarchar(100)
     */
     get CompanyIntegrationRun(): string | null;
     /**
     * * Field Name: CompanyIntegrationRunDetail
-    * * Display Name: Integration Run Detail
+    * * Display Name: Company Integration Run Detail
     * * SQL Data Type: nvarchar(450)
     */
     get CompanyIntegrationRunDetail(): string | null;
@@ -26907,6 +26943,7 @@ export declare class IntegrationURLFormatEntity extends BaseEntity<IntegrationUR
     set EntityID(value: string);
     /**
     * * Field Name: URLFormat
+    * * Display Name: URL Format
     * * SQL Data Type: nvarchar(500)
     * * Description: The URL Format for the given integration including the ability to include markup with fields from the integration
     */
@@ -29273,6 +29310,16 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: AI Agent Run Steps - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIAgentRunStepEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for MJ: AI Agent Run Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * FinalPayloadValidationResult: The FinalPayloadValidationResult field can be empty, but if a value is set it must be one of the allowed outcomes: Warn, Fail, Retry, or Pass. This ensures that only valid validation results are stored.
     * * StepNumber: This rule ensures that the step number must be greater than zero.
@@ -29489,7 +29536,7 @@ detailed information about what validation rules failed.
     set FinalPayloadValidationMessages(value: string | null);
     /**
     * * Field Name: ParentID
-    * * Display Name: Parent
+    * * Display Name: Parent ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: AI Agent Run Steps (vwAIAgentRunSteps.ID)
     * * Description: Optional reference to parent step for tracking hierarchical relationships like code->test->fix->code cycles
@@ -29548,6 +29595,16 @@ export declare class AIAgentRunEntity extends BaseEntity<AIAgentRunEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: AI Agent Runs - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIAgentRunEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for MJ: AI Agent Runs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * EffortLevel: This rule ensures that the effort level, if specified, must be a number between 1 and 100, inclusive.
     * * FinalStep: The FinalStep field can be left empty, but if a value is provided it must be one of the approved step names – While, ForEach, Chat, Sub-Agent, Actions, Retry, Failed, or Success. This ensures only valid workflow steps are recorded.
@@ -30194,6 +30251,16 @@ export declare class AIAgentStepEntity extends BaseEntity<AIAgentStepEntityType>
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: AI Agent Steps - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIAgentStepEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for MJ: AI Agent Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * RetryCount: This rule ensures that the number of retries allowed cannot be negative.
     * * TimeoutSeconds: This rule ensures that, if provided, the timeout value must be greater than zero seconds.
@@ -30824,6 +30891,16 @@ export declare class AIConfigurationEntity extends BaseEntity<AIConfigurationEnt
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: AI Configurations - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIConfigurationEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -32533,6 +32610,16 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * MJ: AI Prompt Runs - Delete method override to wrap in transaction since CascadeDeletes is true.
+    * Wrapping in a transaction ensures that all cascade delete operations are handled atomically.
+    * @public
+    * @method
+    * @override
+    * @memberof AIPromptRunEntity
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    */
+    Delete(options?: EntityDeleteOptions): Promise<boolean>;
+    /**
     * Validate() method override for MJ: AI Prompt Runs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * EffortLevel: This rule ensures that if an effort level is provided, it must be between 1 and 100, inclusive.
     * * Table-Level: This rule ensures that if the 'CompletedAt' date is provided, it must be the same as or later than the 'RunAt' date. If 'CompletedAt' is not specified, there is no restriction.
@@ -36598,7 +36685,7 @@ export declare class ConversationDetailArtifactEntity extends BaseEntity<Convers
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: ConversationDetail
-    * * Display Name: Message Text
+    * * Display Name: Conversation Detail
     * * SQL Data Type: nvarchar(MAX)
     */
     get ConversationDetail(): string;
@@ -36893,7 +36980,7 @@ export declare class ConversationDetailRatingEntity extends BaseEntity<Conversat
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: ConversationDetail
-    * * Display Name: Conversation Detail
+    * * Display Name: Message Text
     * * SQL Data Type: nvarchar(MAX)
     */
     get ConversationDetail(): string;
@@ -38938,13 +39025,13 @@ export declare class MCPServerConnectionToolEntity extends BaseEntity<MCPServerC
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: MCPServerConnection
-    * * Display Name: Connection
+    * * Display Name: Server Connection
     * * SQL Data Type: nvarchar(255)
     */
     get MCPServerConnection(): string;
     /**
     * * Field Name: MCPServerTool
-    * * Display Name: Tool
+    * * Display Name: Server Tool
     * * SQL Data Type: nvarchar(255)
     */
     get MCPServerTool(): string | null;
@@ -39566,7 +39653,7 @@ export declare class MCPToolExecutionLogEntity extends BaseEntity<MCPToolExecuti
     set ID(value: string);
     /**
     * * Field Name: MCPServerConnectionID
-    * * Display Name: MCP Server Connection ID
+    * * Display Name: MCP Server Connection
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: MCP Server Connections (vwMCPServerConnections.ID)
     */
@@ -39574,7 +39661,7 @@ export declare class MCPToolExecutionLogEntity extends BaseEntity<MCPToolExecuti
     set MCPServerConnectionID(value: string);
     /**
     * * Field Name: MCPServerToolID
-    * * Display Name: MCP Server Tool ID
+    * * Display Name: MCP Server Tool
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: MJ: MCP Server Tools (vwMCPServerTools.ID)
     * * Description: FK to MCP Server Tool (null if tool not cached)
@@ -45495,7 +45582,7 @@ export declare class RecommendationItemEntity extends BaseEntity<RecommendationI
     set RecommendationID(value: string);
     /**
     * * Field Name: DestinationEntityID
-    * * Display Name: Destination Entity ID
+    * * Display Name: Destination Entity
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Entities (vwEntities.ID)
     */
@@ -45503,7 +45590,7 @@ export declare class RecommendationItemEntity extends BaseEntity<RecommendationI
     set DestinationEntityID(value: string);
     /**
     * * Field Name: DestinationEntityRecordID
-    * * Display Name: Destination Entity Record ID
+    * * Display Name: Destination Record ID
     * * SQL Data Type: nvarchar(450)
     * * Description: The record ID of the destination entity
     */
@@ -45752,7 +45839,7 @@ export declare class RecommendationEntity extends BaseEntity<RecommendationEntit
     set ID(value: string);
     /**
     * * Field Name: RecommendationRunID
-    * * Display Name: Recommendation Run
+    * * Display Name: Recommendation Run ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Recommendation Runs (vwRecommendationRuns.ID)
     */
@@ -46129,7 +46216,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
     set ID(value: string);
     /**
     * * Field Name: RecordMergeLogID
-    * * Display Name: Record Merge Log
+    * * Display Name: Record Merge Log ID
     * * SQL Data Type: uniqueidentifier
     * * Related Entity/Foreign Key: Record Merge Logs (vwRecordMergeLogs.ID)
     */
@@ -46137,7 +46224,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
     set RecordMergeLogID(value: string);
     /**
     * * Field Name: DeletedRecordID
-    * * Display Name: Deleted Record
+    * * Display Name: Deleted Record ID
     * * SQL Data Type: nvarchar(750)
     * * Description: Field DeletedRecordID for entity Record Merge Deletion Logs.
     */
@@ -46180,7 +46267,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
     get __mj_UpdatedAt(): Date;
     /**
     * * Field Name: RecordMergeLog
-    * * Display Name: Merge Log
+    * * Display Name: Record Merge Log
     * * SQL Data Type: nvarchar(450)
     */
     get RecordMergeLog(): string;
@@ -47210,6 +47297,7 @@ export declare class RoleEntity extends BaseEntity<RoleEntityType> {
     set DirectoryID(value: string | null);
     /**
     * * Field Name: SQLName
+    * * Display Name: SQL Name
     * * SQL Data Type: nvarchar(250)
     * * Description: The name of the role in the database, this is used for auto-generating permission statements by CodeGen
     */
@@ -47641,7 +47729,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
     set SchemaName(value: string);
     /**
     * * Field Name: EntityIDMin
-    * * Display Name: Entity IDMin
+    * * Display Name: Entity ID Minimum
     * * SQL Data Type: int
     * * Description: Field EntityIDMin for entity Schema Info.
     */
@@ -47649,7 +47737,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
     set EntityIDMin(value: number);
     /**
     * * Field Name: EntityIDMax
-    * * Display Name: Entity IDMax
+    * * Display Name: Entity ID Maximum
     * * SQL Data Type: int
     * * Description: Field EntityIDMax for entity Schema Info.
     */
@@ -47683,6 +47771,22 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
     */
     get Description(): string | null;
     set Description(value: string | null);
+    /**
+    * * Field Name: EntityNamePrefix
+    * * Display Name: Entity Name Prefix
+    * * SQL Data Type: nvarchar(25)
+    * * Description: Optional prefix to prepend to entity names generated for this schema. For example, setting this to "Committees: " would result in entity names like "Committees: Individuals". Can be overridden by mj.config.cjs NameRulesBySchema settings.
+    */
+    get EntityNamePrefix(): string | null;
+    set EntityNamePrefix(value: string | null);
+    /**
+    * * Field Name: EntityNameSuffix
+    * * Display Name: Entity Name Suffix
+    * * SQL Data Type: nvarchar(25)
+    * * Description: Optional suffix to append to entity names generated for this schema. Can be overridden by mj.config.cjs NameRulesBySchema settings.
+    */
+    get EntityNameSuffix(): string | null;
+    set EntityNameSuffix(value: string | null);
 }
 /**
  * Skills - strongly typed entity sub-class
@@ -48289,7 +48393,7 @@ export declare class TemplateParamEntity extends BaseEntity<TemplateParamEntityT
     set DefaultValue(value: string | null);
     /**
     * * Field Name: IsRequired
-    * * Display Name: Is Required
+    * * Display Name: Required
     * * SQL Data Type: bit
     * * Default Value: 0
     * * Description: Whether this parameter must be provided when using the template.