Source code for twilio.rest.taskrouter.v1.workspace.worker.worker_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 WorkerStatisticsList(ListResource): def __init__(self, version, workspace_sid, worker_sid): """ Initialize the WorkerStatisticsList :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace that contains the WorkerChannel :param worker_sid: The SID of the Worker that contains the WorkerChannel :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList """ super(WorkerStatisticsList, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, 'worker_sid': worker_sid, }
[docs] def get(self): """ Constructs a WorkerStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext """ return WorkerStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], worker_sid=self._solution['worker_sid'], )
def __call__(self): """ Constructs a WorkerStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext """ return WorkerStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], worker_sid=self._solution['worker_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Taskrouter.V1.WorkerStatisticsList>'
[docs]class WorkerStatisticsPage(Page): def __init__(self, version, response, solution): """ Initialize the WorkerStatisticsPage :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 WorkerChannel :param worker_sid: The SID of the Worker that contains the WorkerChannel :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsPage :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsPage """ super(WorkerStatisticsPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of WorkerStatisticsInstance :param dict payload: Payload response from the API :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance """ return WorkerStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_sid'], worker_sid=self._solution['worker_sid'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Taskrouter.V1.WorkerStatisticsPage>'
[docs]class WorkerStatisticsContext(InstanceContext): def __init__(self, version, workspace_sid, worker_sid): """ Initialize the WorkerStatisticsContext :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace with the WorkerChannel to fetch :param worker_sid: The SID of the Worker with the WorkerChannel to fetch :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext """ super(WorkerStatisticsContext, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, 'worker_sid': worker_sid, } self._uri = '/Workspaces/{workspace_sid}/Workers/{worker_sid}/Statistics'.format(**self._solution)
[docs] def fetch(self, minutes=values.unset, start_date=values.unset, end_date=values.unset, task_channel=values.unset): """ Fetch the WorkerStatisticsInstance :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 include usage that occurred on or before this date :param unicode task_channel: Only calculate statistics on this TaskChannel :returns: The fetched WorkerStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance """ data = values.of({ 'Minutes': minutes, 'StartDate': serialize.iso8601_datetime(start_date), 'EndDate': serialize.iso8601_datetime(end_date), 'TaskChannel': task_channel, }) payload = self._version.fetch(method='GET', uri=self._uri, params=data, ) return WorkerStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_sid'], worker_sid=self._solution['worker_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.WorkerStatisticsContext {}>'.format(context)
[docs]class WorkerStatisticsInstance(InstanceResource): def __init__(self, version, payload, workspace_sid, worker_sid): """ Initialize the WorkerStatisticsInstance :returns: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance """ super(WorkerStatisticsInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'cumulative': payload.get('cumulative'), 'worker_sid': payload.get('worker_sid'), 'workspace_sid': payload.get('workspace_sid'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'workspace_sid': workspace_sid, 'worker_sid': worker_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: WorkerStatisticsContext for this WorkerStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext """ if self._context is None: self._context = WorkerStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], worker_sid=self._solution['worker_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 Worker :rtype: dict """ return self._properties['cumulative'] @property def worker_sid(self): """ :returns: The SID of the Worker that contains the WorkerChannel :rtype: unicode """ return self._properties['worker_sid'] @property def workspace_sid(self): """ :returns: The SID of the Workspace that contains the WorkerChannel :rtype: unicode """ return self._properties['workspace_sid'] @property def url(self): """ :returns: The absolute URL of the WorkerChannel 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): """ Fetch the WorkerStatisticsInstance :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 include usage that occurred on or before this date :param unicode task_channel: Only calculate statistics on this TaskChannel :returns: The fetched WorkerStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance """ return self._proxy.fetch( minutes=minutes, start_date=start_date, end_date=end_date, task_channel=task_channel, )
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.WorkerStatisticsInstance {}>'.format(context)