Source code for twilio.rest.api.v2010.account.sip.domain.credential_list_mapping

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

from twilio.base import deserialize
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 CredentialListMappingList(ListResource): def __init__(self, version, account_sid, domain_sid): """ Initialize the CredentialListMappingList :param Version version: Version that contains the resource :param account_sid: The unique id of the Account that is responsible for this resource. :param domain_sid: The unique string that identifies the SipDomain resource. :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingList """ super(CredentialListMappingList, self).__init__(version) # Path Solution self._solution = {'account_sid': account_sid, 'domain_sid': domain_sid, } self._uri = '/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings.json'.format(**self._solution)
[docs] def create(self, credential_list_sid): """ Create the CredentialListMappingInstance :param unicode credential_list_sid: A string that identifies the CredentialList resource to map to the SIP domain :returns: The created CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance """ data = values.of({'CredentialListSid': credential_list_sid, }) payload = self._version.create(method='POST', uri=self._uri, data=data, ) return CredentialListMappingInstance( self._version, payload, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], )
[docs] def stream(self, limit=None, page_size=None): """ Streams CredentialListMappingInstance 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.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance] """ limits = self._version.read_limits(limit, page_size) page = self.page(page_size=limits['page_size'], ) return self._version.stream(page, limits['limit'])
[docs] def list(self, limit=None, page_size=None): """ Lists CredentialListMappingInstance 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.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance] """ return list(self.stream(limit=limit, page_size=page_size, ))
[docs] def page(self, page_token=values.unset, page_number=values.unset, page_size=values.unset): """ Retrieve a single page of CredentialListMappingInstance 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 CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return CredentialListMappingPage(self._version, response, self._solution)
[docs] def get_page(self, target_url): """ Retrieve a specific page of CredentialListMappingInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return CredentialListMappingPage(self._version, response, self._solution)
[docs] def get(self, sid): """ Constructs a CredentialListMappingContext :param sid: A string that identifies the resource to fetch :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext """ return CredentialListMappingContext( self._version, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], sid=sid, )
def __call__(self, sid): """ Constructs a CredentialListMappingContext :param sid: A string that identifies the resource to fetch :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext """ return CredentialListMappingContext( self._version, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Api.V2010.CredentialListMappingList>'
[docs]class CredentialListMappingPage(Page): def __init__(self, version, response, solution): """ Initialize the CredentialListMappingPage :param Version version: Version that contains the resource :param Response response: Response from the API :param account_sid: The unique id of the Account that is responsible for this resource. :param domain_sid: The unique string that identifies the SipDomain resource. :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingPage """ super(CredentialListMappingPage, self).__init__(version, response) # Path Solution self._solution = solution
[docs] def get_instance(self, payload): """ Build an instance of CredentialListMappingInstance :param dict payload: Payload response from the API :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance """ return CredentialListMappingInstance( self._version, payload, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], )
def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '<Twilio.Api.V2010.CredentialListMappingPage>'
[docs]class CredentialListMappingContext(InstanceContext): def __init__(self, version, account_sid, domain_sid, sid): """ Initialize the CredentialListMappingContext :param Version version: Version that contains the resource :param account_sid: The unique sid that identifies this account :param domain_sid: A string that identifies the SIP Domain that includes the resource to fetch :param sid: A string that identifies the resource to fetch :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext """ super(CredentialListMappingContext, self).__init__(version) # Path Solution self._solution = {'account_sid': account_sid, 'domain_sid': domain_sid, 'sid': sid, } self._uri = '/Accounts/{account_sid}/SIP/Domains/{domain_sid}/CredentialListMappings/{sid}.json'.format(**self._solution)
[docs] def fetch(self): """ Fetch the CredentialListMappingInstance :returns: The fetched CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return CredentialListMappingInstance( self._version, payload, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], sid=self._solution['sid'], )
[docs] def delete(self): """ Deletes the CredentialListMappingInstance :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 '<Twilio.Api.V2010.CredentialListMappingContext {}>'.format(context)
[docs]class CredentialListMappingInstance(InstanceResource): def __init__(self, version, payload, account_sid, domain_sid, sid=None): """ Initialize the CredentialListMappingInstance :returns: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance """ super(CredentialListMappingInstance, self).__init__(version) # Marshaled Properties self._properties = { 'account_sid': payload.get('account_sid'), 'date_created': deserialize.rfc2822_datetime(payload.get('date_created')), 'date_updated': deserialize.rfc2822_datetime(payload.get('date_updated')), 'domain_sid': payload.get('domain_sid'), 'friendly_name': payload.get('friendly_name'), 'sid': payload.get('sid'), 'uri': payload.get('uri'), } # Context self._context = None self._solution = { 'account_sid': account_sid, 'domain_sid': domain_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: CredentialListMappingContext for this CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingContext """ if self._context is None: self._context = CredentialListMappingContext( self._version, account_sid=self._solution['account_sid'], domain_sid=self._solution['domain_sid'], sid=self._solution['sid'], ) return self._context @property def account_sid(self): """ :returns: The unique id of the Account that is responsible for this resource. :rtype: unicode """ return self._properties['account_sid'] @property def date_created(self): """ :returns: The date that this resource was created, given as GMT in RFC 2822 format. :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The date that this resource was last updated, given as GMT in RFC 2822 format. :rtype: datetime """ return self._properties['date_updated'] @property def domain_sid(self): """ :returns: The unique string that identifies the SipDomain resource. :rtype: unicode """ return self._properties['domain_sid'] @property def friendly_name(self): """ :returns: A human readable descriptive text for this resource, up to 64 characters long. :rtype: unicode """ return self._properties['friendly_name'] @property def sid(self): """ :returns: A 34 character string that uniquely identifies this resource. :rtype: unicode """ return self._properties['sid'] @property def uri(self): """ :returns: The URI for this resource, relative to https://api.twilio.com :rtype: unicode """ return self._properties['uri']
[docs] def fetch(self): """ Fetch the CredentialListMappingInstance :returns: The fetched CredentialListMappingInstance :rtype: twilio.rest.api.v2010.account.sip.domain.credential_list_mapping.CredentialListMappingInstance """ return self._proxy.fetch()
[docs] def delete(self): """ Deletes the CredentialListMappingInstance :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 '<Twilio.Api.V2010.CredentialListMappingInstance {}>'.format(context)