@memberjunction/core-entities 0.9.171 → 0.9.173

package/dist/generated/entity_subclasses.js

@@ -2122,6 +2122,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Base View Generated
     * * SQL Data Type: bit
     * * Default Value: 1
+    * * Description: When set to 0, CodeGen no longer generates a base view for the entity.
     */
     get BaseViewGenerated() {
         return this.Get('BaseViewGenerated');
@@ -2155,6 +2156,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Track Record Changes
     * * SQL Data Type: bit
     * * Default Value: 1
+    * * Description: When set to 1, changes made via the MemberJunction architecture will result in tracking records being created in the RecordChange table
     */
     get TrackRecordChanges() {
         return this.Get('TrackRecordChanges');
@@ -2167,6 +2169,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Audit Record Access
     * * SQL Data Type: bit
     * * Default Value: 1
+    * * Description: When set to 1, accessing a record by an end-user will result in an Audit Log record being created
     */
     get AuditRecordAccess() {
         return this.Get('AuditRecordAccess');
@@ -2179,6 +2182,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Audit View Runs
     * * SQL Data Type: bit
     * * Default Value: 1
+    * * Description: When set to 1, users running a view against this entity will result in an Audit Log record being created.
     */
     get AuditViewRuns() {
         return this.Get('AuditViewRuns');
@@ -2191,6 +2195,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Include In API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: If set to 0, the entity will not be available at all in the GraphQL API or the object model.
     */
     get IncludeInAPI() {
         return this.Get('IncludeInAPI');
@@ -2203,6 +2208,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow All Rows API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: If set to 1, a GraphQL query will be enabled that allows access to all rows in the entity.
     */
     get AllowAllRowsAPI() {
         return this.Get('AllowAllRowsAPI');
@@ -2215,6 +2221,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow Update API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: Global flag controlling if updates are allowed for any user, or not. If set to 1, a GraqhQL mutation and stored procedure are created. Permissions are still required to perform the action but if this flag is set to 0, no user will be able to perform the action.
     */
     get AllowUpdateAPI() {
         return this.Get('AllowUpdateAPI');
@@ -2227,6 +2234,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow Create API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: Global flag controlling if creates are allowed for any user, or not. If set to 1, a GraqhQL mutation and stored procedure are created. Permissions are still required to perform the action but if this flag is set to 0, no user will be able to perform the action.
     */
     get AllowCreateAPI() {
         return this.Get('AllowCreateAPI');
@@ -2239,6 +2247,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow Delete API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: Global flag controlling if deletes are allowed for any user, or not. If set to 1, a GraqhQL mutation and stored procedure are created. Permissions are still required to perform the action but if this flag is set to 0, no user will be able to perform the action.
     */
     get AllowDeleteAPI() {
         return this.Get('AllowDeleteAPI');
@@ -2251,6 +2260,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Custom Resolver API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: Set to 1 if a custom resolver has been created for the entity.
     */
     get CustomResolverAPI() {
         return this.Get('CustomResolverAPI');
@@ -2263,6 +2273,7 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
     * * Display Name: Allow User Search API
     * * SQL Data Type: bit
     * * Default Value: 0
+    * * Description: Enabling this bit will result in search being possible at the API and UI layers
     */
     get AllowUserSearchAPI() {
         return this.Get('AllowUserSearchAPI');
@@ -2640,6 +2651,10 @@ let UserEntity = class UserEntity extends core_1.BaseEntity {
     /**
     * * Field Name: Type
     * * SQL Data Type: nchar(15)
+    * * Value List Type: List
+    * * Possible Values
+    *   * User
+    *   * Owner
     */
     get Type() {
         return this.Get('Type');
@@ -2876,6 +2891,10 @@ let EntityRelationshipEntity = class EntityRelationshipEntity extends core_1.Bas
     * * Field Name: Type
     * * SQL Data Type: nchar(20)
     * * Default Value: N'One To Many'
+    * * Value List Type: List
+    * * Possible Values
+    *   * One To Many
+    *   * Many To Many
     */
     get Type() {
         return this.Get('Type');
@@ -4707,6 +4726,15 @@ let CompanyIntegrationRunAPILogEntity = class CompanyIntegrationRunAPILogEntity
     * * Field Name: RequestMethod
     * * Display Name: Request Method
     * * SQL Data Type: nvarchar(12)
+    * * Value List Type: List
+    * * Possible Values
+    *   * GET
+    *   * POST
+    *   * PUT
+    *   * DELETE
+    *   * PATCH
+    *   * HEAD
+    *   * OPTIONS
     */
     get RequestMethod() {
         return this.Get('RequestMethod');
@@ -5240,6 +5268,12 @@ let WorkflowRunEntity = class WorkflowRunEntity extends core_1.BaseEntity {
     * * Field Name: Status
     * * SQL Data Type: nchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * In Progress
+    *   * Complete
+    *   * Failed
     */
     get Status() {
         return this.Get('Status');
@@ -5706,6 +5740,10 @@ let RecordChangeEntity = class RecordChangeEntity extends core_1.BaseEntity {
     * * Field Name: Status
     * * SQL Data Type: nchar(15)
     * * Default Value: N'Complete'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Complete
     */
     get Status() {
         return this.Get('Status');
@@ -6034,6 +6072,10 @@ let AuditLogEntity = class AuditLogEntity extends core_1.BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(50)
     * * Default Value: N'Allow'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Success
+    *   * Failed
     */
     get Status() {
         return this.Get('Status');
@@ -7197,6 +7239,10 @@ let EntityAIActionEntity = class EntityAIActionEntity extends core_1.BaseEntity
     * * Display Name: Trigger Event
     * * SQL Data Type: nchar(15)
     * * Default Value: N'After Save'
+    * * Value List Type: List
+    * * Possible Values
+    *   * after save
+    *   * before save
     */
     get TriggerEvent() {
         return this.Get('TriggerEvent');
@@ -7220,6 +7266,10 @@ let EntityAIActionEntity = class EntityAIActionEntity extends core_1.BaseEntity
     * * Display Name: Output Type
     * * SQL Data Type: nchar(10)
     * * Default Value: N'FIeld'
+    * * Value List Type: List
+    * * Possible Values
+    *   * entity
+    *   * field
     */
     get OutputType() {
         return this.Get('OutputType');
@@ -7822,6 +7872,11 @@ let QueueTaskEntity = class QueueTaskEntity extends core_1.BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * In Progress
+    *   * Completed
+    *   * Failed
     */
     get Status() {
         return this.Get('Status');
@@ -8374,6 +8429,11 @@ let ReportEntity = class ReportEntity extends core_1.BaseEntity {
     * * Display Name: Sharing Scope
     * * SQL Data Type: nvarchar(20)
     * * Default Value: N'Personal'
+    * * Value List Type: List
+    * * Possible Values
+    *   * None
+    *   * Specific
+    *   * Everyone
     */
     get SharingScope() {
         return this.Get('SharingScope');
@@ -9614,6 +9674,11 @@ let ConversationDetailEntity = class ConversationDetailEntity extends core_1.Bas
     * * Display Name: Role
     * * SQL Data Type: nvarchar(20)
     * * Default Value: user_name()
+    * * Value List Type: List
+    * * Possible Values
+    *   * User
+    *   * AI
+    *   * Error
     */
     get Role() {
         return this.Get('Role');
@@ -10342,6 +10407,11 @@ let RecordMergeLogEntity = class RecordMergeLogEntity extends core_1.BaseEntity
     * * Display Name: Approval Status
     * * SQL Data Type: nvarchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Approved
+    *   * Rejected
     */
     get ApprovalStatus() {
         return this.Get('ApprovalStatus');
@@ -10365,6 +10435,11 @@ let RecordMergeLogEntity = class RecordMergeLogEntity extends core_1.BaseEntity
     * * Display Name: Processing Status
     * * SQL Data Type: nvarchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Started
+    *   * Complete
+    *   * Error
     */
     get ProcessingStatus() {
         return this.Get('ProcessingStatus');
@@ -10530,6 +10605,11 @@ let RecordMergeDeletionLogEntity = class RecordMergeDeletionLogEntity extends co
     * * Display Name: Status
     * * SQL Data Type: nvarchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Complete
+    *   * Error
     */
     get Status() {
         return this.Get('Status');
@@ -11013,6 +11093,12 @@ let QueryEntity = class QueryEntity extends core_1.BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Approved
+    *   * Rejected
+    *   * Expired
     */
     get Status() {
         return this.Get('Status');
@@ -11463,6 +11549,11 @@ let EntityDocumentRunEntity = class EntityDocumentRunEntity extends core_1.BaseE
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Complete
+    *   * Failed
     * * Description: Can be Pending, In Progress, Completed, or Failed
     */
     get Status() {
@@ -11848,6 +11939,10 @@ let EntityDocumentEntity = class EntityDocumentEntity extends core_1.BaseEntity
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Active
+    *   * Inactive
     */
     get Status() {
         return this.Get('Status');
@@ -11969,6 +12064,13 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
     * * Field Name: Type
     * * Display Name: Type
     * * SQL Data Type: nvarchar(50)
+    * * Value List Type: List
+    * * Possible Values
+    *   * view
+    *   * sql
+    *   * query
+    *   * single_record
+    *   * full_entity
     * * Description: The type of the item, either "view", "query", "full_entity", "single_record", or "sql"
     */
     get Type() {
@@ -12333,6 +12435,7 @@ let UserViewCategoryEntity = class UserViewCategoryEntity extends core_1.BaseEnt
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
     */
     get EntityID() {
         return this.Get('EntityID');
@@ -13149,6 +13252,10 @@ let VersionInstallationEntity = class VersionInstallationEntity extends core_1.B
     * * Display Name: Type
     * * SQL Data Type: nvarchar(20)
     * * Default Value: N'System'
+    * * Value List Type: List
+    * * Possible Values
+    *   * New
+    *   * Upgrade
     * * Description: What type of installation was applied
     */
     get Type() {
@@ -13173,6 +13280,12 @@ let VersionInstallationEntity = class VersionInstallationEntity extends core_1.B
     * * Display Name: Status
     * * SQL Data Type: nvarchar(20)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * In Progress
+    *   * Complete
+    *   * Failed
     * * Description: Pending, Complete, Failed
     */
     get Status() {