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, List, Optional, Union, Iterator, AsyncIterator from twilio.base import deserialize, 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 from twilio.base.page import Page class EventInstance(InstanceResource): """ :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Event resource. :ivar actor_sid: The SID of the resource that triggered the event. :ivar actor_type: The type of resource that triggered the event. :ivar actor_url: The absolute URL of the resource that triggered the event. :ivar description: A description of the event. :ivar event_data: Data about the event. For more information, see [Event types](https://www.twilio.com/docs/taskrouter/api/event#event-types). :ivar event_date: The time the event was sent, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. :ivar event_date_ms: The time the event was sent in milliseconds. :ivar event_type: The identifier for the event. :ivar resource_sid: The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid. :ivar resource_type: The type of object the event is most relevant to, such as a Task, Reservation, or a Worker). :ivar resource_url: The URL of the resource the event is most relevant to. :ivar sid: The unique string that we created to identify the Event resource. :ivar source: Where the Event originated. :ivar source_ip_address: The IP from which the Event originated. :ivar url: The absolute URL of the Event resource. :ivar workspace_sid: The SID of the Workspace that contains the Event. """ def __init__( self, version: Version, payload: Dict[str, Any], workspace_sid: str, sid: Optional[str] = None, ): super().__init__(version) self.account_sid: Optional[str] = payload.get("account_sid") self.actor_sid: Optional[str] = payload.get("actor_sid") self.actor_type: Optional[str] = payload.get("actor_type") self.actor_url: Optional[str] = payload.get("actor_url") self.description: Optional[str] = payload.get("description") self.event_data: Optional[Dict[str, object]] = payload.get("event_data") self.event_date: Optional[datetime] = deserialize.iso8601_datetime( payload.get("event_date") ) self.event_date_ms: Optional[int] = payload.get("event_date_ms") self.event_type: Optional[str] = payload.get("event_type") self.resource_sid: Optional[str] = payload.get("resource_sid") self.resource_type: Optional[str] = payload.get("resource_type") self.resource_url: Optional[str] = payload.get("resource_url") self.sid: Optional[str] = payload.get("sid") self.source: Optional[str] = payload.get("source") self.source_ip_address: Optional[str] = payload.get("source_ip_address") self.url: Optional[str] = payload.get("url") self.workspace_sid: Optional[str] = payload.get("workspace_sid") self._solution = { "workspace_sid": workspace_sid, "sid": sid or self.sid, } self._context: Optional[EventContext] = None @property def _proxy(self) -> "EventContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: EventContext for this EventInstance """ if self._context is None: self._context = EventContext( self._version, workspace_sid=self._solution["workspace_sid"], sid=self._solution["sid"], ) return self._context def fetch(self) -> "EventInstance": """ Fetch the EventInstance :returns: The fetched EventInstance """ return self._proxy.fetch() async def fetch_async(self) -> "EventInstance": """ Asynchronous coroutine to fetch the EventInstance :returns: The fetched EventInstance """ return await self._proxy.fetch_async() 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 "".format(context) class EventContext(InstanceContext): def __init__(self, version: Version, workspace_sid: str, sid: str): """ Initialize the EventContext :param version: Version that contains the resource :param workspace_sid: The SID of the Workspace with the Event to fetch. :param sid: The SID of the Event resource to fetch. """ super().__init__(version) # Path Solution self._solution = { "workspace_sid": workspace_sid, "sid": sid, } self._uri = "/Workspaces/{workspace_sid}/Events/{sid}".format(**self._solution) def fetch(self) -> EventInstance: """ Fetch the EventInstance :returns: The fetched EventInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return EventInstance( self._version, payload, workspace_sid=self._solution["workspace_sid"], sid=self._solution["sid"], ) async def fetch_async(self) -> EventInstance: """ Asynchronous coroutine to fetch the EventInstance :returns: The fetched EventInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return EventInstance( self._version, payload, workspace_sid=self._solution["workspace_sid"], sid=self._solution["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 "".format(context) class EventPage(Page): def get_instance(self, payload: Dict[str, Any]) -> EventInstance: """ Build an instance of EventInstance :param payload: Payload response from the API """ return EventInstance( self._version, payload, workspace_sid=self._solution["workspace_sid"] ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class EventList(ListResource): def __init__(self, version: Version, workspace_sid: str): """ Initialize the EventList :param version: Version that contains the resource :param workspace_sid: The SID of the Workspace with the Events to read. Returns only the Events that pertain to the specified Workspace. """ super().__init__(version) # Path Solution self._solution = { "workspace_sid": workspace_sid, } self._uri = "/Workspaces/{workspace_sid}/Events".format(**self._solution) def stream( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[EventInstance]: """ Streams EventInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient. :param datetime end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param str event_type: The type of Events to read. Returns only Events of the type specified. :param int minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param str reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param datetime start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param str task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param str task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param str worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param str workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param str task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param str sid: The SID of the Event resource to read. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: Generator that will yield up to limit results """ limits = self._version.read_limits(limit, page_size) page = self.page( end_date=end_date, event_type=event_type, minutes=minutes, reservation_sid=reservation_sid, start_date=start_date, task_queue_sid=task_queue_sid, task_sid=task_sid, worker_sid=worker_sid, workflow_sid=workflow_sid, task_channel=task_channel, sid=sid, page_size=limits["page_size"], ) return self._version.stream(page, limits["limit"]) async def stream_async( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[EventInstance]: """ Asynchronously streams EventInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient. :param datetime end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param str event_type: The type of Events to read. Returns only Events of the type specified. :param int minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param str reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param datetime start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param str task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param str task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param str worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param str workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param str task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param str sid: The SID of the Event resource to read. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: Generator that will yield up to limit results """ limits = self._version.read_limits(limit, page_size) page = await self.page_async( end_date=end_date, event_type=event_type, minutes=minutes, reservation_sid=reservation_sid, start_date=start_date, task_queue_sid=task_queue_sid, task_sid=task_sid, worker_sid=worker_sid, workflow_sid=workflow_sid, task_channel=task_channel, sid=sid, page_size=limits["page_size"], ) return self._version.stream_async(page, limits["limit"]) def list( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[EventInstance]: """ Lists EventInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param datetime end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param str event_type: The type of Events to read. Returns only Events of the type specified. :param int minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param str reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param datetime start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param str task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param str task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param str worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param str workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param str task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param str sid: The SID of the Event resource to read. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: list that will contain up to limit results """ return list( self.stream( end_date=end_date, event_type=event_type, minutes=minutes, reservation_sid=reservation_sid, start_date=start_date, task_queue_sid=task_queue_sid, task_sid=task_sid, worker_sid=worker_sid, workflow_sid=workflow_sid, task_channel=task_channel, sid=sid, limit=limit, page_size=page_size, ) ) async def list_async( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[EventInstance]: """ Asynchronously lists EventInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param datetime end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param str event_type: The type of Events to read. Returns only Events of the type specified. :param int minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param str reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param datetime start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param str task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param str task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param str worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param str workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param str task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param str sid: The SID of the Event resource to read. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param page_size: Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000) :returns: list that will contain up to limit results """ return [ record async for record in await self.stream_async( end_date=end_date, event_type=event_type, minutes=minutes, reservation_sid=reservation_sid, start_date=start_date, task_queue_sid=task_queue_sid, task_sid=task_sid, worker_sid=worker_sid, workflow_sid=workflow_sid, task_channel=task_channel, sid=sid, limit=limit, page_size=page_size, ) ] def page( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> EventPage: """ Retrieve a single page of EventInstance records from the API. Request is executed immediately :param end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param event_type: The type of Events to read. Returns only Events of the type specified. :param minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param sid: The SID of the Event resource to read. :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of EventInstance """ data = values.of( { "EndDate": serialize.iso8601_datetime(end_date), "EventType": event_type, "Minutes": minutes, "ReservationSid": reservation_sid, "StartDate": serialize.iso8601_datetime(start_date), "TaskQueueSid": task_queue_sid, "TaskSid": task_sid, "WorkerSid": worker_sid, "WorkflowSid": workflow_sid, "TaskChannel": task_channel, "Sid": sid, "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return EventPage(self._version, response, self._solution) async def page_async( self, end_date: Union[datetime, object] = values.unset, event_type: Union[str, object] = values.unset, minutes: Union[int, object] = values.unset, reservation_sid: Union[str, object] = values.unset, start_date: Union[datetime, object] = values.unset, task_queue_sid: Union[str, object] = values.unset, task_sid: Union[str, object] = values.unset, worker_sid: Union[str, object] = values.unset, workflow_sid: Union[str, object] = values.unset, task_channel: Union[str, object] = values.unset, sid: Union[str, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> EventPage: """ Asynchronously retrieve a single page of EventInstance records from the API. Request is executed immediately :param end_date: Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time. :param event_type: The type of Events to read. Returns only Events of the type specified. :param minutes: The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted. :param reservation_sid: The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation. :param start_date: Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted. :param task_queue_sid: The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue. :param task_sid: The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task. :param worker_sid: The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker. :param workflow_sid: The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow. :param task_channel: The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel. :param sid: The SID of the Event resource to read. :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of EventInstance """ data = values.of( { "EndDate": serialize.iso8601_datetime(end_date), "EventType": event_type, "Minutes": minutes, "ReservationSid": reservation_sid, "StartDate": serialize.iso8601_datetime(start_date), "TaskQueueSid": task_queue_sid, "TaskSid": task_sid, "WorkerSid": worker_sid, "WorkflowSid": workflow_sid, "TaskChannel": task_channel, "Sid": sid, "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return EventPage(self._version, response, self._solution) def get_page(self, target_url: str) -> EventPage: """ Retrieve a specific page of EventInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of EventInstance """ response = self._version.domain.twilio.request("GET", target_url) return EventPage(self._version, response, self._solution) async def get_page_async(self, target_url: str) -> EventPage: """ Asynchronously retrieve a specific page of EventInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of EventInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return EventPage(self._version, response, self._solution) def get(self, sid: str) -> EventContext: """ Constructs a EventContext :param sid: The SID of the Event resource to fetch. """ return EventContext( self._version, workspace_sid=self._solution["workspace_sid"], sid=sid ) def __call__(self, sid: str) -> EventContext: """ Constructs a EventContext :param sid: The SID of the Event resource to fetch. """ return EventContext( self._version, workspace_sid=self._solution["workspace_sid"], sid=sid ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""