<?php

/**
 * Copyright 2024-2025 Simply.IN Sp. z o.o.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the EUPL-1.2 or later.
 * You may not use this work except in compliance with the Licence.
 *
 * Copy of the Licence is available at:
 * https://joinup.ec.europa.eu/software/page/eupl
 * It is bundled with this package in the file LICENSE.txt
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Licence is distributed on an as is basis,
 * without warranties or conditions of any kind, either express or implied.
 * Check the Licence for the specific language governing permissions
 * and limitations under the License.
 *
 * @author   Simply.IN Sp. z o.o.
 * @copyright 2024-2025 Simply.IN Sp. z o.o.
 * @license   https://joinup.ec.europa.eu/software/page/eupl
 */

declare(strict_types=1);

namespace SimplyIn\Session;

if (!defined('_PS_VERSION_')) {
    exit;
}

interface SimplyInSessionInterface
{
    public function get(string $key, mixed $default = null): mixed;

    public function set(string $key, mixed $value): void;

    /**
     * @param array<int, string>|string $key single key or list of keys to unset
     */
    public function unset(array|string $key): void;

    /**
     * Ends everything, the shopper's Simply.IN authorization included - what logging out means.
     * To finish a checkout use {@see clearCheckout()} instead.
     */
    public function clear(): void;

    /**
     * Ends the CHECKOUT and keeps the authorization: drops the single-use credentials an attempt
     * consumed (a BLIK code, a one-time card token), the method selection and the addresses, while
     * preserving the auth token and e-mail that identify the shopper to Simply.IN. Anything shown
     * after the order is placed - the pay-again surface above all - needs that token to still be
     * there, or the backend answers with the anonymous methods only.
     */
    public function clearCheckout(): void;
}
