<?php
/**
 * @author Amasty Team
 * @copyright Copyright (c) Amasty (https://www.amasty.com)
 * @package Free Gift Base for Magento 2
 */

namespace Amasty\Promo\Api\Data;

use Magento\Framework\Api\ExtensibleDataInterface;

interface GiftRuleInterface extends ExtensibleDataInterface
{
    public const RULE_NAME = 'ampromo_rule';
    public const EXTENSION_CODE = self::RULE_NAME;

    /**#@+
     * Sales Rule Simple Action values
     */
    public const SAME_PRODUCT = 'ampromo_product'; //Auto add the same product
    public const PER_PRODUCT = 'ampromo_items'; //Auto add promo items with products
    public const WHOLE_CART = 'ampromo_cart'; //Auto add promo items for the whole cart
    public const SPENT = 'ampromo_spent'; //Auto add promo items for every $X spent
    public const EACHN = 'ampromo_eachn'; //Add gift with each N-th product in the cart
    /**#@-*/

    /**#@+
     * Constants defined for keys of data array
     */
    public const ENTITY_ID = 'entity_id';
    public const SALESRULE_ID = 'salesrule_id';
    public const SKU = 'sku';
    public const TYPE = 'type';
    public const TOP_BANNER_SHOW_GIFT_IMAGES = 'top_banner_show_gift_images';
    public const TOP_BANNER_SHOW_GIFT_NAME = 'top_banner_show_gift_name';
    public const AFTER_PRODUCT_BANNER_SHOW_GIFT_IMAGES = 'after_product_banner_show_gift_images';
    public const AFTER_PRODUCT_BANNER_SHOW_GIFT_NAME = 'after_product_banner_show_gift_name';
    public const ITEMS_DISCOUNT = 'items_discount';
    public const MINIMAL_ITEMS_PRICE = 'minimal_items_price';
    public const APPLY_TAX = 'apply_tax';
    public const APPLY_SHIPPING = 'apply_shipping';
    /**#@-*/

    /**
     * @return string
     */
    public function getSku();

    /**
     * @param string $sku
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setSku($sku);

    /**
     * @return int
     */
    public function getType();

    /**
     * @param int $type
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setType($type);

    /**
     * @return int
     */
    public function getAfterProductBannerShowGiftImages();

    /**
     * @param int $afterProductBannerShowGiftImages
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setAfterProductBannerShowGiftImages($afterProductBannerShowGiftImages);

    /**
     * @return bool
     */
    public function getAfterProductBannerShowGiftName(): bool;

    /**
     * @param bool $afterProductBannerShowGiftName
     * @return void
     */
    public function setAfterProductBannerShowGiftName(bool $afterProductBannerShowGiftName): void;

    /**
     * @return int
     */
    public function getTopBannerShowGiftImages();

    /**
     * @param int $topBannerShowGiftImages
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setTopBannerShowGiftImages($topBannerShowGiftImages);

    /**
     * @return bool
     */
    public function getTopBannerShowGiftName(): bool;

    /**
     * @param bool $topBannerShowGiftName
     * @return void
     */
    public function setTopBannerShowGiftName(bool $topBannerShowGiftName): void;

    /**
     * @return string|null
     */
    public function getItemsDiscount();

    /**
     * @param string|null $itemsDiscount
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setItemsDiscount($itemsDiscount);

    /**
     * @return float|null
     */
    public function getMinimalItemsPrice();

    /**
     * @param float|null $minimalItemsPrice
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setMinimalItemsPrice($minimalItemsPrice);

    /**
     * @return int
     */
    public function getApplyTax();

    /**
     * @param int $applyTax
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setApplyTax($applyTax);

    /**
     * @return int
     */
    public function getApplyShipping();

    /**
     * @param int $applyShipping
     *
     * @return \Amasty\Promo\Api\Data\GiftRuleInterface
     */
    public function setApplyShipping($applyShipping);
}