<?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;

interface DiscountCouponCodeApiInterface
{
    /**
     * Generates a discount coupon based on the provided rule.
     *
     * @param  int $ruleId ID of the rule based on which the coupon is generated.
     * @return string The generated coupon code.
     */
    public function generateCouponCode(int $ruleId): string;
}