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
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
from twilio.base import serialize
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.page import Page
class VerificationList(ListResource):
def __init__(self, version, service_sid):
"""
Initialize the VerificationList
:param Version version: Version that contains the resource
:param service_sid: The SID of the Service that the resource is associated with
:returns: twilio.rest.verify.v2.service.verification.VerificationList
:rtype: twilio.rest.verify.v2.service.verification.VerificationList
"""
super(VerificationList, self).__init__(version)
# Path Solution
self._solution = {'service_sid': service_sid, }
self._uri = '/Services/{service_sid}/Verifications'.format(**self._solution)
def create(self, to, channel, custom_friendly_name=values.unset,
custom_message=values.unset, send_digits=values.unset,
locale=values.unset, custom_code=values.unset, amount=values.unset,
payee=values.unset, rate_limits=values.unset,
channel_configuration=values.unset, app_hash=values.unset):
"""
Create the VerificationInstance
:param unicode to: The phone number or email to verify
:param unicode channel: The verification method to use
:param unicode custom_friendly_name: A custom user defined friendly name
:param unicode custom_message: The text of a custom message to use for the verification
:param unicode send_digits: The digits to send after a phone call is answered
:param unicode locale: The locale to use for the verification SMS or call
:param unicode custom_code: A pre-generated code
:param unicode amount: The amount of the associated PSD2 compliant transaction.
:param unicode payee: The payee of the associated PSD2 compliant transaction
:param dict rate_limits: The custom key-value pairs of Programmable Rate Limits.
:param dict channel_configuration: Channel specific configuration in json format.
:param unicode app_hash: Your App Hash to be appended at the end of an SMS.
:returns: The created VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.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,
})
payload = self._version.create(method='POST', uri=self._uri, data=data, )
return VerificationInstance(self._version, payload, service_sid=self._solution['service_sid'], )
def get(self, sid):
"""
Constructs a VerificationContext
:param sid: The unique string that identifies the resource
:returns: twilio.rest.verify.v2.service.verification.VerificationContext
:rtype: twilio.rest.verify.v2.service.verification.VerificationContext
"""
return VerificationContext(self._version, service_sid=self._solution['service_sid'], sid=sid, )
def __call__(self, sid):
"""
Constructs a VerificationContext
:param sid: The unique string that identifies the resource
:returns: twilio.rest.verify.v2.service.verification.VerificationContext
:rtype: twilio.rest.verify.v2.service.verification.VerificationContext
"""
return VerificationContext(self._version, service_sid=self._solution['service_sid'], sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Verify.V2.VerificationList>'
class VerificationPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the VerificationPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param service_sid: The SID of the Service that the resource is associated with
:returns: twilio.rest.verify.v2.service.verification.VerificationPage
:rtype: twilio.rest.verify.v2.service.verification.VerificationPage
"""
super(VerificationPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of VerificationInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.verify.v2.service.verification.VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
return VerificationInstance(self._version, payload, service_sid=self._solution['service_sid'], )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Verify.V2.VerificationPage>'
class VerificationContext(InstanceContext):
def __init__(self, version, service_sid, sid):
"""
Initialize the VerificationContext
:param Version version: Version that contains the resource
:param service_sid: The SID of the verification Service to fetch the resource from
:param sid: The unique string that identifies the resource
:returns: twilio.rest.verify.v2.service.verification.VerificationContext
:rtype: twilio.rest.verify.v2.service.verification.VerificationContext
"""
super(VerificationContext, self).__init__(version)
# Path Solution
self._solution = {'service_sid': service_sid, 'sid': sid, }
self._uri = '/Services/{service_sid}/Verifications/{sid}'.format(**self._solution)
def update(self, status):
"""
Update the VerificationInstance
:param VerificationInstance.Status status: The new status of the resource
:returns: The updated VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
data = values.of({'Status': status, })
payload = self._version.update(method='POST', uri=self._uri, data=data, )
return VerificationInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
sid=self._solution['sid'],
)
def fetch(self):
"""
Fetch the VerificationInstance
:returns: The fetched VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return VerificationInstance(
self._version,
payload,
service_sid=self._solution['service_sid'],
sid=self._solution['sid'],
)
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Verify.V2.VerificationContext {}>'.format(context)
class VerificationInstance(InstanceResource):
class Channel(object):
SMS = "sms"
CALL = "call"
EMAIL = "email"
class Status(object):
CANCELED = "canceled"
APPROVED = "approved"
def __init__(self, version, payload, service_sid, sid=None):
"""
Initialize the VerificationInstance
:returns: twilio.rest.verify.v2.service.verification.VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
super(VerificationInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'service_sid': payload.get('service_sid'),
'account_sid': payload.get('account_sid'),
'to': payload.get('to'),
'channel': payload.get('channel'),
'status': payload.get('status'),
'valid': payload.get('valid'),
'lookup': payload.get('lookup'),
'amount': payload.get('amount'),
'payee': payload.get('payee'),
'send_code_attempts': payload.get('send_code_attempts'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {'service_sid': service_sid, 'sid': sid or self._properties['sid'], }
@property
def _proxy(self):
"""
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
:rtype: twilio.rest.verify.v2.service.verification.VerificationContext
"""
if self._context is None:
self._context = VerificationContext(
self._version,
service_sid=self._solution['service_sid'],
sid=self._solution['sid'],
)
return self._context
@property
def sid(self):
"""
:returns: The unique string that identifies the resource
:rtype: unicode
"""
return self._properties['sid']
@property
def service_sid(self):
"""
:returns: The SID of the Service that the resource is associated with
:rtype: unicode
"""
return self._properties['service_sid']
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def to(self):
"""
:returns: The phone number or email being verified
:rtype: unicode
"""
return self._properties['to']
@property
def channel(self):
"""
:returns: The verification method used.
:rtype: VerificationInstance.Channel
"""
return self._properties['channel']
@property
def status(self):
"""
:returns: The status of the verification resource
:rtype: unicode
"""
return self._properties['status']
@property
def valid(self):
"""
:returns: Whether the verification was successful
:rtype: bool
"""
return self._properties['valid']
@property
def lookup(self):
"""
:returns: Information about the phone number being verified
:rtype: dict
"""
return self._properties['lookup']
@property
def amount(self):
"""
:returns: The amount of the associated PSD2 compliant transaction.
:rtype: unicode
"""
return self._properties['amount']
@property
def payee(self):
"""
:returns: The payee of the associated PSD2 compliant transaction
:rtype: unicode
"""
return self._properties['payee']
@property
def send_code_attempts(self):
"""
:returns: An array of verification attempt objects.
:rtype: list[dict]
"""
return self._properties['send_code_attempts']
@property
def date_created(self):
"""
:returns: The RFC 2822 date and time in GMT when the resource was created
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The RFC 2822 date and time in GMT when the resource was last updated
:rtype: datetime
"""
return self._properties['date_updated']
@property
def url(self):
"""
:returns: The absolute URL of the Verification resource
:rtype: unicode
"""
return self._properties['url']
def update(self, status):
"""
Update the VerificationInstance
:param VerificationInstance.Status status: The new status of the resource
:returns: The updated VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
return self._proxy.update(status, )
def fetch(self):
"""
Fetch the VerificationInstance
:returns: The fetched VerificationInstance
:rtype: twilio.rest.verify.v2.service.verification.VerificationInstance
"""
return self._proxy.fetch()
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Verify.V2.VerificationInstance {}>'.format(context)
|