Source code for twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics

# 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 TaskQueueStatisticsList(ListResource): def __init__(self, version, workspace_sid, task_queue_sid): """ Initialize the TaskQueueStatisticsList :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace that contains the TaskQueue :param task_queue_sid: The SID of the TaskQueue from which these statistics were calculated :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsList :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsList """ super(TaskQueueStatisticsList, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, 'task_queue_sid': task_queue_sid, }
[docs] def get(self): """ Constructs a TaskQueueStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext """ return TaskQueueStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], task_queue_sid=self._solution['task_queue_sid'], )
def __call__(self): """ Constructs a TaskQueueStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext """ return TaskQueueStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], task_queue_sid=self._solution['task_queue_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Taskrouter.V1.TaskQueueStatisticsList>'
[docs]class TaskQueueStatisticsPage(Page): def __init__(self, version, response, solution): """ Initialize the TaskQueueStatisticsPage :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 TaskQueue :param task_queue_sid: The SID of the TaskQueue from which these statistics were calculated :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsPage :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsPage """ super(TaskQueueStatisticsPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of TaskQueueStatisticsInstance :param dict payload: Payload response from the API :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance """ return TaskQueueStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_sid'], task_queue_sid=self._solution['task_queue_sid'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Taskrouter.V1.TaskQueueStatisticsPage>'
[docs]class TaskQueueStatisticsContext(InstanceContext): def __init__(self, version, workspace_sid, task_queue_sid): """ Initialize the TaskQueueStatisticsContext :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace with the TaskQueue to fetch :param task_queue_sid: The SID of the TaskQueue for which to fetch statistics :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext """ super(TaskQueueStatisticsContext, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, 'task_queue_sid': task_queue_sid, } self._uri = '/Workspaces/{workspace_sid}/TaskQueues/{task_queue_sid}/Statistics'.format(**self._solution)
[docs] def fetch(self, end_date=values.unset, minutes=values.unset, start_date=values.unset, task_channel=values.unset, split_by_wait_time=values.unset): """ Fetch the TaskQueueStatisticsInstance :param datetime end_date: Only calculate statistics from on or before this date :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 unicode task_channel: Only calculate real-time and cumulative statistics for the specified TaskChannel :param unicode split_by_wait_time: A comma separated list of values that describes the thresholds to calculate statistics on :returns: The fetched TaskQueueStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance """ data = values.of({ 'EndDate': serialize.iso8601_datetime(end_date), 'Minutes': minutes, 'StartDate': serialize.iso8601_datetime(start_date), 'TaskChannel': task_channel, 'SplitByWaitTime': split_by_wait_time, }) payload = self._version.fetch(method='GET', uri=self._uri, params=data, ) return TaskQueueStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_sid'], task_queue_sid=self._solution['task_queue_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.TaskQueueStatisticsContext {}>'.format(context)
[docs]class TaskQueueStatisticsInstance(InstanceResource): def __init__(self, version, payload, workspace_sid, task_queue_sid): """ Initialize the TaskQueueStatisticsInstance :returns: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance """ super(TaskQueueStatisticsInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'cumulative': payload.get('cumulative'), 'realtime': payload.get('realtime'), 'task_queue_sid': payload.get('task_queue_sid'), 'workspace_sid': payload.get('workspace_sid'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'workspace_sid': workspace_sid, 'task_queue_sid': task_queue_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: TaskQueueStatisticsContext for this TaskQueueStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsContext """ if self._context is None: self._context = TaskQueueStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], task_queue_sid=self._solution['task_queue_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 TaskQueue :rtype: dict """ return self._properties['cumulative'] @property def realtime(self): """ :returns: An object that contains the real-time statistics for the TaskQueue :rtype: dict """ return self._properties['realtime'] @property def task_queue_sid(self): """ :returns: The SID of the TaskQueue from which these statistics were calculated :rtype: unicode """ return self._properties['task_queue_sid'] @property def workspace_sid(self): """ :returns: The SID of the Workspace that contains the TaskQueue :rtype: unicode """ return self._properties['workspace_sid'] @property def url(self): """ :returns: The absolute URL of the TaskQueue statistics resource :rtype: unicode """ return self._properties['url']
[docs] def fetch(self, end_date=values.unset, minutes=values.unset, start_date=values.unset, task_channel=values.unset, split_by_wait_time=values.unset): """ Fetch the TaskQueueStatisticsInstance :param datetime end_date: Only calculate statistics from on or before this date :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 unicode task_channel: Only calculate real-time and cumulative statistics for the specified TaskChannel :param unicode split_by_wait_time: A comma separated list of values that describes the thresholds to calculate statistics on :returns: The fetched TaskQueueStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.task_queue.task_queue_statistics.TaskQueueStatisticsInstance """ return self._proxy.fetch( end_date=end_date, minutes=minutes, start_date=start_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.TaskQueueStatisticsInstance {}>'.format(context)