LivePersonInc / LiveEngageLaravel

src/LiveEngageLaravel.php

Indentation +343 added lines, -343 removed lines

@@ -20,397 +20,397 @@
 
 class LiveEngageLaravel
 {
-    private $account = false;
-    private $results = [];
-    private $skills = [];
-    private $next = false;
-    private $prev = false;
-    private $start;
-    private $end;
-    private $config = 'services.liveperson.default';
-    private $version = '1.0';
-    private $history_limit = 50;
-    private $history = false;
-    private $context = 'interactionHistoryRecords';
-    private $interactive = true;
-    private $ended = true;
-    private $bearer = false;
-
-    private $domain = false;
-
-    private $retry_limit = 5;
-    private $retry_counter = 0;
-
-    public function __get($attribute)
-    {
-        return $this->$attribute;
-    }
-
-    public function __set($attribute, $value)
-    {
-        return $this->$attribute = $value;
-    }
-
-    public function __construct()
-    {
-        $this->account = config("{$this->config}.account");
-        //$this->domain = config("{$this->config}.domain");
-        $this->version = config("{$this->config}.version") ?: $this->version;
-    }
-
-    public function key($key = 'default')
-    {
-        $this->config = "services.liveperson.$key";
-
-        return $this;
-    }
+	private $account = false;
+	private $results = [];
+	private $skills = [];
+	private $next = false;
+	private $prev = false;
+	private $start;
+	private $end;
+	private $config = 'services.liveperson.default';
+	private $version = '1.0';
+	private $history_limit = 50;
+	private $history = false;
+	private $context = 'interactionHistoryRecords';
+	private $interactive = true;
+	private $ended = true;
+	private $bearer = false;
+
+	private $domain = false;
+
+	private $retry_limit = 5;
+	private $retry_counter = 0;
+
+	public function __get($attribute)
+	{
+		return $this->$attribute;
+	}
+
+	public function __set($attribute, $value)
+	{
+		return $this->$attribute = $value;
+	}
+
+	public function __construct()
+	{
+		$this->account = config("{$this->config}.account");
+		//$this->domain = config("{$this->config}.domain");
+		$this->version = config("{$this->config}.version") ?: $this->version;
+	}
+
+	public function key($key = 'default')
+	{
+		$this->config = "services.liveperson.$key";
+
+		return $this;
+	}
     
-    public function nonInteractive()
-    {
-	    $this->interactive = false;
-	    return $this;
-    }
+	public function nonInteractive()
+	{
+		$this->interactive = false;
+		return $this;
+	}
     
-    public function active()
-    {
-	    $this->ended = false;
-	    return $this;
-    }
-
-    public function limit($limit)
-    {
-        $this->history_limit = $limit;
-
-        return $this;
-    }
-
-    public function skills($skills)
-    {
-        $this->skills = $skills;
-
-        return $this;
-    }
-
-    public function retry($limit)
-    {
-        $this->retry_limit = $limit;
-
-        return $this;
-    }
-
-    public function get()
-    {
-        return $this->results;
-    }
-
-    public function account($accountid)
-    {
-        $this->account = $accountid;
-
-        return $this;
-    }
-
-    public function domain($service)
-    {
-        $response = $this->requestV1("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET');
-        if (is_a($response, 'Exception')) {
-            throw new \Exception('Unable to get LivePerson account domain', 101);
-        } else {
-            $this->domain = $response->baseURI;
-
-            return $this;
-        }
-    }
-
-    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->requestV1($url, 'POST', $setData);
-        } else {
-            $url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}";
-
-            return $this->requestV1($url, 'GET');
-        }
-    }
-
-    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 = [
-            'interactive' => $this->interactive,
-            'ended' => $this->ended,
-            'start' => [
-                'from' => strtotime($start_str).'000',
-                'to' => strtotime($end_str).'000',
-            ],
-        ];
-        if (count($this->skills)) {
-            $data['skillIds'] = $this->skills;
-        }
-
-        $data = new Payload($data);
-
-        return $this->requestV1($url, 'POST', $data);
-    }
-
-    final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false)
-    {
-        $this->domain('msgHist');
-
-        $url = $url ?: "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/search?limit={$this->history_limit}&offset=0";
-
-        $start_str = $start->toW3cString();
-        $end_str = $end->toW3cString();
-
-        $data = [
-            'interactive' => $this->interactive,
-            'ended' => $this->ended,
-            'start' => [
-                'from' => strtotime($start_str).'000',
-                'to' => strtotime($end_str).'000',
-            ],
-        ];
-        if (count($this->skills)) {
-            $data['skillIds'] = $this->skills;
-        }
-
-        $data = new Payload($data);
-
-        return $this->requestV1($url, 'POST', $data);
-    }
+	public function active()
+	{
+		$this->ended = false;
+		return $this;
+	}
+
+	public function limit($limit)
+	{
+		$this->history_limit = $limit;
+
+		return $this;
+	}
+
+	public function skills($skills)
+	{
+		$this->skills = $skills;
+
+		return $this;
+	}
+
+	public function retry($limit)
+	{
+		$this->retry_limit = $limit;
+
+		return $this;
+	}
+
+	public function get()
+	{
+		return $this->results;
+	}
+
+	public function account($accountid)
+	{
+		$this->account = $accountid;
+
+		return $this;
+	}
+
+	public function domain($service)
+	{
+		$response = $this->requestV1("https://api.liveperson.net/api/account/{$this->account}/service/{$service}/baseURI.json?version={$this->version}", 'GET');
+		if (is_a($response, 'Exception')) {
+			throw new \Exception('Unable to get LivePerson account domain', 101);
+		} else {
+			$this->domain = $response->baseURI;
+
+			return $this;
+		}
+	}
+
+	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->requestV1($url, 'POST', $setData);
+		} else {
+			$url = "https://{$this->domain}/api/account/{$this->account}/monitoring/visitors/{$visitorID}/visits/current/state?v=1&sid={$sessionID}";
+
+			return $this->requestV1($url, 'GET');
+		}
+	}
+
+	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 = [
+			'interactive' => $this->interactive,
+			'ended' => $this->ended,
+			'start' => [
+				'from' => strtotime($start_str).'000',
+				'to' => strtotime($end_str).'000',
+			],
+		];
+		if (count($this->skills)) {
+			$data['skillIds'] = $this->skills;
+		}
+
+		$data = new Payload($data);
+
+		return $this->requestV1($url, 'POST', $data);
+	}
+
+	final public function retrieveMsgHistory(Carbon $start, Carbon $end, $url = false)
+	{
+		$this->domain('msgHist');
+
+		$url = $url ?: "https://{$this->domain}/messaging_history/api/account/{$this->account}/conversations/search?limit={$this->history_limit}&offset=0";
+
+		$start_str = $start->toW3cString();
+		$end_str = $end->toW3cString();
+
+		$data = [
+			'interactive' => $this->interactive,
+			'ended' => $this->ended,
+			'start' => [
+				'from' => strtotime($start_str).'000',
+				'to' => strtotime($end_str).'000',
+			],
+		];
+		if (count($this->skills)) {
+			$data['skillIds'] = $this->skills;
+		}
+
+		$data = new Payload($data);
+
+		return $this->requestV1($url, 'POST', $data);
+	}
     
