@memberjunction/core-entities 2.27.1 → 2.29.0

package/dist/generated/entity_subclasses.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntity, EntitySaveOptions } from "@memberjunction/core";
+import { BaseEntity, EntitySaveOptions, ValidationResult } from "@memberjunction/core";
 import { z } from "zod";
 export declare const loadModule: () => void;
 /**
@@ -1314,6 +1314,8 @@ export declare const CommunicationProviderSchema: z.ZodObject<{
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
     SupportsScheduledSending: z.ZodBoolean;
+    SupportsForwarding: z.ZodBoolean;
+    SupportsReplying: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -1324,6 +1326,8 @@ export declare const CommunicationProviderSchema: z.ZodObject<{
     SupportsSending?: boolean;
     SupportsReceiving?: boolean;
     SupportsScheduledSending?: boolean;
+    SupportsForwarding?: boolean;
+    SupportsReplying?: boolean;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -1334,6 +1338,8 @@ export declare const CommunicationProviderSchema: z.ZodObject<{
     SupportsSending?: boolean;
     SupportsReceiving?: boolean;
     SupportsScheduledSending?: boolean;
+    SupportsForwarding?: boolean;
+    SupportsReplying?: boolean;
 }>;
 export type CommunicationProviderEntityType = z.infer<typeof CommunicationProviderSchema>;
 /**
@@ -3322,6 +3328,11 @@ export declare const EntityFieldSchema: z.ZodObject<{
     ScopeDefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     AutoUpdateRelatedEntityInfo: z.ZodBoolean;
     ValuesToPackWithSchema: z.ZodUnion<[z.ZodLiteral<"Auto">, z.ZodLiteral<"None">, z.ZodLiteral<"All">]>;
+    GeneratedValidationFunctionName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    GeneratedValidationFunctionDescription: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    GeneratedValidationFunctionCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    GeneratedValidationFunctionCheckConstraint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    FieldCodeName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     Entity: z.ZodString;
     SchemaName: z.ZodString;
     BaseTable: z.ZodString;
@@ -3384,6 +3395,11 @@ export declare const EntityFieldSchema: z.ZodObject<{
     EntityIDFieldName?: string;
     AutoUpdateRelatedEntityInfo?: boolean;
     ValuesToPackWithSchema?: "None" | "Auto" | "All";
+    GeneratedValidationFunctionName?: string;
+    GeneratedValidationFunctionDescription?: string;
+    GeneratedValidationFunctionCode?: string;
+    GeneratedValidationFunctionCheckConstraint?: string;
+    FieldCodeName?: string;
     RelatedEntity?: string;
     RelatedEntitySchemaName?: string;
     RelatedEntityBaseTable?: string;
@@ -3440,6 +3456,11 @@ export declare const EntityFieldSchema: z.ZodObject<{
     EntityIDFieldName?: string;
     AutoUpdateRelatedEntityInfo?: boolean;
     ValuesToPackWithSchema?: "None" | "Auto" | "All";
+    GeneratedValidationFunctionName?: string;
+    GeneratedValidationFunctionDescription?: string;
+    GeneratedValidationFunctionCode?: string;
+    GeneratedValidationFunctionCheckConstraint?: string;
+    FieldCodeName?: string;
     RelatedEntity?: string;
     RelatedEntitySchemaName?: string;
     RelatedEntityBaseTable?: string;
@@ -3956,50 +3977,6 @@ export declare const FileSchema: z.ZodObject<{
     Provider?: string;
 }>;
 export type FileEntityType = z.infer<typeof FileSchema>;
-/**
- * zod schema definition for the entity Flyway _schema _histories
- */
-export declare const flyway_schema_historySchema: z.ZodObject<{
-    installed_rank: z.ZodNumber;
-    version: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    type: z.ZodString;
-    script: z.ZodString;
-    checksum: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    installed_by: z.ZodString;
-    installed_on: z.ZodDate;
-    execution_time: z.ZodNumber;
-    success: z.ZodBoolean;
-    __mj_CreatedAt: z.ZodDate;
-    __mj_UpdatedAt: z.ZodDate;
-}, "strip", z.ZodTypeAny, {
-    type?: string;
-    script?: string;
-    success?: boolean;
-    description?: string;
-    version?: string;
-    __mj_CreatedAt?: Date;
-    __mj_UpdatedAt?: Date;
-    installed_rank?: number;
-    checksum?: number;
-    installed_by?: string;
-    installed_on?: Date;
-    execution_time?: number;
-}, {
-    type?: string;
-    script?: string;
-    success?: boolean;
-    description?: string;
-    version?: string;
-    __mj_CreatedAt?: Date;
-    __mj_UpdatedAt?: Date;
-    installed_rank?: number;
-    checksum?: number;
-    installed_by?: string;
-    installed_on?: Date;
-    execution_time?: number;
-}>;
-export type flyway_schema_historyEntityType = z.infer<typeof flyway_schema_historySchema>;
 /**
  * zod schema definition for the entity Integration URL Formats
  */
