@memberjunction/core-entities 2.72.0 → 2.74.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.
@@ -5714,6 +5714,56 @@ export declare const DashboardUserStateSchema: z.ZodObject<{
5714
5714
  UserState?: string;
5715
5715
  }>;
5716
5716
  export type DashboardUserStateEntityType = z.infer<typeof DashboardUserStateSchema>;
5717
+ /**
5718
+ * zod schema definition for the entity MJ: Query Parameters
5719
+ */
5720
+ export declare const QueryParameterSchema: z.ZodObject<{
5721
+ ID: z.ZodString;
5722
+ QueryID: z.ZodString;
5723
+ Name: z.ZodString;
5724
+ Type: z.ZodUnion<[z.ZodLiteral<"string">, z.ZodLiteral<"number">, z.ZodLiteral<"date">, z.ZodLiteral<"boolean">, z.ZodLiteral<"array">]>;
5725
+ IsRequired: z.ZodNullable<z.ZodBoolean>;
5726
+ DefaultValue: z.ZodNullable<z.ZodString>;
5727
+ Description: z.ZodNullable<z.ZodString>;
5728
+ SampleValue: z.ZodNullable<z.ZodString>;
5729
+ ValidationFilters: z.ZodNullable<z.ZodString>;
5730
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
5731
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5732
+ __mj_CreatedAt: z.ZodDate;
5733
+ __mj_UpdatedAt: z.ZodDate;
5734
+ Query: z.ZodString;
5735
+ }, "strip", z.ZodTypeAny, {
5736
+ ID?: string;
5737
+ __mj_CreatedAt?: Date;
5738
+ __mj_UpdatedAt?: Date;
5739
+ Name?: string;
5740
+ Description?: string;
5741
+ DefaultValue?: string;
5742
+ Type?: "string" | "number" | "boolean" | "date" | "array";
5743
+ IsRequired?: boolean;
5744
+ QueryID?: string;
5745
+ Query?: string;
5746
+ SampleValue?: string;
5747
+ ValidationFilters?: string;
5748
+ DetectionMethod?: "AI" | "Manual";
5749
+ AutoDetectConfidenceScore?: number;
5750
+ }, {
5751
+ ID?: string;
5752
+ __mj_CreatedAt?: Date;
5753
+ __mj_UpdatedAt?: Date;
5754
+ Name?: string;
5755
+ Description?: string;
5756
+ DefaultValue?: string;
5757
+ Type?: "string" | "number" | "boolean" | "date" | "array";
5758
+ IsRequired?: boolean;
5759
+ QueryID?: string;
5760
+ Query?: string;
5761
+ SampleValue?: string;
5762
+ ValidationFilters?: string;
5763
+ DetectionMethod?: "AI" | "Manual";
5764
+ AutoDetectConfidenceScore?: number;
5765
+ }>;
5766
+ export type QueryParameterEntityType = z.infer<typeof QueryParameterSchema>;
5717
5767
  /**
5718
5768
  * zod schema definition for the entity MJ: Report User States
5719
5769
  */
