<?php
/**
 * Transaction intent repository port.
 *
 * @package Bookline
 */

declare( strict_types=1 );

namespace Bookline\Domain\OrderIntent;

use Bookline\Domain\Shared\Uuid;

/**
 * Persistence port for transaction intents.
 *
 * @since 0.1.0
 */
interface TransactionIntentRepository {

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

	/**
	 * Find by UUID.
	 *
	 * @param Uuid $uuid Public id.
	 *
	 * @since 0.1.0
	 */
	public function find_by_uuid( Uuid $uuid ): ?TransactionIntent;

	/**
	 * All intents for an order intent.
	 *
	 * @param int $order_intent_id Parent intent id.
	 * @return list<TransactionIntent>
	 *
	 * @since 0.1.0
	 */
	public function find_by_order_intent_id( int $order_intent_id ): array;

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

	/**
	 * Find by gateway intent id.
	 *
	 * @param string $gateway           Gateway key.
	 * @param string $gateway_intent_id Provider id.
	 *
	 * @since 0.1.0
	 */
	public function find_by_gateway_intent_id( string $gateway, string $gateway_intent_id ): ?TransactionIntent;

	/**
	 * Persist the entity.
	 *
	 * @param TransactionIntent $intent Entity.
	 *
	 * @since 0.1.0
	 */
	public function save( TransactionIntent $intent ): void;

	/**
	 * Delete all transaction intents for an order intent.
	 *
	 * @param int $order_intent_id Parent intent id.
	 *
	 * @since 0.1.0
	 */
	public function delete_for_order_intent( int $order_intent_id ): void;
}