r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Lookups 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 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.version import Version class PhoneNumberInstance(InstanceResource): class ValidationError(object): TOO_SHORT = "TOO_SHORT" TOO_LONG = "TOO_LONG" INVALID_BUT_POSSIBLE = "INVALID_BUT_POSSIBLE" INVALID_COUNTRY_CODE = "INVALID_COUNTRY_CODE" INVALID_LENGTH = "INVALID_LENGTH" NOT_A_NUMBER = "NOT_A_NUMBER" """ :ivar calling_country_code: International dialing prefix of the phone number defined in the E.164 standard. :ivar country_code: The phone number's [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). :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 national_format: The phone number in [national format](https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers). :ivar valid: Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user. :ivar validation_errors: Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER. :ivar caller_name: :ivar sim_swap: :ivar call_forwarding: :ivar line_type_intelligence: :ivar line_status: :ivar identity_match: :ivar reassigned_number: :ivar sms_pumping_risk: :ivar phone_number_quality_score: An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number. :ivar pre_fill: An object that contains pre fill information. pre_fill will return PII information associated with the phone number like first name, last name, address line, country code, state and postal code. :ivar url: The absolute URL of the resource. """ def __init__( self, version: Version, payload: Dict[str, Any], phone_number: Optional[str] = None, ): super().__init__(version) self.calling_country_code: Optional[str] = payload.get("calling_country_code") self.country_code: Optional[str] = payload.get("country_code") self.phone_number: Optional[str] = payload.get("phone_number") self.national_format: Optional[str] = payload.get("national_format") self.valid: Optional[bool] = payload.get("valid") self.validation_errors: Optional[List[str]] = payload.get("validation_errors") self.caller_name: Optional[str] = payload.get("caller_name") self.sim_swap: Optional[str] = payload.get("sim_swap") self.call_forwarding: Optional[str] = payload.get("call_forwarding") self.line_type_intelligence: Optional[str] = payload.get( "line_type_intelligence" ) self.line_status: Optional[str] = payload.get("line_status") self.identity_match: Optional[str] = payload.get("identity_match") self.reassigned_number: Optional[str] = payload.get("reassigned_number") self.sms_pumping_risk: Optional[str] = payload.get("sms_pumping_risk") self.phone_number_quality_score: Optional[Dict[str, object]] = payload.get( "phone_number_quality_score" ) self.pre_fill: Optional[Dict[str, object]] = payload.get("pre_fill") self.url: Optional[str] = payload.get("url") self._solution = { "phone_number": phone_number or self.phone_number, } self._context: Optional[PhoneNumberContext] = None @property def _proxy(self) -> "PhoneNumberContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: PhoneNumberContext for this PhoneNumberInstance """ if self._context is None: self._context = PhoneNumberContext( self._version, phone_number=self._solution["phone_number"], ) return self._context def fetch( self, fields: Union[str, object] = values.unset, country_code: Union[str, object] = values.unset, first_name: Union[str, object] = values.unset, last_name: Union[str, object] = values.unset, address_line1: Union[str, object] = values.unset, address_line2: Union[str, object] = values.unset, city: Union[str, object] = values.unset, state: Union[str, object] = values.unset, postal_code: Union[str, object] = values.unset, address_country_code: Union[str, object] = values.unset, national_id: Union[str, object] = values.unset, date_of_birth: Union[str, object] = values.unset, last_verified_date: Union[str, object] = values.unset, verification_sid: Union[str, object] = values.unset, partner_sub_id: Union[str, object] = values.unset, ) -> "PhoneNumberInstance": """ Fetch the PhoneNumberInstance :param fields: A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill. :param country_code: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format. :param first_name: User’s first name. This query parameter is only used (optionally) for identity_match package requests. :param last_name: User’s last name. This query parameter is only used (optionally) for identity_match package requests. :param address_line1: User’s first address line. This query parameter is only used (optionally) for identity_match package requests. :param address_line2: User’s second address line. This query parameter is only used (optionally) for identity_match package requests. :param city: User’s city. This query parameter is only used (optionally) for identity_match package requests. :param state: User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests. :param postal_code: User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests. :param address_country_code: User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests. :param national_id: User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests. :param date_of_birth: User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests. :param last_verified_date: The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests. :param verification_sid: The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests. :param partner_sub_id: The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis. :returns: The fetched PhoneNumberInstance """ return self._proxy.fetch( fields=fields, country_code=country_code, first_name=first_name, last_name=last_name, address_line1=address_line1, address_line2=address_line2, city=city, state=state, postal_code=postal_code, address_country_code=address_country_code, national_id=national_id, date_of_birth=date_of_birth, last_verified_date=last_verified_date, verification_sid=verification_sid, partner_sub_id=partner_sub_id, ) async def fetch_async( self, fields: Union[str, object] = values.unset, country_code: Union[str, object] = values.unset, first_name: Union[str, object] = values.unset, last_name: Union[str, object] = values.unset, address_line1: Union[str, object] = values.unset, address_line2: Union[str, object] = values.unset, city: Union[str, object] = values.unset, state: Union[str, object] = values.unset, postal_code: Union[str, object] = values.unset, address_country_code: Union[str, object] = values.unset, national_id: Union[str, object] = values.unset, date_of_birth: Union[str, object] = values.unset, last_verified_date: Union[str, object] = values.unset, verification_sid: Union[str, object] = values.unset, partner_sub_id: Union[str, object] = values.unset, ) -> "PhoneNumberInstance": """ Asynchronous coroutine to fetch the PhoneNumberInstance :param fields: A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill. :param country_code: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format. :param first_name: User’s first name. This query parameter is only used (optionally) for identity_match package requests. :param last_name: User’s last name. This query parameter is only used (optionally) for identity_match package requests. :param address_line1: User’s first address line. This query parameter is only used (optionally) for identity_match package requests. :param address_line2: User’s second address line. This query parameter is only used (optionally) for identity_match package requests. :param city: User’s city. This query parameter is only used (optionally) for identity_match package requests. :param state: User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests. :param postal_code: User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests. :param address_country_code: User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests. :param national_id: User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests. :param date_of_birth: User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests. :param last_verified_date: The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests. :param verification_sid: The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests. :param partner_sub_id: The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis. :returns: The fetched PhoneNumberInstance """ return await self._proxy.fetch_async( fields=fields, country_code=country_code, first_name=first_name, last_name=last_name, address_line1=address_line1, address_line2=address_line2, city=city, state=state, postal_code=postal_code, address_country_code=address_country_code, national_id=national_id, date_of_birth=date_of_birth, last_verified_date=last_verified_date, verification_sid=verification_sid, partner_sub_id=partner_sub_id, ) 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 PhoneNumberContext(InstanceContext): def __init__(self, version: Version, phone_number: str): """ Initialize the PhoneNumberContext :param version: Version that contains the resource :param phone_number: The phone number to lookup in E.164 or national format. Default country code is +1 (North America). """ super().__init__(version) # Path Solution self._solution = { "phone_number": phone_number, } self._uri = "/PhoneNumbers/{phone_number}".format(**self._solution) def fetch( self, fields: Union[str, object] = values.unset, country_code: Union[str, object] = values.unset, first_name: Union[str, object] = values.unset, last_name: Union[str, object] = values.unset, address_line1: Union[str, object] = values.unset, address_line2: Union[str, object] = values.unset, city: Union[str, object] = values.unset, state: Union[str, object] = values.unset, postal_code: Union[str, object] = values.unset, address_country_code: Union[str, object] = values.unset, national_id: Union[str, object] = values.unset, date_of_birth: Union[str, object] = values.unset, last_verified_date: Union[str, object] = values.unset, verification_sid: Union[str, object] = values.unset, partner_sub_id: Union[str, object] = values.unset, ) -> PhoneNumberInstance: """ Fetch the PhoneNumberInstance :param fields: A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill. :param country_code: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format. :param first_name: User’s first name. This query parameter is only used (optionally) for identity_match package requests. :param last_name: User’s last name. This query parameter is only used (optionally) for identity_match package requests. :param address_line1: User’s first address line. This query parameter is only used (optionally) for identity_match package requests. :param address_line2: User’s second address line. This query parameter is only used (optionally) for identity_match package requests. :param city: User’s city. This query parameter is only used (optionally) for identity_match package requests. :param state: User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests. :param postal_code: User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests. :param address_country_code: User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests. :param national_id: User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests. :param date_of_birth: User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests. :param last_verified_date: The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests. :param verification_sid: The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests. :param partner_sub_id: The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis. :returns: The fetched PhoneNumberInstance """ params = values.of( { "Fields": fields, "CountryCode": country_code, "FirstName": first_name, "LastName": last_name, "AddressLine1": address_line1, "AddressLine2": address_line2, "City": city, "State": state, "PostalCode": postal_code, "AddressCountryCode": address_country_code, "NationalId": national_id, "DateOfBirth": date_of_birth, "LastVerifiedDate": last_verified_date, "VerificationSid": verification_sid, "PartnerSubId": partner_sub_id, } ) headers = values.of({}) headers["Accept"] = "application/json" payload = self._version.fetch( method="GET", uri=self._uri, params=params, headers=headers ) return PhoneNumberInstance( self._version, payload, phone_number=self._solution["phone_number"], ) async def fetch_async( self, fields: Union[str, object] = values.unset, country_code: Union[str, object] = values.unset, first_name: Union[str, object] = values.unset, last_name: Union[str, object] = values.unset, address_line1: Union[str, object] = values.unset, address_line2: Union[str, object] = values.unset, city: Union[str, object] = values.unset, state: Union[str, object] = values.unset, postal_code: Union[str, object] = values.unset, address_country_code: Union[str, object] = values.unset, national_id: Union[str, object] = values.unset, date_of_birth: Union[str, object] = values.unset, last_verified_date: Union[str, object] = values.unset, verification_sid: Union[str, object] = values.unset, partner_sub_id: Union[str, object] = values.unset, ) -> PhoneNumberInstance: """ Asynchronous coroutine to fetch the PhoneNumberInstance :param fields: A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill. :param country_code: The [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format. :param first_name: User’s first name. This query parameter is only used (optionally) for identity_match package requests. :param last_name: User’s last name. This query parameter is only used (optionally) for identity_match package requests. :param address_line1: User’s first address line. This query parameter is only used (optionally) for identity_match package requests. :param address_line2: User’s second address line. This query parameter is only used (optionally) for identity_match package requests. :param city: User’s city. This query parameter is only used (optionally) for identity_match package requests. :param state: User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests. :param postal_code: User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests. :param address_country_code: User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests. :param national_id: User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests. :param date_of_birth: User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests. :param last_verified_date: The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests. :param verification_sid: The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests. :param partner_sub_id: The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis. :returns: The fetched PhoneNumberInstance """ params = values.of( { "Fields": fields, "CountryCode": country_code, "FirstName": first_name, "LastName": last_name, "AddressLine1": address_line1, "AddressLine2": address_line2, "City": city, "State": state, "PostalCode": postal_code, "AddressCountryCode": address_country_code, "NationalId": national_id, "DateOfBirth": date_of_birth, "LastVerifiedDate": last_verified_date, "VerificationSid": verification_sid, "PartnerSubId": partner_sub_id, } ) headers = values.of({}) headers["Accept"] = "application/json" payload = await self._version.fetch_async( method="GET", uri=self._uri, params=params, headers=headers ) return PhoneNumberInstance( self._version, payload, phone_number=self._solution["phone_number"], ) 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 PhoneNumberList(ListResource): def __init__(self, version: Version): """ Initialize the PhoneNumberList :param version: Version that contains the resource """ super().__init__(version) def get(self, phone_number: str) -> PhoneNumberContext: """ Constructs a PhoneNumberContext :param phone_number: The phone number to lookup in E.164 or national format. Default country code is +1 (North America). """ return PhoneNumberContext(self._version, phone_number=phone_number) def __call__(self, phone_number: str) -> PhoneNumberContext: """ Constructs a PhoneNumberContext :param phone_number: The phone number to lookup in E.164 or national format. Default country code is +1 (North America). """ return PhoneNumberContext(self._version, phone_number=phone_number) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""