@@ -8451,6 +8428,37 @@ 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:
+    * * 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.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the speed rank must be zero or a positive number.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateSpeedRank(result: ValidationResult): void;
+    /**
+    * This rule ensures that the cost rank of an item must be zero or higher. This means that the cost rank cannot be negative.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateCostRank(result: ValidationResult): void;
+    /**
+    * This rule ensures that the power rank must be greater than or equal to zero, meaning that it cannot be negative.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidatePowerRank(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -10157,6 +10165,24 @@ export declare class CommunicationProviderEntity extends BaseEntity<Communicatio
     */
     get SupportsScheduledSending(): boolean;
     set SupportsScheduledSending(value: boolean);
+    /**
+    * * Field Name: SupportsForwarding
+    * * Display Name: Supports Forwarding
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Whether or not the provider supports forwarding messages to another recipient
+    */
+    get SupportsForwarding(): boolean;
+    set SupportsForwarding(value: boolean);
+    /**
+    * * Field Name: SupportsReplying
+    * * Display Name: Supports Replying
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Whether or not the provider supports replying to messages
+    */
+    get SupportsReplying(): boolean;
+    set SupportsReplying(value: boolean);
 }
 /**
  * Communication Runs - strongly typed entity sub-class
@@ -11903,6 +11929,21 @@ 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:
+    * * 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
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the user rating is between 1 and 10, inclusive. Ratings below 1 or above 10 are not allowed.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateUserRating(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -12024,7 +12065,6 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
     * * Field Name: User
     * * Display Name: User
     * * SQL Data Type: nvarchar(100)
-    * * Default Value: null
     */
     get User(): string | null;
 }
@@ -15709,6 +15749,44 @@ export declare class EntityFieldEntity extends BaseEntity<EntityFieldEntityType>
     get ValuesToPackWithSchema(): 'Auto' | 'None' | 'All';
     set ValuesToPackWithSchema(value: 'Auto' | 'None' | 'All');
     /**
+    * * Field Name: GeneratedValidationFunctionName
+    * * Display Name: Generated Validation Function Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Contains the name of the generated field validation function, if it exists, null otherwise
+    */
+    get GeneratedValidationFunctionName(): string | null;
+    set GeneratedValidationFunctionName(value: string | null);
+    /**
+    * * Field Name: GeneratedValidationFunctionDescription
+    * * Display Name: Generated Validation Function Description
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Contains a description for business users of what the validation function for this field does, if it exists
+    */
+    get GeneratedValidationFunctionDescription(): string | null;
+    set GeneratedValidationFunctionDescription(value: string | null);
+    /**
+    * * Field Name: GeneratedValidationFunctionCode
+    * * Display Name: Generated Validation Function Code
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Contains the generated code for the field validation function, if it exists, null otherwise.
+    */
+    get GeneratedValidationFunctionCode(): string | null;
+    set GeneratedValidationFunctionCode(value: string | null);
+    /**
+    * * Field Name: GeneratedValidationFunctionCheckConstraint
+    * * Display Name: Generated Validation Function Check Constraint
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: If a generated validation function was generated previously, this stores the text from the source CHECK constraint in the database. This is stored so that regeneration of the validation function will only occur when the source CHECK constraint changes.
+    */
+    get GeneratedValidationFunctionCheckConstraint(): string | null;
+    set GeneratedValidationFunctionCheckConstraint(value: string | null);
+    /**
+    * * Field Name: FieldCodeName
+    * * Display Name: Field Code Name
+    * * SQL Data Type: nvarchar(MAX)
+    */
+    get FieldCodeName(): string | null;
+    /**
     * * Field Name: Entity
     * * SQL Data Type: nvarchar(255)
     */
