@memberjunction/core-entities 1.6.0 → 1.7.0

package/dist/generated/entity_subclasses.js

@@ -2605,6 +2605,18 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
         this.Set('PreferredCommunicationField', value);
     }
     /**
+    * * 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() {
+        return this.Get('Icon');
+    }
+    set Icon(value) {
+        this.Set('Icon', value);
+    }
+    /**
     * * Field Name: CodeName
     * * Display Name: Code Name
     * * SQL Data Type: nvarchar(MAX)
@@ -4142,6 +4154,31 @@ let ApplicationEntity = class ApplicationEntity extends core_1.BaseEntity {
         this.Set('Description', value);
     }
     /**
+    * * 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() {
+        return this.Get('Icon');
+    }
+    set Icon(value) {
+        this.Set('Icon', value);
+    }
+    /**
+    * * 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() {
+        return this.Get('DefaultForNewUser');
+    }
+    set DefaultForNewUser(value) {
+        this.Set('DefaultForNewUser', value);
+    }
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime
@@ -4237,7 +4274,8 @@ let ApplicationEntityEntity = class ApplicationEntityEntity extends core_1.BaseE
     * * 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() {
         return this.Get('DefaultForNewUser');
@@ -5788,7 +5826,7 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
     /**
     * * Field Name: RecordID
     * * Display Name: Record
-    * * SQL Data Type: nvarchar(255)
+    * * SQL Data Type: nvarchar(750)
     */
     get RecordID() {
         return this.Get('RecordID');
@@ -5801,6 +5839,7 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.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() {
         return this.Get('UserID');
@@ -5809,10 +5848,49 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
         this.Set('UserID', value);
     }
     /**
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Create
+    * * Description: Create, Update, or Delete
+    */
+    get Type() {
+        return this.Get('Type');
+    }
+    set Type(value) {
+        this.Set('Type', value);
+    }
+    /**
+    * * Field Name: Source
+    * * Display Name: Source
+    * * SQL Data Type: nvarchar(20)
+    * * Description: Internal or External
+    */
+    get Source() {
+        return this.Get('Source');
+    }
+    set Source(value) {
+        this.Set('Source', value);
+    }
+    /**
+    * * 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() {
+        return this.Get('IntegrationID');
+    }
+    set IntegrationID(value) {
+        this.Set('IntegrationID', value);
+    }
+    /**
     * * Field Name: ChangedAt
     * * Display Name: Changed At
     * * SQL Data Type: datetime
     * * Default Value: getdate()
+    * * Description: The date/time that the change occured.
     */
     get ChangedAt() {
         return this.Get('ChangedAt');
@@ -5824,6 +5902,7 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.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() {
         return this.Get('ChangesJSON');
@@ -5835,6 +5914,7 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.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() {
         return this.Get('ChangesDescription');
@@ -5846,6 +5926,7 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.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() {
         return this.Get('FullRecordJSON');
@@ -5855,12 +5936,13 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
     }
     /**
     * * 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() {
         return this.Get('Status');
@@ -5869,6 +5951,17 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
         this.Set('Status', value);
     }
     /**
+    * * Field Name: ErrorLog
+    * * Display Name: Error Log
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get ErrorLog() {
+        return this.Get('ErrorLog');
+    }
+    set ErrorLog(value) {
+        this.Set('ErrorLog', value);
+    }
+    /**
     * * Field Name: Comments
     * * SQL Data Type: nvarchar(MAX)
     */
@@ -5879,6 +5972,24 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
         this.Set('Comments', value);
     }
     /**
+    * * Field Name: CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get CreatedAt() {
+        return this.Get('CreatedAt');
+    }
+    /**
+    * * Field Name: UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get UpdatedAt() {
+        return this.Get('UpdatedAt');
+    }
+    /**
     * * Field Name: Entity
     * * Display Name: Entity
     * * SQL Data Type: nvarchar(255)
@@ -5894,6 +6005,14 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
     get User() {
         return this.Get('User');
     }
+    /**
+    * * Field Name: Integration
+    * * Display Name: Integration
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Integration() {
+        return this.Get('Integration');
+    }
 };
 exports.RecordChangeEntity = RecordChangeEntity;
 exports.RecordChangeEntity = RecordChangeEntity = __decorate([
@@ -11207,6 +11326,17 @@ let QueryEntity = class QueryEntity extends core_1.BaseEntity {
         this.Set('Name', value);
     }
     /**
+    * * Field Name: UserQuestion
+    * * Display Name: User Question
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get UserQuestion() {
+        return this.Get('UserQuestion');
+    }
+    set UserQuestion(value) {
+        this.Set('UserQuestion', value);
+    }
+    /**
     * * Field Name: Description
     * * Display Name: Description
     * * SQL Data Type: nvarchar(MAX)
@@ -11241,6 +11371,17 @@ let QueryEntity = class QueryEntity extends core_1.BaseEntity {
         this.Set('SQL', value);
     }
     /**
+    * * Field Name: TechnicalDescription
+    * * Display Name: Technical Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get TechnicalDescription() {
+        return this.Get('TechnicalDescription');
+    }
+    set TechnicalDescription(value) {
+        this.Set('TechnicalDescription', value);
+    }
+    /**
     * * Field Name: OriginalSQL
     * * Display Name: Original SQL
     * * SQL Data Type: nvarchar(MAX)
@@ -11285,6 +11426,7 @@ let QueryEntity = class QueryEntity extends core_1.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() {
         return this.Get('QualityRank');
@@ -11293,6 +11435,18 @@ let QueryEntity = class QueryEntity extends core_1.BaseEntity {
         this.Set('QualityRank', value);
     }
     /**
+    * * 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() {
+        return this.Get('ExecutionCostRank');
+    }
+    set ExecutionCostRank(value) {
+        this.Set('ExecutionCostRank', value);
+    }
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime