/**
 * Typesense API
 * An open source search engine for building delightful search experiences.
 *
 * The version of the OpenAPI document: 30.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { CurationInclude } from './CurationInclude.js';
import type { CurationExclude } from './CurationExclude.js';
import type { CurationRule } from './CurationRule.js';
/**
 *
 * @export
 * @interface CurationItemSchema
 */
export interface CurationItemSchema {
    /**
     *
     * @type {CurationRule}
     * @memberof CurationItemSchema
     */
    rule: CurationRule;
    /**
     * List of document `id`s that should be included in the search results with their corresponding `position`s.
     * @type {Array<CurationInclude>}
     * @memberof CurationItemSchema
     */
    includes?: Array<CurationInclude>;
    /**
     * List of document `id`s that should be excluded from the search results.
     * @type {Array<CurationExclude>}
     * @memberof CurationItemSchema
     */
    excludes?: Array<CurationExclude>;
    /**
     * A filter by clause that is applied to any search query that matches the curation rule.
     *
     * @type {string}
     * @memberof CurationItemSchema
     */
    filterBy?: string;
    /**
     * Indicates whether search query tokens that exist in the curation's rule should be removed from the search query.
     *
     * @type {boolean}
     * @memberof CurationItemSchema
     */
    removeMatchedTokens?: boolean;
    /**
     * Return a custom JSON object in the Search API response, when this rule is triggered. This can can be used to display a pre-defined message (eg: a promotion banner) on the front-end when a particular rule is triggered.
     *
     * @type {object}
     * @memberof CurationItemSchema
     */
    metadata?: object;
    /**
     * A sort by clause that is applied to any search query that matches the curation rule.
     *
     * @type {string}
     * @memberof CurationItemSchema
     */
    sortBy?: string;
    /**
     * Replaces the current search query with this value, when the search query matches the curation rule.
     *
     * @type {string}
     * @memberof CurationItemSchema
     */
    replaceQuery?: string;
    /**
     * When set to true, the filter conditions of the query is applied to the curated records as well. Default: false.
     *
     * @type {boolean}
     * @memberof CurationItemSchema
     */
    filterCuratedHits?: boolean;
    /**
     * A Unix timestamp that indicates the date/time from which the curation will be active. You can use this to create rules that start applying from a future point in time.
     *
     * @type {number}
     * @memberof CurationItemSchema
     */
    effectiveFromTs?: number;
    /**
     * A Unix timestamp that indicates the date/time until which the curation will be active. You can use this to create rules that stop applying after a period of time.
     *
     * @type {number}
     * @memberof CurationItemSchema
     */
    effectiveToTs?: number;
    /**
     * When set to true, curation processing will stop at the first matching rule. When set to false curation processing will continue and multiple curation actions will be triggered in sequence. Curations are processed in the lexical sort order of their id field.
     *
     * @type {boolean}
     * @memberof CurationItemSchema
     */
    stopProcessing?: boolean;
    /**
     *
     * @type {string}
     * @memberof CurationItemSchema
     */
    id: string;
}
/**
 * Check if a given object implements the CurationItemSchema interface.
 */
export declare function instanceOfCurationItemSchema(value: object): value is CurationItemSchema;
export declare function CurationItemSchemaFromJSON(json: any): CurationItemSchema;
export declare function CurationItemSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): CurationItemSchema;
export declare function CurationItemSchemaToJSON(json: any): CurationItemSchema;
export declare function CurationItemSchemaToJSONTyped(value?: CurationItemSchema | null, ignoreDiscriminator?: boolean): any;