@creatio/base 0.823.0 → 0.831.0

package/index.d.ts

@@ -49,6 +49,75 @@ export declare enum eAdminUnitRoleSources {
     All = 63
 }
 
+/**
+ * @generativeApi
+ * @description Combined type for all ESQ expressions.If you plan to create a new expression, please add it to this type
+ * */
+declare type IESQExpression = ɵBaseExpression | ɵArithmeticExpression | ɵColumnExpression | ɵParameterExpression | ɵAggregationFunctionExpression | ɵArgumentFunctionExpression | ɵDatePartFunctionExpression | ɵLengthFunctionExpression | ɵMacrosFunctionExpression | ɵWindowFunctionExpression;
+
+/**
+ * @generativeApi
+ * @description Combined type for all ESQ filters. If you plan to create a new filter, please add it to this type.
+ * */
+export declare type IESQFilter = ɵBaseFilter | ɵBetweenFilter | ɵCompareFilter | ɵExistsFilter | IFilterGroup | ɵInFilter | ɵIsNullFilter | ɵSingleFilter;
+
+/**
+ * @public
+ * this interface is created, because JSON schema generation does not support getters
+ * @generativeApi
+ * @description Group of filters. Usually one, or several filters, combined with a logical operation (And, Or).
+ * Groups of filters can be nested into each other,
+ * i.e. The collection itself can be an element of another collection.
+ * @extends {ɵBaseFilter}
+ */
+export declare type IFilterGroup = ɵBaseFilter & {
+    /**
+     * @description Type of filter. 6 means that this is a filter group.
+     * @default 6
+     */
+    readonly filterType: ɵFilterType.FilterGroup;
+    /**
+     * @description Returns collection of child filters or filter groups.
+     * Each item is a key-value pair,
+     * where the key is autogenerated or user-defined name, and value - filter or a filter group
+     */
+    items: Record<string, IESQFilter>;
+    /**
+     * @description The type of the logical operation for a combination of filters in this filter group.
+     */
+    logicalOperation: ɵLogicalOperatorType;
+    /**
+     * @description Root entity schema name or table name.
+     */
+    rootSchemaName?: string;
+};
+
+/**
+ * @public
+ * @generativeApi
+ * @description Parameter object reference. Defines the value and type of the parameter.
+ * dateValue property exists only if dataValueType is 7.
+ */
+export declare interface IParameterDefinition<TDataValueType extends ɵDataValueType = ɵDataValueType> {
+    /**
+     * @description type of the parameter value.
+     * */
+    dataValueType: TDataValueType;
+    /**
+     * @description exists only if dataValueType is 7. Contains the ISO 8601 date string.
+     * */
+    dateValue?: TDataValueType extends ɵDataValueType.DateTime ? `${string}T${string}Z` : never;
+    /**
+     * @description defines the value of the parameter.
+     * If dataValueType is 7. Contains the ISO 8601 date string. but wrapped in escaped string.
+     * E.g.: `\"2023-01-01T00:00:00.000Z\"`, otherwise it is the value of the parameter.
+     * If dataValueType is 10, then value is ɵLookupValue.
+     * value cannot be an array
+     * */
+    value?: TDataValueType extends ɵDataValueType.DateTime ? string : ɵEntityColumnValue;
+    arrayValue?: string[];
+}
+
 /* Excluded from this release type: LookupMode */
 
 /* Excluded from this release type: UsedColumn */
