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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
|
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 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.rest.flex_api.v1.interaction.interaction_channel import (
InteractionChannelList,
)
class InteractionInstance(InstanceResource):
"""
:ivar sid: The unique string created by Twilio to identify an Interaction resource, prefixed with KD.
:ivar channel: A JSON object that defines the Interaction’s communication channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact) Channel object examples.
:ivar routing: A JSON Object representing the routing rules for the Interaction Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions) for an example Routing object. The Interactions resource uses TaskRouter for all routing functionality. All attributes in the Routing object on your Interaction request body are added “as is” to the task. For a list of known attributes consumed by the Flex UI and/or Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes).
:ivar url:
:ivar links:
:ivar interaction_context_sid:
"""
def __init__(
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.channel: Optional[Dict[str, object]] = payload.get("channel")
self.routing: Optional[Dict[str, object]] = payload.get("routing")
self.url: Optional[str] = payload.get("url")
self.links: Optional[Dict[str, object]] = payload.get("links")
self.interaction_context_sid: Optional[str] = payload.get(
"interaction_context_sid"
)
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[InteractionContext] = None
@property
def _proxy(self) -> "InteractionContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: InteractionContext for this InteractionInstance
"""
if self._context is None:
self._context = InteractionContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def fetch(self) -> "InteractionInstance":
"""
Fetch the InteractionInstance
:returns: The fetched InteractionInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "InteractionInstance":
"""
Asynchronous coroutine to fetch the InteractionInstance
:returns: The fetched InteractionInstance
"""
return await self._proxy.fetch_async()
@property
def channels(self) -> InteractionChannelList:
"""
Access the channels
"""
return self._proxy.channels
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.FlexApi.V1.InteractionInstance {}>".format(context)
class InteractionContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the InteractionContext
:param version: Version that contains the resource
:param sid: The SID of the Interaction resource to fetch.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Interactions/{sid}".format(**self._solution)
self._channels: Optional[InteractionChannelList] = None
def fetch(self) -> InteractionInstance:
"""
Fetch the InteractionInstance
:returns: The fetched InteractionInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return InteractionInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> InteractionInstance:
"""
Asynchronous coroutine to fetch the InteractionInstance
:returns: The fetched InteractionInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return InteractionInstance(
self._version,
payload,
sid=self._solution["sid"],
)
@property
def channels(self) -> InteractionChannelList:
"""
Access the channels
"""
if self._channels is None:
self._channels = InteractionChannelList(
self._version,
self._solution["sid"],
)
return self._channels
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.FlexApi.V1.InteractionContext {}>".format(context)
class InteractionList(ListResource):
def __init__(self, version: Version):
"""
Initialize the InteractionList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Interactions"
def create(
self,
channel: object,
routing: Union[object, object] = values.unset,
interaction_context_sid: Union[str, object] = values.unset,
) -> InteractionInstance:
"""
Create the InteractionInstance
:param channel: The Interaction's channel.
:param routing: The Interaction's routing logic.
:param interaction_context_sid: The Interaction context sid is used for adding a context lookup sid
:returns: The created InteractionInstance
"""
data = values.of(
{
"Channel": serialize.object(channel),
"Routing": serialize.object(routing),
"InteractionContextSid": interaction_context_sid,
}
)
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 InteractionInstance(self._version, payload)
async def create_async(
self,
channel: object,
routing: Union[object, object] = values.unset,
interaction_context_sid: Union[str, object] = values.unset,
) -> InteractionInstance:
"""
Asynchronously create the InteractionInstance
:param channel: The Interaction's channel.
:param routing: The Interaction's routing logic.
:param interaction_context_sid: The Interaction context sid is used for adding a context lookup sid
:returns: The created InteractionInstance
"""
data = values.of(
{
"Channel": serialize.object(channel),
"Routing": serialize.object(routing),
"InteractionContextSid": interaction_context_sid,
}
)
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 InteractionInstance(self._version, payload)
def get(self, sid: str) -> InteractionContext:
"""
Constructs a InteractionContext
:param sid: The SID of the Interaction resource to fetch.
"""
return InteractionContext(self._version, sid=sid)
def __call__(self, sid: str) -> InteractionContext:
"""
Constructs a InteractionContext
:param sid: The SID of the Interaction resource to fetch.
"""
return InteractionContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V1.InteractionList>"
|