response.php

<?php


namespace Simonetti\MsMobile\SDK\Client;

use GuzzleHttp\Message\Response;

/**
 * Resposta do client
 * Interface ResponseInterface
 * @package Simonetti\MsMobile\SDK\Client
 */
interface ResponseInterface
{
    /**
     * Reposta original retornada pelo Guzzle
     * @param Response $response
     */
    public function __construct(Response $response);

    /**
     * Retorna se a requisição foi executada com sucesso.
     * @return bool
     */
    public function isSuccessful();

    /**
     * Retorna a mensagem retornada pela requisição.
     * @return string
     */
    public function getMessage();

    /**
     * Retorna os dados retornados.
     * @return array|null
     */
    public function getData();

    /**
     * Retorna o código da requisição HTTP.
     * @link http://pt.wikipedia.org/wiki/Anexo:Lista_de_c%C3%B3digos_de_status_HTTP
     * @return int
     */
    public function getHttpCode();

    /**
     * Transforma a resposta em string.
     * @return string
     */
    public function __toString();
}