@@ -5874,6 +5924,7 @@ export declare const QuerySchema: z.ZodObject<{
5874
5924
  ExecutionCostRank: z.ZodNullable<z.ZodNumber>;
5875
5925
  __mj_CreatedAt: z.ZodDate;
5876
5926
  __mj_UpdatedAt: z.ZodDate;
5927
+ UsesTemplate: z.ZodNullable<z.ZodBoolean>;
5877
5928
  Category: z.ZodNullable<z.ZodString>;
5878
5929
  }, "strip", z.ZodTypeAny, {
5879
5930
  ID?: string;
@@ -5891,6 +5942,7 @@ export declare const QuerySchema: z.ZodObject<{
5891
5942
  Feedback?: string;
5892
5943
  QualityRank?: number;
5893
5944
  ExecutionCostRank?: number;
5945
+ UsesTemplate?: boolean;
5894
5946
  }, {
5895
5947
  ID?: string;
5896
5948
  __mj_CreatedAt?: Date;
@@ -5907,6 +5959,7 @@ export declare const QuerySchema: z.ZodObject<{
5907
5959
  Feedback?: string;
5908
5960
  QualityRank?: number;
5909
5961
  ExecutionCostRank?: number;
5962
+ UsesTemplate?: boolean;
5910
5963
  }>;
5911
5964
  export type QueryEntityType = z.infer<typeof QuerySchema>;
5912
5965
  /**
@@ -5953,6 +6006,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5953
6006
  EntityID: z.ZodString;
5954
6007
  __mj_CreatedAt: z.ZodDate;
5955
6008
  __mj_UpdatedAt: z.ZodDate;
6009
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
6010
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5956
6011
  Query: z.ZodString;
5957
6012
  Entity: z.ZodString;
5958
6013
  }, "strip", z.ZodTypeAny, {
@@ -5963,6 +6018,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5963
6018
  Entity?: string;
5964
6019
  QueryID?: string;
5965
6020
  Query?: string;
6021
+ DetectionMethod?: "AI" | "Manual";
6022
+ AutoDetectConfidenceScore?: number;
5966
6023
  }, {
5967
6024
  ID?: string;
5968
6025
  __mj_CreatedAt?: Date;
@@ -5971,6 +6028,8 @@ export declare const QueryEntitySchema: z.ZodObject<{
5971
6028
  Entity?: string;
5972
6029
  QueryID?: string;
5973
6030
  Query?: string;
6031
+ DetectionMethod?: "AI" | "Manual";
6032
+ AutoDetectConfidenceScore?: number;
5974
6033
  }>;
5975
6034
  export type QueryEntityEntityType = z.infer<typeof QueryEntitySchema>;
5976
6035
  /**
@@ -5992,6 +6051,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
5992
6051
  SummaryDescription: z.ZodNullable<z.ZodString>;
5993
6052
  __mj_CreatedAt: z.ZodDate;
5994
6053
  __mj_UpdatedAt: z.ZodDate;
6054
+ DetectionMethod: z.ZodUnion<[z.ZodLiteral<"AI">, z.ZodLiteral<"Manual">]>;
6055
+ AutoDetectConfidenceScore: z.ZodNullable<z.ZodNumber>;
5995
6056
  Query: z.ZodString;
5996
6057
  SourceEntity: z.ZodNullable<z.ZodString>;
5997
6058
  }, "strip", z.ZodTypeAny, {
@@ -6003,6 +6064,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
6003
6064
  Sequence?: number;
6004
6065
  QueryID?: string;
6005
6066
  Query?: string;
6067
+ DetectionMethod?: "AI" | "Manual";
6068
+ AutoDetectConfidenceScore?: number;
6006
6069
  SQLBaseType?: string;
6007
6070
  SQLFullType?: string;
6008
6071
  SourceEntityID?: string;
@@ -6021,6 +6084,8 @@ export declare const QueryFieldSchema: z.ZodObject<{
6021
6084
  Sequence?: number;
6022
6085
  QueryID?: string;
6023
6086
  Query?: string;
6087
+ DetectionMethod?: "AI" | "Manual";
6088
+ AutoDetectConfidenceScore?: number;
6024
6089
  SQLBaseType?: string;
6025
6090
  SQLFullType?: string;
6026
6091
  SourceEntityID?: string;
@@ -8459,6 +8524,7 @@ export declare class ActionExecutionLogEntity extends BaseEntity<ActionExecution
8459
8524
  * * Field Name: Params
8460
8525
  * * Display Name: Params
8461
8526
  * * SQL Data Type: nvarchar(MAX)
8527
+ * * Description: JSON-formatted input parameters passed to the action during execution, storing the exact values used for this specific run.
8462
8528
  */
8463
8529
  get Params(): string | null;
8464
8530
  set Params(value: string | null);
@@ -8466,6 +8532,7 @@ export declare class ActionExecutionLogEntity extends BaseEntity<ActionExecution
8466
8532
  * * Field Name: ResultCode
8467
8533
  * * Display Name: Result Code
8468
8534
  * * SQL Data Type: nvarchar(255)
8535
+ * * Description: The outcome code returned by the action execution, indicating success, failure, or specific error conditions as defined in Action Result Codes.
8469
8536
  */
8470
8537
  get ResultCode(): string | null;
8471
8538
  set ResultCode(value: string | null);
@@ -8556,6 +8623,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8556
8623
  * * Field Name: UserDescription
8557
8624
  * * Display Name: User Description
8558
8625
  * * SQL Data Type: nvarchar(MAX)
8626
+ * * Description: Human-readable explanation of what this filter checks and when it should prevent action execution, written for non-technical users.
8559
8627
  */
8560
8628
  get UserDescription(): string;
8561
8629
  set UserDescription(value: string);
@@ -8563,6 +8631,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8563
8631
  * * Field Name: UserComments
8564
8632
  * * Display Name: User Comments
8565
8633
  * * SQL Data Type: nvarchar(MAX)
8634
+ * * Description: Additional notes or implementation details about the filter logic, including examples or edge cases to consider.
8566
8635
  */
8567
8636
  get UserComments(): string | null;
8568
8637
  set UserComments(value: string | null);
@@ -8570,6 +8639,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8570
8639
  * * Field Name: Code
8571
8640
  * * Display Name: Code
8572
8641
  * * SQL Data Type: nvarchar(MAX)
8642
+ * * Description: JavaScript code that evaluates to true (allow action) or false (prevent action), executed in the same context as the action.
8573
8643
  */
8574
8644
  get Code(): string;
8575
8645
  set Code(value: string);
@@ -8577,6 +8647,7 @@ export declare class ActionFilterEntity extends BaseEntity<ActionFilterEntityTyp
8577
8647
  * * Field Name: CodeExplanation
8578
8648
  * * Display Name: Code Explanation
8579
8649
  * * SQL Data Type: nvarchar(MAX)
8650
+ * * Description: Technical documentation of the filter code logic, including expected inputs, outputs, and any dependencies or assumptions.
8580
8651
  */
8581
8652
  get CodeExplanation(): string | null;
8582
8653
  set CodeExplanation(value: string | null);
@@ -8729,6 +8800,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8729
8800
  * * Field Name: DefaultValue
8730
8801
  * * Display Name: Default Value
8731
8802
  * * SQL Data Type: nvarchar(MAX)
8803
+ * * Description: The default value for this parameter if not provided during action execution, can be a literal value or JSON for complex types.
8732
8804
  */
8733
8805
  get DefaultValue(): string | null;
8734
8806
  set DefaultValue(value: string | null);
@@ -8741,6 +8813,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8741
8813
  * * Input
8742
8814
  * * Output
8743
8815
  * * Both
8816
+ * * Description: Specifies whether this parameter is used for Input, Output, or Both directions in the action execution flow.
8744
8817
  */
8745
8818
  get Type(): 'Input' | 'Output' | 'Both';
8746
8819
  set Type(value: 'Input' | 'Output' | 'Both');
@@ -8763,6 +8836,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8763
8836
  * * Display Name: Is Array
8764
8837
  * * SQL Data Type: bit
8765
8838
  * * Default Value: 0
8839
+ * * Description: Indicates whether this parameter accepts or returns an array of values rather than a single value.
8766
8840
  */
8767
8841
  get IsArray(): boolean;
8768
8842
  set IsArray(value: boolean);
@@ -8778,6 +8852,7 @@ export declare class ActionParamEntity extends BaseEntity<ActionParamEntityType>
8778
8852
  * * Display Name: Is Required
8779
8853
  * * SQL Data Type: bit
8780
8854
  * * Default Value: 1
8855
+ * * Description: Determines if this parameter must be provided for input parameters or will always be populated for output parameters.
8781
8856
  */
8782
8857
  get IsRequired(): boolean;
8783
8858
  set IsRequired(value: boolean);
@@ -8846,6 +8921,7 @@ export declare class ActionResultCodeEntity extends BaseEntity<ActionResultCodeE
8846
8921
  * * Field Name: ResultCode
8847
8922
  * * Display Name: Result Code
8848
8923
  * * SQL Data Type: nvarchar(255)
8924
+ * * Description: The unique code string returned by the action to indicate specific outcomes, used for programmatic handling of results.
8849
8925
  */
8850
8926
  get ResultCode(): string;
8851
8927
  set ResultCode(value: string);
@@ -8959,6 +9035,7 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
8959
9035
  * * Field Name: UserPrompt
8960
9036
  * * Display Name: User Prompt
8961
9037
  * * SQL Data Type: nvarchar(MAX)
9038
+ * * Description: The natural language prompt provided by the user describing what the action should accomplish, used for AI code generation.
8962
9039
  */
8963
9040
  get UserPrompt(): string | null;
8964
9041
  set UserPrompt(value: string | null);
@@ -8974,6 +9051,7 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
8974
9051
  * * Field Name: Code
8975
9052
  * * Display Name: Code
8976
9053
  * * SQL Data Type: nvarchar(MAX)
9054
+ * * Description: The generated or manually written code that implements the action logic, typically TypeScript/JavaScript that will be executed.
8977
9055
  */
8978
9056
  get Code(): string | null;
8979
9057
  set Code(value: string | null);
@@ -9172,6 +9250,7 @@ export declare class AIActionEntity extends BaseEntity<AIActionEntityType> {
9172
9250
  * * Field Name: DefaultPrompt
9173
9251
  * * Display Name: Default Prompt
9174
9252
  * * SQL Data Type: nvarchar(MAX)
9253
+ * * Description: The standard prompt template used when invoking this AI action, can include placeholders for dynamic values.
9175
9254
  */
9176
9255
  get DefaultPrompt(): string | null;
9177
9256
  set DefaultPrompt(value: string | null);
@@ -9188,6 +9267,7 @@ export declare class AIActionEntity extends BaseEntity<AIActionEntityType> {
9188
9267
  * * Display Name: Is Active
9189
9268
  * * SQL Data Type: bit
9190
9269
  * * Default Value: 1
9270
+ * * Description: Controls whether this AI action is currently available for use across the system.
9191
9271
  */
9192
9272
  get IsActive(): boolean;
9193
9273
  set IsActive(value: boolean);
@@ -9238,8 +9318,8 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
9238
9318
  Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
9239
9319
  /**
9240
9320
  * Validate() method override for AI Agent Actions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
9241
- * * MaxExecutionsPerRun: This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
9242
9321
  * * MinExecutionsPerRun: This rule ensures that if a value for 'Minimum Executions Per Run' is provided, it must be zero or greater. If the value is not provided (left blank), that's also allowed.
9322
+ * * MaxExecutionsPerRun: This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
9243
9323
  * * Table-Level: This rule ensures that the minimum number of executions per run cannot be greater than the maximum number of executions per run. If either value is not specified, the rule is considered satisfied.
9244
9324
  * @public
9245
9325
  * @method
@@ -9247,19 +9327,19 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
9247
9327
  */
9248
9328
  Validate(): ValidationResult;
9249
9329
  /**
9250
- * This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
9330
+ * This rule ensures that if a value for 'Minimum Executions Per Run' is provided, it must be zero or greater. If the value is not provided (left blank), that's also allowed.
9251
9331
  * @param result - the ValidationResult object to add any errors or warnings to
9252
9332
  * @public
9253
9333
  * @method
9254
9334
  */
9255
- ValidateMaxExecutionsPerRunGreaterThanZero(result: ValidationResult): void;
9335
+ ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
9256
9336
  /**
9257
- * This rule ensures that if a value for 'Minimum Executions Per Run' is provided, it must be zero or greater. If the value is not provided (left blank), that's also allowed.
9337
+ * This rule ensures that if a value for the maximum number of executions per run is provided, it must be greater than zero. If no value is provided, that's acceptable.
9258
9338
  * @param result - the ValidationResult object to add any errors or warnings to
9259
9339
  * @public
9260
9340
  * @method
9261
9341
  */
9262
- ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
9342
+ ValidateMaxExecutionsPerRunGreaterThanZero(result: ValidationResult): void;
9263
9343
  /**
9264
9344
  * This rule ensures that the minimum number of executions per run cannot be greater than the maximum number of executions per run. If either value is not specified, the rule is considered satisfied.
9265
9345
  * @param result - the ValidationResult object to add any errors or warnings to
@@ -9507,6 +9587,7 @@ export declare class AIAgentModelEntity extends BaseEntity<AIAgentModelEntityTyp
9507
9587
  * * Field Name: Active
9508
9588
  * * Display Name: Active
9509
9589
  * * SQL Data Type: bit
9590
+ * * Description: Indicates whether this specific agent-model combination is currently enabled for use in AI operations.
9510
9591
  */
9511
9592
  get Active(): boolean | null;
9512
9593
  set Active(value: boolean | null);
@@ -9550,6 +9631,7 @@ export declare class AIAgentModelEntity extends BaseEntity<AIAgentModelEntityTyp
9550
9631
  * * Schema: __mj
9551
9632
  * * Base Table: AIAgentNoteType
9552
9633
  * * Base View: vwAIAgentNoteTypes
9634
+ * * @description Defines categories and types for AI agent notes, enabling classification and organization of agent-generated observations, recommendations, and learnings.
9553
9635
  * * Primary Key: ID
9554
9636
  * @extends {BaseEntity}
9555
9637
  * @class
@@ -9610,6 +9692,7 @@ export declare class AIAgentNoteTypeEntity extends BaseEntity<AIAgentNoteTypeEnt
9610
9692
  * * Schema: __mj
9611
9693
  * * Base Table: AIAgentNote
9612
9694
  * * Base View: vwAIAgentNotes
9695
+ * * @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
9696
  * * Primary Key: ID
9614
9697
  * @extends {BaseEntity}
9615
9698
  * @class
@@ -9656,6 +9739,7 @@ export declare class AIAgentNoteEntity extends BaseEntity<AIAgentNoteEntityType>
9656
9739
  * * Field Name: Note
9657
9740
  * * Display Name: Note
9658
9741
  * * SQL Data Type: nvarchar(MAX)
9742
+ * * Description: The content of the note, observation, or learning captured by the AI agent during its execution.
9659
9743
  */
9660
9744
  get Note(): string | null;
9661
9745
  set Note(value: string | null);
@@ -10229,8 +10313,7 @@ if this limit is exceeded.
10229
10313
  * * Field Name: StartingPayloadValidation
10230
10314
  * * Display Name: Starting Payload Validation
10231
10315
  * * 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.
10316
+ * * Description: Optional JSON schema validation to apply to the input payload before agent execution begins. Uses the same JSONValidator format as FinalPayloadValidation.
10234
10317
  */
10235
10318
  get StartingPayloadValidation(): string | null;
10236
10319
  set StartingPayloadValidation(value: string | null);
@@ -10243,8 +10326,7 @@ format as FinalPayloadValidation.
10243
10326
  * * Possible Values
10244
10327
  * * Fail
10245
10328
  * * Warn
10246
- * * Description: Determines how to handle StartingPayloadValidation failures. Fail = reject invalid input, Warn = log warning but
10247
- proceed.
10329
+ * * Description: Determines how to handle StartingPayloadValidation failures. Fail = reject invalid input, Warn = log warning but proceed.
10248
10330
  */
10249
10331
  get StartingPayloadValidationMode(): 'Fail' | 'Warn';
10250
10332
  set StartingPayloadValidationMode(value: 'Fail' | 'Warn');
@@ -10321,6 +10403,7 @@ export declare class AIModelActionEntity extends BaseEntity<AIModelActionEntityT
10321
10403
  * * Display Name: Is Active
10322
10404
  * * SQL Data Type: bit
10323
10405
  * * Default Value: 1
10406
+ * * Description: Determines if this specific action is currently enabled for the associated AI model.
10324
10407
  */
10325
10408
  get IsActive(): boolean;
10326
10409
  set IsActive(value: boolean);
@@ -10511,6 +10594,7 @@ export declare class AIModelEntity extends BaseEntity<AIModelEntityType> {
10511
10594
  * * Display Name: Is Active
10512
10595
  * * SQL Data Type: bit
10513
10596
  * * Default Value: 1
10597
+ * * Description: Controls whether this AI model is available for use in the system.
10514
10598
  */
10515
10599
  get IsActive(): boolean;
10516
10600
  set IsActive(value: boolean);
@@ -11599,6 +11683,7 @@ export declare class ApplicationEntityEntity extends BaseEntity<ApplicationEntit
11599
11683
  /**
11600
11684
  * * Field Name: Sequence
11601
11685
  * * SQL Data Type: int
11686
+ * * Description: Display order of this entity within the application, lower numbers appear first in navigation and menus.
11602
11687
  */
11603
11688
  get Sequence(): number;
11604
11689
  set Sequence(value: number);
@@ -11665,6 +11750,7 @@ export declare class ApplicationEntityEntity extends BaseEntity<ApplicationEntit
11665
11750
  * * Schema: __mj
11666
11751
  * * Base Table: ApplicationSetting
11667
11752
  * * Base View: vwApplicationSettings
11753
+ * * @description Stores configuration settings and preferences for applications, including key-value pairs for runtime parameters and user-specific customizations.
11668
11754
  * * Primary Key: ID
11669
11755
  * @extends {BaseEntity}
11670
11756
  * @class
@@ -11710,6 +11796,7 @@ export declare class ApplicationSettingEntity extends BaseEntity<ApplicationSett
11710
11796
  * * Field Name: Value
11711
11797
  * * Display Name: Value
11712
11798
  * * SQL Data Type: nvarchar(MAX)
11799
+ * * Description: The setting value, can be simple text, numbers, booleans, or JSON for complex configuration objects.
11713
11800
  */
11714
11801
  get Value(): string;
11715
11802
  set Value(value: string);
@@ -11829,6 +11916,7 @@ export declare class ApplicationEntity extends BaseEntity<ApplicationEntityType>
11829
11916
  * * Schema: __mj
11830
11917
  * * Base Table: AuditLogType
11831
11918
  * * Base View: vwAuditLogTypes
11919
+ * * @description Defines the types of events that can be recorded in the audit log, enabling categorization and filtering of system activities.
11832
11920
  * * Primary Key: ID
11833
11921
  * @extends {BaseEntity}
11834
11922
  * @class
@@ -11917,6 +12005,7 @@ export declare class AuditLogTypeEntity extends BaseEntity<AuditLogTypeEntityTyp
11917
12005
  * * Schema: __mj
11918
12006
  * * Base Table: AuditLog
11919
12007
  * * Base View: vwAuditLogs
12008
+ * * @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
12009
  * * Primary Key: ID
11921
12010
  * @extends {BaseEntity}
11922
12011
  * @class
@@ -11990,6 +12079,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
11990
12079
  * * Field Name: Details
11991
12080
  * * Display Name: Details
11992
12081
  * * SQL Data Type: nvarchar(MAX)
12082
+ * * Description: JSON-formatted additional context about the audited event, including before/after values, parameters, or other relevant data.
11993
12083
  */
11994
12084
  get Details(): string | null;
11995
12085
  set Details(value: string | null);
@@ -12005,6 +12095,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
12005
12095
  * * Field Name: RecordID
12006
12096
  * * Display Name: Record
12007
12097
  * * SQL Data Type: nvarchar(450)
12098
+ * * Description: The primary key value of the record that was affected by this audited action, enabling direct lookup of the modified data.
12008
12099
  */
12009
12100
  get RecordID(): string | null;
12010
12101
  set RecordID(value: string | null);
@@ -12052,6 +12143,7 @@ export declare class AuditLogEntity extends BaseEntity<AuditLogEntityType> {
12052
12143
  * * Schema: __mj
12053
12144
  * * Base Table: AuthorizationRole
12054
12145
  * * Base View: vwAuthorizationRoles
12146
+ * * @description Links authorizations to roles, defining which permissions are granted to users assigned to specific roles in the system.
12055
12147
  * * Primary Key: ID
12056
12148
  * @extends {BaseEntity}
12057
12149
  * @class
@@ -12103,6 +12195,7 @@ export declare class AuthorizationRoleEntity extends BaseEntity<AuthorizationRol
12103
12195
  * * Possible Values
12104
12196
  * * Allow - User allowed to execute tasks linked to this authorization
12105
12197
  * * Deny - User NOT allowed to execute tasks linked to this authorization - deny overrides Allow from all other roles a user may be part of
12198
+ * * Description: Specifies whether this authorization is granted to ('grant') or explicitly denied ('deny') for the role.
12106
12199
  */
12107
12200
  get Type(): 'Allow' | 'Deny';
12108
12201
  set Type(value: 'Allow' | 'Deny');
@@ -12138,6 +12231,7 @@ export declare class AuthorizationRoleEntity extends BaseEntity<AuthorizationRol
12138
12231
  * * Schema: __mj
12139
12232
  * * Base Table: Authorization
12140
12233
  * * Base View: vwAuthorizations
12234
+ * * @description Stores the fundamental permissions and access rights that can be granted to users and roles throughout the system.
12141
12235
  * * Primary Key: ID
12142
12236
  * @extends {BaseEntity}
12143
12237
  * @class
@@ -12184,6 +12278,7 @@ export declare class AuthorizationEntity extends BaseEntity<AuthorizationEntityT
12184
12278
  * * Display Name: Is Active
12185
12279
  * * SQL Data Type: bit
12186
12280
  * * Default Value: 1
12281
+ * * Description: Indicates whether this authorization is currently active and can be granted to users or roles.
12187
12282
  */
12188
12283
  get IsActive(): boolean;
12189
12284
  set IsActive(value: boolean);
@@ -12260,6 +12355,7 @@ export declare class CommunicationBaseMessageTypeEntity extends BaseEntity<Commu
12260
12355
  * * Field Name: Type
12261
12356
  * * Display Name: Type
12262
12357
  * * SQL Data Type: nvarchar(100)
12358
+ * * Description: The unique identifier for this message type, used for routing and processing communications.
12263
12359
  */
12264
12360
  get Type(): string;
12265
12361
  set Type(value: string);
@@ -12846,6 +12942,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12846
12942
  /**
12847
12943
  * * Field Name: Website
12848
12944
  * * SQL Data Type: nvarchar(100)
12945
+ * * Description: The primary website URL for this company or division.
12849
12946
  */
12850
12947
  get Website(): string | null;
12851
12948
  set Website(value: string | null);
@@ -12853,6 +12950,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12853
12950
  * * Field Name: LogoURL
12854
12951
  * * Display Name: Logo URL
12855
12952
  * * SQL Data Type: nvarchar(500)
12953
+ * * Description: URL pointing to the company's logo image, used for branding in the UI.
12856
12954
  */
12857
12955
  get LogoURL(): string | null;
12858
12956
  set LogoURL(value: string | null);
@@ -12860,6 +12958,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12860
12958
  * * Field Name: Domain
12861
12959
  * * Display Name: Domain
12862
12960
  * * SQL Data Type: nvarchar(255)
12961
+ * * Description: The primary email domain associated with this company, used for employee email validation and SSO configuration.
12863
12962
  */
12864
12963
  get Domain(): string | null;
12865
12964
  set Domain(value: string | null);
@@ -12883,6 +12982,7 @@ export declare class CompanyEntity extends BaseEntity<CompanyEntityType> {
12883
12982
  * * Schema: __mj
12884
12983
  * * Base Table: CompanyIntegrationRecordMap
12885
12984
  * * Base View: vwCompanyIntegrationRecordMaps
12985
+ * * @description Maps records between internal entities and external system identifiers, maintaining synchronization between MemberJunction and integrated platforms.
12886
12986
  * * Primary Key: ID
12887
12987
  * @extends {BaseEntity}
12888
12988
  * @class
@@ -12921,6 +13021,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12921
13021
  * * Field Name: ExternalSystemRecordID
12922
13022
  * * Display Name: External System Record ID
12923
13023
  * * SQL Data Type: nvarchar(750)
13024
+ * * Description: The unique identifier for this record in the external integrated system.
12924
13025
  */
12925
13026
  get ExternalSystemRecordID(): string;
12926
13027
  set ExternalSystemRecordID(value: string);
@@ -12936,6 +13037,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12936
13037
  * * Field Name: EntityRecordID
12937
13038
  * * Display Name: Entity Record ID
12938
13039
  * * SQL Data Type: nvarchar(750)
13040
+ * * Description: The internal MemberJunction record ID that corresponds to the external system record.
12939
13041
  */
12940
13042
  get EntityRecordID(): string;
12941
13043
  set EntityRecordID(value: string);
@@ -12971,6 +13073,7 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity<Compan
12971
13073
  * * Schema: __mj
12972
13074
  * * Base Table: CompanyIntegrationRunAPILog
12973
13075
  * * Base View: vwCompanyIntegrationRunAPILogs
13076
+ * * @description Logs detailed API calls and responses during integration runs, including request/response payloads, status codes, and timing information.
12974
13077
  * * Primary Key: ID
12975
13078
  * @extends {BaseEntity}
12976
13079
  * @class
@@ -13009,6 +13112,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13009
13112
  * * Display Name: Executed At
13010
13113
  * * SQL Data Type: datetime
13011
13114
  * * Default Value: getdate()
13115
+ * * Description: Timestamp when this API call was executed during the integration run.
13012
13116
  */
13013
13117
  get ExecutedAt(): Date;
13014
13118
  set ExecutedAt(value: Date);
@@ -13017,6 +13121,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13017
13121
  * * Display Name: Is Success
13018
13122
  * * SQL Data Type: bit
13019
13123
  * * Default Value: 0
13124
+ * * Description: Indicates whether the API call completed successfully or encountered an error.
13020
13125
  */
13021
13126
  get IsSuccess(): boolean;
13022
13127
  set IsSuccess(value: boolean);
@@ -13033,18 +13138,21 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13033
13138
  * * PATCH
13034
13139
  * * HEAD
13035
13140
  * * OPTIONS
13141
+ * * Description: HTTP method used for the API call (GET, POST, PUT, DELETE, PATCH).
13036
13142
  */
13037
13143
  get RequestMethod(): 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null;
13038
13144
  set RequestMethod(value: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null);
13039
13145
  /**
13040
13146
  * * Field Name: URL
13041
13147
  * * SQL Data Type: nvarchar(MAX)
13148
+ * * Description: The complete URL that was called, including query parameters.
13042
13149
  */
13043
13150
  get URL(): string | null;
13044
13151
  set URL(value: string | null);
13045
13152
  /**
13046
13153
  * * Field Name: Parameters
13047
13154
  * * SQL Data Type: nvarchar(MAX)
13155
+ * * Description: JSON-formatted request body or parameters sent with the API call.
13048
13156
  */
13049
13157
  get Parameters(): string | null;
13050
13158
  set Parameters(value: string | null);
@@ -13068,6 +13176,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity<Compan
13068
13176
  * * Schema: __mj
13069
13177
  * * Base Table: CompanyIntegrationRunDetail
13070
13178
  * * Base View: vwCompanyIntegrationRunDetails
13179
+ * * @description Tracks individual record-level operations within an integration run, including success/failure status and error details for each processed item.
13071
13180
  * * Primary Key: ID
13072
13181
  * @extends {BaseEntity}
13073
13182
  * @class
@@ -13113,12 +13222,14 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13113
13222
  * * Field Name: RecordID
13114
13223
  * * Display Name: Record
13115
13224
  * * SQL Data Type: nvarchar(450)
13225
+ * * Description: The ID of the specific record being processed in this integration operation.
13116
13226
  */
13117
13227
  get RecordID(): string;
13118
13228
  set RecordID(value: string);
13119
13229
  /**
13120
13230
  * * Field Name: Action
13121
13231
  * * SQL Data Type: nchar(20)
13232
+ * * Description: The type of operation performed (INSERT, UPDATE, DELETE, SYNC).
13122
13233
  */
13123
13234
  get Action(): string;
13124
13235
  set Action(value: string);
@@ -13127,6 +13238,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13127
13238
  * * Display Name: Executed At
13128
13239
  * * SQL Data Type: datetime
13129
13240
  * * Default Value: getdate()
13241
+ * * Description: Timestamp when this specific record operation was executed.
13130
13242
  */
13131
13243
  get ExecutedAt(): Date;
13132
13244
  set ExecutedAt(value: Date);
@@ -13135,6 +13247,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13135
13247
  * * Display Name: Is Success
13136
13248
  * * SQL Data Type: bit
13137
13249
  * * Default Value: 0
13250
+ * * Description: Indicates whether this individual record operation succeeded or failed.
13138
13251
  */
13139
13252
  get IsSuccess(): boolean;
13140
13253
  set IsSuccess(value: boolean);
@@ -13175,6 +13288,7 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity<Compan
13175
13288
  * * Schema: __mj
13176
13289
  * * Base Table: CompanyIntegrationRun
13177
13290
  * * Base View: vwCompanyIntegrationRuns
13291
+ * * @description Records execution history of company integrations, including start/end times, overall status, and aggregate statistics for monitoring and troubleshooting.
13178
13292
  * * Primary Key: ID
13179
13293
  * @extends {BaseEntity}
13180
13294
  * @class
@@ -13234,6 +13348,7 @@ export declare class CompanyIntegrationRunEntity extends BaseEntity<CompanyInteg
13234
13348
  * * Field Name: TotalRecords
13235
13349
  * * Display Name: Total Records
13236
13350
  * * SQL Data Type: int
13351
+ * * Description: The total number of records processed during this integration run.
13237
13352
  */
13238
13353
  get TotalRecords(): number;
13239
13354
  set TotalRecords(value: number);
@@ -13358,6 +13473,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13358
13473
  * * Field Name: IsActive
13359
13474
  * * Display Name: Is Active
13360
13475
  * * SQL Data Type: bit
13476
+ * * Description: Controls whether this integration is currently active for the company.
13361
13477
  */
13362
13478
  get IsActive(): boolean | null;
13363
13479
  set IsActive(value: boolean | null);
@@ -13365,6 +13481,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13365
13481
  * * Field Name: AccessToken
13366
13482
  * * Display Name: Access Token
13367
13483
  * * SQL Data Type: nvarchar(255)
13484
+ * * Description: OAuth access token for authenticating with the external system.
13368
13485
  */
13369
13486
  get AccessToken(): string | null;
13370
13487
  set AccessToken(value: string | null);
@@ -13372,6 +13489,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13372
13489
  * * Field Name: RefreshToken
13373
13490
  * * Display Name: Refresh Token
13374
13491
  * * SQL Data Type: nvarchar(255)
13492
+ * * Description: OAuth refresh token used to obtain new access tokens when they expire.
13375
13493
  */
13376
13494
  get RefreshToken(): string | null;
13377
13495
  set RefreshToken(value: string | null);
@@ -13379,12 +13497,14 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13379
13497
  * * Field Name: TokenExpirationDate
13380
13498
  * * Display Name: Token Expiration Date
13381
13499
  * * SQL Data Type: datetime
13500
+ * * Description: Timestamp when the current access token expires and needs to be refreshed.
13382
13501
  */
13383
13502
  get TokenExpirationDate(): Date | null;
13384
13503
  set TokenExpirationDate(value: Date | null);
13385
13504
  /**
13386
13505
  * * Field Name: APIKey
13387
13506
  * * SQL Data Type: nvarchar(255)
13507
+ * * Description: API key for systems using key-based authentication instead of OAuth.
13388
13508
  */
13389
13509
  get APIKey(): string | null;
13390
13510
  set APIKey(value: string | null);
@@ -13392,6 +13512,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13392
13512
  * * Field Name: ExternalSystemID
13393
13513
  * * Display Name: ExternalSystem
13394
13514
  * * SQL Data Type: nvarchar(100)
13515
+ * * Description: The company's identifier in the external system, used for API calls.
13395
13516
  */
13396
13517
  get ExternalSystemID(): string | null;
13397
13518
  set ExternalSystemID(value: string | null);
@@ -13400,6 +13521,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13400
13521
  * * Display Name: Is External System Read Only
13401
13522
  * * SQL Data Type: bit
13402
13523
  * * Default Value: 0
13524
+ * * Description: Indicates if data can only be read from the external system, not written back.
13403
13525
  */
13404
13526
  get IsExternalSystemReadOnly(): boolean;
13405
13527
  set IsExternalSystemReadOnly(value: boolean);
@@ -13407,6 +13529,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13407
13529
  * * Field Name: ClientID
13408
13530
  * * Display Name: Client
13409
13531
  * * SQL Data Type: nvarchar(255)
13532
+ * * Description: OAuth client ID for this integration instance.
13410
13533
  */
13411
13534
  get ClientID(): string | null;
13412
13535
  set ClientID(value: string | null);
@@ -13414,6 +13537,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13414
13537
  * * Field Name: ClientSecret
13415
13538
  * * Display Name: Client Secret
13416
13539
  * * SQL Data Type: nvarchar(255)
13540
+ * * Description: OAuth client secret for authentication, should be encrypted at rest.
13417
13541
  */
13418
13542
  get ClientSecret(): string | null;
13419
13543
  set ClientSecret(value: string | null);
@@ -13421,6 +13545,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13421
13545
  * * Field Name: CustomAttribute1
13422
13546
  * * Display Name: Custom Attribute 1
13423
13547
  * * SQL Data Type: nvarchar(255)
13548
+ * * Description: Flexible field for storing integration-specific configuration or metadata.
13424
13549
  */
13425
13550
  get CustomAttribute1(): string | null;
13426
13551
  set CustomAttribute1(value: string | null);
@@ -13492,6 +13617,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity<CompanyIntegrat
13492
13617
  * * Schema: __mj
13493
13618
  * * Base Table: ContentFileType
13494
13619
  * * Base View: vwContentFileTypes
13620
+ * * @description Defines supported file types for content management, including extensions and processing rules for different content formats.
13495
13621
  * * Primary Key: ID
13496
13622
  * @extends {BaseEntity}
13497
13623
  * @class
@@ -13529,6 +13655,7 @@ export declare class ContentFileTypeEntity extends BaseEntity<ContentFileTypeEnt
13529
13655
  * * Field Name: FileExtension
13530
13656
  * * Display Name: File Extension
13531
13657
  * * SQL Data Type: nvarchar(255)
13658
+ * * Description: The file extension (e.g., .pdf, .docx, .jpg) used to identify this content type.
13532
13659
  */
13533
13660
  get FileExtension(): string | null;
13534
13661
  set FileExtension(value: string | null);
@@ -13552,6 +13679,7 @@ export declare class ContentFileTypeEntity extends BaseEntity<ContentFileTypeEnt
13552
13679
  * * Schema: __mj
13553
13680
  * * Base Table: ContentItemAttribute
13554
13681
  * * Base View: vwContentItemAttributes
13682
+ * * @description Stores metadata attributes extracted with prompting for content items, enabling flexible key-value properties and custom fields for content classification.
13555
13683
  * * Primary Key: ID
13556
13684
  * @extends {BaseEntity}
13557
13685
  * @class
@@ -13597,6 +13725,7 @@ export declare class ContentItemAttributeEntity extends BaseEntity<ContentItemAt
13597
13725
  * * Field Name: Value
13598
13726
  * * Display Name: Value
13599
13727
  * * SQL Data Type: nvarchar(MAX)
13728
+ * * Description: The extracted or assigned value for this attribute on the content item.
13600
13729
  */
13601
13730
  get Value(): string;
13602
13731
  set Value(value: string);
@@ -13626,6 +13755,7 @@ export declare class ContentItemAttributeEntity extends BaseEntity<ContentItemAt
13626
13755
  * * Schema: __mj
13627
13756
  * * Base Table: ContentItemTag
13628
13757
  * * Base View: vwContentItemTags
13758
+ * * @description Links tags to content items for categorization, searchability, and content discovery across the system.
13629
13759
  * * Primary Key: ID
13630
13760
  * @extends {BaseEntity}
13631
13761
  * @class
@@ -13664,6 +13794,7 @@ export declare class ContentItemTagEntity extends BaseEntity<ContentItemTagEntit
13664
13794
  * * Field Name: Tag
13665
13795
  * * Display Name: Tag
13666
13796
  * * SQL Data Type: nvarchar(200)
13797
+ * * Description: The tag text applied to the content item for categorization and search.
13667
13798
  */
13668
13799
  get Tag(): string;
13669
13800
  set Tag(value: string);
@@ -13693,6 +13824,7 @@ export declare class ContentItemTagEntity extends BaseEntity<ContentItemTagEntit
13693
13824
  * * Schema: __mj
13694
13825
  * * Base Table: ContentItem
13695
13826
  * * Base View: vwContentItems
13827
+ * * @description Stores extracted text from content assets, as well as the source location, versioning, and links to extracted tags and attributes.
13696
13828
  * * Primary Key: ID
13697
13829
  * @extends {BaseEntity}
13698
13830
  * @class
@@ -13769,6 +13901,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13769
13901
  * * Field Name: Checksum
13770
13902
  * * Display Name: Checksum
13771
13903
  * * SQL Data Type: nvarchar(100)
13904
+ * * Description: Hash value of the content used to detect changes and prevent duplicate processing.
13772
13905
  */
13773
13906
  get Checksum(): string | null;
13774
13907
  set Checksum(value: string | null);
@@ -13776,6 +13909,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13776
13909
  * * Field Name: URL
13777
13910
  * * Display Name: URL
13778
13911
  * * SQL Data Type: nvarchar(2000)
13912
+ * * Description: The source location URL where this content was retrieved from.
13779
13913
  */
13780
13914
  get URL(): string;
13781
13915
  set URL(value: string);
@@ -13783,6 +13917,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13783
13917
  * * Field Name: Text
13784
13918
  * * Display Name: Text
13785
13919
  * * SQL Data Type: nvarchar(MAX)
13920
+ * * Description: The extracted text content from the source document or file.
13786
13921
  */
13787
13922
  get Text(): string | null;
13788
13923
  set Text(value: string | null);
@@ -13830,6 +13965,7 @@ export declare class ContentItemEntity extends BaseEntity<ContentItemEntityType>
13830
13965
  * * Schema: __mj
13831
13966
  * * Base Table: ContentProcessRun
13832
13967
  * * Base View: vwContentProcessRuns
13968
+ * * @description Tracks execution of content tagging workflows, logging the status and details of each execution and ensuring efficient processing of content.
13833
13969
  * * Primary Key: ID
13834
13970
  * @extends {BaseEntity}
13835
13971
  * @class
@@ -13868,6 +14004,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13868
14004
  * * Field Name: StartTime
13869
14005
  * * Display Name: Start Time
13870
14006
  * * SQL Data Type: datetime
14007
+ * * Description: Timestamp when the content processing workflow began execution.
13871
14008
  */
13872
14009
  get StartTime(): Date | null;
13873
14010
  set StartTime(value: Date | null);
@@ -13875,6 +14012,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13875
14012
  * * Field Name: EndTime
13876
14013
  * * Display Name: End Time
13877
14014
  * * SQL Data Type: datetime
14015
+ * * Description: Timestamp when the content processing workflow completed or failed.
13878
14016
  */
13879
14017
  get EndTime(): Date | null;
13880
14018
  set EndTime(value: Date | null);
@@ -13889,6 +14027,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13889
14027
  * * Field Name: ProcessedItems
13890
14028
  * * Display Name: Processed Items
13891
14029
  * * SQL Data Type: int
14030
+ * * Description: Count of content items successfully processed during this run.
13892
14031
  */
13893
14032
  get ProcessedItems(): number | null;
13894
14033
  set ProcessedItems(value: number | null);
@@ -13918,6 +14057,7 @@ export declare class ContentProcessRunEntity extends BaseEntity<ContentProcessRu
13918
14057
  * * Schema: __mj
13919
14058
  * * Base Table: ContentSourceParam
13920
14059
  * * Base View: vwContentSourceParams
14060
+ * * @description Stores configuration parameters for specific content source instances, customizing how content is retrieved and processed from each source.
13921
14061
  * * Primary Key: ID
13922
14062
  * @extends {BaseEntity}
13923
14063
  * @class
@@ -13956,6 +14096,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13956
14096
  * * Field Name: ContentSourceTypeParamID
13957
14097
  * * Display Name: Content Source Type Param ID
13958
14098
  * * SQL Data Type: uniqueidentifier
14099
+ * * Description: Reference to the parameter definition in Content Source Type Params.
13959
14100
  */
13960
14101
  get ContentSourceTypeParamID(): string;
13961
14102
  set ContentSourceTypeParamID(value: string);
@@ -13963,6 +14104,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13963
14104
  * * Field Name: Value
13964
14105
  * * Display Name: Value
13965
14106
  * * SQL Data Type: nvarchar(MAX)
14107
+ * * Description: The configured value for this parameter on this specific content source.
13966
14108
  */
13967
14109
  get Value(): string;
13968
14110
  set Value(value: string);
@@ -13992,6 +14134,7 @@ export declare class ContentSourceParamEntity extends BaseEntity<ContentSourcePa
13992
14134
  * * Schema: __mj
13993
14135
  * * Base Table: ContentSourceTypeParam
13994
14136
  * * Base View: vwContentSourceTypeParams
14137
+ * * @description Defines required and optional parameters for content source types, establishing the configuration for each source type.
13995
14138
  * * Primary Key: ID
13996
14139
  * @extends {BaseEntity}
13997
14140
  * @class
@@ -14036,6 +14179,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14036
14179
  * * Field Name: Type
14037
14180
  * * Display Name: Type
14038
14181
  * * SQL Data Type: nvarchar(50)
14182
+ * * Description: Data type of the parameter (string, number, boolean, date, etc.).
14039
14183
  */
14040
14184
  get Type(): string | null;
14041
14185
  set Type(value: string | null);
@@ -14043,6 +14187,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14043
14187
  * * Field Name: DefaultValue
14044
14188
  * * Display Name: Default Value
14045
14189
  * * SQL Data Type: nvarchar(MAX)
14190
+ * * Description: Default value to use if not specified when configuring a content source.
14046
14191
  */
14047
14192
  get DefaultValue(): string | null;
14048
14193
  set DefaultValue(value: string | null);
@@ -14050,6 +14195,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14050
14195
  * * Field Name: IsRequired
14051
14196
  * * Display Name: Is Required
14052
14197
  * * SQL Data Type: bit
14198
+ * * Description: Indicates whether this parameter must be provided when setting up a content source.
14053
14199
  */
14054
14200
  get IsRequired(): boolean;
14055
14201
  set IsRequired(value: boolean);
@@ -14073,6 +14219,7 @@ export declare class ContentSourceTypeParamEntity extends BaseEntity<ContentSour
14073
14219
  * * Schema: __mj
14074
14220
  * * Base Table: ContentSourceType
14075
14221
  * * Base View: vwContentSourceTypes
14222
+ * * @description Catalogs available content source types such as file systems, APIs, websites, databases, and cloud storage platforms with their capabilities.
14076
14223
  * * Primary Key: ID
14077
14224
  * @extends {BaseEntity}
14078
14225
  * @class
@@ -14133,6 +14280,7 @@ export declare class ContentSourceTypeEntity extends BaseEntity<ContentSourceTyp
14133
14280
  * * Schema: __mj
14134
14281
  * * Base Table: ContentSource
14135
14282
  * * Base View: vwContentSources
14283
+ * * @description Configures connections to external content repositories and systems from which content is imported, synchronized, and tagged.
14136
14284
  * * Primary Key: ID
14137
14285
  * @extends {BaseEntity}
14138
14286
  * @class
@@ -14194,6 +14342,7 @@ export declare class ContentSourceEntity extends BaseEntity<ContentSourceEntityT
14194
14342
  * * Field Name: URL
14195
14343
  * * Display Name: URL
14196
14344
  * * SQL Data Type: nvarchar(2000)
14345
+ * * Description: Base URL or connection string for accessing this content source.
14197
14346
  */
14198
14347
  get URL(): string;
14199
14348
  set URL(value: string);
@@ -14235,6 +14384,7 @@ export declare class ContentSourceEntity extends BaseEntity<ContentSourceEntityT
14235
14384
  * * Schema: __mj
14236
14385
  * * Base Table: ContentTypeAttribute
14237
14386
  * * Base View: vwContentTypeAttributes
14387
+ * * @description Defines the attributes available for extraction via prompt for each content type.
14238
14388
  * * Primary Key: ID
14239
14389
  * @extends {BaseEntity}
14240
14390
  * @class
@@ -14265,6 +14415,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14265
14415
  * * Field Name: ContentTypeID
14266
14416
  * * Display Name: Content Type ID
14267
14417
  * * SQL Data Type: uniqueidentifier
14418
+ * * Description: Reference to the Content Type this attribute belongs to.
14268
14419
  */
14269
14420
  get ContentTypeID(): string;
14270
14421
  set ContentTypeID(value: string);
@@ -14279,6 +14430,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14279
14430
  * * Field Name: Prompt
14280
14431
  * * Display Name: Prompt
14281
14432
  * * SQL Data Type: nvarchar(MAX)
14433
+ * * Description: The AI prompt template used to extract this attribute from content.
14282
14434
  */
14283
14435
  get Prompt(): string;
14284
14436
  set Prompt(value: string);
@@ -14309,6 +14461,7 @@ export declare class ContentTypeAttributeEntity extends BaseEntity<ContentTypeAt
14309
14461
  * * Schema: __mj
14310
14462
  * * Base Table: ContentType
14311
14463
  * * Base View: vwContentTypes
14464
+ * * @description Defines categories of content with specific schemas, behaviors, and processing rules for structured content management.
14312
14465
  * * Primary Key: ID
14313
14466
  * @extends {BaseEntity}
14314
14467
  * @class
@@ -14361,6 +14514,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14361
14514
  * * Field Name: MinTags
14362
14515
  * * Display Name: Min Tags
14363
14516
  * * SQL Data Type: int
14517
+ * * Description: Minimum number of tags that must be applied to content of this type.
14364
14518
  */
14365
14519
  get MinTags(): number;
14366
14520
  set MinTags(value: number);
@@ -14368,6 +14522,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14368
14522
  * * Field Name: MaxTags
14369
14523
  * * Display Name: Max Tags
14370
14524
  * * SQL Data Type: int
14525
+ * * Description: Maximum number of tags allowed on content of this type.
14371
14526
  */
14372
14527
  get MaxTags(): number;
14373
14528
  set MaxTags(value: number);
@@ -14397,6 +14552,7 @@ export declare class ContentTypeEntity extends BaseEntity<ContentTypeEntityType>
14397
14552
  * * Schema: __mj
14398
14553
  * * Base Table: ConversationDetail
14399
14554
  * * Base View: vwConversationDetails
14555
+ * * @description Stores individual messages, responses, and interactions within a conversation, maintaining the complete dialogue history with timestamps.
14400
14556
  * * Primary Key: ID
14401
14557
  * @extends {BaseEntity}
14402
14558
  * @class
@@ -14450,6 +14606,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14450
14606
  * * Field Name: ExternalID
14451
14607
  * * Display Name: External ID
14452
14608
  * * SQL Data Type: nvarchar(100)
14609
+ * * Description: External system identifier for this message, used for integration scenarios.
14453
14610
  */
14454
14611
  get ExternalID(): string | null;
14455
14612
  set ExternalID(value: string | null);
@@ -14463,6 +14620,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14463
14620
  * * User
14464
14621
  * * AI
14465
14622
  * * Error
14623
+ * * Description: The role of the message sender (user, assistant, system, function).
14466
14624
  */
14467
14625
  get Role(): 'User' | 'AI' | 'Error';
14468
14626
  set Role(value: 'User' | 'AI' | 'Error');
@@ -14470,6 +14628,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14470
14628
  * * Field Name: Message
14471
14629
  * * Display Name: Message
14472
14630
  * * SQL Data Type: nvarchar(MAX)
14631
+ * * Description: The actual content of the message in the conversation.
14473
14632
  */
14474
14633
  get Message(): string;
14475
14634
  set Message(value: string);
@@ -14477,6 +14636,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14477
14636
  * * Field Name: Error
14478
14637
  * * Display Name: Error
14479
14638
  * * SQL Data Type: nvarchar(MAX)
14639
+ * * Description: Error message if this conversation turn encountered a problem.
14480
14640
  */
14481
14641
  get Error(): string | null;
14482
14642
  set Error(value: string | null);
@@ -14485,6 +14645,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14485
14645
  * * Display Name: Hidden To User
14486
14646
  * * SQL Data Type: bit
14487
14647
  * * Default Value: 0
14648
+ * * Description: Flag indicating if this message should be hidden from end users (system messages, function calls, etc.).
14488
14649
  */
14489
14650
  get HiddenToUser(): boolean;
14490
14651
  set HiddenToUser(value: boolean);
@@ -14593,6 +14754,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
14593
14754
  * * Schema: __mj
14594
14755
  * * Base Table: Conversation
14595
14756
  * * Base View: vwConversations
14757
+ * * @description Tracks conversation sessions between users and AI agents or between users, including context, participants, and metadata.
14596
14758
  * * Primary Key: ID
14597
14759
  * @extends {BaseEntity}
14598
14760
  * @class
@@ -14631,6 +14793,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14631
14793
  * * Field Name: ExternalID
14632
14794
  * * Display Name: External ID
14633
14795
  * * SQL Data Type: nvarchar(500)
14796
+ * * Description: External system identifier for cross-system conversation tracking.
14634
14797
  */
14635
14798
  get ExternalID(): string | null;
14636
14799
  set ExternalID(value: string | null);
@@ -14653,6 +14816,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14653
14816
  * * Display Name: Type
14654
14817
  * * SQL Data Type: nvarchar(50)
14655
14818
  * * Default Value: Skip
14819
+ * * Description: The type or category of conversation (Skip, Support, Chat, etc.).
14656
14820
  */
14657
14821
  get Type(): string;
14658
14822
  set Type(value: string);
@@ -14661,6 +14825,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14661
14825
  * * Display Name: Is Archived
14662
14826
  * * SQL Data Type: bit
14663
14827
  * * Default Value: 0
14828
+ * * Description: Indicates if this conversation has been archived and should not appear in active lists.
14664
14829
  */
14665
14830
  get IsArchived(): boolean;
14666
14831
  set IsArchived(value: boolean);
@@ -14676,6 +14841,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14676
14841
  * * Field Name: LinkedRecordID
14677
14842
  * * Display Name: Linked Record ID
14678
14843
  * * SQL Data Type: nvarchar(500)
14844
+ * * Description: ID of a related record this conversation is about (support ticket, order, etc.).
14679
14845
  */
14680
14846
  get LinkedRecordID(): string | null;
14681
14847
  set LinkedRecordID(value: string | null);
@@ -14738,6 +14904,7 @@ export declare class ConversationEntity extends BaseEntity<ConversationEntityTyp
14738
14904
  * * Schema: __mj
14739
14905
  * * Base Table: DashboardCategory
14740
14906
  * * Base View: vwDashboardCategories
14907
+ * * @description Organizes dashboards into logical groupings for navigation and access control, supporting hierarchical categorization.
14741
14908
  * * Primary Key: ID
14742
14909
  * @extends {BaseEntity}
14743
14910
  * @class
@@ -14887,6 +15054,7 @@ export declare class DashboardEntity extends BaseEntity<DashboardEntityType> {
14887
15054
  * * Field Name: UIConfigDetails
14888
15055
  * * Display Name: UIConfig Details
14889
15056
  * * SQL Data Type: nvarchar(MAX)
15057
+ * * Description: JSON configuration defining the dashboard layout, widgets, data sources, and display options.
14890
15058
  */
14891
15059
  get UIConfigDetails(): string;
14892
15060
  set UIConfigDetails(value: string);
@@ -15206,6 +15374,7 @@ export declare class DataContextEntity extends BaseEntity<DataContextEntityType>
15206
15374
  * * Field Name: LastRefreshedAt
15207
15375
  * * Display Name: Last Refreshed At
15208
15376
  * * SQL Data Type: datetime
15377
+ * * Description: Timestamp of when the data in this context was last refreshed or recalculated.
15209
15378
  */
15210
15379
  get LastRefreshedAt(): Date | null;
15211
15380
  set LastRefreshedAt(value: Date | null);
@@ -15266,6 +15435,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15266
15435
  * * Field Name: Code
15267
15436
  * * Display Name: Code
15268
15437
  * * SQL Data Type: nvarchar(50)
15438
+ * * Description: Unique code identifier for this dataset item within its parent dataset.
15269
15439
  */
15270
15440
  get Code(): string;
15271
15441
  set Code(value: string);
@@ -15282,6 +15452,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15282
15452
  * * Display Name: Sequence
15283
15453
  * * SQL Data Type: int
15284
15454
  * * Default Value: 0
15455
+ * * Description: Order in which this item should be processed or displayed within the dataset.
15285
15456
  */
15286
15457
  get Sequence(): number;
15287
15458
  set Sequence(value: number);
@@ -15297,6 +15468,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15297
15468
  * * Field Name: WhereClause
15298
15469
  * * Display Name: Where Clause
15299
15470
  * * SQL Data Type: nvarchar(MAX)
15471
+ * * Description: SQL WHERE clause to filter data when this dataset item is sourced from a query.
15300
15472
  */
15301
15473
  get WhereClause(): string | null;
15302
15474
  set WhereClause(value: string | null);
@@ -15304,6 +15476,7 @@ export declare class DatasetItemEntity extends BaseEntity<DatasetItemEntityType>
15304
15476
  * * Field Name: DateFieldToCheck
15305
15477
  * * Display Name: Date Field To Check
15306
15478
  * * SQL Data Type: nvarchar(100)
15479
+ * * Description: The date field name used for incremental updates and change detection.
15307
15480
  */
15308
15481
  get DateFieldToCheck(): string;
15309
15482
  set DateFieldToCheck(value: string);
@@ -15415,6 +15588,7 @@ export declare class DatasetEntity extends BaseEntity<DatasetEntityType> {
15415
15588
  * * Schema: __mj
15416
15589
  * * Base Table: DuplicateRunDetailMatch
15417
15590
  * * Base View: vwDuplicateRunDetailMatches
15591
+ * * @description Records individual matching pairs of potentially duplicate records identified during a duplicate detection run with confidence scores.
15418
15592
  * * Primary Key: ID
15419
15593
  * @extends {BaseEntity}
15420
15594
  * @class
@@ -15466,6 +15640,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15466
15640
  * * Field Name: MatchRecordID
15467
15641
  * * Display Name: Match Record ID
15468
15642
  * * SQL Data Type: nvarchar(500)
15643
+ * * Description: The ID of the record identified as a potential duplicate match.
15469
15644
  */
15470
15645
  get MatchRecordID(): string;
15471
15646
  set MatchRecordID(value: string);
@@ -15483,6 +15658,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15483
15658
  * * Display Name: Matched At
15484
15659
  * * SQL Data Type: datetime
15485
15660
  * * Default Value: getdate()
15661
+ * * Description: Timestamp when this duplicate match was identified.
15486
15662
  */
15487
15663
  get MatchedAt(): Date;
15488
15664
  set MatchedAt(value: Date);
@@ -15491,6 +15667,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15491
15667
  * * Display Name: Action
15492
15668
  * * SQL Data Type: nvarchar(20)
15493
15669
  * * Default Value: Ignore
15670
+ * * Description: The action to take for this match (Ignore, Merge, Delete).
15494
15671
  */
15495
15672
  get Action(): string;
15496
15673
  set Action(value: string);
@@ -15504,6 +15681,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15504
15681
  * * Rejected
15505
15682
  * * Approved
15506
15683
  * * Pending
15684
+ * * Description: Current approval status of the proposed action (Pending, Approved, Rejected).
15507
15685
  */
15508
15686
  get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
15509
15687
  set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
@@ -15525,6 +15703,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15525
15703
  * * Error
15526
15704
  * * Complete
15527
15705
  * * Pending
15706
+ * * Description: Status of the merge operation if Action is Merge (Pending, Complete, Failed).
15528
15707
  */
15529
15708
  get MergeStatus(): 'Error' | 'Complete' | 'Pending';
15530
15709
  set MergeStatus(value: 'Error' | 'Complete' | 'Pending');
@@ -15533,6 +15712,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15533
15712
  * * Display Name: Merged At
15534
15713
  * * SQL Data Type: datetime
15535
15714
  * * Default Value: getdate()
15715
+ * * Description: Timestamp when records were merged, if applicable.
15536
15716
  */
15537
15717
  get MergedAt(): Date;
15538
15718
  set MergedAt(value: Date);
@@ -15556,6 +15736,7 @@ export declare class DuplicateRunDetailMatchEntity extends BaseEntity<DuplicateR
15556
15736
  * * Schema: __mj
15557
15737
  * * Base Table: DuplicateRunDetail
15558
15738
  * * Base View: vwDuplicateRunDetails
15739
+ * * @description Stores detailed results for each record analyzed in a duplicate detection run, including match status and processing metadata.
15559
15740
  * * Primary Key: ID
15560
15741
  * @extends {BaseEntity}
15561
15742
  * @class
@@ -15594,6 +15775,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15594
15775
  * * Field Name: RecordID
15595
15776
  * * Display Name: Record ID
15596
15777
  * * SQL Data Type: nvarchar(500)
15778
+ * * Description: The ID of the record being analyzed for duplicates.
15597
15779
  */
15598
15780
  get RecordID(): string;
15599
15781
  set RecordID(value: string);
@@ -15608,6 +15790,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15608
15790
  * * Skipped
15609
15791
  * * Complete
15610
15792
  * * Pending
15793
+ * * Description: Status of duplicate analysis for this record (Pending, Complete, Error).
15611
15794
  */
15612
15795
  get MatchStatus(): 'Error' | 'Skipped' | 'Complete' | 'Pending';
15613
15796
  set MatchStatus(value: 'Error' | 'Skipped' | 'Complete' | 'Pending');
@@ -15638,6 +15821,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15638
15821
  * * Complete
15639
15822
  * * Pending
15640
15823
  * * Not Applicable
15824
+ * * Description: Status of any merge operations for this record (Not Applicable, Pending, Complete, Failed).
15641
15825
  */
15642
15826
  get MergeStatus(): 'Error' | 'Complete' | 'Pending' | 'Not Applicable';
15643
15827
  set MergeStatus(value: 'Error' | 'Complete' | 'Pending' | 'Not Applicable');
@@ -15645,6 +15829,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15645
15829
  * * Field Name: MergeErrorMessage
15646
15830
  * * Display Name: Merge Error Message
15647
15831
  * * SQL Data Type: nvarchar(MAX)
15832
+ * * Description: Error details if merge operation failed for this record.
15648
15833
  */
15649
15834
  get MergeErrorMessage(): string | null;
15650
15835
  set MergeErrorMessage(value: string | null);
@@ -15668,6 +15853,7 @@ export declare class DuplicateRunDetailEntity extends BaseEntity<DuplicateRunDet
15668
15853
  * * Schema: __mj
15669
15854
  * * Base Table: DuplicateRun
15670
15855
  * * Base View: vwDuplicateRuns
15856
+ * * @description Manages execution of duplicate detection processes across entities, tracking configuration, progress, and summary results.
15671
15857
  * * Primary Key: ID
15672
15858
  * @extends {BaseEntity}
15673
15859
  * @class
@@ -15743,6 +15929,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15743
15929
  * * Rejected
15744
15930
  * * Approved
15745
15931
  * * Pending
15932
+ * * Description: Overall approval status for the duplicate run results (Pending, Approved, Rejected).
15746
15933
  */
15747
15934
  get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
15748
15935
  set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
@@ -15750,6 +15937,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15750
15937
  * * Field Name: ApprovalComments
15751
15938
  * * Display Name: Approval Comments
15752
15939
  * * SQL Data Type: nvarchar(MAX)
15940
+ * * Description: Comments or notes regarding the approval decision for this duplicate run.
15753
15941
  */
15754
15942
  get ApprovalComments(): string | null;
15755
15943
  set ApprovalComments(value: string | null);
@@ -15772,6 +15960,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15772
15960
  * * Complete
15773
15961
  * * In Progress
15774
15962
  * * Pending
15963
+ * * Description: Current processing status of the duplicate detection run (Pending, Running, Complete, Failed).
15775
15964
  */
15776
15965
  get ProcessingStatus(): 'Failed' | 'Complete' | 'In Progress' | 'Pending';
15777
15966
  set ProcessingStatus(value: 'Failed' | 'Complete' | 'In Progress' | 'Pending');
@@ -15779,6 +15968,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15779
15968
  * * Field Name: ProcessingErrorMessage
15780
15969
  * * Display Name: Processing Error Message
15781
15970
  * * SQL Data Type: nvarchar(MAX)
15971
+ * * Description: Error details if the duplicate detection run failed.
15782
15972
  */
15783
15973
  get ProcessingErrorMessage(): string | null;
15784
15974
  set ProcessingErrorMessage(value: string | null);
@@ -15826,6 +16016,7 @@ export declare class DuplicateRunEntity extends BaseEntity<DuplicateRunEntityTyp
15826
16016
  * * Schema: __mj
15827
16017
  * * Base Table: EmployeeCompanyIntegration
15828
16018
  * * Base View: vwEmployeeCompanyIntegrations
16019
+ * * @description Maps employees to their external identifiers in integrated systems, maintaining synchronization across platforms.
15829
16020
  * * Primary Key: ID
15830
16021
  * @extends {BaseEntity}
15831
16022
  * @class
@@ -15871,6 +16062,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15871
16062
  * * Field Name: ExternalSystemRecordID
15872
16063
  * * Display Name: External System Record
15873
16064
  * * SQL Data Type: nvarchar(750)
16065
+ * * Description: The employee's unique identifier in the external integrated system.
15874
16066
  */
15875
16067
  get ExternalSystemRecordID(): string;
15876
16068
  set ExternalSystemRecordID(value: string);
@@ -15879,6 +16071,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15879
16071
  * * Display Name: Is Active
15880
16072
  * * SQL Data Type: bit
15881
16073
  * * Default Value: 1
16074
+ * * Description: Indicates if this employee integration mapping is currently active.
15882
16075
  */
15883
16076
  get IsActive(): boolean;
15884
16077
  set IsActive(value: boolean);
@@ -15908,6 +16101,7 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity<Employe
15908
16101
  * * Schema: __mj
15909
16102
  * * Base Table: EmployeeRole
15910
16103
  * * Base View: vwEmployeeRoles
16104
+ * * @description Links employees to their assigned roles within the organization, managing role-based permissions and responsibilities.
15911
16105
  * * Primary Key: ID
15912
16106
  * @extends {BaseEntity}
15913
16107
  * @class
@@ -15976,6 +16170,7 @@ export declare class EmployeeRoleEntity extends BaseEntity<EmployeeRoleEntityTyp
15976
16170
  * * Schema: __mj
15977
16171
  * * Base Table: EmployeeSkill
15978
16172
  * * Base View: vwEmployeeSkills
16173
+ * * @description Tracks skills, competencies, and certifications associated with employees for resource planning and team composition.
15979
16174
  * * Primary Key: ID
15980
16175
  * @extends {BaseEntity}
15981
16176
  * @class
@@ -16075,12 +16270,14 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16075
16270
  * * Display Name: BCMID
16076
16271
  * * SQL Data Type: uniqueidentifier
16077
16272
  * * Default Value: newid()
16273
+ * * Description: Business Central Management ID - unique identifier for cross-system employee tracking.
16078
16274
  */
16079
16275
  get BCMID(): string;
16080
16276
  /**
16081
16277
  * * Field Name: FirstName
16082
16278
  * * Display Name: First Name
16083
16279
  * * SQL Data Type: nvarchar(30)
16280
+ * * Description: Employee's first name or given name.
16084
16281
  */
16085
16282
  get FirstName(): string;
16086
16283
  set FirstName(value: string);
@@ -16088,6 +16285,7 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16088
16285
  * * Field Name: LastName
16089
16286
  * * Display Name: Last Name
16090
16287
  * * SQL Data Type: nvarchar(50)
16288
+ * * Description: Employee's last name or surname.
16091
16289
  */
16092
16290
  get LastName(): string;
16093
16291
  set LastName(value: string);
@@ -16110,18 +16308,21 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16110
16308
  /**
16111
16309
  * * Field Name: Title
16112
16310
  * * SQL Data Type: nvarchar(50)
16311
+ * * Description: Employee's job title or position within the organization.
16113
16312
  */
16114
16313
  get Title(): string | null;
16115
16314
  set Title(value: string | null);
16116
16315
  /**
16117
16316
  * * Field Name: Email
16118
16317
  * * SQL Data Type: nvarchar(100)
16318
+ * * Description: Employee's primary email address, must be unique across the system.
16119
16319
  */
16120
16320
  get Email(): string;
16121
16321
  set Email(value: string);
16122
16322
  /**
16123
16323
  * * Field Name: Phone
16124
16324
  * * SQL Data Type: nvarchar(20)
16325
+ * * Description: Employee's primary phone number for business contact.
16125
16326
  */
16126
16327
  get Phone(): string | null;
16127
16328
  set Phone(value: string | null);
@@ -16129,6 +16330,7 @@ export declare class EmployeeEntity extends BaseEntity<EmployeeEntityType> {
16129
16330
  * * Field Name: Active
16130
16331
  * * SQL Data Type: bit
16131
16332
  * * Default Value: 1
16333
+ * * Description: Indicates whether the employee is currently active in the organization.
16132
16334
  */
16133
16335
  get Active(): boolean;
16134
16336
  set Active(value: boolean);
@@ -16241,6 +16443,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16241
16443
  * * Field Name: NameSuffix
16242
16444
  * * Display Name: Name Suffix
16243
16445
  * * SQL Data Type: nvarchar(255)
16446
+ * * Description: Optional suffix appended to entity names for display purposes.
16244
16447
  */
16245
16448
  get NameSuffix(): string | null;
16246
16449
  set NameSuffix(value: string | null);
@@ -16263,12 +16466,14 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16263
16466
  * * Field Name: BaseTable
16264
16467
  * * Display Name: Base Table
16265
16468
  * * SQL Data Type: nvarchar(255)
16469
+ * * Description: The underlying database table name for this entity.
16266
16470
  */
16267
16471
  get BaseTable(): string;
16268
16472
  /**
16269
16473
  * * Field Name: BaseView
16270
16474
  * * Display Name: Base View
16271
16475
  * * SQL Data Type: nvarchar(255)
16476
+ * * Description: The "wrapper" database view used for querying this entity with joins and computed fields.
16272
16477
  */
16273
16478
  get BaseView(): string;
16274
16479
  set BaseView(value: string);
@@ -16286,6 +16491,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16286
16491
  * * Display Name: Schema Name
16287
16492
  * * SQL Data Type: nvarchar(255)
16288
16493
  * * Default Value: dbo
16494
+ * * Description: Database schema containing this entity's table and view.
16289
16495
  */
16290
16496
  get SchemaName(): string;
16291
16497
  /**
@@ -16293,6 +16499,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16293
16499
  * * Display Name: Virtual Entity
16294
16500
  * * SQL Data Type: bit
16295
16501
  * * Default Value: 0
16502
+ * * Description: Indicates if this is a virtual entity without a physical database table.
16296
16503
  */
16297
16504
  get VirtualEntity(): boolean;
16298
16505
  set VirtualEntity(value: boolean);
@@ -16391,6 +16598,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16391
16598
  * * Display Name: Full Text Search Enabled
16392
16599
  * * SQL Data Type: bit
16393
16600
  * * Default Value: 0
16601
+ * * Description: Whether full-text search indexing is enabled for this entity.
16394
16602
  */
16395
16603
  get FullTextSearchEnabled(): boolean;
16396
16604
  set FullTextSearchEnabled(value: boolean);
@@ -16398,6 +16606,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16398
16606
  * * Field Name: FullTextCatalog
16399
16607
  * * Display Name: Full Text Catalog
16400
16608
  * * SQL Data Type: nvarchar(255)
16609
+ * * Description: Name of the SQL Server full-text catalog if search is enabled.
16401
16610
  */
16402
16611
  get FullTextCatalog(): string | null;
16403
16612
  set FullTextCatalog(value: string | null);
@@ -16406,6 +16615,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16406
16615
  * * Display Name: Full Text Catalog Generated
16407
16616
  * * SQL Data Type: bit
16408
16617
  * * Default Value: 1
16618
+ * * Description: Indicates if the full-text catalog was auto-generated by CodeGen.
16409
16619
  */
16410
16620
  get FullTextCatalogGenerated(): boolean;
16411
16621
  set FullTextCatalogGenerated(value: boolean);
@@ -16413,6 +16623,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16413
16623
  * * Field Name: FullTextIndex
16414
16624
  * * Display Name: Full Text Index
16415
16625
  * * SQL Data Type: nvarchar(255)
16626
+ * * Description: Name of the full-text index on this entity's table.
16416
16627
  */
16417
16628
  get FullTextIndex(): string | null;
16418
16629
  set FullTextIndex(value: string | null);
@@ -16421,6 +16632,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16421
16632
  * * Display Name: Full Text Index Generated
16422
16633
  * * SQL Data Type: bit
16423
16634
  * * Default Value: 1
16635
+ * * Description: Indicates if the full-text index was auto-generated by CodeGen.
16424
16636
  */
16425
16637
  get FullTextIndexGenerated(): boolean;
16426
16638
  set FullTextIndexGenerated(value: boolean);
@@ -16428,6 +16640,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16428
16640
  * * Field Name: FullTextSearchFunction
16429
16641
  * * Display Name: Full Text Search Function
16430
16642
  * * SQL Data Type: nvarchar(255)
16643
+ * * Description: Name of the function used for full-text searching this entity.
16431
16644
  */
16432
16645
  get FullTextSearchFunction(): string | null;
16433
16646
  set FullTextSearchFunction(value: string | null);
@@ -16436,6 +16649,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16436
16649
  * * Display Name: Full Text Search Function Generated
16437
16650
  * * SQL Data Type: bit
16438
16651
  * * Default Value: 1
16652
+ * * Description: Indicates if the search function was auto-generated by CodeGen.
16439
16653
  */
16440
16654
  get FullTextSearchFunctionGenerated(): boolean;
16441
16655
  set FullTextSearchFunctionGenerated(value: boolean);
@@ -16444,6 +16658,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16444
16658
  * * Display Name: User View Max Rows
16445
16659
  * * SQL Data Type: int
16446
16660
  * * Default Value: 1000
16661
+ * * Description: Maximum number of rows to return in user-created views for this entity.
16447
16662
  */
16448
16663
  get UserViewMaxRows(): number | null;
16449
16664
  set UserViewMaxRows(value: number | null);
@@ -16451,6 +16666,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16451
16666
  * * Field Name: spCreate
16452
16667
  * * Display Name: spCreate
16453
16668
  * * SQL Data Type: nvarchar(255)
16669
+ * * Description: Name of the stored procedure for creating records in this entity.
16454
16670
  */
16455
16671
  get spCreate(): string | null;
16456
16672
  set spCreate(value: string | null);
@@ -16458,6 +16674,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16458
16674
  * * Field Name: spUpdate
16459
16675
  * * Display Name: spUpdate
16460
16676
  * * SQL Data Type: nvarchar(255)
16677
+ * * Description: Name of the stored procedure for updating records in this entity.
16461
16678
  */
16462
16679
  get spUpdate(): string | null;
16463
16680
  set spUpdate(value: string | null);
@@ -16465,6 +16682,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16465
16682
  * * Field Name: spDelete
16466
16683
  * * Display Name: spDelete
16467
16684
  * * SQL Data Type: nvarchar(255)
16685
+ * * Description: Name of the stored procedure for deleting records in this entity.
16468
16686
  */
16469
16687
  get spDelete(): string | null;
16470
16688
  set spDelete(value: string | null);
@@ -16473,6 +16691,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16473
16691
  * * Display Name: sp CreateGenerated
16474
16692
  * * SQL Data Type: bit
16475
16693
  * * Default Value: 1
16694
+ * * Description: Indicates if the create procedure was auto-generated by CodeGen.
16476
16695
  */
16477
16696
  get spCreateGenerated(): boolean;
16478
16697
  set spCreateGenerated(value: boolean);
@@ -16481,6 +16700,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16481
16700
  * * Display Name: sp Update Generated
16482
16701
  * * SQL Data Type: bit
16483
16702
  * * Default Value: 1
16703
+ * * Description: Indicates if the update procedure was auto-generated by CodeGen.
16484
16704
  */
16485
16705
  get spUpdateGenerated(): boolean;
16486
16706
  set spUpdateGenerated(value: boolean);
@@ -16489,6 +16709,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16489
16709
  * * Display Name: sp Delete Generated
16490
16710
  * * SQL Data Type: bit
16491
16711
  * * Default Value: 1
16712
+ * * Description: Indicates if the delete procedure was auto-generated by CodeGen.
16492
16713
  */
16493
16714
  get spDeleteGenerated(): boolean;
16494
16715
  set spDeleteGenerated(value: boolean);
@@ -16549,6 +16770,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16549
16770
  * * Display Name: User Form Generated
16550
16771
  * * SQL Data Type: bit
16551
16772
  * * Default Value: 1
16773
+ * * Description: Indicates if the default user form was auto-generated for this entity.
16552
16774
  */
16553
16775
  get UserFormGenerated(): boolean;
16554
16776
  set UserFormGenerated(value: boolean);
@@ -16556,6 +16778,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16556
16778
  * * Field Name: EntityObjectSubclassName
16557
16779
  * * Display Name: Entity Object Subclass Name
16558
16780
  * * SQL Data Type: nvarchar(255)
16781
+ * * Description: TypeScript class name for the entity subclass in the codebase.
16559
16782
  */
16560
16783
  get EntityObjectSubclassName(): string | null;
16561
16784
  set EntityObjectSubclassName(value: string | null);
@@ -16563,6 +16786,7 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
16563
16786
  * * Field Name: EntityObjectSubclassImport
16564
16787
  * * Display Name: Entity Object Subclass Import
16565
16788
  * * SQL Data Type: nvarchar(255)
16789
+ * * Description: Import path for the entity subclass in the TypeScript codebase.
16566
16790
  */
16567
16791
  get EntityObjectSubclassImport(): string | null;
16568
16792
  set EntityObjectSubclassImport(value: string | null);
@@ -16862,6 +17086,7 @@ export declare class EntityActionInvocationTypeEntity extends BaseEntity<EntityA
16862
17086
  * * Display Name: Display Sequence
16863
17087
  * * SQL Data Type: int
16864
17088
  * * Default Value: 0
17089
+ * * Description: Order in which this invocation type appears in UI lists and menus.
16865
17090
  */
16866
17091
  get DisplaySequence(): number;
16867
17092
  set DisplaySequence(value: number);
@@ -17219,6 +17444,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17219
17444
  * * Field Name: Prompt
17220
17445
  * * Display Name: Prompt
17221
17446
  * * SQL Data Type: nvarchar(MAX)
17447
+ * * Description: The AI prompt template used when this action is triggered by entity changes.
17222
17448
  */
17223
17449
  get Prompt(): string | null;
17224
17450
  set Prompt(value: string | null);
@@ -17231,6 +17457,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17231
17457
  * * Possible Values
17232
17458
  * * after save
17233
17459
  * * before save
17460
+ * * Description: The entity event that triggers this AI action (After Save, Before Delete, etc.).
17234
17461
  */
17235
17462
  get TriggerEvent(): 'after save' | 'before save';
17236
17463
  set TriggerEvent(value: 'after save' | 'before save');
@@ -17238,6 +17465,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17238
17465
  * * Field Name: UserMessage
17239
17466
  * * Display Name: User Message
17240
17467
  * * SQL Data Type: nvarchar(MAX)
17468
+ * * Description: Message shown to users when this AI action is executed.
17241
17469
  */
17242
17470
  get UserMessage(): string;
17243
17471
  set UserMessage(value: string);
@@ -17250,6 +17478,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17250
17478
  * * Possible Values
17251
17479
  * * entity
17252
17480
  * * field
17481
+ * * Description: Where the AI output should be stored (Field, Message, File).
17253
17482
  */
17254
17483
  get OutputType(): 'entity' | 'field';
17255
17484
  set OutputType(value: 'entity' | 'field');
@@ -17257,6 +17486,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17257
17486
  * * Field Name: OutputField
17258
17487
  * * Display Name: Output Field
17259
17488
  * * SQL Data Type: nvarchar(50)
17489
+ * * Description: The field name where AI output should be stored if OutputType is Field.
17260
17490
  */
17261
17491
  get OutputField(): string | null;
17262
17492
  set OutputField(value: string | null);
@@ -17265,6 +17495,7 @@ export declare class EntityAIActionEntity extends BaseEntity<EntityAIActionEntit
17265
17495
  * * Display Name: Skip If Output Field Not Empty
17266
17496
  * * SQL Data Type: bit
17267
17497
  * * Default Value: 1
17498
+ * * Description: Whether to skip AI processing if the output field already contains data.
17268
17499
  */
17269
17500
  get SkipIfOutputFieldNotEmpty(): boolean;
17270
17501
  set SkipIfOutputFieldNotEmpty(value: boolean);
@@ -17482,6 +17713,7 @@ export declare class EntityCommunicationMessageTypeEntity extends BaseEntity<Ent
17482
17713
  * * Schema: __mj
17483
17714
  * * Base Table: EntityDocumentRun
17484
17715
  * * Base View: vwEntityDocumentRuns
17716
+ * * @description Records execution history of document generation processes for entity records, tracking status, timing, and output details.
17485
17717
  * * Primary Key: ID
17486
17718
  * @extends {BaseEntity}
17487
17719
  * @class
@@ -17570,6 +17802,7 @@ export declare class EntityDocumentRunEntity extends BaseEntity<EntityDocumentRu
17570
17802
  * * Schema: __mj
17571
17803
  * * Base Table: EntityDocumentSetting
17572
17804
  * * Base View: vwEntityDocumentSettings
17805
+ * * @description Stores configuration for entity-specific document generation.
17573
17806
  * * Primary Key: ID
17574
17807
  * @extends {BaseEntity}
17575
17808
  * @class
@@ -17615,6 +17848,7 @@ export declare class EntityDocumentSettingEntity extends BaseEntity<EntityDocume
17615
17848
  * * Field Name: Value
17616
17849
  * * Display Name: Value
17617
17850
  * * SQL Data Type: nvarchar(MAX)
17851
+ * * Description: JSON configuration value for this document generation setting.
17618
17852
  */
17619
17853
  get Value(): string;
17620
17854
  set Value(value: string);
@@ -17651,6 +17885,7 @@ export declare class EntityDocumentSettingEntity extends BaseEntity<EntityDocume
17651
17885
  * * Schema: __mj
17652
17886
  * * Base Table: EntityDocumentType
17653
17887
  * * Base View: vwEntityDocumentTypes
17888
+ * * @description Defines types of documents that can be generated from entity data.
17654
17889
  * * Primary Key: ID
17655
17890
  * @extends {BaseEntity}
17656
17891
  * @class
@@ -17711,6 +17946,7 @@ export declare class EntityDocumentTypeEntity extends BaseEntity<EntityDocumentT
17711
17946
  * * Schema: __mj
17712
17947
  * * Base Table: EntityDocument
17713
17948
  * * Base View: vwEntityDocuments
17949
+ * * @description Stores templates for converting structured entity data into unstructured documents.
17714
17950
  * * Primary Key: ID
17715
17951
  * @extends {BaseEntity}
17716
17952
  * @class
@@ -17879,6 +18115,7 @@ export declare class EntityDocumentEntity extends BaseEntity<EntityDocumentEntit
17879
18115
  * * Schema: __mj
17880
18116
  * * Base Table: EntityFieldValue
17881
18117
  * * Base View: vwEntityFieldValues
18118
+ * * @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
18119
  * * Primary Key: ID
17883
18120
  * @extends {BaseEntity}
17884
18121
  * @class
@@ -17917,6 +18154,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17917
18154
  * * Field Name: Sequence
17918
18155
  * * Display Name: Sequence
17919
18156
  * * SQL Data Type: int
18157
+ * * Description: Display order for this value in dropdown lists and UI elements.
17920
18158
  */
17921
18159
  get Sequence(): number;
17922
18160
  set Sequence(value: number);
@@ -17924,6 +18162,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17924
18162
  * * Field Name: Value
17925
18163
  * * Display Name: Value
17926
18164
  * * SQL Data Type: nvarchar(255)
18165
+ * * Description: The actual value stored in the database for this option.
17927
18166
  */
17928
18167
  get Value(): string;
17929
18168
  set Value(value: string);
@@ -17931,6 +18170,7 @@ export declare class EntityFieldValueEntity extends BaseEntity<EntityFieldValueE
17931
18170
  * * Field Name: Code
17932
18171
  * * Display Name: Code
17933
18172
  * * SQL Data Type: nvarchar(50)
18173
+ * * Description: Optional code identifier for this value, useful for programmatic access. If not specified, same as Value
17934
18174
  */
17935
18175
  get Code(): string | null;
17936
18176
  set Code(value: string | null);
@@ -18313,6 +18553,7 @@ export declare class EntityFieldEntity extends BaseEntity<EntityFieldEntityType>
18313
18553
  * * Field Name: RelatedEntityNameFieldMap
18314
18554
  * * Display Name: Related Entity Name Field Map
18315
18555
  * * SQL Data Type: nvarchar(255)
18556
+ * * 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
18557
  */
18317
18558
  get RelatedEntityNameFieldMap(): string | null;
18318
18559
  set RelatedEntityNameFieldMap(value: string | null);
@@ -18522,6 +18763,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18522
18763
  * * Display Name: Can Create
18523
18764
  * * SQL Data Type: bit
18524
18765
  * * Default Value: 0
18766
+ * * Description: Whether the role/user can create new records in this entity.
18525
18767
  */
18526
18768
  get CanCreate(): boolean;
18527
18769
  set CanCreate(value: boolean);
@@ -18530,6 +18772,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18530
18772
  * * Display Name: Can Read
18531
18773
  * * SQL Data Type: bit
18532
18774
  * * Default Value: 0
18775
+ * * Description: Whether the role/user can read/view records in this entity.
18533
18776
  */
18534
18777
  get CanRead(): boolean;
18535
18778
  set CanRead(value: boolean);
@@ -18538,6 +18781,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18538
18781
  * * Display Name: Can Update
18539
18782
  * * SQL Data Type: bit
18540
18783
  * * Default Value: 0
18784
+ * * Description: Whether the role/user can update existing records in this entity.
18541
18785
  */
18542
18786
  get CanUpdate(): boolean;
18543
18787
  set CanUpdate(value: boolean);
@@ -18546,6 +18790,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18546
18790
  * * Display Name: Can Delete
18547
18791
  * * SQL Data Type: bit
18548
18792
  * * Default Value: 0
18793
+ * * Description: Whether the role/user can delete records from this entity.
18549
18794
  */
18550
18795
  get CanDelete(): boolean;
18551
18796
  set CanDelete(value: boolean);
@@ -18643,6 +18888,7 @@ export declare class EntityPermissionEntity extends BaseEntity<EntityPermissionE
18643
18888
  * * Schema: __mj
18644
18889
  * * Base Table: EntityRecordDocument
18645
18890
  * * Base View: vwEntityRecordDocuments
18891
+ * * @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
18892
  * * Primary Key: ID
18647
18893
  * @extends {BaseEntity}
18648
18894
  * @class
@@ -18681,6 +18927,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18681
18927
  * * Field Name: RecordID
18682
18928
  * * Display Name: Record ID
18683
18929
  * * SQL Data Type: nvarchar(450)
18930
+ * * Description: The ID of the entity record this document was generated for.
18684
18931
  */
18685
18932
  get RecordID(): string;
18686
18933
  set RecordID(value: string);
@@ -18696,6 +18943,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18696
18943
  * * Field Name: DocumentText
18697
18944
  * * Display Name: Document Text
18698
18945
  * * SQL Data Type: nvarchar(MAX)
18946
+ * * Description: The generated document text after template processing.
18699
18947
  */
18700
18948
  get DocumentText(): string | null;
18701
18949
  set DocumentText(value: string | null);
@@ -18711,6 +18959,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18711
18959
  * * Field Name: VectorID
18712
18960
  * * Display Name: Vector ID
18713
18961
  * * SQL Data Type: nvarchar(50)
18962
+ * * Description: Reference to the vector embedding of this document if AI search is enabled.
18714
18963
  */
18715
18964
  get VectorID(): string | null;
18716
18965
  set VectorID(value: string | null);
@@ -18718,6 +18967,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18718
18967
  * * Field Name: VectorJSON
18719
18968
  * * Display Name: Vector JSON
18720
18969
  * * SQL Data Type: nvarchar(MAX)
18970
+ * * Description: JSON representation of the vector embedding for this document.
18721
18971
  */
18722
18972
  get VectorJSON(): string | null;
18723
18973
  set VectorJSON(value: string | null);
@@ -18725,6 +18975,7 @@ export declare class EntityRecordDocumentEntity extends BaseEntity<EntityRecordD
18725
18975
  * * Field Name: EntityRecordUpdatedAt
18726
18976
  * * Display Name: Entity Record Updated At
18727
18977
  * * SQL Data Type: datetime
18978
+ * * Description: Timestamp of when the source entity record was last updated.
18728
18979
  */
18729
18980
  get EntityRecordUpdatedAt(): Date;
18730
18981
  set EntityRecordUpdatedAt(value: Date);
@@ -18896,6 +19147,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18896
19147
  * * Display Name: Bundle In API
18897
19148
  * * SQL Data Type: bit
18898
19149
  * * Default Value: 1
19150
+ * * Description: Whether to include related records when fetching the parent entity via API.
18899
19151
  */
18900
19152
  get BundleInAPI(): boolean;
18901
19153
  set BundleInAPI(value: boolean);
@@ -18904,6 +19156,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18904
19156
  * * Display Name: Include In Parent All Query
18905
19157
  * * SQL Data Type: bit
18906
19158
  * * Default Value: 0
19159
+ * * Description: Whether to include this relationship when querying all fields of the parent entity.
18907
19160
  */
18908
19161
  get IncludeInParentAllQuery(): boolean;
18909
19162
  set IncludeInParentAllQuery(value: boolean);
@@ -18915,6 +19168,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18915
19168
  * * Possible Values
18916
19169
  * * One To Many
18917
19170
  * * Many To Many
19171
+ * * Description: The cardinality of the relationship (One To Many, Many To Many, One To One).
18918
19172
  */
18919
19173
  get Type(): 'One To Many' | 'Many To Many';
18920
19174
  set Type(value: 'One To Many' | 'Many To Many');
@@ -18922,6 +19176,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18922
19176
  * * Field Name: EntityKeyField
18923
19177
  * * Display Name: Entity Key Field
18924
19178
  * * SQL Data Type: nvarchar(255)
19179
+ * * Description: The primary key field of the parent entity in this relationship.
18925
19180
  */
18926
19181
  get EntityKeyField(): string | null;
18927
19182
  set EntityKeyField(value: string | null);
@@ -18929,6 +19184,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18929
19184
  * * Field Name: RelatedEntityJoinField
18930
19185
  * * Display Name: Related Entity Join Field
18931
19186
  * * SQL Data Type: nvarchar(255)
19187
+ * * Description: The foreign key field in the related entity that references the parent.
18932
19188
  */
18933
19189
  get RelatedEntityJoinField(): string;
18934
19190
  set RelatedEntityJoinField(value: string);
@@ -18936,6 +19192,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18936
19192
  * * Field Name: JoinView
18937
19193
  * * Display Name: Join View
18938
19194
  * * SQL Data Type: nvarchar(255)
19195
+ * * Description: For many-to-many relationships, the view containing the junction data.
18939
19196
  */
18940
19197
  get JoinView(): string | null;
18941
19198
  set JoinView(value: string | null);
@@ -18943,6 +19200,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18943
19200
  * * Field Name: JoinEntityJoinField
18944
19201
  * * Display Name: Join Entity Join Field
18945
19202
  * * SQL Data Type: nvarchar(255)
19203
+ * * Description: For many-to-many, the field in the junction table linking to the parent entity.
18946
19204
  */
18947
19205
  get JoinEntityJoinField(): string | null;
18948
19206
  set JoinEntityJoinField(value: string | null);
@@ -18950,6 +19208,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18950
19208
  * * Field Name: JoinEntityInverseJoinField
18951
19209
  * * Display Name: Join Entity Inverse Join Field
18952
19210
  * * SQL Data Type: nvarchar(255)
19211
+ * * Description: For many-to-many, the field in the junction table linking to the related entity.
18953
19212
  */
18954
19213
  get JoinEntityInverseJoinField(): string | null;
18955
19214
  set JoinEntityInverseJoinField(value: string | null);
@@ -18971,6 +19230,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
18971
19230
  * * Possible Values
18972
19231
  * * After Field Tabs
18973
19232
  * * Before Field Tabs
19233
+ * * Description: Where to display this relationship in the UI relative to other entity elements.
18974
19234
  */
18975
19235
  get DisplayLocation(): 'After Field Tabs' | 'Before Field Tabs';
18976
19236
  set DisplayLocation(value: 'After Field Tabs' | 'Before Field Tabs');
@@ -19115,6 +19375,7 @@ export declare class EntityRelationshipEntity extends BaseEntity<EntityRelations
19115
19375
  * * Schema: __mj
19116
19376
  * * Base Table: EntitySetting
19117
19377
  * * Base View: vwEntitySettings
19378
+ * * @description Stores entity-specific configuration settings, allowing customization of how entities function.
19118
19379
  * * Primary Key: ID
19119
19380
  * @extends {BaseEntity}
19120
19381
  * @class
@@ -19160,6 +19421,7 @@ export declare class EntitySettingEntity extends BaseEntity<EntitySettingEntityT
19160
19421
  * * Field Name: Value
19161
19422
  * * Display Name: Value
19162
19423
  * * SQL Data Type: nvarchar(MAX)
19424
+ * * Description: The configuration value for this entity setting, often in JSON format.
19163
19425
  */
19164
19426
  get Value(): string;
19165
19427
  set Value(value: string);
@@ -19196,6 +19458,7 @@ export declare class EntitySettingEntity extends BaseEntity<EntitySettingEntityT
19196
19458
  * * Schema: __mj
19197
19459
  * * Base Table: ErrorLog
19198
19460
  * * Base View: vwErrorLogs
19461
+ * * @description Captures system errors, exceptions, and failures with stack traces, context, and debugging info.
19199
19462
  * * Primary Key: ID
19200
19463
  * @extends {BaseEntity}
19201
19464
  * @class
@@ -19240,12 +19503,14 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19240
19503
  /**
19241
19504
  * * Field Name: Code
19242
19505
  * * SQL Data Type: nchar(20)
19506
+ * * Description: Error code for categorizing and handling specific error types.
19243
19507
  */
19244
19508
  get Code(): string | null;
19245
19509
  set Code(value: string | null);
19246
19510
  /**
19247
19511
  * * Field Name: Message
19248
19512
  * * SQL Data Type: nvarchar(MAX)
19513
+ * * Description: The primary error message describing what went wrong.
19249
19514
  */
19250
19515
  get Message(): string | null;
19251
19516
  set Message(value: string | null);
@@ -19254,6 +19519,7 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19254
19519
  * * Display Name: Created By
19255
19520
  * * SQL Data Type: nvarchar(50)
19256
19521
  * * Default Value: suser_name()
19522
+ * * Description: User or system process that encountered this error.
19257
19523
  */
19258
19524
  get CreatedBy(): string | null;
19259
19525
  set CreatedBy(value: string | null);
@@ -19266,12 +19532,14 @@ export declare class ErrorLogEntity extends BaseEntity<ErrorLogEntityType> {
19266
19532
  /**
19267
19533
  * * Field Name: Category
19268
19534
  * * SQL Data Type: nvarchar(20)
19535
+ * * Description: High-level category for grouping related errors (Database, API, Validation, etc.).
19269
19536
  */
19270
19537
  get Category(): string | null;
19271
19538
  set Category(value: string | null);
19272
19539
  /**
19273
19540
  * * Field Name: Details
19274
19541
  * * SQL Data Type: nvarchar(MAX)
19542
+ * * Description: Full error details including stack trace, inner exceptions, and context data.
19275
19543
  */
19276
19544
  get Details(): string | null;
19277
19545
  set Details(value: string | null);
@@ -19433,6 +19701,7 @@ export declare class ExplorerNavigationItemEntity extends BaseEntity<ExplorerNav
19433
19701
  * * Schema: __mj
19434
19702
  * * Base Table: FileCategory
19435
19703
  * * Base View: vwFileCategories
19704
+ * * @description Organizes files into categories for classification, access control, and lifecycle management across the file storage system.
19436
19705
  * * Primary Key: ID
19437
19706
  * @extends {BaseEntity}
19438
19707
  * @class
@@ -19507,6 +19776,7 @@ export declare class FileCategoryEntity extends BaseEntity<FileCategoryEntityTyp
19507
19776
  * * Schema: __mj
19508
19777
  * * Base Table: FileEntityRecordLink
19509
19778
  * * Base View: vwFileEntityRecordLinks
19779
+ * * @description Associates files with entity records, enabling attachment management and document relationships throughout the system.
19510
19780
  * * Primary Key: ID
19511
19781
  * @extends {BaseEntity}
19512
19782
  * @class
@@ -19553,6 +19823,7 @@ export declare class FileEntityRecordLinkEntity extends BaseEntity<FileEntityRec
19553
19823
  * * Field Name: RecordID
19554
19824
  * * Display Name: Record ID
19555
19825
  * * SQL Data Type: nvarchar(750)
19826
+ * * Description: The ID of the entity record this file is attached to.
19556
19827
  */
19557
19828
  get RecordID(): string;
19558
19829
  set RecordID(value: string);
@@ -19588,6 +19859,7 @@ export declare class FileEntityRecordLinkEntity extends BaseEntity<FileEntityRec
19588
19859
  * * Schema: __mj
19589
19860
  * * Base Table: FileStorageProvider
19590
19861
  * * Base View: vwFileStorageProviders
19862
+ * * @description Configures connections to file storage systems including local, cloud, and network storage with authentication and access rules.
19591
19863
  * * Primary Key: ID
19592
19864
  * @extends {BaseEntity}
19593
19865
  * @class
@@ -19632,6 +19904,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19632
19904
  * * Field Name: ServerDriverKey
19633
19905
  * * Display Name: Server Driver Key
19634
19906
  * * SQL Data Type: nvarchar(100)
19907
+ * * Description: Identifier for the server-side driver implementation for this storage provider.
19635
19908
  */
19636
19909
  get ServerDriverKey(): string;
19637
19910
  set ServerDriverKey(value: string);
@@ -19639,6 +19912,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19639
19912
  * * Field Name: ClientDriverKey
19640
19913
  * * Display Name: Client Driver Key
19641
19914
  * * SQL Data Type: nvarchar(100)
19915
+ * * Description: Identifier for the client-side driver implementation for this storage provider.
19642
19916
  */
19643
19917
  get ClientDriverKey(): string;
19644
19918
  set ClientDriverKey(value: string);
@@ -19647,6 +19921,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19647
19921
  * * Display Name: Priority
19648
19922
  * * SQL Data Type: int
19649
19923
  * * Default Value: 0
19924
+ * * Description: Priority order for selecting storage providers, lower numbers are preferred.
19650
19925
  */
19651
19926
  get Priority(): number;
19652
19927
  set Priority(value: number);
@@ -19655,6 +19930,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19655
19930
  * * Display Name: Is Active
19656
19931
  * * SQL Data Type: bit
19657
19932
  * * Default Value: 1
19933
+ * * Description: Whether this storage provider is currently available for use.
19658
19934
  */
19659
19935
  get IsActive(): boolean;
19660
19936
  set IsActive(value: boolean);
@@ -19678,6 +19954,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
19678
19954
  * * Schema: __mj
19679
19955
  * * Base Table: File
19680
19956
  * * Base View: vwFiles
19957
+ * * @description Manages file metadata, storage locations, and access control for all files stored within or referenced by the system.
19681
19958
  * * Primary Key: ID
19682
19959
  * @extends {BaseEntity}
19683
19960
  * @class
@@ -19738,6 +20015,7 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
19738
20015
  * * Field Name: ContentType
19739
20016
  * * Display Name: Content Type
19740
20017
  * * SQL Data Type: nvarchar(255)
20018
+ * * Description: MIME type of the file content (e.g., image/jpeg, application/pdf).
19741
20019
  */
19742
20020
  get ContentType(): string | null;
19743
20021
  set ContentType(value: string | null);
@@ -19745,6 +20023,7 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
19745
20023
  * * Field Name: ProviderKey
19746
20024
  * * Display Name: Provider Key
19747
20025
  * * SQL Data Type: nvarchar(500)
20026
+ * * Description: Storage provider-specific identifier or path for this file.
19748
20027
  */
19749
20028
  get ProviderKey(): string | null;
19750
20029
  set ProviderKey(value: string | null);
@@ -19963,6 +20242,7 @@ export declare class GeneratedCodeEntity extends BaseEntity<GeneratedCodeEntityT
19963
20242
  * * Field Name: LinkedRecordPrimaryKey
19964
20243
  * * Display Name: Linked Record Primary Key
19965
20244
  * * SQL Data Type: nvarchar(MAX)
20245
+ * * Description: JSON containing the primary key(s) of the record this generated code is associated with.
19966
20246
  */
19967
20247
  get LinkedRecordPrimaryKey(): string | null;
19968
20248
  set LinkedRecordPrimaryKey(value: string | null);
@@ -20165,6 +20445,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20165
20445
  * * Field Name: NavigationBaseURL
20166
20446
  * * Display Name: Navigation Base URL
20167
20447
  * * SQL Data Type: nvarchar(500)
20448
+ * * Description: Base URL for navigating to records in the external system from MemberJunction.
20168
20449
  */
20169
20450
  get NavigationBaseURL(): string | null;
20170
20451
  set NavigationBaseURL(value: string | null);
@@ -20172,6 +20453,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20172
20453
  * * Field Name: ClassName
20173
20454
  * * Display Name: Class Name
20174
20455
  * * SQL Data Type: nvarchar(100)
20456
+ * * Description: The TypeScript/JavaScript class name implementing this integration.
20175
20457
  */
20176
20458
  get ClassName(): string | null;
20177
20459
  set ClassName(value: string | null);
@@ -20179,6 +20461,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20179
20461
  * * Field Name: ImportPath
20180
20462
  * * Display Name: Import Path
20181
20463
  * * SQL Data Type: nvarchar(100)
20464
+ * * Description: Module import path for the integration class in the codebase.
20182
20465
  */
20183
20466
  get ImportPath(): string | null;
20184
20467
  set ImportPath(value: string | null);
@@ -20187,6 +20470,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20187
20470
  * * Display Name: Batch Max Request Count
20188
20471
  * * SQL Data Type: int
20189
20472
  * * Default Value: -1
20473
+ * * Description: Maximum number of API requests to batch together, -1 for no limit.
20190
20474
  */
20191
20475
  get BatchMaxRequestCount(): number;
20192
20476
  set BatchMaxRequestCount(value: number);
@@ -20195,6 +20479,7 @@ export declare class IntegrationEntity extends BaseEntity<IntegrationEntityType>
20195
20479
  * * Display Name: Batch Request Wait Time
20196
20480
  * * SQL Data Type: int
20197
20481
  * * Default Value: -1
20482
+ * * Description: Milliseconds to wait before sending a batch of requests, -1 to disable batching.
20198
20483
  */
20199
20484
  get BatchRequestWaitTime(): number;
20200
20485
  set BatchRequestWaitTime(value: number);
@@ -20400,6 +20685,7 @@ export declare class LibraryItemEntity extends BaseEntity<LibraryItemEntityType>
20400
20685
  * * Schema: __mj
20401
20686
  * * Base Table: ListCategory
20402
20687
  * * Base View: vwListCategories
20688
+ * * @description Groups lists into categories for organization and navigation, supporting hierarchical categorization of user-created lists.
20403
20689
  * * Primary Key: ID
20404
20690
  * @extends {BaseEntity}
20405
20691
  * @class
@@ -20526,6 +20812,7 @@ export declare class ListDetailEntity extends BaseEntity<ListDetailEntityType> {
20526
20812
  * * Field Name: RecordID
20527
20813
  * * Display Name: Record
20528
20814
  * * SQL Data Type: nvarchar(445)
20815
+ * * Description: The ID of the record included in this list.
20529
20816
  */
20530
20817
  get RecordID(): string;
20531
20818
  set RecordID(value: string);
@@ -20533,6 +20820,7 @@ export declare class ListDetailEntity extends BaseEntity<ListDetailEntityType> {
20533
20820
  * * Field Name: Sequence
20534
20821
  * * SQL Data Type: int
20535
20822
  * * Default Value: 0
20823
+ * * Description: Order of this record within the list, for maintaining user-defined sorting.
20536
20824
  */
20537
20825
  get Sequence(): number;
20538
20826
  set Sequence(value: number);
@@ -20654,6 +20942,7 @@ export declare class ListEntity extends BaseEntity<ListEntityType> {
20654
20942
  * * Field Name: ExternalSystemRecordID
20655
20943
  * * Display Name: External System Record ID
20656
20944
  * * SQL Data Type: nvarchar(100)
20945
+ * * Description: Identifier for this list in an external system, used for synchronization.
20657
20946
  */
20658
20947
  get ExternalSystemRecordID(): string | null;
20659
20948
  set ExternalSystemRecordID(value: string | null);
@@ -23977,6 +24266,152 @@ export declare class DashboardUserStateEntity extends BaseEntity<DashboardUserSt
23977
24266
  */
23978
24267
  get User(): string;
23979
24268
  }
24269
+ /**
24270
+ * MJ: Query Parameters - strongly typed entity sub-class
24271
+ * * Schema: __mj
24272
+ * * Base Table: QueryParameter
24273
+ * * Base View: vwQueryParameters
24274
+ * * @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.
24275
+ * * Primary Key: ID
24276
+ * @extends {BaseEntity}
24277
+ * @class
24278
+ * @public
24279
+ */
24280
+ export declare class QueryParameterEntity extends BaseEntity<QueryParameterEntityType> {
24281
+ /**
24282
+ * Loads the MJ: Query Parameters record from the database
24283
+ * @param ID: string - primary key value to load the MJ: Query Parameters record.
24284
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
24285
+ * @returns {Promise<boolean>} - true if successful, false otherwise
24286
+ * @public
24287
+ * @async
24288
+ * @memberof QueryParameterEntity
24289
+ * @method
24290
+ * @override
24291
+ */
24292
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
24293
+ /**
24294
+ * * Field Name: ID
24295
+ * * Display Name: ID
24296
+ * * SQL Data Type: uniqueidentifier
24297
+ * * Default Value: newsequentialid()
24298
+ */
24299
+ get ID(): string;
24300
+ set ID(value: string);
24301
+ /**
24302
+ * * Field Name: QueryID
24303
+ * * Display Name: Query ID
24304
+ * * SQL Data Type: uniqueidentifier
24305
+ * * Related Entity/Foreign Key: Queries (vwQueries.ID)
24306
+ */
24307
+ get QueryID(): string;
24308
+ set QueryID(value: string);
24309
+ /**
24310
+ * * Field Name: Name
24311
+ * * Display Name: Name
24312
+ * * SQL Data Type: nvarchar(255)
24313
+ * * 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.
24314
+ */
24315
+ get Name(): string;
24316
+ set Name(value: string);
24317
+ /**
24318
+ * * Field Name: Type
24319
+ * * Display Name: Type
24320
+ * * SQL Data Type: nvarchar(50)
24321
+ * * Value List Type: List
24322
+ * * Possible Values
24323
+ * * string
24324
+ * * number
24325
+ * * date
24326
+ * * boolean
24327
+ * * array
24328
+ * * 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.
24329
+ */
24330
+ get Type(): 'string' | 'number' | 'date' | 'boolean' | 'array';
24331
+ set Type(value: 'string' | 'number' | 'date' | 'boolean' | 'array');
24332
+ /**
24333
+ * * Field Name: IsRequired
24334
+ * * Display Name: Is Required
24335
+ * * SQL Data Type: bit
24336
+ * * Default Value: 0
24337
+ * * 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.
24338
+ */
24339
+ get IsRequired(): boolean | null;
24340
+ set IsRequired(value: boolean | null);
24341
+ /**
24342
+ * * Field Name: DefaultValue
24343
+ * * Display Name: Default Value
24344
+ * * SQL Data Type: nvarchar(MAX)
24345
+ * * 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.
24346
+ */
24347
+ get DefaultValue(): string | null;
24348
+ set DefaultValue(value: string | null);
24349
+ /**
24350
+ * * Field Name: Description
24351
+ * * Display Name: Description
24352
+ * * SQL Data Type: nvarchar(MAX)
24353
+ * * 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.
24354
+ */
24355
+ get Description(): string | null;
24356
+ set Description(value: string | null);
24357
+ /**
24358
+ * * Field Name: SampleValue
24359
+ * * Display Name: Sample Value
24360
+ * * SQL Data Type: nvarchar(MAX)
24361
+ * * 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.
24362
+ */
24363
+ get SampleValue(): string | null;
24364
+ set SampleValue(value: string | null);
24365
+ /**
24366
+ * * Field Name: ValidationFilters
24367
+ * * Display Name: Validation Filters
24368
+ * * SQL Data Type: nvarchar(MAX)
24369
+ * * 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.
24370
+ */
24371
+ get ValidationFilters(): string | null;
24372
+ set ValidationFilters(value: string | null);
24373
+ /**
24374
+ * * Field Name: DetectionMethod
24375
+ * * Display Name: Detection Method
24376
+ * * SQL Data Type: nvarchar(50)
24377
+ * * Default Value: Manual
24378
+ * * Value List Type: List
24379
+ * * Possible Values
24380
+ * * AI
24381
+ * * Manual
24382
+ * * 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.
24383
+ */
24384
+ get DetectionMethod(): 'AI' | 'Manual';
24385
+ set DetectionMethod(value: 'AI' | 'Manual');
24386
+ /**
24387
+ * * Field Name: AutoDetectConfidenceScore
24388
+ * * Display Name: Auto Detect Confidence Score
24389
+ * * SQL Data Type: decimal(3, 2)
24390
+ * * 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.
24391
+ */
24392
+ get AutoDetectConfidenceScore(): number | null;
24393
+ set AutoDetectConfidenceScore(value: number | null);
24394
+ /**
24395
+ * * Field Name: __mj_CreatedAt
24396
+ * * Display Name: Created At
24397
+ * * SQL Data Type: datetimeoffset
24398
+ * * Default Value: getutcdate()
24399
+ */
24400
+ get __mj_CreatedAt(): Date;
24401
+ /**
24402
+ * * Field Name: __mj_UpdatedAt
24403
+ * * Display Name: Updated At
24404
+ * * SQL Data Type: datetimeoffset
24405
+ * * Default Value: getutcdate()
24406
+ */
24407
+ get __mj_UpdatedAt(): Date;
24408
+ /**
24409
+ * * Field Name: Query
24410
+ * * Display Name: Query
24411
+ * * SQL Data Type: nvarchar(255)
24412
+ */
24413
+ get Query(): string;
24414
+ }
23980
24415
  /**
23981
24416
  * MJ: Report User States - strongly typed entity sub-class
23982
24417
  * * Schema: __mj
@@ -24182,10 +24617,12 @@ export declare class ReportVersionEntity extends BaseEntity<ReportVersionEntityT
24182
24617
  * * Schema: __mj
24183
24618
  * * Base Table: OutputDeliveryType
24184
24619
  * * Base View: vwOutputDeliveryTypes
24620
+ * * @description Defines methods for delivering generated outputs such as email, file storage, API endpoints, or messaging platforms.
24185
24621
  * * Primary Key: ID
24186
24622
  * @extends {BaseEntity}
24187
24623
  * @class
24188
24624
  * @public
24625
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24189
24626
  */
24190
24627
  export declare class OutputDeliveryTypeEntity extends BaseEntity<OutputDeliveryTypeEntityType> {
24191
24628
  /**
@@ -24242,10 +24679,12 @@ export declare class OutputDeliveryTypeEntity extends BaseEntity<OutputDeliveryT
24242
24679
  * * Schema: __mj
24243
24680
  * * Base Table: OutputFormatType
24244
24681
  * * Base View: vwOutputFormatTypes
24682
+ * * @description Specifies available output formats for generated content including PDF, Excel, CSV, JSON, and custom formats.
24245
24683
  * * Primary Key: ID
24246
24684
  * @extends {BaseEntity}
24247
24685
  * @class
24248
24686
  * @public
24687
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24249
24688
  */
24250
24689
  export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeEntityType> {
24251
24690
  /**
@@ -24286,6 +24725,7 @@ export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeE
24286
24725
  * * Field Name: DisplayFormat
24287
24726
  * * Display Name: Display Format
24288
24727
  * * SQL Data Type: nvarchar(MAX)
24728
+ * * Description: Configuration or template for how data should be formatted in this output type.
24289
24729
  */
24290
24730
  get DisplayFormat(): string | null;
24291
24731
  set DisplayFormat(value: string | null);
@@ -24309,10 +24749,12 @@ export declare class OutputFormatTypeEntity extends BaseEntity<OutputFormatTypeE
24309
24749
  * * Schema: __mj
24310
24750
  * * Base Table: OutputTriggerType
24311
24751
  * * Base View: vwOutputTriggerTypes
24752
+ * * @description Defines events that can trigger output generation such as schedules, data changes, or manual requests.
24312
24753
  * * Primary Key: ID
24313
24754
  * @extends {BaseEntity}
24314
24755
  * @class
24315
24756
  * @public
24757
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
24316
24758
  */
24317
24759
  export declare class OutputTriggerTypeEntity extends BaseEntity<OutputTriggerTypeEntityType> {
24318
24760
  /**
@@ -24415,6 +24857,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24415
24857
  * * Field Name: UserQuestion
24416
24858
  * * Display Name: User Question
24417
24859
  * * SQL Data Type: nvarchar(MAX)
24860
+ * * Description: The natural language question this query answers, used for AI query selection.
24418
24861
  */
24419
24862
  get UserQuestion(): string | null;
24420
24863
  set UserQuestion(value: string | null);
@@ -24429,6 +24872,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24429
24872
  * * Field Name: SQL
24430
24873
  * * Display Name: SQL
24431
24874
  * * SQL Data Type: nvarchar(MAX)
24875
+ * * Description: The actual SQL query text to execute, may include parameters.
24432
24876
  */
24433
24877
  get SQL(): string | null;
24434
24878
  set SQL(value: string | null);
@@ -24436,6 +24880,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24436
24880
  * * Field Name: TechnicalDescription
24437
24881
  * * Display Name: Technical Description
24438
24882
  * * SQL Data Type: nvarchar(MAX)
24883
+ * * Description: Technical documentation of the query logic, performance considerations, and parameter usage.
24439
24884
  */
24440
24885
  get TechnicalDescription(): string | null;
24441
24886
  set TechnicalDescription(value: string | null);
@@ -24443,6 +24888,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24443
24888
  * * Field Name: OriginalSQL
24444
24889
  * * Display Name: Original SQL
24445
24890
  * * SQL Data Type: nvarchar(MAX)
24891
+ * * Description: The original SQL before any optimization or modification, kept for reference.
24446
24892
  */
24447
24893
  get OriginalSQL(): string | null;
24448
24894
  set OriginalSQL(value: string | null);
@@ -24450,6 +24896,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24450
24896
  * * Field Name: Feedback
24451
24897
  * * Display Name: Feedback
24452
24898
  * * SQL Data Type: nvarchar(MAX)
24899
+ * * Description: User feedback on query accuracy, performance, or suggested improvements.
24453
24900
  */
24454
24901
  get Feedback(): string | null;
24455
24902
  set Feedback(value: string | null);
@@ -24499,6 +24946,15 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24499
24946
  */
24500
24947
  get __mj_UpdatedAt(): Date;
24501
24948
  /**
24949
+ * * Field Name: UsesTemplate
24950
+ * * Display Name: Uses Template
24951
+ * * SQL Data Type: bit
24952
+ * * Default Value: 0
24953
+ * * 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.
24954
+ */
24955
+ get UsesTemplate(): boolean | null;
24956
+ set UsesTemplate(value: boolean | null);
24957
+ /**
24502
24958
  * * Field Name: Category
24503
24959
  * * Display Name: Category
24504
24960
  * * SQL Data Type: nvarchar(50)
@@ -24510,6 +24966,7 @@ export declare class QueryEntity extends BaseEntity<QueryEntityType> {
24510
24966
  * * Schema: __mj
24511
24967
  * * Base Table: QueryCategory
24512
24968
  * * Base View: vwQueryCategories
24969
+ * * @description Organizes saved queries into categories for discovery and management, supporting folder-like organization of queries.
24513
24970
  * * Primary Key: ID
24514
24971
  * @extends {BaseEntity}
24515
24972
  * @class
@@ -24659,6 +25116,27 @@ export declare class QueryEntityEntity extends BaseEntity<QueryEntityEntityType>
24659
25116
  */
24660
25117
  get __mj_UpdatedAt(): Date;
24661
25118
  /**
25119
+ * * Field Name: DetectionMethod
25120
+ * * Display Name: Detection Method
25121
+ * * SQL Data Type: nvarchar(50)
25122
+ * * Default Value: Manual
25123
+ * * Value List Type: List
25124
+ * * Possible Values
25125
+ * * AI
25126
+ * * Manual
25127
+ * * 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.
25128
+ */
25129
+ get DetectionMethod(): 'AI' | 'Manual';
25130
+ set DetectionMethod(value: 'AI' | 'Manual');
25131
+ /**
25132
+ * * Field Name: AutoDetectConfidenceScore
25133
+ * * Display Name: Auto Detect Confidence Score
25134
+ * * SQL Data Type: decimal(3, 2)
25135
+ * * 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.
25136
+ */
25137
+ get AutoDetectConfidenceScore(): number | null;
25138
+ set AutoDetectConfidenceScore(value: number | null);
25139
+ /**
24662
25140
  * * Field Name: Query
24663
25141
  * * Display Name: Query
24664
25142
  * * SQL Data Type: nvarchar(255)
@@ -24676,6 +25154,7 @@ export declare class QueryEntityEntity extends BaseEntity<QueryEntityEntityType>
24676
25154
  * * Schema: __mj
24677
25155
  * * Base Table: QueryField
24678
25156
  * * Base View: vwQueryFields
25157
+ * * @description Stores field-level metadata for queries including display names, data types, and formatting rules for result presentation.
24679
25158
  * * Primary Key: ID
24680
25159
  * @extends {BaseEntity}
24681
25160
  * @class
@@ -24728,6 +25207,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24728
25207
  * * Field Name: Sequence
24729
25208
  * * Display Name: Sequence
24730
25209
  * * SQL Data Type: int
25210
+ * * Description: Display order of this field in query results.
24731
25211
  */
24732
25212
  get Sequence(): number;
24733
25213
  set Sequence(value: number);
@@ -24759,6 +25239,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24759
25239
  * * Field Name: SourceFieldName
24760
25240
  * * Display Name: Source Field Name
24761
25241
  * * SQL Data Type: nvarchar(255)
25242
+ * * Description: The original field name from the SQL query if different from the display name.
24762
25243
  */
24763
25244
  get SourceFieldName(): string | null;
24764
25245
  set SourceFieldName(value: string | null);
@@ -24767,6 +25248,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24767
25248
  * * Display Name: Is Computed
24768
25249
  * * SQL Data Type: bit
24769
25250
  * * Default Value: 0
25251
+ * * Description: Indicates if this field is calculated from other fields rather than directly from the database.
24770
25252
  */
24771
25253
  get IsComputed(): boolean;
24772
25254
  set IsComputed(value: boolean);
@@ -24774,6 +25256,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24774
25256
  * * Field Name: ComputationDescription
24775
25257
  * * Display Name: Computation Description
24776
25258
  * * SQL Data Type: nvarchar(MAX)
25259
+ * * Description: Explanation of how this computed field is calculated.
24777
25260
  */
24778
25261
  get ComputationDescription(): string | null;
24779
25262
  set ComputationDescription(value: string | null);
@@ -24782,6 +25265,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24782
25265
  * * Display Name: Is Summary
24783
25266
  * * SQL Data Type: bit
24784
25267
  * * Default Value: 0
25268
+ * * Description: Whether this field represents an aggregate or summary value.
24785
25269
  */
24786
25270
  get IsSummary(): boolean;
24787
25271
  set IsSummary(value: boolean);
@@ -24789,6 +25273,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24789
25273
  * * Field Name: SummaryDescription
24790
25274
  * * Display Name: Summary Description
24791
25275
  * * SQL Data Type: nvarchar(MAX)
25276
+ * * Description: Description of what this summary field represents and how it's aggregated.
24792
25277
  */
24793
25278
  get SummaryDescription(): string | null;
24794
25279
  set SummaryDescription(value: string | null);
@@ -24807,6 +25292,27 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24807
25292
  */
24808
25293
  get __mj_UpdatedAt(): Date;
24809
25294
  /**
25295
+ * * Field Name: DetectionMethod
25296
+ * * Display Name: Detection Method
25297
+ * * SQL Data Type: nvarchar(50)
25298
+ * * Default Value: Manual
25299
+ * * Value List Type: List
25300
+ * * Possible Values
25301
+ * * AI
25302
+ * * Manual
25303
+ * * 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.
25304
+ */
25305
+ get DetectionMethod(): 'AI' | 'Manual';
25306
+ set DetectionMethod(value: 'AI' | 'Manual');
25307
+ /**
25308
+ * * Field Name: AutoDetectConfidenceScore
25309
+ * * Display Name: Auto Detect Confidence Score
25310
+ * * SQL Data Type: decimal(3, 2)
25311
+ * * 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.
25312
+ */
25313
+ get AutoDetectConfidenceScore(): number | null;
25314
+ set AutoDetectConfidenceScore(value: number | null);
25315
+ /**
24810
25316
  * * Field Name: Query
24811
25317
  * * Display Name: Query
24812
25318
  * * SQL Data Type: nvarchar(255)
@@ -24824,6 +25330,7 @@ export declare class QueryFieldEntity extends BaseEntity<QueryFieldEntityType> {
24824
25330
  * * Schema: __mj
24825
25331
  * * Base Table: QueryPermission
24826
25332
  * * Base View: vwQueryPermissions
25333
+ * * @description Controls access to queries by defining which users and roles can run specific queries.
24827
25334
  * * Primary Key: ID
24828
25335
  * @extends {BaseEntity}
24829
25336
  * @class
@@ -24898,6 +25405,7 @@ export declare class QueryPermissionEntity extends BaseEntity<QueryPermissionEnt
24898
25405
  * * Schema: __mj
24899
25406
  * * Base Table: QueueTask
24900
25407
  * * Base View: vwQueueTasks
25408
+ * * @description Manages asynchronous tasks in processing queues, tracking status, priority, and execution details for background operations.
24901
25409
  * * Primary Key: ID
24902
25410
  * @extends {BaseEntity}
24903
25411
  * @class
@@ -24963,6 +25471,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24963
25471
  * * Field Name: Data
24964
25472
  * * Display Name: Data
24965
25473
  * * SQL Data Type: nvarchar(MAX)
25474
+ * * Description: JSON payload containing the data needed to process this task.
24966
25475
  */
24967
25476
  get Data(): string | null;
24968
25477
  set Data(value: string | null);
@@ -24970,6 +25479,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24970
25479
  * * Field Name: Options
24971
25480
  * * Display Name: Options
24972
25481
  * * SQL Data Type: nvarchar(MAX)
25482
+ * * Description: JSON configuration options for how this task should be processed.
24973
25483
  */
24974
25484
  get Options(): string | null;
24975
25485
  set Options(value: string | null);
@@ -24977,6 +25487,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24977
25487
  * * Field Name: Output
24978
25488
  * * Display Name: Output
24979
25489
  * * SQL Data Type: nvarchar(MAX)
25490
+ * * Description: Result data from task execution, typically in JSON format.
24980
25491
  */
24981
25492
  get Output(): string | null;
24982
25493
  set Output(value: string | null);
@@ -24984,6 +25495,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
24984
25495
  * * Field Name: ErrorMessage
24985
25496
  * * Display Name: Error Message
24986
25497
  * * SQL Data Type: nvarchar(MAX)
25498
+ * * Description: Error details if the task failed during processing.
24987
25499
  */
24988
25500
  get ErrorMessage(): string | null;
24989
25501
  set ErrorMessage(value: string | null);
@@ -25020,6 +25532,7 @@ export declare class QueueTaskEntity extends BaseEntity<QueueTaskEntityType> {
25020
25532
  * * Schema: __mj
25021
25533
  * * Base Table: QueueType
25022
25534
  * * Base View: vwQueueTypes
25535
+ * * @description Defines different types of processing queues with specific behaviors, priorities, and processing rules for task management.
25023
25536
  * * Primary Key: ID
25024
25537
  * @extends {BaseEntity}
25025
25538
  * @class
@@ -25064,6 +25577,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25064
25577
  * * Field Name: DriverClass
25065
25578
  * * Display Name: Driver Class
25066
25579
  * * SQL Data Type: nvarchar(100)
25580
+ * * Description: Field DriverClass for entity Queue Types.
25067
25581
  */
25068
25582
  get DriverClass(): string;
25069
25583
  set DriverClass(value: string);
@@ -25071,6 +25585,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25071
25585
  * * Field Name: DriverImportPath
25072
25586
  * * Display Name: Driver Import Path
25073
25587
  * * SQL Data Type: nvarchar(200)
25588
+ * * Description: Field DriverImportPath for entity Queue Types.
25074
25589
  */
25075
25590
  get DriverImportPath(): string | null;
25076
25591
  set DriverImportPath(value: string | null);
@@ -25079,6 +25594,7 @@ export declare class QueueTypeEntity extends BaseEntity<QueueTypeEntityType> {
25079
25594
  * * Display Name: Is Active
25080
25595
  * * SQL Data Type: bit
25081
25596
  * * Default Value: 1
25597
+ * * Description: Field IsActive for entity Queue Types.
25082
25598
  */
25083
25599
  get IsActive(): boolean;
25084
25600
  set IsActive(value: boolean);
@@ -25156,6 +25672,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25156
25672
  * * Display Name: Is Active
25157
25673
  * * SQL Data Type: bit
25158
25674
  * * Default Value: 0
25675
+ * * Description: Field IsActive for entity Queues.
25159
25676
  */
25160
25677
  get IsActive(): boolean;
25161
25678
  set IsActive(value: boolean);
@@ -25163,6 +25680,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25163
25680
  * * Field Name: ProcessPID
25164
25681
  * * Display Name: Process PID
25165
25682
  * * SQL Data Type: int
25683
+ * * Description: Field ProcessPID for entity Queues.
25166
25684
  */
25167
25685
  get ProcessPID(): number | null;
25168
25686
  set ProcessPID(value: number | null);
@@ -25170,6 +25688,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25170
25688
  * * Field Name: ProcessPlatform
25171
25689
  * * Display Name: Process Platform
25172
25690
  * * SQL Data Type: nvarchar(30)
25691
+ * * Description: Field ProcessPlatform for entity Queues.
25173
25692
  */
25174
25693
  get ProcessPlatform(): string | null;
25175
25694
  set ProcessPlatform(value: string | null);
@@ -25177,6 +25696,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25177
25696
  * * Field Name: ProcessVersion
25178
25697
  * * Display Name: Process Version
25179
25698
  * * SQL Data Type: nvarchar(15)
25699
+ * * Description: Field ProcessVersion for entity Queues.
25180
25700
  */
25181
25701
  get ProcessVersion(): string | null;
25182
25702
  set ProcessVersion(value: string | null);
@@ -25184,6 +25704,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25184
25704
  * * Field Name: ProcessCwd
25185
25705
  * * Display Name: Process Cwd
25186
25706
  * * SQL Data Type: nvarchar(100)
25707
+ * * Description: Field ProcessCwd for entity Queues.
25187
25708
  */
25188
25709
  get ProcessCwd(): string | null;
25189
25710
  set ProcessCwd(value: string | null);
@@ -25191,6 +25712,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25191
25712
  * * Field Name: ProcessIPAddress
25192
25713
  * * Display Name: Process IPAddress
25193
25714
  * * SQL Data Type: nvarchar(50)
25715
+ * * Description: Field ProcessIPAddress for entity Queues.
25194
25716
  */
25195
25717
  get ProcessIPAddress(): string | null;
25196
25718
  set ProcessIPAddress(value: string | null);
@@ -25198,6 +25720,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25198
25720
  * * Field Name: ProcessMacAddress
25199
25721
  * * Display Name: Process Mac Address
25200
25722
  * * SQL Data Type: nvarchar(50)
25723
+ * * Description: Field ProcessMacAddress for entity Queues.
25201
25724
  */
25202
25725
  get ProcessMacAddress(): string | null;
25203
25726
  set ProcessMacAddress(value: string | null);
@@ -25205,6 +25728,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25205
25728
  * * Field Name: ProcessOSName
25206
25729
  * * Display Name: Process OSName
25207
25730
  * * SQL Data Type: nvarchar(25)
25731
+ * * Description: Field ProcessOSName for entity Queues.
25208
25732
  */
25209
25733
  get ProcessOSName(): string | null;
25210
25734
  set ProcessOSName(value: string | null);
@@ -25212,6 +25736,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25212
25736
  * * Field Name: ProcessOSVersion
25213
25737
  * * Display Name: Process OSVersion
25214
25738
  * * SQL Data Type: nvarchar(10)
25739
+ * * Description: Field ProcessOSVersion for entity Queues.
25215
25740
  */
25216
25741
  get ProcessOSVersion(): string | null;
25217
25742
  set ProcessOSVersion(value: string | null);
@@ -25219,6 +25744,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25219
25744
  * * Field Name: ProcessHostName
25220
25745
  * * Display Name: Process Host Name
25221
25746
  * * SQL Data Type: nvarchar(50)
25747
+ * * Description: Field ProcessHostName for entity Queues.
25222
25748
  */
25223
25749
  get ProcessHostName(): string | null;
25224
25750
  set ProcessHostName(value: string | null);
@@ -25226,6 +25752,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25226
25752
  * * Field Name: ProcessUserID
25227
25753
  * * Display Name: Process User ID
25228
25754
  * * SQL Data Type: nvarchar(25)
25755
+ * * Description: Field ProcessUserID for entity Queues.
25229
25756
  */
25230
25757
  get ProcessUserID(): string | null;
25231
25758
  set ProcessUserID(value: string | null);
@@ -25233,6 +25760,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25233
25760
  * * Field Name: ProcessUserName
25234
25761
  * * Display Name: Process User Name
25235
25762
  * * SQL Data Type: nvarchar(50)
25763
+ * * Description: Field ProcessUserName for entity Queues.
25236
25764
  */
25237
25765
  get ProcessUserName(): string | null;
25238
25766
  set ProcessUserName(value: string | null);
@@ -25241,6 +25769,7 @@ export declare class QueueEntity extends BaseEntity<QueueEntityType> {
25241
25769
  * * Display Name: Last Heartbeat
25242
25770
  * * SQL Data Type: datetime
25243
25771
  * * Default Value: getdate()
25772
+ * * Description: Field LastHeartbeat for entity Queues.
25244
25773
  */
25245
25774
  get LastHeartbeat(): Date;
25246
25775
  set LastHeartbeat(value: Date);
@@ -25750,6 +26279,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25750
26279
  * * Field Name: RecordID
25751
26280
  * * Display Name: Record
25752
26281
  * * SQL Data Type: nvarchar(750)
26282
+ * * Description: Field RecordID for entity Record Changes.
25753
26283
  */
25754
26284
  get RecordID(): string;
25755
26285
  set RecordID(value: string);
@@ -25838,6 +26368,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25838
26368
  * * Field Name: ErrorLog
25839
26369
  * * Display Name: Error Log
25840
26370
  * * SQL Data Type: nvarchar(MAX)
26371
+ * * Description: Field ErrorLog for entity Record Changes.
25841
26372
  */
25842
26373
  get ErrorLog(): string | null;
25843
26374
  set ErrorLog(value: string | null);
@@ -25868,6 +26399,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25868
26399
  * * Display Name: Created At
25869
26400
  * * SQL Data Type: datetimeoffset
25870
26401
  * * Default Value: getutcdate()
26402
+ * * Description: Field CreatedAt for entity Record Changes.
25871
26403
  */
25872
26404
  get CreatedAt(): Date;
25873
26405
  /**
@@ -25875,6 +26407,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25875
26407
  * * Display Name: Updated At
25876
26408
  * * SQL Data Type: datetimeoffset
25877
26409
  * * Default Value: getutcdate()
26410
+ * * Description: Field UpdatedAt for entity Record Changes.
25878
26411
  */
25879
26412
  get UpdatedAt(): Date;
25880
26413
  /**
@@ -25901,6 +26434,7 @@ export declare class RecordChangeEntity extends BaseEntity<RecordChangeEntityTyp
25901
26434
  * * Schema: __mj
25902
26435
  * * Base Table: RecordMergeDeletionLog
25903
26436
  * * Base View: vwRecordMergeDeletionLogs
26437
+ * * @description Tracks records deleted during merge operations, maintaining an audit trail of data consolidation activities.
25904
26438
  * * Primary Key: ID
25905
26439
  * @extends {BaseEntity}
25906
26440
  * @class
@@ -25939,6 +26473,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25939
26473
  * * Field Name: DeletedRecordID
25940
26474
  * * Display Name: Deleted Record ID
25941
26475
  * * SQL Data Type: nvarchar(750)
26476
+ * * Description: Field DeletedRecordID for entity Record Merge Deletion Logs.
25942
26477
  */
25943
26478
  get DeletedRecordID(): string;
25944
26479
  set DeletedRecordID(value: string);
@@ -25959,6 +26494,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25959
26494
  * * Field Name: ProcessingLog
25960
26495
  * * Display Name: Processing Log
25961
26496
  * * SQL Data Type: nvarchar(MAX)
26497
+ * * Description: Field ProcessingLog for entity Record Merge Deletion Logs.
25962
26498
  */
25963
26499
  get ProcessingLog(): string | null;
25964
26500
  set ProcessingLog(value: string | null);
@@ -25982,6 +26518,7 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity<RecordMerge
25982
26518
  * * Schema: __mj
25983
26519
  * * Base Table: RecordMergeLog
25984
26520
  * * Base View: vwRecordMergeLogs
26521
+ * * @description Records the history of record merge operations including source records, target records, and merge rules applied.
25985
26522
  * * Primary Key: ID
25986
26523
  * @extends {BaseEntity}
25987
26524
  * @class
@@ -26020,6 +26557,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26020
26557
  * * Field Name: SurvivingRecordID
26021
26558
  * * Display Name: Surviving Record ID
26022
26559
  * * SQL Data Type: nvarchar(450)
26560
+ * * Description: The ID of the record that survived the merge and contains the consolidated data.
26023
26561
  */
26024
26562
  get SurvivingRecordID(): string;
26025
26563
  set SurvivingRecordID(value: string);
@@ -26041,6 +26579,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26041
26579
  * * Pending
26042
26580
  * * Approved
26043
26581
  * * Rejected
26582
+ * * Description: Field ApprovalStatus for entity Record Merge Logs.
26044
26583
  */
26045
26584
  get ApprovalStatus(): 'Pending' | 'Approved' | 'Rejected';
26046
26585
  set ApprovalStatus(value: 'Pending' | 'Approved' | 'Rejected');
@@ -26062,6 +26601,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26062
26601
  * * Started
26063
26602
  * * Complete
26064
26603
  * * Error
26604
+ * * Description: Field ProcessingStatus for entity Record Merge Logs.
26065
26605
  */
26066
26606
  get ProcessingStatus(): 'Started' | 'Complete' | 'Error';
26067
26607
  set ProcessingStatus(value: 'Started' | 'Complete' | 'Error');
@@ -26070,6 +26610,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26070
26610
  * * Display Name: Processing Started At
26071
26611
  * * SQL Data Type: datetime
26072
26612
  * * Default Value: getdate()
26613
+ * * Description: Field ProcessingStartedAt for entity Record Merge Logs.
26073
26614
  */
26074
26615
  get ProcessingStartedAt(): Date;
26075
26616
  set ProcessingStartedAt(value: Date);
@@ -26077,6 +26618,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26077
26618
  * * Field Name: ProcessingEndedAt
26078
26619
  * * Display Name: Processing Ended At
26079
26620
  * * SQL Data Type: datetime
26621
+ * * Description: Field ProcessingEndedAt for entity Record Merge Logs.
26080
26622
  */
26081
26623
  get ProcessingEndedAt(): Date | null;
26082
26624
  set ProcessingEndedAt(value: Date | null);
@@ -26084,6 +26626,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26084
26626
  * * Field Name: ProcessingLog
26085
26627
  * * Display Name: Processing Log
26086
26628
  * * SQL Data Type: nvarchar(MAX)
26629
+ * * Description: Detailed log of the merge process including field mappings and decisions.
26087
26630
  */
26088
26631
  get ProcessingLog(): string | null;
26089
26632
  set ProcessingLog(value: string | null);
@@ -26132,6 +26675,7 @@ export declare class RecordMergeLogEntity extends BaseEntity<RecordMergeLogEntit
26132
26675
  * * Schema: __mj
26133
26676
  * * Base Table: ReportCategory
26134
26677
  * * Base View: vwReportCategories
26678
+ * * @description Organizes reports into logical groupings for navigation, access control, and discovery within the reporting system.
26135
26679
  * * Primary Key: ID
26136
26680
  * @extends {BaseEntity}
26137
26681
  * @class
@@ -26220,6 +26764,7 @@ export declare class ReportCategoryEntity extends BaseEntity<ReportCategoryEntit
26220
26764
  * * Schema: __mj
26221
26765
  * * Base Table: ReportSnapshot
26222
26766
  * * Base View: vwReportSnapshots
26767
+ * * @description Stores point-in-time captures of report outputs, preserving historical data and enabling comparison over time.
26223
26768
  * * Primary Key: ID
26224
26769
  * @extends {BaseEntity}
26225
26770
  * @class
@@ -26258,6 +26803,7 @@ export declare class ReportSnapshotEntity extends BaseEntity<ReportSnapshotEntit
26258
26803
  * * Field Name: ResultSet
26259
26804
  * * Display Name: Result Set
26260
26805
  * * SQL Data Type: nvarchar(MAX)
26806
+ * * Description: Field ResultSet for entity Report Snapshots.
26261
26807
  */
26262
26808
  get ResultSet(): string;
26263
26809
  set ResultSet(value: string);
@@ -26301,6 +26847,7 @@ export declare class ReportSnapshotEntity extends BaseEntity<ReportSnapshotEntit
26301
26847
  * * Schema: __mj
26302
26848
  * * Base Table: Report
26303
26849
  * * Base View: vwReports
26850
+ * * @description Defines report configurations including data sources, layouts, filters, and scheduling for automated report generation.
26304
26851
  * * Primary Key: ID
26305
26852
  * @extends {BaseEntity}
26306
26853
  * @class
@@ -26367,6 +26914,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26367
26914
  * * None
26368
26915
  * * Specific
26369
26916
  * * Everyone
26917
+ * * Description: Field SharingScope for entity Reports.
26370
26918
  */
26371
26919
  get SharingScope(): 'None' | 'Specific' | 'Everyone';
26372
26920
  set SharingScope(value: 'None' | 'Specific' | 'Everyone');
@@ -26398,6 +26946,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26398
26946
  * * Field Name: Configuration
26399
26947
  * * Display Name: Configuration
26400
26948
  * * SQL Data Type: nvarchar(MAX)
26949
+ * * Description: Field Configuration for entity Reports.
26401
26950
  */
26402
26951
  get Configuration(): string | null;
26403
26952
  set Configuration(value: string | null);
@@ -26429,6 +26978,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26429
26978
  * * Field Name: OutputFrequency
26430
26979
  * * Display Name: Output Frequency
26431
26980
  * * SQL Data Type: nvarchar(50)
26981
+ * * Description: For scheduled reports, the frequency of generation (Daily, Weekly, Monthly, etc.).
26432
26982
  */
26433
26983
  get OutputFrequency(): string | null;
26434
26984
  set OutputFrequency(value: string | null);
@@ -26436,6 +26986,7 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
26436
26986
  * * Field Name: OutputTargetEmail
26437
26987
  * * Display Name: Output Target Email
26438
26988
  * * SQL Data Type: nvarchar(255)
26989
+ * * Description: Email address(es) to send the report to when using email delivery.
26439
26990
  */
26440
26991
  get OutputTargetEmail(): string | null;
26441
26992
  set OutputTargetEmail(value: string | null);
@@ -26786,6 +27337,7 @@ export declare class ResourcePermissionEntity extends BaseEntity<ResourcePermiss
26786
27337
  * * Schema: __mj
26787
27338
  * * Base Table: ResourceType
26788
27339
  * * Base View: vwResourceTypes
27340
+ * * @description Tracks types of system resources such as records, dashboards, and reports.
26789
27341
  * * Primary Key: ID
26790
27342
  * @extends {BaseEntity}
26791
27343
  * @class
@@ -26823,6 +27375,7 @@ export declare class ResourceTypeEntity extends BaseEntity<ResourceTypeEntityTyp
26823
27375
  * * Field Name: DisplayName
26824
27376
  * * Display Name: Display Name
26825
27377
  * * SQL Data Type: nvarchar(255)
27378
+ * * Description: Field DisplayName for entity Resource Types.
26826
27379
  */
26827
27380
  get DisplayName(): string;
26828
27381
  set DisplayName(value: string);
@@ -26837,6 +27390,7 @@ export declare class ResourceTypeEntity extends BaseEntity<ResourceTypeEntityTyp
26837
27390
  * * Field Name: Icon
26838
27391
  * * Display Name: Icon
26839
27392
  * * SQL Data Type: nvarchar(100)
27393
+ * * Description: Icon identifier for displaying this resource type in the UI.
26840
27394
  */
26841
27395
  get Icon(): string | null;
26842
27396
  set Icon(value: string | null);
@@ -26963,6 +27517,7 @@ export declare class RoleEntity extends BaseEntity<RoleEntityType> {
26963
27517
  * * Schema: __mj
26964
27518
  * * Base Table: RowLevelSecurityFilter
26965
27519
  * * Base View: vwRowLevelSecurityFilters
27520
+ * * @description Defines data access rules that filter records based on user context, implementing fine-grained security at the row level.
26966
27521
  * * Primary Key: ID
26967
27522
  * @extends {BaseEntity}
26968
27523
  * @class
@@ -27007,6 +27562,7 @@ export declare class RowLevelSecurityFilterEntity extends BaseEntity<RowLevelSec
27007
27562
  * * Field Name: FilterText
27008
27563
  * * Display Name: Filter Text
27009
27564
  * * SQL Data Type: nvarchar(MAX)
27565
+ * * Description: SQL WHERE clause template that filters records based on user context variables.
27010
27566
  */
27011
27567
  get FilterText(): string | null;
27012
27568
  set FilterText(value: string | null);
@@ -27030,6 +27586,7 @@ export declare class RowLevelSecurityFilterEntity extends BaseEntity<RowLevelSec
27030
27586
  * * Schema: __mj
27031
27587
  * * Base Table: ScheduledActionParam
27032
27588
  * * Base View: vwScheduledActionParams
27589
+ * * @description Stores parameter values for scheduled action executions, configuring inputs for automated action runs.
27033
27590
  * * Primary Key: ID
27034
27591
  * @extends {BaseEntity}
27035
27592
  * @class
@@ -27080,6 +27637,7 @@ export declare class ScheduledActionParamEntity extends BaseEntity<ScheduledActi
27080
27637
  * * Possible Values
27081
27638
  * * Static
27082
27639
  * * SQL Statement
27640
+ * * Description: Field ValueType for entity Scheduled Action Params.
27083
27641
  */
27084
27642
  get ValueType(): 'Static' | 'SQL Statement';
27085
27643
  set ValueType(value: 'Static' | 'SQL Statement');
@@ -27087,6 +27645,7 @@ export declare class ScheduledActionParamEntity extends BaseEntity<ScheduledActi
27087
27645
  * * Field Name: Value
27088
27646
  * * Display Name: Value
27089
27647
  * * SQL Data Type: nvarchar(MAX)
27648
+ * * Description: Field Value for entity Scheduled Action Params.
27090
27649
  */
27091
27650
  get Value(): string | null;
27092
27651
  set Value(value: string | null);
@@ -27268,6 +27827,7 @@ export declare class ScheduledActionEntity extends BaseEntity<ScheduledActionEnt
27268
27827
  * * Field Name: CustomCronExpression
27269
27828
  * * Display Name: Custom Cron Expression
27270
27829
  * * SQL Data Type: nvarchar(255)
27830
+ * * Description: Field CustomCronExpression for entity Scheduled Actions.
27271
27831
  */
27272
27832
  get CustomCronExpression(): string | null;
27273
27833
  set CustomCronExpression(value: string | null);
@@ -27357,6 +27917,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27357
27917
  * * Field Name: SchemaName
27358
27918
  * * Display Name: Schema Name
27359
27919
  * * SQL Data Type: nvarchar(50)
27920
+ * * Description: The database schema this information applies to.
27360
27921
  */
27361
27922
  get SchemaName(): string;
27362
27923
  set SchemaName(value: string);
@@ -27364,6 +27925,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27364
27925
  * * Field Name: EntityIDMin
27365
27926
  * * Display Name: Entity IDMin
27366
27927
  * * SQL Data Type: int
27928
+ * * Description: Field EntityIDMin for entity Schema Info.
27367
27929
  */
27368
27930
  get EntityIDMin(): number;
27369
27931
  set EntityIDMin(value: number);
@@ -27371,6 +27933,7 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
27371
27933
  * * Field Name: EntityIDMax
27372
27934
  * * Display Name: Entity IDMax
27373
27935
  * * SQL Data Type: int
27936
+ * * Description: Field EntityIDMax for entity Schema Info.
27374
27937
  */
27375
27938
  get EntityIDMax(): number;
27376
27939
  set EntityIDMax(value: number);
@@ -27514,6 +28077,7 @@ export declare class TaggedItemEntity extends BaseEntity<TaggedItemEntityType> {
27514
28077
  * * Field Name: RecordID
27515
28078
  * * Display Name: Record ID
27516
28079
  * * SQL Data Type: nvarchar(450)
28080
+ * * Description: Field RecordID for entity Tagged Items.
27517
28081
  */
27518
28082
  get RecordID(): string;
27519
28083
  set RecordID(value: string);
@@ -27595,6 +28159,7 @@ export declare class TagEntity extends BaseEntity<TagEntityType> {
27595
28159
  * * Field Name: DisplayName
27596
28160
  * * Display Name: Display Name
27597
28161
  * * SQL Data Type: nvarchar(255)
28162
+ * * Description: Field DisplayName for entity Tags.
27598
28163
  */
27599
28164
  get DisplayName(): string;
27600
28165
  set DisplayName(value: string);
@@ -27984,6 +28549,7 @@ export declare class TemplateParamEntity extends BaseEntity<TemplateParamEntityT
27984
28549
  * * Display Name: Is Required
27985
28550
  * * SQL Data Type: bit
27986
28551
  * * Default Value: 0
28552
+ * * Description: Whether this parameter must be provided when using the template.
27987
28553
  */
27988
28554
  get IsRequired(): boolean;
27989
28555
  set IsRequired(value: boolean);
@@ -28200,6 +28766,7 @@ export declare class TemplateEntity extends BaseEntity<TemplateEntityType> {
28200
28766
  * * Schema: __mj
28201
28767
  * * Base Table: UserApplicationEntity
28202
28768
  * * Base View: vwUserApplicationEntities
28769
+ * * @description Links users to specific entities within applications, managing entity-level personalization.
28203
28770
  * * Primary Key: ID
28204
28771
  * @extends {BaseEntity}
28205
28772
  * @class
@@ -28245,6 +28812,7 @@ export declare class UserApplicationEntityEntity extends BaseEntity<UserApplicat
28245
28812
  * * Field Name: Sequence
28246
28813
  * * SQL Data Type: int
28247
28814
  * * Default Value: 0
28815
+ * * Description: Display order of this entity for the user within the application.
28248
28816
  */
28249
28817
  get Sequence(): number;
28250
28818
  set Sequence(value: number);
@@ -28286,6 +28854,7 @@ export declare class UserApplicationEntityEntity extends BaseEntity<UserApplicat
28286
28854
  * * Schema: __mj
28287
28855
  * * Base Table: UserApplication
28288
28856
  * * Base View: vwUserApplications
28857
+ * * @description Tracks which applications users have configured to display.
28289
28858
  * * Primary Key: ID
28290
28859
  * @extends {BaseEntity}
28291
28860
  * @class
@@ -28331,6 +28900,7 @@ export declare class UserApplicationEntity extends BaseEntity<UserApplicationEnt
28331
28900
  * * Field Name: Sequence
28332
28901
  * * SQL Data Type: int
28333
28902
  * * Default Value: 0
28903
+ * * Description: Display order of this application in the user's navigation.
28334
28904
  */
28335
28905
  get Sequence(): number;
28336
28906
  set Sequence(value: number);
@@ -28339,6 +28909,7 @@ export declare class UserApplicationEntity extends BaseEntity<UserApplicationEnt
28339
28909
  * * Display Name: Is Active
28340
28910
  * * SQL Data Type: bit
28341
28911
  * * Default Value: 1
28912
+ * * Description: Whether this application is currently visible to the user.
28342
28913
  */
28343
28914
  get IsActive(): boolean;
28344
28915
  set IsActive(value: boolean);
@@ -28420,6 +28991,7 @@ export declare class UserFavoriteEntity extends BaseEntity<UserFavoriteEntityTyp
28420
28991
  * * Field Name: RecordID
28421
28992
  * * Display Name: Record
28422
28993
  * * SQL Data Type: nvarchar(450)
28994
+ * * Description: The ID of the favorited record.
28423
28995
  */
28424
28996
  get RecordID(): string;
28425
28997
  set RecordID(value: string);
@@ -28460,6 +29032,7 @@ export declare class UserFavoriteEntity extends BaseEntity<UserFavoriteEntityTyp
28460
29032
  * * Schema: __mj
28461
29033
  * * Base Table: UserNotification
28462
29034
  * * Base View: vwUserNotifications
29035
+ * * @description Manages notifications sent to users including alerts, messages, and system updates with read status and priority.
28463
29036
  * * Primary Key: ID
28464
29037
  * @extends {BaseEntity}
28465
29038
  * @class
@@ -28498,6 +29071,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28498
29071
  * * Field Name: Title
28499
29072
  * * Display Name: Title
28500
29073
  * * SQL Data Type: nvarchar(255)
29074
+ * * Description: Brief title or subject of the notification.
28501
29075
  */
28502
29076
  get Title(): string | null;
28503
29077
  set Title(value: string | null);
@@ -28505,6 +29079,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28505
29079
  * * Field Name: Message
28506
29080
  * * Display Name: Message
28507
29081
  * * SQL Data Type: nvarchar(MAX)
29082
+ * * Description: Full notification message content.
28508
29083
  */
28509
29084
  get Message(): string | null;
28510
29085
  set Message(value: string | null);
@@ -28520,6 +29095,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28520
29095
  * * Field Name: ResourceConfiguration
28521
29096
  * * Display Name: Resource Configuration
28522
29097
  * * SQL Data Type: nvarchar(MAX)
29098
+ * * Description: Field ResourceConfiguration for entity User Notifications.
28523
29099
  */
28524
29100
  get ResourceConfiguration(): string | null;
28525
29101
  set ResourceConfiguration(value: string | null);
@@ -28528,6 +29104,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28528
29104
  * * Display Name: Unread
28529
29105
  * * SQL Data Type: bit
28530
29106
  * * Default Value: 1
29107
+ * * Description: Field Unread for entity User Notifications.
28531
29108
  */
28532
29109
  get Unread(): boolean;
28533
29110
  set Unread(value: boolean);
@@ -28535,6 +29112,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28535
29112
  * * Field Name: ReadAt
28536
29113
  * * Display Name: Read At
28537
29114
  * * SQL Data Type: datetime
29115
+ * * Description: Timestamp when the user read this notification.
28538
29116
  */
28539
29117
  get ReadAt(): Date | null;
28540
29118
  set ReadAt(value: Date | null);
@@ -28556,6 +29134,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28556
29134
  * * Field Name: ResourceRecordID
28557
29135
  * * Display Name: Resource Record ID
28558
29136
  * * SQL Data Type: uniqueidentifier
29137
+ * * Description: ID of the specific record this notification is about.
28559
29138
  */
28560
29139
  get ResourceRecordID(): string | null;
28561
29140
  set ResourceRecordID(value: string | null);
@@ -28577,6 +29156,7 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
28577
29156
  * * Schema: __mj
28578
29157
  * * Base Table: UserRecordLog
28579
29158
  * * Base View: vwUserRecordLogs
29159
+ * * @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
29160
  * * Primary Key: ID
28581
29161
  * @extends {BaseEntity}
28582
29162
  * @class
@@ -28622,6 +29202,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28622
29202
  * * Field Name: RecordID
28623
29203
  * * Display Name: Record
28624
29204
  * * SQL Data Type: nvarchar(450)
29205
+ * * Description: The ID of the accessed record.
28625
29206
  */
28626
29207
  get RecordID(): string;
28627
29208
  set RecordID(value: string);
@@ -28630,6 +29211,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28630
29211
  * * Display Name: Earliest At
28631
29212
  * * SQL Data Type: datetime
28632
29213
  * * Default Value: getdate()
29214
+ * * Description: Field EarliestAt for entity User Record Logs.
28633
29215
  */
28634
29216
  get EarliestAt(): Date;
28635
29217
  set EarliestAt(value: Date);
@@ -28638,6 +29220,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28638
29220
  * * Display Name: Latest At
28639
29221
  * * SQL Data Type: datetime
28640
29222
  * * Default Value: getdate()
29223
+ * * Description: Field LatestAt for entity User Record Logs.
28641
29224
  */
28642
29225
  get LatestAt(): Date;
28643
29226
  set LatestAt(value: Date);
@@ -28646,6 +29229,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28646
29229
  * * Display Name: Total Count
28647
29230
  * * SQL Data Type: int
28648
29231
  * * Default Value: 0
29232
+ * * Description: Field TotalCount for entity User Record Logs.
28649
29233
  */
28650
29234
  get TotalCount(): number;
28651
29235
  set TotalCount(value: number);
@@ -28705,6 +29289,7 @@ export declare class UserRecordLogEntity extends BaseEntity<UserRecordLogEntityT
28705
29289
  * * Schema: __mj
28706
29290
  * * Base Table: UserRole
28707
29291
  * * Base View: vwUserRoles
29292
+ * * @description Associates users with roles in the system, managing role-based access control and permission inheritance.
28708
29293
  * * Primary Key: ID
28709
29294
  * @extends {BaseEntity}
28710
29295
  * @class
@@ -28779,6 +29364,7 @@ export declare class UserRoleEntity extends BaseEntity<UserRoleEntityType> {
28779
29364
  * * Schema: __mj
28780
29365
  * * Base Table: UserViewCategory
28781
29366
  * * Base View: vwUserViewCategories
29367
+ * * @description Organizes user-created views into categories for personal organization and sharing within teams.
28782
29368
  * * Primary Key: ID
28783
29369
  * @extends {BaseEntity}
28784
29370
  * @class
@@ -28919,6 +29505,7 @@ export declare class UserViewRunDetailEntity extends BaseEntity<UserViewRunDetai
28919
29505
  * * Field Name: RecordID
28920
29506
  * * Display Name: Record
28921
29507
  * * SQL Data Type: nvarchar(450)
29508
+ * * Description: Field RecordID for entity User View Run Details.
28922
29509
  */
28923
29510
  get RecordID(): string;
28924
29511
  set RecordID(value: string);
@@ -28992,6 +29579,7 @@ export declare class UserViewRunEntity extends BaseEntity<UserViewRunEntityType>
28992
29579
  * * Field Name: RunAt
28993
29580
  * * Display Name: Run At
28994
29581
  * * SQL Data Type: datetime
29582
+ * * Description: Timestamp when the view was executed.
28995
29583
  */
28996
29584
  get RunAt(): Date;
28997
29585
  set RunAt(value: Date);
@@ -29102,6 +29690,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29102
29690
  * * Display Name: Is Shared
29103
29691
  * * SQL Data Type: bit
29104
29692
  * * Default Value: 0
29693
+ * * Description: Whether this view is shared with other users.
29105
29694
  */
29106
29695
  get IsShared(): boolean;
29107
29696
  set IsShared(value: boolean);
@@ -29110,6 +29699,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29110
29699
  * * Display Name: Is Default
29111
29700
  * * SQL Data Type: bit
29112
29701
  * * Default Value: 0
29702
+ * * Description: Whether this is the user's default view for the entity.
29113
29703
  */
29114
29704
  get IsDefault(): boolean;
29115
29705
  set IsDefault(value: boolean);
@@ -29117,6 +29707,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29117
29707
  * * Field Name: GridState
29118
29708
  * * Display Name: Grid State
29119
29709
  * * SQL Data Type: nvarchar(MAX)
29710
+ * * Description: JSON storing complete grid configuration including columns, widths, and formatting.
29120
29711
  */
29121
29712
  get GridState(): string | null;
29122
29713
  set GridState(value: string | null);
@@ -29124,6 +29715,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29124
29715
  * * Field Name: FilterState
29125
29716
  * * Display Name: Filter State
29126
29717
  * * SQL Data Type: nvarchar(MAX)
29718
+ * * Description: JSON storing the view's filter configuration.
29127
29719
  */
29128
29720
  get FilterState(): string | null;
29129
29721
  set FilterState(value: string | null);
@@ -29132,6 +29724,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29132
29724
  * * Display Name: Custom Filter State
29133
29725
  * * SQL Data Type: bit
29134
29726
  * * Default Value: 0
29727
+ * * Description: Indicates if custom filters beyond standard options are applied.
29135
29728
  */
29136
29729
  get CustomFilterState(): boolean;
29137
29730
  set CustomFilterState(value: boolean);
@@ -29140,6 +29733,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29140
29733
  * * Display Name: Smart Filter Enabled
29141
29734
  * * SQL Data Type: bit
29142
29735
  * * Default Value: 0
29736
+ * * Description: Whether AI-powered smart filtering is enabled for this view.
29143
29737
  */
29144
29738
  get SmartFilterEnabled(): boolean;
29145
29739
  set SmartFilterEnabled(value: boolean);
@@ -29147,6 +29741,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29147
29741
  * * Field Name: SmartFilterPrompt
29148
29742
  * * Display Name: Smart Filter Prompt
29149
29743
  * * SQL Data Type: nvarchar(MAX)
29744
+ * * Description: Natural language prompt for AI-powered filtering.
29150
29745
  */
29151
29746
  get SmartFilterPrompt(): string | null;
29152
29747
  set SmartFilterPrompt(value: string | null);
@@ -29154,6 +29749,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29154
29749
  * * Field Name: SmartFilterWhereClause
29155
29750
  * * Display Name: Smart Filter Where Clause
29156
29751
  * * SQL Data Type: nvarchar(MAX)
29752
+ * * Description: Generated WHERE clause from smart filter processing.
29157
29753
  */
29158
29754
  get SmartFilterWhereClause(): string | null;
29159
29755
  set SmartFilterWhereClause(value: string | null);
@@ -29161,6 +29757,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29161
29757
  * * Field Name: SmartFilterExplanation
29162
29758
  * * Display Name: Smart Filter Explanation
29163
29759
  * * SQL Data Type: nvarchar(MAX)
29760
+ * * Description: AI-generated explanation of what the smart filter does.
29164
29761
  */
29165
29762
  get SmartFilterExplanation(): string | null;
29166
29763
  set SmartFilterExplanation(value: string | null);
@@ -29168,6 +29765,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29168
29765
  * * Field Name: WhereClause
29169
29766
  * * Display Name: Where Clause
29170
29767
  * * SQL Data Type: nvarchar(MAX)
29768
+ * * Description: Direct SQL WHERE clause for the view filter.
29171
29769
  */
29172
29770
  get WhereClause(): string | null;
29173
29771
  set WhereClause(value: string | null);
@@ -29176,6 +29774,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29176
29774
  * * Display Name: Custom Where Clause
29177
29775
  * * SQL Data Type: bit
29178
29776
  * * Default Value: 0
29777
+ * * Description: Indicates if a custom WHERE clause is used instead of standard filters.
29179
29778
  */
29180
29779
  get CustomWhereClause(): boolean;
29181
29780
  set CustomWhereClause(value: boolean);
@@ -29183,6 +29782,7 @@ export declare class UserViewEntity extends BaseEntity<UserViewEntityType> {
29183
29782
  * * Field Name: SortState
29184
29783
  * * Display Name: Sort State
29185
29784
  * * SQL Data Type: nvarchar(MAX)
29785
+ * * Description: JSON storing the view's sort configuration.
29186
29786
  */
29187
29787
  get SortState(): string | null;
29188
29788
  set SortState(value: string | null);
@@ -29286,6 +29886,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29286
29886
  * * Field Name: FirstName
29287
29887
  * * Display Name: First Name
29288
29888
  * * SQL Data Type: nvarchar(50)
29889
+ * * Description: User's first name or given name.
29289
29890
  */
29290
29891
  get FirstName(): string | null;
29291
29892
  set FirstName(value: string | null);
@@ -29293,6 +29894,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29293
29894
  * * Field Name: LastName
29294
29895
  * * Display Name: Last Name
29295
29896
  * * SQL Data Type: nvarchar(50)
29897
+ * * Description: User's last name or surname.
29296
29898
  */
29297
29899
  get LastName(): string | null;
29298
29900
  set LastName(value: string | null);
@@ -29300,6 +29902,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29300
29902
  * * Field Name: Title
29301
29903
  * * Display Name: Title
29302
29904
  * * SQL Data Type: nvarchar(50)
29905
+ * * Description: User's professional title or salutation.
29303
29906
  */
29304
29907
  get Title(): string | null;
29305
29908
  set Title(value: string | null);
@@ -29317,6 +29920,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29317
29920
  * * Possible Values
29318
29921
  * * User
29319
29922
  * * Owner
29923
+ * * Description: User account type (User, Guest, System, API).
29320
29924
  */
29321
29925
  get Type(): 'User' | 'Owner';
29322
29926
  set Type(value: 'User' | 'Owner');
@@ -29325,6 +29929,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29325
29929
  * * Display Name: Is Active
29326
29930
  * * SQL Data Type: bit
29327
29931
  * * Default Value: 0
29932
+ * * Description: Whether this user account is currently active and can log in.
29328
29933
  */
29329
29934
  get IsActive(): boolean;
29330
29935
  set IsActive(value: boolean);
@@ -29333,6 +29938,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29333
29938
  * * Display Name: Linked Record Type
29334
29939
  * * SQL Data Type: nchar(10)
29335
29940
  * * Default Value: None
29941
+ * * Description: Type of record this user is linked to (None, Employee, Contact, etc.).
29336
29942
  */
29337
29943
  get LinkedRecordType(): string;
29338
29944
  set LinkedRecordType(value: string);
@@ -29348,6 +29954,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29348
29954
  * * Field Name: LinkedEntityRecordID
29349
29955
  * * Display Name: Linked Entity Record ID
29350
29956
  * * SQL Data Type: nvarchar(450)
29957
+ * * Description: ID of the specific record this user is linked to.
29351
29958
  */
29352
29959
  get LinkedEntityRecordID(): string | null;
29353
29960
  set LinkedEntityRecordID(value: string | null);
@@ -29415,6 +30022,7 @@ export declare class UserEntity extends BaseEntity<UserEntityType> {
29415
30022
  * * Schema: __mj
29416
30023
  * * Base Table: VectorDatabase
29417
30024
  * * Base View: vwVectorDatabases
30025
+ * * @description Configures connections to vector database systems for AI embeddings, similarity search, and semantic operations.
29418
30026
  * * Primary Key: ID
29419
30027
  * @extends {BaseEntity}
29420
30028
  * @class
@@ -29459,6 +30067,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29459
30067
  * * Field Name: DefaultURL
29460
30068
  * * Display Name: Default URL
29461
30069
  * * SQL Data Type: nvarchar(255)
30070
+ * * Description: Field DefaultURL for entity Vector Databases.
29462
30071
  */
29463
30072
  get DefaultURL(): string | null;
29464
30073
  set DefaultURL(value: string | null);
@@ -29466,6 +30075,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29466
30075
  * * Field Name: ClassKey
29467
30076
  * * Display Name: Class Key
29468
30077
  * * SQL Data Type: nvarchar(100)
30078
+ * * Description: Field ClassKey for entity Vector Databases.
29469
30079
  */
29470
30080
  get ClassKey(): string | null;
29471
30081
  set ClassKey(value: string | null);
@@ -29489,6 +30099,7 @@ export declare class VectorDatabaseEntity extends BaseEntity<VectorDatabaseEntit
29489
30099
  * * Schema: __mj
29490
30100
  * * Base Table: VectorIndex
29491
30101
  * * Base View: vwVectorIndexes
30102
+ * * @description Defines vector indexes within a given Vector Database.
29492
30103
  * * Primary Key: ID
29493
30104
  * @extends {BaseEntity}
29494
30105
  * @class
@@ -29577,6 +30188,7 @@ export declare class VectorIndexEntity extends BaseEntity<VectorIndexEntityType>
29577
30188
  * * Schema: __mj
29578
30189
  * * Base Table: VersionInstallation
29579
30190
  * * Base View: vwVersionInstallations
30191
+ * * @description Records installation history of system versions, tracking deployments, rollbacks, and version-specific configurations.
29580
30192
  * * Primary Key: ID
29581
30193
  * @extends {BaseEntity}
29582
30194
  * @class
@@ -29607,6 +30219,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29607
30219
  * * Field Name: MajorVersion
29608
30220
  * * Display Name: Major Version
29609
30221
  * * SQL Data Type: int
30222
+ * * Description: Major version number installed.
29610
30223
  */
29611
30224
  get MajorVersion(): number;
29612
30225
  set MajorVersion(value: number);
@@ -29614,6 +30227,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29614
30227
  * * Field Name: MinorVersion
29615
30228
  * * Display Name: Minor Version
29616
30229
  * * SQL Data Type: int
30230
+ * * Description: Minor version number installed.
29617
30231
  */
29618
30232
  get MinorVersion(): number;
29619
30233
  set MinorVersion(value: number);
@@ -29621,6 +30235,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29621
30235
  * * Field Name: PatchVersion
29622
30236
  * * Display Name: Patch Version
29623
30237
  * * SQL Data Type: int
30238
+ * * Description: Patch version number installed.
29624
30239
  */
29625
30240
  get PatchVersion(): number;
29626
30241
  set PatchVersion(value: number);
@@ -29641,6 +30256,7 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29641
30256
  * * Field Name: InstalledAt
29642
30257
  * * Display Name: Installed At
29643
30258
  * * SQL Data Type: datetime
30259
+ * * Description: Timestamp when this version was installed.
29644
30260
  */
29645
30261
  get InstalledAt(): Date;
29646
30262
  set InstalledAt(value: Date);
@@ -29701,10 +30317,12 @@ export declare class VersionInstallationEntity extends BaseEntity<VersionInstall
29701
30317
  * * Schema: __mj
29702
30318
  * * Base Table: WorkflowEngine
29703
30319
  * * Base View: vwWorkflowEngines
30320
+ * * @description Registers available workflow execution engines with their capabilities, configuration, and supported workflow types.
29704
30321
  * * Primary Key: ID
29705
30322
  * @extends {BaseEntity}
29706
30323
  * @class
29707
30324
  * @public
30325
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29708
30326
  */
29709
30327
  export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntityType> {
29710
30328
  /**
@@ -29742,6 +30360,7 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29742
30360
  * * Field Name: DriverPath
29743
30361
  * * Display Name: Driver Path
29744
30362
  * * SQL Data Type: nvarchar(500)
30363
+ * * Description: Import path for the workflow engine driver.
29745
30364
  */
29746
30365
  get DriverPath(): string;
29747
30366
  set DriverPath(value: string);
@@ -29749,6 +30368,7 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29749
30368
  * * Field Name: DriverClass
29750
30369
  * * Display Name: Driver Class
29751
30370
  * * SQL Data Type: nvarchar(100)
30371
+ * * Description: Class name implementing the workflow engine interface.
29752
30372
  */
29753
30373
  get DriverClass(): string;
29754
30374
  set DriverClass(value: string);
@@ -29772,10 +30392,12 @@ export declare class WorkflowEngineEntity extends BaseEntity<WorkflowEngineEntit
29772
30392
  * * Schema: __mj
29773
30393
  * * Base Table: WorkflowRun
29774
30394
  * * Base View: vwWorkflowRuns
30395
+ * * @description Tracks execution instances of workflows including status, timing, context data, and detailed step-by-step results.
29775
30396
  * * Primary Key: ID
29776
30397
  * @extends {BaseEntity}
29777
30398
  * @class
29778
30399
  * @public
30400
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29779
30401
  */
29780
30402
  export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType> {
29781
30403
  /**
@@ -29809,6 +30431,7 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29809
30431
  * * Field Name: ExternalSystemRecordID
29810
30432
  * * Display Name: External System Record
29811
30433
  * * SQL Data Type: nvarchar(500)
30434
+ * * Description: Field ExternalSystemRecordID for entity Workflow Runs.
29812
30435
  */
29813
30436
  get ExternalSystemRecordID(): string;
29814
30437
  set ExternalSystemRecordID(value: string);
@@ -29842,6 +30465,7 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29842
30465
  /**
29843
30466
  * * Field Name: Results
29844
30467
  * * SQL Data Type: nvarchar(MAX)
30468
+ * * Description: JSON-formatted detailed results from the workflow execution, including outputs from each step and any error information.
29845
30469
  */
29846
30470
  get Results(): string | null;
29847
30471
  set Results(value: string | null);
@@ -29877,10 +30501,12 @@ export declare class WorkflowRunEntity extends BaseEntity<WorkflowRunEntityType>
29877
30501
  * * Schema: __mj
29878
30502
  * * Base Table: Workflow
29879
30503
  * * Base View: vwWorkflows
30504
+ * * @description Defines automated workflows with steps, conditions, and actions for orchestrating complex business processes.
29880
30505
  * * Primary Key: ID
29881
30506
  * @extends {BaseEntity}
29882
30507
  * @class
29883
30508
  * @public
30509
+ * @deprecated This entity is deprecated and will be removed in a future version. Using it will result in console warnings.
29884
30510
  */
29885
30511
  export declare class WorkflowEntity extends BaseEntity<WorkflowEntityType> {
29886
30512
  /**
@@ -29926,6 +30552,7 @@ export declare class WorkflowEntity extends BaseEntity<WorkflowEntityType> {
29926
30552
  * * Field Name: ExternalSystemRecordID
29927
30553
  * * Display Name: External System Record
29928
30554
  * * SQL Data Type: nvarchar(100)
30555
+ * * Description: The unique identifier of this workflow in an external system, used for synchronization with external workflow engines.
29929
30556
  */
29930
30557
  get ExternalSystemRecordID(): string;
29931
30558
  set ExternalSystemRecordID(value: string);
@@ -30057,6 +30684,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30057
30684
  * * Field Name: ResourceRecordID
30058
30685
  * * Display Name: Resource Record ID
30059
30686
  * * SQL Data Type: nvarchar(2000)
30687
+ * * Description: The ID of the resource (such as a view, dashboard, or other entity record) that is included in this workspace.
30060
30688
  */
30061
30689
  get ResourceRecordID(): string | null;
30062
30690
  set ResourceRecordID(value: string | null);
@@ -30064,6 +30692,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30064
30692
  * * Field Name: Sequence
30065
30693
  * * Display Name: Sequence
30066
30694
  * * SQL Data Type: int
30695
+ * * Description: The display order of this item within the workspace, used for arranging resources in the user interface.
30067
30696
  */
30068
30697
  get Sequence(): number;
30069
30698
  set Sequence(value: number);
@@ -30071,6 +30700,7 @@ export declare class WorkspaceItemEntity extends BaseEntity<WorkspaceItemEntityT
30071
30700
  * * Field Name: Configuration
30072
30701
  * * Display Name: Configuration
30073
30702
  * * SQL Data Type: nvarchar(MAX)
30703
+ * * Description: JSON configuration data specific to this workspace item, storing custom settings and state information.
30074
30704
  */
30075
30705
  get Configuration(): string | null;
30076
30706
  set Configuration(value: string | null);