DrTeamRocks / uon

src/Endpoints/Requests.php

<?php

namespace Uon\Endpoints;

use Uon\Client;

/**
 * Class Requests
 *
 * @package Uon\Endpoint
 */
class Requests extends Client
{
    /**
     * Create new request
     *
     * @link https://api.u-on.ru/{key}/request/create.{_format}
     *
     * @param array $parameters List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function create(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request/create';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Adding touch to the request
     *
     * @link https://api.u-on.ru/{key}/request-action/create.{_format}
     *
     * @param array $parameters List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function createActions(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request-action/create';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Add file into request
     *
     * @link https://api.u-on.ru/{key}/request-file/create.{_format}
     *
     * @param array $parameters List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function createFile(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request-file/create';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Add tourist in request
     *
     * @link https://api.u-on.ru/{key}/tourists-requests/create.{_format}
     *
     * @param array $parameters List of parameters [r_id, tourist_id]
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function createTourist(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'tourists-requests/create';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Get requests data by filter
     *
     * @link https://api.u-on.ru/{key}/request/search.{_format}
     *
     * @param array $parameters List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function search(array $parameters = [])
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request/search';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Get request by ID
     *
     * @link https://api.u-on.ru/{key}/request/{id}.{_format}
     *
     * @param int   $id         Request unique ID
     * @param array $parameters List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function get(int $id, array $parameters = [])
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'request/' . $id;
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Get touch of the request by ID
     *
     * @link https://api.u-on.ru/{key}/request-action/create.{_format}
     *
     * @param int $id List of parameters
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getActions(int $id)
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'request-action/' . $id;

        return $this->done();
    }

    /**
     * Get requests data by client ID
     *
     * @link https://api.u-on.ru/{key}/request-by-client/create.{_format}
     *
     * @param int $id   List of parameters
     * @param int $page Number of page, 1 by default
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getByClient(int $id, int $page = 1)
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'request-by-client/' . $id . '/' . $page;

        return $this->done();
    }

    /**
     * Get requests by dates range (and by source ID)
     *
     * @link https://api.u-on.ru/{key}/request/{date_from}/{date_to}.{_format}
     * @link https://api.u-on.ru/{key}/request/{date_from}/{date_to}/{source_id}.{_format}
     *
     * @param string   $dateFrom Start of dates range
     * @param string   $dateTo   End of dates range
     * @param int      $page     Number of page, 1 by default
     * @param int|null $sourceId Source ID, eg ID of SMS or JivoSite
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getDate(string $dateFrom, string $dateTo, int $page = 1, int $sourceId = null)
    {
        $endpoint = 'requests/' . $dateFrom . '/' . $dateTo;
        if (null !== $sourceId) {
            $endpoint .= '/' . $sourceId;
        }
        $endpoint .= '/' . $page;

        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = $endpoint;

        return $this->done();
    }

    /**
     * Get touch of the requests in dates range
     *
     * @link https://api.u-on.ru/{key}/request/{date_from}/{date_to}.{_format}
     *
     * @param string $dateFrom Start of dates range
     * @param string $dateTo   End of dates range
     * @param int    $page     Number of page, 1 by default
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getDateActions(string $dateFrom, string $dateTo, int $page = 1)
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'request-action/' . $dateFrom . '/' . $dateTo . '/' . $page;

        return $this->done();
    }

    /**
     * Get updates requests by dates range
     *
     * @link https://api.u-on.ru/{key}/request/updated/{date_from}/{date_to}.{_format}
     *
     * @param string $dateFrom Start of dates range
     * @param string $dateTo   End of dates range
     * @param int    $page     Number of page, 1 by default
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getUpdated(string $dateFrom, string $dateTo, int $page = 1)
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'requests/updated/' . $dateFrom . '/' . $dateTo . '/' . $page;

        return $this->done();
    }

    /**
     * Get updates requests by dates range
     *
     * @link https://api.u-on.ru/{key}/requests/closed/{date_from}/{date_to}/{page}.{_format}
     *
     * @param string $dateFrom Start of dates range
     * @param string $dateTo   End of dates range
     * @param int    $page     Number of page, 1 by default
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getClosed(string $dateFrom, string $dateTo, int $page = 1)
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'requests/closed/' . $dateFrom . '/' . $dateTo . '/' . $page;

        return $this->done();
    }

    /**
     * Get all travel types or by some parameters, like id or name
     *
     * @link https://api.u-on.ru/{key}/travel-type.{_format}
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getTravelType()
    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'travel-type';

        return $this->done();
    }

    /**
     * Get filled document from request
     *
     * @link https://api.u-on.ru/{key}/request-document.{_format}
     *
     * @param array $parameters List of parameters [template_id, request_id etc.]
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function getDocument(array $parameters = [])

The parameter $parameters is not used and could be removed.

    {
        // Set HTTP params
        $this->type     = 'get';
        $this->endpoint = 'request-document';

        return $this->done();
    }

    /**
     * Create new travel type
     *
     * @link https://api.u-on.ru/{key}/travel-type/create.{_format}
     *
     * @param array $parameters List of parameters [name]
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function createTravelType(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'travel-type/create';
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Update request by request id
     *
     * @link https://api.u-on.ru/{key}/request/update/{id}.{_format}
     *
     * @param int   $id         Unique ID of request's
     * @param array $parameters List of parameters [r_cl_id]
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function update(int $id, array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request/update/' . $id;
        $this->params   = $parameters;

        return $this->done();
    }

    /**
     * Delete attached file from request
     *
     * @link https://api.u-on.ru/{key}/request-file/delete/{id}.{_format}
     *
     * @param int $id Unique ID of file
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function deleteFile(int $id)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'request/delete/' . $id;

        return $this->done();
    }

    /**
     * Add tourist in request
     *
     * @link https://api.u-on.ru/{key}/tourists-requests/delete.{_format}
     *
     * @param array $parameters List of parameters [r_id, tourist_id]
     *
     * @return null|object|\Uon\Interfaces\ClientInterface
     */
    public function deleteTourist(array $parameters)
    {
        // Set HTTP params
        $this->type     = 'post';
        $this->endpoint = 'tourists-requests/delete';
        $this->params   = $parameters;

        return $this->done();
    }
}