@memberjunction/core-entities 0.9.122 → 0.9.124

package/dist/generated/entity_subclasses.js

@@ -15,7 +15,6 @@ const global_1 = require("@memberjunction/global");
  * * Schema: admin
  * * Base Table: Company
  * * Base View: vwCompanies
- * * @description List of Companies/Organizations within the top-level business, used for subsidiaries
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -125,7 +124,6 @@ exports.CompanyEntity = CompanyEntity = __decorate([
  * * Schema: admin
  * * Base Table: Employee
  * * Base View: vwEmployees
- * * @description Employees
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -199,7 +197,6 @@ let EmployeeEntity = class EmployeeEntity extends core_1.BaseEntity {
     /**
     * * Field Name: Email
     * * SQL Data Type: nvarchar(100)
-    * * Description: 5
     */
     get Email() {
         return this.Get('Email');
@@ -1086,7 +1083,6 @@ exports.IntegrationURLFormatEntity = IntegrationURLFormatEntity = __decorate([
  * * Schema: admin
  * * Base Table: Integration
  * * Base View: vwIntegrations
- * * @description List of integrations that can be executed using the MemberJunction integration architecture.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -1537,7 +1533,6 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -1579,6 +1574,19 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
         this.Set('Description', value);
     }
     /**
+    * * Field Name: AutoUpdateDescription
+    * * Display Name: Auto Update Description
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: When set to 1 (default), whenever a description is modified in the column within the underlying view (first choice) or table (second choice), the Description column in the entity field definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity field definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
+    */
+    get AutoUpdateDescription() {
+        return this.Get('AutoUpdateDescription');
+    }
+    set AutoUpdateDescription(value) {
+        this.Set('AutoUpdateDescription', value);
+    }
+    /**
     * * Field Name: IsPrimaryKey
     * * Display Name: Is Primary Key
     * * SQL Data Type: bit
@@ -1832,7 +1840,6 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
     * * Field Name: RelatedEntityID
     * * Display Name: RelatedEntity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get RelatedEntityID() {
         return this.Get('RelatedEntityID');
@@ -1997,7 +2004,6 @@ exports.EntityFieldEntity = EntityFieldEntity = __decorate([
  * * Schema: admin
  * * Base Table: Entity
  * * Base View: vwEntities
- * * @description Metadata about all of the entities in the system. This information is managed by CodeGen, don't modify the parts that come from SQL Server
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -2032,7 +2038,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Parent ID
     * * SQL Data Type: int
     * * Related Entity: Entities
-    * * Description: Reserved for future use
     */
     get ParentID() {
         return this.Get('ParentID');
@@ -2072,6 +2077,19 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
         this.Set('Description', value);
     }
     /**
+    * * Field Name: AutoUpdateDescription
+    * * Display Name: Auto Update Description
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: When set to 1 (default), whenever a description is modified in the underlying view (first choice) or table (second choice), the Description column in the entity definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
+    */
+    get AutoUpdateDescription() {
+        return this.Get('AutoUpdateDescription');
+    }
+    set AutoUpdateDescription(value) {
+        this.Set('AutoUpdateDescription', value);
+    }
+    /**
     * * Field Name: BaseTable
     * * Display Name: Base Table
     * * SQL Data Type: nvarchar(255)
@@ -2107,7 +2125,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Schema Name
     * * SQL Data Type: nvarchar(255)
     * * Default Value: N'dbo'
-    * * Description: Database Schema Name
     */
     get SchemaName() {
         return this.Get('SchemaName');
@@ -2165,7 +2182,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Include In API
     * * SQL Data Type: bit
     * * Default Value: 0
-    * * Description: Master switch to control if the field is included in the API or not
     */
     get IncludeInAPI() {
         return this.Get('IncludeInAPI');
@@ -2190,7 +2206,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow Update API
     * * SQL Data Type: bit
     * * Default Value: 0
-    * * Description: If set to 1, allows updates to occur via API. Role based permissions are required in addition to turning this bit on.
     */
     get AllowUpdateAPI() {
         return this.Get('AllowUpdateAPI');
@@ -2239,7 +2254,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow User Search API
     * * SQL Data Type: bit
     * * Default Value: 0
-    * * Description: If set to 1, allows an end user to add their own search string when running a user view or searching without saving a view
     */
     get AllowUserSearchAPI() {
         return this.Get('AllowUserSearchAPI');
@@ -2437,7 +2451,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Field Name: EntityObjectSubclassName
     * * Display Name: Entity Object Subclass Name
     * * SQL Data Type: nvarchar(255)
-    * * Description: Normally, CodeGen will sub-class BaseEntity to create a strongly-typed sub-class for each entity. If you provide a value here and in EntityObjectSubclassImport, CodeGen will sub-class the provided class instead of BaseEntity. Also make sure to provide a value for EntityObjectSubclassImport with the name of the module to import that contains an exported class of the name you provide in EntityObjectSubclassName.
     */
     get EntityObjectSubclassName() {
         return this.Get('EntityObjectSubclassName');
@@ -2449,7 +2462,6 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Field Name: EntityObjectSubclassImport
     * * Display Name: Entity Object Subclass Import
     * * SQL Data Type: nvarchar(255)
-    * * Description: Normally, CodeGen will sub-class BaseEntity to create a strongly-typed sub-class for each entity. If you provide a value here and in EntityObjectSubclassName, CodeGen will sub-class the provided class instead of BaseEntity. Also make sure to provide a value for EntityObjectSubclassName with the name of the class itself. This field should have the name of the module  to import that contains an exported class of the name you provide in EntityObjectSubclassName.
     */
     get EntityObjectSubclassImport() {
         return this.Get('EntityObjectSubclassImport');
@@ -3059,7 +3071,6 @@ exports.EntityRelationshipEntity = EntityRelationshipEntity = __decorate([
  * * Schema: admin
  * * Base Table: UserRecordLog
  * * Base View: vwUserRecordLogs
- * * @description Tracks history of user access to records across the system, tracks reads and writes
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3229,7 +3240,6 @@ exports.UserRecordLogEntity = UserRecordLogEntity = __decorate([
  * * Schema: admin
  * * Base Table: UserView
  * * Base View: vwUserViews
- * * @description User Views contain the metadata for the user viewing system of entity data
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3275,7 +3285,6 @@ let UserViewEntity = class UserViewEntity extends core_1.BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -3525,7 +3534,6 @@ exports.UserViewEntity = UserViewEntity = __decorate([
  * * Schema: admin
  * * Base Table: CompanyIntegrationRun
  * * Base View: vwCompanyIntegrationRuns
- * * @description Audit Trail for each run of a given company integration
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3651,7 +3659,6 @@ exports.CompanyIntegrationRunEntity = CompanyIntegrationRunEntity = __decorate([
  * * Schema: admin
  * * Base Table: CompanyIntegrationRunDetail
  * * Base View: vwCompanyIntegrationRunDetails
- * * @description Record-level details for the audit trail for each integration run
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3708,7 +3715,6 @@ let CompanyIntegrationRunDetailEntity = class CompanyIntegrationRunDetailEntity
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -4072,7 +4078,6 @@ let ApplicationEntityEntity = class ApplicationEntityEntity extends core_1.BaseE
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -4209,7 +4214,6 @@ let EntityPermissionEntity = class EntityPermissionEntity extends core_1.BaseEnt
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -4445,7 +4449,6 @@ let UserApplicationEntityEntity = class UserApplicationEntityEntity extends core
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -4781,7 +4784,6 @@ let ListEntity = class ListEntity extends core_1.BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -4843,14 +4845,6 @@ let ListEntity = class ListEntity extends core_1.BaseEntity {
         return this.Get('UpdatedAt');
     }
     /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity() {
-        return this.Get('Entity');
-    }
-    /**
     * * Field Name: User
     * * Display Name: User
     * * SQL Data Type: nvarchar(100)
@@ -5496,7 +5490,6 @@ exports.WorkflowEngineEntity = WorkflowEngineEntity = __decorate([
  * * Schema: admin
  * * Base Table: RecordChange
  * * Base View: vwRecordChanges
- * * @description Tracks history of all pending and complete data changes to records
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -5993,7 +5986,6 @@ let AuditLogEntity = class AuditLogEntity extends core_1.BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -6038,14 +6030,6 @@ let AuditLogEntity = class AuditLogEntity extends core_1.BaseEntity {
     get User() {
         return this.Get('User');
     }
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity() {
-        return this.Get('Entity');
-    }
 };
 exports.AuditLogEntity = AuditLogEntity;
 exports.AuditLogEntity = AuditLogEntity = __decorate([
@@ -8901,7 +8885,6 @@ let TaggedItemEntity = class TaggedItemEntity extends core_1.BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -8928,14 +8911,6 @@ let TaggedItemEntity = class TaggedItemEntity extends core_1.BaseEntity {
     get Tag() {
         return this.Get('Tag');
     }
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity() {
-        return this.Get('Entity');
-    }
 };
 exports.TaggedItemEntity = TaggedItemEntity;
 exports.TaggedItemEntity = TaggedItemEntity = __decorate([
@@ -10224,7 +10199,6 @@ let CompanyIntegrationRecordMapEntity = class CompanyIntegrationRecordMapEntity
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -10261,14 +10235,6 @@ let CompanyIntegrationRecordMapEntity = class CompanyIntegrationRecordMapEntity
     get UpdatedAt() {
         return this.Get('UpdatedAt');
     }
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity() {
-        return this.Get('Entity');
-    }
 };
 exports.CompanyIntegrationRecordMapEntity = CompanyIntegrationRecordMapEntity;
 exports.CompanyIntegrationRecordMapEntity = CompanyIntegrationRecordMapEntity = __decorate([
@@ -10681,10 +10647,33 @@ let QueryFieldEntity = class QueryFieldEntity extends core_1.BaseEntity {
         this.Set('Sequence', value);
     }
     /**
+    * * Field Name: SQLBaseType
+    * * Display Name: SQLBase Type
+    * * SQL Data Type: nvarchar(50)
+    * * Description: The base type, not including parameters, in SQL. For example this field would be nvarchar or decimal, and wouldn't include type parameters. The SQLFullType field provides that information.
+    */
+    get SQLBaseType() {
+        return this.Get('SQLBaseType');
+    }
+    set SQLBaseType(value) {
+        this.Set('SQLBaseType', value);
+    }
+    /**
+    * * Field Name: SQLFullType
+    * * Display Name: SQLFull Type
+    * * SQL Data Type: nvarchar(100)
+    * * Description: The full SQL type for the field, for example datetime or nvarchar(10) etc.
+    */
+    get SQLFullType() {
+        return this.Get('SQLFullType');
+    }
+    set SQLFullType(value) {
+        this.Set('SQLFullType', value);
+    }
+    /**
     * * Field Name: SourceEntityID
     * * Display Name: Source Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get SourceEntityID() {
         return this.Get('SourceEntityID');
@@ -10775,14 +10764,6 @@ let QueryFieldEntity = class QueryFieldEntity extends core_1.BaseEntity {
     get Query() {
         return this.Get('Query');
     }
-    /**
-    * * Field Name: SourceEntity
-    * * Display Name: Source Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get SourceEntity() {
-        return this.Get('SourceEntity');
-    }
 };
 exports.QueryFieldEntity = QueryFieldEntity;
 exports.QueryFieldEntity = QueryFieldEntity = __decorate([
@@ -11467,6 +11448,7 @@ let EntityDocumentRunEntity = class EntityDocumentRunEntity extends core_1.BaseE
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Description: Can be Pending, In Progress, Completed, or Failed
     */
     get Status() {
         return this.Get('Status');
@@ -11825,7 +11807,6 @@ let EntityDocumentEntity = class EntityDocumentEntity extends core_1.BaseEntity
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -11887,14 +11868,6 @@ let EntityDocumentEntity = class EntityDocumentEntity extends core_1.BaseEntity
         return this.Get('UpdatedAt');
     }
     /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity() {
-        return this.Get('Entity');
-    }
-    /**
     * * Field Name: Type
     * * Display Name: Type
     * * SQL Data Type: nvarchar(100)
@@ -11912,6 +11885,7 @@ exports.EntityDocumentEntity = EntityDocumentEntity = __decorate([
  * * Schema: admin
  * * Base Table: DataContextItem
  * * Base View: vwDataContextItems
+ * * @description Data Context Items store information about each item within a Data Context. Each item stores a link to a view, query, or raw sql statement and can optionally cache the JSON representing the last run of that data object as well.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -11958,6 +11932,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Display Name: Data Context ID
     * * SQL Data Type: int
     * * Related Entity: Data Contexts
+    * * Description: Foreign key to the DataContext table
     */
     get DataContextID() {
         return this.Get('DataContextID');
@@ -11969,6 +11944,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: Type
     * * Display Name: Type
     * * SQL Data Type: nvarchar(50)
+    * * Description: The type of the item, either "view", "query", "full_entity", "single_record", or "sql"
     */
     get Type() {
         return this.Get('Type');
@@ -11977,9 +11953,48 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
         this.Set('Type', value);
     }
     /**
+    * * Field Name: ViewID
+    * * Display Name: View ID
+    * * SQL Data Type: int
+    * * Related Entity: User Views
+    * * Description: Only used if Type='view'
+    */
+    get ViewID() {
+        return this.Get('ViewID');
+    }
+    set ViewID(value) {
+        this.Set('ViewID', value);
+    }
+    /**
+    * * Field Name: QueryID
+    * * Display Name: Query ID
+    * * SQL Data Type: int
+    * * Related Entity: Queries
+    * * Description: Only used if Type='query'
+    */
+    get QueryID() {
+        return this.Get('QueryID');
+    }
+    set QueryID(value) {
+        this.Set('QueryID', value);
+    }
+    /**
+    * * Field Name: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: int
+    * * Description: Used if type='full_entity' or type='single_record'
+    */
+    get EntityID() {
+        return this.Get('EntityID');
+    }
+    set EntityID(value) {
+        this.Set('EntityID', value);
+    }
+    /**
     * * Field Name: RecordID
     * * Display Name: Record ID
     * * SQL Data Type: int
+    * * Description: The ID for the record, only used when Type='single_record'
     */
     get RecordID() {
         return this.Get('RecordID');
@@ -11991,6 +12006,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: SQL
     * * Display Name: SQL
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: Only used when Type=sql
     */
     get SQL() {
         return this.Get('SQL');
@@ -12002,6 +12018,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: DataJSON
     * * Display Name: Data JSON
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optionally used to cache results of an item. This can be used for performance optimization, and also for having snapshots of data for historical comparisons.
     */
     get DataJSON() {
         return this.Get('DataJSON');
@@ -12013,6 +12030,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: LastRefreshedAt
     * * Display Name: Last Refreshed At
     * * SQL Data Type: datetime
+    * * Description: If DataJSON is populated, this field will show the date the the data was captured
     */
     get LastRefreshedAt() {
         return this.Get('LastRefreshedAt');
@@ -12042,11 +12060,26 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: DataContext
     * * Display Name: Data Context
     * * SQL Data Type: nvarchar(255)
-    * * Default Value: null
     */
     get DataContext() {
         return this.Get('DataContext');
     }
+    /**
+    * * Field Name: View
+    * * Display Name: View
+    * * SQL Data Type: nvarchar(100)
+    */
+    get View() {
+        return this.Get('View');
+    }
+    /**
+    * * Field Name: Query
+    * * Display Name: Query
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Query() {
+        return this.Get('Query');
+    }
 };
 exports.DataContextItemEntity = DataContextItemEntity;
 exports.DataContextItemEntity = DataContextItemEntity = __decorate([
@@ -12057,6 +12090,7 @@ exports.DataContextItemEntity = DataContextItemEntity = __decorate([
  * * Schema: admin
  * * Base Table: DataContext
  * * Base View: vwDataContexts
+ * * @description Data Contexts are a primitive within the MemberJunction architecture. They store information about data contexts which are groups of data including views, queries, or raw SQL statements. Data contexts can be used in conversations, reports and more.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -12165,7 +12199,6 @@ let DataContextEntity = class DataContextEntity extends core_1.BaseEntity {
     * * Field Name: User
     * * Display Name: User
     * * SQL Data Type: nvarchar(100)
-    * * Default Value: null
     */
     get User() {
         return this.Get('User');