LivePersonInc\LiveEngageLaravel\LiveEngageLaravel

Complexity

Total Complexity

35

Size/Duplication

Total Lines	596
Duplicated Lines	0 %

Test Coverage

Coverage

97.62%

Importance

Changes	13
Bugs	1	Features	1

24 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	getSkill()	0	7	1
A	skills()	0	7	1
A	retry()	0	5	1
A	limit()	0	5	1
A	engagementHistory()	0	19	3
A	getAgent()	0	7	1
A	domain()	0	7	1
A	conversationHistory()	0	19	3
A	version()	0	4	1
A	account()	0	5	1
A	agents()	0	36	1
A	chat()	0	14	1
A	__get()	0	3	1
A	updateAgent()	0	13	1
A	getConversation()	0	16	2
A	nonInteractive()	0	4	1
A	retrieveMsgHistory()	0	24	3
A	key()	0	6	1
A	visitor()	0	12	2
A	getAgentStatus()	0	15	2
A	active()	0	4	1
A	retrieveHistory()	0	24	2
A	status()	0	7	1

<?php
/**
 * Root class file for all api wrappers.
 *
 * @package LivePersonInc\LiveEngageLaravel
 *
 */
 
namespace LivePersonInc\LiveEngageLaravel;

use Carbon\Carbon;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Subscriber\Oauth\Oauth1;
use LivePersonInc\LiveEngageLaravel\Models\Info;
use LivePersonInc\LiveEngageLaravel\Models\MetaData;
use LivePersonInc\LiveEngageLaravel\Models\AccountStatus;
use LivePersonInc\LiveEngageLaravel\Models\MessagingInfo;
use LivePersonInc\LiveEngageLaravel\Models\Payload;
use LivePersonInc\LiveEngageLaravel\Models\Visitor;
use LivePersonInc\LiveEngageLaravel\Models\Agent;
use LivePersonInc\LiveEngageLaravel\Models\Skill;
use LivePersonInc\LiveEngageLaravel\Models\Campaign;
use LivePersonInc\LiveEngageLaravel\Models\Engagement;
use LivePersonInc\LiveEngageLaravel\Models\Conversation;
use LivePersonInc\LiveEngageLaravel\Models\Message;
use LivePersonInc\LiveEngageLaravel\Collections\EngagementHistory;
use LivePersonInc\LiveEngageLaravel\Collections\Skills;
use LivePersonInc\LiveEngageLaravel\Collections\AgentParticipants;
use LivePersonInc\LiveEngageLaravel\Exceptions\LiveEngageException;
use LivePersonInc\LiveEngageLaravel\Collections\ConversationHistory;

/**
 * LiveEngageLaravel class holds all of the root package functions.
 *
 * All "setting" functions will return `$this` so method can be chained. Most methods will return a class object or Laravel collection.
 */
class LiveEngageLaravel
{
	/**
	 * account - LiveEngage account number, usually set by configuration
	 * 
	 * (default value: false)
	 * 
	 * @var long

The type LivePersonInc\LiveEngageLaravel\long was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @access private
	 */
	private $account = false;
	/**
	 * skills - holds the skills for history retrieval
	 * 
	 * (default value: [])
	 * 
	 * @var array
	 * @access private
	 */
	private $skills = [];
	/**
	 * config - holds the configuration key where keyset is stored in config/services.php
	 * 
	 * (default value: 'services.liveperson.default')
	 * 
	 * @var string
	 * @access private
	 */
	private $config = 'services.liveperson.default';
	/**
	 * version - api version
	 * 
	 * (default value: '1.0')
	 * 
	 * @var string
	 * @access private
	 */
	private $version = '1.0';
	/**
	 * history_limit - stores the history page limit
	 * 
	 * (default value: 50)
	 * 
	 * @var int
	 * @access private
	 */
	private $history_limit = 50;
	private $interactive = true;
	private $ended = true;
	/**
	 * bearer - bearer token for V2 authentication
	 * 
	 * (default value: false)
	 * 
	 * @var string
	 * @access private
	 */
	private $bearer = false;
	/**
	 * revision
	 * 
	 * (default value: 0)
	 * 
	 * @var int
	 * @access private
	 */
	private $revision = 0;

	/**
	 * domain - api domain storage
	 * 
	 * (default value: false)
	 * 
	 * @var bool
	 * @access private
	 */
	private $domain = false;

