# 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 WebhookList(ListResource): def __init__(self, version, conversation_sid): """ Initialize the WebhookList :param Version version: Version that contains the resource :param conversation_sid: The unique ID of the Conversation for this webhook. :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookList :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookList """ super(WebhookList, self).__init__(version) # Path Solution self._solution = {'conversation_sid': conversation_sid, } self._uri = '/Conversations/{conversation_sid}/Webhooks'.format(**self._solution) def stream(self, limit=None, page_size=None): """ Streams WebhookInstance 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.conversation.webhook.WebhookInstance] """ 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 WebhookInstance 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.conversation.webhook.WebhookInstance] """ 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 WebhookInstance 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 WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return WebhookPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of WebhookInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return WebhookPage(self._version, response, self._solution) def create(self, target, configuration_url=values.unset, configuration_method=values.unset, configuration_filters=values.unset, configuration_triggers=values.unset, configuration_flow_sid=values.unset, configuration_replay_after=values.unset): """ Create the WebhookInstance :param WebhookInstance.Target target: The target of this webhook. :param unicode configuration_url: The absolute url the webhook request should be sent to. :param WebhookInstance.Method configuration_method: The HTTP method to be used when sending a webhook request. :param unicode configuration_filters: The list of events, firing webhook event for this Conversation. :param unicode configuration_triggers: The list of keywords, firing webhook event for this Conversation. :param unicode configuration_flow_sid: The studio flow SID, where the webhook should be sent to. :param unicode configuration_replay_after: The message index for which and it's successors the webhook will be replayed. :returns: The created WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ data = values.of({ 'Target': target, 'Configuration.Url': configuration_url, 'Configuration.Method': configuration_method, 'Configuration.Filters': serialize.map(configuration_filters, lambda e: e), 'Configuration.Triggers': serialize.map(configuration_triggers, lambda e: e), 'Configuration.FlowSid': configuration_flow_sid, 'Configuration.ReplayAfter': configuration_replay_after, }) payload = self._version.create(method='POST', uri=self._uri, data=data, ) return WebhookInstance(self._version, payload, conversation_sid=self._solution['conversation_sid'], ) def get(self, sid): """ Constructs a WebhookContext :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookContext :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookContext """ return WebhookContext(self._version, conversation_sid=self._solution['conversation_sid'], sid=sid, ) def __call__(self, sid): """ Constructs a WebhookContext :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookContext :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookContext """ return WebhookContext(self._version, conversation_sid=self._solution['conversation_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class WebhookPage(Page): def __init__(self, version, response, solution): """ Initialize the WebhookPage :param Version version: Version that contains the resource :param Response response: Response from the API :param conversation_sid: The unique ID of the Conversation for this webhook. :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookPage :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookPage """ super(WebhookPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of WebhookInstance :param dict payload: Payload response from the API :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ return WebhookInstance(self._version, payload, conversation_sid=self._solution['conversation_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class WebhookContext(InstanceContext): def __init__(self, version, conversation_sid, sid): """ Initialize the WebhookContext :param Version version: Version that contains the resource :param conversation_sid: The unique ID of the Conversation for this webhook. :param sid: A 34 character string that uniquely identifies this resource. :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookContext :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookContext """ super(WebhookContext, self).__init__(version) # Path Solution self._solution = {'conversation_sid': conversation_sid, 'sid': sid, } self._uri = '/Conversations/{conversation_sid}/Webhooks/{sid}'.format(**self._solution) def fetch(self): """ Fetch the WebhookInstance :returns: The fetched WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return WebhookInstance( self._version, payload, conversation_sid=self._solution['conversation_sid'], sid=self._solution['sid'], ) def update(self, configuration_url=values.unset, configuration_method=values.unset, configuration_filters=values.unset, configuration_triggers=values.unset, configuration_flow_sid=values.unset): """ Update the WebhookInstance :param unicode configuration_url: The absolute url the webhook request should be sent to. :param WebhookInstance.Method configuration_method: The HTTP method to be used when sending a webhook request. :param unicode configuration_filters: The list of events, firing webhook event for this Conversation. :param unicode configuration_triggers: The list of keywords, firing webhook event for this Conversation. :param unicode configuration_flow_sid: The studio flow SID, where the webhook should be sent to. :returns: The updated WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ data = values.of({ 'Configuration.Url': configuration_url, 'Configuration.Method': configuration_method, 'Configuration.Filters': serialize.map(configuration_filters, lambda e: e), 'Configuration.Triggers': serialize.map(configuration_triggers, lambda e: e), 'Configuration.FlowSid': configuration_flow_sid, }) payload = self._version.update(method='POST', uri=self._uri, data=data, ) return WebhookInstance( self._version, payload, conversation_sid=self._solution['conversation_sid'], sid=self._solution['sid'], ) def delete(self): """ Deletes the WebhookInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._version.delete(method='DELETE', uri=self._uri, ) 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 WebhookInstance(InstanceResource): class Target(object): WEBHOOK = "webhook" TRIGGER = "trigger" STUDIO = "studio" class Method(object): GET = "GET" POST = "POST" def __init__(self, version, payload, conversation_sid, sid=None): """ Initialize the WebhookInstance :returns: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ super(WebhookInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload.get('sid'), 'account_sid': payload.get('account_sid'), 'conversation_sid': payload.get('conversation_sid'), 'target': payload.get('target'), 'url': payload.get('url'), 'configuration': payload.get('configuration'), 'date_created': deserialize.iso8601_datetime(payload.get('date_created')), 'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')), } # Context self._context = None self._solution = {'conversation_sid': conversation_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: WebhookContext for this WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookContext """ if self._context is None: self._context = WebhookContext( self._version, conversation_sid=self._solution['conversation_sid'], sid=self._solution['sid'], ) return self._context @property def sid(self): """ :returns: A 34 character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @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 conversation_sid(self): """ :returns: The unique ID of the Conversation for this webhook. :rtype: unicode """ return self._properties['conversation_sid'] @property def target(self): """ :returns: The target of this webhook. :rtype: unicode """ return self._properties['target'] @property def url(self): """ :returns: An absolute URL for this webhook. :rtype: unicode """ return self._properties['url'] @property def configuration(self): """ :returns: The configuration of this webhook. :rtype: dict """ return self._properties['configuration'] @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'] def fetch(self): """ Fetch the WebhookInstance :returns: The fetched WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ return self._proxy.fetch() def update(self, configuration_url=values.unset, configuration_method=values.unset, configuration_filters=values.unset, configuration_triggers=values.unset, configuration_flow_sid=values.unset): """ Update the WebhookInstance :param unicode configuration_url: The absolute url the webhook request should be sent to. :param WebhookInstance.Method configuration_method: The HTTP method to be used when sending a webhook request. :param unicode configuration_filters: The list of events, firing webhook event for this Conversation. :param unicode configuration_triggers: The list of keywords, firing webhook event for this Conversation. :param unicode configuration_flow_sid: The studio flow SID, where the webhook should be sent to. :returns: The updated WebhookInstance :rtype: twilio.rest.conversations.v1.conversation.webhook.WebhookInstance """ return self._proxy.update( configuration_url=configuration_url, configuration_method=configuration_method, configuration_filters=configuration_filters, configuration_triggers=configuration_triggers, configuration_flow_sid=configuration_flow_sid, ) def delete(self): """ Deletes the WebhookInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete() 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)