-    public function getAgentStatus(array $skills)
-    {
+	public function getAgentStatus(array $skills)
+	{
 	
-	    $this->domain('msgHist');
+		$this->domain('msgHist');
         
-        $url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status";
+		$url = "https://{$this->domain}/messaging_history/api/account/{$this->account}/agent-view/status";
         
-        $data['skillIds'] = $skills;
+		$data['skillIds'] = $skills;
         
-        $response = $this->requestV1($url, 'POST', $data);
-        $agents = [];
+		$response = $this->requestV1($url, 'POST', $data);
+		$agents = [];
         
-        foreach ($response->agentStatusRecords as $agent) {
-	        $agents[] = new Agent((array) $agent);
-        }
+		foreach ($response->agentStatusRecords as $agent) {
+			$agents[] = new Agent((array) $agent);
+		}
         
-        $collection = new Humans($agents);
-        $collection->metaData = $response->_metadata;
+		$collection = new Humans($agents);
+		$collection->metaData = $response->_metadata;
         
-        return $collection;
+		return $collection;
         
-    }
+	}
 
-    public function messagingHistory(Carbon $start = null, Carbon $end = null)
-    {
-        $this->retry_counter = 0;
+	public function messagingHistory(Carbon $start = null, Carbon $end = null)
+	{
+		$this->retry_counter = 0;
 
-        $start = $start ?: (new Carbon())->today();
-        $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);
+		$start = $start ?: (new Carbon())->today();
+		$end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);
 
