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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Studio
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
from twilio.base import 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
class StepContextInstance(InstanceResource):
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the StepContext resource.
:ivar context: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.
:ivar engagement_sid: The SID of the Engagement.
:ivar flow_sid: The SID of the Flow.
:ivar step_sid: The SID of the Step the context is associated with.
:ivar url: The absolute URL of the resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
flow_sid: str,
engagement_sid: str,
step_sid: str,
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.context: Optional[Dict[str, object]] = payload.get("context")
self.engagement_sid: Optional[str] = payload.get("engagement_sid")
self.flow_sid: Optional[str] = payload.get("flow_sid")
self.step_sid: Optional[str] = payload.get("step_sid")
self.url: Optional[str] = payload.get("url")
self._solution = {
"flow_sid": flow_sid,
"engagement_sid": engagement_sid,
"step_sid": step_sid,
}
self._context: Optional[StepContextContext] = None
@property
def _proxy(self) -> "StepContextContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: StepContextContext for this StepContextInstance
"""
if self._context is None:
self._context = StepContextContext(
self._version,
flow_sid=self._solution["flow_sid"],
engagement_sid=self._solution["engagement_sid"],
step_sid=self._solution["step_sid"],
)
return self._context
def fetch(self) -> "StepContextInstance":
"""
Fetch the StepContextInstance
:returns: The fetched StepContextInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "StepContextInstance":
"""
Asynchronous coroutine to fetch the StepContextInstance
:returns: The fetched StepContextInstance
"""
return await self._proxy.fetch_async()
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.Studio.V1.StepContextInstance {}>".format(context)
class StepContextContext(InstanceContext):
def __init__(
self, version: Version, flow_sid: str, engagement_sid: str, step_sid: str
):
"""
Initialize the StepContextContext
:param version: Version that contains the resource
:param flow_sid: The SID of the Flow with the Step to fetch.
:param engagement_sid: The SID of the Engagement with the Step to fetch.
:param step_sid: The SID of the Step to fetch
"""
super().__init__(version)
# Path Solution
self._solution = {
"flow_sid": flow_sid,
"engagement_sid": engagement_sid,
"step_sid": step_sid,
}
self._uri = "/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context".format(
**self._solution
)
def fetch(self) -> StepContextInstance:
"""
Fetch the StepContextInstance
:returns: The fetched StepContextInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return StepContextInstance(
self._version,
payload,
flow_sid=self._solution["flow_sid"],
engagement_sid=self._solution["engagement_sid"],
step_sid=self._solution["step_sid"],
)
async def fetch_async(self) -> StepContextInstance:
"""
Asynchronous coroutine to fetch the StepContextInstance
:returns: The fetched StepContextInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return StepContextInstance(
self._version,
payload,
flow_sid=self._solution["flow_sid"],
engagement_sid=self._solution["engagement_sid"],
step_sid=self._solution["step_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.Studio.V1.StepContextContext {}>".format(context)
class StepContextList(ListResource):
def __init__(
self, version: Version, flow_sid: str, engagement_sid: str, step_sid: str
):
"""
Initialize the StepContextList
:param version: Version that contains the resource
:param flow_sid: The SID of the Flow with the Step to fetch.
:param engagement_sid: The SID of the Engagement with the Step to fetch.
:param step_sid: The SID of the Step to fetch
"""
super().__init__(version)
# Path Solution
self._solution = {
"flow_sid": flow_sid,
"engagement_sid": engagement_sid,
"step_sid": step_sid,
}
def get(self) -> StepContextContext:
"""
Constructs a StepContextContext
"""
return StepContextContext(
self._version,
flow_sid=self._solution["flow_sid"],
engagement_sid=self._solution["engagement_sid"],
step_sid=self._solution["step_sid"],
)
def __call__(self) -> StepContextContext:
"""
Constructs a StepContextContext
"""
return StepContextContext(
self._version,
flow_sid=self._solution["flow_sid"],
engagement_sid=self._solution["engagement_sid"],
step_sid=self._solution["step_sid"],
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Studio.V1.StepContextList>"
|
