import type * as Square from "../index";
/**
 * Defines how discounts are automatically applied to a set of items that match the pricing rule
 * during the active time period.
 */
export interface CatalogPricingRule {
    /**
     * User-defined name for the pricing rule. For example, "Buy one get one
     * free" or "10% off".
     */
    name?: string | null;
    /**
     * A list of unique IDs for the catalog time periods when
     * this pricing rule is in effect. If left unset, the pricing rule is always
     * in effect.
     */
    timePeriodIds?: string[] | null;
    /**
     * Unique ID for the `CatalogDiscount` to take off
     * the price of all matched items.
     */
    discountId?: string | null;
    /**
     * Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule
     * matches within the entire cart, and can match multiple times. This field will always be set.
     */
    matchProductsId?: string | null;
    /**
     * __Deprecated__: Please use the `exclude_products_id` field to apply
     * an exclude set instead. Exclude sets allow better control over quantity
     * ranges and offer more flexibility for which matched items receive a discount.
     *
     * `CatalogProductSet` to apply the pricing to.
     * An apply rule matches within the subset of the cart that fits the match rules (the match set).
     * An apply rule can only match once in the match set.
     * If not supplied, the pricing will be applied to all products in the match set.
     * Other products retain their base price, or a price generated by other rules.
     */
    applyProductsId?: string | null;
    /**
     * `CatalogProductSet` to exclude from the pricing rule.
     * An exclude rule matches within the subset of the cart that fits the match rules (the match set).
     * An exclude rule can only match once in the match set.
     * If not supplied, the pricing will be applied to all products in the match set.
     * Other products retain their base price, or a price generated by other rules.
     */
    excludeProductsId?: string | null;
    /** Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD). */
    validFromDate?: string | null;
    /**
     * Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format
     * (HH:MM:SS). Partial seconds will be truncated.
     */
    validFromLocalTime?: string | null;
    /** Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD). */
    validUntilDate?: string | null;
    /**
     * Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format
     * (HH:MM:SS). Partial seconds will be truncated.
     */
    validUntilLocalTime?: string | null;
    /**
     * If an `exclude_products_id` was given, controls which subset of matched
     * products is excluded from any discounts.
     *
     * Default value: `LEAST_EXPENSIVE`
     * See [ExcludeStrategy](#type-excludestrategy) for possible values
     */
    excludeStrategy?: Square.ExcludeStrategy;
    /**
     * The minimum order subtotal (before discounts or taxes are applied)
     * that must be met before this rule may be applied.
     */
    minimumOrderSubtotalMoney?: Square.Money;
    /**
     * A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule.
     * Notice that a group ID is generated by the Customers API.
     * If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer
     * has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount
     * applies only to matched products sold to customers belonging to the specified customer groups.
     */
    customerGroupIdsAny?: string[] | null;
}