This repository was archived by the owner on Feb 5, 2024. It is now read-only.
forked from gorkalaucirica/HipchatAPIv2Client
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathClientInterface.php
More file actions
71 lines (66 loc) · 2.56 KB
/
Copy pathClientInterface.php
File metadata and controls
71 lines (66 loc) · 2.56 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
<?php
/**
* Created by solutionDrive GmbH.
*
* @author: Tobias Lückel <tl@solutionDrive.de>
* @date: 01.12.17
* @time: 13:11
* @copyright: 2017 solutionDrive GmbH
*/
namespace SolutionDrive\HipchatAPIv2Client;
interface ClientInterface
{
/**
* Common get request for all API calls
*
* @param string $resource The path to the resource wanted. For example v2/room
* @param array $query Parameters to filter the response for example array('max-results' => 50)
*
* @return array Decoded array containing response
* @throws Exception\RequestException
*/
public function get($resource, $query = array());
/**
* Common post request for all API calls
*
* @param string $resource The path to the resource wanted. For example v2/room
* @param array $content Parameters be posted for example:
* array(
* 'name' => 'Example name',
* 'privacy' => 'private',
* 'is_archived' => 'false',
* 'is_guest_accessible' => 'false',
* 'topic' => 'New topic',
* )
*
* @return array Decoded array containing response
* @throws Exception\RequestException
*/
public function post($resource, $content);
/**
* Common put request for all API calls
*
* @param string $resource The path to the resource wanted. For example v2/room
* @param array $content Parameters be putted for example:
* array(
* 'name' => 'Example name',
* 'privacy' => 'private',
* 'is_archived' => 'false',
* 'is_guest_accessible' => 'false',
* 'topic' => 'New topic',
* )
*
* @return array Decoded array containing response
* @throws Exception\RequestException
*/
public function put($resource, $content = array());
/**
* Common delete request for all API calls
*
* @param string $resource The path to the resource wanted. For example v2/room
*
* @return array Decoded array containing response
* @throws Exception\RequestException
*/
public function delete($resource);
}