@@ -67,7 +136,10 @@ export declare type ɵAggregationEval = 'all' | 'distinct' | 'none';
 
 /**
  * @public
- * @description Scope of the aggregation function.
+ * @generativeApi
+ * @description Defines the scope or evaluation mode for aggregation functions.
+ * 0 - None (No specific scope defined), 1 - All (Includes all values including duplicates),
+ * 2 - Distinct (Only unique values, eliminates duplicates)
  */
 export declare enum ɵAggregationEvalType {
     /**
@@ -121,15 +193,16 @@ export declare enum ɵAggregationFunction {
 
 /**
  * @public
- * @classdesc Class contains info about column with aggregation function.
+ * @description Class contains info about column with aggregation function.
  * @extends {ɵBaseQueryColumn}
  */
 export declare class ɵAggregationFunctionColumn extends ɵBaseQueryColumn<ɵAggregationFunctionExpression> {
-    constructor(aggregationType: ɵAggregationType, aggregationEvalType: ɵAggregationEvalType, functionArgument: ɵBaseExpression);
+    constructor(aggregationType: ɵAggregationType, aggregationEvalType: ɵAggregationEvalType, functionArgument: ɵColumnExpression);
 }
 
 /**
  * @public
+ * @generativeApi
  * @description A class that describes expression with aggregate function.
  * @extends {ɵArgumentFunctionExpression}
  */
@@ -207,7 +280,15 @@ export declare type ɵAggregationSubQueryExpressionConfig = ɵSubQueryExpression
 
 /**
  * @public
- * The type of the aggregation (can be set to None).
+ * @generativeApi
+ * @description The type of aggregation function used in queries and data operations.
+ * 0 - None (No aggregation),
+ * 1 - Count (Count records - can be used with any column type),
+ * 2 - Sum (Total of values - numeric columns only),
+ * 3 - Avg (Average value - numeric columns only),
+ * 4 - Min (Minimum value - numeric and date columns),
+ * 5 - Max (Maximum value - numeric and date columns),
+ * 6 - TopOne (First record - any column type)
  */
 export declare enum ɵAggregationType {
     /**
@@ -252,6 +333,7 @@ export declare class ɵArgumentEmptyException extends Error {
 /**
  * @public
  * @abstract
+ * @generativeApi
  * @description A class that describes a functional expression with argument.
  * @extends {ɵFunctionExpression}
  */
@@ -261,7 +343,7 @@ export declare abstract class ɵArgumentFunctionExpression extends ɵFunctionExp
     /**
      * @description Expression argument.
      */
-    readonly functionArgument: ɵBaseExpression;
+    readonly functionArgument: IESQExpression;
     protected constructor(config: ɵArgumentFunctionExpressionConfig<ɵArgumentFunctionExpression>);
     /**
      * @public
@@ -290,6 +372,7 @@ export declare class ɵArgumentOutOfRangeException extends Error {
 
 /**
  * @public
+ * @genearativeApi
  * @description Arithmetic expression.
  * @extends {ɵBaseExpression}
  */
@@ -307,11 +390,11 @@ export declare class ɵArithmeticExpression extends ɵBaseExpression {
     /**
      * @description Left operand expression.
      */
-    readonly leftArithmeticOperand: ɵBaseExpression;
+    readonly leftArithmeticOperand: IESQExpression;
     /**
      * @description Right operand expression.
      */
-    readonly rightArithmeticOperand: ɵBaseExpression;
+    readonly rightArithmeticOperand: IESQExpression;
     constructor(config: ɵArithmeticExpressionConfig);
     /**
      * Parses expression from json.
@@ -334,7 +417,10 @@ export declare type ɵArithmeticExpressionConfig = ɵExpressionConfig<ɵArithmet
 
 /**
  * @public
- * @description Arithmetic operation.
+ * @generativeApi
+ * @description Represents arithmetic operations that can be performed in queries and expressions.
+ * 0 - Addition (Adds values), 1 - Subtraction (Subtracts values),
+ * 2 - Multiplication (Multiplies values), 3 - Division (Divides values)
  */
 export declare enum ɵArithmeticOperation {
     /**
@@ -446,6 +532,7 @@ export declare interface ɵBaseDialogService<TConfig extends ɵBaseDialogConfig
 
 /**
  * @public
+ * @generativeApi
  * @abstract
  * @description The base class of the expression.
  * @extends {ɵSerializable}
@@ -455,8 +542,9 @@ export declare abstract class ɵBaseExpression implements ɵSerializable {
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description True if expression has brackets.
+     * @default false
      */
-    readonly isBlock: boolean;
+    readonly isBlock?: boolean;
     /**
      * @public
      * @description Method for checking if an instance is of the current class type.
@@ -509,7 +597,8 @@ export declare class ɵBaseExpressionParser {
 /**
  * @public
  * @abstract
- * @description The base class of the filter.
+ * @generativeApi
+ * @description Base class for all filters in the system.
  * @extends {ɵSerializable}
  */
 export declare abstract class ɵBaseFilter implements ɵSerializable {
@@ -521,12 +610,14 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
     readonly filterType: ɵFilterType;
     /**
      * @description Indicates that the filter is active and will be taken into account when building the query.
+     * @default true
      */
     isEnabled: boolean;
     /**
-     * @description Drop the time for the date / time type parameters.
+     * @description Drop the time for the date / time type parameters. In FilterGroup this option is not supported.
+     * @default false
      */
-    trimDateTimeParameterToDate: boolean;
+    trimDateTimeParameterToDate?: boolean;
     /**
      * @public
      * @description Method for checking if an instance is of the current class type.
@@ -705,6 +796,9 @@ export declare interface ɵBaseModel<TLoadOptions extends ɵDataSourceLoadOption
 export declare abstract class ɵBaseQuery implements ɵMetadataProvider<Record<string, unknown>> {
     readonly operationType: ɵQueryOperationType;
     readonly rootSchemaName: string;
+    queryId?: string;
+    /* Excluded from this release type: _queryDtoType */
+    get queryDtoType(): string;
     protected constructor(operationType: ɵQueryOperationType, rootSchemaName: string);
     /** {@inheritDoc ɵMetadataProvider.getMetadata} */
     getMetadata(): Record<string, unknown>;
@@ -713,6 +807,7 @@ export declare abstract class ɵBaseQuery implements ɵMetadataProvider<Record<s
 /**
  * @public
  * @abstract
+ * @generativeApi
  * @classdesc Class contains info about column for query.
  */
 export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpression = ɵBaseExpression> {
@@ -759,6 +854,7 @@ export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpres
      */
     withCaption(caption: string): this;
     /* Excluded from this release type: _getUsedColumns */
+    /* Excluded from this release type: toJson */
 }
 
 /**
@@ -806,21 +902,29 @@ export declare interface ɵBaseSysSettingsService {
 
 /**
  * @public
+ * generativeApi
  * @description Filter class of the "Between" type.
+ * It contains RightLessExpression and RightGreaterExpression,
+ * which represent the boundaries of values for filtering.
  * @extends {ɵSingleFilter}
  */
 export declare class ɵBetweenFilter extends ɵSingleFilter {
+    /**
+     * @description Type of filter.
+     * @default 3
+     * */
+    readonly filterType: 3;
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description The initial expression of the filtering range.
      */
-    readonly rightLessExpression: ɵBaseExpression;
+    readonly rightLessExpression: IESQExpression;
     /**
      * @description The final expression of the filtering range.
      */
-    readonly rightGreaterExpression: ɵBaseExpression;
-    constructor(leftExpression: ɵBaseExpression, rightLessExpression: ɵBaseExpression, rightGreaterExpression: ɵBaseExpression);
+    readonly rightGreaterExpression: IESQExpression;
+    constructor(leftExpression: IESQExpression, rightLessExpression: IESQExpression, rightGreaterExpression: IESQExpression);
     /**
      * Parses filter from json.
      * @public
@@ -839,6 +943,7 @@ export declare type ɵButtonColor = 'primary' | 'accent' | 'warn' | 'default';
 
 /**
  * @public
+ * @generativeApi
  * @description A class that defines an expression of type column EntitySchema.
  * @extends {ɵBaseExpression}
  */
@@ -875,17 +980,24 @@ export declare type ɵColumnExpressionConfig = ɵExpressionConfig<ɵColumnExpres
 
 /**
  * @public
- * @description Comparison filter class.
+ * @generativeApi
+ * @description Filter class for comparing two expressions. leftExpression describes column from the schema,
+ * by which the comparison is made, rightExpression describes the value to which the column is compared.
  * @extends {ɵSingleFilter}
  */
 export declare class ɵCompareFilter extends ɵSingleFilter {
+    /**
+     * @description Type of filter.
+     * @default 1
+     */
+    readonly filterType: 1;
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
-     * @description Filter expression.
+     * @description Filter expression. Right expression is used to compare values of column from the left expression
      */
-    readonly rightExpression: ɵBaseExpression;
-    constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression, rightExpression: ɵBaseExpression);
+    readonly rightExpression: IESQExpression;
+    constructor(comparisonType: ɵComparisonType, leftExpression: IESQExpression, rightExpression: IESQExpression);
     /**
      * Parses filter from json.
      * @public
@@ -898,12 +1010,22 @@ export declare class ɵCompareFilter extends ɵSingleFilter {
 
 /**
  * @public
- * @description The type of comparison operation in the filter.
+ * @generativeApi
+ * @description The type of comparison operation used in filters and query conditions.
+ 1 - Is_null (Value is null), 2 - Is_not_null (Value is not null),
+ * 3 - Equal (Value equals), 4 - Not_equal (Value doesn't equal), 5 - Less (Value is less than),
+ * 6 - Less_or_equal (Value is less than or equal), 7 - Greater (Value is greater than),
+ * 8 - Greater_or_equal (Value is greater than or equal), 9 - Start_with (Value starts with string),
+ * 10 - Not_start_with (Value doesn't start with string), 11 - Contain (Value contains string),
+ * 12 - Not_contain (Value doesn't contain string), 13 - End_with (Value ends with string),
+ * 14 - Not_end_with (Value doesn't end with string), 15 - Exists (Value exists),
+ * 16 - Not_exists (Value doesn't exist)
  */
 export declare enum ɵComparisonType {
     /**
      * @public
      * @description Value is between two specified values.
+     * @hidden
      */
     Between = 0,
     /**
@@ -1082,10 +1204,13 @@ export declare interface ɵDataSchema {
  * @property {string} name - name of DataSchemaAttribute.
  * @property {string} caption - caption of DataSchemaAttribute.
  * @property {string} isValueCloneable - copy this DataSchemaAttribute value when copying object.
- * @property {string} referenceSchemaName - name of refernce DataSchema.
+ * @property {string} referenceSchemaName - name of reference DataSchema.
  * @property {boolean} isMasked - is mask used for DataSchemaAttribute.
  * @property {boolean} isFormatValidated - is format validated for DataSchemaAttribute.
- * @property {boolean} isSensitiveData - is data of DataSchemaAttribute sensetive.
+ * @property {boolean} isSensitiveData - is data of DataSchemaAttribute sensitive.
+ * @property {boolean} isValueMasked - is value of DataSchemaAttribute masked.
+ * @property {DataSchemaAttributeValueMaskingSettings} valueMaskingSettings -
+ * settings for masking DataSchemaAttribute value.
  * @property {boolean} isRequired - flag to determine DataSchemaAttribute required or not.
  */
 export declare interface ɵDataSchemaAttribute {
@@ -1151,7 +1276,7 @@ export declare interface ɵDataSchemaAttribute {
     aggregationConfig?: ɵDataSchemaAttributeAggregationConfig;
     /**
      * @public
-     * @description Whether attribute should ues mask.
+     * @description Whether attribute should use mask for input.
      */
     isMasked: boolean;
     /**
@@ -1169,6 +1294,16 @@ export declare interface ɵDataSchemaAttribute {
      * @description Whether attribute is contain sensitive data.
      */
     isSensitiveData: boolean;
+    /**
+     * @public
+     * @description Whether attribute value is masked.
+     */
+    isValueMasked: boolean;
+    /**
+     * @public
+     * @description Value masking settings.
+     */
+    valueMaskingSettings: ɵDataSchemaAttributeValueMaskingSettings;
     /**
      * @public
      * @description Usage type.
@@ -1245,6 +1380,31 @@ export declare interface ɵDataSchemaAttributeValidatorConfig {
     };
 }
 
+/**
+ * @public
+ * @description Masking settings for attribute value.
+ * @property {string} pattern - Regular expression pattern to match the value.
+ * @property {string} replacement - Replacement string for the matched value.
+ * @property {string} adminOperationCode - Admin operation code for unmasking value.
+ */
+export declare interface ɵDataSchemaAttributeValueMaskingSettings {
+    /**
+     * @public
+     * @description Regular expression pattern to match the value.
+     */
+    pattern: string;
+    /**
+     * @public
+     * @description Replacement string for the matched value.
+     */
+    replacement: string;
+    /**
+     * @public
+     * @description Admin operation code for unmasking value.
+     */
+    adminOperationCode: string;
+}
+
 /**
  * @public
  * @decription Type of DataSchema. In combination with the name is used for unique identification of {@link ɵDataSchema}.
@@ -1602,6 +1762,53 @@ export declare interface ɵDataSourceSortingConfig {
 
 /**
  * @public
+ * @generativeApi
+ * @description possible BE valur types. Try to keep it same as {@link ɵEntityColumnValue}.
+ * 0 - Global unique identifier.
+ * 1 - String.
+ * 4 - Integer.
+ * 5 - Real number.
+ * 6 - Currency.
+ * 7 - Date and time.
+ * 8 - Date.
+ * 9 - Time.
+ * 10 - Lookup.
+ * 11 - Enumeration.
+ * 12 - Boolean.
+ * 13 - Binary data object.
+ * 14 - The object of image binary data.
+ * 15 - Custom object.
+ * 16 - Image from a lookup.
+ * 17 - Collection of items.
+ * 18 - Color.
+ * 19 - Localized string.
+ * 20 - Object (Entity).
+ * 21 - Collection of objects (EntityCollection).
+ * 22 - List of object column values (EntityColumnMappingCollection).
+ * 23 - Hash string.
+ * 24 - Encrypted string.
+ * 25 - File.
+ * 26 - Mapping.
+ * 27 - Short length text.
+ * 28 - Medium length text.
+ * 29 - Unlimited length text.
+ * 30 - Long length text.
+ * 31 - float1.
+ * 32 - float2.
+ * 33 - float3.
+ * 34 - float4.
+ * 35 - Localizable parameter values list.
+ * 36 - Process not localizable text.
+ * 37 - Stage indicator.
+ * 38 - Serializable list of values.
+ * 39 - Serializable list of composite values.
+ * 40 - float8.
+ * 41 - File.
+ * 42 - Phone.
+ * 43 - Text with formating tags.
+ * 44 - Web link.
+ * 45 - Email.
+ * 46 - Composite object.
  * Types of values.
  */
 export declare enum ɵDataValueType {
@@ -1626,7 +1833,9 @@ export declare enum ɵDataValueType {
      */
     Money = 6,
     /**
-     * @description Date and time.
+     * @description Date and time. if used this type of a value, then value should consist of two parts:
+     * "dateValue": "ISO 8601 date string",
+     * "value": "\"ISO 8601 date string\""
      */
     DateTime = 7,
     /**
@@ -1777,7 +1986,9 @@ export declare type ɵDatePart = 'minute' | 'hour' | 'day' | 'weekday' | 'week'
 
 /**
  * @public
+ * @generativeApi
  * @classdesc Class contains info about column with date part.
+ * @description Class contains info about column with date part.
  * @extends {ɵBaseQueryColumn}
  */
 export declare class ɵDatePartFunctionColumn extends ɵBaseQueryColumn<ɵDatePartFunctionExpression> {
@@ -1790,6 +2001,7 @@ export declare class ɵDatePartFunctionColumn extends ɵBaseQueryColumn<ɵDatePa
 
 /**
  * @public
+ * @gererativeApi
  * @description A class that describes expression part of date function.
  * @extends {ɵArgumentFunctionExpression}
  */
@@ -1822,7 +2034,16 @@ export declare type ɵDatePartFunctionExpressionConfig = ɵArgumentFunctionExpre
 
 /**
  * @public
- * @description Part of the date.
+ * @generativeApi
+ * @description Defines possible parts of the date.
+ * 0 - Empty value.
+ * 1 - Day.
+ * 2 - Week.
+ * 3 - Month.
+ * 4 - Year.
+ * 5 - Day of the week.
+ * 6 - Hour.
+ * 7 - Minute.
  */
 export declare enum ɵDatePartType {
     /**
@@ -1891,6 +2112,7 @@ export declare enum ɵDefaultValueSource {
  * @extends {ɵBaseFilterableQuery}
  */
 export declare class ɵDeleteQuery extends ɵBaseFilterableQuery {
+    /* Excluded from this release type: _queryDtoType */
     constructor(rootSchemaName: string);
 }
 
@@ -1926,12 +2148,14 @@ export declare function ɵencodeDate(date: Date): string;
 
 /**
  * @public
- * @description type of column value.
+ * @generativeApi
+ * @description possible type of column value.
  */
 export declare type ɵEntityColumnValue = boolean | number | string | ɵGuid | Date | ɵLookupValue | null;
 
 /**
  * @public
+ * @generativeApi
  * @classdesc Class contains info about common column from entity.
  * @extends {ɵBaseQueryColumn}
  */
@@ -1946,6 +2170,7 @@ export declare class ɵEntityQueryColumn extends ɵBaseQueryColumn<ɵColumnExpre
  */
 export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
     private _columns;
+    /* Excluded from this release type: _queryDtoType */
     /**
      * @description Determines if merge duplicates in query result.
      */
@@ -2088,21 +2313,29 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
 
 /**
  * @public
+ * @generativeApi
  * @description The comparison filter class [Exists according to the specified condition].
  * @extends {ɵSingleFilter}
  */
 export declare class ɵExistsFilter extends ɵSingleFilter {
+    /**
+     * @description Type of filter.
+     * @default 5
+     */
+    readonly filterType: 5;
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description Subquery filters. Cannot contain filters with other subqueries.
+     * @hidden
      */
     readonly subFilters?: ɵFilterGroup;
     /**
      * @description Indicates that the filter is aggregating.
+     * @default true
      */
     readonly isAggregative: boolean;
-    constructor(leftExpression: ɵBaseExpression, subFilters?: ɵFilterGroup, comparisonType?: ɵComparisonType, isAggregative?: boolean);
+    constructor(leftExpression: IESQExpression, subFilters?: ɵFilterGroup, comparisonType?: ɵComparisonType, isAggregative?: boolean);
     /**
      * Parses filter from json.
      * @public
@@ -2162,7 +2395,11 @@ export declare class ɵExpressionResolver {
 
 /**
  * @public
+ * @generativeApi
  * @description Type of expression.
+ * 0 - SchemaColumn (Reference to a data column), 1 - Function (Function call expression),
+ * 2 - Parameter (Parameter value), 3 - SubQuery (Nested query expression),
+ * 4 - ArithmeticOperation (Mathematical operation)
  */
 export declare enum ɵExpressionType {
     /**
@@ -2193,23 +2430,33 @@ export declare enum ɵExpressionType {
  * i.e. The collection itself can be an element of another collection.
  * @extends {ɵBaseFilter}
  */
-export declare class ɵFilterGroup extends ɵBaseFilter {
+export declare class ɵFilterGroup extends ɵBaseFilter implements IFilterGroup {
+    /**
+     * @description Type of filter.
+     * @default 6
+     */
+    readonly filterType = ɵFilterType.FilterGroup;
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @public
+     * @hidden
      * @description Collection of child filters.
      */
     filters: Map<string, ɵBaseFilter>;
     /**
      * @public
-     * @description Return collecion of deserialized filters.
+     * @description Returns collection of child filters or filter groups.
+     * Each item is a key-value pair,
+     * where the key is autogenerated or user-defined name, and value - filter or a filter group
+     * @default {}
      */
     get items(): {
         [key: string]: ɵBaseFilter;
     };
     /**
-     * @description The type of the logical operation for a combination of filters in the collection.
+     * @description The type of the logical operation for a combination of filters in this filter group.
+     * @default 0
      */
     logicalOperation: ɵLogicalOperatorType;
     /**
@@ -2349,6 +2596,12 @@ export declare class ɵFilterResolver {
 /**
  * @public
  * @description The type of filter.
+ * - 0 None, No filter applied.
+ * - 1 Compare, Comparison filter (e.g., equal to, greater than).
+ * - 2 IsNull, Checks if a value is null.
+ * - 4 In, Checks if a value is in a specified set of values.
+ * - 5 Exists, Checks if a value exists.
+ * - 6 FilterGroup, A group of filters combined with logical operators (AND, OR).
  */
 export declare enum ɵFilterType {
     /**
@@ -2369,6 +2622,8 @@ export declare enum ɵFilterType {
     /**
      * @public
      * @description Checks if a value is between two specified values.
+     * should be used with {@link ɵBetweenFilter}
+     * @hidden
      */
     Between = 3,
     /**
@@ -2402,7 +2657,9 @@ export declare interface ɵFiltrationPlatformAPIOptions extends ɵPlatformAPIOpt
 /**
  * @public
  * @abstract
+ * @generativeApi
  * @description A class that describes a functional expression.
+ * Functional expressions are evaluated on BE to produce a value based on the function type.
  * @extends {ɵFunctionExpression}
  */
 export declare abstract class ɵFunctionExpression extends ɵBaseExpression {
@@ -2410,6 +2667,7 @@ export declare abstract class ɵFunctionExpression extends ɵBaseExpression {
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description Expression type. Default 'Function'.
+     * @default 1.
      */
     readonly expressionType: ɵExpressionType;
     /**
@@ -2437,7 +2695,13 @@ export declare type ɵFunctionStringType = 'aggregation' | 'datePart' | 'none';
 
 /**
  * @public
- * @description The type of function in the filter.
+ * @generativeApi
+ * @description The type of function in the filter, or in the aggregation function
+ * 0 - None (Function type not defined), 1 - Macros (Substitution by macro),
+ * 2 - Aggregation (Aggregating function), 3 - DatePart (Date fragment),
+ * 4 - Length (Size of value in bytes), 5 - Window (Window query function),
+ * 6 - DateAdd (Date addition), 7 - DateDiff (Date difference).
+ * if used in aggregation function, use 2 by default.
  */
 export declare enum ɵFunctionType {
     /**
@@ -2485,6 +2749,7 @@ export declare function ɵgenerateGuid(): ɵGuid;
 /* Excluded from this release type: ɵgetFilterPlainObj */
 
 /**
+ * @generativeApi
  * @description Type for Guid value.
  * @public
  */
@@ -2492,17 +2757,24 @@ export declare type ɵGuid = string;
 
 /**
  * @public
- * @description In-Filter Class
+ * @generativeApi
+ * @description Filter that checks if the value of {@link #leftExpression} is satisfied
+ * by each of expressions in the array of {@link #rightExpressions}.
  * @extends {ɵSingleFilter}
  */
 export declare class ɵInFilter extends ɵSingleFilter {
+    /**
+     * @description Type of filter. 4 means filter of type "In".
+     * @default 4
+     */
+    readonly filterType: 4;
     /* Excluded from this release type: _instanceOfKey */
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description An array of expressions that will be compared with {@link #leftExpression}.
      */
-    readonly rightExpressions: ɵBaseExpression[];
-    constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression, rightExpressions: ɵBaseExpression[]);
+    readonly rightExpressions: IESQExpression[];
+    constructor(comparisonType: ɵComparisonType, leftExpression: IESQExpression, rightExpressions: IESQExpression[]);
     /**
      * @description Parses in filter from json.
      * @public
@@ -2521,6 +2793,7 @@ export declare class ɵInFilter extends ɵSingleFilter {
  */
 export declare class ɵInsertQuery extends ɵBaseQuery {
     private _columnValues;
+    /* Excluded from this release type: _queryDtoType */
     constructor(rootSchemaName: string);
     /**
      * @description A collection of column values for updating entities.
@@ -2557,17 +2830,27 @@ export declare function ɵisGuid(value: unknown): boolean;
 
 /**
  * @public
- * @description IsNull filter Class
+ * @generativeApi
+ * @description Filter that checks if the value of {@link #leftExpression} equals to null or not.
  * @extends {ɵSingleFilter}
  */
 export declare class ɵIsNullFilter extends ɵSingleFilter {
+    /**
+     * @description Type of filter.
+     * @default 2
+     */
+    readonly filterType: 2;
     /**
      * @description Flag that indicates if expression is empty or not.
      */
     isNull: boolean;
     /* Excluded from this release type: _instanceOfKey */
-    /* Excluded from this release type: _instanceOfKeys */
-    constructor(comparisonType: ɵComparisonType.Is_null | ɵComparisonType.Is_not_null, leftExpression: ɵBaseExpression);
+    /**
+     * @internale
+     * @dontChange
+     */
+    protected static get _instanceOfKeys(): string[];
+    constructor(comparisonType: ɵComparisonType.Is_null | ɵComparisonType.Is_not_null, leftExpression: IESQExpression);
     private static _getComparisonType;
     /**
      * @description Parses isNull filter from json.
@@ -2623,9 +2906,14 @@ export declare type ɵJsonData = string | number | boolean | null | undefined |
 
 /**
  * @public
+ * @generativeApi
+ * @hidden
  * @description JSON object.
  */
 export declare interface ɵJsonObject {
+    /**
+     * @hidden
+     * */
     [key: string]: ɵJsonData;
 }
 
@@ -2640,6 +2928,7 @@ export declare class ɵLengthFunctionColumn extends ɵBaseQueryColumn<ɵLengthFu
 
 /**
  * @public
+ * @generativeApi
  * @description A class that describes expression with length function.
  * @extends {ɵArgumentFunctionExpression}
  */
@@ -2691,7 +2980,9 @@ export declare type ɵLocalizeFn = (key: string) => string;
 
 /**
  * @public
- * @description The type of logical operation.
+ * @generativeApi
+ * @description The type of logical operation used to combine multiple conditions in filters.
+ * 0 - And (All conditions must be true), 1 - Or (At least one condition must be true)
  */
 export declare enum ɵLogicalOperatorType {
     /**
@@ -2706,6 +2997,7 @@ export declare enum ɵLogicalOperatorType {
 
 /**
  * @public
+ * @genearativeApi
  * @description Required shape for lookup.
  * @extends {ɵJsonObject}
  * @property {string} displayValue - Value witch will be displayed in lookup
@@ -2761,6 +3053,7 @@ export declare class ɵMacrosFunctionColumn extends ɵBaseQueryColumn<ɵMacrosFu
 
 /**
  * @public
+ * @generativeApi
  * @description A class that describes expression with macros function.
  * @extends {ɵFunctionExpression}
  */
@@ -2769,6 +3062,7 @@ export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description Function type. Default 'Macros'.
+     * @default 1
      */
     readonly functionType: ɵFunctionType;
     /**
@@ -2777,8 +3071,9 @@ export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
     readonly macrosType: ɵQueryMacrosType;
     /**
      * @description Function argument.
+     * it is optional and exists only for some macros functions.
      */
-    readonly functionArgument?: ɵBaseExpression;
+    readonly functionArgument?: IESQExpression;
     constructor(config: ɵMacrosFunctionExpressionConfig);
     /**
      * Parses expression from json.
@@ -2975,7 +3270,9 @@ export declare class ɵNextHandlerAlreadySpecifiedException extends Error {
 
 /**
  * @public
- * @description Sort order (can be set to None).
+ * @generativeApi
+ * @description Specifies the sort direction for query results.
+ * 0 - None (No specific ordering), 1 - Asc (Ascending order, A-Z, 0-9), 2 - Desc (Descending order, Z-A, 9-0)
  */
 export declare enum ɵOrderDirection {
     /**
@@ -2994,7 +3291,9 @@ export declare enum ɵOrderDirection {
 
 /**
  * @public
+ * @generativeApi
  * @description The class that defines the parametric expression.
+ * It means that result of this expression is a parameter value.
  * @extends {ɵBaseExpression}
  */
 export declare class ɵParameterExpression extends ɵBaseExpression {
@@ -3006,20 +3305,21 @@ export declare class ɵParameterExpression extends ɵBaseExpression {
     readonly expressionType: ɵExpressionType;
     /**
      * @description Parameter value.
+     * @hidden
      */
     readonly value: ɵEntityColumnValue;
     /**
      * @description Parameter value type.
+     * @hidden
      */
     readonly dataValueType: ɵDataValueType;
     /**
-     * @description Parameter object reference.
+     * @description Parameter object reference. Defines the value and type of the parameter.
+     * dateValue property exists only if dataValueType === ɵDataValueType.DateTime.
+     * if dataValueType === ɵDataValueType.DateTime, dataValueType will contain the ISO 8601 date string and
+     * value will contain the same date, but wrapped in escaped string. E.g.: "\"2023-01-01T00:00:00.000Z\""
      */
-    readonly parameter: {
-        value?: ɵEntityColumnValue;
-        arrayValue?: string[];
-        dataValueType: ɵDataValueType;
-    };
+    readonly parameter: IParameterDefinition;
     constructor(config: ɵParameterExpressionConfig);
     /**
      * Parses expression from json.
@@ -3102,7 +3402,36 @@ export declare interface ɵPrimaryDisplayFilterDataSourceParameter extends ɵBas
 
 /**
  * @public
- * @description The type of macros.
+ * @generativeApi
+ * @description Defines the types of macros that can be used in queries.
+ * 0 - None (No macro), 1 - CurrentUser (Current user ID), 2 - CurrentUserContact (User's contact),
+ * 3 - Yesterday (Previous day), 4 - Today (Current day), 5 - Tomorrow (Next day),
+ * 6 - PreviousWeek (Last week), 7 - CurrentWeek (This week), 8 - NextWeek (Coming week),
+ * 9 - PreviousMonth (Last month), 10 - CurrentMonth (This month), 11 - NextMonth (Coming month)
+ * 12 - Previous quarter.
+ * 13 - Current quarter.
+ * 14 - Next quarter.
+ * 15 - Previous half of the year.
+ * 16 - Current half-year.
+ * 17 - Next half-year.
+ * 18 - Last year.
+ * 19 - This year.
+ * 20 - Previous hour.
+ * 21 - Current hour.
+ * 22 - Next hour.
+ * 23 - Next year.
+ * 24 - Next N Days.
+ * 25 - Previous N days.
+ * 26 - Next N hours.
+ * 27 - Previous N hours.
+ * 34 - Primary column.
+ * 35 - Primary displayed column.
+ * 36 - Primary image display column.
+ * 37 - Anniversary today.
+ * 38 - Anniversary on the date computed as today plus days offset.
+ * 39 - Anniversary on the next several days.
+ * 40 - Anniversary on the previous several days.
+ * 41 - Primary color display column.
  */
 export declare enum ɵQueryMacrosType {
     /**
@@ -3379,6 +3708,7 @@ export declare interface ɵSerializable {
 
 /**
  * @public
+ * @generativeApi
  * @description Basic filter class with one condition.
  * @extends {ɵBaseFilter}
  */
@@ -3387,13 +3717,20 @@ export declare abstract class ɵSingleFilter extends ɵBaseFilter {
     /* Excluded from this release type: _instanceOfKeys */
     /**
      * @description Type of comparison operation.
+     * this comparison type defines how the {@link #leftExpression} will be compared
+     * with the value of the right expression.
      */
     readonly comparisonType: ɵComparisonType;
     /**
-     * @description The test expression.
+     * @description expression that contains the value to be compared with the right expressions.
+     */
+    readonly leftExpression: IESQExpression;
+    /**
+     * @description name of the entity schema, connected to the root schema of the filter.
+     * Used, when one of the expressions uses a column from another schema.
      */
-    readonly leftExpression: ɵBaseExpression;
-    protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
+    readonly referenceSchemaName?: string;
+    protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: IESQExpression);
     /** {@inheritDoc ɵSerializable.toJson} */
     toJson(): ɵJsonObject;
     /* Excluded from this release type: _getUsedColumns */
@@ -3538,6 +3875,7 @@ export declare type ɵType<T = any> = new (...args: any[]) => T;
  */
 export declare class ɵUpdateQuery extends ɵBaseFilterableQuery {
     private _columnValues;
+    /* Excluded from this release type: _queryDtoType */
     /**
      * @description Flag that indicates whether to force save data.
      */
@@ -3637,6 +3975,7 @@ export declare class ɵWindowFunctionColumn extends ɵBaseQueryColumn<ɵWindowFu
 
 /**
  * @public
+ * @generativeApi
  * @description A class that describes expression with window function.
  * @extends {ɵArgumentFunctionExpression}
  */