# 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 from twilio.rest.conversations.v1.service.conversation.message import MessageList from twilio.rest.conversations.v1.service.conversation.participant import ParticipantList from twilio.rest.conversations.v1.service.conversation.webhook import WebhookList class ConversationList(ListResource): def __init__(self, version, chat_service_sid): """ Initialize the ConversationList :param Version version: Version that contains the resource :param chat_service_sid: The unique ID of the Conversation Service this conversation belongs to. :returns: twilio.rest.conversations.v1.service.conversation.ConversationList :rtype: twilio.rest.conversations.v1.service.conversation.ConversationList """ super(ConversationList, self).__init__(version) # Path Solution self._solution = {'chat_service_sid': chat_service_sid, } self._uri = '/Services/{chat_service_sid}/Conversations'.format(**self._solution) def create(self, friendly_name=values.unset, unique_name=values.unset, attributes=values.unset, messaging_service_sid=values.unset, date_created=values.unset, date_updated=values.unset, state=values.unset, timers_inactive=values.unset, timers_closed=values.unset, x_twilio_webhook_enabled=values.unset): """ Create the ConversationInstance :param unicode friendly_name: The human-readable name of this conversation. :param unicode unique_name: An application-defined string that uniquely identifies the resource :param unicode attributes: An optional string metadata field you can use to store any data you wish. :param unicode messaging_service_sid: The unique ID of the Messaging Service this conversation belongs to. :param datetime date_created: The date that this resource was created. :param datetime date_updated: The date that this resource was last updated. :param ConversationInstance.State state: Current state of this conversation. :param unicode timers_inactive: ISO8601 duration when conversation will be switched to `inactive` state. :param unicode timers_closed: ISO8601 duration when conversation will be switched to `closed` state. :param ConversationInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: The created ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ data = values.of({ 'FriendlyName': friendly_name, 'UniqueName': unique_name, 'Attributes': attributes, 'MessagingServiceSid': messaging_service_sid, 'DateCreated': serialize.iso8601_datetime(date_created), 'DateUpdated': serialize.iso8601_datetime(date_updated), 'State': state, 'Timers.Inactive': timers_inactive, 'Timers.Closed': timers_closed, }) headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, }) payload = self._version.create(method='POST', uri=self._uri, data=data, headers=headers, ) return ConversationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_sid'], ) def stream(self, limit=None, page_size=None): """ Streams ConversationInstance 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 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.conversations.v1.service.conversation.ConversationInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(page_size=limits['page_size'], ) return self._version.stream(page, limits['limit']) def list(self, limit=None, page_size=None): """ Lists ConversationInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :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.conversations.v1.service.conversation.ConversationInstance] """ return list(self.stream(limit=limit, page_size=page_size, )) def page(self, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of ConversationInstance records from the API. Request is executed immediately :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 ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return ConversationPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of ConversationInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return ConversationPage(self._version, response, self._solution) def get(self, sid): """ Constructs a ConversationContext :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.service.conversation.ConversationContext :rtype: twilio.rest.conversations.v1.service.conversation.ConversationContext """ return ConversationContext( self._version, chat_service_sid=self._solution['chat_service_sid'], sid=sid, ) def __call__(self, sid): """ Constructs a ConversationContext :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.service.conversation.ConversationContext :rtype: twilio.rest.conversations.v1.service.conversation.ConversationContext """ return ConversationContext( self._version, chat_service_sid=self._solution['chat_service_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class ConversationPage(Page): def __init__(self, version, response, solution): """ Initialize the ConversationPage :param Version version: Version that contains the resource :param Response response: Response from the API :param chat_service_sid: The unique ID of the Conversation Service this conversation belongs to. :returns: twilio.rest.conversations.v1.service.conversation.ConversationPage :rtype: twilio.rest.conversations.v1.service.conversation.ConversationPage """ super(ConversationPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of ConversationInstance :param dict payload: Payload response from the API :returns: twilio.rest.conversations.v1.service.conversation.ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ return ConversationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class ConversationContext(InstanceContext): def __init__(self, version, chat_service_sid, sid): """ Initialize the ConversationContext :param Version version: Version that contains the resource :param chat_service_sid: The SID of the Conversation Service that the resource is associated with. :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.service.conversation.ConversationContext :rtype: twilio.rest.conversations.v1.service.conversation.ConversationContext """ super(ConversationContext, self).__init__(version) # Path Solution self._solution = {'chat_service_sid': chat_service_sid, 'sid': sid, } self._uri = '/Services/{chat_service_sid}/Conversations/{sid}'.format(**self._solution) # Dependents self._participants = None self._messages = None self._webhooks = None def update(self, friendly_name=values.unset, date_created=values.unset, date_updated=values.unset, attributes=values.unset, messaging_service_sid=values.unset, state=values.unset, timers_inactive=values.unset, timers_closed=values.unset, unique_name=values.unset, x_twilio_webhook_enabled=values.unset): """ Update the ConversationInstance :param unicode friendly_name: The human-readable name of this conversation. :param datetime date_created: The date that this resource was created. :param datetime date_updated: The date that this resource was last updated. :param unicode attributes: An optional string metadata field you can use to store any data you wish. :param unicode messaging_service_sid: The unique ID of the Messaging Service this conversation belongs to. :param ConversationInstance.State state: Current state of this conversation. :param unicode timers_inactive: ISO8601 duration when conversation will be switched to `inactive` state. :param unicode timers_closed: ISO8601 duration when conversation will be switched to `closed` state. :param unicode unique_name: An application-defined string that uniquely identifies the resource :param ConversationInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: The updated ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ data = values.of({ 'FriendlyName': friendly_name, 'DateCreated': serialize.iso8601_datetime(date_created), 'DateUpdated': serialize.iso8601_datetime(date_updated), 'Attributes': attributes, 'MessagingServiceSid': messaging_service_sid, 'State': state, 'Timers.Inactive': timers_inactive, 'Timers.Closed': timers_closed, 'UniqueName': unique_name, }) headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, }) payload = self._version.update(method='POST', uri=self._uri, data=data, headers=headers, ) return ConversationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_sid'], sid=self._solution['sid'], ) def delete(self, x_twilio_webhook_enabled=values.unset): """ Deletes the ConversationInstance :param ConversationInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise :rtype: bool """ headers = values.of({'X-Twilio-Webhook-Enabled': x_twilio_webhook_enabled, }) return self._version.delete(method='DELETE', uri=self._uri, headers=headers, ) def fetch(self): """ Fetch the ConversationInstance :returns: The fetched ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return ConversationInstance( self._version, payload, chat_service_sid=self._solution['chat_service_sid'], sid=self._solution['sid'], ) @property def participants(self): """ Access the participants :returns: twilio.rest.conversations.v1.service.conversation.participant.ParticipantList :rtype: twilio.rest.conversations.v1.service.conversation.participant.ParticipantList """ if self._participants is None: self._participants = ParticipantList( self._version, chat_service_sid=self._solution['chat_service_sid'], conversation_sid=self._solution['sid'], ) return self._participants @property def messages(self): """ Access the messages :returns: twilio.rest.conversations.v1.service.conversation.message.MessageList :rtype: twilio.rest.conversations.v1.service.conversation.message.MessageList """ if self._messages is None: self._messages = MessageList( self._version, chat_service_sid=self._solution['chat_service_sid'], conversation_sid=self._solution['sid'], ) return self._messages @property def webhooks(self): """ Access the webhooks :returns: twilio.rest.conversations.v1.service.conversation.webhook.WebhookList :rtype: twilio.rest.conversations.v1.service.conversation.webhook.WebhookList """ if self._webhooks is None: self._webhooks = WebhookList( self._version, chat_service_sid=self._solution['chat_service_sid'], conversation_sid=self._solution['sid'], ) return self._webhooks 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 ConversationInstance(InstanceResource): class WebhookEnabledType(object): TRUE = "true" FALSE = "false" class State(object): INACTIVE = "inactive" ACTIVE = "active" CLOSED = "closed" def __init__(self, version, payload, chat_service_sid, sid=None): """ Initialize the ConversationInstance :returns: twilio.rest.conversations.v1.service.conversation.ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ super(ConversationInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'chat_service_sid': payload.get('chat_service_sid'), 'messaging_service_sid': payload.get('messaging_service_sid'), 'sid': payload.get('sid'), 'friendly_name': payload.get('friendly_name'), 'unique_name': payload.get('unique_name'), 'attributes': payload.get('attributes'), 'state': payload.get('state'), 'date_created': deserialize.iso8601_datetime(payload.get('date_created')), 'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')), 'timers': payload.get('timers'), 'url': payload.get('url'), 'links': payload.get('links'), 'bindings': payload.get('bindings'), } # Context self._context = None self._solution = {'chat_service_sid': chat_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: ConversationContext for this ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationContext """ if self._context is None: self._context = ConversationContext( self._version, chat_service_sid=self._solution['chat_service_sid'], sid=self._solution['sid'], ) return self._context @property def account_sid(self): """ :returns: The unique ID of the Account responsible for this conversation. :rtype: unicode """ return self._properties['account_sid'] @property def chat_service_sid(self): """ :returns: The unique ID of the Conversation Service this conversation belongs to. :rtype: unicode """ return self._properties['chat_service_sid'] @property def messaging_service_sid(self): """ :returns: The unique ID of the Messaging Service this conversation belongs to. :rtype: unicode """ return self._properties['messaging_service_sid'] @property def sid(self): """ :returns: A 34 character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @property def friendly_name(self): """ :returns: The human-readable name of this conversation. :rtype: unicode """ return self._properties['friendly_name'] @property def unique_name(self): """ :returns: An application-defined string that uniquely identifies the resource :rtype: unicode """ return self._properties['unique_name'] @property def attributes(self): """ :returns: An optional string metadata field you can use to store any data you wish. :rtype: unicode """ return self._properties['attributes'] @property def state(self): """ :returns: Current state of this conversation. :rtype: ConversationInstance.State """ return self._properties['state'] @property def date_created(self): """ :returns: The date that this resource was created. :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date that this resource was last updated. :rtype: datetime """ return self._properties['date_updated'] @property def timers(self): """ :returns: Timer date values for this conversation. :rtype: dict """ return self._properties['timers'] @property def url(self): """ :returns: An absolute URL for this conversation. :rtype: unicode """ return self._properties['url'] @property def links(self): """ :returns: Absolute URLs to access the participants, messages and webhooks of this conversation. :rtype: unicode """ return self._properties['links'] @property def bindings(self): """ :returns: The bindings :rtype: dict """ return self._properties['bindings'] def update(self, friendly_name=values.unset, date_created=values.unset, date_updated=values.unset, attributes=values.unset, messaging_service_sid=values.unset, state=values.unset, timers_inactive=values.unset, timers_closed=values.unset, unique_name=values.unset, x_twilio_webhook_enabled=values.unset): """ Update the ConversationInstance :param unicode friendly_name: The human-readable name of this conversation. :param datetime date_created: The date that this resource was created. :param datetime date_updated: The date that this resource was last updated. :param unicode attributes: An optional string metadata field you can use to store any data you wish. :param unicode messaging_service_sid: The unique ID of the Messaging Service this conversation belongs to. :param ConversationInstance.State state: Current state of this conversation. :param unicode timers_inactive: ISO8601 duration when conversation will be switched to `inactive` state. :param unicode timers_closed: ISO8601 duration when conversation will be switched to `closed` state. :param unicode unique_name: An application-defined string that uniquely identifies the resource :param ConversationInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: The updated ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ return self._proxy.update( friendly_name=friendly_name, date_created=date_created, date_updated=date_updated, attributes=attributes, messaging_service_sid=messaging_service_sid, state=state, timers_inactive=timers_inactive, timers_closed=timers_closed, unique_name=unique_name, x_twilio_webhook_enabled=x_twilio_webhook_enabled, ) def delete(self, x_twilio_webhook_enabled=values.unset): """ Deletes the ConversationInstance :param ConversationInstance.WebhookEnabledType x_twilio_webhook_enabled: The X-Twilio-Webhook-Enabled HTTP request header :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete(x_twilio_webhook_enabled=x_twilio_webhook_enabled, ) def fetch(self): """ Fetch the ConversationInstance :returns: The fetched ConversationInstance :rtype: twilio.rest.conversations.v1.service.conversation.ConversationInstance """ return self._proxy.fetch() @property def participants(self): """ Access the participants :returns: twilio.rest.conversations.v1.service.conversation.participant.ParticipantList :rtype: twilio.rest.conversations.v1.service.conversation.participant.ParticipantList """ return self._proxy.participants @property def messages(self): """ Access the messages :returns: twilio.rest.conversations.v1.service.conversation.message.MessageList :rtype: twilio.rest.conversations.v1.service.conversation.message.MessageList """ return self._proxy.messages @property def webhooks(self): """ Access the webhooks :returns: twilio.rest.conversations.v1.service.conversation.webhook.WebhookList :rtype: twilio.rest.conversations.v1.service.conversation.webhook.WebhookList """ return self._proxy.webhooks 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)