	/**
	 * retry_limit - number of times the request will attempt before it throws the exception.
	 * 
	 * (default value: 5)
	 * 
	 * @var int
	 * @access private
	 */
	private $retry_limit = 5;
	/**
	 * retry_counter - stores current count of retries.
	 * 
	 * (default value: 0)
	 * 
	 * @var int
	 * @access private
	 */
	private $retry_counter = 0;
	
	private $request_version = 'V1';

	/**
	 * __get magic function to retrieve private properties of the class.
	 * 
	 * @access public
	 * @param mixed $attribute
	 * @return mixed
	 */
	public function __get($attribute)
	{
		return $this->$attribute;
	}
	
	private $request;

	/**
	 * __construct function.
	 * 
	 * @access public
	 * @return void
	 */
	public function __construct()
	{
		$this->account = config("{$this->config}.account");
		$this->version = config("{$this->config}.version") ?: $this->version;
		$this->request = new LiveEngageRequest($this->config);
	}

	/**
	 * key function sets the keyset the class should use. Setting this once will be stored for script execution, but not for the session.
	 * 
	 * @access public
	 * @param string $key (default: 'default')
	 * @return this
	 */
	public function key($key = 'default')
	{
		$this->config = "services.liveperson.$key";
		$this->__construct();

		return $this;
	}
	
	/**
	 * version function.
	 * 
	 * @access public
	 * @param string $version (default: 'V1')
	 * @return void
	 */
	public function version($version = 'V1') {
		$this->request_version = 'V2';
		
		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}
	
	/**
	 * nonInteractive function.
	 * 
	 * @access public
	 * @return void
	 */
	public function nonInteractive()
	{
		$this->interactive = false;
		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}
	
	/**
	 * active function.
	 * 
	 * @access public
	 * @return void
	 */
	public function active()
	{
		$this->ended = false;
		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}

	/**
	 * limit function.
	 * 
	 * @access public
	 * @param mixed $limit
	 * @return void
	 */
	public function limit($limit)
	{
		$this->history_limit = $limit;

		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}

	/**
	 * retry function.
	 * 
	 * @access public
	 * @param mixed $limit
	 * @return void
	 */
	public function retry($limit)
	{
		$this->retry_limit = $limit;

		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}

	/**
	 * account function.
	 * 
	 * @access public
	 * @param mixed $accountid
	 * @return void
	 */
	public function account($accountid)
	{
		$this->account = $accountid;

		return $this;

The expression return $this returns the type LivePersonInc\LiveEngageLaravel\LiveEngageLaravel which is incompatible with the documented return type void.

	}

	/**
	 * domain function sets the LivePerson domain for the secified service. Like `key` it is set for the execution script, but not session. It must be run each time.
	 * 
	 * @access public
	 * @param mixed $service
	 * @return this
	 */
	public function domain($service)
	{
		$response = $this->request->V1("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET');
		
		$this->domain = $response->baseURI;

		return $this;
	}

	/**
	 * visitor function gets or sets visitor attribute information - this only works for CHAT, not messaging.
	 * 
	 * @access public
	 * @param string $visitorID
	 * @param string $sessionID
	 * @param mixed $setData (default: false)
	 * @return mixed
	 * @codeCoverageIgnore
	 */
	public function visitor($visitorID, $sessionID, $setData = false)
	{
		$this->domain('smt');

		if ($setData) {
			$url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/events?v=1&sid={$sessionID}";

			return $this->request->V1($url, 'POST', $setData);
		} else {
			$url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}";

			return $this->request->V1($url, 'GET');
		}
	}
	
	/**
	 * chat function
	 *
     * @codeCoverageIgnore
     *
     * @todo connect this to the server chat api - this function currently does nothing.
     */
	public function chat()
	{
		$this->domain('conversationVep');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/chat/request?v=1&NC=true";
		
		$args = [
			
		];
		$payload = new Payload($args);
		
		$response = $this->request->V1($url, 'POST', $payload);

$payload of type LivePersonInc\LiveEngageLaravel\Models\Payload is incompatible with the type array expected by parameter $payload of LivePersonInc\LiveEngageLaravel\LiveEngageRequest::V1().

		
		return $response;
	}

