| 1 |
<?php |
| 2 |
|
| 3 |
// phpcs:disable Yoast.NamingConventions.NamespaceName.TooLong -- Needed in the folder structure. |
| 4 |
|
| 5 |
namespace Yoast\WP\SEO\AI\HTTP_Request\Infrastructure; |
| 6 |
|
| 7 |
use Exception; |
| 8 |
use Yoast\WP\SEO\AI\HTTP_Request\Domain\Exceptions\WP_Request_Exception; |
| 9 |
|
| 10 |
/** |
| 11 |
* Interface for the API client. |
| 12 |
*/ |
| 13 |
|
| 14 |
interface API_Client_Interface { |
| 15 |
|
| 16 |
/** |
| 17 |
* Performs a request to the API. |
| 18 |
* |
| 19 |
* @param string $action_path The action path for the request. |
| 20 |
* @param array<string> $body The body of the request. |
| 21 |
* @param array<string> $headers The headers for the request. |
| 22 |
* @param bool $is_post Whether the request is a POST request. |
| 23 |
* |
| 24 |
* @return array<int|string|array<string>> The response from the API. |
| 25 |
* |
| 26 |
* @throws WP_Request_Exception When the wp_remote_post() returns an error. |
| 27 |
*/ |
| 28 |
public function perform_request( string $action_path, $body, $headers, bool $is_post ): array; |
| 29 |
|
| 30 |
/** |
| 31 |
* Gets the timeout of the requests in seconds. |
| 32 |
* |
| 33 |
* @return int The timeout of the suggestion requests in seconds. |
| 34 |
*/ |
| 35 |
public function get_request_timeout(): int; |
| 36 |
} |
| 37 |
|
