@memberjunction/core-entities 2.73.0 → 2.75.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5284,6 +5284,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
5284
5284
  OriginalModelID: z.ZodNullable<z.ZodString>;
5285
5285
  OriginalRequestStartTime: z.ZodNullable<z.ZodDate>;
5286
5286
  TotalFailoverDuration: z.ZodNullable<z.ZodNumber>;
5287
+ RerunFromPromptRunID: z.ZodNullable<z.ZodString>;
5287
5288
  Prompt: z.ZodString;
5288
5289
  Model: z.ZodString;
5289
5290
  Vendor: z.ZodString;
@@ -5356,6 +5357,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
5356
5357
  OriginalModelID?: string;
5357
5358
  OriginalRequestStartTime?: Date;
5358
5359
  TotalFailoverDuration?: number;
5360
+ RerunFromPromptRunID?: string;
5359
5361
  OriginalModel?: string;
5360
5362
  }, {
5361
5363
  ID?: string;
@@ -5423,6 +5425,7 @@ export declare const AIPromptRunSchema: z.ZodObject<{
5423
5425
  OriginalModelID?: string;
5424
5426
  OriginalRequestStartTime?: Date;
5425
5427
  TotalFailoverDuration?: number;
5428
+ RerunFromPromptRunID?: string;
5426
5429
  OriginalModel?: string;
5427
5430
  }>;
5428
5431
  export type AIPromptRunEntityType = z.infer<typeof AIPromptRunSchema>;
@@ -5714,6 +5717,56 @@ export declare const DashboardUserStateSchema: z.ZodObject<{
5714
5717
  UserState?: string;
5715
5718
  }>;
5716
5719
  export type DashboardUserStateEntityType = z.infer<typeof DashboardUserStateSchema>;
5720
+ /**
5721
+ * zod schema definition for the entity MJ: Query Parameters
5722
+ */
5723
+ export declare const QueryParameterSchema: z.ZodObject<{
5724
+ ID: z.ZodString;
5725
+ QueryID: z.ZodString;
5726
+ Name: z.ZodString;
5727
+ Type: z.ZodUnion<[z.ZodLiteral<"string">, z.ZodLiteral<"number">, z.ZodLiteral<"date">, z.ZodLiteral<"boolean">, z.ZodLiteral<"array">]>;
5728
+ IsRequired: z.ZodNullable<z.ZodBoolean>;
5729
+ DefaultValue: z.ZodNullable<z.ZodString>;
5730
+ Description: z.ZodNullable<z.ZodString>;
5731
+ SampleValue: z.ZodNullable<z.ZodString>;
5732
+ ValidationFilters: z.ZodNullable<z.ZodString>;
5733
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
5734
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5735
+ __mj_CreatedAt: z.ZodDate;
5736
+ __mj_UpdatedAt: z.ZodDate;
5737
+ Query: z.ZodString;
5738
+ }, "strip", z.ZodTypeAny, {
5739
+ ID?: string;
5740
+ __mj_CreatedAt?: Date;
5741
+ __mj_UpdatedAt?: Date;
5742
+ Name?: string;
5743
+ Description?: string;
5744
+ DefaultValue?: string;
5745
+ Type?: "string" | "number" | "boolean" | "date" | "array";
5746
+ IsRequired?: boolean;
5747
+ QueryID?: string;
5748
+ Query?: string;
5749
+ SampleValue?: string;
5750
+ ValidationFilters?: string;
5751
+ DetectionMethod?: "AI" | "Manual";
5752
+ AutoDetectConfidenceScore?: number;
5753
+ }, {
5754
+ ID?: string;
5755
+ __mj_CreatedAt?: Date;
5756
+ __mj_UpdatedAt?: Date;
5757
+ Name?: string;
5758
+ Description?: string;
5759
+ DefaultValue?: string;
5760
+ Type?: "string" | "number" | "boolean" | "date" | "array";
5761
+ IsRequired?: boolean;
5762
+ QueryID?: string;
5763
+ Query?: string;
5764
+ SampleValue?: string;
5765
+ ValidationFilters?: string;
5766
+ DetectionMethod?: "AI" | "Manual";
5767
+ AutoDetectConfidenceScore?: number;
5768
+ }>;
5769
+ export type QueryParameterEntityType = z.infer<typeof QueryParameterSchema>;
5717
5770
  /**
5718
5771
  * zod schema definition for the entity MJ: Report User States
5719
5772
  */
@@ -5874,6 +5927,7 @@ export declare const QuerySchema: z.ZodObject<{
5874
5927
  ExecutionCostRank: z.ZodNullable<z.ZodNumber>;
5875
5928
  __mj_CreatedAt: z.ZodDate;
5876
5929
  __mj_UpdatedAt: z.ZodDate;
5930
+ UsesTemplate: z.ZodNullable<z.ZodBoolean>;
5877
5931
  Category: z.ZodNullable<z.ZodString>;
5878
5932
  }, "strip", z.ZodTypeAny, {
5879
5933
  ID?: string;
@@ -5891,6 +5945,7 @@ export declare const QuerySchema: z.ZodObject<{
5891
5945
  Feedback?: string;
5892
5946
  QualityRank?: number;
5893
5947
  ExecutionCostRank?: number;
5948
+ UsesTemplate?: boolean;
5894
5949
  }, {
5895
5950
  ID?: string;
5896
5951
  __mj_CreatedAt?: Date;
@@ -5907,6 +5962,7 @@ export declare const QuerySchema: z.ZodObject<{
5907
5962
  Feedback?: string;
5908
5963
  QualityRank?: number;
5909
5964
  ExecutionCostRank?: number;
5965
+ UsesTemplate?: boolean;
5910
5966
  }>;
5911
5967
  export type QueryEntityType = z.infer<typeof QuerySchema>;
5912
5968
  /**
@@ -5953,6 +6009,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5953
6009
  EntityID: z.ZodString;
5954
6010
  __mj_CreatedAt: z.ZodDate;
5955
6011
  __mj_UpdatedAt: z.ZodDate;
6012
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
6013
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5956
6014
  Query: z.ZodString;
5957
6015
  Entity: z.ZodString;
5958
6016
  }, "strip", z.ZodTypeAny, {
@@ -5963,6 +6021,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5963
6021
  Entity?: string;
5964
6022
  QueryID?: string;
5965
6023
  Query?: string;
6024
+ DetectionMethod?: "AI" | "Manual";
6025
+ AutoDetectConfidenceScore?: number;
5966
6026
  }, {
5967
6027
  ID?: string;
5968
6028
  __mj_CreatedAt?: Date;
@@ -5971,6 +6031,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5971
6031
  Entity?: string;
5972
6032
  QueryID?: string;
5973
6033
  Query?: string;
6034
+ DetectionMethod?: "AI" | "Manual";
6035
+ AutoDetectConfidenceScore?: number;
5974
6036
  }>;
5975
6037
  export type QueryEntityEntityType = z.infer<typeof QueryEntitySchema>;
5976
6038
  /**
@@ -5992,6 +6054,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
5992
6054
  SummaryDescription: z.ZodNullable<z.ZodString>;
5993
6055
  __mj_CreatedAt: z.ZodDate;
5994
6056
  __mj_UpdatedAt: z.ZodDate;
6057
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
6058
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5995
6059
  Query: z.ZodString;
5996
6060
  SourceEntity: z.ZodNullable<z.ZodString>;
5997
6061
  }, "strip", z.ZodTypeAny, {
@@ -6003,6 +6067,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
6003
6067
  Sequence?: number;
6004
6068
  QueryID?: string;
6005
6069
  Query?: string;
6070
+ DetectionMethod?: "AI" | "Manual";
6071
+ AutoDetectConfidenceScore?: number;
6006
6072
  SQLBaseType?: string;
6007
6073
  SQLFullType?: string;
6008
6074
  SourceEntityID?: string;
@@ -6021,6 +6087,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
6021
6087
  Sequence?: number;
6022
6088
  QueryID?: string;
6023
6089
  Query?: string;
6090
+ DetectionMethod?: "AI" | "Manual";
6091
+ AutoDetectConfidenceScore?: number;
6024
6092
  SQLBaseType?: string;
6025
6093
  SQLFullType?: string;
6026
6094
  SourceEntityID?: string;
@@ -8459,6 +8527,7 @@ export declare class ActionExecutionLogEntity extends BaseEntity<ActionExecution
8459
8527
  * * Field Name: Params
8460
8528
  * * Display Name: Params
8461
8529
  * * SQL Data Type: nvarchar(MAX)
8530
+ * * Description: JSON-formatted input parameters passed to the action during execution, storing the exact values used for this specific run.
8462
8531
  */
8463
8532
  get Params(): string | null;
8464
8533
  set Params(value: string | null);
@@ -8466,6 +8535,7 @@ export declare class ActionExecutionLogEntity extends BaseEntity<ActionExecution
8466
8535
  * * Field Name: ResultCode
8467
8536
  * * Display Name: Result Code
8468
8537
  * * SQL Data Type: nvarchar(255)
8538
+ * * Description: The outcome code returned by the action execution, indicating success, failure, or specific error conditions as defined in Action Result Codes.
8469
8539
  */
8470
8540
  get ResultCode(): string | null;
8471
8541
  set ResultCode(value: string | null);
@@ -8556,6 +8626,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8556
8626
  * * Field Name: UserDescription
8557
8627
  * * Display Name: User Description
8558
8628
  * * SQL Data Type: nvarchar(MAX)
8629
+ * * Description: Human-readable explanation of what this filter checks and when it should prevent action execution, written for non-technical users.
8559
8630
  */
8560
8631
  get UserDescription(): string;
8561
8632
  set UserDescription(value: string);
@@ -8563,6 +8634,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8563
8634
  * * Field Name: UserComments
8564
8635
  * * Display Name: User Comments
8565
8636
  * * SQL Data Type: nvarchar(MAX)
8637
+ * * Description: Additional notes or implementation details about the filter logic, including examples or edge cases to consider.
8566
8638
  */
8567
8639
  get UserComments(): string | null;
8568
8640
  set UserComments(value: string | null);
@@ -8570,6 +8642,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8570
8642
  * * Field Name: Code
8571
8643
  * * Display Name: Code
8572
8644
  * * SQL Data Type: nvarchar(MAX)
8645
+ * * Description: JavaScript code that evaluates to true (allow action) or false (prevent action), executed in the same context as the action.
8573
8646
  */
8574
8647
  get Code(): string;
8575
8648
  set Code(value: string);
@@ -8577,6 +8650,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8577
8650
  * * Field Name: CodeExplanation
8578
8651
  * * Display Name: Code Explanation
8579
8652
  * * SQL Data Type: nvarchar(MAX)
8653
+ * * Description: Technical documentation of the filter code logic, including expected inputs, outputs, and any dependencies or assumptions.
8580
8654
  */
8581
8655
  get CodeExplanation(): string | null;
8582
8656
  set CodeExplanation(value: string | null);
@@ -8729,6 +8803,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8729
8803
  * * Field Name: DefaultValue
8730
8804
  * * Display Name: Default Value
8731
8805
  * * SQL Data Type: nvarchar(MAX)
8806
+ * * Description: The default value for this parameter if not provided during action execution, can be a literal value or JSON for complex types.
8732
8807
  */
8733
8808
  get DefaultValue(): string | null;
8734
8809
  set DefaultValue(value: string | null);
@@ -8741,6 +8816,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8741
8816
  * * Input
8742
8817
  * * Output
8743
8818
  * * Both
8819
+ * * Description: Specifies whether this parameter is used for Input, Output, or Both directions in the action execution flow.
8744
8820
  */
8745
8821
  get Type(): 'Input' | 'Output' | 'Both';
8746
8822
  set Type(value: 'Input' | 'Output' | 'Both');
@@ -8763,6 +8839,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8763
8839
  * * Display Name: Is Array
8764
8840
  * * SQL Data Type: bit
8765
8841
  * * Default Value: 0
8842
+ * * Description: Indicates whether this parameter accepts or returns an array of values rather than a single value.
8766
8843
  */
8767
8844
  get IsArray(): boolean;
8768
8845
  set IsArray(value: boolean);
@@ -8778,6 +8855,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8778
8855
  * * Display Name: Is Required
8779
8856
  * * SQL Data Type: bit
8780
8857
  * * Default Value: 1
8858
+ * * Description: Determines if this parameter must be provided for input parameters or will always be populated for output parameters.
8781
8859
  */
8782
8860
  get IsRequired(): boolean;
8783
8861
  set IsRequired(value: boolean);
@@ -8846,6 +8924,7 @@ export declare class ActionResultCodeEntity extends BaseEntity<ActionResultCodeE
8846
8924
  * * Field Name: ResultCode
8847
8925
  * * Display Name: Result Code
8848
8926
  * * SQL Data Type: nvarchar(255)
8927
+ * * Description: The unique code string returned by the action to indicate specific outcomes, used for programmatic handling of results.
8849
8928
  */
8850
8929
  get ResultCode(): string;
8851
8930
  set ResultCode(value: string);
@@ -8959,6 +9038,7 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
8959
9038
  * * Field Name: UserPrompt
8960
9039
  * * Display Name: User Prompt
8961
9040
  * * SQL Data Type: nvarchar(MAX)
9041
+ * * Description: The natural language prompt provided by the user describing what the action should accomplish, used for AI code generation.
8962
9042
  */
8963
9043
  get UserPrompt(): string | null;
8964
9044
  set UserPrompt(value: string | null);
@@ -8974,6 +9054,7 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
8974
9054
  * * Field Name: Code
8975
9055
  * * Display Name: Code
8976
9056
  * * SQL Data Type: nvarchar(MAX)
9057
+ * * Description: The generated or manually written code that implements the action logic, typically TypeScript/JavaScript that will be executed.
8977
9058
  */
8978
9059
  get Code(): string | null;
8979
9060
  set Code(value: string | null);
@@ -9172,6 +9253,7 @@ export declare class AIActionEntity extends BaseEntity<AIActionEntityType> {
9172
9253
  * * Field Name: DefaultPrompt
9173
9254
  * * Display Name: Default Prompt
9174
9255
  * * SQL Data Type: nvarchar(MAX)
9256
+ * * Description: The standard prompt template used when invoking this AI action, can include placeholders for dynamic values.
9175
9257
  */
9176
9258
  get DefaultPrompt(): string | null;
9177
9259
  set DefaultPrompt(value: string | null);
@@ -9188,6 +9270,7 @@ export declare class AIActionEntity extends BaseEntity<AIActionEntityType> {
9188
9270
  * * Display Name: Is Active
9189
9271
  * * SQL Data Type: bit
9190
9272
  * * Default Value: 1
9273
+ * * Description: Controls whether this AI action is currently available for use across the system.
9191
9274
  */
9192
9275
  get IsActive(): boolean;
9193
9276
  set IsActive(value: boolean);
@@ -9507,6 +9590,7 @@ export declare class AIAgentModelEntity extends BaseEntity<AIAgentModelEntityTyp
9507
9590
  * * Field Name: Active
9508
9591
  * * Display Name: Active
9509
9592
  * * SQL Data Type: bit
9593
+ * * Description: Indicates whether this specific agent-model combination is currently enabled for use in AI operations.
9510
9594
  */
9511
9595
  get Active(): boolean | null;
9512
9596
  set Active(value: boolean | null);
@@ -9550,6 +9634,7 @@ export declare class AIAgentModelEntity extends BaseEntity<AIAgentModelEntityTyp
9550
9634
  * * Schema: __mj
9551
9635
  * * Base Table: AIAgentNoteType
9552
9636
  * * Base View: vwAIAgentNoteTypes
9637
+ * * @description Defines categories and types for AI agent notes, enabling classification and organization of agent-generated observations, recommendations, and learnings.
9553
9638
  * * Primary Key: ID
9554
9639
  * @extends {BaseEntity}
9555
9640
  * @class
@@ -9610,6 +9695,7 @@ export declare class AIAgentNoteTypeEntity extends BaseEntity<AIAgentNoteTypeEnt
9610
9695
  * * Schema: __mj
9611
9696
  * * Base Table: AIAgentNote
9612
9697
  * * Base View: vwAIAgentNotes
9698
+ * * @description Stores notes, observations, and learnings generated by AI agents during their operations, linked to specific agent runs and categorized by note type. Can be user-specific or general.
9613
9699
  * * Primary Key: ID
9614
9700
  * @extends {BaseEntity}
9615
9701
  * @class
@@ -9656,6 +9742,7 @@ export declare class AIAgentNoteEntity extends BaseEntity<AIAgentNoteEntityType>
9656
9742
  * * Field Name: Note
9657
9743
  * * Display Name: Note
9658
9744
  * * SQL Data Type: nvarchar(MAX)
9745
+ * * Description: The content of the note, observation, or learning captured by the AI agent during its execution.
9659
9746
  */
9660
9747
  get Note(): string | null;
9661
9748
  set Note(value: string | null);
@@ -9886,17 +9973,24 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
9886
9973
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
9887
9974
  /**
9888
9975
  * 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:
9889
- * * MinExecutionsPerRun: This rule ensures that if the minimum executions per run value is provided, it must be zero or greater.
9890
9976
  * * MaxExecutionsPerRun: This rule ensures that the maximum number of executions per run can either be left blank (unspecified) or, if provided, it must be a positive number greater than zero.
9977
+ * * MinExecutionsPerRun: This rule ensures that if the minimum executions per run value is provided, it must be zero or greater.
9978
+ * * Table-Level: This rule ensures that if context compression is enabled, all related settings (message threshold, prompt ID, and message retention count) must be specified. If context compression is not enabled, these settings may be left unspecified.
9891
9979
  * * Table-Level: This rule ensures that if both 'Minimum Executions Per Run' and 'Maximum Executions Per Run' are specified, the minimum must not be greater than the maximum. If either field is not specified, this rule does not apply.
9892
9980
  * * Table-Level: This rule makes sure that if the ParentID is set (not empty), then the ExposeAsAction option must be disabled. If ExposeAsAction is enabled, ParentID must be empty.
9893
- * * Table-Level: This rule ensures that if context compression is enabled, all related settings (message threshold, prompt ID, and message retention count) must be specified. If context compression is not enabled, these settings may be left unspecified.
9894
9981
  * @public
9895
9982
  * @method
9896
9983
  * @override
9897
9984
  */
9898
9985
  Validate(): ValidationResult;
9899
9986
  /**
9987
+ * This rule ensures that the maximum number of executions per run can either be left blank (unspecified) or, if provided, it must be a positive number greater than zero.
9988
+ * @param result - the ValidationResult object to add any errors or warnings to
9989
+ * @public
9990
+ * @method
9991
+ */
9992
+ ValidateMaxExecutionsPerRunIsNullOrPositive(result: ValidationResult): void;
9993
+ /**
9900
9994
  * This rule ensures that if the minimum executions per run value is provided, it must be zero or greater.
9901
9995
  * @param result - the ValidationResult object to add any errors or warnings to
9902
9996
  * @public
@@ -9904,12 +9998,12 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
9904
9998
  */
9905
9999
  ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
9906
10000
  /**
9907
- * This rule ensures that the maximum number of executions per run can either be left blank (unspecified) or, if provided, it must be a positive number greater than zero.
10001
+ * This rule ensures that if context compression is enabled, all related settings (message threshold, prompt ID, and message retention count) must be specified. If context compression is not enabled, these settings may be left unspecified.
9908
10002
  * @param result - the ValidationResult object to add any errors or warnings to
9909
10003
  * @public
9910
10004
  * @method
9911
10005
  */
9912
- ValidateMaxExecutionsPerRunIsNullOrPositive(result: ValidationResult): void;
10006
+ ValidateEnableContextCompressionRequiresContextFields(result: ValidationResult): void;
9913
10007
  /**
9914
10008
  * This rule ensures that if both 'Minimum Executions Per Run' and 'Maximum Executions Per Run' are specified, the minimum must not be greater than the maximum. If either field is not specified, this rule does not apply.
9915
10009
  * @param result - the ValidationResult object to add any errors or warnings to
@@ -9925,13 +10019,6 @@ export declare class AIAgentEntity extends BaseEntity<AIAgentEntityType> {
9925
10019
  */
9926
10020
  ValidateParentIDMustBeNullIfExposeAsActionTrue(result: ValidationResult): void;
9927
10021
  /**
9928
- * This rule ensures that if context compression is enabled, all related settings (message threshold, prompt ID, and message retention count) must be specified. If context compression is not enabled, these settings may be left unspecified.
9929
- * @param result - the ValidationResult object to add any errors or warnings to
9930
- * @public
9931
- * @method
9932
- */
9933
- ValidateEnableContextCompressionRequiresContextFields(result: ValidationResult): void;
9934
- /**
9935
10022
  * * Field Name: ID
9936
10023
  * * Display Name: ID
9937
10024
  * * SQL Data Type: uniqueidentifier
@@ -10229,8 +10316,7 @@ if this limit is exceeded.
10229
10316
  * * Field Name: StartingPayloadValidation
10230
10317
  * * Display Name: Starting Payload Validation
10231
10318
  * * SQL Data Type: nvarchar(MAX)
10232
- * * Description: Optional JSON schema validation to apply to the input payload before agent execution begins. Uses the same JSONValidator
10233
- format as FinalPayloadValidation.
10319
+ * * Description: Optional JSON schema validation to apply to the input payload before agent execution begins. Uses the same JSONValidator format as FinalPayloadValidation.
10234
10320
  */
10235
10321
  get StartingPayloadValidation(): string | null;
10236
10322
  set StartingPayloadValidation(value: string | null);
@@ -10243,8 +10329,7 @@ format as FinalPayloadValidation.
10243
10329
  * * Possible Values
10244
10330
  * * Fail
10245
10331
  * * Warn
10246
- * * Description: Determines how to handle StartingPayloadValidation failures. Fail = reject invalid input, Warn = log warning but
10247
- proceed.
10332
+ * * Description: Determines how to handle StartingPayloadValidation failures. Fail = reject invalid input, Warn = log warning but proceed.
10248
10333
  */
10249
10334
  get StartingPayloadValidationMode(): 'Fail' | 'Warn';
10250
10335
  set StartingPayloadValidationMode(value: 'Fail' | 'Warn');
@@ -10321,6 +10406,7 @@ export declare class AIModelActionEntity extends BaseEntity<AIModelActionEntityT
10321
10406
  * * Display Name: Is Active
10322
10407
  * * SQL Data Type: bit
10323
10408
  * * Default Value: 1
10409
+ * * Description: Determines if this specific action is currently enabled for the associated AI model.
10324
10410
  */
10325
10411
  get IsActive(): boolean;
10326
10412
  set IsActive(value: boolean);
@@ -10438,35 +10524,35 @@ export declare class AIModelEntity extends BaseEntity<AIModelEntityType> {
10438
10524
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
10439
10525
  /**
10440
10526
  * Validate() method override for AI Models entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
10441
- * * SpeedRank: This rule ensures that the speed rank must be zero or a positive number.
10442
10527
  * * CostRank: This rule ensures that the cost rank of an item must be zero or higher. This means that the cost rank cannot be negative.
10443
10528
  * * PowerRank: This rule ensures that the power rank must be greater than or equal to zero, meaning that it cannot be negative.
10529
+ * * SpeedRank: This rule ensures that the speed rank must be zero or a positive number.
10444
10530
  * @public
10445
10531
  * @method
10446
10532
  * @override
10447
10533
  */
10448
10534
  Validate(): ValidationResult;
10449
10535
  /**
10450
- * This rule ensures that the speed rank must be zero or a positive number.
10536
+ * This rule ensures that the cost rank of an item must be zero or higher. This means that the cost rank cannot be negative.
10451
10537
  * @param result - the ValidationResult object to add any errors or warnings to
10452
10538
  * @public
10453
10539
  * @method
10454
10540
  */
10455
- ValidateSpeedRank(result: ValidationResult): void;
10541
+ ValidateCostRank(result: ValidationResult): void;
10456
10542
  /**
10457
- * This rule ensures that the cost rank of an item must be zero or higher. This means that the cost rank cannot be negative.
10543
+ * This rule ensures that the power rank must be greater than or equal to zero, meaning that it cannot be negative.
10458
10544
  * @param result - the ValidationResult object to add any errors or warnings to
10459
10545
  * @public
10460
10546
  * @method
10461
10547
  */
10462
- ValidateCostRank(result: ValidationResult): void;
10548
+ ValidatePowerRank(result: ValidationResult): void;
10463
10549
  /**
10464
- * This rule ensures that the power rank must be greater than or equal to zero, meaning that it cannot be negative.
10550
+ * This rule ensures that the speed rank must be zero or a positive number.
10465
10551
  * @param result - the ValidationResult object to add any errors or warnings to
10466
10552
  * @public
10467
10553
  * @method
10468
10554
  */
10469
- ValidatePowerRank(result: ValidationResult): void;
10555
+ ValidateSpeedRank(result: ValidationResult): void;
10470
10556
  /**
10471
10557
  * * Field Name: ID
10472
10558
  * * Display Name: ID
@@ -10511,6 +10597,7 @@ export declare class AIModelEntity extends BaseEntity<AIModelEntityType> {
10511
10597
  * * Display Name: Is Active
10512
10598
  * * SQL Data Type: bit
10513
10599
  * * Default Value: 1
10600
+ * * Description: Controls whether this AI model is available for use in the system.
10514
10601
  */
10515
10602
  get IsActive(): boolean;
10516
10603
  set IsActive(value: boolean);
@@ -10766,35 +10853,35 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
10766
10853
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
10767
10854
  /**
10768
10855
  * 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:
10769
- * * FailoverStrategy: This rule ensures that the FailoverStrategy field, if specified, must be either 'None', 'PowerRank', 'NextBestModel', 'SameModelDifferentVendor', or left blank (unset).
10770
- * * FailoverModelStrategy: This rule ensures that the value for FailoverModelStrategy is either 'RequireSameModel', 'PreferDifferentModel', 'PreferSameModel', or left blank (not set). Any other value is not allowed.
10771
- * * FailoverErrorScope: This rule ensures that the FailoverErrorScope field can only be set to 'ServiceErrorOnly', 'RateLimitOnly', 'NetworkOnly', 'All', or left empty.
10772
10856
  * * CacheSimilarityThreshold: This rule ensures that if a cache similarity threshold is provided, it must be a value between 0 and 1, inclusive. If no value is provided, that's also allowed.
10773
10857
  * * CacheTTLSeconds: This rule ensures that if the cache expiration time in seconds is provided, it must be greater than zero.
10774
- * * Table-Level: This rule ensures that the ResultSelectorPromptID field must be different from the ID field. In other words, a result selector prompt cannot reference itself.
10858
+ * * FailoverErrorScope: This rule ensures that the FailoverErrorScope field can only be set to 'ServiceErrorOnly', 'RateLimitOnly', 'NetworkOnly', 'All', or left empty.
10859
+ * * FailoverModelStrategy: This rule ensures that the value for FailoverModelStrategy is either 'RequireSameModel', 'PreferDifferentModel', 'PreferSameModel', or left blank (not set). Any other value is not allowed.
10860
+ * * FailoverStrategy: This rule ensures that the FailoverStrategy field, if specified, must be either 'None', 'PowerRank', 'NextBestModel', 'SameModelDifferentVendor', or left blank (unset).
10775
10861
  * * Table-Level: This rule ensures that if the cache match type is set to 'Vector', the cache similarity threshold must be specified. If the match type is anything other than 'Vector', the similarity threshold can be left empty.
10776
- * * Table-Level: This rule ensures that if the parallelization mode is set to 'StaticCount', then the number of parallel tasks (ParallelCount) must be provided.
10777
- * * Table-Level: This rule ensures that if the Parallelization Mode is set to 'ConfigParam', then the Parallel Config Param field must be filled in. For any other mode, the Parallel Config Param can be left empty.
10778
10862
  * * Table-Level: This rule ensures that if the OutputType is set to 'object', an OutputExample must be provided. If the OutputType is anything other than 'object', providing an OutputExample is not required.
10863
+ * * Table-Level: This rule ensures that if the Parallelization Mode is set to 'ConfigParam', then the Parallel Config Param field must be filled in. For any other mode, the Parallel Config Param can be left empty.
10864
+ * * Table-Level: This rule ensures that if the parallelization mode is set to 'StaticCount', then the number of parallel tasks (ParallelCount) must be provided.
10865
+ * * Table-Level: This rule ensures that the ResultSelectorPromptID field must be different from the ID field. In other words, a result selector prompt cannot reference itself.
10779
10866
  * @public
10780
10867
  * @method
10781
10868
  * @override
10782
10869
  */
10783
10870
  Validate(): ValidationResult;
10784
10871
  /**
10785
- * This rule ensures that the FailoverStrategy field, if specified, must be either 'None', 'PowerRank', 'NextBestModel', 'SameModelDifferentVendor', or left blank (unset).
10872
+ * This rule ensures that if a cache similarity threshold is provided, it must be a value between 0 and 1, inclusive. If no value is provided, that's also allowed.
10786
10873
  * @param result - the ValidationResult object to add any errors or warnings to
10787
10874
  * @public
10788
10875
  * @method
10789
10876
  */
10790
- ValidateFailoverStrategyAllowedValues(result: ValidationResult): void;
10877
+ ValidateCacheSimilarityThresholdIsBetweenZeroAndOne(result: ValidationResult): void;
10791
10878
  /**
10792
- * This rule ensures that the value for FailoverModelStrategy is either 'RequireSameModel', 'PreferDifferentModel', 'PreferSameModel', or left blank (not set). Any other value is not allowed.
10879
+ * This rule ensures that if the cache expiration time in seconds is provided, it must be greater than zero.
10793
10880
  * @param result - the ValidationResult object to add any errors or warnings to
10794
10881
  * @public
10795
10882
  * @method
10796
10883
  */
10797
- ValidateFailoverModelStrategyAgainstAllowedValues(result: ValidationResult): void;
10884
+ ValidateCacheTTLSecondsGreaterThanZero(result: ValidationResult): void;
10798
10885
  /**
10799
10886
  * This rule ensures that the FailoverErrorScope field can only be set to 'ServiceErrorOnly', 'RateLimitOnly', 'NetworkOnly', 'All', or left empty.
10800
10887
  * @param result - the ValidationResult object to add any errors or warnings to
@@ -10803,54 +10890,54 @@ export declare class AIPromptEntity extends BaseEntity<AIPromptEntityType> {
10803
10890
  */
10804
10891
  ValidateFailoverErrorScopeAgainstAllowedValues(result: ValidationResult): void;
10805
10892
  /**
10806
- * This rule ensures that if a cache similarity threshold is provided, it must be a value between 0 and 1, inclusive. If no value is provided, that's also allowed.
10893
+ * This rule ensures that the value for FailoverModelStrategy is either 'RequireSameModel', 'PreferDifferentModel', 'PreferSameModel', or left blank (not set). Any other value is not allowed.
10807
10894
  * @param result - the ValidationResult object to add any errors or warnings to
10808
10895
  * @public
10809
10896
  * @method
10810
10897
  */
10811
- ValidateCacheSimilarityThresholdIsBetweenZeroAndOne(result: ValidationResult): void;
10898
+ ValidateFailoverModelStrategyAgainstAllowedValues(result: ValidationResult): void;
10812
10899
  /**
10813
- * This rule ensures that if the cache expiration time in seconds is provided, it must be greater than zero.
10900
+ * This rule ensures that the FailoverStrategy field, if specified, must be either 'None', 'PowerRank', 'NextBestModel', 'SameModelDifferentVendor', or left blank (unset).
10814
10901
  * @param result - the ValidationResult object to add any errors or warnings to
10815
10902
  * @public
10816
10903
  * @method
10817
10904
  */
10818
- ValidateCacheTTLSecondsGreaterThanZero(result: ValidationResult): void;
10905
+ ValidateFailoverStrategyAllowedValues(result: ValidationResult): void;
10819
10906
  /**
10820
- * This rule ensures that the ResultSelectorPromptID field must be different from the ID field. In other words, a result selector prompt cannot reference itself.
10907
+ * This rule ensures that if the cache match type is set to 'Vector', the cache similarity threshold must be specified. If the match type is anything other than 'Vector', the similarity threshold can be left empty.
10821
10908
  * @param result - the ValidationResult object to add any errors or warnings to
10822
10909
  * @public
10823
10910
  * @method
10824
10911
  */
10825
- ValidateResultSelectorPromptIDNotEqualID(result: ValidationResult): void;
10912
+ ValidateCacheSimilarityThresholdRequiredForVectorCache(result: ValidationResult): void;
10826
10913
  /**
10827
- * This rule ensures that if the cache match type is set to 'Vector', the cache similarity threshold must be specified. If the match type is anything other than 'Vector', the similarity threshold can be left empty.
10914
+ * This rule ensures that if the OutputType is set to 'object', an OutputExample must be provided. If the OutputType is anything other than 'object', providing an OutputExample is not required.
10828
10915
  * @param result - the ValidationResult object to add any errors or warnings to
10829
10916
  * @public
10830
10917
  * @method
10831
10918
  */
10832
- ValidateCacheSimilarityThresholdRequiredForVectorCache(result: ValidationResult): void;
10919
+ ValidateOutputExampleWhenOutputTypeObject(result: ValidationResult): void;
10833
10920
  /**
10834
- * This rule ensures that if the parallelization mode is set to 'StaticCount', then the number of parallel tasks (ParallelCount) must be provided.
10921
+ * This rule ensures that if the Parallelization Mode is set to 'ConfigParam', then the Parallel Config Param field must be filled in. For any other mode, the Parallel Config Param can be left empty.
10835
10922
  * @param result - the ValidationResult object to add any errors or warnings to
10836
10923
  * @public
10837
10924
  * @method
10838
10925
  */
10839
- ValidateParallelCountWhenParallelizationModeIsStaticCount(result: ValidationResult): void;
10926
+ ValidateParallelConfigParamRequiredForConfigParamMode(result: ValidationResult): void;
10840
10927
  /**
10841
- * This rule ensures that if the Parallelization Mode is set to 'ConfigParam', then the Parallel Config Param field must be filled in. For any other mode, the Parallel Config Param can be left empty.
10928
+ * This rule ensures that if the parallelization mode is set to 'StaticCount', then the number of parallel tasks (ParallelCount) must be provided.
10842
10929
  * @param result - the ValidationResult object to add any errors or warnings to
10843
10930
  * @public
10844
10931
  * @method
10845
10932
  */
10846
- ValidateParallelConfigParamRequiredForConfigParamMode(result: ValidationResult): void;
10933
+ ValidateParallelCountWhenParallelizationModeIsStaticCount(result: ValidationResult): void;
10847
10934
  /**
10848
- * This rule ensures that if the OutputType is set to 'object', an OutputExample must be provided. If the OutputType is anything other than 'object', providing an OutputExample is not required.
10935
+ * This rule ensures that the ResultSelectorPromptID field must be different from the ID field. In other words, a result selector prompt cannot reference itself.
10849
10936
  * @param result - the ValidationResult object to add any errors or warnings to
10850
10937
  * @public
10851
10938
  * @method
10852
10939
  */
10853
- ValidateOutputExampleWhenOutputTypeObject(result: ValidationResult): void;
10940
+ ValidateResultSelectorPromptIDNotEqualID(result: ValidationResult): void;
10854
10941
  /**
10855
10942
  * * Field Name: ID
10856
10943
  * * Display Name: ID
@@ -11599,6 +11686,7 @@ export declare class ApplicationEntityEntity extends BaseEntity<ApplicationEntit
11599
11686
  /**
11600
11687
  * * Field Name: Sequence
11601
11688
  * * SQL Data Type: int
11689
+ * * Description: Display order of this entity within the application, lower numbers appear first in navigation and menus.
11602
11690
  */
11603
11691
  get Sequence(): number;
11604
11692
  set Sequence(value: number);
@@ -11665,6 +11753,7 @@ export declare class ApplicationEntityEntity extends BaseEntity<ApplicationEntit
11665
11753
  * * Schema: __mj
11666
11754
  * * Base Table: ApplicationSetting
11667
11755
  * * Base View: vwApplicationSettings
11756
+ * * @description Stores configuration settings and preferences for applications, including key-value pairs for runtime parameters and user-specific customizations.
11668
11757
  * * Primary Key: ID
11669
11758
  * @extends {BaseEntity}
11670
11759
  * @class
@@ -11710,6 +11799,7 @@ export declare class ApplicationSettingEntity extends BaseEntity<ApplicationSett
11710
11799
  * * Field Name: Value
11711
11800
  * * Display Name: Value
11712
11801
  * * SQL Data Type: nvarchar(MAX)
11802
+ * * Description: The setting value, can be simple text, numbers, booleans, or JSON for complex configuration objects.
11713
11803
  */
11714
11804
  get Value(): string;
11715
11805
  set Value(value: string);
@@ -11829,6 +11919,7 @@ export declare class ApplicationEntity extends BaseEntity<ApplicationEntityType>
11829
11919
  * * Schema: __mj
11830
11920
  * * Base Table: AuditLogType
11831
11921
  * * Base View: vwAuditLogTypes
11922
+ * * @description Defines the types of events that can be recorded in the audit log, enabling categorization and filtering of system activities.
11832
11923
  * * Primary Key: ID
11833
11924
  * @extends {BaseEntity}
11834
11925
  * @class
@@ -11917,6 +12008,7 @@ export declare class AuditLogTypeEntity extends BaseEntity<AuditLogTypeEntityTyp
11917
12008
  * * Schema: __mj
11918
12009
  * * Base Table: AuditLog
11919
12010
  * * Base View: vwAuditLogs
12011
+ * * @description Tracks system events and user actions for security, compliance, and debugging purposes, providing a complete audit trail. Any application can write entries to this entity.
11920
12012
  * * Primary Key: ID
11921
12013
  * @extends {BaseEntity}
11922
12014
  * @class
@@ -11990,6 +12082,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
11990
12082
  * * Field Name: Details
11991
12083
  * * Display Name: Details
11992
12084
  * * SQL Data Type: nvarchar(MAX)
12085
+ * * Description: JSON-formatted additional context about the audited event, including before/after values, parameters, or other relevant data.
11993
12086
  */
11994
12087
  get Details(): string | null;
11995
12088
  set Details(value: string | null);
@@ -12005,6 +12098,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
12005
12098
  * * Field Name: RecordID
12006
12099
  * * Display Name: Record
12007
12100
  * * SQL Data Type: nvarchar(450)
12101
+ * * Description: The primary key value of the record that was affected by this audited action, enabling direct lookup of the modified data.
12008
12102
  */
12009
12103
  get RecordID(): string | null;
12010
12104
  set RecordID(value: string | null);
@@ -12052,6 +12146,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
12052
12146
  * * Schema: __mj
12053
12147
  * * Base Table: AuthorizationRole
12054
12148
  * * Base View: vwAuthorizationRoles
12149
+ * * @description Links authorizations to roles, defining which permissions are granted to users assigned to specific roles in the system.
12055
12150
  * * Primary Key: ID
12056
12151
  * @extends {BaseEntity}
12057
12152
  * @class
@@ -12103,6 +12198,7 @@ export declare class AuthorizationRoleEntity extends BaseEntity<AuthorizationRol
12103
12198
  * * Possible Values
12104
12199
  * * Allow - User allowed to execute tasks linked to this authorization
12105
12200
  * * Deny - User NOT allowed to execute tasks linked to this authorization - deny overrides Allow from all other roles a user may be part of
12201
+ * * Description: Specifies whether this authorization is granted to ('grant') or explicitly denied ('deny') for the role.
12106
12202
  */
12107
12203
  get Type(): 'Allow' | 'Deny';
12108
12204
  set Type(value: 'Allow' | 'Deny');
@@ -12138,6 +12234,7 @@ export declare class AuthorizationRoleEntity extends BaseEntity<AuthorizationRol
12138
12234
  * * Schema: __mj
12139
12235
  * * Base Table: Authorization
12140
12236
  * * Base View: vwAuthorizations
12237
+ * * @description Stores the fundamental permissions and access rights that can be granted to users and roles throughout the system.
12141
12238
  * * Primary Key: ID
12142
12239
  * @extends {BaseEntity}
12143
12240
  * @class
@@ -12184,6 +12281,7 @@ export declare class AuthorizationEntity extends BaseEntity<AuthorizationEntityT
12184
12281
  * * Display Name: Is Active
12185
12282
  * * SQL Data Type: bit
12186
12283
  * * Default Value: 1
12284
+ * * Description: Indicates whether this authorization is currently active and can be granted to users or roles.
12187
12285
  */
12188
12286
  get IsActive(): boolean;
12189
12287
  set IsActive(value: boolean);
@@ -12260,6 +12358,7 @@ export declare class CommunicationBaseMessageTypeEntity extends BaseEntity<Commu
12260
12358
  * * Field Name: Type
12261
12359
  * * Display Name: Type
12262
12360
  * * SQL Data Type: nvarchar(100)
12361
+ * * Description: The unique identifier for this message type, used for routing and processing communications.
12263
12362
  */
12264
12363
  get Type(): string;
12265
12364
  set Type(value: string);
@@ -12846,6 +12945,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12846
12945
  /**
12847
12946
  * * Field Name: Website
12848
12947
  * * SQL Data Type: nvarchar(100)
12948
+ * * Description: The primary website URL for this company or division.
12849
12949
  */
12850
12950
  get Website(): string | null;
12851
12951
  set Website(value: string | null);
@@ -12853,6 +12953,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12853
12953
  * * Field Name: LogoURL
12854
12954
  * * Display Name: Logo URL
12855
12955
  * * SQL Data Type: nvarchar(500)
12956
+ * * Description: URL pointing to the company's logo image, used for branding in the UI.
12856
12957
  */
12857
12958
  get LogoURL(): string | null;
12858
12959
  set LogoURL(value: string | null);
@@ -12860,6 +12961,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12860
12961
  * * Field Name: Domain
12861
12962
  * * Display Name: Domain
12862
12963
  * * SQL Data Type: nvarchar(255)
12964
+ * * Description: The primary email domain associated with this company, used for employee email validation and SSO configuration.
12863
12965
  */
12864
12966
  get Domain(): string | null;
12865
12967
  set Domain(value: string | null);
@@ -12883,6 +12985,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12883
12985
  * * Schema: __mj
12884
12986
  * * Base Table: CompanyIntegrationRecordMap
12885
12987
  * * Base View: vwCompanyIntegrationRecordMaps
12988
+ * * @description Maps records between internal entities and external system identifiers, maintaining synchronization between MemberJunction and integrated platforms.
12886
12989
  * * Primary Key: ID
12887
12990
  * @extends {BaseEntity}
12888
12991
  * @class
@@ -12921,6 +13024,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12921
13024
  * * Field Name: ExternalSystemRecordID
12922
13025
  * * Display Name: External System Record ID
12923
13026
  * * SQL Data Type: nvarchar(750)
13027
+ * * Description: The unique identifier for this record in the external integrated system.
12924
13028
  */
12925
13029
  get ExternalSystemRecordID(): string;
12926
13030
  set ExternalSystemRecordID(value: string);
@@ -12936,6 +13040,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12936
13040
  * * Field Name: EntityRecordID
12937
13041
  * * Display Name: Entity Record ID
12938
13042
  * * SQL Data Type: nvarchar(750)
13043
+ * * Description: The internal MemberJunction record ID that corresponds to the external system record.
12939
13044
  */
12940
13045
  get EntityRecordID(): string;
12941
13046
  set EntityRecordID(value: string);
@@ -12971,6 +13076,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12971
13076
  * * Schema: __mj
12972
13077
  * * Base Table: CompanyIntegrationRunAPILog
12973
13078
  * * Base View: vwCompanyIntegrationRunAPILogs
13079
+ * * @description Logs detailed API calls and responses during integration runs, including request/response payloads, status codes, and timing information.
12974
13080
  * * Primary Key: ID
12975
13081
  * @extends {BaseEntity}
12976
13082
  * @class
@@ -13009,6 +13115,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13009
13115
  * * Display Name: Executed At
13010
13116
  * * SQL Data Type: datetime
13011
13117
  * * Default Value: getdate()
13118
+ * * Description: Timestamp when this API call was executed during the integration run.
13012
13119
  */
13013
13120
  get ExecutedAt(): Date;
13014
13121
  set ExecutedAt(value: Date);
@@ -13017,6 +13124,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13017
13124
  * * Display Name: Is Success
13018
13125
  * * SQL Data Type: bit
13019
13126
  * * Default Value: 0
13127
+ * * Description: Indicates whether the API call completed successfully or encountered an error.
13020
13128
  */
13021
13129
  get IsSuccess(): boolean;
13022
13130
  set IsSuccess(value: boolean);
@@ -13033,18 +13141,21 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13033
13141
  * * PATCH
13034
13142
  * * HEAD
13035
13143
  * * OPTIONS
13144
+ * * Description: HTTP method used for the API call (GET, POST, PUT, DELETE, PATCH).
13036
13145
  */
13037
13146
  get RequestMethod(): 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null;
13038
13147
  set RequestMethod(value: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null);
13039
13148
  /**
13040
13149
  * * Field Name: URL
13041
13150
  * * SQL Data Type: nvarchar(MAX)
13151
+ * * Description: The complete URL that was called, including query parameters.
13042
13152
  */
13043
13153
  get URL(): string | null;
13044
13154
  set URL(value: string | null);
13045
13155
  /**
13046
13156
  * * Field Name: Parameters
13047
13157
  * * SQL Data Type: nvarchar(MAX)
13158
+ * * Description: JSON-formatted request body or parameters sent with the API call.
13048
13159
  */
13049
13160
  get Parameters(): string | null;
13050
13161
  set Parameters(value: string | null);
@@ -13068,6 +13179,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13068
13179
  * * Schema: __mj
13069
13180
  * * Base Table: CompanyIntegrationRunDetail
13070
13181
  * * Base View: vwCompanyIntegrationRunDetails
13182
+ * * @description Tracks individual record-level operations within an integration run, including success/failure status and error details for each processed item.
13071
13183
  * * Primary Key: ID
13072
13184
  * @extends {BaseEntity}
13073
13185
  * @class
@@ -13113,12 +13225,14 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13113
13225
  * * Field Name: RecordID
13114
13226
  * * Display Name: Record
13115
13227
  * * SQL Data Type: nvarchar(450)
13228
+ * * Description: The ID of the specific record being processed in this integration operation.
13116
13229
  */
13117
13230
  get RecordID(): string;
13118
13231
  set RecordID(value: string);
13119
13232
  /**
13120
13233
  * * Field Name: Action
13121
13234
  * * SQL Data Type: nchar(20)
13235
+ * * Description: The type of operation performed (INSERT, UPDATE, DELETE, SYNC).
13122
13236
  */
13123
13237
  get Action(): string;
13124
13238
  set Action(value: string);
@@ -13127,6 +13241,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13127
13241
  * * Display Name: Executed At
13128
13242
  * * SQL Data Type: datetime
13129
13243
  * * Default Value: getdate()
13244
+ * * Description: Timestamp when this specific record operation was executed.
13130
13245
  */
13131
13246
  get ExecutedAt(): Date;
13132
13247
  set ExecutedAt(value: Date);
@@ -13135,6 +13250,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13135
13250
  * * Display Name: Is Success
13136
13251
  * * SQL Data Type: bit
13137
13252
  * * Default Value: 0
13253
+ * * Description: Indicates whether this individual record operation succeeded or failed.
13138
13254
  */
13139
13255
  get IsSuccess(): boolean;
13140
13256
  set IsSuccess(value: boolean);
@@ -13175,6 +13291,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13175
13291
  * * Schema: __mj
13176
13292
  * * Base Table: CompanyIntegrationRun
13177
13293
  * * Base View: vwCompanyIntegrationRuns
13294
+ * * @description Records execution history of company integrations, including start/end times, overall status, and aggregate statistics for monitoring and troubleshooting.
13178
13295
  * * Primary Key: ID
13179
13296
  * @extends {BaseEntity}
13180
13297
  * @class
@@ -13234,6 +13351,7 @@ export declare class CompanyIntegrationRunEntity extends BaseEntity<CompanyInteg
13234
13351
  * * Field Name: TotalRecords
13235
13352
  * * Display Name: Total Records
13236
13353
  * * SQL Data Type: int
13354
+ * * Description: The total number of records processed during this integration run.
13237
13355
  */
13238
13356
  get TotalRecords(): number;
13239
13357
  set TotalRecords(value: number);
@@ -13358,6 +13476,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13358
13476
  * * Field Name: IsActive
13359
13477
  * * Display Name: Is Active
13360
13478
  * * SQL Data Type: bit
13479
+ * * Description: Controls whether this integration is currently active for the company.
13361
13480
  */
13362
13481
  get IsActive(): boolean | null;
13363
13482
  set IsActive(value: boolean | null);
@@ -13365,6 +13484,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13365
13484
  * * Field Name: AccessToken
13366
13485
  * * Display Name: Access Token
13367
13486
  * * SQL Data Type: nvarchar(255)
13487
+ * * Description: OAuth access token for authenticating with the external system.
13368
13488
  */
13369
13489
  get AccessToken(): string | null;
13370
13490
  set AccessToken(value: string | null);
@@ -13372,6 +13492,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13372
13492
  * * Field Name: RefreshToken
13373
13493
  * * Display Name: Refresh Token
13374
13494
  * * SQL Data Type: nvarchar(255)
13495
+ * * Description: OAuth refresh token used to obtain new access tokens when they expire.
13375
13496
  */
13376
13497
  get RefreshToken(): string | null;
13377
13498
  set RefreshToken(value: string | null);
@@ -13379,12 +13500,14 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13379
13500
  * * Field Name: TokenExpirationDate
13380
13501
  * * Display Name: Token Expiration Date
13381
13502
  * * SQL Data Type: datetime
13503
+ * * Description: Timestamp when the current access token expires and needs to be refreshed.
13382
13504
  */
13383
13505
  get TokenExpirationDate(): Date | null;
13384
13506
  set TokenExpirationDate(value: Date | null);
13385
13507
  /**
13386
13508
  * * Field Name: APIKey
13387
13509
  * * SQL Data Type: nvarchar(255)
13510
+ * * Description: API key for systems using key-based authentication instead of OAuth.
13388
13511
  */
13389
13512
  get APIKey(): string | null;
13390
13513
  set APIKey(value: string | null);
@@ -13392,6 +13515,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13392
13515
  * * Field Name: ExternalSystemID
13393
13516
  * * Display Name: ExternalSystem
13394
13517
  * * SQL Data Type: nvarchar(100)
13518
+ * * Description: The company's identifier in the external system, used for API calls.
13395
13519
  */
13396
13520
  get ExternalSystemID(): string | null;
13397
13521
  set ExternalSystemID(value: string | null);
@@ -13400,6 +13524,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13400
13524
  * * Display Name: Is External System Read Only
13401
13525
  * * SQL Data Type: bit
13402
13526
  * * Default Value: 0
13527
+ * * Description: Indicates if data can only be read from the external system, not written back.
13403
13528
  */
13404
13529
  get IsExternalSystemReadOnly(): boolean;
13405
13530
  set IsExternalSystemReadOnly(value: boolean);
@@ -13407,6 +13532,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13407
13532
  * * Field Name: ClientID
13408
13533
  * * Display Name: Client
13409
13534
  * * SQL Data Type: nvarchar(255)
13535
+ * * Description: OAuth client ID for this integration instance.
13410
13536
  */
13411
13537
  get ClientID(): string | null;
13412
13538
  set ClientID(value: string | null);
@@ -13414,6 +13540,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13414
13540
  * * Field Name: ClientSecret
13415
13541
  * * Display Name: Client Secret
13416
13542
  * * SQL Data Type: nvarchar(255)
13543
+ * * Description: OAuth client secret for authentication, should be encrypted at rest.
13417
13544
  */
13418
13545
  get ClientSecret(): string | null;
13419
13546
  set ClientSecret(value: string | null);
@@ -13421,6 +13548,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13421
13548
  * * Field Name: CustomAttribute1
13422
13549
  * * Display Name: Custom Attribute 1
13423
13550
  * * SQL Data Type: nvarchar(255)
13551
+ * * Description: Flexible field for storing integration-specific configuration or metadata.
13424
13552
  */
13425
13553
  get CustomAttribute1(): string | null;
13426
13554
  set CustomAttribute1(value: string | null);
@@ -13492,6 +13620,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13492
13620
  * * Schema: __mj
13493
13621
  * * Base Table: ContentFileType
13494
13622
  * * Base View: vwContentFileTypes
13623
+ * * @description Defines supported file types for content management, including extensions and processing rules for different content formats.
13495
13624
  * * Primary Key: ID
13496
13625
  * @extends {BaseEntity}
13497
13626
  * @class
@@ -13529,6 +13658,7 @@ export declare class ContentFileTypeEntity extends BaseEntity<ContentFileTypeEnt
13529
13658
  * * Field Name: FileExtension
13530
13659
  * * Display Name: File Extension
13531
13660
  * * SQL Data Type: nvarchar(255)
13661
+ * * Description: The file extension (e.g., .pdf, .docx, .jpg) used to identify this content type.
13532
13662
  */
13533
13663
  get FileExtension(): string | null;
13534
13664
  set FileExtension(value: string | null);
@@ -13552,6 +13682,7 @@ export declare class ContentFileTypeEntity extends BaseEntity<ContentFileTypeEnt
13552
13682
  * * Schema: __mj
13553
13683
  * * Base Table: ContentItemAttribute
13554
13684
  * * Base View: vwContentItemAttributes
13685
+ * * @description Stores metadata attributes extracted with prompting for content items, enabling flexible key-value properties and custom fields for content classification.
13555
13686
  * * Primary Key: ID
13556
13687
  * @extends {BaseEntity}
13557
13688
  * @class
@@ -13597,6 +13728,7 @@ export declare class ContentItemAttributeEntity extends BaseEntity<ContentItemAt
13597
13728
  * * Field Name: Value
13598
13729
  * * Display Name: Value
13599
13730
  * * SQL Data Type: nvarchar(MAX)
13731
+ * * Description: The extracted or assigned value for this attribute on the content item.
13600
13732
  */
13601
13733
  get Value(): string;
13602
13734
  set Value(value: string);
@@ -13626,6 +13758,7 @@ export declare class ContentItemAttributeEntity extends BaseEntity<ContentItemAt
13626
13758
  * * Schema: __mj
13627
13759
  * * Base Table: ContentItemTag
13628
13760
  * * Base View: vwContentItemTags
13761
+ * * @description Links tags to content items for categorization, searchability, and content discovery across the system.
13629
13762
  * * Primary Key: ID
13630
13763
  * @extends {BaseEntity}
13631
13764
  * @class
@@ -13664,6 +13797,7 @@ export declare class ContentItemTagEntity extends BaseEntity<ContentItemTagEntit
13664
13797
  * * Field Name: Tag
13665
13798
  * * Display Name: Tag
13666
13799
  * * SQL Data Type: nvarchar(200)
13800
+ * * Description: The tag text applied to the content item for categorization and search.
13667
13801
  */
13668
13802
  get Tag(): string;
13669
13803
  set Tag(value: string);
@@ -13693,6 +13827,7 @@ export declare class ContentItemTagEntity extends BaseEntity<ContentItemTagEntit
13693
13827
  * * Schema: __mj
13694
13828
  * * Base Table: ContentItem
13695
13829
  * * Base View: vwContentItems
13830
+ * * @description Stores extracted text from content assets, as well as the source location, versioning, and links to extracted tags and attributes.
13696
13831
  * * Primary Key: ID
13697
13832
  * @extends {BaseEntity}
13698
13833
  * @class
@@ -13769,6 +13904,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13769
13904
  * * Field Name: Checksum
13770
13905
  * * Display Name: Checksum
13771
13906
  * * SQL Data Type: nvarchar(100)
13907
+ * * Description: Hash value of the content used to detect changes and prevent duplicate processing.
13772
13908
  */
13773
13909
  get Checksum(): string | null;
13774
13910
  set Checksum(value: string | null);
@@ -13776,6 +13912,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13776
13912
  * * Field Name: URL
13777
13913
  * * Display Name: URL
13778
13914
  * * SQL Data Type: nvarchar(2000)
13915
+ * * Description: The source location URL where this content was retrieved from.
13779
13916
  */
13780
13917
  get URL(): string;
13781
13918
  set URL(value: string);
@@ -13783,6 +13920,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13783
13920
  * * Field Name: Text
13784
13921
  * * Display Name: Text
13785
13922
  * * SQL Data Type: nvarchar(MAX)
13923
+ * * Description: The extracted text content from the source document or file.
13786
13924
  */
13787
13925
  get Text(): string | null;
13788
13926
  set Text(value: string | null);
@@ -13830,6 +13968,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13830
13968
  * * Schema: __mj
13831
13969
  * * Base Table: ContentProcessRun
13832
13970
  * * Base View: vwContentProcessRuns
13971
+ * * @description Tracks execution of content tagging workflows, logging the status and details of each execution and ensuring efficient processing of content.
13833
13972
  * * Primary Key: ID
13834
13973
  * @extends {BaseEntity}
13835
13974
  * @class
@@ -13868,6 +14007,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13868
14007
  * * Field Name: StartTime
13869
14008
  * * Display Name: Start Time
13870
14009
  * * SQL Data Type: datetime
14010
+ * * Description: Timestamp when the content processing workflow began execution.
13871
14011
  */
13872
14012
  get StartTime(): Date | null;
13873
14013
  set StartTime(value: Date | null);
@@ -13875,6 +14015,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13875
14015
  * * Field Name: EndTime
13876
14016
  * * Display Name: End Time
13877
14017
  * * SQL Data Type: datetime
14018
+ * * Description: Timestamp when the content processing workflow completed or failed.
13878
14019
  */
13879
14020
  get EndTime(): Date | null;
13880
14021
  set EndTime(value: Date | null);
@@ -13889,6 +14030,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13889
14030
  * * Field Name: ProcessedItems
13890
14031
  * * Display Name: Processed Items
13891
14032
  * * SQL Data Type: int
14033
+ * * Description: Count of content items successfully processed during this run.
13892
14034
  */
13893
14035
  get ProcessedItems(): number | null;
13894
14036
  set ProcessedItems(value: number | null);
@@ -13918,6 +14060,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13918
14060
  * * Schema: __mj
13919
14061
  * * Base Table: ContentSourceParam
13920
14062
  * * Base View: vwContentSourceParams
14063
+ * * @description Stores configuration parameters for specific content source instances, customizing how content is retrieved and processed from each source.
13921
14064
  * * Primary Key: ID
13922
14065
  * @extends {BaseEntity}
13923
14066
  * @class
@@ -13956,6 +14099,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13956
14099
  * * Field Name: ContentSourceTypeParamID
13957
14100
  * * Display Name: Content Source Type Param ID
13958
14101
  * * SQL Data Type: uniqueidentifier
14102
+ * * Description: Reference to the parameter definition in Content Source Type Params.
13959
14103
  */
13960
14104
  get ContentSourceTypeParamID(): string;
13961
14105
  set ContentSourceTypeParamID(value: string);
@@ -13963,6 +14107,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13963
14107
  * * Field Name: Value
13964
14108
  * * Display Name: Value
13965
14109
  * * SQL Data Type: nvarchar(MAX)
14110
+ * * Description: The configured value for this parameter on this specific content source.
13966
14111
  */
13967
14112
  get Value(): string;
13968
14113
  set Value(value: string);
@@ -13992,6 +14137,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13992
14137
  * * Schema: __mj
13993
14138
  * * Base Table: ContentSourceTypeParam
13994
14139
  * * Base View: vwContentSourceTypeParams
14140
+ * * @description Defines required and optional parameters for content source types, establishing the configuration for each source type.
13995
14141
  * * Primary Key: ID
13996
14142
  * @extends {BaseEntity}
13997
14143
  * @class
@@ -14036,6 +14182,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14036
14182
  * * Field Name: Type
14037
14183
  * * Display Name: Type
14038
14184
  * * SQL Data Type: nvarchar(50)
14185
+ * * Description: Data type of the parameter (string, number, boolean, date, etc.).
14039
14186
  */
14040
14187
  get Type(): string | null;
14041
14188
  set Type(value: string | null);
@@ -14043,6 +14190,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14043
14190
  * * Field Name: DefaultValue
14044
14191
  * * Display Name: Default Value
14045
14192
  * * SQL Data Type: nvarchar(MAX)
14193
+ * * Description: Default value to use if not specified when configuring a content source.
14046
14194
  */
14047
14195
  get DefaultValue(): string | null;
14048
14196
  set DefaultValue(value: string | null);
@@ -14050,6 +14198,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14050
14198
  * * Field Name: IsRequired
14051
14199
  * * Display Name: Is Required
14052
14200
  * * SQL Data Type: bit
14201
+ * * Description: Indicates whether this parameter must be provided when setting up a content source.
14053
14202
  */
14054
14203
  get IsRequired(): boolean;
14055
14204
  set IsRequired(value: boolean);
@@ -14073,6 +14222,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14073
14222
  * * Schema: __mj
14074
14223
  * * Base Table: ContentSourceType
14075
14224
  * * Base View: vwContentSourceTypes
14225
+ * * @description Catalogs available content source types such as file systems, APIs, websites, databases, and cloud storage platforms with their capabilities.
14076
14226
  * * Primary Key: ID
14077
14227
  * @extends {BaseEntity}
14078
14228
  * @class
@@ -14133,6 +14283,7 @@ export declare class ContentSourceTypeEntity extends BaseEntity<ContentSourceTyp
14133
14283
  * * Schema: __mj
14134
14284
  * * Base Table: ContentSource
14135
14285
  * * Base View: vwContentSources
14286
+ * * @description Configures connections to external content repositories and systems from which content is imported, synchronized, and tagged.
14136
14287
  * * Primary Key: ID
14137
14288
  * @extends {BaseEntity}
14138
14289
  * @class
@@ -14194,6 +14345,7 @@ export declare class ContentSourceEntity extends BaseEntity<ContentSourceEntityT
14194
14345
  * * Field Name: URL
14195
14346
  * * Display Name: URL
14196
14347
  * * SQL Data Type: nvarchar(2000)
14348
+ * * Description: Base URL or connection string for accessing this content source.
14197
14349
  */
14198
14350
  get URL(): string;
14199
14351
  set URL(value: string);
@@ -14235,6 +14387,7 @@ export declare class ContentSourceEntity extends BaseEntity<ContentSourceEntityT
14235
14387
  * * Schema: __mj
14236
14388
  * * Base Table: ContentTypeAttribute
14237
14389
  * * Base View: vwContentTypeAttributes
14390
+ * * @description Defines the attributes available for extraction via prompt for each content type.
14238
14391
  * * Primary Key: ID
14239
14392
  * @extends {BaseEntity}
14240
14393
  * @class
@@ -14265,6 +14418,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14265
14418
  * * Field Name: ContentTypeID
14266
14419
  * * Display Name: Content Type ID
14267
14420
  * * SQL Data Type: uniqueidentifier
14421
+ * * Description: Reference to the Content Type this attribute belongs to.
14268
14422
  */
14269
14423
  get ContentTypeID(): string;
14270
14424
  set ContentTypeID(value: string);
@@ -14279,6 +14433,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14279
14433
  * * Field Name: Prompt
14280
14434
  * * Display Name: Prompt
14281
14435
  * * SQL Data Type: nvarchar(MAX)
14436
+ * * Description: The AI prompt template used to extract this attribute from content.
14282
14437
  */
14283
14438
  get Prompt(): string;
14284
14439
  set Prompt(value: string);
@@ -14309,6 +14464,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14309
14464
  * * Schema: __mj
14310
14465
  * * Base Table: ContentType
14311
14466
  * * Base View: vwContentTypes
14467
+ * * @description Defines categories of content with specific schemas, behaviors, and processing rules for structured content management.
14312
14468
  * * Primary Key: ID
14313
14469
  * @extends {BaseEntity}
14314
14470
  * @class
@@ -14361,6 +14517,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14361
14517
  * * Field Name: MinTags
14362
14518
  * * Display Name: Min Tags
14363
14519
  * * SQL Data Type: int
14520
+ * * Description: Minimum number of tags that must be applied to content of this type.
14364
14521
  */
14365
14522
  get MinTags(): number;
14366
14523
  set MinTags(value: number);
@@ -14368,6 +14525,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14368
14525
  * * Field Name: MaxTags
14369
14526
  * * Display Name: Max Tags
14370
14527
  * * SQL Data Type: int
14528
+ * * Description: Maximum number of tags allowed on content of this type.
14371
14529
  */
14372
14530
  get MaxTags(): number;
14373
14531
  set MaxTags(value: number);
@@ -14397,6 +14555,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14397
14555
  * * Schema: __mj
14398
14556
  * * Base Table: ConversationDetail
14399
14557
  * * Base View: vwConversationDetails
14558
+ * * @description Stores individual messages, responses, and interactions within a conversation, maintaining the complete dialogue history with timestamps.
14400
14559
  * * Primary Key: ID
14401
14560
  * @extends {BaseEntity}
14402
14561
  * @class
@@ -14450,6 +14609,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14450
14609
  * * Field Name: ExternalID
14451
14610
  * * Display Name: External ID
14452
14611
  * * SQL Data Type: nvarchar(100)
14612
+ * * Description: External system identifier for this message, used for integration scenarios.
14453
14613
  */
14454
14614
  get ExternalID(): string | null;
14455
14615
  set ExternalID(value: string | null);
@@ -14463,6 +14623,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14463
14623
  * * User
14464
14624
  * * AI
14465
14625
  * * Error
14626
+ * * Description: The role of the message sender (user, assistant, system, function).
14466
14627
  */
14467
14628
  get Role(): 'User' | 'AI' | 'Error';
14468
14629
  set Role(value: 'User' | 'AI' | 'Error');
@@ -14470,6 +14631,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14470
14631
  * * Field Name: Message
14471
14632
  * * Display Name: Message
14472
14633
  * * SQL Data Type: nvarchar(MAX)
14634
+ * * Description: The actual content of the message in the conversation.
14473
14635
  */
14474
14636
  get Message(): string;
14475
14637
  set Message(value: string);
@@ -14477,6 +14639,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14477
14639
  * * Field Name: Error
14478
14640
  * * Display Name: Error
14479
14641
  * * SQL Data Type: nvarchar(MAX)
14642
+ * * Description: Error message if this conversation turn encountered a problem.
14480
14643
  */
14481
14644
  get Error(): string | null;
14482
14645
  set Error(value: string | null);
@@ -14485,6 +14648,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14485
14648
  * * Display Name: Hidden To User
14486
14649
  * * SQL Data Type: bit
14487
14650
  * * Default Value: 0
14651
+ * * Description: Flag indicating if this message should be hidden from end users (system messages, function calls, etc.).
14488
14652
  */
14489
14653
  get HiddenToUser(): boolean;
14490
14654
  set HiddenToUser(value: boolean);
@@ -14593,6 +14757,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14593
14757
  * * Schema: __mj
14594
14758
  * * Base Table: Conversation
14595
14759
  * * Base View: vwConversations
14760
+ * * @description Tracks conversation sessions between users and AI agents or between users, including context, participants, and metadata.
14596
14761
  * * Primary Key: ID
14597
14762
  * @extends {BaseEntity}
14598
14763
  * @class
@@ -14631,6 +14796,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14631
14796
  * * Field Name: ExternalID
14632
14797
  * * Display Name: External ID
14633
14798
  * * SQL Data Type: nvarchar(500)
14799
+ * * Description: External system identifier for cross-system conversation tracking.
14634
14800
  */
14635
14801
  get ExternalID(): string | null;
14636
14802
  set ExternalID(value: string | null);
@@ -14653,6 +14819,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14653
14819
  * * Display Name: Type
14654
14820
  * * SQL Data Type: nvarchar(50)
14655
14821
  * * Default Value: Skip
14822
+ * * Description: The type or category of conversation (Skip, Support, Chat, etc.).
14656
14823
  */
14657
14824
  get Type(): string;
14658
14825
  set Type(value: string);
@@ -14661,6 +14828,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14661
14828
  * * Display Name: Is Archived
14662
14829
  * * SQL Data Type: bit
14663
14830
  * * Default Value: 0
14831
+ * * Description: Indicates if this conversation has been archived and should not appear in active lists.
14664
14832
  */
14665
14833
  get IsArchived(): boolean;
14666
14834
  set IsArchived(value: boolean);
@@ -14676,6 +14844,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14676
14844
  * * Field Name: LinkedRecordID
14677
14845
  * * Display Name: Linked Record ID
14678
14846
  * * SQL Data Type: nvarchar(500)
14847
+ * * Description: ID of a related record this conversation is about (support ticket, order, etc.).
14679
14848
  */
14680
14849
  get LinkedRecordID(): string | null;
14681
14850
  set LinkedRecordID(value: string | null);
@@ -14738,6 +14907,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14738
14907
  * * Schema: __mj
14739
14908
  * * Base Table: DashboardCategory
14740
14909
  * * Base View: vwDashboardCategories
14910
+ * * @description Organizes dashboards into logical groupings for navigation and access control, supporting hierarchical categorization.
14741
14911
  * * Primary Key: ID
14742
14912
  * @extends {BaseEntity}
14743
14913
  * @class
@@ -14887,6 +15057,7 @@ export declare class DashboardEntity extends BaseEntity<DashboardEntityType> {
14887
15057
  * * Field Name: UIConfigDetails
14888
15058
  * * Display Name: UIConfig Details
14889
15059
  * * SQL Data Type: nvarchar(MAX)
15060
+ * * Description: JSON configuration defining the dashboard layout, widgets, data sources, and display options.
14890
15061
  */
14891
15062
  get UIConfigDetails(): string;
14892
15063
  set UIConfigDetails(value: string);
@@ -15206,6 +15377,7 @@ export declare class DataContextEntity extends BaseEntity<DataContextEntityType>
15206
15377
  * * Field Name: LastRefreshedAt
15207
15378
  * * Display Name: Last Refreshed At
15208
15379
  * * SQL Data Type: datetime
15380
+ * * Description: Timestamp of when the data in this context was last refreshed or recalculated.
15209
15381
  */
15210
15382
  get LastRefreshedAt(): Date | null;
15211
15383
  set LastRefreshedAt(value: Date | null);
@@ -15266,6 +15438,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15266
15438
  * * Field Name: Code
15267
15439
  * * Display Name: Code
15268
15440
  * * SQL Data Type: nvarchar(50)
15441
+ * * Description: Unique code identifier for this dataset item within its parent dataset.
15269
15442
  */
15270
15443
  get Code(): string;
15271
15444
  set Code(value: string);
@@ -15282,6 +15455,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15282
15455
  * * Display Name: Sequence
15283
15456
  * * SQL Data Type: int
15284
15457
  * * Default Value: 0
15458
+ * * Description: Order in which this item should be processed or displayed within the dataset.
15285
15459
  */
15286
15460
  get Sequence(): number;
15287
15461
  set Sequence(value: number);
@@ -15297,6 +15471,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15297
15471
  * * Field Name: WhereClause
15298
15472
  * * Display Name: Where Clause
15299
15473
  * * SQL Data Type: nvarchar(MAX)
15474
+ * * Description: SQL WHERE clause to filter data when this dataset item is sourced from a query.
15300
15475
  */
15301
15476
  get WhereClause(): string | null;
15302
15477
  set WhereClause(value: string | null);
@@ -15304,6 +15479,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15304
15479
  * * Field Name: DateFieldToCheck
15305
15480
  * * Display Name: Date Field To Check
15306
15481
  * * SQL Data Type: nvarchar(100)
15482
+ * * Description: The date field name used for incremental updates and change detection.
15307
15483
  */
15308
15484
  get DateFieldToCheck(): string;
15309
15485
  set DateFieldToCheck(value: string);
@@ -15415,6 +15591,7 @@ export declare class DatasetEntity extends BaseEntity<DatasetEntityType> {
15415
15591
  * * Schema: __mj
15416
15592
  * * Base Table: DuplicateRunDetailMatch
15417
15593
  * * Base View: vwDuplicateRunDetailMatches
15594
+ * * @description Records individual matching pairs of potentially duplicate records identified during a duplicate detection run with confidence scores.
15418
15595
  * * Primary Key: ID
15419
15596
  * @extends {BaseEntity}
15420
15597
  * @class
@@ -15466,6 +15643,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15466
15643
  * * Field Name: MatchRecordID
15467
15644
  * * Display Name: Match Record ID
15468
15645
  * * SQL Data Type: nvarchar(500)
15646
+ * * Description: The ID of the record identified as a potential duplicate match.
15469
15647
  */
15470
15648
  get MatchRecordID(): string;
15471
15649
  set MatchRecordID(value: string);
@@ -15483,6 +15661,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15483
15661
  * * Display Name: Matched At
15484
15662
  * * SQL Data Type: datetime
15485
15663
  * * Default Value: getdate()
15664
+ * * Description: Timestamp when this duplicate match was identified.
15486
15665
  */
15487
15666
  get MatchedAt(): Date;
15488
15667
  set MatchedAt(value: Date);
@@ -15491,6 +15670,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15491
15670
  * * Display Name: Action
15492
15671
  * * SQL Data Type: nvarchar(20)
15493
15672
  * * Default Value: Ignore
15673
+ * * Description: The action to take for this match (Ignore, Merge, Delete).
15494
15674
  */
15495
15675
  get Action(): string;
15496
15676
  set Action(value: string);
@@ -15504,6 +15684,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15504
15684
  * * Rejected
15505
15685
  * * Approved
15506
15686
  * * Pending
15687
+ * * Description: Current approval status of the proposed action (Pending, Approved, Rejected).
15507
15688
  */
15508
15689
  get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
15509
15690
  set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
@@ -15525,6 +15706,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15525
15706
  * * Error
15526
15707
  * * Complete
15527
15708
  * * Pending
15709
+ * * Description: Status of the merge operation if Action is Merge (Pending, Complete, Failed).
15528
15710
  */
15529
15711
  get MergeStatus(): 'Error' | 'Complete' | 'Pending';
15530
15712
  set MergeStatus(value: 'Error' | 'Complete' | 'Pending');
@@ -15533,6 +15715,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15533
15715
  * * Display Name: Merged At
15534
15716
  * * SQL Data Type: datetime
15535
15717
  * * Default Value: getdate()
15718
+ * * Description: Timestamp when records were merged, if applicable.
15536
15719
  */
15537
15720
  get MergedAt(): Date;
15538
15721
  set MergedAt(value: Date);
@@ -15556,6 +15739,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15556
15739
  * * Schema: __mj
15557
15740
  * * Base Table: DuplicateRunDetail
15558
15741
  * * Base View: vwDuplicateRunDetails
15742
+ * * @description Stores detailed results for each record analyzed in a duplicate detection run, including match status and processing metadata.
15559
15743
  * * Primary Key: ID
15560
15744
  * @extends {BaseEntity}
15561
15745
  * @class
@@ -15594,6 +15778,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15594
15778
  * * Field Name: RecordID
15595
15779
  * * Display Name: Record ID
15596
15780
  * * SQL Data Type: nvarchar(500)
15781
+ * * Description: The ID of the record being analyzed for duplicates.
15597
15782
  */
15598
15783
  get RecordID(): string;
15599
15784
  set RecordID(value: string);
@@ -15608,6 +15793,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15608
15793
  * * Skipped
15609
15794
  * * Complete
15610
15795
  * * Pending
15796
+ * * Description: Status of duplicate analysis for this record (Pending, Complete, Error).
15611
15797
  */
15612
15798
  get MatchStatus(): 'Error' | 'Skipped' | 'Complete' | 'Pending';
15613
15799
  set MatchStatus(value: 'Error' | 'Skipped' | 'Complete' | 'Pending');
@@ -15638,6 +15824,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15638
15824
  * * Complete
15639
15825
  * * Pending
15640
15826
  * * Not Applicable
15827
+ * * Description: Status of any merge operations for this record (Not Applicable, Pending, Complete, Failed).
15641
15828
  */
15642
15829
  get MergeStatus(): 'Error' | 'Complete' | 'Pending' | 'Not Applicable';
15643
15830
  set MergeStatus(value: 'Error' | 'Complete' | 'Pending' | 'Not Applicable');
@@ -15645,6 +15832,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15645
15832
  * * Field Name: MergeErrorMessage
15646
15833
  * * Display Name: Merge Error Message
15647
15834
  * * SQL Data Type: nvarchar(MAX)
15835
+ * * Description: Error details if merge operation failed for this record.
15648
15836
  */
15649
15837
  get MergeErrorMessage(): string | null;
15650
15838
  set MergeErrorMessage(value: string | null);
@@ -15668,6 +15856,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15668
15856
  * * Schema: __mj
15669
15857
  * * Base Table: DuplicateRun
15670
15858
  * * Base View: vwDuplicateRuns
15859
+ * * @description Manages execution of duplicate detection processes across entities, tracking configuration, progress, and summary results.
15671
15860
  * * Primary Key: ID
15672
15861
  * @extends {BaseEntity}
15673
15862
  * @class
@@ -15743,6 +15932,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15743
15932
  * * Rejected
15744
15933
  * * Approved
15745
15934
  * * Pending
15935
+ * * Description: Overall approval status for the duplicate run results (Pending, Approved, Rejected).
15746
15936
  */
15747
15937
  get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
15748
15938
  set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
@@ -15750,6 +15940,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15750
15940
  * * Field Name: ApprovalComments
15751
15941
  * * Display Name: Approval Comments
15752
15942
  * * SQL Data Type: nvarchar(MAX)
15943
+ * * Description: Comments or notes regarding the approval decision for this duplicate run.
15753
15944
  */
15754
15945
  get ApprovalComments(): string | null;
15755
15946
  set ApprovalComments(value: string | null);
@@ -15772,6 +15963,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15772
15963
  * * Complete
15773
15964
  * * In Progress
15774
15965
  * * Pending
15966
+ * * Description: Current processing status of the duplicate detection run (Pending, Running, Complete, Failed).
15775
15967
  */
15776
15968
  get ProcessingStatus(): 'Failed' | 'Complete' | 'In Progress' | 'Pending';
15777
15969
  set ProcessingStatus(value: 'Failed' | 'Complete' | 'In Progress' | 'Pending');
@@ -15779,6 +15971,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15779
15971
  * * Field Name: ProcessingErrorMessage
15780
15972
  * * Display Name: Processing Error Message
15781
15973
  * * SQL Data Type: nvarchar(MAX)
15974
+ * * Description: Error details if the duplicate detection run failed.
15782
15975
  */
15783
15976
  get ProcessingErrorMessage(): string | null;
15784
15977
  set ProcessingErrorMessage(value: string | null);
@@ -15826,6 +16019,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15826
16019
  * * Schema: __mj
15827
16020
  * * Base Table: EmployeeCompanyIntegration
15828
16021
  * * Base View: vwEmployeeCompanyIntegrations
16022
+ * * @description Maps employees to their external identifiers in integrated systems, maintaining synchronization across platforms.
15829
16023
  * * Primary Key: ID
15830
16024
  * @extends {BaseEntity}
15831
16025
  * @class
@@ -15871,6 +16065,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15871
16065
  * * Field Name: ExternalSystemRecordID
15872
16066
  * * Display Name: External System Record
15873
16067
  * * SQL Data Type: nvarchar(750)
16068
+ * * Description: The employee's unique identifier in the external integrated system.
15874
16069
  */
15875
16070
  get ExternalSystemRecordID(): string;
15876
16071
  set ExternalSystemRecordID(value: string);
@@ -15879,6 +16074,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15879
16074
  * * Display Name: Is Active
15880
16075
  * * SQL Data Type: bit
15881
16076
  * * Default Value: 1
16077
+ * * Description: Indicates if this employee integration mapping is currently active.
15882
16078
  */
15883
16079
  get IsActive(): boolean;
15884
16080
  set IsActive(value: boolean);
@@ -15908,6 +16104,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15908
16104
  * * Schema: __mj
15909
16105
  * * Base Table: EmployeeRole
15910
16106
  * * Base View: vwEmployeeRoles
16107
+ * * @description Links employees to their assigned roles within the organization, managing role-based permissions and responsibilities.
15911
16108
  * * Primary Key: ID
15912
16109
  * @extends {BaseEntity}
15913
16110
  * @class
@@ -15976,6 +16173,7 @@ export declare class EmployeeRoleEntity extends BaseEntity<EmployeeRoleEntityTyp
15976
16173
  * * Schema: __mj
15977
16174
  * * Base Table: EmployeeSkill
15978
16175
  * * Base View: vwEmployeeSkills
16176
+ * * @description Tracks skills, competencies, and certifications associated with employees for resource planning and team composition.
15979
16177
  * * Primary Key: ID
15980
16178
  * @extends {BaseEntity}
15981
16179
  * @class
@@ -16075,12 +16273,14 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16075
16273
  * * Display Name: BCMID
16076
16274
  * * SQL Data Type: uniqueidentifier
16077
16275
  * * Default Value: newid()
16276
+ * * Description: Business Central Management ID - unique identifier for cross-system employee tracking.
16078
16277
  */
16079
16278
  get BCMID(): string;
16080
16279
  /**
16081
16280
  * * Field Name: FirstName
16082
16281
  * * Display Name: First Name
16083
16282
  * * SQL Data Type: nvarchar(30)
16283
+ * * Description: Employee's first name or given name.
16084
16284
  */
16085
16285
  get FirstName(): string;
16086
16286
  set FirstName(value: string);
@@ -16088,6 +16288,7 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16088
16288
  * * Field Name: LastName
16089
16289
  * * Display Name: Last Name
16090
16290
  * * SQL Data Type: nvarchar(50)
16291
+ * * Description: Employee's last name or surname.
16091
16292
  */
16092
16293
  get LastName(): string;
16093
16294
  set LastName(value: string);
@@ -16110,18 +16311,21 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16110
16311
  /**
16111
16312
  * * Field Name: Title
16112
16313
  * * SQL Data Type: nvarchar(50)
16314
+ * * Description: Employee's job title or position within the organization.
16113
16315
  */
16114
16316
  get Title(): string | null;
16115
16317
  set Title(value: string | null);
16116
16318
  /**
16117
16319
  * * Field Name: Email
16118
16320
  * * SQL Data Type: nvarchar(100)
16321
+ * * Description: Employee's primary email address, must be unique across the system.
16119
16322
  */
16120
16323
  get Email(): string;
16121
16324
  set Email(value: string);
16122
16325
  /**
16123
16326
  * * Field Name: Phone
16124
16327
  * * SQL Data Type: nvarchar(20)
16328
+ * * Description: Employee's primary phone number for business contact.
16125
16329
  */
16126
16330
  get Phone(): string | null;
16127
16331
  set Phone(value: string | null);
@@ -16129,6 +16333,7 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16129
16333
  * * Field Name: Active
16130
16334
  * * SQL Data Type: bit
16131
16335
  * * Default Value: 1
16336
+ * * Description: Indicates whether the employee is currently active in the organization.
16132
16337
  */
16133
16338
  get Active(): boolean;
16134
16339
  set Active(value: boolean);
@@ -16241,6 +16446,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16241
16446
  * * Field Name: NameSuffix
16242
16447
  * * Display Name: Name Suffix
16243
16448
  * * SQL Data Type: nvarchar(255)
16449
+ * * Description: Optional suffix appended to entity names for display purposes.
16244
16450
  */
16245
16451
  get NameSuffix(): string | null;
16246
16452
  set NameSuffix(value: string | null);
@@ -16263,12 +16469,14 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16263
16469
  * * Field Name: BaseTable
16264
16470
  * * Display Name: Base Table
16265
16471
  * * SQL Data Type: nvarchar(255)
16472
+ * * Description: The underlying database table name for this entity.
16266
16473
  */
16267
16474
  get BaseTable(): string;
16268
16475
  /**
16269
16476
  * * Field Name: BaseView
16270
16477
  * * Display Name: Base View
16271
16478
  * * SQL Data Type: nvarchar(255)
16479
+ * * Description: The "wrapper" database view used for querying this entity with joins and computed fields.
16272
16480
  */
16273
16481
  get BaseView(): string;
16274
16482
  set BaseView(value: string);
@@ -16286,6 +16494,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16286
16494
  * * Display Name: Schema Name
16287
16495
  * * SQL Data Type: nvarchar(255)
16288
16496
  * * Default Value: dbo
16497
+ * * Description: Database schema containing this entity's table and view.
16289
16498
  */
16290
16499
  get SchemaName(): string;
16291
16500
  /**
@@ -16293,6 +16502,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16293
16502
  * * Display Name: Virtual Entity
16294
16503
  * * SQL Data Type: bit
16295
16504
  * * Default Value: 0
16505
+ * * Description: Indicates if this is a virtual entity without a physical database table.
16296
16506
  */
16297
16507
  get VirtualEntity(): boolean;
16298
16508
  set VirtualEntity(value: boolean);
@@ -16391,6 +16601,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16391
16601
  * * Display Name: Full Text Search Enabled
16392
16602
  * * SQL Data Type: bit
16393
16603
  * * Default Value: 0
16604
+ * * Description: Whether full-text search indexing is enabled for this entity.
16394
16605
  */
16395
16606
  get FullTextSearchEnabled(): boolean;
16396
16607
  set FullTextSearchEnabled(value: boolean);
@@ -16398,6 +16609,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16398
16609
  * * Field Name: FullTextCatalog
16399
16610
  * * Display Name: Full Text Catalog
16400
16611
  * * SQL Data Type: nvarchar(255)
16612
+ * * Description: Name of the SQL Server full-text catalog if search is enabled.
16401
16613
  */
16402
16614
  get FullTextCatalog(): string | null;
16403
16615
  set FullTextCatalog(value: string | null);
@@ -16406,6 +16618,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16406
16618
  * * Display Name: Full Text Catalog Generated
16407
16619
  * * SQL Data Type: bit
16408
16620
  * * Default Value: 1
16621
+ * * Description: Indicates if the full-text catalog was auto-generated by CodeGen.
16409
16622
  */
16410
16623
  get FullTextCatalogGenerated(): boolean;
16411
16624
  set FullTextCatalogGenerated(value: boolean);
@@ -16413,6 +16626,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16413
16626
  * * Field Name: FullTextIndex
16414
16627
  * * Display Name: Full Text Index
16415
16628
  * * SQL Data Type: nvarchar(255)
16629
+ * * Description: Name of the full-text index on this entity's table.
16416
16630
  */
16417
16631
  get FullTextIndex(): string | null;
16418
16632
  set FullTextIndex(value: string | null);
@@ -16421,6 +16635,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16421
16635
  * * Display Name: Full Text Index Generated
16422
16636
  * * SQL Data Type: bit
16423
16637
  * * Default Value: 1
16638
+ * * Description: Indicates if the full-text index was auto-generated by CodeGen.
16424
16639
  */
16425
16640
  get FullTextIndexGenerated(): boolean;
16426
16641
  set FullTextIndexGenerated(value: boolean);
@@ -16428,6 +16643,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16428
16643
  * * Field Name: FullTextSearchFunction
16429
16644
  * * Display Name: Full Text Search Function
16430
16645
  * * SQL Data Type: nvarchar(255)
16646
+ * * Description: Name of the function used for full-text searching this entity.
16431
16647
  */
16432
16648
  get FullTextSearchFunction(): string | null;
16433
16649
  set FullTextSearchFunction(value: string | null);
@@ -16436,6 +16652,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16436
16652
  * * Display Name: Full Text Search Function Generated
16437
16653
  * * SQL Data Type: bit
16438
16654
  * * Default Value: 1
16655
+ * * Description: Indicates if the search function was auto-generated by CodeGen.
16439
16656
  */
16440
16657
  get FullTextSearchFunctionGenerated(): boolean;
16441
16658
  set FullTextSearchFunctionGenerated(value: boolean);
@@ -16444,6 +16661,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16444
16661
  * * Display Name: User View Max Rows
16445
16662
  * * SQL Data Type: int
16446
16663
  * * Default Value: 1000
16664
+ * * Description: Maximum number of rows to return in user-created views for this entity.
16447
16665
  */
16448
16666
  get UserViewMaxRows(): number | null;
16449
16667
  set UserViewMaxRows(value: number | null);
@@ -16451,6 +16669,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16451
16669
  * * Field Name: spCreate
16452
16670
  * * Display Name: spCreate
16453
16671
  * * SQL Data Type: nvarchar(255)
16672
+ * * Description: Name of the stored procedure for creating records in this entity.
16454
16673
  */
16455
16674
  get spCreate(): string | null;
16456
16675
  set spCreate(value: string | null);
@@ -16458,6 +16677,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16458
16677
  * * Field Name: spUpdate
16459
16678
  * * Display Name: spUpdate
16460
16679
  * * SQL Data Type: nvarchar(255)
16680
+ * * Description: Name of the stored procedure for updating records in this entity.
16461
16681
  */
16462
16682
  get spUpdate(): string | null;
16463
16683
  set spUpdate(value: string | null);
@@ -16465,6 +16685,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16465
16685
  * * Field Name: spDelete
16466
16686
  * * Display Name: spDelete
16467
16687
  * * SQL Data Type: nvarchar(255)
16688
+ * * Description: Name of the stored procedure for deleting records in this entity.
16468
16689
  */
16469
16690
  get spDelete(): string | null;
16470
16691
  set spDelete(value: string | null);
@@ -16473,6 +16694,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16473
16694
  * * Display Name: sp CreateGenerated
16474
16695
  * * SQL Data Type: bit
16475
16696
  * * Default Value: 1
16697
+ * * Description: Indicates if the create procedure was auto-generated by CodeGen.
16476
16698
  */
16477
16699
  get spCreateGenerated(): boolean;
16478
16700
  set spCreateGenerated(value: boolean);
@@ -16481,6 +16703,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16481
16703
  * * Display Name: sp Update Generated
16482
16704
  * * SQL Data Type: bit
16483
16705
  * * Default Value: 1
16706
+ * * Description: Indicates if the update procedure was auto-generated by CodeGen.
16484
16707
  */
16485
16708
  get spUpdateGenerated(): boolean;
16486
16709
  set spUpdateGenerated(value: boolean);
@@ -16489,6 +16712,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16489
16712
  * * Display Name: sp Delete Generated
16490
16713
  * * SQL Data Type: bit
16491
16714
  * * Default Value: 1
16715
+ * * Description: Indicates if the delete procedure was auto-generated by CodeGen.
16492
16716
  */
16493
16717
  get spDeleteGenerated(): boolean;
16494
16718
  set spDeleteGenerated(value: boolean);
@@ -16549,6 +16773,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16549
16773
  * * Display Name: User Form Generated
16550
16774
  * * SQL Data Type: bit
16551
16775
  * * Default Value: 1
16776
+ * * Description: Indicates if the default user form was auto-generated for this entity.
16552
16777
  */
16553
16778
  get UserFormGenerated(): boolean;
16554
16779
  set UserFormGenerated(value: boolean);
@@ -16556,6 +16781,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16556
16781
  * * Field Name: EntityObjectSubclassName
16557
16782
  * * Display Name: Entity Object Subclass Name
16558
16783
  * * SQL Data Type: nvarchar(255)
16784
+ * * Description: TypeScript class name for the entity subclass in the codebase.
16559
16785
  */
16560
16786
  get EntityObjectSubclassName(): string | null;
16561
16787
  set EntityObjectSubclassName(value: string | null);
@@ -16563,6 +16789,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16563
16789
  * * Field Name: EntityObjectSubclassImport
16564
16790
  * * Display Name: Entity Object Subclass Import
16565
16791
  * * SQL Data Type: nvarchar(255)
16792
+ * * Description: Import path for the entity subclass in the TypeScript codebase.
16566
16793
  */
16567
16794
  get EntityObjectSubclassImport(): string | null;
16568
16795
  set EntityObjectSubclassImport(value: string | null);
@@ -16862,6 +17089,7 @@ export declare class EntityActionInvocationTypeEntity extends BaseEntity<EntityA
16862
17089
  * * Display Name: Display Sequence
16863
17090
  * * SQL Data Type: int
16864
17091
  * * Default Value: 0
17092
+ * * Description: Order in which this invocation type appears in UI lists and menus.
16865
17093
  */
16866
17094
  get DisplaySequence(): number;
16867
17095
  set DisplaySequence(value: number);
@@ -17219,6 +17447,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17219
17447
  * * Field Name: Prompt
17220
17448
  * * Display Name: Prompt
17221
17449
  * * SQL Data Type: nvarchar(MAX)
17450
+ * * Description: The AI prompt template used when this action is triggered by entity changes.
17222
17451
  */
17223
17452
  get Prompt(): string | null;
17224
17453
  set Prompt(value: string | null);
@@ -17231,6 +17460,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17231
17460
  * * Possible Values
17232
17461
  * * after save
17233
17462
  * * before save
17463
+ * * Description: The entity event that triggers this AI action (After Save, Before Delete, etc.).
17234
17464
  */
17235
17465
  get TriggerEvent(): 'after save' | 'before save';
17236
17466
  set TriggerEvent(value: 'after save' | 'before save');
@@ -17238,6 +17468,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17238
17468
  * * Field Name: UserMessage
17239
17469
  * * Display Name: User Message
17240
17470
  * * SQL Data Type: nvarchar(MAX)
17471
+ * * Description: Message shown to users when this AI action is executed.
17241
17472
  */
17242
17473
  get UserMessage(): string;
17243
17474
  set UserMessage(value: string);
@@ -17250,6 +17481,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17250
17481
  * * Possible Values
17251
17482
  * * entity
17252
17483
  * * field
17484
+ * * Description: Where the AI output should be stored (Field, Message, File).
17253
17485
  */
17254
17486
  get OutputType(): 'entity' | 'field';
17255
17487
  set OutputType(value: 'entity' | 'field');
@@ -17257,6 +17489,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17257
17489
  * * Field Name: OutputField
17258
17490
  * * Display Name: Output Field
17259
17491
  * * SQL Data Type: nvarchar(50)
17492
+ * * Description: The field name where AI output should be stored if OutputType is Field.
17260
17493
  */
17261
17494
  get OutputField(): string | null;
17262
17495
  set OutputField(value: string | null);
@@ -17265,6 +17498,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17265
17498
  * * Display Name: Skip If Output Field Not Empty
17266
17499
  * * SQL Data Type: bit
17267
17500
  * * Default Value: 1
17501
+ * * Description: Whether to skip AI processing if the output field already contains data.
17268
17502
  */
17269
17503
  get SkipIfOutputFieldNotEmpty(): boolean;
17270
17504
  set SkipIfOutputFieldNotEmpty(value: boolean);
@@ -17482,6 +17716,7 @@ export declare class EntityCommunicationMessageTypeEntity extends BaseEntity<Ent
17482
17716
  * * Schema: __mj
17483
17717
  * * Base Table: EntityDocumentRun
17484
17718
  * * Base View: vwEntityDocumentRuns
17719
+ * * @description Records execution history of document generation processes for entity records, tracking status, timing, and output details.
17485
17720
  * * Primary Key: ID
17486
17721
  * @extends {BaseEntity}
17487
17722
  * @class
@@ -17570,6 +17805,7 @@ export declare class EntityDocumentRunEntity extends BaseEntity<EntityDocumentRu
17570
17805
  * * Schema: __mj
17571
17806
  * * Base Table: EntityDocumentSetting
17572
17807
  * * Base View: vwEntityDocumentSettings
17808
+ * * @description Stores configuration for entity-specific document generation.
17573
17809
  * * Primary Key: ID
17574
17810
  * @extends {BaseEntity}
17575
17811
  * @class
@@ -17615,6 +17851,7 @@ export declare class EntityDocumentSettingEntity extends BaseEntity<EntityDocume
17615
17851
  * * Field Name: Value
17616
17852
  * * Display Name: Value
17617
17853
  * * SQL Data Type: nvarchar(MAX)
17854
+ * * Description: JSON configuration value for this document generation setting.
17618
17855
  */
17619
17856
  get Value(): string;
17620
17857
  set Value(value: string);
@@ -17651,6 +17888,7 @@ export declare class EntityDocumentSettingEntity extends BaseEntity<EntityDocume
17651
17888
  * * Schema: __mj
17652
17889
  * * Base Table: EntityDocumentType
17653
17890
  * * Base View: vwEntityDocumentTypes
17891
+ * * @description Defines types of documents that can be generated from entity data.
17654
17892
  * * Primary Key: ID
17655
17893
  * @extends {BaseEntity}
17656
17894
  * @class
@@ -17711,6 +17949,7 @@ export declare class EntityDocumentTypeEntity extends BaseEntity<EntityDocumentT
17711
17949
  * * Schema: __mj
17712
17950
  * * Base Table: EntityDocument
17713
17951
  * * Base View: vwEntityDocuments
17952
+ * * @description Stores templates for converting structured entity data into unstructured documents.
17714
17953
  * * Primary Key: ID
17715
17954
  * @extends {BaseEntity}
17716
17955
  * @class
@@ -17879,6 +18118,7 @@ export declare class EntityDocumentEntity extends BaseEntity<EntityDocumentEntit
17879
18118
  * * Schema: __mj
17880
18119
  * * Base Table: EntityFieldValue
17881
18120
  * * Base View: vwEntityFieldValues
18121
+ * * @description Defines allowed values for entity fields with value lists, supporting dropdowns, validations, and data integrity constraints. MJ CodeGen automatically maintains this for columns that have CHECK constraints with IN lists such as "Status IN (A, B, C)"
17882
18122
  * * Primary Key: ID
17883
18123
  * @extends {BaseEntity}
17884
18124
  * @class
@@ -17917,6 +18157,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17917
18157
  * * Field Name: Sequence
17918
18158
  * * Display Name: Sequence
17919
18159
  * * SQL Data Type: int
18160
+ * * Description: Display order for this value in dropdown lists and UI elements.
17920
18161
  */
17921
18162
  get Sequence(): number;
17922
18163
  set Sequence(value: number);
@@ -17924,6 +18165,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17924
18165
  * * Field Name: Value
17925
18166
  * * Display Name: Value
17926
18167
  * * SQL Data Type: nvarchar(255)
18168
+ * * Description: The actual value stored in the database for this option.
17927
18169
  */
17928
18170
  get Value(): string;
17929
18171
  set Value(value: string);
@@ -17931,6 +18173,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17931
18173
  * * Field Name: Code
17932
18174
  * * Display Name: Code
17933
18175
  * * SQL Data Type: nvarchar(50)
18176
+ * * Description: Optional code identifier for this value, useful for programmatic access. If not specified, same as Value
17934
18177
  */
17935
18178
  get Code(): string | null;
17936
18179
  set Code(value: string | null);
@@ -18313,6 +18556,7 @@ export declare class EntityFieldEntity extends BaseEntity<EntityFieldEntityType>
18313
18556
  * * Field Name: RelatedEntityNameFieldMap
18314
18557
  * * Display Name: Related Entity Name Field Map
18315
18558
  * * SQL Data Type: nvarchar(255)
18559
+ * * Description: For foreign key fields, maps which field in the related entity contains the display name. This is used by CodeGen to automatically add in virtual fields for the "Name Field" of the related entity.
18316
18560
  */
18317
18561
  get RelatedEntityNameFieldMap(): string | null;
18318
18562
  set RelatedEntityNameFieldMap(value: string | null);
@@ -18522,6 +18766,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18522
18766
  * * Display Name: Can Create
18523
18767
  * * SQL Data Type: bit
18524
18768
  * * Default Value: 0
18769
+ * * Description: Whether the role/user can create new records in this entity.
18525
18770
  */
18526
18771
  get CanCreate(): boolean;
18527
18772
  set CanCreate(value: boolean);
@@ -18530,6 +18775,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18530
18775
  * * Display Name: Can Read
18531
18776
  * * SQL Data Type: bit
18532
18777
  * * Default Value: 0
18778
+ * * Description: Whether the role/user can read/view records in this entity.
18533
18779
  */
18534
18780
  get CanRead(): boolean;
18535
18781
  set CanRead(value: boolean);
@@ -18538,6 +18784,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18538
18784
  * * Display Name: Can Update
18539
18785
  * * SQL Data Type: bit
18540
18786
  * * Default Value: 0
18787
+ * * Description: Whether the role/user can update existing records in this entity.
18541
18788
  */
18542
18789
  get CanUpdate(): boolean;
18543
18790
  set CanUpdate(value: boolean);
@@ -18546,6 +18793,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18546
18793
  * * Display Name: Can Delete
18547
18794
  * * SQL Data Type: bit
18548
18795
  * * Default Value: 0
18796
+ * * Description: Whether the role/user can delete records from this entity.
18549
18797
  */
18550
18798
  get CanDelete(): boolean;
18551
18799
  set CanDelete(value: boolean);
@@ -18643,6 +18891,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18643
18891
  * * Schema: __mj
18644
18892
  * * Base Table: EntityRecordDocument
18645
18893
  * * Base View: vwEntityRecordDocuments
18894
+ * * @description Stores the output for a given entity record for a specific Entity Document. For example if a "Person" entity had a particular template that outputted First and Last name like "#{{FirstName}}\n#{{LastName}}" the Entity Record Document would have a row for each entity record in the Person entity that was run through that particular document and have row values such as "#Jane\n#Doe" and "#Mark\n#Smith".
18646
18895
  * * Primary Key: ID
18647
18896
  * @extends {BaseEntity}
18648
18897
  * @class
@@ -18681,6 +18930,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18681
18930
  * * Field Name: RecordID
18682
18931
  * * Display Name: Record ID
18683
18932
  * * SQL Data Type: nvarchar(450)
18933
+ * * Description: The ID of the entity record this document was generated for.
18684
18934
  */
18685
18935
  get RecordID(): string;
18686
18936
  set RecordID(value: string);
@@ -18696,6 +18946,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18696
18946
  * * Field Name: DocumentText
18697
18947
  * * Display Name: Document Text
18698
18948
  * * SQL Data Type: nvarchar(MAX)
18949
+ * * Description: The generated document text after template processing.
18699
18950
  */
18700
18951
  get DocumentText(): string | null;
18701
18952
  set DocumentText(value: string | null);
@@ -18711,6 +18962,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18711
18962
  * * Field Name: VectorID
18712
18963
  * * Display Name: Vector ID
18713
18964
  * * SQL Data Type: nvarchar(50)
18965
+ * * Description: Reference to the vector embedding of this document if AI search is enabled.
18714
18966
  */
18715
18967
  get VectorID(): string | null;
18716
18968
  set VectorID(value: string | null);
@@ -18718,6 +18970,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18718
18970
  * * Field Name: VectorJSON
18719
18971
  * * Display Name: Vector JSON
18720
18972
  * * SQL Data Type: nvarchar(MAX)
18973
+ * * Description: JSON representation of the vector embedding for this document.
18721
18974
  */
18722
18975
  get VectorJSON(): string | null;
18723
18976
  set VectorJSON(value: string | null);
@@ -18725,6 +18978,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18725
18978
  * * Field Name: EntityRecordUpdatedAt
18726
18979
  * * Display Name: Entity Record Updated At
18727
18980
  * * SQL Data Type: datetime
18981
+ * * Description: Timestamp of when the source entity record was last updated.
18728
18982
  */
18729
18983
  get EntityRecordUpdatedAt(): Date;
18730
18984
  set EntityRecordUpdatedAt(value: Date);
@@ -18896,6 +19150,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18896
19150
  * * Display Name: Bundle In API
18897
19151
  * * SQL Data Type: bit
18898
19152
  * * Default Value: 1
19153
+ * * Description: Whether to include related records when fetching the parent entity via API.
18899
19154
  */
18900
19155
  get BundleInAPI(): boolean;
18901
19156
  set BundleInAPI(value: boolean);
@@ -18904,6 +19159,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18904
19159
  * * Display Name: Include In Parent All Query
18905
19160
  * * SQL Data Type: bit
18906
19161
  * * Default Value: 0
19162
+ * * Description: Whether to include this relationship when querying all fields of the parent entity.
18907
19163
  */
18908
19164
  get IncludeInParentAllQuery(): boolean;
18909
19165
  set IncludeInParentAllQuery(value: boolean);
@@ -18915,6 +19171,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18915
19171
  * * Possible Values
18916
19172
  * * One To Many
18917
19173
  * * Many To Many
19174
+ * * Description: The cardinality of the relationship (One To Many, Many To Many, One To One).
18918
19175
  */
18919
19176
  get Type(): 'One To Many' | 'Many To Many';
18920
19177
  set Type(value: 'One To Many' | 'Many To Many');
@@ -18922,6 +19179,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18922
19179
  * * Field Name: EntityKeyField
18923
19180
  * * Display Name: Entity Key Field
18924
19181
  * * SQL Data Type: nvarchar(255)
19182
+ * * Description: The primary key field of the parent entity in this relationship.
18925
19183
  */
18926
19184
  get EntityKeyField(): string | null;
18927
19185
  set EntityKeyField(value: string | null);
@@ -18929,6 +19187,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18929
19187
  * * Field Name: RelatedEntityJoinField
18930
19188
  * * Display Name: Related Entity Join Field
18931
19189
  * * SQL Data Type: nvarchar(255)
19190
+ * * Description: The foreign key field in the related entity that references the parent.
18932
19191
  */
18933
19192
  get RelatedEntityJoinField(): string;
18934
19193
  set RelatedEntityJoinField(value: string);
@@ -18936,6 +19195,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18936
19195
  * * Field Name: JoinView
18937
19196
  * * Display Name: Join View
18938
19197
  * * SQL Data Type: nvarchar(255)
19198
+ * * Description: For many-to-many relationships, the view containing the junction data.
18939
19199
  */
18940
19200
  get JoinView(): string | null;
18941
19201
  set JoinView(value: string | null);
@@ -18943,6 +19203,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18943
19203
  * * Field Name: JoinEntityJoinField
18944
19204
  * * Display Name: Join Entity Join Field
18945
19205
  * * SQL Data Type: nvarchar(255)
19206
+ * * Description: For many-to-many, the field in the junction table linking to the parent entity.
18946
19207
  */
18947
19208
  get JoinEntityJoinField(): string | null;
18948
19209
  set JoinEntityJoinField(value: string | null);
@@ -18950,6 +19211,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18950
19211
  * * Field Name: JoinEntityInverseJoinField
18951
19212
  * * Display Name: Join Entity Inverse Join Field
18952
19213
  * * SQL Data Type: nvarchar(255)
19214
+ * * Description: For many-to-many, the field in the junction table linking to the related entity.
18953
19215
  */
18954
19216
  get JoinEntityInverseJoinField(): string | null;
18955
19217
  set JoinEntityInverseJoinField(value: string | null);
@@ -18971,6 +19233,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18971
19233
  * * Possible Values
18972
19234
  * * After Field Tabs
18973
19235
  * * Before Field Tabs
19236
+ * * Description: Where to display this relationship in the UI relative to other entity elements.
18974
19237
  */
18975
19238
  get DisplayLocation(): 'After Field Tabs' | 'Before Field Tabs';
18976
19239
  set DisplayLocation(value: 'After Field Tabs' | 'Before Field Tabs');
@@ -19115,6 +19378,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
19115
19378
  * * Schema: __mj
19116
19379
  * * Base Table: EntitySetting
19117
19380
  * * Base View: vwEntitySettings
19381
+ * * @description Stores entity-specific configuration settings, allowing customization of how entities function.
19118
19382
  * * Primary Key: ID
19119
19383
  * @extends {BaseEntity}
19120
19384
  * @class
@@ -19160,6 +19424,7 @@ export declare class EntitySettingEntity extends BaseEntity<EntitySettingEntityT
19160
19424
  * * Field Name: Value
19161
19425
  * * Display Name: Value
19162
19426
  * * SQL Data Type: nvarchar(MAX)
19427
+ * * Description: The configuration value for this entity setting, often in JSON format.
19163
19428
  */
19164
19429
  get Value(): string;
19165
19430
  set Value(value: string);
@@ -19196,6 +19461,7 @@ export declare class EntitySettingEntity extends BaseEntity<EntitySettingEntityT
19196
19461
  * * Schema: __mj
19197
19462
  * * Base Table: ErrorLog
19198
19463
  * * Base View: vwErrorLogs
19464
+ * * @description Captures system errors, exceptions, and failures with stack traces, context, and debugging info.
19199
19465
  * * Primary Key: ID
19200
19466
  * @extends {BaseEntity}
19201
19467
  * @class
@@ -19240,12 +19506,14 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19240
19506
  /**
19241
19507
  * * Field Name: Code
19242
19508
  * * SQL Data Type: nchar(20)
19509
+ * * Description: Error code for categorizing and handling specific error types.
19243
19510
  */
19244
19511
  get Code(): string | null;
19245
19512
  set Code(value: string | null);
19246
19513
  /**
19247
19514
  * * Field Name: Message
19248
19515
  * * SQL Data Type: nvarchar(MAX)
19516
+ * * Description: The primary error message describing what went wrong.
19249
19517
  */
19250
19518
  get Message(): string | null;
19251
19519
  set Message(value: string | null);
@@ -19254,6 +19522,7 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19254
19522
  * * Display Name: Created By
19255
19523
  * * SQL Data Type: nvarchar(50)
19256
19524
  * * Default Value: suser_name()
19525
+ * * Description: User or system process that encountered this error.
19257
19526
  */
19258
19527
  get CreatedBy(): string | null;
19259
19528
  set CreatedBy(value: string | null);
@@ -19266,12 +19535,14 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19266
19535
  /**
19267
19536
  * * Field Name: Category
19268
19537
  * * SQL Data Type: nvarchar(20)
19538
+ * * Description: High-level category for grouping related errors (Database, API, Validation, etc.).
19269
19539
  */
19270
19540
  get Category(): string | null;
19271
19541
  set Category(value: string | null);
19272
19542
  /**
19273
19543
  * * Field Name: Details
19274
19544
  * * SQL Data Type: nvarchar(MAX)
19545
+ * * Description: Full error details including stack trace, inner exceptions, and context data.
19275
19546
  */
19276
19547
  get Details(): string | null;
19277
19548
  set Details(value: string | null);
@@ -19433,6 +19704,7 @@ export declare class ExplorerNavigationItemEntity extends BaseEntity<ExplorerNav
19433
19704
  * * Schema: __mj
19434
19705
  * * Base Table: FileCategory
19435
19706
  * * Base View: vwFileCategories
19707
+ * * @description Organizes files into categories for classification, access control, and lifecycle management across the file storage system.
19436
19708
  * * Primary Key: ID
19437
19709
  * @extends {BaseEntity}
19438
19710
  * @class
@@ -19507,6 +19779,7 @@ export declare class FileCategoryEntity extends BaseEntity<FileCategoryEntityTyp
19507
19779
  * * Schema: __mj
19508
19780
  * * Base Table: FileEntityRecordLink
19509
19781
  * * Base View: vwFileEntityRecordLinks
19782
+ * * @description Associates files with entity records, enabling attachment management and document relationships throughout the system.
19510
19783
  * * Primary Key: ID
19511
19784
  * @extends {BaseEntity}
19512
19785
  * @class
@@ -19553,6 +19826,7 @@ export declare class FileEntityRecordLinkEntity extends BaseEntity<FileEntityRec
19553
19826
  * * Field Name: RecordID
19554
19827
  * * Display Name: Record ID
19555
19828
  * * SQL Data Type: nvarchar(750)
19829
+ * * Description: The ID of the entity record this file is attached to.
19556
19830
  */
19557
19831
  get RecordID(): string;
19558
19832
  set RecordID(value: string);
@@ -19588,6 +19862,7 @@ export declare class FileEntityRecordLinkEntity extends BaseEntity<FileEntityRec
19588
19862
  * * Schema: __mj
19589
19863
  * * Base Table: FileStorageProvider
19590
19864
  * * Base View: vwFileStorageProviders
19865
+ * * @description Configures connections to file storage systems including local, cloud, and network storage with authentication and access rules.
19591
19866
  * * Primary Key: ID
19592
19867
  * @extends {BaseEntity}
19593
19868
  * @class
@@ -19632,6 +19907,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19632
19907
  * * Field Name: ServerDriverKey
19633
19908
  * * Display Name: Server Driver Key
19634
19909
  * * SQL Data Type: nvarchar(100)
19910
+ * * Description: Identifier for the server-side driver implementation for this storage provider.
19635
19911
  */
19636
19912
  get ServerDriverKey(): string;
19637
19913
  set ServerDriverKey(value: string);
@@ -19639,6 +19915,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19639
19915
  * * Field Name: ClientDriverKey
19640
19916
  * * Display Name: Client Driver Key
19641
19917
  * * SQL Data Type: nvarchar(100)
19918
+ * * Description: Identifier for the client-side driver implementation for this storage provider.
19642
19919
  */
19643
19920
  get ClientDriverKey(): string;
19644
19921
  set ClientDriverKey(value: string);
@@ -19647,6 +19924,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19647
19924
  * * Display Name: Priority
19648
19925
  * * SQL Data Type: int
19649
19926
  * * Default Value: 0
19927
+ * * Description: Priority order for selecting storage providers, lower numbers are preferred.
19650
19928
  */
19651
19929
  get Priority(): number;
19652
19930
  set Priority(value: number);
@@ -19655,6 +19933,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19655
19933
  * * Display Name: Is Active
19656
19934
  * * SQL Data Type: bit
19657
19935
  * * Default Value: 1
19936
+ * * Description: Whether this storage provider is currently available for use.
19658
19937
  */
19659
19938
  get IsActive(): boolean;
19660
19939
  set IsActive(value: boolean);
@@ -19678,6 +19957,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19678
19957
  * * Schema: __mj
19679
19958
  * * Base Table: File
19680
19959
  * * Base View: vwFiles
19960
+ * * @description Manages file metadata, storage locations, and access control for all files stored within or referenced by the system.
19681
19961
  * * Primary Key: ID
19682
19962
  * @extends {BaseEntity}
19683
19963
  * @class
@@ -19738,6 +20018,7 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
19738
20018
  * * Field Name: ContentType
19739
20019
  * * Display Name: Content Type
19740
20020
  * * SQL Data Type: nvarchar(255)
20021
+ * * Description: MIME type of the file content (e.g., image/jpeg, application/pdf).
19741
20022
  */
19742
20023
  get ContentType(): string | null;
19743
20024
  set ContentType(value: string | null);
@@ -19745,6 +20026,7 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
19745
20026
  * * Field Name: ProviderKey
19746
20027
  * * Display Name: Provider Key
19747
20028
  * * SQL Data Type: nvarchar(500)
20029
+ * * Description: Storage provider-specific identifier or path for this file.
19748
20030
  */
19749
20031
  get ProviderKey(): string | null;
19750
20032
  set ProviderKey(value: string | null);
@@ -19963,6 +20245,7 @@ export declare class GeneratedCodeEntity extends BaseEntity<GeneratedCodeEntityT
19963
20245
  * * Field Name: LinkedRecordPrimaryKey
19964
20246
  * * Display Name: Linked Record Primary Key
19965
20247
  * * SQL Data Type: nvarchar(MAX)
20248
+ * * Description: JSON containing the primary key(s) of the record this generated code is associated with.
19966
20249
  */
19967
20250
  get LinkedRecordPrimaryKey(): string | null;
19968
20251
  set LinkedRecordPrimaryKey(value: string | null);
@@ -20165,6 +20448,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20165
20448
  * * Field Name: NavigationBaseURL
20166
20449
  * * Display Name: Navigation Base URL
20167
20450
  * * SQL Data Type: nvarchar(500)
20451
+ * * Description: Base URL for navigating to records in the external system from MemberJunction.
20168
20452
  */
20169
20453
  get NavigationBaseURL(): string | null;
20170
20454
  set NavigationBaseURL(value: string | null);
@@ -20172,6 +20456,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20172
20456
  * * Field Name: ClassName
20173
20457
  * * Display Name: Class Name
20174
20458
  * * SQL Data Type: nvarchar(100)
20459
+ * * Description: The TypeScript/JavaScript class name implementing this integration.
20175
20460
  */
20176
20461
  get ClassName(): string | null;
20177
20462
  set ClassName(value: string | null);
@@ -20179,6 +20464,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20179
20464
  * * Field Name: ImportPath
20180
20465
  * * Display Name: Import Path
20181
20466
  * * SQL Data Type: nvarchar(100)
20467
+ * * Description: Module import path for the integration class in the codebase.
20182
20468
  */
20183
20469
  get ImportPath(): string | null;
20184
20470
  set ImportPath(value: string | null);
@@ -20187,6 +20473,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20187
20473
  * * Display Name: Batch Max Request Count
20188
20474
  * * SQL Data Type: int
20189
20475
  * * Default Value: -1
20476
+ * * Description: Maximum number of API requests to batch together, -1 for no limit.
20190
20477
  */
20191
20478
  get BatchMaxRequestCount(): number;
20192
20479
  set BatchMaxRequestCount(value: number);
@@ -20195,6 +20482,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20195
20482
  * * Display Name: Batch Request Wait Time
20196
20483
  * * SQL Data Type: int
20197
20484
  * * Default Value: -1
20485
+ * * Description: Milliseconds to wait before sending a batch of requests, -1 to disable batching.
20198
20486
  */
20199
20487
  get BatchRequestWaitTime(): number;
20200
20488
  set BatchRequestWaitTime(value: number);
@@ -20400,6 +20688,7 @@ export declare class LibraryItemEntity extends BaseEntity<LibraryItemEntityType>
20400
20688
  * * Schema: __mj
20401
20689
  * * Base Table: ListCategory
20402
20690
  * * Base View: vwListCategories
20691
+ * * @description Groups lists into categories for organization and navigation, supporting hierarchical categorization of user-created lists.
20403
20692
  * * Primary Key: ID
20404
20693
  * @extends {BaseEntity}
20405
20694
  * @class
@@ -20526,6 +20815,7 @@ export declare class ListDetailEntity extends BaseEntity<ListDetailEntityType> {
20526
20815
  * * Field Name: RecordID
20527
20816
  * * Display Name: Record
20528
20817
  * * SQL Data Type: nvarchar(445)
20818
+ * * Description: The ID of the record included in this list.
20529
20819
  */
20530
20820
  get RecordID(): string;
20531
20821
  set RecordID(value: string);
@@ -20533,6 +20823,7 @@ export declare class ListDetailEntity extends BaseEntity<ListDetailEntityType> {
20533
20823
  * * Field Name: Sequence
20534
20824
  * * SQL Data Type: int
20535
20825
  * * Default Value: 0
20826
+ * * Description: Order of this record within the list, for maintaining user-defined sorting.
20536
20827
  */
20537
20828
  get Sequence(): number;
20538
20829
  set Sequence(value: number);
@@ -20654,6 +20945,7 @@ export declare class ListEntity extends BaseEntity<ListEntityType> {
20654
20945
  * * Field Name: ExternalSystemRecordID
20655
20946
  * * Display Name: External System Record ID
20656
20947
  * * SQL Data Type: nvarchar(100)
20948
+ * * Description: Identifier for this list in an external system, used for synchronization.
20657
20949
  */
20658
20950
  get ExternalSystemRecordID(): string | null;
20659
20951
  set ExternalSystemRecordID(value: string | null);
@@ -20894,27 +21186,27 @@ export declare class AIAgentRunStepEntity extends BaseEntity<AIAgentRunStepEntit
20894
21186
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
20895
21187
  /**
20896
21188
  * 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:
20897
- * * StepNumber: This rule ensures that the step number must always be greater than zero.
20898
21189
  * * FinalPayloadValidationResult: This rule ensures that the FinalPayloadValidationResult field is either left blank or is set to one of the following values: 'Warn', 'Fail', 'Retry', or 'Pass'. No other values are allowed.
21190
+ * * StepNumber: This rule ensures that the step number must always be greater than zero.
20899
21191
  * @public
20900
21192
  * @method
20901
21193
  * @override
20902
21194
  */
20903
21195
  Validate(): ValidationResult;
20904
21196
  /**
20905
- * This rule ensures that the step number must always be greater than zero.
21197
+ * This rule ensures that the FinalPayloadValidationResult field is either left blank or is set to one of the following values: 'Warn', 'Fail', 'Retry', or 'Pass'. No other values are allowed.
20906
21198
  * @param result - the ValidationResult object to add any errors or warnings to
20907
21199
  * @public
20908
21200
  * @method
20909
21201
  */
20910
- ValidateStepNumberGreaterThanZero(result: ValidationResult): void;
21202
+ ValidateFinalPayloadValidationResultAllowedValues(result: ValidationResult): void;
20911
21203
  /**
20912
- * This rule ensures that the FinalPayloadValidationResult field is either left blank or is set to one of the following values: 'Warn', 'Fail', 'Retry', or 'Pass'. No other values are allowed.
21204
+ * This rule ensures that the step number must always be greater than zero.
20913
21205
  * @param result - the ValidationResult object to add any errors or warnings to
20914
21206
  * @public
20915
21207
  * @method
20916
21208
  */
20917
- ValidateFinalPayloadValidationResultAllowedValues(result: ValidationResult): void;
21209
+ ValidateStepNumberGreaterThanZero(result: ValidationResult): void;
20918
21210
  /**
20919
21211
  * * Field Name: ID
20920
21212
  * * Display Name: ID
@@ -22062,27 +22354,27 @@ export declare class AIModelPriceUnitTypeEntity extends BaseEntity<AIModelPriceU
22062
22354
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
22063
22355
  /**
22064
22356
  * Validate() method override for MJ: AI Model Price Unit Types entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
22065
- * * Name: This rule ensures that the Name field cannot be empty or contain only spaces; it must have at least one non-space character.
22066
22357
  * * DriverClass: This rule ensures that the DriverClass field cannot be empty or consist only of spaces. The value must contain at least one character when leading and trailing spaces are ignored.
22358
+ * * Name: This rule ensures that the Name field cannot be empty or contain only spaces; it must have at least one non-space character.
22067
22359
  * @public
22068
22360
  * @method
22069
22361
  * @override
22070
22362
  */
22071
22363
  Validate(): ValidationResult;
22072
22364
  /**
22073
- * This rule ensures that the Name field cannot be empty or contain only spaces; it must have at least one non-space character.
22365
+ * This rule ensures that the DriverClass field cannot be empty or consist only of spaces. The value must contain at least one character when leading and trailing spaces are ignored.
22074
22366
  * @param result - the ValidationResult object to add any errors or warnings to
22075
22367
  * @public
22076
22368
  * @method
22077
22369
  */
22078
- ValidateNameNotEmptyOrWhitespace(result: ValidationResult): void;
22370
+ ValidateDriverClassNotEmpty(result: ValidationResult): void;
22079
22371
  /**
22080
- * This rule ensures that the DriverClass field cannot be empty or consist only of spaces. The value must contain at least one character when leading and trailing spaces are ignored.
22372
+ * This rule ensures that the Name field cannot be empty or contain only spaces; it must have at least one non-space character.
22081
22373
  * @param result - the ValidationResult object to add any errors or warnings to
22082
22374
  * @public
22083
22375
  * @method
22084
22376
  */
22085
- ValidateDriverClassNotEmpty(result: ValidationResult): void;
22377
+ ValidateNameNotEmptyOrWhitespace(result: ValidationResult): void;
22086
22378
  /**
22087
22379
  * * Field Name: ID
22088
22380
  * * Display Name: ID
@@ -22156,35 +22448,35 @@ export declare class AIModelVendorEntity extends BaseEntity<AIModelVendorEntityT
22156
22448
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
22157
22449
  /**
22158
22450
  * Validate() method override for MJ: AI Model Vendors entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
22159
- * * Priority: This rule ensures that the Priority value cannot be negative. It must be zero or greater.
22160
22451
  * * MaxInputTokens: This rule ensures that if the MaxInputTokens field is specified, it must be zero or a positive number. It cannot be negative.
22161
22452
  * * MaxOutputTokens: This rule ensures that the maximum output tokens value must be zero or higher. If no value is provided, that's also acceptable.
22453
+ * * Priority: This rule ensures that the Priority value cannot be negative. It must be zero or greater.
22162
22454
  * @public
22163
22455
  * @method
22164
22456
  * @override
22165
22457
  */
22166
22458
  Validate(): ValidationResult;
22167
22459
  /**
22168
- * This rule ensures that the Priority value cannot be negative. It must be zero or greater.
22460
+ * This rule ensures that if the MaxInputTokens field is specified, it must be zero or a positive number. It cannot be negative.
22169
22461
  * @param result - the ValidationResult object to add any errors or warnings to
22170
22462
  * @public
22171
22463
  * @method
22172
22464
  */
22173
- ValidatePriorityIsNonNegative(result: ValidationResult): void;
22465
+ ValidateMaxInputTokensNonNegative(result: ValidationResult): void;
22174
22466
  /**
22175
- * This rule ensures that if the MaxInputTokens field is specified, it must be zero or a positive number. It cannot be negative.
22467
+ * This rule ensures that the maximum output tokens value must be zero or higher. If no value is provided, that's also acceptable.
22176
22468
  * @param result - the ValidationResult object to add any errors or warnings to
22177
22469
  * @public
22178
22470
  * @method
22179
22471
  */
22180
- ValidateMaxInputTokensNonNegative(result: ValidationResult): void;
22472
+ ValidateMaxOutputTokensNotNegative(result: ValidationResult): void;
22181
22473
  /**
22182
- * This rule ensures that the maximum output tokens value must be zero or higher. If no value is provided, that's also acceptable.
22474
+ * This rule ensures that the Priority value cannot be negative. It must be zero or greater.
22183
22475
  * @param result - the ValidationResult object to add any errors or warnings to
22184
22476
  * @public
22185
22477
  * @method
22186
22478
  */
22187
- ValidateMaxOutputTokensNotNegative(result: ValidationResult): void;
22479
+ ValidatePriorityIsNonNegative(result: ValidationResult): void;
22188
22480
  /**
22189
22481
  * * Field Name: ID
22190
22482
  * * Display Name: ID
@@ -22368,9 +22660,9 @@ export declare class AIPromptModelEntity extends BaseEntity<AIPromptModelEntityT
22368
22660
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
22369
22661
  /**
22370
22662
  * Validate() method override for MJ: AI Prompt Models entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
22371
- * * Priority: This rule ensures that the Priority value must be greater than or equal to zero. Negative priorities are not allowed.
22372
22663
  * * ExecutionGroup: This rule ensures that the ExecutionGroup value must be zero or a positive number. Negative numbers are not allowed.
22373
22664
  * * ParallelCount: This rule ensures that the number of parallel tasks (ParallelCount) must be at least 1. It cannot be zero or negative.
22665
+ * * Priority: This rule ensures that the Priority value must be greater than or equal to zero. Negative priorities are not allowed.
22374
22666
  * * Table-Level: This rule ensures that if the parallelization mode is 'None' or 'StaticCount', then the parallel config parameter must be empty. If the parallelization mode is 'ConfigParam', then the parallel config parameter must be provided.
22375
22667
  * @public
22376
22668
  * @method
@@ -22378,26 +22670,26 @@ export declare class AIPromptModelEntity extends BaseEntity<AIPromptModelEntityT
22378
22670
  */
22379
22671
  Validate(): ValidationResult;
22380
22672
  /**
22381
- * This rule ensures that the Priority value must be greater than or equal to zero. Negative priorities are not allowed.
22673
+ * This rule ensures that the ExecutionGroup value must be zero or a positive number. Negative numbers are not allowed.
22382
22674
  * @param result - the ValidationResult object to add any errors or warnings to
22383
22675
  * @public
22384
22676
  * @method
22385
22677
  */
22386
- ValidatePriorityIsNonNegative(result: ValidationResult): void;
22678
+ ValidateExecutionGroupIsNonNegative(result: ValidationResult): void;
22387
22679
  /**
22388
- * This rule ensures that the ExecutionGroup value must be zero or a positive number. Negative numbers are not allowed.
22680
+ * This rule ensures that the number of parallel tasks (ParallelCount) must be at least 1. It cannot be zero or negative.
22389
22681
  * @param result - the ValidationResult object to add any errors or warnings to
22390
22682
  * @public
22391
22683
  * @method
22392
22684
  */
22393
- ValidateExecutionGroupIsNonNegative(result: ValidationResult): void;
22685
+ ValidateParallelCountAtLeastOne(result: ValidationResult): void;
22394
22686
  /**
22395
- * This rule ensures that the number of parallel tasks (ParallelCount) must be at least 1. It cannot be zero or negative.
22687
+ * This rule ensures that the Priority value must be greater than or equal to zero. Negative priorities are not allowed.
22396
22688
  * @param result - the ValidationResult object to add any errors or warnings to
22397
22689
  * @public
22398
22690
  * @method
22399
22691
  */
22400
- ValidateParallelCountAtLeastOne(result: ValidationResult): void;
22692
+ ValidatePriorityIsNonNegative(result: ValidationResult): void;
22401
22693
  /**
22402
22694
  * This rule ensures that if the parallelization mode is 'None' or 'StaticCount', then the parallel config parameter must be empty. If the parallelization mode is 'ConfigParam', then the parallel config parameter must be provided.
22403
22695
  * @param result - the ValidationResult object to add any errors or warnings to
@@ -22586,27 +22878,27 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
22586
22878
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
22587
22879
  /**
22588
22880
  * 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:
22589
- * * Table-Level: This rule ensures that either both TokensPrompt and TokensCompletion are missing, or TokensUsed is missing, or, if all values are present, the value of TokensUsed equals the sum of TokensPrompt and TokensCompletion.
22590
22881
  * * Table-Level: This rule ensures that if the 'CompletedAt' field has a value, it must be on or after the 'RunAt' field. Otherwise, if 'CompletedAt' is empty, there is no restriction.
22882
+ * * Table-Level: This rule ensures that either both TokensPrompt and TokensCompletion are missing, or TokensUsed is missing, or, if all values are present, the value of TokensUsed equals the sum of TokensPrompt and TokensCompletion.
22591
22883
  * @public
22592
22884
  * @method
22593
22885
  * @override
22594
22886
  */
22595
22887
  Validate(): ValidationResult;
22596
22888
  /**
22597
- * This rule ensures that either both TokensPrompt and TokensCompletion are missing, or TokensUsed is missing, or, if all values are present, the value of TokensUsed equals the sum of TokensPrompt and TokensCompletion.
22889
+ * This rule ensures that if the 'CompletedAt' field has a value, it must be on or after the 'RunAt' field. Otherwise, if 'CompletedAt' is empty, there is no restriction.
22598
22890
  * @param result - the ValidationResult object to add any errors or warnings to
22599
22891
  * @public
22600
22892
  * @method
22601
22893
  */
22602
- ValidateTokensUsedSumMatchesPromptAndCompletion(result: ValidationResult): void;
22894
+ ValidateCompletedAtIsNullOrAfterRunAt(result: ValidationResult): void;
22603
22895
  /**
22604
- * This rule ensures that if the 'CompletedAt' field has a value, it must be on or after the 'RunAt' field. Otherwise, if 'CompletedAt' is empty, there is no restriction.
22896
+ * This rule ensures that either both TokensPrompt and TokensCompletion are missing, or TokensUsed is missing, or, if all values are present, the value of TokensUsed equals the sum of TokensPrompt and TokensCompletion.
22605
22897
  * @param result - the ValidationResult object to add any errors or warnings to
22606
22898
  * @public
22607
22899
  * @method
22608
22900
  */
22609
- ValidateCompletedAtIsNullOrAfterRunAt(result: ValidationResult): void;
22901
+ ValidateTokensUsedSumMatchesPromptAndCompletion(result: ValidationResult): void;
22610
22902
  /**
22611
22903
  * * Field Name: ID
22612
22904
  * * Display Name: ID
@@ -23104,6 +23396,15 @@ export declare class AIPromptRunEntity extends BaseEntity<AIPromptRunEntityType>
23104
23396
  get TotalFailoverDuration(): number | null;
23105
23397
  set TotalFailoverDuration(value: number | null);
23106
23398
  /**
23399
+ * * Field Name: RerunFromPromptRunID
23400
+ * * Display Name: Rerun From Prompt Run ID
23401
+ * * SQL Data Type: uniqueidentifier
23402
+ * * Related Entity/Foreign Key: MJ: AI Prompt Runs (vwAIPromptRuns.ID)
23403
+ * * Description: If this run was initiated as a re-run of another prompt run, this field links back to the original run ID
23404
+ */
23405
+ get RerunFromPromptRunID(): string | null;
23406
+ set RerunFromPromptRunID(value: string | null);
23407
+ /**
23107
23408
  * * Field Name: Prompt
23108
23409
  * * Display Name: Prompt
23109
23410
  * * SQL Data Type: nvarchar(255)
@@ -23977,6 +24278,152 @@ export declare class DashboardUserStateEntity extends BaseEntity<DashboardUserSt
23977
24278
  */
23978
24279
  get User(): string;
23979
24280
  }
24281
+ /**
24282
+ * MJ: Query Parameters - strongly typed entity sub-class
24283
+ * * Schema: __mj
24284
+ * * Base Table: QueryParameter
24285
+ * * Base View: vwQueryParameters
24286
+ * * @description Stores parameter definitions for parameterized queries that use Nunjucks templates. Each parameter represents a dynamic value that can be passed when executing the query. Parameters are automatically extracted from the query template by the QueryEntityServer using LLM analysis, or can be manually defined. The combination of parameter metadata and validation filters creates a self-documenting, type-safe query execution system.
24287
+ * * Primary Key: ID
24288
+ * @extends {BaseEntity}
24289
+ * @class
24290
+ * @public
24291
+ */
24292
+ export declare class QueryParameterEntity extends BaseEntity<QueryParameterEntityType> {
24293
+ /**
24294
+ * Loads the MJ: Query Parameters record from the database
24295
+ * @param ID: string - primary key value to load the MJ: Query Parameters record.
24296
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
24297
+ * @returns {Promise<boolean>} - true if successful, false otherwise
24298
+ * @public
24299
+ * @async
24300
+ * @memberof QueryParameterEntity
24301
+ * @method
24302
+ * @override
24303
+ */
24304
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
24305
+ /**
24306
+ * * Field Name: ID
24307
+ * * Display Name: ID
24308
+ * * SQL Data Type: uniqueidentifier
24309
+ * * Default Value: newsequentialid()
24310
+ */
24311
+ get ID(): string;
24312
+ set ID(value: string);
24313
+ /**
24314
+ * * Field Name: QueryID
24315
+ * * Display Name: Query ID
24316
+ * * SQL Data Type: uniqueidentifier
24317
+ * * Related Entity/Foreign Key: Queries (vwQueries.ID)
24318
+ */
24319
+ get QueryID(): string;
24320
+ set QueryID(value: string);
24321
+ /**
24322
+ * * Field Name: Name
24323
+ * * Display Name: Name
24324
+ * * SQL Data Type: nvarchar(255)
24325
+ * * Description: The name of the parameter as it appears in the Nunjucks template. This must match exactly with the parameter reference in the SQL template. For example, if the template contains {{ userEmail | required | email }}, the Name would be "userEmail". Parameter names should follow JavaScript identifier rules: start with a letter, and contain only letters, numbers, and underscores.
24326
+ */
24327
+ get Name(): string;
24328
+ set Name(value: string);
24329
+ /**
24330
+ * * Field Name: Type
24331
+ * * Display Name: Type
24332
+ * * SQL Data Type: nvarchar(50)
24333
+ * * Value List Type: List
24334
+ * * Possible Values
24335
+ * * string
24336
+ * * number
24337
+ * * date
24338
+ * * boolean
24339
+ * * array
24340
+ * * Description: The data type of the parameter used for validation and type conversion. Valid values are: "string" for text values, "number" for integers or decimals, "date" for date/datetime values (ISO 8601 format expected), "boolean" for true/false values, and "array" for multiple values (typically used with IN clauses). The type determines which validation filters can be applied and how the parameter is processed.
24341
+ */
24342
+ get Type(): 'string' | 'number' | 'date' | 'boolean' | 'array';
24343
+ set Type(value: 'string' | 'number' | 'date' | 'boolean' | 'array');
24344
+ /**
24345
+ * * Field Name: IsRequired
24346
+ * * Display Name: Is Required
24347
+ * * SQL Data Type: bit
24348
+ * * Default Value: 0
24349
+ * * Description: Indicates whether this parameter must be provided when executing the query. When true, the query execution will fail if the parameter is not supplied and no DefaultValue is set. This is automatically determined by the presence of the "required" filter in the template, but can be manually overridden. Required parameters ensure data integrity and prevent unintended query behavior.
24350
+ */
24351
+ get IsRequired(): boolean | null;
24352
+ set IsRequired(value: boolean | null);
24353
+ /**
24354
+ * * Field Name: DefaultValue
24355
+ * * Display Name: Default Value
24356
+ * * SQL Data Type: nvarchar(MAX)
24357
+ * * Description: The default value to use when the parameter is not provided during query execution. This value must be compatible with the parameter Type. For arrays, use JSON format like ["value1","value2"]. Default values allow queries to have sensible fallbacks while still accepting custom inputs. If a parameter is required (IsRequired=true), the default value is ignored.
24358
+ */
24359
+ get DefaultValue(): string | null;
24360
+ set DefaultValue(value: string | null);
24361
+ /**
24362
+ * * Field Name: Description
24363
+ * * Display Name: Description
24364
+ * * SQL Data Type: nvarchar(MAX)
24365
+ * * Description: Human-readable description explaining the purpose and usage of this parameter. This is typically generated by LLM analysis of the query context but can be manually edited. Good descriptions include: what the parameter filters or controls, valid value ranges or formats, business meaning, and any special considerations. This text is shown in UI to help users understand what value to provide.
24366
+ */
24367
+ get Description(): string | null;
24368
+ set Description(value: string | null);
24369
+ /**
24370
+ * * Field Name: SampleValue
24371
+ * * Display Name: Sample Value
24372
+ * * SQL Data Type: nvarchar(MAX)
24373
+ * * Description: A concrete example value demonstrating the proper format for this parameter. Generated by LLM based on the query context and validation filters. For example: "john@example.com" for an email parameter, "2024-01-15" for a date, or "["active","pending"]" for a status array. Sample values help users understand the expected format and can be used in API documentation.
24374
+ */
24375
+ get SampleValue(): string | null;
24376
+ set SampleValue(value: string | null);
24377
+ /**
24378
+ * * Field Name: ValidationFilters
24379
+ * * Display Name: Validation Filters
24380
+ * * SQL Data Type: nvarchar(MAX)
24381
+ * * Description: JSON array of Nunjucks filter definitions that validate and transform the parameter value. Each filter is an object with "name" and optional "args" properties. Filters are applied in order and can include: validation (required, email, min, max), transformation (trim, upper, lower), SQL safety (sqlsafe, sqljoin), and type conversion (number, date). Example: [{"name":"required"},{"name":"email"},{"name":"sqlsafe"}]. The filter chain ensures type safety and prevents SQL injection.
24382
+ */
24383
+ get ValidationFilters(): string | null;
24384
+ set ValidationFilters(value: string | null);
24385
+ /**
24386
+ * * Field Name: DetectionMethod
24387
+ * * Display Name: Detection Method
24388
+ * * SQL Data Type: nvarchar(50)
24389
+ * * Default Value: Manual
24390
+ * * Value List Type: List
24391
+ * * Possible Values
24392
+ * * AI
24393
+ * * Manual
24394
+ * * Description: Indicates how this parameter was identified and added to the system. "AI" means it was automatically detected by LLM analysis of the query template, including extraction of parameter name, type inference from filters, and generation of description. "Manual" means it was explicitly defined by a user. This helps track which parameters might need human review and provides transparency about the source of metadata.
24395
+ */
24396
+ get DetectionMethod(): 'AI' | 'Manual';
24397
+ set DetectionMethod(value: 'AI' | 'Manual');
24398
+ /**
24399
+ * * Field Name: AutoDetectConfidenceScore
24400
+ * * Display Name: Auto Detect Confidence Score
24401
+ * * SQL Data Type: decimal(3, 2)
24402
+ * * Description: Confidence score (0.00-1.00) indicating how certain the AI was about this parameter detection. Only populated when DetectionMethod="AI". Higher scores indicate the LLM was more confident about the parameter name, type, and usage. Scores above 0.80 are generally reliable, 0.60-0.80 may benefit from human review, and below 0.60 should be manually verified. This helps prioritize which auto-detected parameters need human attention.
24403
+ */
24404
+ get AutoDetectConfidenceScore(): number | null;
24405
+ set AutoDetectConfidenceScore(value: number | null);
24406
+ /**
24407
+ * * Field Name: __mj_CreatedAt
24408
+ * * Display Name: Created At
24409
+ * * SQL Data Type: datetimeoffset
24410
+ * * Default Value: getutcdate()
24411
+ */
24412
+ get __mj_CreatedAt(): Date;
24413
+ /**
24414
+ * * Field Name: __mj_UpdatedAt
24415
+ * * Display Name: Updated At
24416
+ * * SQL Data Type: datetimeoffset
24417
+ * * Default Value: getutcdate()
24418
+ */
24419
+ get __mj_UpdatedAt(): Date;
24420
+ /**
24421
+ * * Field Name: Query
24422
+ * * Display Name: Query
24423
+ * * SQL Data Type: nvarchar(255)
24424
+ */
24425
+ get Query(): string;
24426
+ }
23980
24427
  /**
23981
24428
  * MJ: Report User States - strongly typed entity sub-class
23982
24429
  * * Schema: __mj
@@ -24182,10 +24629,12 @@ export declare class ReportVersionEntity extends BaseEntity<ReportVersionEntityT
24182
24629
  * * Schema: __mj
24183
24630
  * * Base Table: OutputDeliveryType
24184
24631
  * * Base View: vwOutputDeliveryTypes
24632
+ * * @description Defines methods for delivering generated outputs such as email, file storage, API endpoints, or messaging platforms.
24185
24633
  * * Primary Key: ID
24186
24634
  * @extends {BaseEntity}
24187
24635
  * @class
24188
24636
  * @public
24637
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24189
24638
  */
24190
24639
  export declare class OutputDeliveryTypeEntity extends BaseEntity<OutputDeliveryTypeEntityType> {
24191
24640
  /**
@@ -24242,10 +24691,12 @@ export declare class OutputDeliveryTypeEntity extends BaseEntity<OutputDeliveryT
24242
24691
  * * Schema: __mj
24243
24692
  * * Base Table: OutputFormatType
24244
24693
  * * Base View: vwOutputFormatTypes
24694
+ * * @description Specifies available output formats for generated content including PDF, Excel, CSV, JSON, and custom formats.
24245
24695
  * * Primary Key: ID
24246
24696
  * @extends {BaseEntity}
24247
24697
  * @class
24248
24698
  * @public
24699
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24249
24700
  */
24250
24701
  export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeEntityType> {
24251
24702
  /**
@@ -24286,6 +24737,7 @@ export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeE
24286
24737
  * * Field Name: DisplayFormat
24287
24738
  * * Display Name: Display Format
24288
24739
  * * SQL Data Type: nvarchar(MAX)
24740
+ * * Description: Configuration or template for how data should be formatted in this output type.
24289
24741
  */
24290
24742
  get DisplayFormat(): string | null;
24291
24743
  set DisplayFormat(value: string | null);
@@ -24309,10 +24761,12 @@ export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeE
24309
24761
  * * Schema: __mj
24310
24762
  * * Base Table: OutputTriggerType
24311
24763
  * * Base View: vwOutputTriggerTypes
24764
+ * * @description Defines events that can trigger output generation such as schedules, data changes, or manual requests.
24312
24765
  * * Primary Key: ID
24313
24766
  * @extends {BaseEntity}
24314
24767
  * @class
24315
24768
  * @public
24769
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24316
24770
  */
24317
24771
  export declare class OutputTriggerTypeEntity extends BaseEntity<OutputTriggerTypeEntityType> {
24318
24772
  /**
@@ -24415,6 +24869,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24415
24869
  * * Field Name: UserQuestion
24416
24870
  * * Display Name: User Question
24417
24871
  * * SQL Data Type: nvarchar(MAX)
24872
+ * * Description: The natural language question this query answers, used for AI query selection.
24418
24873
  */
24419
24874
  get UserQuestion(): string | null;
24420
24875
  set UserQuestion(value: string | null);
@@ -24429,6 +24884,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24429
24884
  * * Field Name: SQL
24430
24885
  * * Display Name: SQL
24431
24886
  * * SQL Data Type: nvarchar(MAX)
24887
+ * * Description: The actual SQL query text to execute, may include parameters.
24432
24888
  */
24433
24889
  get SQL(): string | null;
24434
24890
  set SQL(value: string | null);
@@ -24436,6 +24892,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24436
24892
  * * Field Name: TechnicalDescription
24437
24893
  * * Display Name: Technical Description
24438
24894
  * * SQL Data Type: nvarchar(MAX)
24895
+ * * Description: Technical documentation of the query logic, performance considerations, and parameter usage.
24439
24896
  */
24440
24897
  get TechnicalDescription(): string | null;
24441
24898
  set TechnicalDescription(value: string | null);
@@ -24443,6 +24900,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24443
24900
  * * Field Name: OriginalSQL
24444
24901
  * * Display Name: Original SQL
24445
24902
  * * SQL Data Type: nvarchar(MAX)
24903
+ * * Description: The original SQL before any optimization or modification, kept for reference.
24446
24904
  */
24447
24905
  get OriginalSQL(): string | null;
24448
24906
  set OriginalSQL(value: string | null);
@@ -24450,6 +24908,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24450
24908
  * * Field Name: Feedback
24451
24909
  * * Display Name: Feedback
24452
24910
  * * SQL Data Type: nvarchar(MAX)
24911
+ * * Description: User feedback on query accuracy, performance, or suggested improvements.
24453
24912
  */
24454
24913
  get Feedback(): string | null;
24455
24914
  set Feedback(value: string | null);
@@ -24499,6 +24958,15 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24499
24958
  */
24500
24959
  get __mj_UpdatedAt(): Date;
24501
24960
  /**
24961
+ * * Field Name: UsesTemplate
24962
+ * * Display Name: Uses Template
24963
+ * * SQL Data Type: bit
24964
+ * * Default Value: 0
24965
+ * * Description: Automatically set to true when the SQL column contains Nunjucks template markers (e.g., {{ paramName }}). This flag is maintained by the QueryEntityServer for performance optimization and discovery purposes. It allows quick filtering of parameterized queries and enables the UI to show parameter inputs only when needed. The system will automatically update this flag when the SQL content changes.
24966
+ */
24967
+ get UsesTemplate(): boolean | null;
24968
+ set UsesTemplate(value: boolean | null);
24969
+ /**
24502
24970
  * * Field Name: Category
24503
24971
  * * Display Name: Category
24504
24972
  * * SQL Data Type: nvarchar(50)
@@ -24510,6 +24978,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24510
24978
  * * Schema: __mj
24511
24979
  * * Base Table: QueryCategory
24512
24980
  * * Base View: vwQueryCategories
24981
+ * * @description Organizes saved queries into categories for discovery and management, supporting folder-like organization of queries.
24513
24982
  * * Primary Key: ID
24514
24983
  * @extends {BaseEntity}
24515
24984
  * @class
@@ -24659,6 +25128,27 @@ export declare class QueryEntityEntity extends BaseEntity<QueryEntityEntityType>
24659
25128
  */
24660
25129
  get __mj_UpdatedAt(): Date;
24661
25130
  /**
25131
+ * * Field Name: DetectionMethod
25132
+ * * Display Name: Detection Method
25133
+ * * SQL Data Type: nvarchar(50)
25134
+ * * Default Value: Manual
25135
+ * * Value List Type: List
25136
+ * * Possible Values
25137
+ * * AI
25138
+ * * Manual
25139
+ * * Description: Indicates how this entity-query relationship was identified. "AI" means the QueryEntityServer used LLM analysis to parse the SQL/template and identify which MemberJunction entities are referenced (by analyzing table names, joins, and query structure). "Manual" means a user explicitly marked this entity as being used by the query. AI detection helps maintain accurate metadata automatically as queries evolve.
25140
+ */
25141
+ get DetectionMethod(): 'AI' | 'Manual';
25142
+ set DetectionMethod(value: 'AI' | 'Manual');
25143
+ /**
25144
+ * * Field Name: AutoDetectConfidenceScore
25145
+ * * Display Name: Auto Detect Confidence Score
25146
+ * * SQL Data Type: decimal(3, 2)
25147
+ * * Description: Confidence score (0.00-1.00) indicating how certain the AI was that this entity is actually used in the query. Only populated when DetectionMethod="AI". Considers factors like: direct table references vs indirect joins, clear entity names vs ambiguous aliases, and context from the query purpose. Lower scores might indicate the entity is only peripherally involved or the detection was uncertain.
25148
+ */
25149
+ get AutoDetectConfidenceScore(): number | null;
25150
+ set AutoDetectConfidenceScore(value: number | null);
25151
+ /**
24662
25152
  * * Field Name: Query
24663
25153
  * * Display Name: Query
24664
25154
  * * SQL Data Type: nvarchar(255)
@@ -24676,6 +25166,7 @@ export declare class QueryEntityEntity extends BaseEntity<QueryEntityEntityType>
24676
25166
  * * Schema: __mj
24677
25167
  * * Base Table: QueryField
24678
25168
  * * Base View: vwQueryFields
25169
+ * * @description Stores field-level metadata for queries including display names, data types, and formatting rules for result presentation.
24679
25170
  * * Primary Key: ID
24680
25171
  * @extends {BaseEntity}
24681
25172
  * @class
@@ -24728,6 +25219,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24728
25219
  * * Field Name: Sequence
24729
25220
  * * Display Name: Sequence
24730
25221
  * * SQL Data Type: int
25222
+ * * Description: Display order of this field in query results.
24731
25223
  */
24732
25224
  get Sequence(): number;
24733
25225
  set Sequence(value: number);
@@ -24759,6 +25251,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24759
25251
  * * Field Name: SourceFieldName
24760
25252
  * * Display Name: Source Field Name
24761
25253
  * * SQL Data Type: nvarchar(255)
25254
+ * * Description: The original field name from the SQL query if different from the display name.
24762
25255
  */
24763
25256
  get SourceFieldName(): string | null;
24764
25257
  set SourceFieldName(value: string | null);
@@ -24767,6 +25260,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24767
25260
  * * Display Name: Is Computed
24768
25261
  * * SQL Data Type: bit
24769
25262
  * * Default Value: 0
25263
+ * * Description: Indicates if this field is calculated from other fields rather than directly from the database.
24770
25264
  */
24771
25265
  get IsComputed(): boolean;
24772
25266
  set IsComputed(value: boolean);
@@ -24774,6 +25268,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24774
25268
  * * Field Name: ComputationDescription
24775
25269
  * * Display Name: Computation Description
24776
25270
  * * SQL Data Type: nvarchar(MAX)
25271
+ * * Description: Explanation of how this computed field is calculated.
24777
25272
  */
24778
25273
  get ComputationDescription(): string | null;
24779
25274
  set ComputationDescription(value: string | null);
@@ -24782,6 +25277,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24782
25277
  * * Display Name: Is Summary
24783
25278
  * * SQL Data Type: bit
24784
25279
  * * Default Value: 0
25280
+ * * Description: Whether this field represents an aggregate or summary value.
24785
25281
  */
24786
25282
  get IsSummary(): boolean;
24787
25283
  set IsSummary(value: boolean);
@@ -24789,6 +25285,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24789
25285
  * * Field Name: SummaryDescription
24790
25286
  * * Display Name: Summary Description
24791
25287
  * * SQL Data Type: nvarchar(MAX)
25288
+ * * Description: Description of what this summary field represents and how it's aggregated.
24792
25289
  */
24793
25290
  get SummaryDescription(): string | null;
24794
25291
  set SummaryDescription(value: string | null);
@@ -24807,6 +25304,27 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24807
25304
  */
24808
25305
  get __mj_UpdatedAt(): Date;
24809
25306
  /**
25307
+ * * Field Name: DetectionMethod
25308
+ * * Display Name: Detection Method
25309
+ * * SQL Data Type: nvarchar(50)
25310
+ * * Default Value: Manual
25311
+ * * Value List Type: List
25312
+ * * Possible Values
25313
+ * * AI
25314
+ * * Manual
25315
+ * * Description: Indicates how this field was identified in the query output. "AI" means the QueryEntityServer used LLM analysis to parse the SELECT clause and determine field names, types, and their source entities/columns. This includes handling aliased columns, computed expressions, aggregations, and CASE statements. "Manual" means a user explicitly defined this output field. AI detection ensures the field list stays synchronized with query changes.
25316
+ */
25317
+ get DetectionMethod(): 'AI' | 'Manual';
25318
+ set DetectionMethod(value: 'AI' | 'Manual');
25319
+ /**
25320
+ * * Field Name: AutoDetectConfidenceScore
25321
+ * * Display Name: Auto Detect Confidence Score
25322
+ * * SQL Data Type: decimal(3, 2)
25323
+ * * Description: Confidence score (0.00-1.00) indicating how certain the AI was about this field detection. Only populated when DetectionMethod="AI". Factors include: clarity of the SELECT clause, complexity of any expressions or transformations, confidence in type inference, and ability to trace back to source entity/column. Complex computed fields or ambiguous aliases result in lower scores. This helps identify fields that may need manual verification.
25324
+ */
25325
+ get AutoDetectConfidenceScore(): number | null;
25326
+ set AutoDetectConfidenceScore(value: number | null);
25327
+ /**
24810
25328
  * * Field Name: Query
24811
25329
  * * Display Name: Query
24812
25330
  * * SQL Data Type: nvarchar(255)
@@ -24824,6 +25342,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24824
25342
  * * Schema: __mj
24825
25343
  * * Base Table: QueryPermission
24826
25344
  * * Base View: vwQueryPermissions
25345
+ * * @description Controls access to queries by defining which users and roles can run specific queries.
24827
25346
  * * Primary Key: ID
24828
25347
  * @extends {BaseEntity}
24829
25348
  * @class
@@ -24898,6 +25417,7 @@ export declare class QueryPermissionEntity extends BaseEntity<QueryPermissionEnt
24898
25417
  * * Schema: __mj
24899
25418
  * * Base Table: QueueTask
24900
25419
  * * Base View: vwQueueTasks
25420
+ * * @description Manages asynchronous tasks in processing queues, tracking status, priority, and execution details for background operations.
24901
25421
  * * Primary Key: ID
24902
25422
  * @extends {BaseEntity}
24903
25423
  * @class
@@ -24963,6 +25483,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24963
25483
  * * Field Name: Data
24964
25484
  * * Display Name: Data
24965
25485
  * * SQL Data Type: nvarchar(MAX)
25486
+ * * Description: JSON payload containing the data needed to process this task.
24966
25487
  */
24967
25488
  get Data(): string | null;
24968
25489
  set Data(value: string | null);
@@ -24970,6 +25491,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24970
25491
  * * Field Name: Options
24971
25492
  * * Display Name: Options
24972
25493
  * * SQL Data Type: nvarchar(MAX)
25494
+ * * Description: JSON configuration options for how this task should be processed.
24973
25495
  */
24974
25496
  get Options(): string | null;
24975
25497
  set Options(value: string | null);
@@ -24977,6 +25499,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24977
25499
  * * Field Name: Output
24978
25500
  * * Display Name: Output
24979
25501
  * * SQL Data Type: nvarchar(MAX)
25502
+ * * Description: Result data from task execution, typically in JSON format.
24980
25503
  */
24981
25504
  get Output(): string | null;
24982
25505
  set Output(value: string | null);
@@ -24984,6 +25507,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24984
25507
  * * Field Name: ErrorMessage
24985
25508
  * * Display Name: Error Message
24986
25509
  * * SQL Data Type: nvarchar(MAX)
25510
+ * * Description: Error details if the task failed during processing.
24987
25511
  */
24988
25512
  get ErrorMessage(): string | null;
24989
25513
  set ErrorMessage(value: string | null);
@@ -25020,6 +25544,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
25020
25544
  * * Schema: __mj
25021
25545
  * * Base Table: QueueType
25022
25546
  * * Base View: vwQueueTypes
25547
+ * * @description Defines different types of processing queues with specific behaviors, priorities, and processing rules for task management.
25023
25548
  * * Primary Key: ID
25024
25549
  * @extends {BaseEntity}
25025
25550
  * @class
@@ -25064,6 +25589,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25064
25589
  * * Field Name: DriverClass
25065
25590
  * * Display Name: Driver Class
25066
25591
  * * SQL Data Type: nvarchar(100)
25592
+ * * Description: Field DriverClass for entity Queue Types.
25067
25593
  */
25068
25594
  get DriverClass(): string;
25069
25595
  set DriverClass(value: string);
@@ -25071,6 +25597,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25071
25597
  * * Field Name: DriverImportPath
25072
25598
  * * Display Name: Driver Import Path
25073
25599
  * * SQL Data Type: nvarchar(200)
25600
+ * * Description: Field DriverImportPath for entity Queue Types.
25074
25601
  */
25075
25602
  get DriverImportPath(): string | null;
25076
25603
  set DriverImportPath(value: string | null);
@@ -25079,6 +25606,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25079
25606
  * * Display Name: Is Active
25080
25607
  * * SQL Data Type: bit
25081
25608
  * * Default Value: 1
25609
+ * * Description: Field IsActive for entity Queue Types.
25082
25610
  */
25083
25611
  get IsActive(): boolean;
25084
25612
  set IsActive(value: boolean);
@@ -25156,6 +25684,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25156
25684
  * * Display Name: Is Active
25157
25685
  * * SQL Data Type: bit
25158
25686
  * * Default Value: 0
25687
+ * * Description: Field IsActive for entity Queues.
25159
25688
  */
25160
25689
  get IsActive(): boolean;
25161
25690
  set IsActive(value: boolean);
@@ -25163,6 +25692,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25163
25692
  * * Field Name: ProcessPID
25164
25693
  * * Display Name: Process PID
25165
25694
  * * SQL Data Type: int
25695
+ * * Description: Field ProcessPID for entity Queues.
25166
25696
  */
25167
25697
  get ProcessPID(): number | null;
25168
25698
  set ProcessPID(value: number | null);
@@ -25170,6 +25700,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25170
25700
  * * Field Name: ProcessPlatform
25171
25701
  * * Display Name: Process Platform
25172
25702
  * * SQL Data Type: nvarchar(30)
25703
+ * * Description: Field ProcessPlatform for entity Queues.
25173
25704
  */
25174
25705
  get ProcessPlatform(): string | null;
25175
25706
  set ProcessPlatform(value: string | null);
@@ -25177,6 +25708,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25177
25708
  * * Field Name: ProcessVersion
25178
25709
  * * Display Name: Process Version
25179
25710
  * * SQL Data Type: nvarchar(15)
25711
+ * * Description: Field ProcessVersion for entity Queues.
25180
25712
  */
25181
25713
  get ProcessVersion(): string | null;
25182
25714
  set ProcessVersion(value: string | null);
@@ -25184,6 +25716,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25184
25716
  * * Field Name: ProcessCwd
25185
25717
  * * Display Name: Process Cwd
25186
25718
  * * SQL Data Type: nvarchar(100)
25719
+ * * Description: Field ProcessCwd for entity Queues.
25187
25720
  */
25188
25721
  get ProcessCwd(): string | null;
25189
25722
  set ProcessCwd(value: string | null);
@@ -25191,6 +25724,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25191
25724
  * * Field Name: ProcessIPAddress
25192
25725
  * * Display Name: Process IPAddress
25193
25726
  * * SQL Data Type: nvarchar(50)
25727
+ * * Description: Field ProcessIPAddress for entity Queues.
25194
25728
  */
25195
25729
  get ProcessIPAddress(): string | null;
25196
25730
  set ProcessIPAddress(value: string | null);
@@ -25198,6 +25732,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25198
25732
  * * Field Name: ProcessMacAddress
25199
25733
  * * Display Name: Process Mac Address
25200
25734
  * * SQL Data Type: nvarchar(50)
25735
+ * * Description: Field ProcessMacAddress for entity Queues.
25201
25736
  */
25202
25737
  get ProcessMacAddress(): string | null;
25203
25738
  set ProcessMacAddress(value: string | null);
@@ -25205,6 +25740,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25205
25740
  * * Field Name: ProcessOSName
25206
25741
  * * Display Name: Process OSName
25207
25742
  * * SQL Data Type: nvarchar(25)
25743
+ * * Description: Field ProcessOSName for entity Queues.
25208
25744
  */
25209
25745
  get ProcessOSName(): string | null;
25210
25746
  set ProcessOSName(value: string | null);
@@ -25212,6 +25748,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25212
25748
  * * Field Name: ProcessOSVersion
25213
25749
  * * Display Name: Process OSVersion
25214
25750
  * * SQL Data Type: nvarchar(10)
25751
+ * * Description: Field ProcessOSVersion for entity Queues.
25215
25752
  */
25216
25753
  get ProcessOSVersion(): string | null;
25217
25754
  set ProcessOSVersion(value: string | null);
@@ -25219,6 +25756,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25219
25756
  * * Field Name: ProcessHostName
25220
25757
  * * Display Name: Process Host Name
25221
25758
  * * SQL Data Type: nvarchar(50)
25759
+ * * Description: Field ProcessHostName for entity Queues.
25222
25760
  */
25223
25761
  get ProcessHostName(): string | null;
25224
25762
  set ProcessHostName(value: string | null);
@@ -25226,6 +25764,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25226
25764
  * * Field Name: ProcessUserID
25227
25765
  * * Display Name: Process User ID
25228
25766
  * * SQL Data Type: nvarchar(25)
25767
+ * * Description: Field ProcessUserID for entity Queues.
25229
25768
  */
25230
25769
  get ProcessUserID(): string | null;
25231
25770
  set ProcessUserID(value: string | null);
@@ -25233,6 +25772,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25233
25772
  * * Field Name: ProcessUserName
25234
25773
  * * Display Name: Process User Name
25235
25774
  * * SQL Data Type: nvarchar(50)
25775
+ * * Description: Field ProcessUserName for entity Queues.
25236
25776
  */
25237
25777
  get ProcessUserName(): string | null;
25238
25778
  set ProcessUserName(value: string | null);
@@ -25241,6 +25781,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25241
25781
  * * Display Name: Last Heartbeat
25242
25782
  * * SQL Data Type: datetime
25243
25783
  * * Default Value: getdate()
25784
+ * * Description: Field LastHeartbeat for entity Queues.
25244
25785
  */
25245
25786
  get LastHeartbeat(): Date;
25246
25787
  set LastHeartbeat(value: Date);
@@ -25750,6 +26291,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25750
26291
  * * Field Name: RecordID
25751
26292
  * * Display Name: Record
25752
26293
  * * SQL Data Type: nvarchar(750)
26294
+ * * Description: Field RecordID for entity Record Changes.
25753
26295
  */
25754
26296
  get RecordID(): string;
25755
26297
  set RecordID(value: string);
@@ -25838,6 +26380,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25838
26380
  * * Field Name: ErrorLog
25839
26381
  * * Display Name: Error Log
25840
26382
  * * SQL Data Type: nvarchar(MAX)
26383
+ * * Description: Field ErrorLog for entity Record Changes.
25841
26384
  */
25842
26385
  get ErrorLog(): string | null;
25843
26386
  set ErrorLog(value: string | null);
@@ -25868,6 +26411,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25868
26411
  * * Display Name: Created At
25869
26412
  * * SQL Data Type: datetimeoffset
25870
26413
  * * Default Value: getutcdate()
26414
+ * * Description: Field CreatedAt for entity Record Changes.
25871
26415
  */
25872
26416
  get CreatedAt(): Date;
25873
26417
  /**
@@ -25875,6 +26419,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25875
26419
  * * Display Name: Updated At
25876
26420
  * * SQL Data Type: datetimeoffset
25877
26421
  * * Default Value: getutcdate()
26422
+ * * Description: Field UpdatedAt for entity Record Changes.
25878
26423
  */
25879
26424
  get UpdatedAt(): Date;
25880
26425
  /**
@@ -25901,6 +26446,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25901
26446
  * * Schema: __mj
25902
26447
  * * Base Table: RecordMergeDeletionLog
25903
26448
  * * Base View: vwRecordMergeDeletionLogs
26449
+ * * @description Tracks records deleted during merge operations, maintaining an audit trail of data consolidation activities.
25904
26450
  * * Primary Key: ID
25905
26451
  * @extends {BaseEntity}
25906
26452
  * @class
@@ -25939,6 +26485,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25939
26485
  * * Field Name: DeletedRecordID
25940
26486
  * * Display Name: Deleted Record ID
25941
26487
  * * SQL Data Type: nvarchar(750)
26488
+ * * Description: Field DeletedRecordID for entity Record Merge Deletion Logs.
25942
26489
  */
25943
26490
  get DeletedRecordID(): string;
25944
26491
  set DeletedRecordID(value: string);
@@ -25959,6 +26506,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25959
26506
  * * Field Name: ProcessingLog
25960
26507
  * * Display Name: Processing Log
25961
26508
  * * SQL Data Type: nvarchar(MAX)
26509
+ * * Description: Field ProcessingLog for entity Record Merge Deletion Logs.
25962
26510
  */
25963
26511
  get ProcessingLog(): string | null;
25964
26512
  set ProcessingLog(value: string | null);
@@ -25982,6 +26530,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25982
26530
  * * Schema: __mj
25983
26531
  * * Base Table: RecordMergeLog
25984
26532
  * * Base View: vwRecordMergeLogs
26533
+ * * @description Records the history of record merge operations including source records, target records, and merge rules applied.
25985
26534
  * * Primary Key: ID
25986
26535
  * @extends {BaseEntity}
25987
26536
  * @class
@@ -26020,6 +26569,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26020
26569
  * * Field Name: SurvivingRecordID
26021
26570
  * * Display Name: Surviving Record ID
26022
26571
  * * SQL Data Type: nvarchar(450)
26572
+ * * Description: The ID of the record that survived the merge and contains the consolidated data.
26023
26573
  */
26024
26574
  get SurvivingRecordID(): string;
26025
26575
  set SurvivingRecordID(value: string);
@@ -26041,6 +26591,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26041
26591
  * * Pending
26042
26592
  * * Approved
26043
26593
  * * Rejected
26594
+ * * Description: Field ApprovalStatus for entity Record Merge Logs.
26044
26595
  */
26045
26596
  get ApprovalStatus(): 'Pending' | 'Approved' | 'Rejected';
26046
26597
  set ApprovalStatus(value: 'Pending' | 'Approved' | 'Rejected');
@@ -26062,6 +26613,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26062
26613
  * * Started
26063
26614
  * * Complete
26064
26615
  * * Error
26616
+ * * Description: Field ProcessingStatus for entity Record Merge Logs.
26065
26617
  */
26066
26618
  get ProcessingStatus(): 'Started' | 'Complete' | 'Error';
26067
26619
  set ProcessingStatus(value: 'Started' | 'Complete' | 'Error');
@@ -26070,6 +26622,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26070
26622
  * * Display Name: Processing Started At
26071
26623
  * * SQL Data Type: datetime
26072
26624
  * * Default Value: getdate()
26625
+ * * Description: Field ProcessingStartedAt for entity Record Merge Logs.
26073
26626
  */
26074
26627
  get ProcessingStartedAt(): Date;
26075
26628
  set ProcessingStartedAt(value: Date);
@@ -26077,6 +26630,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26077
26630
  * * Field Name: ProcessingEndedAt
26078
26631
  * * Display Name: Processing Ended At
26079
26632
  * * SQL Data Type: datetime
26633
+ * * Description: Field ProcessingEndedAt for entity Record Merge Logs.
26080
26634
  */
26081
26635
  get ProcessingEndedAt(): Date | null;
26082
26636
  set ProcessingEndedAt(value: Date | null);
@@ -26084,6 +26638,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26084
26638
  * * Field Name: ProcessingLog
26085
26639
  * * Display Name: Processing Log
26086
26640
  * * SQL Data Type: nvarchar(MAX)
26641
+ * * Description: Detailed log of the merge process including field mappings and decisions.
26087
26642
  */
26088
26643
  get ProcessingLog(): string | null;
26089
26644
  set ProcessingLog(value: string | null);
@@ -26132,6 +26687,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26132
26687
  * * Schema: __mj
26133
26688
  * * Base Table: ReportCategory
26134
26689
  * * Base View: vwReportCategories
26690
+ * * @description Organizes reports into logical groupings for navigation, access control, and discovery within the reporting system.
26135
26691
  * * Primary Key: ID
26136
26692
  * @extends {BaseEntity}
26137
26693
  * @class
@@ -26220,6 +26776,7 @@ export declare class ReportCategoryEntity extends BaseEntity<ReportCategoryEntit
26220
26776
  * * Schema: __mj
26221
26777
  * * Base Table: ReportSnapshot
26222
26778
  * * Base View: vwReportSnapshots
26779
+ * * @description Stores point-in-time captures of report outputs, preserving historical data and enabling comparison over time.
26223
26780
  * * Primary Key: ID
26224
26781
  * @extends {BaseEntity}
26225
26782
  * @class
@@ -26258,6 +26815,7 @@ export declare class ReportSnapshotEntity extends BaseEntity<ReportSnapshotEntit
26258
26815
  * * Field Name: ResultSet
26259
26816
  * * Display Name: Result Set
26260
26817
  * * SQL Data Type: nvarchar(MAX)
26818
+ * * Description: Field ResultSet for entity Report Snapshots.
26261
26819
  */
26262
26820
  get ResultSet(): string;
26263
26821
  set ResultSet(value: string);
@@ -26301,6 +26859,7 @@ export declare class ReportSnapshotEntity extends BaseEntity<ReportSnapshotEntit
26301
26859
  * * Schema: __mj
26302
26860
  * * Base Table: Report
26303
26861
  * * Base View: vwReports
26862
+ * * @description Defines report configurations including data sources, layouts, filters, and scheduling for automated report generation.
26304
26863
  * * Primary Key: ID
26305
26864
  * @extends {BaseEntity}
26306
26865
  * @class
@@ -26367,6 +26926,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26367
26926
  * * None
26368
26927
  * * Specific
26369
26928
  * * Everyone
26929
+ * * Description: Field SharingScope for entity Reports.
26370
26930
  */
26371
26931
  get SharingScope(): 'None' | 'Specific' | 'Everyone';
26372
26932
  set SharingScope(value: 'None' | 'Specific' | 'Everyone');
@@ -26398,6 +26958,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26398
26958
  * * Field Name: Configuration
26399
26959
  * * Display Name: Configuration
26400
26960
  * * SQL Data Type: nvarchar(MAX)
26961
+ * * Description: Field Configuration for entity Reports.
26401
26962
  */
26402
26963
  get Configuration(): string | null;
26403
26964
  set Configuration(value: string | null);
@@ -26429,6 +26990,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26429
26990
  * * Field Name: OutputFrequency
26430
26991
  * * Display Name: Output Frequency
26431
26992
  * * SQL Data Type: nvarchar(50)
26993
+ * * Description: For scheduled reports, the frequency of generation (Daily, Weekly, Monthly, etc.).
26432
26994
  */
26433
26995
  get OutputFrequency(): string | null;
26434
26996
  set OutputFrequency(value: string | null);
@@ -26436,6 +26998,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26436
26998
  * * Field Name: OutputTargetEmail
26437
26999
  * * Display Name: Output Target Email
26438
27000
  * * SQL Data Type: nvarchar(255)
27001
+ * * Description: Email address(es) to send the report to when using email delivery.
26439
27002
  */
26440
27003
  get OutputTargetEmail(): string | null;
26441
27004
  set OutputTargetEmail(value: string | null);
@@ -26786,6 +27349,7 @@ export declare class ResourcePermissionEntity extends BaseEntity<ResourcePermiss
26786
27349
  * * Schema: __mj
26787
27350
  * * Base Table: ResourceType
26788
27351
  * * Base View: vwResourceTypes
27352
+ * * @description Tracks types of system resources such as records, dashboards, and reports.
26789
27353
  * * Primary Key: ID
26790
27354
  * @extends {BaseEntity}
26791
27355
  * @class
@@ -26823,6 +27387,7 @@ export declare class ResourceTypeEntity extends BaseEntity<ResourceTypeEntityTyp
26823
27387
  * * Field Name: DisplayName
26824
27388
  * * Display Name: Display Name
26825
27389
  * * SQL Data Type: nvarchar(255)
27390
+ * * Description: Field DisplayName for entity Resource Types.
26826
27391
  */
26827
27392
  get DisplayName(): string;
26828
27393
  set DisplayName(value: string);
@@ -26837,6 +27402,7 @@ export declare class ResourceTypeEntity extends BaseEntity<ResourceTypeEntityTyp
26837
27402
  * * Field Name: Icon
26838
27403
  * * Display Name: Icon
26839
27404
  * * SQL Data Type: nvarchar(100)
27405
+ * * Description: Icon identifier for displaying this resource type in the UI.
26840
27406
  */
26841
27407
  get Icon(): string | null;
26842
27408
  set Icon(value: string | null);
@@ -26963,6 +27529,7 @@ export declare class RoleEntity extends BaseEntity<RoleEntityType> {
26963
27529
  * * Schema: __mj
26964
27530
  * * Base Table: RowLevelSecurityFilter
26965
27531
  * * Base View: vwRowLevelSecurityFilters
27532
+ * * @description Defines data access rules that filter records based on user context, implementing fine-grained security at the row level.
26966
27533
  * * Primary Key: ID
26967
27534
  * @extends {BaseEntity}
26968
27535
  * @class
@@ -27007,6 +27574,7 @@ export declare class RowLevelSecurityFilterEntity extends BaseEntity<RowLevelSec
27007
27574
  * * Field Name: FilterText
27008
27575
  * * Display Name: Filter Text
27009
27576
  * * SQL Data Type: nvarchar(MAX)
27577
+ * * Description: SQL WHERE clause template that filters records based on user context variables.
27010
27578
  */
27011
27579
  get FilterText(): string | null;
27012
27580
  set FilterText(value: string | null);
@@ -27030,6 +27598,7 @@ export declare class RowLevelSecurityFilterEntity extends BaseEntity<RowLevelSec
27030
27598
  * * Schema: __mj
27031
27599
  * * Base Table: ScheduledActionParam
27032
27600
  * * Base View: vwScheduledActionParams
27601
+ * * @description Stores parameter values for scheduled action executions, configuring inputs for automated action runs.
27033
27602
  * * Primary Key: ID
27034
27603
  * @extends {BaseEntity}
27035
27604
  * @class
@@ -27080,6 +27649,7 @@ export declare class ScheduledActionParamEntity extends BaseEntity<ScheduledActi
27080
27649
  * * Possible Values
27081
27650
  * * Static
27082
27651
  * * SQL Statement
27652
+ * * Description: Field ValueType for entity Scheduled Action Params.
27083
27653
  */
27084
27654
  get ValueType(): 'Static' | 'SQL Statement';
27085
27655
  set ValueType(value: 'Static' | 'SQL Statement');
@@ -27087,6 +27657,7 @@ export declare class ScheduledActionParamEntity extends BaseEntity<ScheduledActi
27087
27657
  * * Field Name: Value
27088
27658
  * * Display Name: Value
27089
27659
  * * SQL Data Type: nvarchar(MAX)
27660
+ * * Description: Field Value for entity Scheduled Action Params.
27090
27661
  */
27091
27662
  get Value(): string | null;
27092
27663
  set Value(value: string | null);
@@ -27268,6 +27839,7 @@ export declare class ScheduledActionEntity extends BaseEntity<ScheduledActionEnt
27268
27839
  * * Field Name: CustomCronExpression
27269
27840
  * * Display Name: Custom Cron Expression
27270
27841
  * * SQL Data Type: nvarchar(255)
27842
+ * * Description: Field CustomCronExpression for entity Scheduled Actions.
27271
27843
  */
27272
27844
  get CustomCronExpression(): string | null;
27273
27845
  set CustomCronExpression(value: string | null);
@@ -27324,27 +27896,27 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27324
27896
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
27325
27897
  /**
27326
27898
  * Validate() method override for Schema Info entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
27327
- * * Table-Level: This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
27328
27899
  * * Table-Level: This rule ensures that the maximum entity ID must be greater than the minimum entity ID, which helps to maintain valid and logical ranges for entity IDs.
27900
+ * * Table-Level: This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
27329
27901
  * @public
27330
27902
  * @method
27331
27903
  * @override
27332
27904
  */
27333
27905
  Validate(): ValidationResult;
27334
27906
  /**
27335
- * This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
27907
+ * This rule ensures that the maximum entity ID must be greater than the minimum entity ID, which helps to maintain valid and logical ranges for entity IDs.
27336
27908
  * @param result - the ValidationResult object to add any errors or warnings to
27337
27909
  * @public
27338
27910
  * @method
27339
27911
  */
27340
- ValidateEntityIDMinAndEntityIDMaxGreaterThanZero(result: ValidationResult): void;
27912
+ ValidateEntityIDMaxGreaterThanEntityIDMin(result: ValidationResult): void;
27341
27913
  /**
27342
- * This rule ensures that the maximum entity ID must be greater than the minimum entity ID, which helps to maintain valid and logical ranges for entity IDs.
27914
+ * This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
27343
27915
  * @param result - the ValidationResult object to add any errors or warnings to
27344
27916
  * @public
27345
27917
  * @method
27346
27918
  */
27347
- ValidateEntityIDMaxGreaterThanEntityIDMin(result: ValidationResult): void;
27919
+ ValidateEntityIDMinAndEntityIDMaxGreaterThanZero(result: ValidationResult): void;
27348
27920
  /**
27349
27921
  * * Field Name: ID
27350
27922
  * * Display Name: ID
@@ -27357,6 +27929,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27357
27929
  * * Field Name: SchemaName
27358
27930
  * * Display Name: Schema Name
27359
27931
  * * SQL Data Type: nvarchar(50)
27932
+ * * Description: The database schema this information applies to.
27360
27933
  */
27361
27934
  get SchemaName(): string;
27362
27935
  set SchemaName(value: string);
@@ -27364,6 +27937,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27364
27937
  * * Field Name: EntityIDMin
27365
27938
  * * Display Name: Entity IDMin
27366
27939
  * * SQL Data Type: int
27940
+ * * Description: Field EntityIDMin for entity Schema Info.
27367
27941
  */
27368
27942
  get EntityIDMin(): number;
27369
27943
  set EntityIDMin(value: number);
@@ -27371,6 +27945,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27371
27945
  * * Field Name: EntityIDMax
27372
27946
  * * Display Name: Entity IDMax
27373
27947
  * * SQL Data Type: int
27948
+ * * Description: Field EntityIDMax for entity Schema Info.
27374
27949
  */
27375
27950
  get EntityIDMax(): number;
27376
27951
  set EntityIDMax(value: number);
@@ -27514,6 +28089,7 @@ export declare class TaggedItemEntity extends BaseEntity<TaggedItemEntityType> {
27514
28089
  * * Field Name: RecordID
27515
28090
  * * Display Name: Record ID
27516
28091
  * * SQL Data Type: nvarchar(450)
28092
+ * * Description: Field RecordID for entity Tagged Items.
27517
28093
  */
27518
28094
  get RecordID(): string;
27519
28095
  set RecordID(value: string);
@@ -27595,6 +28171,7 @@ export declare class TagEntity extends BaseEntity<TagEntityType> {
27595
28171
  * * Field Name: DisplayName
27596
28172
  * * Display Name: Display Name
27597
28173
  * * SQL Data Type: nvarchar(255)
28174
+ * * Description: Field DisplayName for entity Tags.
27598
28175
  */
27599
28176
  get DisplayName(): string;
27600
28177
  set DisplayName(value: string);
@@ -27984,6 +28561,7 @@ export declare class TemplateParamEntity extends BaseEntity<TemplateParamEntityT
27984
28561
  * * Display Name: Is Required
27985
28562
  * * SQL Data Type: bit
27986
28563
  * * Default Value: 0
28564
+ * * Description: Whether this parameter must be provided when using the template.
27987
28565
  */
27988
28566
  get IsRequired(): boolean;
27989
28567
  set IsRequired(value: boolean);
@@ -28200,6 +28778,7 @@ export declare class TemplateEntity extends BaseEntity<TemplateEntityType> {
28200
28778
  * * Schema: __mj
28201
28779
  * * Base Table: UserApplicationEntity
28202
28780
  * * Base View: vwUserApplicationEntities
28781
+ * * @description Links users to specific entities within applications, managing entity-level personalization.
28203
28782
  * * Primary Key: ID
28204
28783
  * @extends {BaseEntity}
28205
28784
  * @class
@@ -28245,6 +28824,7 @@ export declare class UserApplicationEntityEntity extends BaseEntity<UserApplicat
28245
28824
  * * Field Name: Sequence
28246
28825
  * * SQL Data Type: int
28247
28826
  * * Default Value: 0
28827
+ * * Description: Display order of this entity for the user within the application.
28248
28828
  */
28249
28829
  get Sequence(): number;
28250
28830
  set Sequence(value: number);
@@ -28286,6 +28866,7 @@ export declare class UserApplicationEntityEntity extends BaseEntity<UserApplicat
28286
28866
  * * Schema: __mj
28287
28867
  * * Base Table: UserApplication
28288
28868
  * * Base View: vwUserApplications
28869
+ * * @description Tracks which applications users have configured to display.
28289
28870
  * * Primary Key: ID
28290
28871
  * @extends {BaseEntity}
28291
28872
  * @class
@@ -28331,6 +28912,7 @@ export declare class UserApplicationEntity extends BaseEntity<UserApplicationEnt
28331
28912
  * * Field Name: Sequence
28332
28913
  * * SQL Data Type: int
28333
28914
  * * Default Value: 0
28915
+ * * Description: Display order of this application in the user's navigation.
28334
28916
  */
28335
28917
  get Sequence(): number;
28336
28918
  set Sequence(value: number);
@@ -28339,6 +28921,7 @@ export declare class UserApplicationEntity extends BaseEntity<UserApplicationEnt
28339
28921
  * * Display Name: Is Active
28340
28922
  * * SQL Data Type: bit
28341
28923
  * * Default Value: 1
28924
+ * * Description: Whether this application is currently visible to the user.
28342
28925
  */
28343
28926
  get IsActive(): boolean;
28344
28927
  set IsActive(value: boolean);
@@ -28420,6 +29003,7 @@ export declare class UserFavoriteEntity extends BaseEntity<UserFavoriteEntityTyp
28420
29003
  * * Field Name: RecordID
28421
29004
  * * Display Name: Record
28422
29005
  * * SQL Data Type: nvarchar(450)
29006
+ * * Description: The ID of the favorited record.
28423
29007
  */
28424
29008
  get RecordID(): string;
28425
29009
  set RecordID(value: string);
@@ -28460,6 +29044,7 @@ export declare class UserFavoriteEntity extends BaseEntity<UserFavoriteEntityTyp
28460
29044
  * * Schema: __mj
28461
29045
  * * Base Table: UserNotification
28462
29046
  * * Base View: vwUserNotifications
29047
+ * * @description Manages notifications sent to users including alerts, messages, and system updates with read status and priority.
28463
29048
  * * Primary Key: ID
28464
29049
  * @extends {BaseEntity}
28465
29050
  * @class
@@ -28498,6 +29083,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28498
29083
  * * Field Name: Title
28499
29084
  * * Display Name: Title
28500
29085
  * * SQL Data Type: nvarchar(255)
29086
+ * * Description: Brief title or subject of the notification.
28501
29087
  */
28502
29088
  get Title(): string | null;
28503
29089
  set Title(value: string | null);
@@ -28505,6 +29091,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28505
29091
  * * Field Name: Message
28506
29092
  * * Display Name: Message
28507
29093
  * * SQL Data Type: nvarchar(MAX)
29094
+ * * Description: Full notification message content.
28508
29095
  */
28509
29096
  get Message(): string | null;
28510
29097
  set Message(value: string | null);
@@ -28520,6 +29107,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28520
29107
  * * Field Name: ResourceConfiguration
28521
29108
  * * Display Name: Resource Configuration
28522
29109
  * * SQL Data Type: nvarchar(MAX)
29110
+ * * Description: Field ResourceConfiguration for entity User Notifications.
28523
29111
  */
28524
29112
  get ResourceConfiguration(): string | null;
28525
29113
  set ResourceConfiguration(value: string | null);
@@ -28528,6 +29116,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28528
29116
  * * Display Name: Unread
28529
29117
  * * SQL Data Type: bit
28530
29118
  * * Default Value: 1
29119
+ * * Description: Field Unread for entity User Notifications.
28531
29120
  */
28532
29121
  get Unread(): boolean;
28533
29122
  set Unread(value: boolean);
@@ -28535,6 +29124,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28535
29124
  * * Field Name: ReadAt
28536
29125
  * * Display Name: Read At
28537
29126
  * * SQL Data Type: datetime
29127
+ * * Description: Timestamp when the user read this notification.
28538
29128
  */
28539
29129
  get ReadAt(): Date | null;
28540
29130
  set ReadAt(value: Date | null);
@@ -28556,6 +29146,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28556
29146
  * * Field Name: ResourceRecordID
28557
29147
  * * Display Name: Resource Record ID
28558
29148
  * * SQL Data Type: uniqueidentifier
29149
+ * * Description: ID of the specific record this notification is about.
28559
29150
  */
28560
29151
  get ResourceRecordID(): string | null;
28561
29152
  set ResourceRecordID(value: string | null);
@@ -28577,6 +29168,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28577
29168
  * * Schema: __mj
28578
29169
  * * Base Table: UserRecordLog
28579
29170
  * * Base View: vwUserRecordLogs
29171
+ * * @description Tracks user interactions with specific records, maintaining an audit trail of views or other operations. Changes are managed separately in the Record Changes entity.
28580
29172
  * * Primary Key: ID
28581
29173
  * @extends {BaseEntity}
28582
29174
  * @class
@@ -28622,6 +29214,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28622
29214
  * * Field Name: RecordID
28623
29215
  * * Display Name: Record
28624
29216
  * * SQL Data Type: nvarchar(450)
29217
+ * * Description: The ID of the accessed record.
28625
29218
  */
28626
29219
  get RecordID(): string;
28627
29220
  set RecordID(value: string);
@@ -28630,6 +29223,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28630
29223
  * * Display Name: Earliest At
28631
29224
  * * SQL Data Type: datetime
28632
29225
  * * Default Value: getdate()
29226
+ * * Description: Field EarliestAt for entity User Record Logs.
28633
29227
  */
28634
29228
  get EarliestAt(): Date;
28635
29229
  set EarliestAt(value: Date);
@@ -28638,6 +29232,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28638
29232
  * * Display Name: Latest At
28639
29233
  * * SQL Data Type: datetime
28640
29234
  * * Default Value: getdate()
29235
+ * * Description: Field LatestAt for entity User Record Logs.
28641
29236
  */
28642
29237
  get LatestAt(): Date;
28643
29238
  set LatestAt(value: Date);
@@ -28646,6 +29241,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28646
29241
  * * Display Name: Total Count
28647
29242
  * * SQL Data Type: int
28648
29243
  * * Default Value: 0
29244
+ * * Description: Field TotalCount for entity User Record Logs.
28649
29245
  */
28650
29246
  get TotalCount(): number;
28651
29247
  set TotalCount(value: number);
@@ -28705,6 +29301,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28705
29301
  * * Schema: __mj
28706
29302
  * * Base Table: UserRole
28707
29303
  * * Base View: vwUserRoles
29304
+ * * @description Associates users with roles in the system, managing role-based access control and permission inheritance.
28708
29305
  * * Primary Key: ID
28709
29306
  * @extends {BaseEntity}
28710
29307
  * @class
@@ -28779,6 +29376,7 @@ export declare class UserRoleEntity extends BaseEntity<UserRoleEntityType> {
28779
29376
  * * Schema: __mj
28780
29377
  * * Base Table: UserViewCategory
28781
29378
  * * Base View: vwUserViewCategories
29379
+ * * @description Organizes user-created views into categories for personal organization and sharing within teams.
28782
29380
  * * Primary Key: ID
28783
29381
  * @extends {BaseEntity}
28784
29382
  * @class
@@ -28919,6 +29517,7 @@ export declare class UserViewRunDetailEntity extends BaseEntity<UserViewRunDetai
28919
29517
  * * Field Name: RecordID
28920
29518
  * * Display Name: Record
28921
29519
  * * SQL Data Type: nvarchar(450)
29520
+ * * Description: Field RecordID for entity User View Run Details.
28922
29521
  */
28923
29522
  get RecordID(): string;
28924
29523
  set RecordID(value: string);
@@ -28992,6 +29591,7 @@ export declare class UserViewRunEntity extends BaseEntity<UserViewRunEntityType>
28992
29591
  * * Field Name: RunAt
28993
29592
  * * Display Name: Run At
28994
29593
  * * SQL Data Type: datetime
29594
+ * * Description: Timestamp when the view was executed.
28995
29595
  */
28996
29596
  get RunAt(): Date;
28997
29597
  set RunAt(value: Date);
@@ -29102,6 +29702,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29102
29702
  * * Display Name: Is Shared
29103
29703
  * * SQL Data Type: bit
29104
29704
  * * Default Value: 0
29705
+ * * Description: Whether this view is shared with other users.
29105
29706
  */
29106
29707
  get IsShared(): boolean;
29107
29708
  set IsShared(value: boolean);
@@ -29110,6 +29711,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29110
29711
  * * Display Name: Is Default
29111
29712
  * * SQL Data Type: bit
29112
29713
  * * Default Value: 0
29714
+ * * Description: Whether this is the user's default view for the entity.
29113
29715
  */
29114
29716
  get IsDefault(): boolean;
29115
29717
  set IsDefault(value: boolean);
@@ -29117,6 +29719,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29117
29719
  * * Field Name: GridState
29118
29720
  * * Display Name: Grid State
29119
29721
  * * SQL Data Type: nvarchar(MAX)
29722
+ * * Description: JSON storing complete grid configuration including columns, widths, and formatting.
29120
29723
  */
29121
29724
  get GridState(): string | null;
29122
29725
  set GridState(value: string | null);
@@ -29124,6 +29727,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29124
29727
  * * Field Name: FilterState
29125
29728
  * * Display Name: Filter State
29126
29729
  * * SQL Data Type: nvarchar(MAX)
29730
+ * * Description: JSON storing the view's filter configuration.
29127
29731
  */
29128
29732
  get FilterState(): string | null;
29129
29733
  set FilterState(value: string | null);
@@ -29132,6 +29736,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29132
29736
  * * Display Name: Custom Filter State
29133
29737
  * * SQL Data Type: bit
29134
29738
  * * Default Value: 0
29739
+ * * Description: Indicates if custom filters beyond standard options are applied.
29135
29740
  */
29136
29741
  get CustomFilterState(): boolean;
29137
29742
  set CustomFilterState(value: boolean);
@@ -29140,6 +29745,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29140
29745
  * * Display Name: Smart Filter Enabled
29141
29746
  * * SQL Data Type: bit
29142
29747
  * * Default Value: 0
29748
+ * * Description: Whether AI-powered smart filtering is enabled for this view.
29143
29749
  */
29144
29750
  get SmartFilterEnabled(): boolean;
29145
29751
  set SmartFilterEnabled(value: boolean);
@@ -29147,6 +29753,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29147
29753
  * * Field Name: SmartFilterPrompt
29148
29754
  * * Display Name: Smart Filter Prompt
29149
29755
  * * SQL Data Type: nvarchar(MAX)
29756
+ * * Description: Natural language prompt for AI-powered filtering.
29150
29757
  */
29151
29758
  get SmartFilterPrompt(): string | null;
29152
29759
  set SmartFilterPrompt(value: string | null);
@@ -29154,6 +29761,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29154
29761
  * * Field Name: SmartFilterWhereClause
29155
29762
  * * Display Name: Smart Filter Where Clause
29156
29763
  * * SQL Data Type: nvarchar(MAX)
29764
+ * * Description: Generated WHERE clause from smart filter processing.
29157
29765
  */
29158
29766
  get SmartFilterWhereClause(): string | null;
29159
29767
  set SmartFilterWhereClause(value: string | null);
@@ -29161,6 +29769,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29161
29769
  * * Field Name: SmartFilterExplanation
29162
29770
  * * Display Name: Smart Filter Explanation
29163
29771
  * * SQL Data Type: nvarchar(MAX)
29772
+ * * Description: AI-generated explanation of what the smart filter does.
29164
29773
  */
29165
29774
  get SmartFilterExplanation(): string | null;
29166
29775
  set SmartFilterExplanation(value: string | null);
@@ -29168,6 +29777,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29168
29777
  * * Field Name: WhereClause
29169
29778
  * * Display Name: Where Clause
29170
29779
  * * SQL Data Type: nvarchar(MAX)
29780
+ * * Description: Direct SQL WHERE clause for the view filter.
29171
29781
  */
29172
29782
  get WhereClause(): string | null;
29173
29783
  set WhereClause(value: string | null);
@@ -29176,6 +29786,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29176
29786
  * * Display Name: Custom Where Clause
29177
29787
  * * SQL Data Type: bit
29178
29788
  * * Default Value: 0
29789
+ * * Description: Indicates if a custom WHERE clause is used instead of standard filters.
29179
29790
  */
29180
29791
  get CustomWhereClause(): boolean;
29181
29792
  set CustomWhereClause(value: boolean);
@@ -29183,6 +29794,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29183
29794
  * * Field Name: SortState
29184
29795
  * * Display Name: Sort State
29185
29796
  * * SQL Data Type: nvarchar(MAX)
29797
+ * * Description: JSON storing the view's sort configuration.
29186
29798
  */
29187
29799
  get SortState(): string | null;
29188
29800
  set SortState(value: string | null);
@@ -29286,6 +29898,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29286
29898
  * * Field Name: FirstName
29287
29899
  * * Display Name: First Name
29288
29900
  * * SQL Data Type: nvarchar(50)
29901
+ * * Description: User's first name or given name.
29289
29902
  */
29290
29903
  get FirstName(): string | null;
29291
29904
  set FirstName(value: string | null);
@@ -29293,6 +29906,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29293
29906
  * * Field Name: LastName
29294
29907
  * * Display Name: Last Name
29295
29908
  * * SQL Data Type: nvarchar(50)
29909
+ * * Description: User's last name or surname.
29296
29910
  */
29297
29911
  get LastName(): string | null;
29298
29912
  set LastName(value: string | null);
@@ -29300,6 +29914,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29300
29914
  * * Field Name: Title
29301
29915
  * * Display Name: Title
29302
29916
  * * SQL Data Type: nvarchar(50)
29917
+ * * Description: User's professional title or salutation.
29303
29918
  */
29304
29919
  get Title(): string | null;
29305
29920
  set Title(value: string | null);
@@ -29317,6 +29932,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29317
29932
  * * Possible Values
29318
29933
  * * User
29319
29934
  * * Owner
29935
+ * * Description: User account type (User, Guest, System, API).
29320
29936
  */
29321
29937
  get Type(): 'User' | 'Owner';
29322
29938
  set Type(value: 'User' | 'Owner');
@@ -29325,6 +29941,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29325
29941
  * * Display Name: Is Active
29326
29942
  * * SQL Data Type: bit
29327
29943
  * * Default Value: 0
29944
+ * * Description: Whether this user account is currently active and can log in.
29328
29945
  */
29329
29946
  get IsActive(): boolean;
29330
29947
  set IsActive(value: boolean);
@@ -29333,6 +29950,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29333
29950
  * * Display Name: Linked Record Type
29334
29951
  * * SQL Data Type: nchar(10)
29335
29952
  * * Default Value: None
29953
+ * * Description: Type of record this user is linked to (None, Employee, Contact, etc.).
29336
29954
  */
29337
29955
  get LinkedRecordType(): string;
29338
29956
  set LinkedRecordType(value: string);
@@ -29348,6 +29966,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29348
29966
  * * Field Name: LinkedEntityRecordID
29349
29967
  * * Display Name: Linked Entity Record ID
29350
29968
  * * SQL Data Type: nvarchar(450)
29969
+ * * Description: ID of the specific record this user is linked to.
29351
29970
  */
29352
29971
  get LinkedEntityRecordID(): string | null;
29353
29972
  set LinkedEntityRecordID(value: string | null);
@@ -29415,6 +30034,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29415
30034
  * * Schema: __mj
29416
30035
  * * Base Table: VectorDatabase
29417
30036
  * * Base View: vwVectorDatabases
30037
+ * * @description Configures connections to vector database systems for AI embeddings, similarity search, and semantic operations.
29418
30038
  * * Primary Key: ID
29419
30039
  * @extends {BaseEntity}
29420
30040
  * @class
@@ -29459,6 +30079,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29459
30079
  * * Field Name: DefaultURL
29460
30080
  * * Display Name: Default URL
29461
30081
  * * SQL Data Type: nvarchar(255)
30082
+ * * Description: Field DefaultURL for entity Vector Databases.
29462
30083
  */
29463
30084
  get DefaultURL(): string | null;
29464
30085
  set DefaultURL(value: string | null);
@@ -29466,6 +30087,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29466
30087
  * * Field Name: ClassKey
29467
30088
  * * Display Name: Class Key
29468
30089
  * * SQL Data Type: nvarchar(100)
30090
+ * * Description: Field ClassKey for entity Vector Databases.
29469
30091
  */
29470
30092
  get ClassKey(): string | null;
29471
30093
  set ClassKey(value: string | null);
@@ -29489,6 +30111,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29489
30111
  * * Schema: __mj
29490
30112
  * * Base Table: VectorIndex
29491
30113
  * * Base View: vwVectorIndexes
30114
+ * * @description Defines vector indexes within a given Vector Database.
29492
30115
  * * Primary Key: ID
29493
30116
  * @extends {BaseEntity}
29494
30117
  * @class
@@ -29577,6 +30200,7 @@ export declare class VectorIndexEntity extends BaseEntity<VectorIndexEntityType>
29577
30200
  * * Schema: __mj
29578
30201
  * * Base Table: VersionInstallation
29579
30202
  * * Base View: vwVersionInstallations
30203
+ * * @description Records installation history of system versions, tracking deployments, rollbacks, and version-specific configurations.
29580
30204
  * * Primary Key: ID
29581
30205
  * @extends {BaseEntity}
29582
30206
  * @class
@@ -29607,6 +30231,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29607
30231
  * * Field Name: MajorVersion
29608
30232
  * * Display Name: Major Version
29609
30233
  * * SQL Data Type: int
30234
+ * * Description: Major version number installed.
29610
30235
  */
29611
30236
  get MajorVersion(): number;
29612
30237
  set MajorVersion(value: number);
@@ -29614,6 +30239,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29614
30239
  * * Field Name: MinorVersion
29615
30240
  * * Display Name: Minor Version
29616
30241
  * * SQL Data Type: int
30242
+ * * Description: Minor version number installed.
29617
30243
  */
29618
30244
  get MinorVersion(): number;
29619
30245
  set MinorVersion(value: number);
@@ -29621,6 +30247,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29621
30247
  * * Field Name: PatchVersion
29622
30248
  * * Display Name: Patch Version
29623
30249
  * * SQL Data Type: int
30250
+ * * Description: Patch version number installed.
29624
30251
  */
29625
30252
  get PatchVersion(): number;
29626
30253
  set PatchVersion(value: number);
@@ -29641,6 +30268,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29641
30268
  * * Field Name: InstalledAt
29642
30269
  * * Display Name: Installed At
29643
30270
  * * SQL Data Type: datetime
30271
+ * * Description: Timestamp when this version was installed.
29644
30272
  */
29645
30273
  get InstalledAt(): Date;
29646
30274
  set InstalledAt(value: Date);
@@ -29701,10 +30329,12 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29701
30329
  * * Schema: __mj
29702
30330
  * * Base Table: WorkflowEngine
29703
30331
  * * Base View: vwWorkflowEngines
30332
+ * * @description Registers available workflow execution engines with their capabilities, configuration, and supported workflow types.
29704
30333
  * * Primary Key: ID
29705
30334
  * @extends {BaseEntity}
29706
30335
  * @class
29707
30336
  * @public
30337
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29708
30338
  */
29709
30339
  export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntityType> {
29710
30340
  /**
@@ -29742,6 +30372,7 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29742
30372
  * * Field Name: DriverPath
29743
30373
  * * Display Name: Driver Path
29744
30374
  * * SQL Data Type: nvarchar(500)
30375
+ * * Description: Import path for the workflow engine driver.
29745
30376
  */
29746
30377
  get DriverPath(): string;
29747
30378
  set DriverPath(value: string);
@@ -29749,6 +30380,7 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29749
30380
  * * Field Name: DriverClass
29750
30381
  * * Display Name: Driver Class
29751
30382
  * * SQL Data Type: nvarchar(100)
30383
+ * * Description: Class name implementing the workflow engine interface.
29752
30384
  */
29753
30385
  get DriverClass(): string;
29754
30386
  set DriverClass(value: string);
@@ -29772,10 +30404,12 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29772
30404
  * * Schema: __mj
29773
30405
  * * Base Table: WorkflowRun
29774
30406
  * * Base View: vwWorkflowRuns
30407
+ * * @description Tracks execution instances of workflows including status, timing, context data, and detailed step-by-step results.
29775
30408
  * * Primary Key: ID
29776
30409
  * @extends {BaseEntity}
29777
30410
  * @class
29778
30411
  * @public
30412
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29779
30413
  */
29780
30414
  export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType> {
29781
30415
  /**
@@ -29809,6 +30443,7 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29809
30443
  * * Field Name: ExternalSystemRecordID
29810
30444
  * * Display Name: External System Record
29811
30445
  * * SQL Data Type: nvarchar(500)
30446
+ * * Description: Field ExternalSystemRecordID for entity Workflow Runs.
29812
30447
  */
29813
30448
  get ExternalSystemRecordID(): string;
29814
30449
  set ExternalSystemRecordID(value: string);
@@ -29842,6 +30477,7 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29842
30477
  /**
29843
30478
  * * Field Name: Results
29844
30479
  * * SQL Data Type: nvarchar(MAX)
30480
+ * * Description: JSON-formatted detailed results from the workflow execution, including outputs from each step and any error information.
29845
30481
  */
29846
30482
  get Results(): string | null;
29847
30483
  set Results(value: string | null);
@@ -29877,10 +30513,12 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29877
30513
  * * Schema: __mj
29878
30514
  * * Base Table: Workflow
29879
30515
  * * Base View: vwWorkflows
30516
+ * * @description Defines automated workflows with steps, conditions, and actions for orchestrating complex business processes.
29880
30517
  * * Primary Key: ID
29881
30518
  * @extends {BaseEntity}
29882
30519
  * @class
29883
30520
  * @public
30521
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29884
30522
  */
29885
30523
  export declare class WorkflowEntity extends BaseEntity<WorkflowEntityType> {
29886
30524
  /**
@@ -29926,6 +30564,7 @@ export declare class WorkflowEntity extends BaseEntity<WorkflowEntityType> {
29926
30564
  * * Field Name: ExternalSystemRecordID
29927
30565
  * * Display Name: External System Record
29928
30566
  * * SQL Data Type: nvarchar(100)
30567
+ * * Description: The unique identifier of this workflow in an external system, used for synchronization with external workflow engines.
29929
30568
  */
29930
30569
  get ExternalSystemRecordID(): string;
29931
30570
  set ExternalSystemRecordID(value: string);
@@ -30057,6 +30696,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30057
30696
  * * Field Name: ResourceRecordID
30058
30697
  * * Display Name: Resource Record ID
30059
30698
  * * SQL Data Type: nvarchar(2000)
30699
+ * * Description: The ID of the resource (such as a view, dashboard, or other entity record) that is included in this workspace.
30060
30700
  */
30061
30701
  get ResourceRecordID(): string | null;
30062
30702
  set ResourceRecordID(value: string | null);
@@ -30064,6 +30704,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30064
30704
  * * Field Name: Sequence
30065
30705
  * * Display Name: Sequence
30066
30706
  * * SQL Data Type: int
30707
+ * * Description: The display order of this item within the workspace, used for arranging resources in the user interface.
30067
30708
  */
30068
30709
  get Sequence(): number;
30069
30710
  set Sequence(value: number);
@@ -30071,6 +30712,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30071
30712
  * * Field Name: Configuration
30072
30713
  * * Display Name: Configuration
30073
30714
  * * SQL Data Type: nvarchar(MAX)
30715
+ * * Description: JSON configuration data specific to this workspace item, storing custom settings and state information.
30074
30716
  */
30075
30717
  get Configuration(): string | null;
30076
30718
  set Configuration(value: string | null);