<?php

declare(strict_types=1);

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Meta\Sales\Api;

use Magento\SalesRule\Api\Data\RuleInterface;

/**
 * AddCartCouponApi response
 */
interface AddCartCouponApiResponseInterface
{
    /**
     * Get status of trying to add coupon to Magento cart
     *
     * @SuppressWarnings(PHPMD.BooleanGetMethodName)
     * @return                                       bool
     */
    public function getStatus(): bool;

    /**
     * Get rule of coupon trying to be added to Magento cart
     *
     * @return \Magento\SalesRule\Api\Data\RuleInterface|null
     */
    public function getRule(): ?RuleInterface;
}