Apps.php
5.41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<?php
namespace Zendesk\API;
/**
* The Apps class exposes app management methods
* @package Zendesk\API
*/
class Apps extends ClientAbstract
{
/**
* @var AppInstallations
*/
protected $installations;
/**
* @param Client $client
*/
public function __construct(Client $client)
{
parent::__construct($client);
$this->installations = new AppInstallations($client);
}
/**
* Uploads an app - see http://developer.zendesk.com/documentation/rest_api/apps.html for workflow
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function upload(array $params)
{
if (!$this->hasKeys($params, array('file'))) {
throw new MissingParametersException(__METHOD__, array('file'));
}
$endPoint = Http::prepare('apps/uploads.json');
$response = Http::send($this->client, $endPoint, array('uploaded_data' => $params['file']), 'POST');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 201)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Create an app
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function create(array $params)
{
$endPoint = Http::prepare('apps.json');
$response = Http::send($this->client, $endPoint, $params, 'POST');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 202)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Get a job status
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function jobStatus(array $params)
{
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$endPoint = Http::prepare('apps/job_statuses/' . $params['id'] . '.json');
$response = Http::send($this->client, $endPoint);
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Update an app
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function update(array $params)
{
if ($this->lastId != null) {
$params['id'] = $this->lastId;
$this->lastId = null;
}
if (!$this->hasKeys($params, array('file', 'id'))) {
throw new MissingParametersException(__METHOD__, array('file', 'id'));
}
$endPoint = Http::prepare('apps/' . $params['id'] . '.json');
$response = Http::send($this->client, $endPoint, array('uploaded_data' => $params['file']), 'PUT');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Delete an app
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return bool
*/
public function delete(array $params = array())
{
if ($this->lastId != null) {
$params['id'] = $this->lastId;
$this->lastId = null;
}
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$id = $params['id'];
$endPoint = Http::prepare('apps/' . $id . '.json');
$response = Http::send($this->client, $endPoint, null, 'DELETE');
if ($this->client->getDebug()->lastResponseCode != 200) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return true;
}
/**
* Send an app notification
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function sendNotification(array $params)
{
$endPoint = Http::prepare('apps/notify.json');
$response = Http::send($this->client, $endPoint, $params, 'POST');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/*
* Syntactic sugar methods:
* Handy aliases:
*/
/**
* @param int|null $id
*
* @return AppInstallations
*/
public function installations($id = null)
{
return ($id != null ? $this->installations->setLastId($id) : $this->installations);
}
/**
* @param int $id
*
* @return AppInstallations
*/
public function installation($id)
{
return $this->installations->setLastId($id);
}
}