@memberjunction/core-entities 2.29.2 → 2.30.0

package/dist/generated/entity_subclasses.d.ts

@@ -3977,6 +3977,94 @@ export declare const FileSchema: z.ZodObject<{
     Provider?: string;
 }>;
 export type FileEntityType = z.infer<typeof FileSchema>;
+/**
+ * zod schema definition for the entity Generated Code Categories
+ */
+export declare const GeneratedCodeCategorySchema: z.ZodObject<{
+    ID: z.ZodString;
+    Name: z.ZodString;
+    Description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ParentID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Parent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    ParentID?: string;
+    Parent?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    ParentID?: string;
+    Parent?: string;
+}>;
+export type GeneratedCodeCategoryEntityType = z.infer<typeof GeneratedCodeCategorySchema>;
+/**
+ * zod schema definition for the entity Generated Codes
+ */
+export declare const GeneratedCodeSchema: z.ZodObject<{
+    ID: z.ZodString;
+    GeneratedAt: z.ZodDate;
+    CategoryID: z.ZodString;
+    GeneratedByModelID: z.ZodString;
+    Name: z.ZodString;
+    Description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    Code: z.ZodString;
+    Source: z.ZodString;
+    LinkedEntityID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    LinkedRecordPrimaryKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    Status: z.ZodUnion<[z.ZodLiteral<"Pending">, z.ZodLiteral<"Approved">, z.ZodLiteral<"Rejected">]>;
+    Language: z.ZodUnion<[z.ZodLiteral<"TypeScript">, z.ZodLiteral<"SQL">, z.ZodLiteral<"HTML">, z.ZodLiteral<"CSS">, z.ZodLiteral<"JavaScript">, z.ZodLiteral<"Python">, z.ZodLiteral<"Other">]>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Category: z.ZodString;
+    GeneratedByModel: z.ZodString;
+    LinkedEntity: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    Category?: string;
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    Status?: "Pending" | "Approved" | "Rejected";
+    Code?: string;
+    CategoryID?: string;
+    Source?: string;
+    LinkedEntityID?: string;
+    LinkedEntity?: string;
+    GeneratedAt?: Date;
+    GeneratedByModelID?: string;
+    LinkedRecordPrimaryKey?: string;
+    Language?: "Other" | "SQL" | "TypeScript" | "HTML" | "CSS" | "JavaScript" | "Python";
+    GeneratedByModel?: string;
+}, {
+    Category?: string;
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    Status?: "Pending" | "Approved" | "Rejected";
+    Code?: string;
+    CategoryID?: string;
+    Source?: string;
+    LinkedEntityID?: string;
+    LinkedEntity?: string;
+    GeneratedAt?: Date;
+    GeneratedByModelID?: string;
+    LinkedRecordPrimaryKey?: string;
+    Language?: "Other" | "SQL" | "TypeScript" | "HTML" | "CSS" | "JavaScript" | "Python";
+    GeneratedByModel?: string;
+}>;
+export type GeneratedCodeEntityType = z.infer<typeof GeneratedCodeSchema>;
 /**
  * zod schema definition for the entity Integration URL Formats
  */
@@ -8428,7 +8516,7 @@ export declare class AIModelEntity extends BaseEntity<AIModelEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
-    * Validate() method override for AI Models entity. This is an auto-generated method that invokes the generated field validators for this entity for the following fields:
+    * Validate() method override for AI Models entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * SpeedRank: This rule ensures that the speed rank must be zero or a positive number.
     * * CostRank: This rule ensures that the cost rank of an item must be zero or higher. This means that the cost rank cannot be negative.
     * * PowerRank: This rule ensures that the power rank must be greater than or equal to zero, meaning that it cannot be negative.
