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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Verify
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 FormInstance(InstanceResource):
class FormTypes(object):
FORM_PUSH = "form-push"
"""
:ivar form_type:
:ivar forms: Object that contains the available forms for this type. This available forms are given in the standard [JSON Schema](https://json-schema.org/) format
:ivar form_meta: Additional information for the available forms for this type. E.g. The separator string used for `binding` in a Factor push.
:ivar url: The URL to access the forms for this type.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
form_type: Optional[FormTypes] = None,
):
super().__init__(version)
self.form_type: Optional["FormInstance.FormTypes"] = payload.get("form_type")
self.forms: Optional[Dict[str, object]] = payload.get("forms")
self.form_meta: Optional[Dict[str, object]] = payload.get("form_meta")
self.url: Optional[str] = payload.get("url")
self._solution = {
"form_type": form_type or self.form_type,
}
self._context: Optional[FormContext] = None
@property
def _proxy(self) -> "FormContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: FormContext for this FormInstance
"""
if self._context is None:
self._context = FormContext(
self._version,
form_type=self._solution["form_type"],
)
return self._context
def fetch(self) -> "FormInstance":
"""
Fetch the FormInstance
:returns: The fetched FormInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "FormInstance":
"""
Asynchronous coroutine to fetch the FormInstance
:returns: The fetched FormInstance
"""
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.Verify.V2.FormInstance {}>".format(context)
class FormContext(InstanceContext):
def __init__(self, version: Version, form_type: "FormInstance.FormTypes"):
"""
Initialize the FormContext
:param version: Version that contains the resource
:param form_type: The Type of this Form. Currently only `form-push` is supported.
"""
super().__init__(version)
# Path Solution
self._solution = {
"form_type": form_type,
}
self._uri = "/Forms/{form_type}".format(**self._solution)
def fetch(self) -> FormInstance:
"""
Fetch the FormInstance
:returns: The fetched FormInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return FormInstance(
self._version,
payload,
form_type=self._solution["form_type"],
)
async def fetch_async(self) -> FormInstance:
"""
Asynchronous coroutine to fetch the FormInstance
:returns: The fetched FormInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return FormInstance(
self._version,
payload,
form_type=self._solution["form_type"],
)
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.Verify.V2.FormContext {}>".format(context)
class FormList(ListResource):
def __init__(self, version: Version):
"""
Initialize the FormList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, form_type: "FormInstance.FormTypes") -> FormContext:
"""
Constructs a FormContext
:param form_type: The Type of this Form. Currently only `form-push` is supported.
"""
return FormContext(self._version, form_type=form_type)
def __call__(self, form_type: "FormInstance.FormTypes") -> FormContext:
"""
Constructs a FormContext
:param form_type: The Type of this Form. Currently only `form-push` is supported.
"""
return FormContext(self._version, form_type=form_type)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.FormList>"
|
