# 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.preview.proxy.service.session.interaction import InteractionList from twilio.rest.preview.proxy.service.session.participant import ParticipantList class SessionList(ListResource): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, service_sid): """ Initialize the SessionList :param Version version: Version that contains the resource :param service_sid: Service Sid. :returns: twilio.rest.preview.proxy.service.session.SessionList :rtype: twilio.rest.preview.proxy.service.session.SessionList """ super(SessionList, self).__init__(version) # Path Solution self._solution = {'service_sid': service_sid, } self._uri = '/Services/{service_sid}/Sessions'.format(**self._solution) def stream(self, unique_name=values.unset, status=values.unset, limit=None, page_size=None): """ Streams SessionInstance 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 unicode unique_name: A unique, developer assigned name of this Session. :param SessionInstance.Status status: The Status of this Session :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.preview.proxy.service.session.SessionInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(unique_name=unique_name, status=status, page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'], limits['page_limit']) def list(self, unique_name=values.unset, status=values.unset, limit=None, page_size=None): """ Lists SessionInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param unicode unique_name: A unique, developer assigned name of this Session. :param SessionInstance.Status status: The Status of this Session :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.preview.proxy.service.session.SessionInstance] """ return list(self.stream(unique_name=unique_name, status=status, limit=limit, page_size=page_size, )) def page(self, unique_name=values.unset, status=values.unset, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of SessionInstance records from the API. Request is executed immediately :param unicode unique_name: A unique, developer assigned name of this Session. :param SessionInstance.Status status: The Status of this Session :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 SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionPage """ params = values.of({ 'UniqueName': unique_name, 'Status': status, 'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page( 'GET', self._uri, params=params, ) return SessionPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of SessionInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return SessionPage(self._version, response, self._solution) def create(self, unique_name=values.unset, ttl=values.unset, status=values.unset, participants=values.unset): """ Create a new SessionInstance :param unicode unique_name: A unique, developer assigned name of this Session. :param unicode ttl: How long will this session stay open, in seconds. :param SessionInstance.Status status: The Status of this Session :param unicode participants: The participants :returns: Newly created SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ data = values.of({ 'UniqueName': unique_name, 'Ttl': ttl, 'Status': status, 'Participants': serialize.map(participants, lambda e: e), }) payload = self._version.create( 'POST', self._uri, data=data, ) return SessionInstance(self._version, payload, service_sid=self._solution['service_sid'], ) def get(self, sid): """ Constructs a SessionContext :param sid: A string that uniquely identifies this Session. :returns: twilio.rest.preview.proxy.service.session.SessionContext :rtype: twilio.rest.preview.proxy.service.session.SessionContext """ return SessionContext(self._version, service_sid=self._solution['service_sid'], sid=sid, ) def __call__(self, sid): """ Constructs a SessionContext :param sid: A string that uniquely identifies this Session. :returns: twilio.rest.preview.proxy.service.session.SessionContext :rtype: twilio.rest.preview.proxy.service.session.SessionContext """ return SessionContext(self._version, service_sid=self._solution['service_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class SessionPage(Page): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, response, solution): """ Initialize the SessionPage :param Version version: Version that contains the resource :param Response response: Response from the API :param service_sid: Service Sid. :returns: twilio.rest.preview.proxy.service.session.SessionPage :rtype: twilio.rest.preview.proxy.service.session.SessionPage """ super(SessionPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of SessionInstance :param dict payload: Payload response from the API :returns: twilio.rest.preview.proxy.service.session.SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ return SessionInstance(self._version, payload, service_sid=self._solution['service_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class SessionContext(InstanceContext): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ def __init__(self, version, service_sid, sid): """ Initialize the SessionContext :param Version version: Version that contains the resource :param service_sid: Service Sid. :param sid: A string that uniquely identifies this Session. :returns: twilio.rest.preview.proxy.service.session.SessionContext :rtype: twilio.rest.preview.proxy.service.session.SessionContext """ super(SessionContext, self).__init__(version) # Path Solution self._solution = {'service_sid': service_sid, 'sid': sid, } self._uri = '/Services/{service_sid}/Sessions/{sid}'.format(**self._solution) # Dependents self._interactions = None self._participants = None def fetch(self): """ Fetch a SessionInstance :returns: Fetched SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ params = values.of({}) payload = self._version.fetch( 'GET', self._uri, params=params, ) return SessionInstance( self._version, payload, service_sid=self._solution['service_sid'], sid=self._solution['sid'], ) def delete(self): """ Deletes the SessionInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._version.delete('delete', self._uri) def update(self, unique_name=values.unset, ttl=values.unset, status=values.unset, participants=values.unset): """ Update the SessionInstance :param unicode unique_name: A unique, developer assigned name of this Session. :param unicode ttl: How long will this session stay open, in seconds. :param SessionInstance.Status status: The Status of this Session :param unicode participants: The participants :returns: Updated SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ data = values.of({ 'UniqueName': unique_name, 'Ttl': ttl, 'Status': status, 'Participants': serialize.map(participants, lambda e: e), }) payload = self._version.update( 'POST', self._uri, data=data, ) return SessionInstance( self._version, payload, service_sid=self._solution['service_sid'], sid=self._solution['sid'], ) @property def interactions(self): """ Access the interactions :returns: twilio.rest.preview.proxy.service.session.interaction.InteractionList :rtype: twilio.rest.preview.proxy.service.session.interaction.InteractionList """ if self._interactions is None: self._interactions = InteractionList( self._version, service_sid=self._solution['service_sid'], session_sid=self._solution['sid'], ) return self._interactions @property def participants(self): """ Access the participants :returns: twilio.rest.preview.proxy.service.session.participant.ParticipantList :rtype: twilio.rest.preview.proxy.service.session.participant.ParticipantList """ if self._participants is None: self._participants = ParticipantList( self._version, service_sid=self._solution['service_sid'], session_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 SessionInstance(InstanceResource): """ PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com. """ class Status(object): IN_PROGESS = "in-progess" COMPLETED = "completed" def __init__(self, version, payload, service_sid, sid=None): """ Initialize the SessionInstance :returns: twilio.rest.preview.proxy.service.session.SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ super(SessionInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload['sid'], 'service_sid': payload['service_sid'], 'account_sid': payload['account_sid'], 'unique_name': payload['unique_name'], 'ttl': deserialize.integer(payload['ttl']), 'status': payload['status'], 'start_time': deserialize.iso8601_datetime(payload['start_time']), 'end_time': deserialize.iso8601_datetime(payload['end_time']), 'date_created': deserialize.iso8601_datetime(payload['date_created']), 'date_updated': deserialize.iso8601_datetime(payload['date_updated']), 'url': payload['url'], 'links': payload['links'], } # Context self._context = None self._solution = {'service_sid': service_sid, '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: SessionContext for this SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionContext """ if self._context is None: self._context = SessionContext( self._version, service_sid=self._solution['service_sid'], sid=self._solution['sid'], ) return self._context @property def sid(self): """ :returns: A string that uniquely identifies this Session. :rtype: unicode """ return self._properties['sid'] @property def service_sid(self): """ :returns: Service Sid. :rtype: unicode """ return self._properties['service_sid'] @property def account_sid(self): """ :returns: Account Sid. :rtype: unicode """ return self._properties['account_sid'] @property def unique_name(self): """ :returns: A unique, developer assigned name of this Session. :rtype: unicode """ return self._properties['unique_name'] @property def ttl(self): """ :returns: How long will this session stay open, in seconds. :rtype: unicode """ return self._properties['ttl'] @property def status(self): """ :returns: The Status of this Session :rtype: SessionInstance.Status """ return self._properties['status'] @property def start_time(self): """ :returns: The date this Session was started :rtype: datetime """ return self._properties['start_time'] @property def end_time(self): """ :returns: The date this Session was ended :rtype: datetime """ return self._properties['end_time'] @property def date_created(self): """ :returns: The date this Session was created :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date this Session was updated :rtype: datetime """ return self._properties['date_updated'] @property def url(self): """ :returns: The URL of this Session. :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: Nested resource URLs. :rtype: unicode """ return self._properties['links'] def fetch(self): """ Fetch a SessionInstance :returns: Fetched SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ return self._proxy.fetch() def delete(self): """ Deletes the SessionInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete() def update(self, unique_name=values.unset, ttl=values.unset, status=values.unset, participants=values.unset): """ Update the SessionInstance :param unicode unique_name: A unique, developer assigned name of this Session. :param unicode ttl: How long will this session stay open, in seconds. :param SessionInstance.Status status: The Status of this Session :param unicode participants: The participants :returns: Updated SessionInstance :rtype: twilio.rest.preview.proxy.service.session.SessionInstance """ return self._proxy.update( unique_name=unique_name, ttl=ttl, status=status, participants=participants, ) @property def interactions(self): """ Access the interactions :returns: twilio.rest.preview.proxy.service.session.interaction.InteractionList :rtype: twilio.rest.preview.proxy.service.session.interaction.InteractionList """ return self._proxy.interactions @property def participants(self): """ Access the participants :returns: twilio.rest.preview.proxy.service.session.participant.ParticipantList :rtype: twilio.rest.preview.proxy.service.session.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)