-        $this->start = $start;
-        $this->end = $end;
+		$this->start = $start;
+		$this->end = $end;
         
-        $results_object = $this->retrieveMsgHistory($start, $end);
+		$results_object = $this->retrieveMsgHistory($start, $end);
 
 		if (is_object($results_object)) {
 
-	        $results = $results_object->conversationHistoryRecords;
-	        if (property_exists($results_object->_metadata, 'next')) {
-	            $this->next = $results_object->_metadata->next->href;
-	        }
-	        if (property_exists($results_object->_metadata, 'prev')) {
-	            $this->prev = $results_object->_metadata->prev->href;
-	        }
+			$results = $results_object->conversationHistoryRecords;
+			if (property_exists($results_object->_metadata, 'next')) {
+				$this->next = $results_object->_metadata->next->href;
+			}
+			if (property_exists($results_object->_metadata, 'prev')) {
+				$this->prev = $results_object->_metadata->prev->href;
+			}
 	
-	        $history = [];
-	        foreach ($results as $item) {
-	            if (property_exists($item, 'info')) {
-	                $item->info = new Info((array) $item->info);
-	            }
+			$history = [];
+			foreach ($results as $item) {
+				if (property_exists($item, 'info')) {
+					$item->info = new Info((array) $item->info);
+				}
 	
-	            if (property_exists($item, 'visitorInfo')) {
-	                $item->visitorInfo = new Visitor((array) $item->visitorInfo);
-	            }
+				if (property_exists($item, 'visitorInfo')) {
+					$item->visitorInfo = new Visitor((array) $item->visitorInfo);
+				}
 	
-	            if (property_exists($item, 'campaign')) {
-	                $item->campaign = new Campaign((array) $item->campaign);
-	            }
+				if (property_exists($item, 'campaign')) {
+					$item->campaign = new Campaign((array) $item->campaign);
+				}
 	
-	            $history[] = new Conversation((array) $item);
-	        }
+				$history[] = new Conversation((array) $item);
+			}
 	
-	        $collection = new ConversationHistory($history, $this);
-	        $collection->metaData = $results_object->_metadata;
+			$collection = new ConversationHistory($history, $this);
+			$collection->metaData = $results_object->_metadata;
 	        
-	        return $collection;
+			return $collection;
 	        
-	    } else {
-		    return false;
-	    }
-    }
+		} else {
+			return false;
+		}
+	}
 
