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.api_response import ApiResponse 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 "" 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, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: Union[str, object] = values.unset, ) -> tuple: """ Internal helper for create operation Returns: tuple: (payload, status_code, headers) """ data = values.of( { "AddressSid": address_sid, "ChatFriendlyName": chat_friendly_name, "CustomerFriendlyName": customer_friendly_name, "PreEngagementData": pre_engagement_data, "Identity": identity, } ) headers = values.of( { "Ui-Version": ui_version, "Content-Type": "application/x-www-form-urlencoded", } ) headers["Content-Type"] = "application/x-www-form-urlencoded" headers["Accept"] = "application/json" return self._version.create_with_response_info( method="POST", uri=self._uri, data=data, headers=headers ) def create( self, address_sid: str, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: 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 ui_version: The Ui-Version HTTP request header :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. :param identity: The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example. :returns: The created WebChannelsInstance """ payload, _, _ = self._create( address_sid=address_sid, ui_version=ui_version, chat_friendly_name=chat_friendly_name, customer_friendly_name=customer_friendly_name, pre_engagement_data=pre_engagement_data, identity=identity, ) return WebChannelsInstance(self._version, payload) def create_with_http_info( self, address_sid: str, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: Union[str, object] = values.unset, ) -> ApiResponse: """ Create the WebChannelsInstance and return response metadata :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 ui_version: The Ui-Version HTTP request header :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. :param identity: The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example. :returns: ApiResponse with instance, status code, and headers """ payload, status_code, headers = self._create( address_sid=address_sid, ui_version=ui_version, chat_friendly_name=chat_friendly_name, customer_friendly_name=customer_friendly_name, pre_engagement_data=pre_engagement_data, identity=identity, ) instance = WebChannelsInstance(self._version, payload) return ApiResponse(data=instance, status_code=status_code, headers=headers) async def _create_async( self, address_sid: str, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: Union[str, object] = values.unset, ) -> tuple: """ Internal async helper for create operation Returns: tuple: (payload, status_code, headers) """ data = values.of( { "AddressSid": address_sid, "ChatFriendlyName": chat_friendly_name, "CustomerFriendlyName": customer_friendly_name, "PreEngagementData": pre_engagement_data, "Identity": identity, } ) headers = values.of( { "Ui-Version": ui_version, "Content-Type": "application/x-www-form-urlencoded", } ) headers["Content-Type"] = "application/x-www-form-urlencoded" headers["Accept"] = "application/json" return await self._version.create_with_response_info_async( method="POST", uri=self._uri, data=data, headers=headers ) async def create_async( self, address_sid: str, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: 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 ui_version: The Ui-Version HTTP request header :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. :param identity: The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example. :returns: The created WebChannelsInstance """ payload, _, _ = await self._create_async( address_sid=address_sid, ui_version=ui_version, chat_friendly_name=chat_friendly_name, customer_friendly_name=customer_friendly_name, pre_engagement_data=pre_engagement_data, identity=identity, ) return WebChannelsInstance(self._version, payload) async def create_with_http_info_async( self, address_sid: str, ui_version: Union[str, object] = values.unset, chat_friendly_name: Union[str, object] = values.unset, customer_friendly_name: Union[str, object] = values.unset, pre_engagement_data: Union[str, object] = values.unset, identity: Union[str, object] = values.unset, ) -> ApiResponse: """ Asynchronously create the WebChannelsInstance and return response metadata :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 ui_version: The Ui-Version HTTP request header :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. :param identity: The Identity of the guest user. See the [Conversation User Resource](https://www.twilio.com/docs/conversations/api/user-resource) for an example. :returns: ApiResponse with instance, status code, and headers """ payload, status_code, headers = await self._create_async( address_sid=address_sid, ui_version=ui_version, chat_friendly_name=chat_friendly_name, customer_friendly_name=customer_friendly_name, pre_engagement_data=pre_engagement_data, identity=identity, ) instance = WebChannelsInstance(self._version, payload) return ApiResponse(data=instance, status_code=status_code, headers=headers) def __repr__(self) -> str: """ Provide a friendly representation :returns: Machine friendly representation """ return ""