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
|
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, 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 VerificationAttemptsSummaryInstance(InstanceResource):
class Channels(object):
SMS = "sms"
CALL = "call"
EMAIL = "email"
WHATSAPP = "whatsapp"
"""
:ivar total_attempts: Total of attempts made according to the provided filters
:ivar total_converted: Total of attempts made that were confirmed by the end user, according to the provided filters.
:ivar total_unconverted: Total of attempts made that were not confirmed by the end user, according to the provided filters.
:ivar conversion_rate_percentage: Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.
:ivar url:
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.total_attempts: Optional[int] = deserialize.integer(
payload.get("total_attempts")
)
self.total_converted: Optional[int] = deserialize.integer(
payload.get("total_converted")
)
self.total_unconverted: Optional[int] = deserialize.integer(
payload.get("total_unconverted")
)
self.conversion_rate_percentage: Optional[float] = deserialize.decimal(
payload.get("conversion_rate_percentage")
)
self.url: Optional[str] = payload.get("url")
self._context: Optional[VerificationAttemptsSummaryContext] = None
@property
def _proxy(self) -> "VerificationAttemptsSummaryContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: VerificationAttemptsSummaryContext for this VerificationAttemptsSummaryInstance
"""
if self._context is None:
self._context = VerificationAttemptsSummaryContext(
self._version,
)
return self._context
def fetch(
self,
verify_service_sid: Union[str, object] = values.unset,
date_created_after: Union[datetime, object] = values.unset,
date_created_before: Union[datetime, object] = values.unset,
country: Union[str, object] = values.unset,
channel: Union[
"VerificationAttemptsSummaryInstance.Channels", object
] = values.unset,
destination_prefix: Union[str, object] = values.unset,
) -> "VerificationAttemptsSummaryInstance":
"""
Fetch the VerificationAttemptsSummaryInstance
:param verify_service_sid: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
:param date_created_after: Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param date_created_before: Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param country: Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
:param channel: Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
:param destination_prefix: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
:returns: The fetched VerificationAttemptsSummaryInstance
"""
return self._proxy.fetch(
verify_service_sid=verify_service_sid,
date_created_after=date_created_after,
date_created_before=date_created_before,
country=country,
channel=channel,
destination_prefix=destination_prefix,
)
async def fetch_async(
self,
verify_service_sid: Union[str, object] = values.unset,
date_created_after: Union[datetime, object] = values.unset,
date_created_before: Union[datetime, object] = values.unset,
country: Union[str, object] = values.unset,
channel: Union[
"VerificationAttemptsSummaryInstance.Channels", object
] = values.unset,
destination_prefix: Union[str, object] = values.unset,
) -> "VerificationAttemptsSummaryInstance":
"""
Asynchronous coroutine to fetch the VerificationAttemptsSummaryInstance
:param verify_service_sid: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
:param date_created_after: Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param date_created_before: Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param country: Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
:param channel: Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
:param destination_prefix: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
:returns: The fetched VerificationAttemptsSummaryInstance
"""
return await self._proxy.fetch_async(
verify_service_sid=verify_service_sid,
date_created_after=date_created_after,
date_created_before=date_created_before,
country=country,
channel=channel,
destination_prefix=destination_prefix,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.VerificationAttemptsSummaryInstance>"
class VerificationAttemptsSummaryContext(InstanceContext):
def __init__(self, version: Version):
"""
Initialize the VerificationAttemptsSummaryContext
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Attempts/Summary"
def fetch(
self,
verify_service_sid: Union[str, object] = values.unset,
date_created_after: Union[datetime, object] = values.unset,
date_created_before: Union[datetime, object] = values.unset,
country: Union[str, object] = values.unset,
channel: Union[
"VerificationAttemptsSummaryInstance.Channels", object
] = values.unset,
destination_prefix: Union[str, object] = values.unset,
) -> VerificationAttemptsSummaryInstance:
"""
Fetch the VerificationAttemptsSummaryInstance
:param verify_service_sid: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
:param date_created_after: Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param date_created_before: Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param country: Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
:param channel: Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
:param destination_prefix: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
:returns: The fetched VerificationAttemptsSummaryInstance
"""
data = values.of(
{
"VerifyServiceSid": verify_service_sid,
"DateCreatedAfter": serialize.iso8601_datetime(date_created_after),
"DateCreatedBefore": serialize.iso8601_datetime(date_created_before),
"Country": country,
"Channel": channel,
"DestinationPrefix": destination_prefix,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return VerificationAttemptsSummaryInstance(
self._version,
payload,
)
async def fetch_async(
self,
verify_service_sid: Union[str, object] = values.unset,
date_created_after: Union[datetime, object] = values.unset,
date_created_before: Union[datetime, object] = values.unset,
country: Union[str, object] = values.unset,
channel: Union[
"VerificationAttemptsSummaryInstance.Channels", object
] = values.unset,
destination_prefix: Union[str, object] = values.unset,
) -> VerificationAttemptsSummaryInstance:
"""
Asynchronous coroutine to fetch the VerificationAttemptsSummaryInstance
:param verify_service_sid: Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
:param date_created_after: Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param date_created_before: Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
:param country: Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
:param channel: Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
:param destination_prefix: Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
:returns: The fetched VerificationAttemptsSummaryInstance
"""
data = values.of(
{
"VerifyServiceSid": verify_service_sid,
"DateCreatedAfter": serialize.iso8601_datetime(date_created_after),
"DateCreatedBefore": serialize.iso8601_datetime(date_created_before),
"Country": country,
"Channel": channel,
"DestinationPrefix": destination_prefix,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return VerificationAttemptsSummaryInstance(
self._version,
payload,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.VerificationAttemptsSummaryContext>"
class VerificationAttemptsSummaryList(ListResource):
def __init__(self, version: Version):
"""
Initialize the VerificationAttemptsSummaryList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self) -> VerificationAttemptsSummaryContext:
"""
Constructs a VerificationAttemptsSummaryContext
"""
return VerificationAttemptsSummaryContext(self._version)
def __call__(self) -> VerificationAttemptsSummaryContext:
"""
Constructs a VerificationAttemptsSummaryContext
"""
return VerificationAttemptsSummaryContext(self._version)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Verify.V2.VerificationAttemptsSummaryList>"
|