	/**
	 * retrieveHistory function.
	 * 
	 * @access public
	 * @final
	 * @param Carbon $start
	 * @param Carbon $end
	 * @param string $url (default: false)
	 * @return mixed
	 */
	final public function retrieveHistory(Carbon $start, Carbon $end, $url = false)
	{
		$this->domain('engHistDomain');

		$url = $url ?: "https://{$this->domain}/interaction_history/api/account/{$this->account}/interactions/search?limit={$this->history_limit}&offset=0";

		$start_str = $start->toW3cString();
		$end_str = $end->toW3cString();

		$data = new Payload([
			'interactive' => $this->interactive,
			'ended' => $this->ended,
			'start' => [
				'from' => strtotime($start_str) . '000',
				'to' => strtotime($end_str) . '000',
			],
			'skillIds' => $this->skills
		]);

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

$data of type LivePersonInc\LiveEngageLaravel\Models\Payload is incompatible with the type array expected by parameter $payload of LivePersonInc\LiveEngageLaravel\LiveEngageRequest::V1().

		$result->records = $result->interactionHistoryRecords;
		$result->interactionHistoryRecords = null;
		
		return $result;
	}

	/**
	 * retrieveMsgHistory function.
	 * 
	 * @access public
	 * @final
	 * @param Carbon $start
	 * @param Carbon $end
	 * @param string $url (default: false)
	 * @return mixed
	 */
	final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false)
	{
		$this->domain('msgHist');
		$version = $this->request_version;

		$url = $url ?: "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/search?limit={$this->history_limit}&offset=0&sort=start:desc";

		$start_str = $start->toW3cString();
		$end_str = $end->toW3cString();

		$data = new Payload([
			'status' => $this->ended ? ['CLOSE'] : ['OPEN', 'CLOSE'],
			'start' => [
				'from' => strtotime($start_str) . '000',
				'to' => strtotime($end_str) . '000',
			],
			'skillIds' => $this->skills
		]);
		
		$result = $this->request->$version($url, 'POST', $data);
		$result->records = $result->conversationHistoryRecords;
		$result->conversationHistoryRecords = null;
		
		return $result;
	}
	
	/**
	 * skills function gets collection of skills associated with the account.
	 * 
	 * @access public
	 * @return Collections\Skills
	 */
	public function skills()
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/skills?v=4.0";
		
		return new Skills($this->request->V2($url, 'GET'));
	}
	
	/**
	 * getSkill function gets skill object based on ID.
	 * 
	 * @access public
	 * @param int $skillId
	 * @return Models\Skill
	 */
	public function getSkill($skillId)
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/skills/{$skillId}?v=4.0";
		
		return new Skill((array) $this->request->V2($url, 'GET'));
	}
	
	/**
	 * getAgent function gets agent object based on ID.
	 * 
	 * @access public
	 * @param int $userId
	 * @return Models\Agent
	 */
	public function getAgent($userId)
	{
		$this->domain('accountConfigReadOnly');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users/{$userId}?v=4.0";
		
		return new Agent((array) $this->request->V2($url, 'GET'));
	}
	
	/**
	 * updateAgent function.
	 * 
	 * @access public
	 * @param mixed $userId
	 * @param mixed $properties
	 * @return void
	 * @codeCoverageIgnore
	 */
	public function updateAgent($userId, $properties)
	{
		$agent = $this->getAgent($userId);

The assignment to $agent is dead and can be removed.

		
		$this->domain('accountConfigReadWrite');
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users/{$userId}?v=4.0";
		$headers = [
			'X-HTTP-Method-Override' => 'PUT',
			'if-Match' => '*'
		];
		
		return new Agent((array) $this->request->V2($url, 'PUT', $properties, $headers));

The expression return new LivePersonInc\LiveEngageLaravel\Models\Agent((array)$this->request->V2($url, 'PUT', $properties, $headers)) returns the type LivePersonInc\LiveEngageLaravel\Models\Agent which is incompatible with the documented return type void.

	}
	
	/**
	 * agents function gets collection of agents from account.
	 * 
	 * @access public
	 * @return Collections\AgentParticipants
	 */
	public function agents()
	{
		$this->domain('accountConfigReadOnly');
		
		$select = implode(',', [
			'id',
			'pid',
			'deleted',
			'loginName',
			'skills',
			'nickname',
			'dateCreated',
			'userTypeId',
			'isApiUser',
			'profileIds',
			'permissionGroups',
			'allowedAppKeys',
			'changePwdNextLogin',
			'maxChats',
			'skillIds',
			'lpaCreatedUser',
			'email',
			'lobs',
			'profiles',
			'fullName',
			'employeeId',
			'managedAgentGroups',
			'dateUpdated',
			'isEnabled',
			'lastPwdChangeDate',
			'pictureUrl'
		]);
		
		$url = "https://{$this->domain}/api/account/{$this->account}/configuration/le-users/users?v=4.0&select=$select";
		
		return new AgentParticipants($this->request->V2($url, 'GET'));
	}
	
	/**
	 * getAgentStatus function gets status of agents based on provided Skill IDs.
	 * 
	 * @access public
	 * @param int/array $skills

The doc comment int/array at position 0 could not be parsed: Unknown type name 'int/array' at position 0 in int/array.

	 * @return Collections\AgentParticipants
	 */
	public function getAgentStatus($skills)
	{
		$skills = is_array($skills) ? $skills : [$skills];
	
		$this->domain('msgHist');
		
		$url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status";
		
		$data = ['skillIds' => $skills];
		
		$response = $this->request->V1($url, 'POST', $data);
		$collection = new AgentParticipants($response->agentStatusRecords);
		$collection->metaData = new MetaData((array) $response->_metadata);
		
		return $collection;
		
	}
	
	/**
	 * conversationHistory function.
	 * 
	 * @access public
	 * @param Carbon $start (default: null)
	 * @param Carbon $end (default: null)
	 * @param int/array $skills (default: [])

The doc comment int/array at position 0 could not be parsed: Unknown type name 'int/array' at position 0 in int/array.

	 * @return Collections\ConversationHistory
	 */
	public function conversationHistory(Carbon $start = null, Carbon $end = null, $skills = [])
	{
		$this->retry_counter = 0;
		$this->skills = $skills;

		$start = $start ?: (new Carbon())->today();
		$end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);

		$results_object = $this->retrieveMsgHistory($start, $end);
		
		$results_object->_metadata->start = $start;
		$results_object->_metadata->end = $end;
	
		$meta = new MetaData((array) $results_object->_metadata);
		
		$collection = new ConversationHistory($results_object->records);
		$collection->metaData = $meta;
		
		return $collection;
			
	}
	
	/**
	 * getConversation function.
	 * 
	 * @access public
	 * @param mixed $conversationId
	 * @return Models\Conversation
	 */
	public function getConversation($conversationId)
	{
		$this->domain('msgHist');
		
		$url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/conversation/search";
		
		$data = new Payload([
			'conversationId' => $conversationId
		]);
		
		$result = $this->request->V1($url, 'POST', $data);

$data of type LivePersonInc\LiveEngageLaravel\Models\Payload is incompatible with the type array expected by parameter $payload of LivePersonInc\LiveEngageLaravel\LiveEngageRequest::V1().

		if (!count($result->conversationHistoryRecords)) {
			return null; // @codeCoverageIgnore
		}
		
		return new Conversation((array) $result->conversationHistoryRecords[0]);
	}

	/**
	 * engagementHistory function.
	 * 
	 * @access public
	 * @param Carbon $start (default: null)
	 * @param Carbon $end (default: null)
	 * @param int/array $skills (default: [])

The doc comment int/array at position 0 could not be parsed: Unknown type name 'int/array' at position 0 in int/array.

	 * @return Collections\EngagementHistory
	 */
	public function engagementHistory(Carbon $start = null, Carbon $end = null, $skills = [])
	{
		$this->retry_counter = 0;
		$this->skills = $skills;

		$start = $start ?: (new Carbon())->today();
		$end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);

		$results_object = $this->retrieveHistory($start, $end);
		
		$results_object->_metadata->start = $start;
		$results_object->_metadata->end = $end;
	
		$meta = new MetaData((array) $results_object->_metadata);
		
		$collection = new EngagementHistory($results_object->records);
		$collection->metaData = $meta;
		
		return $collection;
			
	}
	
	/**
	 * status function gets status of the account.
	 * 
	 * @access public
	 * @return Models\AccountStatus
	 */
	public function status()
	{
		$url = "https://status.liveperson.com/json?site={$this->account}";
		
		$response = $this->request->V1($url, 'GET');
		
		return new AccountStatus((array) $response);
	}
}