# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import serialize
from twilio.base import 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.page import Page
[docs]class WorkflowStatisticsList(ListResource):
def __init__(self, version, workspace_sid, workflow_sid):
"""
Initialize the WorkflowStatisticsList
:param Version version: Version that contains the resource
:param workspace_sid: The SID of the Workspace that contains the Workflow
:param workflow_sid: Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsList
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsList
"""
super(WorkflowStatisticsList, self).__init__(version)
# Path Solution
self._solution = {'workspace_sid': workspace_sid, 'workflow_sid': workflow_sid, }
[docs] def get(self):
"""
Constructs a WorkflowStatisticsContext
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
"""
return WorkflowStatisticsContext(
self._version,
workspace_sid=self._solution['workspace_sid'],
workflow_sid=self._solution['workflow_sid'],
)
def __call__(self):
"""
Constructs a WorkflowStatisticsContext
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
"""
return WorkflowStatisticsContext(
self._version,
workspace_sid=self._solution['workspace_sid'],
workflow_sid=self._solution['workflow_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Taskrouter.V1.WorkflowStatisticsList>'
[docs]class WorkflowStatisticsPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the WorkflowStatisticsPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param workspace_sid: The SID of the Workspace that contains the Workflow
:param workflow_sid: Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsPage
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsPage
"""
super(WorkflowStatisticsPage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of WorkflowStatisticsInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
"""
return WorkflowStatisticsInstance(
self._version,
payload,
workspace_sid=self._solution['workspace_sid'],
workflow_sid=self._solution['workflow_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Taskrouter.V1.WorkflowStatisticsPage>'
[docs]class WorkflowStatisticsContext(InstanceContext):
def __init__(self, version, workspace_sid, workflow_sid):
"""
Initialize the WorkflowStatisticsContext
:param Version version: Version that contains the resource
:param workspace_sid: The SID of the Workspace with the Workflow to fetch
:param workflow_sid: Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
"""
super(WorkflowStatisticsContext, self).__init__(version)
# Path Solution
self._solution = {'workspace_sid': workspace_sid, 'workflow_sid': workflow_sid, }
self._uri = '/Workspaces/{workspace_sid}/Workflows/{workflow_sid}/Statistics'.format(**self._solution)
[docs] def fetch(self, minutes=values.unset, start_date=values.unset,
end_date=values.unset, task_channel=values.unset,
split_by_wait_time=values.unset):
"""
Fetch the WorkflowStatisticsInstance
:param unicode minutes: Only calculate statistics since this many minutes in the past
:param datetime start_date: Only calculate statistics from on or after this date
:param datetime end_date: Only calculate statistics from this date and time and earlier
:param unicode task_channel: Only calculate real-time statistics on this TaskChannel.
:param unicode split_by_wait_time: A comma separated list of values that describes the thresholds to calculate statistics on
:returns: The fetched WorkflowStatisticsInstance
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
"""
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,
})
payload = self._version.fetch(method='GET', uri=self._uri, params=data, )
return WorkflowStatisticsInstance(
self._version,
payload,
workspace_sid=self._solution['workspace_sid'],
workflow_sid=self._solution['workflow_sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Taskrouter.V1.WorkflowStatisticsContext {}>'.format(context)
[docs]class WorkflowStatisticsInstance(InstanceResource):
def __init__(self, version, payload, workspace_sid, workflow_sid):
"""
Initialize the WorkflowStatisticsInstance
:returns: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
"""
super(WorkflowStatisticsInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'cumulative': payload.get('cumulative'),
'realtime': payload.get('realtime'),
'workflow_sid': payload.get('workflow_sid'),
'workspace_sid': payload.get('workspace_sid'),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {'workspace_sid': workspace_sid, 'workflow_sid': workflow_sid, }
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: WorkflowStatisticsContext for this WorkflowStatisticsInstance
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsContext
"""
if self._context is None:
self._context = WorkflowStatisticsContext(
self._version,
workspace_sid=self._solution['workspace_sid'],
workflow_sid=self._solution['workflow_sid'],
)
return self._context
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def cumulative(self):
"""
:returns: An object that contains the cumulative statistics for the Workflow
:rtype: dict
"""
return self._properties['cumulative']
@property
def realtime(self):
"""
:returns: An object that contains the real-time statistics for the Workflow
:rtype: dict
"""
return self._properties['realtime']
@property
def workflow_sid(self):
"""
:returns: Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
:rtype: unicode
"""
return self._properties['workflow_sid']
@property
def workspace_sid(self):
"""
:returns: The SID of the Workspace that contains the Workflow
:rtype: unicode
"""
return self._properties['workspace_sid']
@property
def url(self):
"""
:returns: The absolute URL of the Workflow statistics resource
:rtype: unicode
"""
return self._properties['url']
[docs] def fetch(self, minutes=values.unset, start_date=values.unset,
end_date=values.unset, task_channel=values.unset,
split_by_wait_time=values.unset):
"""
Fetch the WorkflowStatisticsInstance
:param unicode minutes: Only calculate statistics since this many minutes in the past
:param datetime start_date: Only calculate statistics from on or after this date
:param datetime end_date: Only calculate statistics from this date and time and earlier
:param unicode task_channel: Only calculate real-time statistics on this TaskChannel.
:param unicode split_by_wait_time: A comma separated list of values that describes the thresholds to calculate statistics on
:returns: The fetched WorkflowStatisticsInstance
:rtype: twilio.rest.taskrouter.v1.workspace.workflow.workflow_statistics.WorkflowStatisticsInstance
"""
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,
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Taskrouter.V1.WorkflowStatisticsInstance {}>'.format(context)