Source code for twilio.rest.verify.v2.form

# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

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


[docs]class FormList(ListResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version): """ Initialize the FormList :param Version version: Version that contains the resource :returns: twilio.rest.verify.v2.form.FormList :rtype: twilio.rest.verify.v2.form.FormList """ super(FormList, self).__init__(version) # Path Solution self._solution = {}
[docs] def get(self, form_type): """ Constructs a FormContext :param form_type: The Type of this Form :returns: twilio.rest.verify.v2.form.FormContext :rtype: twilio.rest.verify.v2.form.FormContext """ return FormContext(self._version, form_type=form_type, )
def __call__(self, form_type): """ Constructs a FormContext :param form_type: The Type of this Form :returns: twilio.rest.verify.v2.form.FormContext :rtype: twilio.rest.verify.v2.form.FormContext """ return FormContext(self._version, form_type=form_type, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Verify.V2.FormList>'
[docs]class FormPage(Page): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, response, solution): """ Initialize the FormPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.verify.v2.form.FormPage :rtype: twilio.rest.verify.v2.form.FormPage """ super(FormPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of FormInstance :param dict payload: Payload response from the API :returns: twilio.rest.verify.v2.form.FormInstance :rtype: twilio.rest.verify.v2.form.FormInstance """ return FormInstance(self._version, payload, )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Verify.V2.FormPage>'
[docs]class FormContext(InstanceContext): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """ def __init__(self, version, form_type): """ Initialize the FormContext :param Version version: Version that contains the resource :param form_type: The Type of this Form :returns: twilio.rest.verify.v2.form.FormContext :rtype: twilio.rest.verify.v2.form.FormContext """ super(FormContext, self).__init__(version) # Path Solution self._solution = {'form_type': form_type, } self._uri = '/Forms/{form_type}'.format(**self._solution)
[docs] def fetch(self): """ Fetch the FormInstance :returns: The fetched FormInstance :rtype: twilio.rest.verify.v2.form.FormInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return FormInstance(self._version, payload, form_type=self._solution['form_type'], )
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 '<Twilio.Verify.V2.FormContext {}>'.format(context)
[docs]class FormInstance(InstanceResource): """ PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution. """
[docs] class FormTypes(object): FORM_PUSH = "form-push"
def __init__(self, version, payload, form_type=None): """ Initialize the FormInstance :returns: twilio.rest.verify.v2.form.FormInstance :rtype: twilio.rest.verify.v2.form.FormInstance """ super(FormInstance, self).__init__(version) # Marshaled Properties self._properties = { 'form_type': payload.get('form_type'), 'forms': payload.get('forms'), 'form_meta': payload.get('form_meta'), 'url': payload.get('url'), } # Context self._context = None self._solution = {'form_type': form_type or self._properties['form_type'], } @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: FormContext for this FormInstance :rtype: twilio.rest.verify.v2.form.FormContext """ if self._context is None: self._context = FormContext(self._version, form_type=self._solution['form_type'], ) return self._context @property def form_type(self): """ :returns: The Type of this Form :rtype: FormInstance.FormTypes """ return self._properties['form_type'] @property def forms(self): """ :returns: Object that contains the available forms for this type. :rtype: dict """ return self._properties['forms'] @property def form_meta(self): """ :returns: Additional information for the available forms for this type. :rtype: dict """ return self._properties['form_meta'] @property def url(self): """ :returns: The URL to access the forms for this type. :rtype: unicode """ return self._properties['url']
[docs] def fetch(self): """ Fetch the FormInstance :returns: The fetched FormInstance :rtype: twilio.rest.verify.v2.form.FormInstance """ return self._proxy.fetch()
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 '<Twilio.Verify.V2.FormInstance {}>'.format(context)