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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
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 datetime import datetime
from typing import Any, Dict, Optional, Union
from twilio.base import serialize, 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 WorkspaceStatisticsInstance(InstanceResource):
"""
:ivar realtime: An object that contains the real-time statistics for the Workspace.
:ivar cumulative: An object that contains the cumulative statistics for the Workspace.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workspace resource.
: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.realtime: Optional[Dict[str, object]] = payload.get("realtime")
self.cumulative: Optional[Dict[str, object]] = payload.get("cumulative")
self.account_sid: Optional[str] = payload.get("account_sid")
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[WorkspaceStatisticsContext] = None
@property
def _proxy(self) -> "WorkspaceStatisticsContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: WorkspaceStatisticsContext for this WorkspaceStatisticsInstance
"""
if self._context is None:
self._context = WorkspaceStatisticsContext(
self._version,
workspace_sid=self._solution["workspace_sid"],
)
return self._context
def fetch(
self,
minutes: Union[int, object] = values.unset,
start_date: Union[datetime, object] = values.unset,
end_date: Union[datetime, object] = values.unset,
task_channel: Union[str, object] = values.unset,
split_by_wait_time: Union[str, object] = values.unset,
) -> "WorkspaceStatisticsInstance":
"""
Fetch the WorkspaceStatisticsInstance
:param minutes: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
:param start_date: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:param end_date: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
:param task_channel: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
:returns: The fetched WorkspaceStatisticsInstance
"""
return self._proxy.fetch(
minutes=minutes,
start_date=start_date,
end_date=end_date,
task_channel=task_channel,
split_by_wait_time=split_by_wait_time,
)
async def fetch_async(
self,
minutes: Union[int, object] = values.unset,
start_date: Union[datetime, object] = values.unset,
end_date: Union[datetime, object] = values.unset,
task_channel: Union[str, object] = values.unset,
split_by_wait_time: Union[str, object] = values.unset,
) -> "WorkspaceStatisticsInstance":
"""
Asynchronous coroutine to fetch the WorkspaceStatisticsInstance
:param minutes: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
:param start_date: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:param end_date: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
:param task_channel: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
:returns: The fetched WorkspaceStatisticsInstance
"""
return await self._proxy.fetch_async(
minutes=minutes,
start_date=start_date,
end_date=end_date,
task_channel=task_channel,
split_by_wait_time=split_by_wait_time,
)
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.WorkspaceStatisticsInstance {}>".format(context)
class WorkspaceStatisticsContext(InstanceContext):
def __init__(self, version: Version, workspace_sid: str):
"""
Initialize the WorkspaceStatisticsContext
: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}/Statistics".format(**self._solution)
def fetch(
self,
minutes: Union[int, object] = values.unset,
start_date: Union[datetime, object] = values.unset,
end_date: Union[datetime, object] = values.unset,
task_channel: Union[str, object] = values.unset,
split_by_wait_time: Union[str, object] = values.unset,
) -> WorkspaceStatisticsInstance:
"""
Fetch the WorkspaceStatisticsInstance
:param minutes: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
:param start_date: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:param end_date: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
:param task_channel: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
:returns: The fetched WorkspaceStatisticsInstance
"""
data = values.of(
{
"Minutes": minutes,
"StartDate": serialize.iso8601_datetime(start_date),
"EndDate": serialize.iso8601_datetime(end_date),
"TaskChannel": task_channel,
"SplitByWaitTime": split_by_wait_time,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return WorkspaceStatisticsInstance(
self._version,
payload,
workspace_sid=self._solution["workspace_sid"],
)
async def fetch_async(
self,
minutes: Union[int, object] = values.unset,
start_date: Union[datetime, object] = values.unset,
end_date: Union[datetime, object] = values.unset,
task_channel: Union[str, object] = values.unset,
split_by_wait_time: Union[str, object] = values.unset,
) -> WorkspaceStatisticsInstance:
"""
Asynchronous coroutine to fetch the WorkspaceStatisticsInstance
:param minutes: Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
:param start_date: Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:param end_date: Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
:param task_channel: Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
:param split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
:returns: The fetched WorkspaceStatisticsInstance
"""
data = values.of(
{
"Minutes": minutes,
"StartDate": serialize.iso8601_datetime(start_date),
"EndDate": serialize.iso8601_datetime(end_date),
"TaskChannel": task_channel,
"SplitByWaitTime": split_by_wait_time,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return WorkspaceStatisticsInstance(
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.WorkspaceStatisticsContext {}>".format(context)
class WorkspaceStatisticsList(ListResource):
def __init__(self, version: Version, workspace_sid: str):
"""
Initialize the WorkspaceStatisticsList
: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) -> WorkspaceStatisticsContext:
"""
Constructs a WorkspaceStatisticsContext
"""
return WorkspaceStatisticsContext(
self._version, workspace_sid=self._solution["workspace_sid"]
)
def __call__(self) -> WorkspaceStatisticsContext:
"""
Constructs a WorkspaceStatisticsContext
"""
return WorkspaceStatisticsContext(
self._version, workspace_sid=self._solution["workspace_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Taskrouter.V1.WorkspaceStatisticsList>"
|
