Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/zendesk/zendesk_api_client_php/src/Zendesk/API/Resources/Core/ |
<?php
namespace Zendesk\API\Resources\Core;
use Zendesk\API\Exceptions\MissingParametersException;
use Zendesk\API\Exceptions\ResponseException;
use Zendesk\API\Http;
use Zendesk\API\Resources\ResourceAbstract;
use Zendesk\API\Traits\Resource\Defaults;
use Zendesk\API\Traits\Resource\DeleteMany;
use Zendesk\API\Traits\Resource\FindMany;
use Zendesk\API\Traits\Resource\UpdateMany;
use Zendesk\API\Traits\Utility\InstantiatorTrait;
/**
* The Tickets class exposes key methods for reading and updating ticket data
* @method TicketComments comments()
* @method TicketForms forms()
* @method Tags tags()
* @method TicketAudits audits()
* @method Attachments attachments()
* @method TicketMetrics metrics()
*/
class Tickets extends ResourceAbstract
{
use InstantiatorTrait;
use Defaults {
create as traitCreate;
update as traitUpdate;
}
use FindMany;
use UpdateMany {
UpdateMany::updateMany as bulkUpdate;
}
use DeleteMany;
/**
* @var array
*/
protected $lastAttachments = [];
/**
* {@inheritdoc}
*/
public static function getValidSubResources()
{
return [
'comments' => TicketComments::class,
'forms' => TicketForms::class,
'tags' => Tags::class,
'audits' => TicketAudits::class,
'attachments' => Attachments::class,
'metrics' => TicketMetrics::class,
'satisfactionRatings' => SatisfactionRatings::class,
];
}
/**
* Wrapper for common GET requests
*
* @param $route
* @param array $params
*
* @return \stdClass | null
* @throws ResponseException
* @throws \Exception
*/
private function sendGetRequest($route, array $params = [])
{
$response = Http::send(
$this->client,
$this->getRoute($route, $params),
['queryParams' => $params]
);
return $response;
}
/**
* Declares routes to be used by this resource.
*/
protected function setUpRoutes()
{
parent::setUpRoutes();
$this->setRoutes([
'create' => 'tickets.json',
'findMany' => 'tickets/show_many.json',
'updateMany' => 'tickets/update_many.json',
'markAsSpam' => 'tickets/{id}/mark_as_spam.json',
'markManyAsSpam' => 'tickets/mark_many_as_spam.json',
'related' => 'tickets/{id}/related.json',
'deleteMany' => 'tickets/destroy_many.json',
'collaborators' => 'tickets/{id}/collaborators.json',
'incidents' => 'tickets/{id}/incidents.json',
'merge' => 'tickets/{id}/merge.json',
'problems' => 'problems.json',
'export' => 'exports/tickets.json',
'problemAutoComplete' => 'problems/autocomplete.json'
]);
}
/**
* Find a specific twitter generated ticket by id
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return \stdClass | null
*/
public function findTwicket(array $params = [])
{
$params = $this->addChainedParametersToParams($params, ['id' => get_class($this)]);
if (! $this->hasKeys($params, ['id'])) {
throw new MissingParametersException(__METHOD__, ['id']);
}
$endPointBase = 'channels/twitter/tickets/' . $params['id'] . '/statuses.json';
$endPoint = Http::prepare(
$endPointBase . (is_array($params['comment_ids']) ? '?' . implode(',', $params['comment_ids']) : ''),
$this->client->getSideload($params)
);
$response = Http::send($this->client, $endPoint);
return $response;
}
/**
* Create a ticket
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
* @throws \Zendesk\API\Exceptions\AuthException
* @throws \Zendesk\API\Exceptions\ApiResponseException
*/
public function create(array $params)
{
if (count($this->lastAttachments)) {
$params['comment']['uploads'] = $this->lastAttachments;
$this->lastAttachments = [];
}
$extraOptions = [];
if (isset($params['async']) && ($params['async'] == true)) {
$extraOptions = [
'queryParams' => [
'async' => true
]
];
}
$route = $this->getRoute(__FUNCTION__, $params);
return $this->client->post(
$route,
[$this->objectName => $params],
$extraOptions
);
}
/**
* Create a ticket from a tweet
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function createFromTweet(array $params)
{
if ((! $params['twitter_status_message_id']) || (! $params['monitored_twitter_handle_id'])) {
throw new MissingParametersException(
__METHOD__,
['twitter_status_message_id', 'monitored_twitter_handle_id']
);
}
$endPoint = Http::prepare('channels/twitter/tickets.json');
$response = Http::send($this->client, $endPoint, [self::OBJ_NAME => $params], 'POST');
$lastResponseCode = $this->client->getDebug()->lastResponseCode;
if ((! is_object($response)) || ($lastResponseCode != 201)) {
throw new ResponseException(
__METHOD__,
($lastResponseCode == 422 ? ' (hint: you can\'t create two tickets from the same tweet)' : '')
);
}
return $response;
}
/**
* Update a ticket or series of tickets
*
* @param int $id
* @param array $updateResourceFields
* @return null|\stdClass
*/
public function update($id = null, array $updateResourceFields = [])
{
if (count($this->lastAttachments)) {
$updateResourceFields['comment']['uploads'] = $this->lastAttachments;
$this->lastAttachments = [];
}
return $this->traitUpdate($id, $updateResourceFields);
}
/**
* Update a ticket or series of tickets
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function updateMany(array $params)
{
if (count($this->lastAttachments)) {
$params['comment']['uploads'] = $this->lastAttachments;
$this->lastAttachments = [];
}
return $this->bulkUpdate($params);
}
/**
* Mark a ticket as spam and suspend the requester
*
* @param mixed $id The ticket ID, or an array of ticket ID's to mark as spam
*
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function markAsSpam($id = null)
{
$options = ['method' => 'PUT'];
if (is_array($id)) {
$options['queryParams']['ids'] = implode(',', $id);
$route = $this->getRoute('markManyAsSpam');
} else {
$params = $this->addChainedParametersToParams(
['id' => $id],
['id' => get_class($this)]
);
$route = $this->getRoute('markAsSpam', $params);
}
$response = Http::send(
$this->client,
$route,
$options
);
return $response;
}
/**
* Get related ticket information
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function related(array $params = [])
{
$params = $this->addChainedParametersToParams($params, ['id' => get_class($this)]);
if (! $this->hasKeys($params, ['id'])) {
throw new MissingParametersException(__METHOD__, ['id']);
}
return $this->sendGetRequest(__FUNCTION__, $params);
}
/**
* List collaborators for a ticket
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function collaborators(array $params = [])
{
$params = $this->addChainedParametersToParams($params, ['id' => get_class($this)]);
if (! $this->hasKeys($params, ['id'])) {
throw new MissingParametersException(__METHOD__, ['id']);
}
return $this->sendGetRequest(__FUNCTION__, $params);
}
/**
* List incidents for a ticket
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function incidents(array $params = [])
{
$params = $this->addChainedParametersToParams($params, ['id' => get_class($this)]);
if (! $this->hasKeys($params, ['id'])) {
throw new MissingParametersException(__METHOD__, ['id']);
}
return $this->sendGetRequest(__FUNCTION__, $params);
}
/**
* List all problem tickets
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function problems(array $params = [])
{
return $this->sendGetRequest(__FUNCTION__, $params);
}
/**
* Add a problem autocomplete
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function problemAutoComplete(array $params)
{
if (! $params['text']) {
throw new MissingParametersException(__METHOD__, ['text']);
}
$response = Http::send(
$this->client,
$this->getRoute('problemAutoComplete'),
[
'method' => 'POST',
'postFields' => ['text' => $params['text']]
]
);
return $response;
}
/**
* Incremental ticket exports with a supplied start_time
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
* @return \stdClass | null
*/
public function export(array $params)
{
if (! $params['start_time']) {
throw new MissingParametersException(__METHOD__, ['start_time']);
}
$queryParams = ["start_time" => $params["start_time"]];
$response = Http::send(
$this->client,
$this->getRoute('export'),
['queryParams' => $queryParams]
);
return $response;
}
/**
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @return Tickets
*/
public function attach(array $params = [])
{
if (! $this->hasKeys($params, ['file'])) {
throw new MissingParametersException(__METHOD__, ['file']);
}
$upload = $this->client->attachments()->upload($params);
if ((! is_object($upload->upload)) || (! $upload->upload->token)) {
throw new ResponseException(__METHOD__);
}
$this->lastAttachments[] = $upload->upload->token;
return $this;
}
/**
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @return \stdClass | null
*/
public function merge(array $params = [])
{
$params = $this->addChainedParametersToParams($params, ['id' => get_class($this)]);
if (! $this->hasKeys($params, ['id', 'ids'])) {
throw new MissingParametersException(__METHOD__, ['id', 'ids']);
}
$route = $this->getRoute(__FUNCTION__, ['id' => $params['id']]);
unset($params['id']);
$response = Http::send(
$this->client,
$route,
[
'method' => 'POST',
'postFields' => $params,
]
);
return $response;
}
}