jamseyp / live-person

src/Engage.php

<?php
/**
 * Created by PhpStorm.
 * User: james
 * Date: 12/07/2018
 * Time: 14:30
 */

namespace CwsOps\LivePerson;

use CwsOps\LivePerson\Account\Config;
use CwsOps\LivePerson\Rest\Request;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * Class Engage
 */
class Engage
{
    const API_VERSION = 1;

    const ENGAGEMENT_HISTORY_SERVICE = 'engHistDomain';
    const MESSAGE_HISTORY_SERVICE = 'msgHist';
    const VISITOR_SERVICE = 'smt';
    const OPERATIONAL_REAL_TIME_SERVICE = 'leDataReporting';

    private $accountConfig;
    private $skills = [];
    private $historyLimit;
    private $request;
    private $logger;
    private $ended = false;


    /**
     * Engage constructor.
     *
     * @param Config $accountConfig
     * @param int $retryLimit
     * @param LoggerInterface|null $logger
     */
    public function __construct(Config $accountConfig, int $retryLimit = 3, LoggerInterface $logger = null)
    {
        $this->accountConfig = $accountConfig;
        $this->request = new Request($accountConfig, $retryLimit, $logger);
        $this->historyLimit = 50;
        $this->logger = $logger ?: new NullLogger();
    }

    /**
     * Gets or sets visitor attribute information.
     *
     * @param string $visitorId the unique visitor id.
     * @param string $sessionId the current session id.
     * @param bool $setData true or false if the information should be set.
     *
     * @return array|\stdClass
     *
     * @throws Rest\BuilderLockedException
     * @throws Rest\URLNotBuiltException
     */
    public function visitor(string $visitorId, string $sessionId, bool $setData = false)
    {
        $url = $this->request->buildUrl(self::VISITOR_SERVICE)
            ->setAccount($this->accountConfig->getAccountId())
            ->setAction('monitoring/visitors')
            ->addActionContext($visitorId . '/visits/current/events')
            ->hasQueryParam(true)
            ->addQueryParam('sid', $sessionId)
            ->setVersion(1)
            ->build()
            ->getUrl();


        return false === $setData ? $this->request->v1($url, Request::METHOD_GET)
            : $this->request->v1($url, Request::METHOD_POST, $setData);

$setData of type true is incompatible with the type null|array expected by parameter $payload of CwsOps\LivePerson\Rest\Request::v1().

    }

    /**
     * Retrieves the message history.
     *
     * @param \DateTime $start
     * @param \DateTime $end
     *
     * @return array|\stdClass
     *
     * @throws Rest\BuilderLockedException
     * @throws Rest\URLNotBuiltException
     */
    public function retrieveMessageHistory(\DateTime $start, \DateTime $end)
    {
        $url = $this->request->buildUrl(self::MESSAGE_HISTORY_SERVICE)
            ->setService('messaging_history')
            ->setAccount($this->accountConfig->getAccountId())
            ->setAction('conversations/search')
            ->build()
            ->getUrl();

        $data = [
            'status' => $this->ended ? ['CLOSE'] : ['OPEN', 'CLOSE'],
            'start' => [
                'from' => $this->dateTimeToMilliseconds($start),
                'to' => $this->dateTimeToMilliseconds($end),
            ],
            'skillIds' => $this->skills
        ];

        $result = $this->request->V1($url, 'POST', $data);
        $result->records = $result->conversationHistoryRecords;
        $result->conversationHistoryRecords = null;

        return $result;
    }

    /**
     * Gets status of agents based on provided Skill IDs.
     *
     * @param array $skills
     *
     * @return array|\stdClass
     * @throws Rest\BuilderLockedException
     */
    public function getAgentStatus(array $skills)
    {
        $url = $this->request->buildUrl(self::MESSAGE_HISTORY_SERVICE)
            ->setService('messaging_history')
            ->setAccount($this->accountConfig->getAccountId())
            ->setAction('/agent-view/status');
        $data = ['skillsIds' => $skills];

        $response = $this->request->v1($url, Request::METHOD_GET, $data);

$url of type CwsOps\LivePerson\Rest\UrlBuilder is incompatible with the type string expected by parameter $url of CwsOps\LivePerson\Rest\Request::v1().

        return $response;
    }

    /**
     * Gets a agent or a collection of agents.
     *
     * @param int $agentId the agent id, if left to null, then will return all agents.
     *
     * @return \stdClass
     *
     * @throws Rest\BuilderLockedException
     * @throws Rest\URLNotBuiltException
     */
    public function getAgents(int $agentId = null)
    {
        $action = 'configuration/le-users/users';

        if (null === $agentId) {
            $action .= '/' . $agentId;
        }

        $url = $this->request->buildUrl('')
            ->setAccount($this->accountConfig->getAccountId())
            ->setAction($action)
            ->setVersion(4)
            ->build()
            ->getUrl();

        $response = $this->request->v2($url, Request::METHOD_GET);

        $data = json_decode($response);;

$response of type stdClass is incompatible with the type string expected by parameter $json of json_decode().

        return $data;
    }

    /**
     * Gets the current status of the API.
     *
     * @return array|\stdClass
     */
    public function status()
    {
        $url = "https://status.liveperson.com/json?site={$this->accountConfig->getAccountId()}";

        $response = $this->request->v1($url, Request::METHOD_GET);

        return $response;
    }

    /**
     * Converts a datetime obj into a int represents milliseconds since the epoc.
     *
     * @param \DateTime $dateTime
     *
     * @return int
     */
    private function dateTimeToMilliseconds(\DateTime $dateTime)
    {
        return strtotime($dateTime->format('Y-m-d H:i:sP'));
    }
}