1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
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,
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,
) -> 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.
:returns: The created WebChannelsInstance
"""
data = values.of(
{
"AddressSid": address_sid,
"ChatFriendlyName": chat_friendly_name,
"CustomerFriendlyName": customer_friendly_name,
"PreEngagementData": pre_engagement_data,
}
)
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"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return WebChannelsInstance(self._version, payload)
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,
) -> 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.
:returns: The created WebChannelsInstance
"""
data = values.of(
{
"AddressSid": address_sid,
"ChatFriendlyName": chat_friendly_name,
"CustomerFriendlyName": customer_friendly_name,
"PreEngagementData": pre_engagement_data,
}
)
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"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return WebChannelsInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V2.WebChannelsList>"
|
