File: //home/arjun/projects/env/lib/python3.10/site-packages/twilio/rest/flex_api/v2/web_channels.py
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Flex
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, Optional, Union
from twilio.base import values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class WebChannelsInstance(InstanceResource):
"""
:ivar conversation_sid: The unique string representing the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) created.
:ivar identity: The unique string representing the User created and should be authorized to participate in the Conversation. For more details, see [User Identity & Access Tokens](https://www.twilio.com/docs/conversations/identity).
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.conversation_sid: Optional[str] = payload.get("conversation_sid")
self.identity: Optional[str] = payload.get("identity")
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V2.WebChannelsInstance>"
class WebChannelsList(ListResource):
def __init__(self, version: Version):
"""
Initialize the WebChannelsList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/WebChats"
def create(
self,
address_sid: str,
chat_friendly_name: Union[str, object] = values.unset,
customer_friendly_name: Union[str, object] = values.unset,
pre_engagement_data: Union[str, object] = values.unset,
) -> WebChannelsInstance:
"""
Create the WebChannelsInstance
:param address_sid: The SID of the Conversations Address. See [Address Configuration Resource](https://www.twilio.com/docs/conversations/api/address-configuration-resource) for configuration details. When a conversation is created on the Flex backend, the callback URL will be set to the corresponding Studio Flow SID or webhook URL in your address configuration.
:param chat_friendly_name: The Conversation's friendly name. See the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) for an example.
:param customer_friendly_name: The Conversation participant's friendly name. See the [Conversation Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) for an example.
:param pre_engagement_data: The pre-engagement data.
:returns: The created WebChannelsInstance
"""
data = values.of(
{
"AddressSid": address_sid,
"ChatFriendlyName": chat_friendly_name,
"CustomerFriendlyName": customer_friendly_name,
"PreEngagementData": pre_engagement_data,
}
)
payload = self._version.create(
method="POST",
uri=self._uri,
data=data,
)
return WebChannelsInstance(self._version, payload)
async def create_async(
self,
address_sid: str,
chat_friendly_name: Union[str, object] = values.unset,
customer_friendly_name: Union[str, object] = values.unset,
pre_engagement_data: Union[str, object] = values.unset,
) -> WebChannelsInstance:
"""
Asynchronously create the WebChannelsInstance
:param address_sid: The SID of the Conversations Address. See [Address Configuration Resource](https://www.twilio.com/docs/conversations/api/address-configuration-resource) for configuration details. When a conversation is created on the Flex backend, the callback URL will be set to the corresponding Studio Flow SID or webhook URL in your address configuration.
:param chat_friendly_name: The Conversation's friendly name. See the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource) for an example.
:param customer_friendly_name: The Conversation participant's friendly name. See the [Conversation Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) for an example.
:param pre_engagement_data: The pre-engagement data.
:returns: The created WebChannelsInstance
"""
data = values.of(
{
"AddressSid": address_sid,
"ChatFriendlyName": chat_friendly_name,
"CustomerFriendlyName": customer_friendly_name,
"PreEngagementData": pre_engagement_data,
}
)
payload = await self._version.create_async(
method="POST",
uri=self._uri,
data=data,
)
return WebChannelsInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V2.WebChannelsList>"