<?php
/**
 * Notification log persistence port.
 *
 * @package Bookline
 */

declare( strict_types=1 );

namespace Bookline\Domain\Notification;

/**
 * Delivery log repository.
 *
 * @since 0.1.0
 */
interface NotificationLogRepository {

	/**
	 * Find by id.
	 *
	 * @param int $id Id.
	 *
	 * @since 0.1.0
	 */
	public function find_by_id( int $id ): ?NotificationLogEntry;

	/**
	 * Find by idempotency key.
	 *
	 * @param string $key Key.
	 *
	 * @since 0.1.0
	 */
	public function find_by_idempotency_key( string $key ): ?NotificationLogEntry;

	/**
	 * Persist.
	 *
	 * @param NotificationLogEntry $entry Entry.
	 *
	 * @since 0.1.0
	 */
	public function save( NotificationLogEntry $entry ): void;

	/**
	 * Cancel queued/drafted rows for a booking.
	 *
	 * @param int $booking_id Booking id.
	 *
	 * @return list<NotificationLogEntry> Cancelled rows.
	 *
	 * @since 0.1.0
	 */
	public function cancel_pending_for_booking( int $booking_id ): array;

	/**
	 * Pending entries for a booking.
	 *
	 * @param int $booking_id Booking id.
	 *
	 * @return list<NotificationLogEntry>
	 *
	 * @since 0.1.0
	 */
	public function pending_for_booking( int $booking_id ): array;

	/**
	 * Count by status.
	 *
	 * @param NotificationStatus $status Status.
	 *
	 * @since 0.1.0
	 */
	public function count_by_status( NotificationStatus $status ): int;

	/**
	 * Admin list with filters.
	 *
	 * @param array<string, mixed> $filters  status, channel, booking_id, search.
	 * @param int                  $page     Page.
	 * @param int                  $per_page Per page.
	 * @return array{items: list<NotificationLogEntry>, total: int}
	 *
	 * @since 0.1.0
	 */
	public function list_for_admin( array $filters, int $page, int $per_page ): array;
}