@memberjunction/core-entities 1.6.1 → 1.7.1

package/dist/generated/entity_subclasses.d.ts

@@ -1847,6 +1847,14 @@ export declare class EntityEntity extends BaseEntity {
     get PreferredCommunicationField(): string | null;
     set PreferredCommunicationField(value: string | null);
     /**
+    * * Field Name: Icon
+    * * Display Name: Icon
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Optional, specify an icon (CSS Class) for each entity for display in the UI
+    */
+    get Icon(): string | null;
+    set Icon(value: string | null);
+    /**
     * * Field Name: CodeName
     * * Display Name: Code Name
     * * SQL Data Type: nvarchar(MAX)
@@ -2924,6 +2932,23 @@ export declare class ApplicationEntity extends BaseEntity {
     get Description(): string | null;
     set Description(value: string | null);
     /**
+    * * Field Name: Icon
+    * * Display Name: Icon
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Specify the CSS class information for the display icon for each application.
+    */
+    get Icon(): string | null;
+    set Icon(value: string | null);
+    /**
+    * * Field Name: DefaultForNewUser
+    * * Display Name: Default For New User
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: If turned on, when a new user first uses the MJ Explorer app, the application records with this turned on will have this application included in their selected application list.
+    */
+    get DefaultForNewUser(): boolean;
+    set DefaultForNewUser(value: boolean);
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime
@@ -2993,7 +3018,8 @@ export declare class ApplicationEntityEntity extends BaseEntity {
     * * Field Name: DefaultForNewUser
     * * Display Name: Default For New User
     * * SQL Data Type: bit
-    * * Default Value: 0
+    * * Default Value: 1
+    * * Description: When set to 1, the entity will be included by default for a new user when they first access the application in question
     */
     get DefaultForNewUser(): boolean;
     set DefaultForNewUser(value: boolean);
@@ -4100,7 +4126,7 @@ export declare class RecordChangeEntity extends BaseEntity {
     /**
     * * Field Name: RecordID
     * * Display Name: Record
-    * * SQL Data Type: nvarchar(255)
+    * * SQL Data Type: nvarchar(750)
     */
     get RecordID(): string;
     set RecordID(value: string);
@@ -4109,14 +4135,42 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * Display Name: User ID
     * * SQL Data Type: int
     * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    * * Description: The user that made the change
     */
     get UserID(): number;
     set UserID(value: number);
     /**
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Create
+    * * Description: Create, Update, or Delete
+    */
+    get Type(): string;
+    set Type(value: string);
+    /**
+    * * Field Name: Source
+    * * Display Name: Source
+    * * SQL Data Type: nvarchar(20)
+    * * Description: Internal or External
+    */
+    get Source(): string | null;
+    set Source(value: string | null);
+    /**
+    * * Field Name: IntegrationID
+    * * Display Name: Integration ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Integrations (vwIntegrations.ID)
+    * * Description: If Source=External, this field can optionally specify which integration created the change, if known
+    */
+    get IntegrationID(): number | null;
+    set IntegrationID(value: number | null);
+    /**
     * * Field Name: ChangedAt
     * * Display Name: Changed At
     * * SQL Data Type: datetime
     * * Default Value: getdate()
+    * * Description: The date/time that the change occured.
     */
     get ChangedAt(): Date;
     set ChangedAt(value: Date);
@@ -4124,6 +4178,7 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * Field Name: ChangesJSON
     * * Display Name: Changes JSON
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON structure that describes what was changed in a structured format.
     */
     get ChangesJSON(): string;
     set ChangesJSON(value: string);
@@ -4131,6 +4186,7 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * Field Name: ChangesDescription
     * * Display Name: Changes Description
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: A generated, human-readable description of what was changed.
     */
     get ChangesDescription(): string;
     set ChangesDescription(value: string);
@@ -4138,27 +4194,50 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * Field Name: FullRecordJSON
     * * Display Name: Full Record JSON
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: A complete snapshot of the record AFTER the change was applied in a JSON format that can be parsed.
     */
     get FullRecordJSON(): string;
     set FullRecordJSON(value: string);
     /**
     * * Field Name: Status
-    * * SQL Data Type: nchar(15)
+    * * SQL Data Type: nvarchar(50)
     * * Default Value: Complete
     * * Value List Type: List
     * * Possible Values
     *   * Pending
     *   * Complete
+    * * Description: For internal record changes generated within MJ, the status is immediately Complete. For external changes that are detected, the workflow starts off as Pending, then In Progress and finally either Complete or Error
     */
     get Status(): 'Pending' | 'Complete';
     set Status(value: 'Pending' | 'Complete');
     /**
+    * * Field Name: ErrorLog
+    * * Display Name: Error Log
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get ErrorLog(): string | null;
+    set ErrorLog(value: string | null);
+    /**
     * * Field Name: Comments
     * * SQL Data Type: nvarchar(MAX)
     */
     get Comments(): string | null;
     set Comments(value: string | null);
     /**
+    * * Field Name: CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get CreatedAt(): Date;
+    /**
+    * * Field Name: UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get UpdatedAt(): Date;
+    /**
     * * Field Name: Entity
     * * Display Name: Entity
     * * SQL Data Type: nvarchar(255)
@@ -4170,6 +4249,12 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * SQL Data Type: nvarchar(100)
     */
     get User(): string;
+    /**
+    * * Field Name: Integration
+    * * Display Name: Integration
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Integration(): string | null;
 }
 /**
  * User Roles - strongly typed entity sub-class
@@ -7963,6 +8048,13 @@ export declare class QueryEntity extends BaseEntity {
     get Name(): string;
     set Name(value: string);
     /**
+    * * Field Name: UserQuestion
+    * * Display Name: User Question
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get UserQuestion(): string | null;
+    set UserQuestion(value: string | null);
+    /**
     * * Field Name: Description
     * * Display Name: Description
     * * SQL Data Type: nvarchar(MAX)
@@ -7985,6 +8077,13 @@ export declare class QueryEntity extends BaseEntity {
     get SQL(): string | null;
     set SQL(value: string | null);
     /**
+    * * Field Name: TechnicalDescription
+    * * Display Name: Technical Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get TechnicalDescription(): string | null;
+    set TechnicalDescription(value: string | null);
+    /**
     * * Field Name: OriginalSQL
     * * Display Name: Original SQL
     * * SQL Data Type: nvarchar(MAX)
@@ -8017,10 +8116,19 @@ export declare class QueryEntity extends BaseEntity {
     * * Display Name: Quality Rank
     * * SQL Data Type: int
     * * Default Value: 0
+    * * Description: Value indicating the quality of the query, higher values mean a better quality
     */
     get QualityRank(): number | null;
     set QualityRank(value: number | null);
     /**
+    * * Field Name: ExecutionCostRank
+    * * Display Name: Execution Cost Rank
+    * * SQL Data Type: int
+    * * Description: Higher numbers indicate more execution overhead/time required. Useful for planning which queries to use in various scenarios.
+    */
+    get ExecutionCostRank(): number | null;
+    set ExecutionCostRank(value: number | null);
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime