r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Verify This is the public Twilio REST API. NOTE: This class is auto generated by OpenAPI Generator. https://openapi-generator.tech Do not edit the class manually. """ from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator from twilio.base import values from twilio.base.instance_resource import InstanceResource from twilio.base.list_resource import ListResource from twilio.base.version import Version from twilio.base.page import Page class TemplateInstance(InstanceResource): """ :ivar sid: A 34 character string that uniquely identifies a Verification Template. :ivar account_sid: The unique SID identifier of the Account. :ivar friendly_name: A descriptive string that you create to describe a Template. It can be up to 32 characters long. :ivar channels: A list of channels that support the Template. Can include: sms, voice. :ivar translations: An object that contains the different translations of the template. Every translation is identified by the language short name and contains its respective information as the approval status, text and created/modified date. """ def __init__(self, version: Version, payload: Dict[str, Any]): super().__init__(version) self.sid: Optional[str] = payload.get("sid") self.account_sid: Optional[str] = payload.get("account_sid") self.friendly_name: Optional[str] = payload.get("friendly_name") self.channels: Optional[List[str]] = payload.get("channels") self.translations: Optional[Dict[str, object]] = payload.get("translations") def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class TemplatePage(Page): def get_instance(self, payload: Dict[str, Any]) -> TemplateInstance: """ Build an instance of TemplateInstance :param payload: Payload response from the API """ return TemplateInstance(self._version, payload) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class TemplateList(ListResource): def __init__(self, version: Version): """ Initialize the TemplateList :param version: Version that contains the resource """ super().__init__(version) self._uri = "/Templates" def stream( self, friendly_name: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[TemplateInstance]: """ Streams TemplateInstance 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 str friendly_name: String filter used to query templates with a given friendly name. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param 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 """ limits = self._version.read_limits(limit, page_size) page = self.page(friendly_name=friendly_name, page_size=limits["page_size"]) return self._version.stream(page, limits["limit"]) async def stream_async( self, friendly_name: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[TemplateInstance]: """ Asynchronously streams TemplateInstance 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 str friendly_name: String filter used to query templates with a given friendly name. :param limit: Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit :param 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 """ limits = self._version.read_limits(limit, page_size) page = await self.page_async( friendly_name=friendly_name, page_size=limits["page_size"] ) return self._version.stream_async(page, limits["limit"]) def list( self, friendly_name: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[TemplateInstance]: """ Lists TemplateInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str friendly_name: String filter used to query templates with a given friendly name. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param 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: list that will contain up to limit results """ return list( self.stream( friendly_name=friendly_name, limit=limit, page_size=page_size, ) ) async def list_async( self, friendly_name: Union[str, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[TemplateInstance]: """ Asynchronously lists TemplateInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str friendly_name: String filter used to query templates with a given friendly name. :param limit: Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit :param 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: list that will contain up to limit results """ return [ record async for record in await self.stream_async( friendly_name=friendly_name, limit=limit, page_size=page_size, ) ] def page( self, friendly_name: Union[str, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> TemplatePage: """ Retrieve a single page of TemplateInstance records from the API. Request is executed immediately :param friendly_name: String filter used to query templates with a given friendly name. :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of TemplateInstance """ data = values.of( { "FriendlyName": friendly_name, "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return TemplatePage(self._version, response) async def page_async( self, friendly_name: Union[str, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> TemplatePage: """ Asynchronously retrieve a single page of TemplateInstance records from the API. Request is executed immediately :param friendly_name: String filter used to query templates with a given friendly name. :param page_token: PageToken provided by the API :param page_number: Page Number, this value is simply for client state :param page_size: Number of records to return, defaults to 50 :returns: Page of TemplateInstance """ data = values.of( { "FriendlyName": friendly_name, "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return TemplatePage(self._version, response) def get_page(self, target_url: str) -> TemplatePage: """ Retrieve a specific page of TemplateInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of TemplateInstance """ response = self._version.domain.twilio.request("GET", target_url) return TemplatePage(self._version, response) async def get_page_async(self, target_url: str) -> TemplatePage: """ Asynchronously retrieve a specific page of TemplateInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of TemplateInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return TemplatePage(self._version, response) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""