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
|
<?php
/**
* Twilio TaskRouter Capability assigner
*
* @category Services
* @package Services_Twilio
* @author Justin Witz <justin.witz@twilio.com>
* @license http://creativecommons.org/licenses/MIT/ MIT
*/
class Services_Twilio_TaskRouter_Capability extends Services_Twilio_TaskRouter_CapabilityAPI
{
protected $baseUrl = 'https://taskrouter.twilio.com/v1';
protected $baseWsUrl = 'https://event-bridge.twilio.com/v1/wschannels';
protected $version = 'v1';
protected $workspaceSid;
protected $channelId;
protected $resourceUrl;
protected $required = array("required" => true);
protected $optional = array("required" => false);
public function __construct($accountSid, $authToken, $workspaceSid, $channelId, $resourceUrl = null, $overrideBaseUrl = null, $overrideBaseWSUrl = null) {
parent::__construct($accountSid, $authToken, $this->version, $channelId);
$this->workspaceSid = $workspaceSid;
$this->channelId = $channelId;
if(isset($overrideBaseUrl)) {
$this->baseUrl = $overrideBaseUrl;
}
if(isset($overrideBaseWSUrl)) {
$this->baseWsUrl = $overrideBaseWSUrl;
}
$this->baseUrl = $this->baseUrl.'/Workspaces/'.$workspaceSid;
$this->validateJWT();
if(!isset($resourceUrl)) {
$this->setupResource();
}
//add permissions to GET and POST to the event-bridge channel
$this->allow($this->baseWsUrl."/".$this->accountSid."/".$this->channelId, "GET", null, null);
$this->allow($this->baseWsUrl."/".$this->accountSid."/".$this->channelId, "POST", null, null);
//add permissions to fetch the instance resource
$this->allow($this->resourceUrl, "GET", null, null);
}
protected function setupResource() {
if(substr($this->channelId,0,2) == 'WS') {
$this->resourceUrl = $this->baseUrl;
}else if(substr($this->channelId,0,2) == 'WK') {
$this->resourceUrl = $this->baseUrl.'/Workers/'.$this->channelId;
//add permissions to fetch the list of activities, tasks and worker reservations
$activityUrl = $this->baseUrl.'/Activities';
$this->allow($activityUrl, "GET", null, null);
$tasksUrl = $this->baseUrl.'/Tasks/**';
$this->allow($tasksUrl, "GET", null, null);
$workerReservationsUrl = $this->resourceUrl.'/Reservations/**';
$this->allow($workerReservationsUrl, "GET", null, null);
}else if(substr($this->channelId,0,2) == 'WQ') {
$this->resourceUrl = $this->baseUrl.'/TaskQueues/'.$this->channelId;
}
}
private function validateJWT() {
if(!isset($this->accountSid) || substr($this->accountSid,0,2) != 'AC') {
throw new Exception("Invalid AccountSid provided: ".$this->accountSid);
}
if(!isset($this->workspaceSid) || substr($this->workspaceSid,0,2) != 'WS') {
throw new Exception("Invalid WorkspaceSid provided: ".$this->workspaceSid);
}
if(!isset($this->channelId)) {
throw new Exception("ChannelId not provided");
}
$prefix = substr($this->channelId,0,2);
if($prefix != 'WS' && $prefix != 'WK' && $prefix != 'WQ') {
throw new Exception("Invalid ChannelId provided: ".$this->channelId);
}
}
public function allowFetchSubresources() {
$method = 'GET';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl.'/**', $method, $queryFilter, $postFilter);
}
public function allowUpdates() {
$method = 'POST';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl, $method, $queryFilter, $postFilter);
}
public function allowUpdatesSubresources() {
$method = 'POST';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl.'/**', $method, $queryFilter, $postFilter);
}
public function allowDelete() {
$method = 'DELETE';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl, $method, $queryFilter, $postFilter);
}
public function allowDeleteSubresources() {
$method = 'DELETE';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl.'/**', $method, $queryFilter, $postFilter);
}
/**
* @deprecated Please use {Services_Twilio_TaskRouter_Worker_Capability.allowActivityUpdates} instead
*/
public function allowWorkerActivityUpdates() {
$method = 'POST';
$queryFilter = array();
$postFilter = array("ActivitySid" => $this->required);
$this->allow($this->resourceUrl, $method, $queryFilter, $postFilter);
}
/**
* @deprecated Please use {Services_Twilio_TaskRouter_Worker_Capability} instead; added automatically in constructor
*/
public function allowWorkerFetchAttributes() {
$method = 'GET';
$queryFilter = array();
$postFilter = array();
$this->allow($this->resourceUrl, $method, $queryFilter, $postFilter);
}
/**
* @deprecated Please use {Services_Twilio_TaskRouter_Worker_Capability.allowReservationUpdates} instead
*/
public function allowTaskReservationUpdates() {
$method = 'POST';
$queryFilter = array();
$postFilter = array();
$reservationsUrl = $this->baseUrl.'/Tasks/**';
$this->allow($reservationsUrl, $method, $queryFilter, $postFilter);
}
public function generateToken($ttl = 3600, $extraAttributes = null) {
$taskRouterAttributes = array(
'account_sid' => $this->accountSid,
'channel' => $this->channelId,
'workspace_sid' => $this->workspaceSid
);
if(substr($this->channelId,0,2) == 'WK') {
$taskRouterAttributes['worker_sid'] = $this->channelId;
}else if(substr($this->channelId,0,2) == 'WQ') {
$taskRouterAttributes['taskqueue_sid'] = $this->channelId;
}
return parent::generateToken($ttl, $taskRouterAttributes);
}
}
|