r""" This code was generated by ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ Twilio - Numbers 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, serialize, 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 PortingAllPortInInstance(InstanceResource): """ :ivar port_in_request_sid: The SID of the Port-in request :ivar port_in_request_status: Status of the Port In Request :ivar status_last_updated_timestamp: The last updated timestamp of the request :ivar phone_numbers_requested: Amount of phone numbers requested :ivar phone_numbers_ported: Amount of phone numbers ported :ivar suggested_action: Suggested action on this ticket """ def __init__(self, version: Version, payload: Dict[str, Any]): super().__init__(version) self.port_in_request_sid: Optional[str] = payload.get("port_in_request_sid") self.port_in_request_status: Optional[str] = payload.get( "port_in_request_status" ) self.status_last_updated_timestamp: Optional[str] = payload.get( "status_last_updated_timestamp" ) self.phone_numbers_requested: Optional[int] = deserialize.integer( payload.get("phone_numbers_requested") ) self.phone_numbers_ported: Optional[int] = deserialize.integer( payload.get("phone_numbers_ported") ) self.suggested_action: Optional[str] = payload.get("suggested_action") def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class PortingAllPortInPage(Page): def get_instance(self, payload: Dict[str, Any]) -> PortingAllPortInInstance: """ Build an instance of PortingAllPortInInstance :param payload: Payload response from the API """ return PortingAllPortInInstance(self._version, payload) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class PortingAllPortInList(ListResource): def __init__(self, version: Version): """ Initialize the PortingAllPortInList :param version: Version that contains the resource """ super().__init__(version) self._uri = "/Porting/PortIn/PortInRequests" def stream( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[PortingAllPortInInstance]: """ Streams PortingAllPortInInstance 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 token: Page start token, if null then it will start from the beginning :param int size: Number of items per page :param str port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param str port_in_request_status: Filter by Port In request status :param datetime created_before: Find all created before a certain date :param datetime created_after: Find all created after a certain date :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( token=token, size=size, port_in_request_sid=port_in_request_sid, port_in_request_status=port_in_request_status, created_before=created_before, created_after=created_after, page_size=limits["page_size"], ) return self._version.stream(page, limits["limit"]) async def stream_async( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[PortingAllPortInInstance]: """ Asynchronously streams PortingAllPortInInstance 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 token: Page start token, if null then it will start from the beginning :param int size: Number of items per page :param str port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param str port_in_request_status: Filter by Port In request status :param datetime created_before: Find all created before a certain date :param datetime created_after: Find all created after a certain date :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( token=token, size=size, port_in_request_sid=port_in_request_sid, port_in_request_status=port_in_request_status, created_before=created_before, created_after=created_after, page_size=limits["page_size"], ) return self._version.stream_async(page, limits["limit"]) def list( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[PortingAllPortInInstance]: """ Lists PortingAllPortInInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str token: Page start token, if null then it will start from the beginning :param int size: Number of items per page :param str port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param str port_in_request_status: Filter by Port In request status :param datetime created_before: Find all created before a certain date :param datetime created_after: Find all created after a certain date :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( token=token, size=size, port_in_request_sid=port_in_request_sid, port_in_request_status=port_in_request_status, created_before=created_before, created_after=created_after, limit=limit, page_size=page_size, ) ) async def list_async( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[PortingAllPortInInstance]: """ Asynchronously lists PortingAllPortInInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str token: Page start token, if null then it will start from the beginning :param int size: Number of items per page :param str port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param str port_in_request_status: Filter by Port In request status :param datetime created_before: Find all created before a certain date :param datetime created_after: Find all created after a certain date :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( token=token, size=size, port_in_request_sid=port_in_request_sid, port_in_request_status=port_in_request_status, created_before=created_before, created_after=created_after, limit=limit, page_size=page_size, ) ] def page( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> PortingAllPortInPage: """ Retrieve a single page of PortingAllPortInInstance records from the API. Request is executed immediately :param token: Page start token, if null then it will start from the beginning :param size: Number of items per page :param port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param port_in_request_status: Filter by Port In request status :param created_before: Find all created before a certain date :param created_after: Find all created after a certain date :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 PortingAllPortInInstance """ data = values.of( { "Token": token, "Size": size, "PortInRequestSid": port_in_request_sid, "PortInRequestStatus": port_in_request_status, "CreatedBefore": serialize.iso8601_datetime(created_before), "CreatedAfter": serialize.iso8601_datetime(created_after), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) headers["Accept"] = "application/json" response = self._version.page( method="GET", uri=self._uri, params=data, headers=headers ) return PortingAllPortInPage(self._version, response) async def page_async( self, token: Union[str, object] = values.unset, size: Union[int, object] = values.unset, port_in_request_sid: Union[str, object] = values.unset, port_in_request_status: Union[str, object] = values.unset, created_before: Union[datetime, object] = values.unset, created_after: Union[datetime, object] = values.unset, page_token: Union[str, object] = values.unset, page_number: Union[int, object] = values.unset, page_size: Union[int, object] = values.unset, ) -> PortingAllPortInPage: """ Asynchronously retrieve a single page of PortingAllPortInInstance records from the API. Request is executed immediately :param token: Page start token, if null then it will start from the beginning :param size: Number of items per page :param port_in_request_sid: Filter by Port in request SID, supports multiple values separated by comma :param port_in_request_status: Filter by Port In request status :param created_before: Find all created before a certain date :param created_after: Find all created after a certain date :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 PortingAllPortInInstance """ data = values.of( { "Token": token, "Size": size, "PortInRequestSid": port_in_request_sid, "PortInRequestStatus": port_in_request_status, "CreatedBefore": serialize.iso8601_datetime(created_before), "CreatedAfter": serialize.iso8601_datetime(created_after), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) headers["Accept"] = "application/json" response = await self._version.page_async( method="GET", uri=self._uri, params=data, headers=headers ) return PortingAllPortInPage(self._version, response) def get_page(self, target_url: str) -> PortingAllPortInPage: """ Retrieve a specific page of PortingAllPortInInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of PortingAllPortInInstance """ response = self._version.domain.twilio.request("GET", target_url) return PortingAllPortInPage(self._version, response) async def get_page_async(self, target_url: str) -> PortingAllPortInPage: """ Asynchronously retrieve a specific page of PortingAllPortInInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of PortingAllPortInInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return PortingAllPortInPage(self._version, response) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""