<?php
/**
 * Read-side transport contract.
 *
 * @package AdPix\Analytics
 */

declare( strict_types = 1 );

namespace AdPix\Analytics\Contracts;

use AdPix\Analytics\Http\Response;

defined( 'ABSPATH' ) || exit;

/**
 * Reads back from the AdPix API.
 *
 * Separate from TransportInterface because the two have genuinely different callers and different
 * risks. Sending is queued, retried and must never block a customer; reading happens on an admin
 * screen, in front of somebody waiting for it, and must never be retried in the background. Nothing
 * that sends events needs this method, so nothing that sends events is made to depend on it.
 */
interface ReadTransportInterface {

	/**
	 * GET a resource from /api/v1/s2s/{endpoint}.
	 *
	 * @param string                $endpoint Endpoint suffix, e.g. `attribution`.
	 * @param array<string,scalar>  $query    Query parameters.
	 * @return Response
	 */
	public function fetch( string $endpoint, array $query = array() ): Response;
}