@memberjunction/core-entities 0.9.112 → 0.9.120

package/dist/generated/entity_subclasses.d.ts

@@ -6831,6 +6831,21 @@ export declare class ConversationEntity extends BaseEntity {
     get Type(): string;
     set Type(value: string);
     /**
+    * * Field Name: LinkedEntityID
+    * * Display Name: Linked Entity ID
+    * * SQL Data Type: int
+    * * Related Entity: Entities
+    */
+    get LinkedEntityID(): number;
+    set LinkedEntityID(value: number);
+    /**
+    * * Field Name: LinkedRecordID
+    * * Display Name: Linked Record ID
+    * * SQL Data Type: int
+    */
+    get LinkedRecordID(): number;
+    set LinkedRecordID(value: number);
+    /**
     * * Field Name: CreatedAt
     * * Display Name: Created At
     * * SQL Data Type: datetime
@@ -6850,6 +6865,12 @@ export declare class ConversationEntity extends BaseEntity {
     * * SQL Data Type: nvarchar(100)
     */
     get User(): string;
+    /**
+    * * Field Name: LinkedEntity
+    * * Display Name: Linked Entity
+    * * SQL Data Type: nvarchar(255)
+    */
+    get LinkedEntity(): string;
 }
 /**
  * User Notifications - strongly typed entity sub-class
@@ -7871,3 +7892,545 @@ export declare class QueryPermissionEntity extends BaseEntity {
     */
     get UpdatedAt(): Date;
 }
