@memberjunction/core-entities 0.9.171 → 0.9.173

package/dist/generated/entity_subclasses.d.ts

@@ -1503,6 +1503,7 @@ export declare class EntityEntity extends 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(): boolean;
     set BaseViewGenerated(value: boolean);
@@ -1526,6 +1527,7 @@ export declare class EntityEntity extends 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(): boolean;
     set TrackRecordChanges(value: boolean);
@@ -1534,6 +1536,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AuditRecordAccess(value: boolean);
@@ -1542,6 +1545,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AuditViewRuns(value: boolean);
@@ -1550,6 +1554,7 @@ export declare class EntityEntity extends 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(): boolean;
     set IncludeInAPI(value: boolean);
@@ -1558,6 +1563,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowAllRowsAPI(value: boolean);
@@ -1566,6 +1572,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowUpdateAPI(value: boolean);
@@ -1574,6 +1581,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowCreateAPI(value: boolean);
@@ -1582,6 +1590,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowDeleteAPI(value: boolean);
@@ -1590,6 +1599,7 @@ export declare class EntityEntity extends 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(): boolean;
     set CustomResolverAPI(value: boolean);
@@ -1598,6 +1608,7 @@ export declare class EntityEntity extends 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(): boolean;
     set AllowUserSearchAPI(value: boolean);
