<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace KTXF\Mail\Service;

/**
 * Mail Service API Key Identity Interface
 * 
 * API key authentication for transactional mail services (SendGrid, Mailgun, etc.)
 * 
 * @since 2025.05.01
 */
interface IServiceIdentityApiKey extends IServiceIdentity {

    /**
     * Gets the API key
     * 
     * @since 2025.05.01
     * 
     * @return string
     */
    public function getApiKey(): string;

    /**
     * Gets the optional API key identifier/name
     * 
     * @since 2025.05.01
     * 
     * @return string|null
     */
    public function getApiKeyId(): ?string;

}