@memberjunction/core-entities 0.9.121 → 0.9.123

package/dist/generated/entity_subclasses.d.ts

@@ -1094,7 +1094,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 +1121,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 +1303,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);
@@ -1465,6 +1472,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)
@@ -2304,7 +2320,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);
@@ -2605,7 +2620,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 +2873,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 +2971,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 +3136,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 +3371,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 +3412,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)
@@ -4222,7 +4226,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 +4256,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 +6295,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 +6311,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
@@ -6846,6 +6836,13 @@ export declare class ConversationEntity extends BaseEntity {
     get LinkedRecordID(): number;
     set LinkedRecordID(value: number);
     /**
+    * * Field Name: DataContextID
+    * * Display Name: Data Context ID
+    * * SQL Data Type: int
+    */
+    get DataContextID(): number;
+    set DataContextID(value: number);
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime
@@ -7230,7 +7227,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);
@@ -7255,12 +7251,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
@@ -7556,7 +7546,6 @@ export declare class QueryFieldEntity extends BaseEntity {
     * * Field Name: SourceEntityID
     * * Display Name: Source Entity ID
     * * SQL Data Type: int
-    * * Related Entity: Entities
     */
     get SourceEntityID(): number;
     set SourceEntityID(value: number);
@@ -7617,12 +7606,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
@@ -8119,6 +8102,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);
@@ -8375,7 +8359,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);
@@ -8417,15 +8400,245 @@ export declare class EntityDocumentEntity extends BaseEntity {
     */
     get UpdatedAt(): Date;
     /**
-    * * Field Name: Entity
-    * * Display Name: Entity
-    * * SQL Data Type: nvarchar(255)
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(100)
     */
-    get Entity(): string;
+    get Type(): string;
+}
+/**
+ * Data Context Items - strongly typed entity sub-class
+ * * 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
+ * @public
+ */
+export declare class DataContextItemEntity extends BaseEntity {
+    /**
+    * Loads the Data Context Items record from the database
+    * @param ID: Number - primary key value to load the Data Context Items record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof DataContextItemEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Data Context Items - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof DataContextItemEntity
+    * @throws {Error} - Delete is not allowed for Data Context Items, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+* * Field Name: ID
+* * Display Name: ID
+* * SQL Data Type: int
+*/
+    get ID(): number;
+    /**
+    * * Field Name: DataContextID
+    * * 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);
     /**
     * * Field Name: Type
     * * Display Name: Type
-    * * SQL Data Type: nvarchar(100)
+    * * 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);
+    /**
+    * * Field Name: SQL
+    * * Display Name: SQL
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Only used when Type=sql
+    */
+    get SQL(): string;
+    set SQL(value: string);
+    /**
+    * * 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);
+    /**
+    * * 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);
+    /**
+    * * 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: DataContext
+    * * Display Name: Data Context
+    * * SQL Data Type: nvarchar(255)
+    */
+    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
+ * @public
+ */
+export declare class DataContextEntity extends BaseEntity {
+    /**
+    * Loads the Data Contexts record from the database
+    * @param ID: Number - primary key value to load the Data Contexts record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof DataContextEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Data Contexts - AllowDeleteAPI is set to 0 in the database.  Delete is not allowed, so this method is generated to override the base class method and throw an error. To enable delete for this entity, set AllowDeleteAPI to 1 in the database.
+    * @public
+    * @method
+    * @override
+    * @memberof DataContextEntity
+    * @throws {Error} - Delete is not allowed for Data Contexts, to enable it set AllowDeleteAPI to 1 in the database.
+    */
+    Delete(): Promise<boolean>;
+    /**
+* * Field Name: ID
+* * Display Name: ID
+* * SQL Data Type: int
+*/
+    get ID(): number;
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: UserID
+    * * Display Name: User ID
+    * * SQL Data Type: int
+    * * Related Entity: Users
+    */
+    get UserID(): number;
+    set UserID(value: number);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string;
+    set Description(value: string);
+    /**
+    * * Field Name: LastRefreshedAt
+    * * Display Name: Last Refreshed At
+    * * SQL Data Type: datetime
+    */
+    get LastRefreshedAt(): Date;
+    set LastRefreshedAt(value: Date);
+    /**
+    * * 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: User
+    * * Display Name: User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get User(): string;
 }