# 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.understand.assistant.intent.field import FieldList from twilio.rest.preview.understand.assistant.intent.intent_actions import IntentActionsList from twilio.rest.preview.understand.assistant.intent.intent_statistics import IntentStatisticsList from twilio.rest.preview.understand.assistant.intent.sample import SampleList class IntentList(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, assistant_sid): """ Initialize the IntentList :param Version version: Version that contains the resource :param assistant_sid: The unique ID of the Assistant. :returns: twilio.rest.preview.understand.assistant.intent.IntentList :rtype: twilio.rest.preview.understand.assistant.intent.IntentList """ super(IntentList, self).__init__(version) # Path Solution self._solution = {'assistant_sid': assistant_sid, } self._uri = '/Assistants/{assistant_sid}/Intents'.format(**self._solution) def stream(self, limit=None, page_size=None): """ Streams IntentInstance 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.preview.understand.assistant.intent.IntentInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'], limits['page_limit']) def list(self, limit=None, page_size=None): """ Lists IntentInstance 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.preview.understand.assistant.intent.IntentInstance] """ 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 IntentInstance 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 IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentPage """ params = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page( 'GET', self._uri, params=params, ) return IntentPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of IntentInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return IntentPage(self._version, response, self._solution) def create(self, unique_name, friendly_name=values.unset, actions=values.unset): """ Create a new IntentInstance :param unicode unique_name: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. :param unicode friendly_name: A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. :param dict actions: The actions :returns: Newly created IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ data = values.of({ 'UniqueName': unique_name, 'FriendlyName': friendly_name, 'Actions': serialize.object(actions), }) payload = self._version.create( 'POST', self._uri, data=data, ) return IntentInstance(self._version, payload, assistant_sid=self._solution['assistant_sid'], ) def get(self, sid): """ Constructs a IntentContext :param sid: The sid :returns: twilio.rest.preview.understand.assistant.intent.IntentContext :rtype: twilio.rest.preview.understand.assistant.intent.IntentContext """ return IntentContext(self._version, assistant_sid=self._solution['assistant_sid'], sid=sid, ) def __call__(self, sid): """ Constructs a IntentContext :param sid: The sid :returns: twilio.rest.preview.understand.assistant.intent.IntentContext :rtype: twilio.rest.preview.understand.assistant.intent.IntentContext """ return IntentContext(self._version, assistant_sid=self._solution['assistant_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class IntentPage(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 IntentPage :param Version version: Version that contains the resource :param Response response: Response from the API :param assistant_sid: The unique ID of the Assistant. :returns: twilio.rest.preview.understand.assistant.intent.IntentPage :rtype: twilio.rest.preview.understand.assistant.intent.IntentPage """ super(IntentPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of IntentInstance :param dict payload: Payload response from the API :returns: twilio.rest.preview.understand.assistant.intent.IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ return IntentInstance(self._version, payload, assistant_sid=self._solution['assistant_sid'], ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class IntentContext(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, assistant_sid, sid): """ Initialize the IntentContext :param Version version: Version that contains the resource :param assistant_sid: The assistant_sid :param sid: The sid :returns: twilio.rest.preview.understand.assistant.intent.IntentContext :rtype: twilio.rest.preview.understand.assistant.intent.IntentContext """ super(IntentContext, self).__init__(version) # Path Solution self._solution = {'assistant_sid': assistant_sid, 'sid': sid, } self._uri = '/Assistants/{assistant_sid}/Intents/{sid}'.format(**self._solution) # Dependents self._fields = None self._samples = None self._intent_actions = None self._statistics = None def fetch(self): """ Fetch a IntentInstance :returns: Fetched IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ params = values.of({}) payload = self._version.fetch( 'GET', self._uri, params=params, ) return IntentInstance( self._version, payload, assistant_sid=self._solution['assistant_sid'], sid=self._solution['sid'], ) def update(self, friendly_name=values.unset, unique_name=values.unset, actions=values.unset): """ Update the IntentInstance :param unicode friendly_name: A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. :param unicode unique_name: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. :param dict actions: The actions :returns: Updated IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ data = values.of({ 'FriendlyName': friendly_name, 'UniqueName': unique_name, 'Actions': serialize.object(actions), }) payload = self._version.update( 'POST', self._uri, data=data, ) return IntentInstance( self._version, payload, assistant_sid=self._solution['assistant_sid'], sid=self._solution['sid'], ) def delete(self): """ Deletes the IntentInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._version.delete('delete', self._uri) @property def fields(self): """ Access the fields :returns: twilio.rest.preview.understand.assistant.intent.field.FieldList :rtype: twilio.rest.preview.understand.assistant.intent.field.FieldList """ if self._fields is None: self._fields = FieldList( self._version, assistant_sid=self._solution['assistant_sid'], intent_sid=self._solution['sid'], ) return self._fields @property def samples(self): """ Access the samples :returns: twilio.rest.preview.understand.assistant.intent.sample.SampleList :rtype: twilio.rest.preview.understand.assistant.intent.sample.SampleList """ if self._samples is None: self._samples = SampleList( self._version, assistant_sid=self._solution['assistant_sid'], intent_sid=self._solution['sid'], ) return self._samples @property def intent_actions(self): """ Access the intent_actions :returns: twilio.rest.preview.understand.assistant.intent.intent_actions.IntentActionsList :rtype: twilio.rest.preview.understand.assistant.intent.intent_actions.IntentActionsList """ if self._intent_actions is None: self._intent_actions = IntentActionsList( self._version, assistant_sid=self._solution['assistant_sid'], intent_sid=self._solution['sid'], ) return self._intent_actions @property def statistics(self): """ Access the statistics :returns: twilio.rest.preview.understand.assistant.intent.intent_statistics.IntentStatisticsList :rtype: twilio.rest.preview.understand.assistant.intent.intent_statistics.IntentStatisticsList """ if self._statistics is None: self._statistics = IntentStatisticsList( self._version, assistant_sid=self._solution['assistant_sid'], intent_sid=self._solution['sid'], ) return self._statistics 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 IntentInstance(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. """ def __init__(self, version, payload, assistant_sid, sid=None): """ Initialize the IntentInstance :returns: twilio.rest.preview.understand.assistant.intent.IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ super(IntentInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload['account_sid'], 'date_created': deserialize.iso8601_datetime(payload['date_created']), 'date_updated': deserialize.iso8601_datetime(payload['date_updated']), 'friendly_name': payload['friendly_name'], 'links': payload['links'], 'assistant_sid': payload['assistant_sid'], 'sid': payload['sid'], 'unique_name': payload['unique_name'], 'url': payload['url'], } # Context self._context = None self._solution = {'assistant_sid': assistant_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: IntentContext for this IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentContext """ if self._context is None: self._context = IntentContext( self._version, assistant_sid=self._solution['assistant_sid'], sid=self._solution['sid'], ) return self._context @property def account_sid(self): """ :returns: The unique ID of the Account that created this Intent. :rtype: unicode """ return self._properties['account_sid'] @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 friendly_name(self): """ :returns: A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. :rtype: unicode """ return self._properties['friendly_name'] @property def links(self): """ :returns: The links :rtype: unicode """ return self._properties['links'] @property def assistant_sid(self): """ :returns: The unique ID of the Assistant. :rtype: unicode """ return self._properties['assistant_sid'] @property def sid(self): """ :returns: A 34 character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @property def unique_name(self): """ :returns: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. :rtype: unicode """ return self._properties['unique_name'] @property def url(self): """ :returns: The url :rtype: unicode """ return self._properties['url'] def fetch(self): """ Fetch a IntentInstance :returns: Fetched IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ return self._proxy.fetch() def update(self, friendly_name=values.unset, unique_name=values.unset, actions=values.unset): """ Update the IntentInstance :param unicode friendly_name: A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long. :param unicode unique_name: A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. :param dict actions: The actions :returns: Updated IntentInstance :rtype: twilio.rest.preview.understand.assistant.intent.IntentInstance """ return self._proxy.update(friendly_name=friendly_name, unique_name=unique_name, actions=actions, ) def delete(self): """ Deletes the IntentInstance :returns: True if delete succeeds, False otherwise :rtype: bool """ return self._proxy.delete() @property def fields(self): """ Access the fields :returns: twilio.rest.preview.understand.assistant.intent.field.FieldList :rtype: twilio.rest.preview.understand.assistant.intent.field.FieldList """ return self._proxy.fields @property def samples(self): """ Access the samples :returns: twilio.rest.preview.understand.assistant.intent.sample.SampleList :rtype: twilio.rest.preview.understand.assistant.intent.sample.SampleList """ return self._proxy.samples @property def intent_actions(self): """ Access the intent_actions :returns: twilio.rest.preview.understand.assistant.intent.intent_actions.IntentActionsList :rtype: twilio.rest.preview.understand.assistant.intent.intent_actions.IntentActionsList """ return self._proxy.intent_actions @property def statistics(self): """ Access the statistics :returns: twilio.rest.preview.understand.assistant.intent.intent_statistics.IntentStatisticsList :rtype: twilio.rest.preview.understand.assistant.intent.intent_statistics.IntentStatisticsList """ return self._proxy.statistics 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)