@memberjunction/core-entities 1.2.0 → 1.2.1

package/dist/generated/entity_subclasses.d.ts

@@ -8549,7 +8549,7 @@ export declare class EntityDocumentEntity extends BaseEntity {
     * * Field Name: Status
     * * Display Name: Status
     * * SQL Data Type: nvarchar(15)
-    * * Default Value: N'Pending'
+    * * Default Value: N'Active'
     * * Value List Type: List
     * * Possible Values
     *   * Active
@@ -8565,23 +8565,10 @@ export declare class EntityDocumentEntity extends BaseEntity {
     get Template(): string | null;
     set Template(value: string | null);
     /**
-    * * 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: VectorDatabaseID
     * * Display Name: Vector Database ID
     * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Vector Databases (vwVectorDatabases.ID)
     */
     get VectorDatabaseID(): number;
     set VectorDatabaseID(value: number);
@@ -8589,10 +8576,43 @@ export declare class EntityDocumentEntity extends BaseEntity {
     * * Field Name: AIModelID
     * * Display Name: AIModel ID
     * * SQL Data Type: int
+    * * Related Entity/Foreign Key: AI Models (vwAIModels.ID)
     */
     get AIModelID(): number;
     set AIModelID(value: number);
     /**
+    * * Field Name: PotentialMatchThreshold
+    * * Display Name: Potential Match Threshold
+    * * SQL Data Type: numeric(12, 11)
+    * * Default Value: 1
+    * * Description: Value between 0 and 1 that determines what is considered a potential matching record. Value must be <= AbsoluteMatchThreshold. This is primarily used for duplicate detection but can be used for other applications as well where matching is relevant.
+    */
+    get PotentialMatchThreshold(): number;
+    set PotentialMatchThreshold(value: number);
+    /**
+    * * Field Name: AbsoluteMatchThreshold
+    * * Display Name: Absolute Match Threshold
+    * * SQL Data Type: numeric(12, 11)
+    * * Default Value: 1
+    * * Description: Value between 0 and 1 that determines what is considered an absolute matching record. Value must be >= PotentialMatchThreshold. This is primarily used for duplicate detection but can be used for other applications as well where matching is relevant.
+    */
+    get AbsoluteMatchThreshold(): number;
+    set AbsoluteMatchThreshold(value: number);
+    /**
+    * * 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: Entity
     * * Display Name: Entity
     * * SQL Data Type: nvarchar(255)
@@ -9618,4 +9638,605 @@ export declare class VersionInstallationEntity extends BaseEntity {
     */
     get CompleteVersion(): string | null;
 }
+/**
+ * Duplicate Run Detail Matches - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: DuplicateRunDetailMatch
+ * * Base View: vwDuplicateRunDetailMatches
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class DuplicateRunDetailMatchEntity extends BaseEntity {
+    /**
+    * Loads the Duplicate Run Detail Matches record from the database
+    * @param ID: number - primary key value to load the Duplicate Run Detail Matches record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof DuplicateRunDetailMatchEntity
+    * @method
+    * @override
+    */
+    Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Duplicate Run Detail Matches - 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 DuplicateRunDetailMatchEntity
+    * @throws {Error} - Delete is not allowed for Duplicate Run Detail Matches, 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: DuplicateRunDetailID
+    * * Display Name: Duplicate Run Detail ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Duplicate Run Details (vwDuplicateRunDetails.ID)
+    */
+    get DuplicateRunDetailID(): number;
+    set DuplicateRunDetailID(value: number);
+    /**
+    * * Field Name: MatchRecordID
+    * * Display Name: Match Record ID
+    * * SQL Data Type: nvarchar(500)
+    */
+    get MatchRecordID(): string;
+    set MatchRecordID(value: string);
+    /**
+    * * Field Name: MatchProbability
+    * * Display Name: Match Probability
+    * * SQL Data Type: numeric(12, 11)
+    * * Default Value: 0
+    * * Description: Value between 0 and 1 designating the computed probability of a match
+    */
+    get MatchProbability(): number;
+    set MatchProbability(value: number);
+    /**
+    * * Field Name: MatchedAt
+    * * Display Name: Matched At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get MatchedAt(): Date;
+    set MatchedAt(value: Date);
+    /**
+    * * Field Name: Action
+    * * Display Name: Action
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Ignore'
+    */
+    get Action(): string;
+    set Action(value: string);
+    /**
+    * * Field Name: ApprovalStatus
+    * * Display Name: Approval Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Rejected
+    *   * Approved
+    *   * Pending
+    */
+    get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
+    set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
+    /**
+    * * Field Name: MergeStatus
+    * * Display Name: Merge Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Error
+    *   * Complete
+    *   * Pending
+    */
+    get MergeStatus(): 'Error' | 'Complete' | 'Pending';
+    set MergeStatus(value: 'Error' | 'Complete' | 'Pending');
+    /**
+    * * Field Name: MergedAt
+    * * Display Name: Merged At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get MergedAt(): Date;
+    set MergedAt(value: Date);
+    /**
+    * * Field Name: RecordMergeLogID
+    * * Display Name: Record Merge Log ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Record Merge Logs (vwRecordMergeLogs.ID)
+    */
+    get RecordMergeLogID(): number | null;
+    set RecordMergeLogID(value: number | null);
+    /**
+    * * 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;
+}
+/**
+ * Entity Document Settings - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: EntityDocumentSetting
+ * * Base View: vwEntityDocumentSettings
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntityDocumentSettingEntity extends BaseEntity {
+    /**
+    * Loads the Entity Document Settings record from the database
+    * @param ID: number - primary key value to load the Entity Document Settings record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityDocumentSettingEntity
+    * @method
+    * @override
+    */
+    Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Document Settings - 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 EntityDocumentSettingEntity
+    * @throws {Error} - Delete is not allowed for Entity Document Settings, 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: EntityDocumentID
+    * * Display Name: Entity Document ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Entity Documents (vwEntityDocuments.ID)
+    */
+    get EntityDocumentID(): number;
+    set EntityDocumentID(value: number);
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Value
+    * * Display Name: Value
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Value(): string;
+    set Value(value: string);
+    /**
+    * * Field Name: Comments
+    * * Display Name: Comments
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Comments(): string | null;
+    set Comments(value: string | null);
+    /**
+    * * 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: EntityDocument
+    * * Display Name: Entity Document
+    * * SQL Data Type: nvarchar(250)
+    * * Default Value: null
+    */
+    get EntityDocument(): string;
+}
+/**
+ * Entity Settings - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: EntitySetting
+ * * Base View: vwEntitySettings
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntitySettingEntity extends BaseEntity {
+    /**
+    * Loads the Entity Settings record from the database
+    * @param ID: number - primary key value to load the Entity Settings record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntitySettingEntity
+    * @method
+    * @override
+    */
+    Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Settings - 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 EntitySettingEntity
+    * @throws {Error} - Delete is not allowed for Entity Settings, 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: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
+    */
+    get EntityID(): number;
+    set EntityID(value: number);
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(100)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Value
+    * * Display Name: Value
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Value(): string;
+    set Value(value: string);
+    /**
+    * * Field Name: Comments
+    * * Display Name: Comments
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Comments(): string | null;
+    set Comments(value: string | null);
+    /**
+    * * 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: Entity
+    * * Display Name: Entity
+    * * SQL Data Type: nvarchar(255)
+    * * Default Value: null
+    */
+    get Entity(): string;
+}
+/**
+ * Duplicate Runs - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: DuplicateRun
+ * * Base View: vwDuplicateRuns
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class DuplicateRunEntity extends BaseEntity {
+    /**
+    * Loads the Duplicate Runs record from the database
+    * @param ID: number - primary key value to load the Duplicate Runs record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof DuplicateRunEntity
+    * @method
+    * @override
+    */
+    Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Duplicate Runs - 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 DuplicateRunEntity
+    * @throws {Error} - Delete is not allowed for Duplicate Runs, 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: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
+    */
+    get EntityID(): number;
+    set EntityID(value: number);
+    /**
+    * * Field Name: StartedByUserID
+    * * Display Name: Started By User ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    */
+    get StartedByUserID(): number;
+    set StartedByUserID(value: number);
+    /**
+    * * Field Name: StartedAt
+    * * Display Name: Started At
+    * * SQL Data Type: datetime
+    * * Default Value: getdate()
+    */
+    get StartedAt(): Date;
+    set StartedAt(value: Date);
+    /**
+    * * Field Name: EndedAt
+    * * Display Name: Ended At
+    * * SQL Data Type: datetime
+    */
+    get EndedAt(): Date | null;
+    set EndedAt(value: Date | null);
+    /**
+    * * Field Name: ApprovalStatus
+    * * Display Name: Approval Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Rejected
+    *   * Approved
+    *   * Pending
+    */
+    get ApprovalStatus(): 'Rejected' | 'Approved' | 'Pending';
+    set ApprovalStatus(value: 'Rejected' | 'Approved' | 'Pending');
+    /**
+    * * Field Name: ApprovalComments
+    * * Display Name: Approval Comments
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get ApprovalComments(): string | null;
+    set ApprovalComments(value: string | null);
+    /**
+    * * Field Name: ApprovedByUserID
+    * * Display Name: Approved By User ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    */
+    get ApprovedByUserID(): number | null;
+    set ApprovedByUserID(value: number | null);
+    /**
+    * * Field Name: ProcessingStatus
+    * * Display Name: Processing Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Failed
+    *   * Complete
+    *   * In Progress
+    *   * Pending
+    */
+    get ProcessingStatus(): 'Failed' | 'Complete' | 'In Progress' | 'Pending';
+    set ProcessingStatus(value: 'Failed' | 'Complete' | 'In Progress' | 'Pending');
+    /**
+    * * Field Name: ProcessingErrorMessage
+    * * Display Name: Processing Error Message
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get ProcessingErrorMessage(): string | null;
+    set ProcessingErrorMessage(value: string | null);
+    /**
+    * * Field Name: SourceListID
+    * * Display Name: Source List ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Lists (vwLists.ID)
+    */
+    get SourceListID(): number;
+    set SourceListID(value: number);
+    /**
+    * * 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: Entity
+    * * Display Name: Entity
+    * * SQL Data Type: nvarchar(255)
+    * * Default Value: null
+    */
+    get Entity(): string;
+    /**
+    * * Field Name: StartedByUser
+    * * Display Name: Started By User
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get StartedByUser(): string;
+    /**
+    * * Field Name: ApprovedByUser
+    * * Display Name: Approved By User
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get ApprovedByUser(): string | null;
+    /**
+    * * Field Name: SourceList
+    * * Display Name: Source List
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get SourceList(): string;
+}
+/**
+ * Duplicate Run Details - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: DuplicateRunDetail
+ * * Base View: vwDuplicateRunDetails
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class DuplicateRunDetailEntity extends BaseEntity {
+    /**
+    * Loads the Duplicate Run Details record from the database
+    * @param ID: number - primary key value to load the Duplicate Run Details record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof DuplicateRunDetailEntity
+    * @method
+    * @override
+    */
+    Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Duplicate Run Details - 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 DuplicateRunDetailEntity
+    * @throws {Error} - Delete is not allowed for Duplicate Run Details, 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: DuplicateRunID
+    * * Display Name: Duplicate Run ID
+    * * SQL Data Type: int
+    * * Related Entity/Foreign Key: Duplicate Runs (vwDuplicateRuns.ID)
+    */
+    get DuplicateRunID(): number;
+    set DuplicateRunID(value: number);
+    /**
+    * * Field Name: RecordID
+    * * Display Name: Record ID
+    * * SQL Data Type: nvarchar(500)
+    */
+    get RecordID(): string;
+    set RecordID(value: string);
+    /**
+    * * Field Name: MatchStatus
+    * * Display Name: Match Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Pending'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Error
+    *   * Skipped
+    *   * Complete
+    *   * Pending
+    */
+    get MatchStatus(): 'Error' | 'Skipped' | 'Complete' | 'Pending';
+    set MatchStatus(value: 'Error' | 'Skipped' | 'Complete' | 'Pending');
+    /**
+    * * Field Name: SkippedReason
+    * * Display Name: Skipped Reason
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: If MatchStatus=Skipped, this field can be used to store the reason why the record was skipped
+    */
+    get SkippedReason(): string | null;
+    set SkippedReason(value: string | null);
+    /**
+    * * Field Name: MatchErrorMessage
+    * * Display Name: Match Error Message
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: If MatchStatus='Error' this field can be used to track the error from that phase of the process for logging/diagnostics.
+    */
+    get MatchErrorMessage(): string | null;
+    set MatchErrorMessage(value: string | null);
+    /**
+    * * Field Name: MergeStatus
+    * * Display Name: Merge Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: N'Not Applicable'
+    * * Value List Type: List
+    * * Possible Values
+    *   * Error
+    *   * Complete
+    *   * Pending
+    *   * Not Applicable
+    */
+    get MergeStatus(): 'Error' | 'Complete' | 'Pending' | 'Not Applicable';
+    set MergeStatus(value: 'Error' | 'Complete' | 'Pending' | 'Not Applicable');
+    /**
+    * * Field Name: MergeErrorMessage
+    * * Display Name: Merge Error Message
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get MergeErrorMessage(): string | null;
+    set MergeErrorMessage(value: string | null);
+    /**
+    * * 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;
+}
 //# sourceMappingURL=entity_subclasses.d.ts.map