traderinteractive / tol-api-php

src/ClientInterface.php

<?php
namespace TraderInteractive\Api;

/**
 * Client for apis
 */
interface ClientInterface
{
    /**
     * Get access token and refresh token
     *
     * @return array two string values, access token and refresh token
     */
    public function getTokens() : array;

    /**
     * Search the API resource using the specified $filters
     *
     * @param string $resource
     * @param array $filters
     *
     * @return string opaque handle to be given to endIndex()
     */
    public function startIndex(string $resource, array $filters = []) : string;

    /**
     * @see startIndex()
     */
    public function index(string $resource, array $filters = []) : Response;

    /**
     * Get the details of an API resource based on $id
     *
     * @param string $resource
     * @param string $id
     * @param array  $parameters
     *
     * @return string opaque handle to be given to endGet()
     */
    public function startGet(string $resource, string $id, array $parameters = []) : string;

    /**
     * @see startGet()
     */
    public function get(string $resource, string $id, array $parameters = []) : Response;

    /**
     * Create a new instance of an API resource using the provided $data
     *
     * @param string $resource
     * @param array $data
     *
     * @return string opaque handle to be given to endPost()
     */
    public function startPost(string $resource, array $data) : string;

    /**
     * @see startPost()
     */
    public function post(string $resource, array $data) : Response;

    /**
     * Update an existing instance of an API resource specified by $id with the provided $data
     *
     * @param string $resource
     * @param string $id
     * @param array $data
     *
     * @return string opaque handle to be given to endPut()
     */
    public function startPut(string $resource, string $id, array $data) : string;

    /**
     * @see startPut()
     */
    public function put(string $resource, string $id, array $data) : Response;

    /**
     * Delete an existing instance of an API resource specified by $id
     *
     * @param string $resource
     * @param string $id
     * @param array $data
     *
     * @return string opaque handle to be given to endDelete()
     */
    public function startDelete(string $resource, string $id = null, array $data = null) : string;

    /**
     * @see startDelete()
     */
    public function delete(string $resource, string $id = null, array $data = null) : Response;

    /**
     * Performs a request to the given URI and returns the response.
     *
     * @param string $method The HTTP method of the request to send.
     * @param string $uri    A relative api URI to which the POST request will be made.
     * @param array  $data   Array of data to be sent as the POST body.
     *
     * @return Response
     */
    public function send(string $method, string $uri, array $data = null) : Response;

    /**
     * Starts a request to the given URI.
     *
     * @param string $method The HTTP method of the request to send.
     * @param string $uri    A relative api URI to which the POST request will be made.
     * @param array  $data   Array of data to be sent as the POST body.
     *
     * @return string opaque handle to be given to endDelete()
     */
    public function startSend(string $method, string $uri, array $data = null) : string;

    /**
     * Get response of start*() method
     *
     * @param string $handle opaque handle from start*()
     *
     * @return Response
     */
    public function end(string $handle) : Response;

    /**
     * Set the default headers
     *
     * @param array The default headers

The type TraderInteractive\Api\The was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return void
     */
    public function setDefaultHeaders(array $defaultHeaders);
}