@memberjunction/core-entities 0.9.164 → 0.9.166

package/dist/generated/entity_subclasses.d.ts

@@ -4,6 +4,7 @@ import { BaseEntity, EntitySaveOptions } from "@memberjunction/core";
  * * Schema: __mj
  * * Base Table: Company
  * * Base View: vwCompanies
+ * * @description A list of organizational units within your business. These can be subsidiaries or divisions or other units. Companies are used to organizae employee records and also for separating integrations if you have multiple integrations of the same type of system.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -79,6 +80,7 @@ export declare class CompanyEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Employee
  * * Base View: vwEmployees
+ * * @description A list of employees across all units of your organization
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -214,6 +216,7 @@ export declare class EmployeeEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: UserFavorite
  * * Base View: vwUserFavorites
+ * * @description Records that each user can mark as a favorite for easy access
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -530,6 +533,7 @@ export declare class EmployeeSkillEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Role
  * * Base View: vwRoles
+ * * @description Roles are used for security administration and can have zero to many Users as members
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -549,15 +553,6 @@ export declare class RoleEntity extends BaseEntity {
     */
     Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
-    * Roles - 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 RoleEntity
-    * @throws {Error} - Delete is not allowed for Roles, to enable it set AllowDeleteAPI to 1 in the database.
-    */
-    Delete(): Promise<boolean>;
-    /**
 * * Field Name: ID
 * * SQL Data Type: int
 */
@@ -610,6 +605,7 @@ export declare class RoleEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Skill
  * * Base View: vwSkills
+ * * @description A hierarchical list of possible skills that are linked to Employees and can also be linked to any other entity
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -691,6 +687,7 @@ export declare class SkillEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: IntegrationURLFormat
  * * Base View: vwIntegrationURLFormats
+ * * @description Used to generate web links for end users to easily access resources in a source system. URL Formats support templating to inject various field values at run-time to take a user directly to a resource in a source system.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -775,6 +772,7 @@ export declare class IntegrationURLFormatEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Integration
  * * Base View: vwIntegrations
+ * * @description Catalog of all integrations that have been configured in the system.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -876,6 +874,7 @@ export declare class IntegrationEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: CompanyIntegration
  * * Base View: vwCompanyIntegrations
+ * * @description Links individual company records to specific integrations
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -1066,6 +1065,7 @@ export declare class CompanyIntegrationEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: EntityField
  * * Base View: vwEntityFields
+ * * @description List of all fields within each entity with metadata about each field
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -1420,6 +1420,7 @@ export declare class EntityFieldEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Entity
  * * Base View: vwEntities
+ * * @description Catalog of all entities across all schemas
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -1787,6 +1788,7 @@ export declare class EntityEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: User
  * * Base View: vwUsers
+ * * @description A list of all users who have or had access to the system
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -1943,6 +1945,7 @@ export declare class UserEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: EntityRelationship
  * * Base View: vwEntityRelationships
+ * * @description Metadata about relationships between entities including display preferences for the UI
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -2277,6 +2280,7 @@ export declare class UserRecordLogEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: UserView
  * * Base View: vwUserViews
+ * * @description Views are sets of records within a given entity defined by filtering rules. Views can be used programatically to retrieve dynamic sets of data and in user interfaces like MJ Explorer for end-user consumption.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -2774,6 +2778,7 @@ export declare class ErrorLogEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Application
  * * Base View: vwApplications
+ * * @description Applications are used to group entities in the user interface for ease of user access
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -2838,6 +2843,7 @@ export declare class ApplicationEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: ApplicationEntity
  * * Base View: vwApplicationEntities
+ * * @description List of entities within each application. An application can have any number of entities and an entity can be part of any number of applications.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -2945,6 +2951,7 @@ export declare class ApplicationEntityEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: EntityPermission
  * * Base View: vwEntityPermissions
+ * * @description Security settings for each entity
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3326,6 +3333,7 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: List
  * * Base View: vwLists
+ * * @description Static lists are useful for controlling a set of data for a given entity. These can be used programatically for applications like logging and tracking long-running tasks and also by end users for tracking any particular list of records they want to directly control the set.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3424,6 +3432,7 @@ export declare class ListEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: ListDetail
  * * Base View: vwListDetails
+ * * @description Tracks the records within each list.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3475,6 +3484,7 @@ export declare class ListDetailEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: UserViewRun
  * * Base View: vwUserViewRuns
+ * * @description User Views can be logged when run to capture the date and user that ran the view as well as the output results.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3548,6 +3558,7 @@ export declare class UserViewRunEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: UserViewRunDetail
  * * Base View: vwUserViewRunDetails
+ * * @description Tracks the set of records that were included in each run of a given user view.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -3870,6 +3881,7 @@ export declare class WorkflowEngineEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: RecordChange
  * * Base View: vwRecordChanges
+ * * @description For entities that have TrackRecordChanges=1, Record Changes will store the history of all changes made within the system. For integrations you can directly add values here if you have inbound signals indicating records were changed in a source system. This entity only automatically captures Record Changes if they were made within the system.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -4670,6 +4682,7 @@ export declare class EntityFieldValueEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: AIModel
  * * Base View: vwAIModels
+ * * @description Catalog of all AI Models configured in the system.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -4774,6 +4787,7 @@ export declare class AIModelEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: AIAction
  * * Base View: vwAIActions
+ * * @description List of all actions that are possible across all AI Models
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -4870,6 +4884,7 @@ export declare class AIActionEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: AIModelAction
  * * Base View: vwAIModelActions
+ * * @description Tracks the actions supported by each AI Model
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -4959,6 +4974,7 @@ export declare class AIModelActionEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: EntityAIAction
  * * Base View: vwEntityAIActions
+ * * @description Tracks the AI actions that should be invoked based on changes to records within a given entity.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -5113,6 +5129,7 @@ export declare class EntityAIActionEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: AIModelType
  * * Base View: vwAIModelTypes
+ * * @description Types of AI Models
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -5250,6 +5267,7 @@ export declare class QueueTypeEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Queue
  * * Base View: vwQueues
+ * * @description Queues can be used to async execute long running tasks
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -5528,6 +5546,7 @@ export declare class QueueTaskEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Dashboard
  * * Base View: vwDashboards
+ * * @description Dashboards are used to group resources into a single display pane for an end-user
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6191,6 +6210,7 @@ export declare class ResourceTypeEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Tag
  * * Base View: vwTags
+ * * @description Tags are used to arbitrarily associate any record in any entity with addtional information.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6274,6 +6294,7 @@ export declare class TagEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: TaggedItem
  * * Base View: vwTaggedItems
+ * * @description Tracks the links between any record in any entity with Tags
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6348,6 +6369,7 @@ export declare class TaggedItemEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Workspace
  * * Base View: vwWorkspaces
+ * * @description A user can have one or more workspaces
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6406,6 +6428,7 @@ export declare class WorkspaceEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: WorkspaceItem
  * * Base View: vwWorkspaceItems
+ * * @description Tracks the resources that are active within a given worksapce
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6499,6 +6522,7 @@ export declare class WorkspaceItemEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Dataset
  * * Base View: vwDatasets
+ * * @description Cacheable sets of data that can span one or more items
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -6575,6 +6599,7 @@ export declare class DatasetEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: DatasetItem
  * * Base View: vwDatasetItems
+ * * @description A single item in a Dataset and can be sourced from multiple methods.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -7021,6 +7046,7 @@ export declare class UserNotificationEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: SchemaInfo
  * * Base View: vwSchemaInfos
+ * * @description Tracks the schemas in the system and the ID ranges that are valid for entities within each schema.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class
@@ -7641,6 +7667,7 @@ export declare class QueryCategoryEntity extends BaseEntity {
  * * Schema: __mj
  * * Base Table: Query
  * * Base View: vwQueries
+ * * @description Catalog of stored queries. This is useful for any arbitrary query that is known to be performant and correct and can be reused. Queries can be viewed/run by a user, used programatically via RunQuery, and also used by AI systems for improved reliability instead of dynamically generated SQL. Queries can also improve security since they store the SQL instead of using dynamic SQL.
  * * Primary Key: ID
  * @extends {BaseEntity}
  * @class