+/**
+ * Vector Indexes - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: VectorIndex
+ * * Base View: vwVectorIndexes
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class VectorIndexEntity extends BaseEntity {
+    /**
+    * Loads the Vector Indexes record from the database
+    * @param ID: Number - primary key value to load the Vector Indexes record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof VectorIndexEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Vector Indexes - 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 VectorIndexEntity
+    * @throws {Error} - Delete is not allowed for Vector Indexes, 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: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string;
+    set Description(value: string);
+    /**
+    * * Field Name: VectorDatabaseID
+    * * Display Name: Vector Database ID
+    * * SQL Data Type: int
+    * * Related Entity: Vector Databases
+    */
+    get VectorDatabaseID(): number;
+    set VectorDatabaseID(value: number);
+    /**
+    * * Field Name: EmbeddingModelID
+    * * Display Name: Embedding Model ID
+    * * SQL Data Type: int
+    * * Related Entity: AI Models
+    */
+    get EmbeddingModelID(): number;
+    set EmbeddingModelID(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: VectorDatabase
+    * * Display Name: Vector Database
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get VectorDatabase(): string;
+    /**
+    * * Field Name: EmbeddingModel
+    * * Display Name: Embedding Model
+    * * SQL Data Type: nvarchar(50)
+    * * Default Value: null
+    */
+    get EmbeddingModel(): string;
+}
+/**
+ * Entity Document Types - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: EntityDocumentType
+ * * Base View: vwEntityDocumentTypes
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntityDocumentTypeEntity extends BaseEntity {
+    /**
+    * Loads the Entity Document Types record from the database
+    * @param ID: Number - primary key value to load the Entity Document Types record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityDocumentTypeEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Document Types - 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 EntityDocumentTypeEntity
+    * @throws {Error} - Delete is not allowed for Entity Document Types, 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(100)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string;
+    set Description(value: string);
+    /**
+    * * 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 Runs - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: EntityDocumentRun
+ * * Base View: vwEntityDocumentRuns
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntityDocumentRunEntity extends BaseEntity {
+    /**
+    * Loads the Entity Document Runs record from the database
+    * @param ID: Number - primary key value to load the Entity Document Runs record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityDocumentRunEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Document 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 EntityDocumentRunEntity
+    * @throws {Error} - Delete is not allowed for Entity Document 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: EntityDocumentID
+    * * Display Name: Entity Document ID
+    * * SQL Data Type: int
+    * * Related Entity: Entity Documents
+    */
+    get EntityDocumentID(): number;
+    set EntityDocumentID(value: number);
+    /**
+    * * Field Name: StartedAt
+    * * Display Name: Started At
+    * * SQL Data Type: datetime
+    */
+    get StartedAt(): Date;
+    set StartedAt(value: Date);
+    /**
+    * * Field Name: EndedAt
+    * * Display Name: Ended At
+    * * SQL Data Type: datetime
+    */
+    get EndedAt(): Date;
+    set EndedAt(value: Date);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(15)
+    * * Default Value: N'Pending'
+    */
+    get Status(): string;
+    set Status(value: string);
+    /**
+    * * 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;
+}
+/**
+ * Vector Databases - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: VectorDatabase
+ * * Base View: vwVectorDatabases
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class VectorDatabaseEntity extends BaseEntity {
+    /**
+    * Loads the Vector Databases record from the database
+    * @param ID: Number - primary key value to load the Vector Databases record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof VectorDatabaseEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Vector Databases - 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 VectorDatabaseEntity
+    * @throws {Error} - Delete is not allowed for Vector Databases, 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(100)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Description(): string;
+    set Description(value: string);
+    /**
+    * * Field Name: DefaultURL
+    * * Display Name: Default URL
+    * * SQL Data Type: nvarchar(255)
+    */
+    get DefaultURL(): string;
+    set DefaultURL(value: string);
+    /**
+    * * Field Name: ClassKey
+    * * Display Name: Class Key
+    * * SQL Data Type: nvarchar(100)
+    */
+    get ClassKey(): string;
+    set ClassKey(value: string);
+    /**
+    * * 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 Record Documents - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: EntityRecordDocument
+ * * Base View: vwEntityRecordDocuments
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntityRecordDocumentEntity extends BaseEntity {
+    /**
+    * Loads the Entity Record Documents record from the database
+    * @param ID: Number - primary key value to load the Entity Record Documents record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityRecordDocumentEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Record Documents - 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 EntityRecordDocumentEntity
+    * @throws {Error} - Delete is not allowed for Entity Record Documents, 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
+    */
+    get EntityID(): number;
+    set EntityID(value: number);
+    /**
+    * * Field Name: RecordID
+    * * Display Name: Record ID
+    * * SQL Data Type: nvarchar(255)
+    */
+    get RecordID(): string;
+    set RecordID(value: string);
+    /**
+    * * Field Name: DocumentText
+    * * Display Name: Document Text
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get DocumentText(): string;
+    set DocumentText(value: string);
+    /**
+    * * Field Name: VectorIndexID
+    * * Display Name: Vector Index ID
+    * * SQL Data Type: int
+    */
+    get VectorIndexID(): number;
+    set VectorIndexID(value: number);
+    /**
+    * * Field Name: VectorID
+    * * Display Name: Vector ID
+    * * SQL Data Type: nvarchar(50)
+    */
+    get VectorID(): string;
+    set VectorID(value: string);
+    /**
+    * * Field Name: VectorJSON
+    * * Display Name: Vector JSON
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get VectorJSON(): string;
+    set VectorJSON(value: string);
+    /**
+    * * Field Name: EntityRecordUpdatedAt
+    * * Display Name: Entity Record Updated At
+    * * SQL Data Type: datetime
+    */
+    get EntityRecordUpdatedAt(): Date;
+    set EntityRecordUpdatedAt(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;
+}
+/**
+ * Entity Documents - strongly typed entity sub-class
+ * * Schema: admin
+ * * Base Table: EntityDocument
+ * * Base View: vwEntityDocuments
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class EntityDocumentEntity extends BaseEntity {
+    /**
+    * Loads the Entity Documents record from the database
+    * @param ID: Number - primary key value to load the Entity Documents record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof EntityDocumentEntity
+    * @method
+    * @override
+    */
+    Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Entity Documents - 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 EntityDocumentEntity
+    * @throws {Error} - Delete is not allowed for Entity Documents, 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(250)
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: int
+    * * Related Entity: Entities
+    */
+    get EntityID(): number;
+    set EntityID(value: number);
+    /**
+    * * Field Name: TypeID
+    * * Display Name: Type ID
+    * * SQL Data Type: int
+    * * Related Entity: Entity Document Types
+    */
+    get TypeID(): number;
+    set TypeID(value: number);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(15)
+    * * Default Value: N'Pending'
+    */
+    get Status(): string;
+    set Status(value: string);
+    /**
+    * * Field Name: Template
+    * * Display Name: Template
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get Template(): string;
+    set Template(value: string);
+    /**
+    * * 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: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(100)
+    * * Default Value: null
+    */
+    get Type(): string;
+}