r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Api 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 datetime import datetime from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator from twilio.base import deserialize, 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 DependentPhoneNumberInstance(InstanceResource): class AddressRequirement(object): NONE = "none" ANY = "any" LOCAL = "local" FOREIGN = "foreign" class EmergencyStatus(object): ACTIVE = "Active" INACTIVE = "Inactive" """ :ivar sid: The unique string that that we created to identify the DependentPhoneNumber resource. :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resource. :ivar friendly_name: The string that you assigned to describe the resource. :ivar phone_number: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. :ivar voice_url: The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set. :ivar voice_method: The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`. :ivar voice_fallback_method: The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`. :ivar voice_fallback_url: The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`. :ivar voice_caller_id_lookup: Whether we look up the caller's caller-ID name from the CNAM database. Can be: `true` or `false`. Caller ID lookups can cost $0.01 each. :ivar date_created: The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. :ivar date_updated: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. :ivar sms_fallback_method: The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`. :ivar sms_fallback_url: The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`. :ivar sms_method: The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`. :ivar sms_url: The URL we call when the phone number receives an incoming SMS message. :ivar address_requirements: :ivar capabilities: The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`. :ivar status_callback: The URL we call using the `status_callback_method` to send status information to your application. :ivar status_callback_method: The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`. :ivar api_version: The API version used to start a new TwiML session. :ivar sms_application_sid: The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application. :ivar voice_application_sid: The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. :ivar trunk_sid: The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. :ivar emergency_status: :ivar emergency_address_sid: The SID of the emergency address configuration that we use for emergency calling from the phone number. :ivar uri: The URI of the resource, relative to `https://api.twilio.com`. """ def __init__( self, version: Version, payload: Dict[str, Any], account_sid: str, address_sid: str, ): 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.phone_number: Optional[str] = payload.get("phone_number") self.voice_url: Optional[str] = payload.get("voice_url") self.voice_method: Optional[str] = payload.get("voice_method") self.voice_fallback_method: Optional[str] = payload.get("voice_fallback_method") self.voice_fallback_url: Optional[str] = payload.get("voice_fallback_url") self.voice_caller_id_lookup: Optional[bool] = payload.get( "voice_caller_id_lookup" ) self.date_created: Optional[datetime] = deserialize.rfc2822_datetime( payload.get("date_created") ) self.date_updated: Optional[datetime] = deserialize.rfc2822_datetime( payload.get("date_updated") ) self.sms_fallback_method: Optional[str] = payload.get("sms_fallback_method") self.sms_fallback_url: Optional[str] = payload.get("sms_fallback_url") self.sms_method: Optional[str] = payload.get("sms_method") self.sms_url: Optional[str] = payload.get("sms_url") self.address_requirements: Optional[ "DependentPhoneNumberInstance.AddressRequirement" ] = payload.get("address_requirements") self.capabilities: Optional[Dict[str, object]] = payload.get("capabilities") self.status_callback: Optional[str] = payload.get("status_callback") self.status_callback_method: Optional[str] = payload.get( "status_callback_method" ) self.api_version: Optional[str] = payload.get("api_version") self.sms_application_sid: Optional[str] = payload.get("sms_application_sid") self.voice_application_sid: Optional[str] = payload.get("voice_application_sid") self.trunk_sid: Optional[str] = payload.get("trunk_sid") self.emergency_status: Optional[ "DependentPhoneNumberInstance.EmergencyStatus" ] = payload.get("emergency_status") self.emergency_address_sid: Optional[str] = payload.get("emergency_address_sid") self.uri: Optional[str] = payload.get("uri") self._solution = { "account_sid": account_sid, "address_sid": address_sid, } def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) return "".format(context) class DependentPhoneNumberPage(Page): def get_instance(self, payload: Dict[str, Any]) -> DependentPhoneNumberInstance: """ Build an instance of DependentPhoneNumberInstance :param payload: Payload response from the API """ return DependentPhoneNumberInstance( self._version, payload, account_sid=self._solution["account_sid"], address_sid=self._solution["address_sid"], ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class DependentPhoneNumberList(ListResource): def __init__(self, version: Version, account_sid: str, address_sid: str): """ Initialize the DependentPhoneNumberList :param version: Version that contains the resource :param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resources to read. :param address_sid: The SID of the Address resource associated with the phone number. """ super().__init__(version) # Path Solution self._solution = { "account_sid": account_sid, "address_sid": address_sid, } self._uri = "/Accounts/{account_sid}/Addresses/{address_sid}/DependentPhoneNumbers.json".format( **self._solution ) def stream( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[DependentPhoneNumberInstance]: """ Streams DependentPhoneNumberInstance 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 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(page_size=limits["page_size"]) return self._version.stream(page, limits["limit"]) async def stream_async( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[DependentPhoneNumberInstance]: """ Asynchronously streams DependentPhoneNumberInstance 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 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(page_size=limits["page_size"]) return self._version.stream_async(page, limits["limit"]) def list( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[DependentPhoneNumberInstance]: """ Lists DependentPhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :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( limit=limit, page_size=page_size, ) ) async def list_async( self, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[DependentPhoneNumberInstance]: """ Asynchronously lists DependentPhoneNumberInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :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( limit=limit, page_size=page_size, ) ] def page( self, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> DependentPhoneNumberPage: """ Retrieve a single page of DependentPhoneNumberInstance records from the API. Request is executed immediately :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 DependentPhoneNumberInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return DependentPhoneNumberPage(self._version, response, self._solution) async def page_async( self, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> DependentPhoneNumberPage: """ Asynchronously retrieve a single page of DependentPhoneNumberInstance records from the API. Request is executed immediately :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 DependentPhoneNumberInstance """ data = values.of( { "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return DependentPhoneNumberPage(self._version, response, self._solution) def get_page(self, target_url: str) -> DependentPhoneNumberPage: """ Retrieve a specific page of DependentPhoneNumberInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of DependentPhoneNumberInstance """ response = self._version.domain.twilio.request("GET", target_url) return DependentPhoneNumberPage(self._version, response, self._solution) async def get_page_async(self, target_url: str) -> DependentPhoneNumberPage: """ Asynchronously retrieve a specific page of DependentPhoneNumberInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of DependentPhoneNumberInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return DependentPhoneNumberPage(self._version, response, self._solution) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""