-    public function history(Carbon $start = null, Carbon $end = null)
-    {
-        $this->retry_counter = 0;
+	public function history(Carbon $start = null, Carbon $end = null)
+	{
+		$this->retry_counter = 0;
 
-        $start = $start ?: (new Carbon())->today();
-        $end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);
+		$start = $start ?: (new Carbon())->today();
+		$end = $end ?: (new Carbon())->today()->addHours(23)->addMinutes(59);
 
-        $this->start = $start;
-        $this->end = $end;
+		$this->start = $start;
+		$this->end = $end;
 
-        $results_object = $this->retrieveHistory($start, $end);
+		$results_object = $this->retrieveHistory($start, $end);
         
-        if (is_object($results_object)) {
+		if (is_object($results_object)) {
         
-	        $results = $results_object->interactionHistoryRecords;
-	        if (property_exists($results_object->_metadata, 'next')) {
-	            $this->next = $results_object->_metadata->next->href;
-	        }
-	        if (property_exists($results_object->_metadata, 'prev')) {
-	            $this->prev = $results_object->_metadata->prev->href;
-	        }
+			$results = $results_object->interactionHistoryRecords;
+			if (property_exists($results_object->_metadata, 'next')) {
+				$this->next = $results_object->_metadata->next->href;
+			}
+			if (property_exists($results_object->_metadata, 'prev')) {
+				$this->prev = $results_object->_metadata->prev->href;
+			}
 	
-	        $history = [];
-	        foreach ($results as $item) {
-	            if (property_exists($item, 'info')) {
-	                $item->info = new Info((array) $item->info);
-	            }
+			$history = [];
+			foreach ($results as $item) {
+				if (property_exists($item, 'info')) {
+					$item->info = new Info((array) $item->info);
+				}
 	
-	            if (property_exists($item, 'visitorInfo')) {
-	                $item->visitorInfo = new Visitor((array) $item->visitorInfo);
-	            }
+				if (property_exists($item, 'visitorInfo')) {
+					$item->visitorInfo = new Visitor((array) $item->visitorInfo);
+				}
 	
-	            if (property_exists($item, 'campaign')) {
-	                $item->campaign = new Campaign((array) $item->campaign);
-	            }
+				if (property_exists($item, 'campaign')) {
+					$item->campaign = new Campaign((array) $item->campaign);
+				}
 	
-	            $history[] = new Engagement((array) $item);
-	        }
+				$history[] = new Engagement((array) $item);
+			}
 	        
-	        $collection = new EngagementHistory($history, $this);
-	        $collection->metaData = $results_object->_metadata;
+			$collection = new EngagementHistory($history, $this);
+			$collection->metaData = $results_object->_metadata;
 	        
-	        return $collection;
+			return $collection;
 	        
-        } else {
-	        return false;
-        }
-    }
+		} else {
+			return false;
+		}
+	}
     
-    public function login()
-    {
-	    $this->domain('agentVep');
+	public function login()
+	{
+		$this->domain('agentVep');
 	    
-	    $consumer_key = config("{$this->config}.key");
-        $consumer_secret = config("{$this->config}.secret");
-        $token = config("{$this->config}.token");
-        $secret = config("{$this->config}.token_secret");
-        $username = config("{$this->config}.user_name");
+		$consumer_key = config("{$this->config}.key");
+		$consumer_secret = config("{$this->config}.secret");
+		$token = config("{$this->config}.token");
+		$secret = config("{$this->config}.token_secret");
+		$username = config("{$this->config}.user_name");
         
-        $auth = [
-	        'username'          => $username,
-            'appKey'            => $consumer_key,
-            'secret'            => $consumer_secret,
-            'accessToken'		=> $token,
-            'accessTokenSecret' => $secret,
-        ];
+		$auth = [
+			'username'          => $username,
+			'appKey'            => $consumer_key,
+			'secret'            => $consumer_secret,
+			'accessToken'		=> $token,
+			'accessTokenSecret' => $secret,
+		];
         
-        $url = "https://{$this->domain}/api/account/{$this->account}/login?v=1.3";
+		$url = "https://{$this->domain}/api/account/{$this->account}/login?v=1.3";
         
-        $response = $this->requestV1($url, 'POST', $auth);
+		$response = $this->requestV1($url, 'POST', $auth);
         
-        $this->bearer = $response->bearer;
+		$this->bearer = $response->bearer;
         
-        return $this;
-    }
+		return $this;
+	}
     
