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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Taskrouter
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from typing import Any, Dict, List, Optional, Union
from twilio.base import deserialize, values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class WorkspaceRealTimeStatisticsInstance(InstanceResource):
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource.
:ivar activity_statistics: The number of current Workers by Activity.
:ivar longest_task_waiting_age: The age of the longest waiting Task.
:ivar longest_task_waiting_sid: The SID of the longest waiting Task.
:ivar tasks_by_priority: The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99.
:ivar tasks_by_status: The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`.
:ivar total_tasks: The total number of Tasks.
:ivar total_workers: The total number of Workers in the Workspace.
:ivar workspace_sid: The SID of the Workspace.
:ivar url: The absolute URL of the Workspace statistics resource.
"""
def __init__(self, version: Version, payload: Dict[str, Any], workspace_sid: str):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.activity_statistics: Optional[List[Dict[str, object]]] = payload.get(
"activity_statistics"
)
self.longest_task_waiting_age: Optional[int] = deserialize.integer(
payload.get("longest_task_waiting_age")
)
self.longest_task_waiting_sid: Optional[str] = payload.get(
"longest_task_waiting_sid"
)
self.tasks_by_priority: Optional[Dict[str, object]] = payload.get(
"tasks_by_priority"
)
self.tasks_by_status: Optional[Dict[str, object]] = payload.get(
"tasks_by_status"
)
self.total_tasks: Optional[int] = deserialize.integer(
payload.get("total_tasks")
)
self.total_workers: Optional[int] = deserialize.integer(
payload.get("total_workers")
)
self.workspace_sid: Optional[str] = payload.get("workspace_sid")
self.url: Optional[str] = payload.get("url")
self._solution = {
"workspace_sid": workspace_sid,
}
self._context: Optional[WorkspaceRealTimeStatisticsContext] = None
@property
def _proxy(self) -> "WorkspaceRealTimeStatisticsContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: WorkspaceRealTimeStatisticsContext for this WorkspaceRealTimeStatisticsInstance
"""
if self._context is None:
self._context = WorkspaceRealTimeStatisticsContext(
self._version,
workspace_sid=self._solution["workspace_sid"],
)
return self._context
def fetch(
self, task_channel: Union[str, object] = values.unset
) -> "WorkspaceRealTimeStatisticsInstance":
"""
Fetch the WorkspaceRealTimeStatisticsInstance
:param task_channel: Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:returns: The fetched WorkspaceRealTimeStatisticsInstance
"""
return self._proxy.fetch(
task_channel=task_channel,
)
async def fetch_async(
self, task_channel: Union[str, object] = values.unset
) -> "WorkspaceRealTimeStatisticsInstance":
"""
Asynchronous coroutine to fetch the WorkspaceRealTimeStatisticsInstance
:param task_channel: Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:returns: The fetched WorkspaceRealTimeStatisticsInstance
"""
return await self._proxy.fetch_async(
task_channel=task_channel,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Taskrouter.V1.WorkspaceRealTimeStatisticsInstance {}>".format(
context
)
class WorkspaceRealTimeStatisticsContext(InstanceContext):
def __init__(self, version: Version, workspace_sid: str):
"""
Initialize the WorkspaceRealTimeStatisticsContext
:param version: Version that contains the resource
:param workspace_sid: The SID of the Workspace to fetch.
"""
super().__init__(version)
# Path Solution
self._solution = {
"workspace_sid": workspace_sid,
}
self._uri = "/Workspaces/{workspace_sid}/RealTimeStatistics".format(
**self._solution
)
def fetch(
self, task_channel: Union[str, object] = values.unset
) -> WorkspaceRealTimeStatisticsInstance:
"""
Fetch the WorkspaceRealTimeStatisticsInstance
:param task_channel: Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:returns: The fetched WorkspaceRealTimeStatisticsInstance
"""
data = values.of(
{
"TaskChannel": task_channel,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return WorkspaceRealTimeStatisticsInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
)
async def fetch_async(
self, task_channel: Union[str, object] = values.unset
) -> WorkspaceRealTimeStatisticsInstance:
"""
Asynchronous coroutine to fetch the WorkspaceRealTimeStatisticsInstance
:param task_channel: Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:returns: The fetched WorkspaceRealTimeStatisticsInstance
"""
data = values.of(
{
"TaskChannel": task_channel,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return WorkspaceRealTimeStatisticsInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Taskrouter.V1.WorkspaceRealTimeStatisticsContext {}>".format(
context
)
class WorkspaceRealTimeStatisticsList(ListResource):
def __init__(self, version: Version, workspace_sid: str):
"""
Initialize the WorkspaceRealTimeStatisticsList
:param version: Version that contains the resource
:param workspace_sid: The SID of the Workspace to fetch.
"""
super().__init__(version)
# Path Solution
self._solution = {
"workspace_sid": workspace_sid,
}
def get(self) -> WorkspaceRealTimeStatisticsContext:
"""
Constructs a WorkspaceRealTimeStatisticsContext
"""
return WorkspaceRealTimeStatisticsContext(
self._version, workspace_sid=self._solution["workspace_sid"]
)
def __call__(self) -> WorkspaceRealTimeStatisticsContext:
"""
Constructs a WorkspaceRealTimeStatisticsContext
"""
return WorkspaceRealTimeStatisticsContext(
self._version, workspace_sid=self._solution["workspace_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Taskrouter.V1.WorkspaceRealTimeStatisticsList>"
|
