@memberjunction/core-entities 0.9.122 → 0.9.124

package/dist/generated/entity_subclasses.d.ts

@@ -4,7 +4,6 @@ import { BaseEntity, EntitySaveOptions } from "@memberjunction/core";
  * * 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
@@ -80,7 +79,6 @@ export declare class CompanyEntity extends BaseEntity {
  * * Schema: admin
  * * Base Table: Employee
  * * Base View: vwEmployees
- * * @description Employees
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -134,7 +132,6 @@ export declare class EmployeeEntity extends BaseEntity {
     /**
     * * Field Name: Email
     * * SQL Data Type: nvarchar(100)
-    * * Description: 5
     */
     get Email(): string;
     set Email(value: string);
@@ -775,7 +772,6 @@ export declare class IntegrationURLFormatEntity extends BaseEntity {
  * * 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
@@ -1094,7 +1090,6 @@ export declare class EntityFieldEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     /**
@@ -1122,6 +1117,15 @@ export declare class EntityFieldEntity extends BaseEntity {
     get Description(): string;
     set Description(value: string);
     /**
+    * * 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(): boolean;
+    set AutoUpdateDescription(value: boolean);
+    /**
     * * Field Name: IsPrimaryKey
     * * Display Name: Is Primary Key
     * * SQL Data Type: bit
@@ -1295,7 +1299,6 @@ export declare class EntityFieldEntity extends BaseEntity {
     * * Field Name: RelatedEntityID
     * * Display Name: RelatedEntity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get RelatedEntityID(): number;
     set RelatedEntityID(value: number);
@@ -1412,7 +1415,6 @@ export declare class EntityFieldEntity extends BaseEntity {
  * * 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
@@ -1441,7 +1443,6 @@ export declare class EntityEntity extends BaseEntity {
     * * Display Name: Parent ID
     * * SQL Data Type: int
     * * Related Entity: Entities
-    * * Description: Reserved for future use
     */
     get ParentID(): number;
     set ParentID(value: number);
@@ -1465,6 +1466,15 @@ export declare class EntityEntity extends BaseEntity {
     get Description(): string;
     set Description(value: string);
     /**
+    * * 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(): boolean;
+    set AutoUpdateDescription(value: boolean);
+    /**
     * * Field Name: BaseTable
     * * Display Name: Base Table
     * * SQL Data Type: nvarchar(255)
@@ -1490,7 +1500,6 @@ export declare class EntityEntity extends BaseEntity {
     * * Display Name: Schema Name
     * * SQL Data Type: nvarchar(255)
     * * Default Value: N'dbo'
-    * * Description: Database Schema Name
     */
     get SchemaName(): string;
     /**
@@ -1530,7 +1539,6 @@ export declare class EntityEntity extends 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(): boolean;
     set IncludeInAPI(value: boolean);
@@ -1547,7 +1555,6 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowUpdateAPI(value: boolean);
@@ -1580,7 +1587,6 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowUserSearchAPI(value: boolean);
@@ -1710,7 +1716,6 @@ export declare class EntityEntity extends 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(): string;
     set EntityObjectSubclassName(value: string);
@@ -1718,7 +1723,6 @@ export declare class EntityEntity extends 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(): string;
     set EntityObjectSubclassImport(value: string);
@@ -2146,7 +2150,6 @@ export declare class EntityRelationshipEntity extends BaseEntity {
  * * 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
@@ -2268,7 +2271,6 @@ export declare class UserRecordLogEntity extends BaseEntity {
  * * 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
@@ -2304,7 +2306,6 @@ export declare class UserViewEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -2472,7 +2473,6 @@ export declare class UserViewEntity extends BaseEntity {
  * * 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
@@ -2560,7 +2560,6 @@ export declare class CompanyIntegrationRunEntity extends BaseEntity {
  * * 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
@@ -2605,7 +2604,6 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -2859,7 +2857,6 @@ export declare class ApplicationEntityEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -2958,7 +2955,6 @@ export declare class EntityPermissionEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -3124,7 +3120,6 @@ export declare class UserApplicationEntityEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -3360,7 +3355,6 @@ export declare class ListEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -3402,12 +3396,6 @@ export declare class ListEntity extends BaseEntity {
     */
     get UpdatedAt(): Date;
     /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity(): string;
-    /**
     * * Field Name: User
     * * Display Name: User
     * * SQL Data Type: nvarchar(100)
@@ -3865,7 +3853,6 @@ export declare class WorkflowEngineEntity extends BaseEntity {
  * * 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
@@ -4222,7 +4209,6 @@ export declare class AuditLogEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -4253,12 +4239,6 @@ export declare class AuditLogEntity extends BaseEntity {
     * * SQL Data Type: nvarchar(100)
     */
     get User(): string;
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity(): string;
 }
 /**
  * Authorizations - strongly typed entity sub-class
@@ -6298,7 +6278,6 @@ export declare class TaggedItemEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -6315,12 +6294,6 @@ export declare class TaggedItemEntity extends BaseEntity {
     * * SQL Data Type: nvarchar(255)
     */
     get Tag(): string;
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity(): string;
 }
 /**
  * Workspaces - strongly typed entity sub-class
@@ -7237,7 +7210,6 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -7262,12 +7234,6 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
     * * Default Value: getdate()
     */
     get UpdatedAt(): Date;
-    /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity(): string;
 }
 /**
  * Record Merge Logs - strongly typed entity sub-class
@@ -7560,10 +7526,25 @@ export declare class QueryFieldEntity extends BaseEntity {
     get Sequence(): number;
     set Sequence(value: number);
     /**
+    * * 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(): string;
+    set SQLBaseType(value: string);
+    /**
+    * * 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(): string;
+    set SQLFullType(value: string);
+    /**
     * * Field Name: SourceEntityID
     * * Display Name: Source Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get SourceEntityID(): number;
     set SourceEntityID(value: number);
@@ -7624,12 +7605,6 @@ export declare class QueryFieldEntity extends BaseEntity {
     * * SQL Data Type: nvarchar(255)
     */
     get Query(): string;
-    /**
-    * * Field Name: SourceEntity
-    * * Display Name: Source Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get SourceEntity(): string;
 }
 /**
  * Query Categories - strongly typed entity sub-class
@@ -8126,6 +8101,7 @@ export declare class EntityDocumentRunEntity extends BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Description: Can be Pending, In Progress, Completed, or Failed
     */
     get Status(): string;
     set Status(value: string);
@@ -8382,7 +8358,6 @@ export declare class EntityDocumentEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -8424,12 +8399,6 @@ export declare class EntityDocumentEntity extends BaseEntity {
     */
     get UpdatedAt(): Date;
     /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
-    */
-    get Entity(): string;
-    /**
     * * Field Name: Type
     * * Display Name: Type
     * * SQL Data Type: nvarchar(100)
@@ -8441,6 +8410,7 @@ export declare class EntityDocumentEntity extends BaseEntity {
  * * 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
@@ -8479,6 +8449,7 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * Display Name: Data Context ID
     * * SQL Data Type: int
     * * Related Entity: Data Contexts
+    * * Description: Foreign key to the DataContext table
     */
     get DataContextID(): number;
     set DataContextID(value: number);
@@ -8486,13 +8457,41 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * 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(): string;
     set Type(value: string);
     /**
+    * * Field Name: ViewID
+    * * Display Name: View ID
+    * * SQL Data Type: int
+    * * Related Entity: User Views
+    * * Description: Only used if Type='view'
+    */
+    get ViewID(): number;
+    set ViewID(value: number);
+    /**
+    * * Field Name: QueryID
+    * * Display Name: Query ID
+    * * SQL Data Type: int
+    * * Related Entity: Queries
+    * * Description: Only used if Type='query'
+    */
+    get QueryID(): number;
+    set QueryID(value: number);
+    /**
+    * * Field Name: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: int
+    * * Description: Used if type='full_entity' or type='single_record'
+    */
+    get EntityID(): number;
+    set EntityID(value: number);
+    /**
     * * 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(): number;
     set RecordID(value: number);
@@ -8500,6 +8499,7 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * Field Name: SQL
     * * Display Name: SQL
     * * SQL Data Type: nvarchar(MAX)
+    * * Description: Only used when Type=sql
     */
     get SQL(): string;
     set SQL(value: string);
@@ -8507,6 +8507,7 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * 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(): string;
     set DataJSON(value: string);
@@ -8514,6 +8515,7 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * 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(): Date;
     set LastRefreshedAt(value: Date);
@@ -8535,15 +8537,27 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * Field Name: DataContext
     * * Display Name: Data Context
     * * SQL Data Type: nvarchar(255)
-    * * Default Value: null
     */
     get DataContext(): string;
+    /**
+    * * Field Name: View
+    * * Display Name: View
+    * * SQL Data Type: nvarchar(100)
+    */
+    get View(): string;
+    /**
+    * * Field Name: Query
+    * * Display Name: Query
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Query(): string;
 }
 /**
  * Data Contexts - strongly typed entity sub-class
  * * 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
@@ -8624,7 +8638,6 @@ export declare class DataContextEntity extends BaseEntity {
     * * Field Name: User
     * * Display Name: User
     * * SQL Data Type: nvarchar(100)
-    * * Default Value: null
     */
     get User(): string;
 }