# coding=utf-8 r""" This code was generated by \ / _ _ _| _ _ | (_)\/(_)(_|\/| |(/_ v1.0.0 / / """ from twilio.base import deserialize 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 class WorkspaceCumulativeStatisticsList(ListResource): def __init__(self, version, workspace_sid): """ Initialize the WorkspaceCumulativeStatisticsList :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsList :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsList """ super(WorkspaceCumulativeStatisticsList, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, } def get(self): """ Constructs a WorkspaceCumulativeStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext """ return WorkspaceCumulativeStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], ) def __call__(self): """ Constructs a WorkspaceCumulativeStatisticsContext :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext """ return WorkspaceCumulativeStatisticsContext( self._version, workspace_sid=self._solution['workspace_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class WorkspaceCumulativeStatisticsPage(Page): def __init__(self, version, response, solution): """ Initialize the WorkspaceCumulativeStatisticsPage :param Version version: Version that contains the resource :param Response response: Response from the API :param workspace_sid: The SID of the Workspace :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsPage :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsPage """ super(WorkspaceCumulativeStatisticsPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of WorkspaceCumulativeStatisticsInstance :param dict payload: Payload response from the API :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance """ return WorkspaceCumulativeStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class WorkspaceCumulativeStatisticsContext(InstanceContext): def __init__(self, version, workspace_sid): """ Initialize the WorkspaceCumulativeStatisticsContext :param Version version: Version that contains the resource :param workspace_sid: The SID of the Workspace to fetch :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext """ super(WorkspaceCumulativeStatisticsContext, self).__init__(version) # Path Solution self._solution = {'workspace_sid': workspace_sid, } self._uri = '/Workspaces/{workspace_sid}/CumulativeStatistics'.format(**self._solution) 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 WorkspaceCumulativeStatisticsInstance :param datetime end_date: Only include usage that occurred 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 cumulative statistics on this TaskChannel :param unicode split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on :returns: The fetched WorkspaceCumulativeStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance """ 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 WorkspaceCumulativeStatisticsInstance( self._version, payload, workspace_sid=self._solution['workspace_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 ''.format(context) class WorkspaceCumulativeStatisticsInstance(InstanceResource): def __init__(self, version, payload, workspace_sid): """ Initialize the WorkspaceCumulativeStatisticsInstance :returns: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance """ super(WorkspaceCumulativeStatisticsInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'avg_task_acceptance_time': deserialize.integer(payload.get('avg_task_acceptance_time')), 'start_time': deserialize.iso8601_datetime(payload.get('start_time')), 'end_time': deserialize.iso8601_datetime(payload.get('end_time')), 'reservations_created': deserialize.integer(payload.get('reservations_created')), 'reservations_accepted': deserialize.integer(payload.get('reservations_accepted')), 'reservations_rejected': deserialize.integer(payload.get('reservations_rejected')), 'reservations_timed_out': deserialize.integer(payload.get('reservations_timed_out')), 'reservations_canceled': deserialize.integer(payload.get('reservations_canceled')), 'reservations_rescinded': deserialize.integer(payload.get('reservations_rescinded')), 'split_by_wait_time': payload.get('split_by_wait_time'), 'wait_duration_until_accepted': payload.get('wait_duration_until_accepted'), 'wait_duration_until_canceled': payload.get('wait_duration_until_canceled'), 'tasks_canceled': deserialize.integer(payload.get('tasks_canceled')), 'tasks_completed': deserialize.integer(payload.get('tasks_completed')), 'tasks_created': deserialize.integer(payload.get('tasks_created')), 'tasks_deleted': deserialize.integer(payload.get('tasks_deleted')), 'tasks_moved': deserialize.integer(payload.get('tasks_moved')), 'tasks_timed_out_in_workflow': deserialize.integer(payload.get('tasks_timed_out_in_workflow')), 'workspace_sid': payload.get('workspace_sid'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'workspace_sid': workspace_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: WorkspaceCumulativeStatisticsContext for this WorkspaceCumulativeStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsContext """ if self._context is None: self._context = WorkspaceCumulativeStatisticsContext( self._version, workspace_sid=self._solution['workspace_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 avg_task_acceptance_time(self): """ :returns: The average time in seconds between Task creation and acceptance :rtype: unicode """ return self._properties['avg_task_acceptance_time'] @property def start_time(self): """ :returns: The beginning of the interval during which these statistics were calculated :rtype: datetime """ return self._properties['start_time'] @property def end_time(self): """ :returns: The end of the interval during which these statistics were calculated :rtype: datetime """ return self._properties['end_time'] @property def reservations_created(self): """ :returns: The total number of Reservations that were created for Workers :rtype: unicode """ return self._properties['reservations_created'] @property def reservations_accepted(self): """ :returns: The total number of Reservations accepted by Workers :rtype: unicode """ return self._properties['reservations_accepted'] @property def reservations_rejected(self): """ :returns: The total number of Reservations that were rejected :rtype: unicode """ return self._properties['reservations_rejected'] @property def reservations_timed_out(self): """ :returns: The total number of Reservations that were timed out :rtype: unicode """ return self._properties['reservations_timed_out'] @property def reservations_canceled(self): """ :returns: The total number of Reservations that were canceled :rtype: unicode """ return self._properties['reservations_canceled'] @property def reservations_rescinded(self): """ :returns: The total number of Reservations that were rescinded :rtype: unicode """ return self._properties['reservations_rescinded'] @property def split_by_wait_time(self): """ :returns: A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds :rtype: dict """ return self._properties['split_by_wait_time'] @property def wait_duration_until_accepted(self): """ :returns: The wait duration statistics for Tasks that were accepted :rtype: dict """ return self._properties['wait_duration_until_accepted'] @property def wait_duration_until_canceled(self): """ :returns: The wait duration statistics for Tasks that were canceled :rtype: dict """ return self._properties['wait_duration_until_canceled'] @property def tasks_canceled(self): """ :returns: The total number of Tasks that were canceled :rtype: unicode """ return self._properties['tasks_canceled'] @property def tasks_completed(self): """ :returns: The total number of Tasks that were completed :rtype: unicode """ return self._properties['tasks_completed'] @property def tasks_created(self): """ :returns: The total number of Tasks created :rtype: unicode """ return self._properties['tasks_created'] @property def tasks_deleted(self): """ :returns: The total number of Tasks that were deleted :rtype: unicode """ return self._properties['tasks_deleted'] @property def tasks_moved(self): """ :returns: The total number of Tasks that were moved from one queue to another :rtype: unicode """ return self._properties['tasks_moved'] @property def tasks_timed_out_in_workflow(self): """ :returns: The total number of Tasks that were timed out of their Workflows :rtype: unicode """ return self._properties['tasks_timed_out_in_workflow'] @property def workspace_sid(self): """ :returns: The SID of the Workspace :rtype: unicode """ return self._properties['workspace_sid'] @property def url(self): """ :returns: The absolute URL of the Workspace statistics resource :rtype: unicode """ return self._properties['url'] 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 WorkspaceCumulativeStatisticsInstance :param datetime end_date: Only include usage that occurred 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 cumulative statistics on this TaskChannel :param unicode split_by_wait_time: A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on :returns: The fetched WorkspaceCumulativeStatisticsInstance :rtype: twilio.rest.taskrouter.v1.workspace.workspace_cumulative_statistics.WorkspaceCumulativeStatisticsInstance """ 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 ''.format(context)