# coding=utf-8 """ 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 from twilio.rest.video.v1.room.recording import RoomRecordingList from twilio.rest.video.v1.room.room_participant import ParticipantList class RoomList(ListResource): """ """ def __init__(self, version): """ Initialize the RoomList :param Version version: Version that contains the resource :returns: twilio.rest.video.v1.room.RoomList :rtype: twilio.rest.video.v1.room.RoomList """ super(RoomList, self).__init__(version) # Path Solution self._solution = {} self._uri = '/Rooms'.format(**self._solution) def create(self, enable_turn=values.unset, type=values.unset, unique_name=values.unset, status_callback=values.unset, status_callback_method=values.unset, max_participants=values.unset, record_participants_on_connect=values.unset, video_codecs=values.unset, media_region=values.unset): """ Create a new RoomInstance :param bool enable_turn: Use Twilio Network Traversal for TURN service. :param RoomInstance.RoomType type: Type of room, either peer-to-peer, group-small or group. :param unicode unique_name: Name of the Room. :param unicode status_callback: A URL that Twilio sends asynchronous webhook requests to on every room event. :param unicode status_callback_method: HTTP method Twilio should use when requesting the above URL. :param unicode max_participants: Maximum number of Participants in the Room. :param bool record_participants_on_connect: Start Participant recording when connected. :param RoomInstance.VideoCodec video_codecs: An array of video codecs supported when publishing a Track in the Room. :param unicode media_region: Region for the media server in Group Rooms. :returns: Newly created RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ data = values.of({ 'EnableTurn': enable_turn, 'Type': type, 'UniqueName': unique_name, 'StatusCallback': status_callback, 'StatusCallbackMethod': status_callback_method, 'MaxParticipants': max_participants, 'RecordParticipantsOnConnect': record_participants_on_connect, 'VideoCodecs': serialize.map(video_codecs, lambda e: e), 'MediaRegion': media_region, }) payload = self._version.create( 'POST', self._uri, data=data, ) return RoomInstance(self._version, payload, ) def stream(self, status=values.unset, unique_name=values.unset, date_created_after=values.unset, date_created_before=values.unset, limit=None, page_size=None): """ Streams RoomInstance 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 RoomInstance.RoomStatus status: Only show Rooms with the given status. :param unicode unique_name: Only show Rooms with the provided Name. :param datetime date_created_after: Only show Rooms that started on or after this date, given as YYYY-MM-DD. :param datetime date_created_before: Only show Rooms that started before this date, given as YYYY-MM-DD. :param int limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param int 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 :rtype: list[twilio.rest.video.v1.room.RoomInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page( status=status, unique_name=unique_name, date_created_after=date_created_after, date_created_before=date_created_before, page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'], limits['page_limit']) def list(self, status=values.unset, unique_name=values.unset, date_created_after=values.unset, date_created_before=values.unset, limit=None, page_size=None): """ Lists RoomInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param RoomInstance.RoomStatus status: Only show Rooms with the given status. :param unicode unique_name: Only show Rooms with the provided Name. :param datetime date_created_after: Only show Rooms that started on or after this date, given as YYYY-MM-DD. :param datetime date_created_before: Only show Rooms that started before this date, given as YYYY-MM-DD. :param int limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param int 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: Generator that will yield up to limit results :rtype: list[twilio.rest.video.v1.room.RoomInstance] """ return list(self.stream( status=status, unique_name=unique_name, date_created_after=date_created_after, date_created_before=date_created_before, limit=limit, page_size=page_size, )) def page(self, status=values.unset, unique_name=values.unset, date_created_after=values.unset, date_created_before=values.unset, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of RoomInstance records from the API. Request is executed immediately :param RoomInstance.RoomStatus status: Only show Rooms with the given status. :param unicode unique_name: Only show Rooms with the provided Name. :param datetime date_created_after: Only show Rooms that started on or after this date, given as YYYY-MM-DD. :param datetime date_created_before: Only show Rooms that started before this date, given as YYYY-MM-DD. :param str page_token: PageToken provided by the API :param int page_number: Page Number, this value is simply for client state :param int page_size: Number of records to return, defaults to 50 :returns: Page of RoomInstance :rtype: twilio.rest.video.v1.room.RoomPage """ params = values.of({ 'Status': status, 'UniqueName': unique_name, 'DateCreatedAfter': serialize.iso8601_datetime(date_created_after), 'DateCreatedBefore': serialize.iso8601_datetime(date_created_before), 'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page( 'GET', self._uri, params=params, ) return RoomPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of RoomInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of RoomInstance :rtype: twilio.rest.video.v1.room.RoomPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return RoomPage(self._version, response, self._solution) def get(self, sid): """ Constructs a RoomContext :param sid: The Room Sid or name that uniquely identifies this resource. :returns: twilio.rest.video.v1.room.RoomContext :rtype: twilio.rest.video.v1.room.RoomContext """ return RoomContext(self._version, sid=sid, ) def __call__(self, sid): """ Constructs a RoomContext :param sid: The Room Sid or name that uniquely identifies this resource. :returns: twilio.rest.video.v1.room.RoomContext :rtype: twilio.rest.video.v1.room.RoomContext """ return RoomContext(self._version, sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class RoomPage(Page): """ """ def __init__(self, version, response, solution): """ Initialize the RoomPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.video.v1.room.RoomPage :rtype: twilio.rest.video.v1.room.RoomPage """ super(RoomPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of RoomInstance :param dict payload: Payload response from the API :returns: twilio.rest.video.v1.room.RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ return RoomInstance(self._version, payload, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class RoomContext(InstanceContext): """ """ def __init__(self, version, sid): """ Initialize the RoomContext :param Version version: Version that contains the resource :param sid: The Room Sid or name that uniquely identifies this resource. :returns: twilio.rest.video.v1.room.RoomContext :rtype: twilio.rest.video.v1.room.RoomContext """ super(RoomContext, self).__init__(version) # Path Solution self._solution = {'sid': sid, } self._uri = '/Rooms/{sid}'.format(**self._solution) # Dependents self._recordings = None self._participants = None def fetch(self): """ Fetch a RoomInstance :returns: Fetched RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ params = values.of({}) payload = self._version.fetch( 'GET', self._uri, params=params, ) return RoomInstance(self._version, payload, sid=self._solution['sid'], ) def update(self, status): """ Update the RoomInstance :param RoomInstance.RoomStatus status: Set to completed to end the Room. :returns: Updated RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ data = values.of({'Status': status, }) payload = self._version.update( 'POST', self._uri, data=data, ) return RoomInstance(self._version, payload, sid=self._solution['sid'], ) @property def recordings(self): """ Access the recordings :returns: twilio.rest.video.v1.room.recording.RoomRecordingList :rtype: twilio.rest.video.v1.room.recording.RoomRecordingList """ if self._recordings is None: self._recordings = RoomRecordingList(self._version, room_sid=self._solution['sid'], ) return self._recordings @property def participants(self): """ Access the participants :returns: twilio.rest.video.v1.room.room_participant.ParticipantList :rtype: twilio.rest.video.v1.room.room_participant.ParticipantList """ if self._participants is None: self._participants = ParticipantList(self._version, room_sid=self._solution['sid'], ) return self._participants 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 RoomInstance(InstanceResource): """ """ class RoomStatus(object): IN_PROGRESS = "in-progress" COMPLETED = "completed" FAILED = "failed" class RoomType(object): PEER_TO_PEER = "peer-to-peer" GROUP = "group" GROUP_SMALL = "group-small" class VideoCodec(object): VP8 = "VP8" H264 = "H264" def __init__(self, version, payload, sid=None): """ Initialize the RoomInstance :returns: twilio.rest.video.v1.room.RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ super(RoomInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload['sid'], 'status': payload['status'], 'date_created': deserialize.iso8601_datetime(payload['date_created']), 'date_updated': deserialize.iso8601_datetime(payload['date_updated']), 'account_sid': payload['account_sid'], 'enable_turn': payload['enable_turn'], 'unique_name': payload['unique_name'], 'status_callback': payload['status_callback'], 'status_callback_method': payload['status_callback_method'], 'end_time': deserialize.iso8601_datetime(payload['end_time']), 'duration': deserialize.integer(payload['duration']), 'type': payload['type'], 'max_participants': deserialize.integer(payload['max_participants']), 'record_participants_on_connect': payload['record_participants_on_connect'], 'video_codecs': payload['video_codecs'], 'media_region': payload['media_region'], 'url': payload['url'], 'links': payload['links'], } # Context self._context = None self._solution = {'sid': sid or self._properties['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: RoomContext for this RoomInstance :rtype: twilio.rest.video.v1.room.RoomContext """ if self._context is None: self._context = RoomContext(self._version, sid=self._solution['sid'], ) return self._context @property def sid(self): """ :returns: A system-generated 34-character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @property def status(self): """ :returns: A string representing the status of the Room. :rtype: RoomInstance.RoomStatus """ return self._properties['status'] @property def date_created(self): """ :returns: The date that this resource was created, given as a UTC ISO 8601 Timestamp. :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date that this resource was last updated, given as a UTC ISO 8601 Timestamp. :rtype: datetime """ return self._properties['date_updated'] @property def account_sid(self): """ :returns: The unique ID of the Account associated with this Room. :rtype: unicode """ return self._properties['account_sid'] @property def enable_turn(self): """ :returns: Enable Twilio's Network Traversal TURN service. :rtype: bool """ return self._properties['enable_turn'] @property def unique_name(self): """ :returns: A developer-supplied Name of the Room. :rtype: unicode """ return self._properties['unique_name'] @property def status_callback(self): """ :returns: A URL that Twilio sends asynchronous webhook requests to on every Room event. :rtype: unicode """ return self._properties['status_callback'] @property def status_callback_method(self): """ :returns: HTTP method Twilio should use when requesting the above URL. :rtype: unicode """ return self._properties['status_callback_method'] @property def end_time(self): """ :returns: The end time of the Room, given as a UTC ISO 8601 Timestamp. :rtype: datetime """ return self._properties['end_time'] @property def duration(self): """ :returns: The duration of the Room in seconds. :rtype: unicode """ return self._properties['duration'] @property def type(self): """ :returns: Type of Room, either peer-to-peer, group-small or group. :rtype: RoomInstance.RoomType """ return self._properties['type'] @property def max_participants(self): """ :returns: Maximum number of concurrent Participants allowed in the Room. :rtype: unicode """ return self._properties['max_participants'] @property def record_participants_on_connect(self): """ :returns: Start recording when Participants connect. :rtype: bool """ return self._properties['record_participants_on_connect'] @property def video_codecs(self): """ :returns: The video_codecs :rtype: RoomInstance.VideoCodec """ return self._properties['video_codecs'] @property def media_region(self): """ :returns: Region for the media server in Group Rooms. :rtype: unicode """ return self._properties['media_region'] @property def url(self): """ :returns: The absolute URL for this resource. :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: The links :rtype: unicode """ return self._properties['links'] def fetch(self): """ Fetch a RoomInstance :returns: Fetched RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ return self._proxy.fetch() def update(self, status): """ Update the RoomInstance :param RoomInstance.RoomStatus status: Set to completed to end the Room. :returns: Updated RoomInstance :rtype: twilio.rest.video.v1.room.RoomInstance """ return self._proxy.update(status, ) @property def recordings(self): """ Access the recordings :returns: twilio.rest.video.v1.room.recording.RoomRecordingList :rtype: twilio.rest.video.v1.room.recording.RoomRecordingList """ return self._proxy.recordings @property def participants(self): """ Access the participants :returns: twilio.rest.video.v1.room.room_participant.ParticipantList :rtype: twilio.rest.video.v1.room.room_participant.ParticipantList """ return self._proxy.participants 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)