File: C:/Users/fred/anaconda3/Lib/site-packages/twilio/rest/chat/v1/service/channel/message.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Chat
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_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
class MessageInstance(InstanceResource):
class OrderType(object):
ASC = "asc"
DESC = "desc"
"""
:ivar sid: The unique string that we created to identify the Message resource.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Message resource.
:ivar attributes: The JSON string that stores application-specific data. **Note** If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, `{}` is returned.
:ivar service_sid: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) the resource is associated with.
:ivar to: The SID of the [Channel](https://www.twilio.com/docs/chat/api/channels) that the message was sent to.
:ivar channel_sid: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the Message resource belongs to.
:ivar date_created: The date and time in GMT when the resource was created specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
:ivar was_edited: Whether the message has been edited since it was created.
:ivar _from: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the message's author. The default value is `system`.
:ivar body: The content of the message.
:ivar index: The index of the message within the [Channel](https://www.twilio.com/docs/chat/api/channels).
:ivar url: The absolute URL of the Message resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
service_sid: str,
channel_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.attributes: Optional[str] = payload.get("attributes")
self.service_sid: Optional[str] = payload.get("service_sid")
self.to: Optional[str] = payload.get("to")
self.channel_sid: Optional[str] = payload.get("channel_sid")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.was_edited: Optional[bool] = payload.get("was_edited")
self._from: Optional[str] = payload.get("from")
self.body: Optional[str] = payload.get("body")
self.index: Optional[int] = deserialize.integer(payload.get("index"))
self.url: Optional[str] = payload.get("url")
self._solution = {
"service_sid": service_sid,
"channel_sid": channel_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,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_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,
attributes: Union[str, object] = values.unset,
) -> "MessageInstance":
"""
Update the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The updated MessageInstance
"""
return self._proxy.update(
body=body,
attributes=attributes,
)
async def update_async(
self,
body: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
) -> "MessageInstance":
"""
Asynchronous coroutine to update the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The updated MessageInstance
"""
return await self._proxy.update_async(
body=body,
attributes=attributes,
)
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 "<Twilio.Chat.V1.MessageInstance {}>".format(context)
class MessageContext(InstanceContext):
def __init__(self, version: Version, service_sid: str, channel_sid: str, sid: str):
"""
Initialize the MessageContext
:param version: Version that contains the resource
:param service_sid: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to update the resource from.
:param channel_sid: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message belongs to. Can be the Channel's `sid` or `unique_name`.
:param sid: The Twilio-provided string that uniquely identifies the Message resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"channel_sid": channel_sid,
"sid": sid,
}
self._uri = (
"/Services/{service_sid}/Channels/{channel_sid}/Messages/{sid}".format(
**self._solution
)
)
def delete(self) -> bool:
"""
Deletes the MessageInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the MessageInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> MessageInstance:
"""
Fetch the MessageInstance
:returns: The fetched MessageInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> MessageInstance:
"""
Asynchronous coroutine to fetch the MessageInstance
:returns: The fetched MessageInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
sid=self._solution["sid"],
)
def update(
self,
body: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
) -> MessageInstance:
"""
Update the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The updated MessageInstance
"""
data = values.of(
{
"Body": body,
"Attributes": attributes,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
body: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
) -> MessageInstance:
"""
Asynchronous coroutine to update the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The updated MessageInstance
"""
data = values.of(
{
"Body": body,
"Attributes": attributes,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
sid=self._solution["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 "<Twilio.Chat.V1.MessageContext {}>".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,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Chat.V1.MessagePage>"
class MessageList(ListResource):
def __init__(self, version: Version, service_sid: str, channel_sid: str):
"""
Initialize the MessageList
:param version: Version that contains the resource
:param service_sid: The SID of the [Service](https://www.twilio.com/docs/api/chat/rest/services) to read the resources from.
:param channel_sid: The unique ID of the [Channel](https://www.twilio.com/docs/api/chat/rest/channels) the message to read belongs to. Can be the Channel's `sid` or `unique_name`.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"channel_sid": channel_sid,
}
self._uri = "/Services/{service_sid}/Channels/{channel_sid}/Messages".format(
**self._solution
)
def create(
self,
body: str,
from_: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
) -> MessageInstance:
"""
Create the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param from_: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The created MessageInstance
"""
data = values.of(
{
"Body": body,
"From": from_,
"Attributes": attributes,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
)
async def create_async(
self,
body: str,
from_: Union[str, object] = values.unset,
attributes: Union[str, object] = values.unset,
) -> MessageInstance:
"""
Asynchronously create the MessageInstance
:param body: The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.
:param from_: The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.
:param attributes: A valid JSON string that contains application-specific data.
:returns: The created MessageInstance
"""
data = values.of(
{
"Body": body,
"From": from_,
"Attributes": attributes,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return MessageInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
)
def stream(
self,
order: Union["MessageInstance.OrderType", 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 "MessageInstance.OrderType" order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(order=order, page_size=limits["page_size"])
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
order: Union["MessageInstance.OrderType", 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 "MessageInstance.OrderType" order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(order=order, page_size=limits["page_size"])
return self._version.stream_async(page, limits["limit"])
def list(
self,
order: Union["MessageInstance.OrderType", 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 "MessageInstance.OrderType" order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(
order=order,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
order: Union["MessageInstance.OrderType", 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 "MessageInstance.OrderType" order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(
order=order,
limit=limit,
page_size=page_size,
)
]
def page(
self,
order: Union["MessageInstance.OrderType", 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 order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(
{
"Order": order,
"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 MessagePage(self._version, response, self._solution)
async def page_async(
self,
order: Union["MessageInstance.OrderType", 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 order: The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.
: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(
{
"Order": order,
"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 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,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_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,
service_sid=self._solution["service_sid"],
channel_sid=self._solution["channel_sid"],
sid=sid,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Chat.V1.MessageList>"