-    private function requestV2($url, $method, $payload = false)
-    {
-	    if (!$this->bearer) $this->login();
+	private function requestV2($url, $method, $payload = false)
+	{
+		if (!$this->bearer) $this->login();
 	    
-	    $client = new Client();
-	    $args = [
-		    'headers' => [
-			    'Authorization' => $this->bearer
-		    ]
-	    ];
+		$client = new Client();
+		$args = [
+			'headers' => [
+				'Authorization' => $this->bearer
+			]
+		];
 	    
-	    if ($payload !== false) {
-            $args['body'] = json_encode($payload);
-        }
+		if ($payload !== false) {
+			$args['body'] = json_encode($payload);
+		}
 	    
-	    try {
-		    $res = $client->request($method, $url, $args);
-	    } catch (\Exception $e) {
-		    throw $e;
-	    } 
+		try {
+			$res = $client->request($method, $url, $args);
+		} catch (\Exception $e) {
+			throw $e;
+		} 
 	    
-	    return json_decode($res->getBody());
-    }
-
-    private function requestV1($url, $method, $payload = false)
-    {
-        $consumer_key = config("{$this->config}.key");
-        $consumer_secret = config("{$this->config}.secret");
-        $token = config("{$this->config}.token");
-        $secret = config("{$this->config}.token_secret");
-
-        $stack = HandlerStack::create();
-        $auth = new Oauth1([
-            'consumer_key'    => $consumer_key,
-            'consumer_secret' => $consumer_secret,
-            'token'           => $token,
-            'token_secret'    => $secret,
-            'signature_method'=> Oauth1::SIGNATURE_METHOD_HMAC,
-        ]);
-        $stack->push($auth);
-
-        $client = new Client([
-            'handler' => $stack,
-        ]);
-
-        $args = [
-            'auth' => 'oauth',
-            'headers' => [
-                'content-type' => 'application/json',
-            ],
-        ];
-
-        if ($payload !== false) {
-            $args['body'] = json_encode($payload);
-        }
-
-        try {
-            $res = $client->request($method, $url, $args);
-
-            $response = json_decode($res->getBody());
-        } catch (\GuzzleHttp\Exception\ConnectException $connection) {
-            return $connection;
-        } catch (\GuzzleHttp\Exception\ClientException $clientException) {
-	        return $clientException;
-        } catch (\Exception $e) {
-            if ($this->retry_counter < $this->retry_limit || $this->retry_limit == -1) {
-                usleep(1500);
-                $this->retry_counter++;
-                $response = $this->requestV1($url, $payload);
-            } else {
-                throw $e; //new LiveEngageException("Retry limit has been exceeded ($this->retry_limit)", 100);
-            }
-        }
-
-        return $response;
-    }
+		return json_decode($res->getBody());
+	}
+
+	private function requestV1($url, $method, $payload = false)
+	{
+		$consumer_key = config("{$this->config}.key");
+		$consumer_secret = config("{$this->config}.secret");
+		$token = config("{$this->config}.token");
+		$secret = config("{$this->config}.token_secret");
+
+		$stack = HandlerStack::create();
+		$auth = new Oauth1([
+			'consumer_key'    => $consumer_key,
+			'consumer_secret' => $consumer_secret,
+			'token'           => $token,
+			'token_secret'    => $secret,
+			'signature_method'=> Oauth1::SIGNATURE_METHOD_HMAC,
+		]);
+		$stack->push($auth);
+
+		$client = new Client([
+			'handler' => $stack,
+		]);
+
+		$args = [
+			'auth' => 'oauth',
+			'headers' => [
+				'content-type' => 'application/json',
+			],
+		];
+
+		if ($payload !== false) {
+			$args['body'] = json_encode($payload);
+		}
+
+		try {
+			$res = $client->request($method, $url, $args);
+
+			$response = json_decode($res->getBody());
+		} catch (\GuzzleHttp\Exception\ConnectException $connection) {
+			return $connection;
+		} catch (\GuzzleHttp\Exception\ClientException $clientException) {
+			return $clientException;
+		} catch (\Exception $e) {
+			if ($this->retry_counter < $this->retry_limit || $this->retry_limit == -1) {
+				usleep(1500);
+				$this->retry_counter++;
+				$response = $this->requestV1($url, $payload);
+			} else {
+				throw $e; //new LiveEngageException("Retry limit has been exceeded ($this->retry_limit)", 100);
+			}
+		}
+
+		return $response;
+	}
 }