@@ -10091,6 +10179,21 @@ export declare class CommunicationProviderEntity extends BaseEntity<Communicatio
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Validate() method override for Communication Providers entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that the ability to schedule sending messages cannot exceed the overall ability to send messages. In simpler terms, if a user can send messages, they can also send them on a schedule, but if they cannot send messages, they shouldn't be able to send them on a schedule either.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the ability to schedule sending messages cannot exceed the overall ability to send messages. In simpler terms, if a user can send messages, they can also send them on a schedule, but if they cannot send messages, they shouldn't be able to send them on a schedule either.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateSupportsScheduledSendingComparedToSupportsSending(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -11929,7 +12032,7 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
-    * Validate() method override for Conversation Details entity. This is an auto-generated method that invokes the generated field validators for this entity for the following fields:
+    * Validate() method override for Conversation Details entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * UserRating: This rule ensures that the user rating is between 1 and 10, inclusive. Ratings below 1 or above 10 are not allowed.
     * @public
     * @method
@@ -13629,6 +13732,21 @@ export declare class EntityEntity extends BaseEntity<EntityEntityType> {
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Validate() method override for Entities entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that if record merging is allowed, it can only be permitted if record deletion is enabled and the deletion type is set to 'Soft'.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that if record merging is allowed, it can only be permitted if record deletion is enabled and the deletion type is set to 'Soft'.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateAllowRecordMergeConstraints(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * SQL Data Type: uniqueidentifier
     * * Default Value: newsequentialid()
@@ -15109,6 +15227,21 @@ export declare class EntityDocumentEntity extends BaseEntity<EntityDocumentEntit
     */
     Delete(): Promise<boolean>;
     /**
+    * Validate() method override for Entity Documents entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that the potential match threshold is not greater than the absolute match threshold, and both thresholds must be between 0 and 1 inclusive.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the potential match threshold is not greater than the absolute match threshold, and both thresholds must be between 0 and 1 inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidatePotentialMatchThresholdAgainstAbsoluteMatchThreshold(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -16724,7 +16857,7 @@ export declare class ExplorerNavigationItemEntity extends BaseEntity<ExplorerNav
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
-    * Validate() method override for Explorer Navigation Items entity. This is an auto-generated method that invokes the generated field validators for this entity for the following fields:
+    * Validate() method override for Explorer Navigation Items entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * Sequence: This rule ensures that the sequence must be greater than zero.
     * @public
     * @method
@@ -17188,6 +17321,249 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
     */
     get Provider(): string;
 }
+/**
+ * Generated Code Categories - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: GeneratedCodeCategory
+ * * Base View: vwGeneratedCodeCategories
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class GeneratedCodeCategoryEntity extends BaseEntity<GeneratedCodeCategoryEntityType> {
+    /**
+    * Loads the Generated Code Categories record from the database
+    * @param ID: string - primary key value to load the Generated Code Categories record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof GeneratedCodeCategoryEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * 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 | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: ParentID
+    * * Display Name: Parent ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Generated Code Categories (vwGeneratedCodeCategories.ID)
+    * * Description: Parent category ID, allowing for hierarchical categorization.
+    */
+    get ParentID(): string | null;
+    set ParentID(value: string | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Parent
+    * * Display Name: Parent
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Parent(): string | null;
+}
+/**
+ * Generated Codes - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: GeneratedCode
+ * * Base View: vwGeneratedCodes
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class GeneratedCodeEntity extends BaseEntity<GeneratedCodeEntityType> {
+    /**
+    * Loads the Generated Codes record from the database
+    * @param ID: string - primary key value to load the Generated Codes record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof GeneratedCodeEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: GeneratedAt
+    * * Display Name: Generated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    * * Description: When the code was generated.
+    */
+    get GeneratedAt(): Date;
+    set GeneratedAt(value: Date);
+    /**
+    * * Field Name: CategoryID
+    * * Display Name: Category ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Generated Code Categories (vwGeneratedCodeCategories.ID)
+    * * Description: Reference to the category of generated code.
+    */
+    get CategoryID(): string;
+    set CategoryID(value: string);
+    /**
+    * * Field Name: GeneratedByModelID
+    * * Display Name: Generated By Model ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Models (vwAIModels.ID)
+    * * Description: AI model responsible for generating this code.
+    */
+    get GeneratedByModelID(): string;
+    set GeneratedByModelID(value: string);
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Descriptive name of the generated code.
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optional description of the generated code.
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: Code
+    * * Display Name: Code
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: The actual generated code.
+    */
+    get Code(): string;
+    set Code(value: string);
+    /**
+    * * Field Name: Source
+    * * Display Name: Source
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Source material used to generate the code, e.g., a SQL CHECK constraint.
+    */
+    get Source(): string;
+    set Source(value: string);
+    /**
+    * * Field Name: LinkedEntityID
+    * * Display Name: Linked Entity ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
+    */
+    get LinkedEntityID(): string | null;
+    set LinkedEntityID(value: string | null);
+    /**
+    * * Field Name: LinkedRecordPrimaryKey
+    * * Display Name: Linked Record Primary Key
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get LinkedRecordPrimaryKey(): string | null;
+    set LinkedRecordPrimaryKey(value: string | null);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Pending
+    * * Value List Type: List
+    * * Possible Values
+    *   * Pending
+    *   * Approved
+    *   * Rejected
+    * * Description: Status of the generated code, e.g., Pending, Approved, or Rejected.
+    */
+    get Status(): 'Pending' | 'Approved' | 'Rejected';
+    set Status(value: 'Pending' | 'Approved' | 'Rejected');
+    /**
+    * * Field Name: Language
+    * * Display Name: Language
+    * * SQL Data Type: nvarchar(50)
+    * * Default Value: TypeScript
+    * * Value List Type: List
+    * * Possible Values
+    *   * TypeScript
+    *   * SQL
+    *   * HTML
+    *   * CSS
+    *   * JavaScript
+    *   * Python
+    *   * Other
+    * * Description: Programming language of the generated code (TypeScript, SQL, HTML, CSS, JavaScript, Python, or Other).
+    */
+    get Language(): 'TypeScript' | 'SQL' | 'HTML' | 'CSS' | 'JavaScript' | 'Python' | 'Other';
+    set Language(value: 'TypeScript' | 'SQL' | 'HTML' | 'CSS' | 'JavaScript' | 'Python' | 'Other');
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Category
+    * * Display Name: Category
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Category(): string;
+    /**
+    * * Field Name: GeneratedByModel
+    * * Display Name: Generated By Model
+    * * SQL Data Type: nvarchar(50)
+    */
+    get GeneratedByModel(): string;
+    /**
+    * * Field Name: LinkedEntity
+    * * Display Name: Linked Entity
+    * * SQL Data Type: nvarchar(255)
+    */
+    get LinkedEntity(): string | null;
+}
 /**
  * Integration URL Formats - strongly typed entity sub-class
  * * Schema: __mj
@@ -19040,7 +19416,7 @@ export declare class RecommendationItemEntity extends BaseEntity<RecommendationI
     */
     Delete(): Promise<boolean>;
     /**
-    * Validate() method override for Recommendation Items entity. This is an auto-generated method that invokes the generated field validators for this entity for the following fields:
+    * Validate() method override for Recommendation Items entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
     * * MatchProbability: This rule ensures that the match probability value is between 0 and 1, inclusive.
     * @public
     * @method
@@ -20421,6 +20797,21 @@ export declare class ResourcePermissionEntity extends BaseEntity<ResourcePermiss
     */
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
+    * Validate() method override for Resource Permissions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that when the type is set to 'Role', a role ID must be provided and the user ID must not be provided. Conversely, if the type is set to 'User', a user ID must be provided and the role ID must not be provided.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that when the type is set to 'Role', a role ID must be provided and the user ID must not be provided. Conversely, if the type is set to 'User', a user ID must be provided and the role ID must not be provided.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateUserTypeConstraints(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -21122,6 +21513,29 @@ export declare class SchemaInfoEntity extends BaseEntity<SchemaInfoEntityType> {
     */
     Delete(): Promise<boolean>;
     /**
+    * Validate() method override for Schema Info entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
+    * * Table-Level: This rule ensures that the maximum entity ID must be greater than the minimum entity ID, which helps to maintain valid and logical ranges for entity IDs.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that both the minimum and maximum entity IDs must be greater than zero.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEntityIDMinAndEntityIDMaxGreaterThanZero(result: ValidationResult): void;
+    /**
+    * This rule ensures that the maximum entity ID must be greater than the minimum entity ID, which helps to maintain valid and logical ranges for entity IDs.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEntityIDMaxGreaterThanEntityIDMin(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier