1 | <?php |
||
12 | class PreviewApp |
||
13 | { |
||
14 | /** |
||
15 | * @var Client |
||
16 | */ |
||
17 | private $client; |
||
18 | |||
19 | 1 | public function __construct(Client $client) |
|
23 | |||
24 | /** |
||
25 | * Deploy app |
||
26 | * https://cybozudev.zendesk.com/hc/ja/articles/204699420 |
||
27 | * |
||
28 | * @param integer $id |
||
29 | * @param integer $guestSpaceId |
||
30 | * @param integer $revision |
||
31 | * @param boolean $revert |
||
32 | * @return array |
||
33 | */ |
||
34 | 20 | public function deploy($id, $guestSpaceId = null, $revision = -1, $revert = false) |
|
41 | |||
42 | /** |
||
43 | * Deploy apps |
||
44 | * https://cybozudev.zendesk.com/hc/ja/articles/204699420 |
||
45 | * |
||
46 | * @param array $apps |
||
47 | * @param integer $guestSpaceId |
||
48 | * @param boolean $revert |
||
49 | * @return array |
||
50 | */ |
||
51 | 20 | public function deployApps(array $apps, $guestSpaceId = null, $revert = false) |
|
62 | |||
63 | /** |
||
64 | * get deploy status |
||
65 | * https://cybozudev.zendesk.com/hc/ja/articles/204699420 |
||
66 | * |
||
67 | * @param integer $id |
||
68 | * @param integer $guestSpaceId |
||
69 | * @return array |
||
70 | */ |
||
71 | 20 | public function getDeployStatus($id, $guestSpaceId = null) |
|
75 | |||
76 | /** |
||
77 | * get deploy statuses |
||
78 | * https://cybozudev.zendesk.com/hc/ja/articles/204699420 |
||
79 | * |
||
80 | * @param array $ids |
||
81 | * @param integer $guestSpaceId |
||
82 | * @return array |
||
83 | */ |
||
84 | 20 | public function getDeployStatuses(array $ids, $guestSpaceId = null) |
|
95 | |||
96 | /** |
||
97 | * Post preview app |
||
98 | * https://cybozudev.zendesk.com/hc/ja/articles/202931674#step1 |
||
99 | * |
||
100 | * @param string $name |
||
101 | * @param integer $spaceId |
||
102 | * @param integer $threadId |
||
103 | * @param integer $guestSpaceId |
||
104 | * @return array |
||
105 | */ |
||
106 | 32 | public function post($name, $spaceId = null, $threadId = null, $guestSpaceId = null) |
|
121 | |||
122 | /** |
||
123 | * Get app settings |
||
124 | * https://cybozudev.zendesk.com/hc/ja/articles/204694170 |
||
125 | * |
||
126 | * @param integer $id |
||
127 | * @param integer $guestSpaceId |
||
128 | * @param string $lang |
||
129 | * @return array |
||
130 | */ |
||
131 | public function getSettings($id, $guestSpaceId = null, $lang = 'default') |
||
132 | { |
||
133 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
134 | |||
135 | /** @var JsonStream $stream */ |
||
136 | $stream = $this->client |
||
137 | ->get(KintoneApi::generateUrl('preview/app/settings.json', $guestSpaceId), $options) |
||
138 | ->getBody(); |
||
139 | |||
140 | return $stream->jsonSerialize(); |
||
141 | } |
||
142 | |||
143 | /** |
||
144 | * Get app form fields |
||
145 | * https://cybozudev.zendesk.com/hc/ja/articles/204783170#anchor_getform_fields |
||
146 | * |
||
147 | * @param integer $id |
||
148 | * @param integer $guestSpaceId |
||
149 | * @param string $lang |
||
150 | * @return array |
||
151 | */ |
||
152 | public function getFields($id, $guestSpaceId = null, $lang = 'default') |
||
153 | { |
||
154 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
155 | |||
156 | /** @var JsonStream $stream */ |
||
157 | $stream = $this->client |
||
158 | ->get(KintoneApi::generateUrl('preview/app/form/fields.json', $guestSpaceId), $options) |
||
159 | ->getBody(); |
||
160 | |||
161 | return $stream->jsonSerialize(); |
||
162 | } |
||
163 | |||
164 | /** |
||
165 | * Get app form layout |
||
166 | * https://cybozudev.zendesk.com/hc/ja/articles/204783170#anchor_getform_layout |
||
167 | * |
||
168 | * @param integer $id |
||
169 | * @param integer $guestSpaceId |
||
170 | * @param string $lang |
||
171 | * @return array |
||
172 | */ |
||
173 | public function getLayout($id, $guestSpaceId = null, $lang = 'default') |
||
174 | { |
||
175 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
176 | |||
177 | /** @var JsonStream $stream */ |
||
178 | $stream = $this->client |
||
179 | ->get(KintoneApi::generateUrl('preview/app/form/layout.json', $guestSpaceId), $options) |
||
180 | ->getBody(); |
||
181 | |||
182 | return $stream->jsonSerialize(); |
||
183 | } |
||
184 | |||
185 | /** |
||
186 | * Get app views |
||
187 | * https://cybozudev.zendesk.com/hc/ja/articles/204529784 |
||
188 | * |
||
189 | * @param integer $id |
||
190 | * @param integer $guestSpaceId |
||
191 | * @param string $lang |
||
192 | * @return array |
||
193 | */ |
||
194 | public function getViews($id, $guestSpaceId = null, $lang = 'default') |
||
205 | |||
206 | /** |
||
207 | * Get app acl |
||
208 | * https://cybozudev.zendesk.com/hc/ja/articles/204529754 |
||
209 | * |
||
210 | * @param integer $id |
||
211 | * @param integer $guestSpaceId |
||
212 | * @param string $lang |
||
213 | * @return array |
||
214 | */ |
||
215 | public function getAcl($id, $guestSpaceId = null, $lang = 'default') |
||
216 | { |
||
217 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
218 | |||
219 | /** @var JsonStream $stream */ |
||
220 | $stream = $this->client |
||
221 | ->get(KintoneApi::generateUrl('preview/app/acl.json', $guestSpaceId), $options) |
||
222 | ->getBody(); |
||
223 | |||
224 | return $stream->jsonSerialize(); |
||
225 | } |
||
226 | |||
227 | /** |
||
228 | * Get record acl |
||
229 | * https://cybozudev.zendesk.com/hc/ja/articles/204791510 |
||
230 | * |
||
231 | * @param integer $id |
||
232 | * @param integer $guestSpaceId |
||
233 | * @param string $lang |
||
234 | * @return array |
||
235 | */ |
||
236 | public function getRecordAcl($id, $guestSpaceId = null, $lang = 'default') |
||
237 | { |
||
238 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
239 | |||
240 | /** @var JsonStream $stream */ |
||
241 | $stream = $this->client |
||
242 | ->get(KintoneApi::generateUrl('preview/record/acl.json', $guestSpaceId), $options) |
||
243 | ->getBody(); |
||
244 | |||
245 | return $stream->jsonSerialize(); |
||
246 | } |
||
247 | |||
248 | /** |
||
249 | * Get field acl |
||
250 | * https://cybozudev.zendesk.com/hc/ja/articles/204791520 |
||
251 | * |
||
252 | * @param integer $id |
||
253 | * @param integer $guestSpaceId |
||
254 | * @param string $lang |
||
255 | * @return array |
||
256 | */ |
||
257 | public function getFieldAcl($id, $guestSpaceId = null, $lang = 'default') |
||
268 | |||
269 | /** |
||
270 | * Get app JavaScript and CSS customize |
||
271 | * https://cybozudev.zendesk.com/hc/ja/articles/204529824 |
||
272 | * |
||
273 | * @param integer $id |
||
274 | * @param integer $guestSpaceId |
||
275 | * @return array |
||
276 | */ |
||
277 | 1 | public function getCustomize($id, $guestSpaceId = null) |
|
288 | |||
289 | /** |
||
290 | * Get app status list |
||
291 | * https://cybozudev.zendesk.com/hc/ja/articles/216972946 |
||
292 | * |
||
293 | * @param integer $id |
||
294 | * @param string $lang |
||
295 | * @param integer $guestSpaceId |
||
296 | * @return array |
||
297 | */ |
||
298 | public function getStatus($id, $lang = 'ja', $guestSpaceId = null) |
||
299 | { |
||
300 | $options = ['json' => ['app' => $id, 'lang' => $lang]]; |
||
301 | |||
302 | /** @var JsonStream $stream */ |
||
303 | $stream = $this->client |
||
304 | ->get(KintoneApi::generateUrl('preview/app/status.json', $guestSpaceId), $options) |
||
305 | ->getBody(); |
||
306 | |||
307 | return $stream->jsonSerialize(); |
||
308 | } |
||
309 | |||
310 | /** |
||
311 | * Put preview app settings |
||
312 | * https://cybozudev.zendesk.com/hc/ja/articles/204730520 |
||
313 | * |
||
314 | * @param integer $id |
||
315 | * @param string $name |
||
316 | * @param string $description |
||
317 | * @param array $icon |
||
318 | * @param string $theme |
||
319 | * @param integer $guestSpaceId |
||
320 | * @param integer $revision |
||
321 | * @return array |
||
322 | */ |
||
323 | 20 | public function putSettings($id, $name, $description, array $icon, $theme, $guestSpaceId = null, $revision = -1) |
|
341 | |||
342 | /** |
||
343 | * Post form fields to preview app |
||
344 | * https://cybozudev.zendesk.com/hc/ja/articles/204529724#anchor_changeform_addfields |
||
345 | * |
||
346 | * @param integer $id |
||
347 | * @param array $fields |
||
348 | * @param integer $guestSpaceId |
||
349 | * @param integer $revision |
||
350 | * @return array |
||
351 | */ |
||
352 | 20 | public function postFields($id, array $fields, $guestSpaceId = null, $revision = -1) |
|
367 | |||
368 | /** |
||
369 | * Put form fields to preview app |
||
370 | * https://cybozudev.zendesk.com/hc/ja/articles/204529724#anchor_changeform_changefields |
||
371 | * |
||
372 | * @param integer $id |
||
373 | * @param array $fields |
||
374 | * @param integer $guestSpaceId |
||
375 | * @param integer $revision |
||
376 | * @return array |
||
377 | */ |
||
378 | public function putFields($id, array $fields, $guestSpaceId = null, $revision = -1) |
||
379 | { |
||
380 | $options = ['json' => [ |
||
381 | 'app' => $id, |
||
382 | 'properties' => $fields, |
||
383 | 'revision' => $revision |
||
384 | ]]; |
||
385 | |||
386 | /** @var JsonStream $stream */ |
||
387 | $stream = $this->client |
||
388 | ->put(KintoneApi::generateUrl('preview/app/form/fields.json', $guestSpaceId), $options) |
||
389 | ->getBody(); |
||
390 | |||
391 | return $stream->jsonSerialize(); |
||
392 | } |
||
393 | |||
394 | /** |
||
395 | * Delete form fields to preview app |
||
396 | * https://cybozudev.zendesk.com/hc/ja/articles/204529724#anchor_changeform_deletefields |
||
397 | * |
||
398 | * @param integer $id |
||
399 | * @param array $fields |
||
400 | * @param integer $guestSpaceId |
||
401 | * @param integer $revision |
||
402 | * @return array |
||
403 | */ |
||
404 | public function deleteFields($id, array $fields, $guestSpaceId = null, $revision = -1) |
||
405 | { |
||
406 | $options = ['json' => [ |
||
407 | 'app' => $id, |
||
408 | 'fields' => $fields, |
||
409 | 'revision' => $revision |
||
410 | ]]; |
||
411 | |||
412 | /** @var JsonStream $stream */ |
||
413 | $stream = $this->client |
||
414 | ->delete(KintoneApi::generateUrl('preview/app/form/fields.json', $guestSpaceId), $options) |
||
415 | ->getBody(); |
||
416 | |||
417 | return $stream->jsonSerialize(); |
||
418 | } |
||
419 | |||
420 | /** |
||
421 | * Put form layout to preview app |
||
422 | * https://cybozudev.zendesk.com/hc/ja/articles/204529724#anchor_changeform_changelayout |
||
423 | * |
||
424 | * @param integer $id |
||
425 | * @param array $layout |
||
426 | * @param integer $guestSpaceId |
||
427 | * @param integer $revision |
||
428 | * @return array |
||
429 | */ |
||
430 | 20 | public function putLayout($id, array $layout, $guestSpaceId = null, $revision = -1) |
|
445 | |||
446 | /** |
||
447 | * Put views to preview app |
||
448 | * https://cybozudev.zendesk.com/hc/ja/articles/204529794 |
||
449 | * |
||
450 | * @param integer $id |
||
451 | * @param array $views |
||
452 | * @param integer $guestSpaceId |
||
453 | * @param integer $revision |
||
454 | * @return array |
||
455 | */ |
||
456 | 20 | public function putViews($id, array $views, $guestSpaceId = null, $revision = -1) |
|
471 | |||
472 | /** |
||
473 | * Put app acl to preview app |
||
474 | * https://cybozudev.zendesk.com/hc/ja/articles/201941844 |
||
475 | * |
||
476 | * @param integer $id |
||
477 | * @param array $rights |
||
478 | * @param integer $guestSpaceId |
||
479 | * @param integer $revision |
||
480 | * @return array |
||
481 | */ |
||
482 | public function putAcl($id, array $rights, $guestSpaceId = null, $revision = -1) |
||
483 | { |
||
484 | $options = ['json' => [ |
||
485 | 'app' => $id, |
||
486 | 'rights' => $rights, |
||
487 | 'revision' => $revision |
||
488 | ]]; |
||
489 | |||
490 | /** @var JsonStream $stream */ |
||
491 | $stream = $this->client |
||
492 | ->put(KintoneApi::generateUrl('preview/app/acl.json', $guestSpaceId), $options) |
||
493 | ->getBody(); |
||
494 | |||
495 | return $stream->jsonSerialize(); |
||
496 | } |
||
497 | |||
498 | /** |
||
499 | * Put record acl to preview app |
||
500 | * https://cybozudev.zendesk.com/hc/ja/articles/201941854 |
||
501 | * |
||
502 | * @param integer $id |
||
503 | * @param array $rights |
||
504 | * @param integer $guestSpaceId |
||
505 | * @param integer $revision |
||
506 | * @return array |
||
507 | */ |
||
508 | public function putRecordAcl($id, array $rights, $guestSpaceId = null, $revision = -1) |
||
509 | { |
||
510 | $options = ['json' => compact('id', 'rights', 'revision')]; |
||
511 | |||
512 | /** @var JsonStream $stream */ |
||
513 | $stream = $this->client |
||
514 | ->put(KintoneApi::generateUrl('preview/record/acl.json', $guestSpaceId), $options) |
||
515 | ->getBody(); |
||
516 | |||
517 | return $stream->jsonSerialize(); |
||
518 | } |
||
519 | |||
520 | /** |
||
521 | * Put field acl to preview app |
||
522 | * https://cybozudev.zendesk.com/hc/ja/articles/201941854 |
||
523 | * |
||
524 | * @param integer $id |
||
525 | * @param array $rights |
||
526 | * @param integer $guestSpaceId |
||
527 | * @param integer $revision |
||
528 | * @return array |
||
529 | */ |
||
530 | public function putFieldAcl($id, array $rights, $guestSpaceId = null, $revision = -1) |
||
541 | |||
542 | /** |
||
543 | * Put app JavaScript & CSS customize to preview app |
||
544 | * https://cybozudev.zendesk.com/hc/ja/articles/204529834 |
||
545 | * |
||
546 | * @param integer $id |
||
547 | * @param array $js |
||
548 | * @param array $css |
||
549 | * @param array $mobileJs |
||
550 | * @param integer $guestSpaceId |
||
551 | * @param string $scope |
||
552 | * @param integer $revision |
||
553 | * @return array |
||
554 | */ |
||
555 | 1 | public function putCustomize($id, array $js = [], array $css = [], array $mobileJs = [], $guestSpaceId = null, $scope = 'ALL', $revision = -1) |
|
574 | |||
575 | /** |
||
576 | * Put app status and action |
||
577 | * https://cybozudev.zendesk.com/hc/ja/articles/217905503 |
||
578 | * |
||
579 | * @param integer $id |
||
580 | * @param array $states |
||
581 | * @param array $actions |
||
582 | * @param boolean $enable |
||
583 | * @param integer $guestSpaceId |
||
584 | * @return array |
||
585 | */ |
||
586 | 1 | public function putStatus($id, array $states, array $actions, $enable = true, $guestSpaceId = null) |
|
604 | } |