# 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 SupportingDocumentList(ListResource): def __init__(self, version): """ Initialize the SupportingDocumentList :param Version version: Version that contains the resource :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentList :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentList """ super(SupportingDocumentList, self).__init__(version) # Path Solution self._solution = {} self._uri = '/SupportingDocuments'.format(**self._solution) def create(self, friendly_name, type, attributes=values.unset): """ Create the SupportingDocumentInstance :param unicode friendly_name: The string that you assigned to describe the resource :param unicode type: The type of the Supporting Document :param dict attributes: The set of parameters that compose the Supporting Documents resource :returns: The created SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ data = values.of({ 'FriendlyName': friendly_name, 'Type': type, 'Attributes': serialize.object(attributes), }) payload = self._version.create(method='POST', uri=self._uri, data=data, ) return SupportingDocumentInstance(self._version, payload, ) def stream(self, limit=None, page_size=None): """ Streams SupportingDocumentInstance 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.trusthub.v1.supporting_document.SupportingDocumentInstance] """ 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 SupportingDocumentInstance 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.trusthub.v1.supporting_document.SupportingDocumentInstance] """ 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 SupportingDocumentInstance 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 SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage """ data = values.of({'PageToken': page_token, 'Page': page_number, 'PageSize': page_size, }) response = self._version.page(method='GET', uri=self._uri, params=data, ) return SupportingDocumentPage(self._version, response, self._solution) def get_page(self, target_url): """ Retrieve a specific page of SupportingDocumentInstance records from the API. Request is executed immediately :param str target_url: API-generated URL for the requested results page :returns: Page of SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage """ response = self._version.domain.twilio.request( 'GET', target_url, ) return SupportingDocumentPage(self._version, response, self._solution) def get(self, sid): """ Constructs a SupportingDocumentContext :param sid: The unique string that identifies the resource :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext """ return SupportingDocumentContext(self._version, sid=sid, ) def __call__(self, sid): """ Constructs a SupportingDocumentContext :param sid: The unique string that identifies the resource :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext """ return SupportingDocumentContext(self._version, sid=sid, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class SupportingDocumentPage(Page): def __init__(self, version, response, solution): """ Initialize the SupportingDocumentPage :param Version version: Version that contains the resource :param Response response: Response from the API :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage """ super(SupportingDocumentPage, self).__init__(version, response) # Path Solution self._solution = solution def get_instance(self, payload): """ Build an instance of SupportingDocumentInstance :param dict payload: Payload response from the API :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ return SupportingDocumentInstance(self._version, payload, ) def __repr__(self): """ Provide a friendly representation :returns: Machine friendly representation :rtype: str """ return '' class SupportingDocumentContext(InstanceContext): def __init__(self, version, sid): """ Initialize the SupportingDocumentContext :param Version version: Version that contains the resource :param sid: The unique string that identifies the resource :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext """ super(SupportingDocumentContext, self).__init__(version) # Path Solution self._solution = {'sid': sid, } self._uri = '/SupportingDocuments/{sid}'.format(**self._solution) def fetch(self): """ Fetch the SupportingDocumentInstance :returns: The fetched SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ payload = self._version.fetch(method='GET', uri=self._uri, ) return SupportingDocumentInstance(self._version, payload, sid=self._solution['sid'], ) def update(self, friendly_name=values.unset, attributes=values.unset): """ Update the SupportingDocumentInstance :param unicode friendly_name: The string that you assigned to describe the resource :param dict attributes: The set of parameters that compose the Supporting Document resource :returns: The updated SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ data = values.of({'FriendlyName': friendly_name, 'Attributes': serialize.object(attributes), }) payload = self._version.update(method='POST', uri=self._uri, data=data, ) return SupportingDocumentInstance(self._version, payload, sid=self._solution['sid'], ) def delete(self): """ Deletes the SupportingDocumentInstance :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 SupportingDocumentInstance(InstanceResource): class Status(object): DRAFT = "draft" PENDING_REVIEW = "pending-review" REJECTED = "rejected" APPROVED = "approved" EXPIRED = "expired" PROVISIONALLY_APPROVED = "provisionally-approved" def __init__(self, version, payload, sid=None): """ Initialize the SupportingDocumentInstance :returns: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ super(SupportingDocumentInstance, self).__init__(version) # Marshaled Properties self._properties = { 'sid': payload.get('sid'), 'account_sid': payload.get('account_sid'), 'friendly_name': payload.get('friendly_name'), 'mime_type': payload.get('mime_type'), 'status': payload.get('status'), 'type': payload.get('type'), 'attributes': payload.get('attributes'), 'date_created': deserialize.iso8601_datetime(payload.get('date_created')), 'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')), 'url': payload.get('url'), } # Context self._context = None self._solution = {'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: SupportingDocumentContext for this SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext """ if self._context is None: self._context = SupportingDocumentContext(self._version, sid=self._solution['sid'], ) return self._context @property def sid(self): """ :returns: The unique string that identifies the resource :rtype: unicode """ return self._properties['sid'] @property def account_sid(self): """ :returns: The SID of the Account that created the resource :rtype: unicode """ return self._properties['account_sid'] @property def friendly_name(self): """ :returns: The string that you assigned to describe the resource :rtype: unicode """ return self._properties['friendly_name'] @property def mime_type(self): """ :returns: The image type of the file :rtype: unicode """ return self._properties['mime_type'] @property def status(self): """ :returns: The verification status of the Supporting Document resource :rtype: SupportingDocumentInstance.Status """ return self._properties['status'] @property def type(self): """ :returns: The type of the Supporting Document :rtype: unicode """ return self._properties['type'] @property def attributes(self): """ :returns: The set of parameters that compose the Supporting Documents resource :rtype: dict """ return self._properties['attributes'] @property def date_created(self): """ :returns: The ISO 8601 date and time in GMT when the resource was created :rtype: datetime """ return self._properties['date_created'] @property def date_updated(self): """ :returns: The ISO 8601 date and time in GMT when the resource was last updated :rtype: datetime """ return self._properties['date_updated'] @property def url(self): """ :returns: The absolute URL of the Supporting Document resource :rtype: unicode """ return self._properties['url'] def fetch(self): """ Fetch the SupportingDocumentInstance :returns: The fetched SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ return self._proxy.fetch() def update(self, friendly_name=values.unset, attributes=values.unset): """ Update the SupportingDocumentInstance :param unicode friendly_name: The string that you assigned to describe the resource :param dict attributes: The set of parameters that compose the Supporting Document resource :returns: The updated SupportingDocumentInstance :rtype: twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance """ return self._proxy.update(friendly_name=friendly_name, attributes=attributes, ) def delete(self): """ Deletes the SupportingDocumentInstance :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)