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
|
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 datetime import datetime
from typing import Any, Dict, List, Optional, Union
from twilio.base import deserialize, values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class VerificationCheckInstance(InstanceResource):
class Channel(object):
SMS = "sms"
CALL = "call"
EMAIL = "email"
WHATSAPP = "whatsapp"
SNA = "sna"
"""
:ivar sid: The unique string that we created to identify the VerificationCheck resource.
:ivar service_sid: The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource.
:ivar to: The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
:ivar channel:
:ivar status: The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.
:ivar valid: Use \"status\" instead. Legacy property indicating whether the verification was successful.
:ivar amount: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:ivar payee: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:ivar date_created: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created.
:ivar date_updated: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated.
:ivar sna_attempts_error_codes: List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`.
"""
def __init__(self, version: Version, payload: Dict[str, Any], service_sid: str):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.service_sid: Optional[str] = payload.get("service_sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.to: Optional[str] = payload.get("to")
self.channel: Optional["VerificationCheckInstance.Channel"] = payload.get(
"channel"
)
self.status: Optional[str] = payload.get("status")
self.valid: Optional[bool] = payload.get("valid")
self.amount: Optional[str] = payload.get("amount")
self.payee: Optional[str] = payload.get("payee")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.sna_attempts_error_codes: Optional[List[Dict[str, object]]] = payload.get(
"sna_attempts_error_codes"
)
self._solution = {
"service_sid": service_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.Verify.V2.VerificationCheckInstance {}>".format(context)
class VerificationCheckList(ListResource):
def __init__(self, version: Version, service_sid: str):
"""
Initialize the VerificationCheckList
:param version: Version that contains the resource
:param service_sid: The SID of the verification [Service](https://www.twilio.com/docs/verify/api/service) to create the resource under.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
}
self._uri = "/Services/{service_sid}/VerificationCheck".format(**self._solution)
def create(
self,
code: Union[str, object] = values.unset,
to: Union[str, object] = values.unset,
verification_sid: Union[str, object] = values.unset,
amount: Union[str, object] = values.unset,
payee: Union[str, object] = values.unset,
sna_client_token: Union[str, object] = values.unset,
) -> VerificationCheckInstance:
"""
Create the VerificationCheckInstance
:param code: The 4-10 character string being verified.
:param to: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
:param verification_sid: A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.
:param amount: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:param payee: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:param sna_client_token: A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.
:returns: The created VerificationCheckInstance
"""
data = values.of(
{
"Code": code,
"To": to,
"VerificationSid": verification_sid,
"Amount": amount,
"Payee": payee,
"SnaClientToken": sna_client_token,
}
)
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 VerificationCheckInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
async def create_async(
self,
code: Union[str, object] = values.unset,
to: Union[str, object] = values.unset,
verification_sid: Union[str, object] = values.unset,
amount: Union[str, object] = values.unset,
payee: Union[str, object] = values.unset,
sna_client_token: Union[str, object] = values.unset,
) -> VerificationCheckInstance:
"""
Asynchronously create the VerificationCheckInstance
:param code: The 4-10 character string being verified.
:param to: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
:param verification_sid: A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.
:param amount: The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:param payee: The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
:param sna_client_token: A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.
:returns: The created VerificationCheckInstance
"""
data = values.of(
{
"Code": code,
"To": to,
"VerificationSid": verification_sid,
"Amount": amount,
"Payee": payee,
"SnaClientToken": sna_client_token,
}
)
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 VerificationCheckInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.VerificationCheckList>"
|
