| @@ -8,13 +8,11 @@ | ||
| 8 | 8 | use FluentSupport\App\Services\Tickets\ResponseService; |
| 9 | 9 | use FluentSupport\App\Services\Tickets\TicketService; |
| 10 | 10 | |
| 11 | 11 | /** |
| 12 | - * Tickets class for PHP API | |
| 12 | + * Tickets PHP API. | |
| 13 | + * | |
| 13 | 14 | * Example Usage: $ticketsApi = FluentSupportApi('tickets'); |
| 14 | - * @package FluentSupport\App\Api\Classes | |
| 15 | - * | |
| 16 | - * @version 1.0.0 | |
| 17 | 15 | */ |
| 18 | 16 | class Tickets |
| 19 | 17 | { |
| 20 | 18 | private $instance = null; |
| @@ -32,9 +30,9 @@ | ||
| 32 | 30 | $this->instance = $instance; |
| 33 | 31 | } |
| 34 | 32 | |
| 35 | 33 | /** |
| 36 | - * getTickets method will return all tickets | |
| 34 | + * Paginated tickets, newest first. | |
| 37 | 35 | * |
| 38 | 36 | * @return object |
| 39 | 37 | */ |
| 40 | 38 | public function getTickets() |
| @@ -58,9 +56,8 @@ | ||
| 58 | 56 | return $tickets; |
| 59 | 57 | } |
| 60 | 58 | |
| 61 | 59 | /** |
| 62 | - * getTicket method will return a specific ticket by id | |
| 63 | 60 | * @param int $id |
| 64 | 61 | * @return object|false |
| 65 | 62 | */ |
| 66 | 63 | |
| @@ -76,9 +73,8 @@ | ||
| 76 | 73 | return false; |
| 77 | 74 | } |
| 78 | 75 | |
| 79 | 76 | /** |
| 80 | - * addResponse method add response to a ticket by agent and ticket ID | |
| 81 | 77 | * @param array $data |
| 82 | 78 | * @param int $agentId |
| 83 | 79 | * @param int $ticketId |
| 84 | 80 | * @return array|boolean |
| @@ -99,11 +95,10 @@ | ||
| 99 | 95 | return false; |
| 100 | 96 | } |
| 101 | 97 | |
| 102 | 98 | /** |
| 103 | - * createTicket method will create a new ticket | |
| 104 | 99 | * @param array $data |
| 105 | - * @return object| boolean | |
| 100 | + * @return object|false | |
| 106 | 101 | */ |
| 107 | 102 | |
| 108 | 103 | public function createTicket(array $data) |
| 109 | 104 | { |