@@ -1853,9 +1864,13 @@ export declare class UserEntity extends BaseEntity {
     /**
     * * Field Name: Type
     * * SQL Data Type: nchar(15)
+    * * Value List Type: List
+    * * Possible Values
+    *   * User
+    *   * Owner
     */
-    get Type(): string;
-    set Type(value: string);
+    get Type(): 'User' | 'Owner';
+    set Type(value: 'User' | 'Owner');
     /**
     * * Field Name: IsActive
     * * Display Name: Is Active
@@ -2019,9 +2034,13 @@ export declare class EntityRelationshipEntity extends BaseEntity {
     * * 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(): string;
-    set Type(value: string);
+    get Type(): 'One To Many' | 'Many To Many';
+    set Type(value: 'One To Many' | 'Many To Many');
     /**
     * * Field Name: EntityKeyField
     * * Display Name: Entity Key Field
@@ -3308,9 +3327,18 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity {
     * * 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(): string | null;
-    set RequestMethod(value: string | null);
+    get RequestMethod(): 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null;
+    set RequestMethod(value: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | null);
     /**
     * * Field Name: URL
     * * SQL Data Type: nvarchar(MAX)
@@ -3685,9 +3713,15 @@ export declare class WorkflowRunEntity extends 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(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'In Progress' | 'Complete' | 'Failed';
+    set Status(value: 'Pending' | 'In Progress' | 'Complete' | 'Failed');
     /**
     * * Field Name: Results
     * * SQL Data Type: nvarchar(MAX)
@@ -4013,9 +4047,13 @@ export declare class RecordChangeEntity extends BaseEntity {
     * * Field Name: Status
     * * SQL Data Type: nchar(15)
     * * Default Value: N'Complete'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Complete
     */
-    get Status(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'Complete';
+    set Status(value: 'Pending' | 'Complete');
     /**
     * * Field Name: Comments
     * * SQL Data Type: nvarchar(MAX)
@@ -4251,9 +4289,13 @@ export declare class AuditLogEntity extends BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(50)
     * * Default Value: N'Allow'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Success
+    *   * Failed
     */
-    get Status(): string;
-    set Status(value: string);
+    get Status(): 'Success' | 'Failed';
+    set Status(value: 'Success' | 'Failed');
     /**
     * * Field Name: Description
     * * Display Name: Description
@@ -5090,9 +5132,13 @@ export declare class EntityAIActionEntity extends 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(): string;
-    set TriggerEvent(value: string);
+    get TriggerEvent(): 'after save' | 'before save';
+    set TriggerEvent(value: 'after save' | 'before save');
     /**
     * * Field Name: UserMessage
     * * Display Name: User Message
@@ -5105,9 +5151,13 @@ export declare class EntityAIActionEntity extends BaseEntity {
     * * Display Name: Output Type
     * * SQL Data Type: nchar(10)
     * * Default Value: N'FIeld'
+    * * Value List Type: List
+    * * Possible Values
+    *   * entity
+    *   * field
     */
-    get OutputType(): string;
-    set OutputType(value: string);
+    get OutputType(): 'entity' | 'field';
+    set OutputType(value: 'entity' | 'field');
     /**
     * * Field Name: OutputField
     * * Display Name: Output Field
@@ -5527,9 +5577,14 @@ export declare class QueueTaskEntity extends 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(): string;
-    set Status(value: string);
+    get Status(): 'In Progress' | 'Completed' | 'Failed';
+    set Status(value: 'In Progress' | 'Completed' | 'Failed');
     /**
     * * Field Name: StartedAt
     * * Display Name: Started At
@@ -5917,9 +5972,14 @@ export declare class ReportEntity extends 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(): string;
-    set SharingScope(value: string);
+    get SharingScope(): 'None' | 'Specific' | 'Everyone';
+    set SharingScope(value: 'None' | 'Specific' | 'Everyone');
     /**
     * * Field Name: ConversationID
     * * Display Name: Conversation ID
@@ -6803,9 +6863,14 @@ export declare class ConversationDetailEntity extends BaseEntity {
     * * Display Name: Role
     * * SQL Data Type: nvarchar(20)
     * * Default Value: user_name()
+    * * Value List Type: List
+    * * Possible Values
+    *   * User
+    *   * AI
+    *   * Error
     */
-    get Role(): string;
-    set Role(value: string);
+    get Role(): 'User' | 'AI' | 'Error';
+    set Role(value: 'User' | 'AI' | 'Error');
     /**
     * * Field Name: Message
     * * Display Name: Message
@@ -7317,9 +7382,14 @@ export declare class RecordMergeLogEntity extends 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(): string;
-    set ApprovalStatus(value: string);
+    get ApprovalStatus(): 'Pending' | 'Approved' | 'Rejected';
+    set ApprovalStatus(value: 'Pending' | 'Approved' | 'Rejected');
     /**
     * * Field Name: ApprovedByUserID
     * * Display Name: Approved By User ID
@@ -7332,9 +7402,14 @@ export declare class RecordMergeLogEntity extends 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(): string;
-    set ProcessingStatus(value: string);
+    get ProcessingStatus(): 'Started' | 'Complete' | 'Error';
+    set ProcessingStatus(value: 'Started' | 'Complete' | 'Error');
     /**
     * * Field Name: ProcessingStartedAt
     * * Display Name: Processing Started At
@@ -7449,9 +7524,14 @@ export declare class RecordMergeDeletionLogEntity extends BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(10)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Complete
+    *   * Error
     */
-    get Status(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'Complete' | 'Error';
+    set Status(value: 'Pending' | 'Complete' | 'Error');
     /**
     * * Field Name: ProcessingLog
     * * Display Name: Processing Log
@@ -7788,9 +7868,15 @@ export declare class QueryEntity extends 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(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'Approved' | 'Rejected' | 'Expired';
+    set Status(value: 'Pending' | 'Approved' | 'Rejected' | 'Expired');
     /**
     * * Field Name: QualityRank
     * * Display Name: Quality Rank
@@ -8116,10 +8202,15 @@ export declare class EntityDocumentRunEntity extends BaseEntity {
     * * 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(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'Complete' | 'Failed';
+    set Status(value: 'Pending' | 'Complete' | 'Failed');
     /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
@@ -8391,9 +8482,13 @@ export declare class EntityDocumentEntity extends BaseEntity {
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
     * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Active
+    *   * Inactive
     */
-    get Status(): string;
-    set Status(value: string);
+    get Status(): 'Active' | 'Inactive';
+    set Status(value: 'Active' | 'Inactive');
     /**
     * * Field Name: Template
     * * Display Name: Template
@@ -8480,10 +8575,17 @@ export declare class DataContextItemEntity extends BaseEntity {
     * * 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(): string;
-    set Type(value: string);
+    get Type(): 'view' | 'sql' | 'query' | 'single_record' | 'full_entity';
+    set Type(value: 'view' | 'sql' | 'query' | 'single_record' | 'full_entity');
     /**
     * * Field Name: ViewID
     * * Display Name: View ID
@@ -8740,6 +8842,7 @@ export declare class UserViewCategoryEntity extends BaseEntity {
     * * Field Name: EntityID
     * * Display Name: Entity ID
     * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
     */
     get EntityID(): number;
     set EntityID(value: number);
@@ -9324,10 +9427,14 @@ export declare class VersionInstallationEntity extends BaseEntity {
     * * 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(): string | null;
-    set Type(value: string | null);
+    get Type(): 'New' | 'Upgrade' | null;
+    set Type(value: 'New' | 'Upgrade' | null);
     /**
     * * Field Name: InstalledAt
     * * Display Name: Installed At
@@ -9340,10 +9447,16 @@ export declare class VersionInstallationEntity extends BaseEntity {
     * * 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(): string;
-    set Status(value: string);
+    get Status(): 'Pending' | 'In Progress' | 'Complete' | 'Failed';
+    set Status(value: 'Pending' | 'In Progress' | 'Complete' | 'Failed');
     /**
     * * Field Name: InstallLog
     * * Display Name: Install Log