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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
|
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, 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
class VerificationInstance(InstanceResource):
class Channel(object):
SMS = "sms"
CALL = "call"
EMAIL = "email"
WHATSAPP = "whatsapp"
SNA = "sna"
class RiskCheck(object):
ENABLE = "enable"
DISABLE = "disable"
class Status(object):
CANCELED = "canceled"
APPROVED = "approved"
"""
:ivar sid: The unique string that we created to identify the Verification 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 Verification 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 lookup: Information about the phone number being verified.
: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 send_code_attempts: An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID.
:ivar date_created: The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_updated: The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar sna: The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number.
:ivar url: The absolute URL of the Verification resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
service_sid: str,
sid: Optional[str] = None,
):
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["VerificationInstance.Channel"] = payload.get("channel")
self.status: Optional[str] = payload.get("status")
self.valid: Optional[bool] = payload.get("valid")
self.lookup: Optional[Dict[str, object]] = payload.get("lookup")
self.amount: Optional[str] = payload.get("amount")
self.payee: Optional[str] = payload.get("payee")
self.send_code_attempts: Optional[List[Dict[str, object]]] = payload.get(
"send_code_attempts"
)
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: Optional[Dict[str, object]] = payload.get("sna")
self.url: Optional[str] = payload.get("url")
self._solution = {
"service_sid": service_sid,
"sid": sid or self.sid,
}
self._context: Optional[VerificationContext] = None
@property
def _proxy(self) -> "VerificationContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: VerificationContext for this VerificationInstance
"""
if self._context is None:
self._context = VerificationContext(
self._version,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
return self._context
def fetch(self) -> "VerificationInstance":
"""
Fetch the VerificationInstance
:returns: The fetched VerificationInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "VerificationInstance":
"""
Asynchronous coroutine to fetch the VerificationInstance
:returns: The fetched VerificationInstance
"""
return await self._proxy.fetch_async()
def update(self, status: "VerificationInstance.Status") -> "VerificationInstance":
"""
Update the VerificationInstance
:param status:
:returns: The updated VerificationInstance
"""
return self._proxy.update(
status=status,
)
async def update_async(
self, status: "VerificationInstance.Status"
) -> "VerificationInstance":
"""
Asynchronous coroutine to update the VerificationInstance
:param status:
:returns: The updated VerificationInstance
"""
return await self._proxy.update_async(
status=status,
)
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.VerificationInstance {}>".format(context)
class VerificationContext(InstanceContext):
def __init__(self, version: Version, service_sid: str, sid: str):
"""
Initialize the VerificationContext
: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 update the resource from.
:param sid: The Twilio-provided string that uniquely identifies the Verification resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"service_sid": service_sid,
"sid": sid,
}
self._uri = "/Services/{service_sid}/Verifications/{sid}".format(
**self._solution
)
def fetch(self) -> VerificationInstance:
"""
Fetch the VerificationInstance
:returns: The fetched VerificationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return VerificationInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> VerificationInstance:
"""
Asynchronous coroutine to fetch the VerificationInstance
:returns: The fetched VerificationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return VerificationInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
def update(self, status: "VerificationInstance.Status") -> VerificationInstance:
"""
Update the VerificationInstance
:param status:
:returns: The updated VerificationInstance
"""
data = values.of(
{
"Status": status,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return VerificationInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["sid"],
)
async def update_async(
self, status: "VerificationInstance.Status"
) -> VerificationInstance:
"""
Asynchronous coroutine to update the VerificationInstance
:param status:
:returns: The updated VerificationInstance
"""
data = values.of(
{
"Status": status,
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return VerificationInstance(
self._version,
payload,
service_sid=self._solution["service_sid"],
sid=self._solution["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.VerificationContext {}>".format(context)
class VerificationList(ListResource):
def __init__(self, version: Version, service_sid: str):
"""
Initialize the VerificationList
: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}/Verifications".format(**self._solution)
def create(
self,
to: str,
channel: str,
custom_friendly_name: Union[str, object] = values.unset,
custom_message: Union[str, object] = values.unset,
send_digits: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
custom_code: Union[str, object] = values.unset,
amount: Union[str, object] = values.unset,
payee: Union[str, object] = values.unset,
rate_limits: Union[object, object] = values.unset,
channel_configuration: Union[object, object] = values.unset,
app_hash: Union[str, object] = values.unset,
template_sid: Union[str, object] = values.unset,
template_custom_substitutions: Union[str, object] = values.unset,
device_ip: Union[str, object] = values.unset,
enable_sna_client_token: Union[bool, object] = values.unset,
risk_check: Union["VerificationInstance.RiskCheck", object] = values.unset,
tags: Union[str, object] = values.unset,
) -> VerificationInstance:
"""
Create the VerificationInstance
:param to: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
:param channel: The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.
:param custom_friendly_name: A custom user defined friendly name that overwrites the existing one in the verification message
:param custom_message: The text of a custom message to use for the verification.
:param send_digits: The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
:param locale: Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See supported languages and more information here](https://www.twilio.com/docs/verify/supported-languages).
:param custom_code: A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
: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 rate_limits: The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
:param channel_configuration: [`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.
:param app_hash: Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
:param template_sid: The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only.
:param template_custom_substitutions: A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.
:param device_ip: Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.
:param enable_sna_client_token: An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.
:param risk_check:
:param tags: A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.
:returns: The created VerificationInstance
"""
data = values.of(
{
"To": to,
"Channel": channel,
"CustomFriendlyName": custom_friendly_name,
"CustomMessage": custom_message,
"SendDigits": send_digits,
"Locale": locale,
"CustomCode": custom_code,
"Amount": amount,
"Payee": payee,
"RateLimits": serialize.object(rate_limits),
"ChannelConfiguration": serialize.object(channel_configuration),
"AppHash": app_hash,
"TemplateSid": template_sid,
"TemplateCustomSubstitutions": template_custom_substitutions,
"DeviceIp": device_ip,
"EnableSnaClientToken": serialize.boolean_to_string(
enable_sna_client_token
),
"RiskCheck": risk_check,
"Tags": tags,
}
)
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 VerificationInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
async def create_async(
self,
to: str,
channel: str,
custom_friendly_name: Union[str, object] = values.unset,
custom_message: Union[str, object] = values.unset,
send_digits: Union[str, object] = values.unset,
locale: Union[str, object] = values.unset,
custom_code: Union[str, object] = values.unset,
amount: Union[str, object] = values.unset,
payee: Union[str, object] = values.unset,
rate_limits: Union[object, object] = values.unset,
channel_configuration: Union[object, object] = values.unset,
app_hash: Union[str, object] = values.unset,
template_sid: Union[str, object] = values.unset,
template_custom_substitutions: Union[str, object] = values.unset,
device_ip: Union[str, object] = values.unset,
enable_sna_client_token: Union[bool, object] = values.unset,
risk_check: Union["VerificationInstance.RiskCheck", object] = values.unset,
tags: Union[str, object] = values.unset,
) -> VerificationInstance:
"""
Asynchronously create the VerificationInstance
:param to: The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
:param channel: The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.
:param custom_friendly_name: A custom user defined friendly name that overwrites the existing one in the verification message
:param custom_message: The text of a custom message to use for the verification.
:param send_digits: The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
:param locale: Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See supported languages and more information here](https://www.twilio.com/docs/verify/supported-languages).
:param custom_code: A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
: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 rate_limits: The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
:param channel_configuration: [`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.
:param app_hash: Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
:param template_sid: The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only.
:param template_custom_substitutions: A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.
:param device_ip: Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.
:param enable_sna_client_token: An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.
:param risk_check:
:param tags: A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.
:returns: The created VerificationInstance
"""
data = values.of(
{
"To": to,
"Channel": channel,
"CustomFriendlyName": custom_friendly_name,
"CustomMessage": custom_message,
"SendDigits": send_digits,
"Locale": locale,
"CustomCode": custom_code,
"Amount": amount,
"Payee": payee,
"RateLimits": serialize.object(rate_limits),
"ChannelConfiguration": serialize.object(channel_configuration),
"AppHash": app_hash,
"TemplateSid": template_sid,
"TemplateCustomSubstitutions": template_custom_substitutions,
"DeviceIp": device_ip,
"EnableSnaClientToken": serialize.boolean_to_string(
enable_sna_client_token
),
"RiskCheck": risk_check,
"Tags": tags,
}
)
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 VerificationInstance(
self._version, payload, service_sid=self._solution["service_sid"]
)
def get(self, sid: str) -> VerificationContext:
"""
Constructs a VerificationContext
:param sid: The Twilio-provided string that uniquely identifies the Verification resource to update.
"""
return VerificationContext(
self._version, service_sid=self._solution["service_sid"], sid=sid
)
def __call__(self, sid: str) -> VerificationContext:
"""
Constructs a VerificationContext
:param sid: The Twilio-provided string that uniquely identifies the Verification resource to update.
"""
return VerificationContext(
self._version, service_sid=self._solution["service_sid"], sid=sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.VerificationList>"
|