@@ -16646,6 +16724,21 @@ 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:
+    * * Sequence: This rule ensures that the sequence must be greater than zero.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the sequence must be greater than zero.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateSequence(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -17095,114 +17188,6 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
     */
     get Provider(): string;
 }
-/**
- * Flyway _schema _histories - strongly typed entity sub-class
- * * Schema: __mj
- * * Base Table: flyway_schema_history
- * * Base View: vwFlyway_schema_histories
- * * Primary Key: installed_rank
- * @extends {BaseEntity}
- * @class
- * @public
- */
-export declare class flyway_schema_historyEntity extends BaseEntity<flyway_schema_historyEntityType> {
-    /**
-    * Loads the Flyway _schema _histories record from the database
-    * @param installed_rank: number - primary key value to load the Flyway _schema _histories record.
-    * @param EntityRelationshipsToLoad - (optional) the relationships to load
-    * @returns {Promise<boolean>} - true if successful, false otherwise
-    * @public
-    * @async
-    * @memberof flyway_schema_historyEntity
-    * @method
-    * @override
-    */
-    Load(installed_rank: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
-    /**
-    * * Field Name: installed_rank
-    * * Display Name: installed _rank
-    * * SQL Data Type: int
-    */
-    get installed_rank(): number;
-    /**
-    * * Field Name: version
-    * * Display Name: version
-    * * SQL Data Type: nvarchar(50)
-    */
-    get version(): string | null;
-    set version(value: string | null);
-    /**
-    * * Field Name: description
-    * * Display Name: description
-    * * SQL Data Type: nvarchar(200)
-    */
-    get description(): string | null;
-    set description(value: string | null);
-    /**
-    * * Field Name: type
-    * * Display Name: type
-    * * SQL Data Type: nvarchar(20)
-    */
-    get type(): string;
-    set type(value: string);
-    /**
-    * * Field Name: script
-    * * Display Name: script
-    * * SQL Data Type: nvarchar(1000)
-    */
-    get script(): string;
-    set script(value: string);
-    /**
-    * * Field Name: checksum
-    * * Display Name: checksum
-    * * SQL Data Type: int
-    */
-    get checksum(): number | null;
-    set checksum(value: number | null);
-    /**
-    * * Field Name: installed_by
-    * * Display Name: installed _by
-    * * SQL Data Type: nvarchar(100)
-    */
-    get installed_by(): string;
-    set installed_by(value: string);
-    /**
-    * * Field Name: installed_on
-    * * Display Name: installed _on
-    * * SQL Data Type: datetime
-    * * Default Value: getdate()
-    */
-    get installed_on(): Date;
-    set installed_on(value: Date);
-    /**
-    * * Field Name: execution_time
-    * * Display Name: execution _time
-    * * SQL Data Type: int
-    */
-    get execution_time(): number;
-    set execution_time(value: number);
-    /**
-    * * Field Name: success
-    * * Display Name: success
-    * * SQL Data Type: bit
-    */
-    get success(): boolean;
-    set success(value: boolean);
-    /**
-    * * 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;
-}
 /**
  * Integration URL Formats - strongly typed entity sub-class
  * * Schema: __mj
@@ -19055,6 +19040,21 @@ 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:
+    * * MatchProbability: This rule ensures that the match probability value is between 0 and 1, inclusive.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that the match probability value is between 0 and 1, inclusive.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateMatchProbability(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier