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, serialize, 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 from twilio.base.page import Page from twilio.rest.api.v2010.account.message.feedback import FeedbackList from twilio.rest.api.v2010.account.message.media import MediaList class MessageInstance(InstanceResource): class AddressRetention(object): RETAIN = "retain" class ContentRetention(object): RETAIN = "retain" class Direction(object): INBOUND = "inbound" OUTBOUND_API = "outbound-api" OUTBOUND_CALL = "outbound-call" OUTBOUND_REPLY = "outbound-reply" class ScheduleType(object): FIXED = "fixed" class Status(object): QUEUED = "queued" SENDING = "sending" SENT = "sent" FAILED = "failed" DELIVERED = "delivered" UNDELIVERED = "undelivered" RECEIVING = "receiving" RECEIVED = "received" ACCEPTED = "accepted" SCHEDULED = "scheduled" READ = "read" PARTIALLY_DELIVERED = "partially_delivered" CANCELED = "canceled" class UpdateStatus(object): CANCELED = "canceled" """ :ivar body: The message text. Can be up to 1,600 characters long. :ivar num_segments: The number of segments that make up the complete message. A message body that is too large to be sent in a single SMS message is segmented and charged as multiple messages. Inbound messages over 160 characters are reassembled when the message is received. Note: When using a Messaging Service to send messages, `num_segments` will always be 0 in Twilio's response to your API request. :ivar direction: :ivar from_: The phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or [Wireless SIM](https://www.twilio.com/docs/wireless/tutorials/communications-guides/how-to-send-and-receive-text-messages) that initiated the message. For incoming messages, this will be the number of the sending phone. For outgoing messages, this value will be one of your Twilio phone numbers or the alphanumeric sender ID used. :ivar to: The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format that received the message. For incoming messages, this will be one of your Twilio phone numbers. For outgoing messages, this will be the sending phone. :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 price: The amount billed for the message, in the currency specified by `price_unit`. Note that your account is charged for each segment we send to the handset. Populated after the message has been sent. May not be immediately available. :ivar error_message: The description of the `error_code` if your message `status` is `failed` or `undelivered`. If the message was successful, this value is null. :ivar uri: The URI of the resource, relative to `https://api.twilio.com`. :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that sent the message that created the resource. :ivar num_media: The number of media files associated with the message. A message can send up to 10 media files. :ivar status: :ivar messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) used with the message. The value is null if a Messaging Service was not used. :ivar sid: The unique string that that we created to identify the Message resource. :ivar date_sent: The date and time in GMT that the resource was sent specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. For outgoing messages, this is when we sent the message. For incoming messages, this is when we made the HTTP request to your application. :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 error_code: The error code returned if your message `status` is `failed` or `undelivered`. The error_code provides more information about the failure. If the message was successful, this value is null. :ivar price_unit: The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`). :ivar api_version: The API version used to process the message. :ivar subresource_uris: A list of related resources identified by their URIs relative to `https://api.twilio.com` """ def __init__( self, version: Version, payload: Dict[str, Any], account_sid: str, sid: Optional[str] = None, ): super().__init__(version) self.body: Optional[str] = payload.get("body") self.num_segments: Optional[str] = payload.get("num_segments") self.direction: Optional["MessageInstance.Direction"] = payload.get("direction") self.from_: Optional[str] = payload.get("from") self.to: Optional[str] = payload.get("to") self.date_updated: Optional[datetime] = deserialize.rfc2822_datetime( payload.get("date_updated") ) self.price: Optional[str] = payload.get("price") self.error_message: Optional[str] = payload.get("error_message") self.uri: Optional[str] = payload.get("uri") self.account_sid: Optional[str] = payload.get("account_sid") self.num_media: Optional[str] = payload.get("num_media") self.status: Optional["MessageInstance.Status"] = payload.get("status") self.messaging_service_sid: Optional[str] = payload.get("messaging_service_sid") self.sid: Optional[str] = payload.get("sid") self.date_sent: Optional[datetime] = deserialize.rfc2822_datetime( payload.get("date_sent") ) self.date_created: Optional[datetime] = deserialize.rfc2822_datetime( payload.get("date_created") ) self.error_code: Optional[int] = deserialize.integer(payload.get("error_code")) self.price_unit: Optional[str] = payload.get("price_unit") self.api_version: Optional[str] = payload.get("api_version") self.subresource_uris: Optional[Dict[str, object]] = payload.get( "subresource_uris" ) self._solution = { "account_sid": account_sid, "sid": sid or self.sid, } self._context: Optional[MessageContext] = None @property def _proxy(self) -> "MessageContext": """ Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context :returns: MessageContext for this MessageInstance """ if self._context is None: self._context = MessageContext( self._version, account_sid=self._solution["account_sid"], sid=self._solution["sid"], ) return self._context def delete(self) -> bool: """ Deletes the MessageInstance :returns: True if delete succeeds, False otherwise """ return self._proxy.delete() async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the MessageInstance :returns: True if delete succeeds, False otherwise """ return await self._proxy.delete_async() def fetch(self) -> "MessageInstance": """ Fetch the MessageInstance :returns: The fetched MessageInstance """ return self._proxy.fetch() async def fetch_async(self) -> "MessageInstance": """ Asynchronous coroutine to fetch the MessageInstance :returns: The fetched MessageInstance """ return await self._proxy.fetch_async() def update( self, body: Union[str, object] = values.unset, status: Union["MessageInstance.UpdateStatus", object] = values.unset, ) -> "MessageInstance": """ Update the MessageInstance :param body: The text of the message you want to send. Can be up to 1,600 characters long. :param status: :returns: The updated MessageInstance """ return self._proxy.update( body=body, status=status, ) async def update_async( self, body: Union[str, object] = values.unset, status: Union["MessageInstance.UpdateStatus", object] = values.unset, ) -> "MessageInstance": """ Asynchronous coroutine to update the MessageInstance :param body: The text of the message you want to send. Can be up to 1,600 characters long. :param status: :returns: The updated MessageInstance """ return await self._proxy.update_async( body=body, status=status, ) @property def feedback(self) -> FeedbackList: """ Access the feedback """ return self._proxy.feedback @property def media(self) -> MediaList: """ Access the media """ return self._proxy.media 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 MessageContext(InstanceContext): def __init__(self, version: Version, account_sid: str, sid: str): """ Initialize the MessageContext :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 Message resources to update. :param sid: The Twilio-provided string that uniquely identifies the Message resource to update. """ super().__init__(version) # Path Solution self._solution = { "account_sid": account_sid, "sid": sid, } self._uri = "/Accounts/{account_sid}/Messages/{sid}.json".format( **self._solution ) self._feedback: Optional[FeedbackList] = None self._media: Optional[MediaList] = None def delete(self) -> bool: """ Deletes the MessageInstance :returns: True if delete succeeds, False otherwise """ return self._version.delete( method="DELETE", uri=self._uri, ) async def delete_async(self) -> bool: """ Asynchronous coroutine that deletes the MessageInstance :returns: True if delete succeeds, False otherwise """ return await self._version.delete_async( method="DELETE", uri=self._uri, ) def fetch(self) -> MessageInstance: """ Fetch the MessageInstance :returns: The fetched MessageInstance """ payload = self._version.fetch( method="GET", uri=self._uri, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"], sid=self._solution["sid"], ) async def fetch_async(self) -> MessageInstance: """ Asynchronous coroutine to fetch the MessageInstance :returns: The fetched MessageInstance """ payload = await self._version.fetch_async( method="GET", uri=self._uri, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"], sid=self._solution["sid"], ) def update( self, body: Union[str, object] = values.unset, status: Union["MessageInstance.UpdateStatus", object] = values.unset, ) -> MessageInstance: """ Update the MessageInstance :param body: The text of the message you want to send. Can be up to 1,600 characters long. :param status: :returns: The updated MessageInstance """ data = values.of( { "Body": body, "Status": status, } ) payload = self._version.update( method="POST", uri=self._uri, data=data, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"], sid=self._solution["sid"], ) async def update_async( self, body: Union[str, object] = values.unset, status: Union["MessageInstance.UpdateStatus", object] = values.unset, ) -> MessageInstance: """ Asynchronous coroutine to update the MessageInstance :param body: The text of the message you want to send. Can be up to 1,600 characters long. :param status: :returns: The updated MessageInstance """ data = values.of( { "Body": body, "Status": status, } ) payload = await self._version.update_async( method="POST", uri=self._uri, data=data, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"], sid=self._solution["sid"], ) @property def feedback(self) -> FeedbackList: """ Access the feedback """ if self._feedback is None: self._feedback = FeedbackList( self._version, self._solution["account_sid"], self._solution["sid"], ) return self._feedback @property def media(self) -> MediaList: """ Access the media """ if self._media is None: self._media = MediaList( self._version, self._solution["account_sid"], self._solution["sid"], ) return self._media 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 MessagePage(Page): def get_instance(self, payload: Dict[str, Any]) -> MessageInstance: """ Build an instance of MessageInstance :param payload: Payload response from the API """ return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"] ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return "" class MessageList(ListResource): def __init__(self, version: Version, account_sid: str): """ Initialize the MessageList :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 Message resources to read. """ super().__init__(version) # Path Solution self._solution = { "account_sid": account_sid, } self._uri = "/Accounts/{account_sid}/Messages.json".format(**self._solution) def create( self, to: str, status_callback: Union[str, object] = values.unset, application_sid: Union[str, object] = values.unset, max_price: Union[float, object] = values.unset, provide_feedback: Union[bool, object] = values.unset, attempt: Union[int, object] = values.unset, validity_period: Union[int, object] = values.unset, force_delivery: Union[bool, object] = values.unset, content_retention: Union[ "MessageInstance.ContentRetention", object ] = values.unset, address_retention: Union[ "MessageInstance.AddressRetention", object ] = values.unset, smart_encoded: Union[bool, object] = values.unset, persistent_action: Union[List[str], object] = values.unset, shorten_urls: Union[bool, object] = values.unset, schedule_type: Union["MessageInstance.ScheduleType", object] = values.unset, send_at: Union[datetime, object] = values.unset, send_as_mms: Union[bool, object] = values.unset, content_variables: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, messaging_service_sid: Union[str, object] = values.unset, body: Union[str, object] = values.unset, media_url: Union[List[str], object] = values.unset, content_sid: Union[str, object] = values.unset, ) -> MessageInstance: """ Create the MessageInstance :param to: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels. :param status_callback: The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed. :param application_sid: The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used. :param max_price: The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked. :param provide_feedback: Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default. :param attempt: Total number of attempts made ( including this ) to send out the message regardless of the provider used :param validity_period: How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds. :param force_delivery: Reserved :param content_retention: :param address_retention: :param smart_encoded: Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`. :param persistent_action: Rich actions for Channels Messages. :param shorten_urls: Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`. :param schedule_type: :param send_at: The time that Twilio will send the message. Must be in ISO 8601 format. :param send_as_mms: If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. :param content_variables: Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time. :param from_: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty. :param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery. :param body: The text of the message you want to send. Can be up to 1,600 characters in length. :param media_url: The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada. :param content_sid: The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized. :returns: The created MessageInstance """ data = values.of( { "To": to, "StatusCallback": status_callback, "ApplicationSid": application_sid, "MaxPrice": max_price, "ProvideFeedback": provide_feedback, "Attempt": attempt, "ValidityPeriod": validity_period, "ForceDelivery": force_delivery, "ContentRetention": content_retention, "AddressRetention": address_retention, "SmartEncoded": smart_encoded, "PersistentAction": serialize.map(persistent_action, lambda e: e), "ShortenUrls": shorten_urls, "ScheduleType": schedule_type, "SendAt": serialize.iso8601_datetime(send_at), "SendAsMms": send_as_mms, "ContentVariables": content_variables, "From": from_, "MessagingServiceSid": messaging_service_sid, "Body": body, "MediaUrl": serialize.map(media_url, lambda e: e), "ContentSid": content_sid, } ) payload = self._version.create( method="POST", uri=self._uri, data=data, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"] ) async def create_async( self, to: str, status_callback: Union[str, object] = values.unset, application_sid: Union[str, object] = values.unset, max_price: Union[float, object] = values.unset, provide_feedback: Union[bool, object] = values.unset, attempt: Union[int, object] = values.unset, validity_period: Union[int, object] = values.unset, force_delivery: Union[bool, object] = values.unset, content_retention: Union[ "MessageInstance.ContentRetention", object ] = values.unset, address_retention: Union[ "MessageInstance.AddressRetention", object ] = values.unset, smart_encoded: Union[bool, object] = values.unset, persistent_action: Union[List[str], object] = values.unset, shorten_urls: Union[bool, object] = values.unset, schedule_type: Union["MessageInstance.ScheduleType", object] = values.unset, send_at: Union[datetime, object] = values.unset, send_as_mms: Union[bool, object] = values.unset, content_variables: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, messaging_service_sid: Union[str, object] = values.unset, body: Union[str, object] = values.unset, media_url: Union[List[str], object] = values.unset, content_sid: Union[str, object] = values.unset, ) -> MessageInstance: """ Asynchronously create the MessageInstance :param to: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels. :param status_callback: The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed. :param application_sid: The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used. :param max_price: The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked. :param provide_feedback: Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default. :param attempt: Total number of attempts made ( including this ) to send out the message regardless of the provider used :param validity_period: How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds. :param force_delivery: Reserved :param content_retention: :param address_retention: :param smart_encoded: Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`. :param persistent_action: Rich actions for Channels Messages. :param shorten_urls: Determines the usage of Click Tracking. Setting it to `true` will instruct Twilio to replace all links in the Message with a shortened version based on the associated Domain Sid and track clicks on them. If this parameter is not set on an API call, we will use the value set on the Messaging Service. If this parameter is not set and the value is not configured on the Messaging Service used this will default to `false`. :param schedule_type: :param send_at: The time that Twilio will send the message. Must be in ISO 8601 format. :param send_as_mms: If set to True, Twilio will deliver the message as a single MMS message, regardless of the presence of media. :param content_variables: Key-value pairs of variable names to substitution values, used alongside a content_sid. If not specified, Content API will default to the default variables defined at create time. :param from_: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty. :param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery. :param body: The text of the message you want to send. Can be up to 1,600 characters in length. :param media_url: The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada. :param content_sid: The SID of the Content object returned at Content API content create time (https://www.twilio.com/docs/content-api/create-and-send-your-first-content-api-template#create-a-template). If this parameter is not specified, then the Content API will not be utilized. :returns: The created MessageInstance """ data = values.of( { "To": to, "StatusCallback": status_callback, "ApplicationSid": application_sid, "MaxPrice": max_price, "ProvideFeedback": provide_feedback, "Attempt": attempt, "ValidityPeriod": validity_period, "ForceDelivery": force_delivery, "ContentRetention": content_retention, "AddressRetention": address_retention, "SmartEncoded": smart_encoded, "PersistentAction": serialize.map(persistent_action, lambda e: e), "ShortenUrls": shorten_urls, "ScheduleType": schedule_type, "SendAt": serialize.iso8601_datetime(send_at), "SendAsMms": send_as_mms, "ContentVariables": content_variables, "From": from_, "MessagingServiceSid": messaging_service_sid, "Body": body, "MediaUrl": serialize.map(media_url, lambda e: e), "ContentSid": content_sid, } ) payload = await self._version.create_async( method="POST", uri=self._uri, data=data, ) return MessageInstance( self._version, payload, account_sid=self._solution["account_sid"] ) def stream( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> Iterator[MessageInstance]: """ Streams MessageInstance 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 to: Read messages sent to only this phone number. :param str from_: Read messages sent from only this phone number or alphanumeric sender ID. :param datetime date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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( to=to, from_=from_, date_sent=date_sent, date_sent_before=date_sent_before, date_sent_after=date_sent_after, page_size=limits["page_size"], ) return self._version.stream(page, limits["limit"]) async def stream_async( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> AsyncIterator[MessageInstance]: """ Asynchronously streams MessageInstance 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 to: Read messages sent to only this phone number. :param str from_: Read messages sent from only this phone number or alphanumeric sender ID. :param datetime date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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( to=to, from_=from_, date_sent=date_sent, date_sent_before=date_sent_before, date_sent_after=date_sent_after, page_size=limits["page_size"], ) return self._version.stream_async(page, limits["limit"]) def list( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[MessageInstance]: """ Lists MessageInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str to: Read messages sent to only this phone number. :param str from_: Read messages sent from only this phone number or alphanumeric sender ID. :param datetime date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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( to=to, from_=from_, date_sent=date_sent, date_sent_before=date_sent_before, date_sent_after=date_sent_after, limit=limit, page_size=page_size, ) ) async def list_async( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_after: Union[datetime, object] = values.unset, limit: Optional[int] = None, page_size: Optional[int] = None, ) -> List[MessageInstance]: """ Asynchronously lists MessageInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. :param str to: Read messages sent to only this phone number. :param str from_: Read messages sent from only this phone number or alphanumeric sender ID. :param datetime date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param datetime date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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( to=to, from_=from_, date_sent=date_sent, date_sent_before=date_sent_before, date_sent_after=date_sent_after, limit=limit, page_size=page_size, ) ] def page( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_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, ) -> MessagePage: """ Retrieve a single page of MessageInstance records from the API. Request is executed immediately :param to: Read messages sent to only this phone number. :param from_: Read messages sent from only this phone number or alphanumeric sender ID. :param date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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 MessageInstance """ data = values.of( { "To": to, "From": from_, "DateSent": serialize.iso8601_datetime(date_sent), "DateSent<": serialize.iso8601_datetime(date_sent_before), "DateSent>": serialize.iso8601_datetime(date_sent_after), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = self._version.page(method="GET", uri=self._uri, params=data) return MessagePage(self._version, response, self._solution) async def page_async( self, to: Union[str, object] = values.unset, from_: Union[str, object] = values.unset, date_sent: Union[datetime, object] = values.unset, date_sent_before: Union[datetime, object] = values.unset, date_sent_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, ) -> MessagePage: """ Asynchronously retrieve a single page of MessageInstance records from the API. Request is executed immediately :param to: Read messages sent to only this phone number. :param from_: Read messages sent from only this phone number or alphanumeric sender ID. :param date_sent: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param date_sent_before: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date. :param date_sent_after: The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a 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 MessageInstance """ data = values.of( { "To": to, "From": from_, "DateSent": serialize.iso8601_datetime(date_sent), "DateSent<": serialize.iso8601_datetime(date_sent_before), "DateSent>": serialize.iso8601_datetime(date_sent_after), "PageToken": page_token, "Page": page_number, "PageSize": page_size, } ) response = await self._version.page_async( method="GET", uri=self._uri, params=data ) return MessagePage(self._version, response, self._solution) def get_page(self, target_url: str) -> MessagePage: """ Retrieve a specific page of MessageInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of MessageInstance """ response = self._version.domain.twilio.request("GET", target_url) return MessagePage(self._version, response, self._solution) async def get_page_async(self, target_url: str) -> MessagePage: """ Asynchronously retrieve a specific page of MessageInstance records from the API. Request is executed immediately :param target_url: API-generated URL for the requested results page :returns: Page of MessageInstance """ response = await self._version.domain.twilio.request_async("GET", target_url) return MessagePage(self._version, response, self._solution) def get(self, sid: str) -> MessageContext: """ Constructs a MessageContext :param sid: The Twilio-provided string that uniquely identifies the Message resource to update. """ return MessageContext( self._version, account_sid=self._solution["account_sid"], sid=sid ) def __call__(self, sid: str) -> MessageContext: """ Constructs a MessageContext :param sid: The Twilio-provided string that uniquely identifies the Message resource to update. """ return MessageContext( self._version, account_sid=self._solution["account_sid"], sid=sid ) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""