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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Trusthub
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, Union
from twilio.base import 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 ComplianceRegistrationInquiriesInstance(InstanceResource):
class BusinessIdentityType(object):
DIRECT_CUSTOMER = "direct_customer"
ISV_RESELLER_OR_PARTNER = "isv_reseller_or_partner"
UNKNOWN = "unknown"
class BusinessRegistrationAuthority(object):
UK_CRN = "UK:CRN"
US_EIN = "US:EIN"
CA_CBN = "CA:CBN"
AU_ACN = "AU:ACN"
OTHER = "Other"
class EndUserType(object):
INDIVIDUAL = "Individual"
BUSINESS = "Business"
class PhoneNumberType(object):
LOCAL = "local"
NATIONAL = "national"
MOBILE = "mobile"
TOLL_FREE = "toll-free"
"""
:ivar inquiry_id: The unique ID used to start an embedded compliance registration session.
:ivar inquiry_session_token: The session token used to start an embedded compliance registration session.
:ivar registration_id: The RegistrationId matching the Registration Profile that should be resumed or resubmitted for editing.
:ivar url: The URL of this resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
registration_id: Optional[str] = None,
):
super().__init__(version)
self.inquiry_id: Optional[str] = payload.get("inquiry_id")
self.inquiry_session_token: Optional[str] = payload.get("inquiry_session_token")
self.registration_id: Optional[str] = payload.get("registration_id")
self.url: Optional[str] = payload.get("url")
self._solution = {
"registration_id": registration_id or self.registration_id,
}
self._context: Optional[ComplianceRegistrationInquiriesContext] = None
@property
def _proxy(self) -> "ComplianceRegistrationInquiriesContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: ComplianceRegistrationInquiriesContext for this ComplianceRegistrationInquiriesInstance
"""
if self._context is None:
self._context = ComplianceRegistrationInquiriesContext(
self._version,
registration_id=self._solution["registration_id"],
)
return self._context
def update(
self,
is_isv_embed: Union[bool, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> "ComplianceRegistrationInquiriesInstance":
"""
Update the ComplianceRegistrationInquiriesInstance
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The updated ComplianceRegistrationInquiriesInstance
"""
return self._proxy.update(
is_isv_embed=is_isv_embed,
theme_set_id=theme_set_id,
)
async def update_async(
self,
is_isv_embed: Union[bool, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> "ComplianceRegistrationInquiriesInstance":
"""
Asynchronous coroutine to update the ComplianceRegistrationInquiriesInstance
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The updated ComplianceRegistrationInquiriesInstance
"""
return await self._proxy.update_async(
is_isv_embed=is_isv_embed,
theme_set_id=theme_set_id,
)
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.Trusthub.V1.ComplianceRegistrationInquiriesInstance {}>".format(
context
)
class ComplianceRegistrationInquiriesContext(InstanceContext):
def __init__(self, version: Version, registration_id: str):
"""
Initialize the ComplianceRegistrationInquiriesContext
:param version: Version that contains the resource
:param registration_id: The unique RegistrationId matching the Regulatory Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Regulatory Compliance Inquiry creation call.
"""
super().__init__(version)
# Path Solution
self._solution = {
"registration_id": registration_id,
}
self._uri = "/ComplianceInquiries/Registration/{registration_id}/RegulatoryCompliance/GB/Initialize".format(
**self._solution
)
def update(
self,
is_isv_embed: Union[bool, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> ComplianceRegistrationInquiriesInstance:
"""
Update the ComplianceRegistrationInquiriesInstance
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The updated ComplianceRegistrationInquiriesInstance
"""
data = values.of(
{
"IsIsvEmbed": serialize.boolean_to_string(is_isv_embed),
"ThemeSetId": theme_set_id,
}
)
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 ComplianceRegistrationInquiriesInstance(
self._version, payload, registration_id=self._solution["registration_id"]
)
async def update_async(
self,
is_isv_embed: Union[bool, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> ComplianceRegistrationInquiriesInstance:
"""
Asynchronous coroutine to update the ComplianceRegistrationInquiriesInstance
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The updated ComplianceRegistrationInquiriesInstance
"""
data = values.of(
{
"IsIsvEmbed": serialize.boolean_to_string(is_isv_embed),
"ThemeSetId": theme_set_id,
}
)
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 ComplianceRegistrationInquiriesInstance(
self._version, payload, registration_id=self._solution["registration_id"]
)
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.Trusthub.V1.ComplianceRegistrationInquiriesContext {}>".format(
context
)
class ComplianceRegistrationInquiriesList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ComplianceRegistrationInquiriesList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = (
"/ComplianceInquiries/Registration/RegulatoryCompliance/GB/Initialize"
)
def create(
self,
end_user_type: "ComplianceRegistrationInquiriesInstance.EndUserType",
phone_number_type: "ComplianceRegistrationInquiriesInstance.PhoneNumberType",
business_identity_type: Union[
"ComplianceRegistrationInquiriesInstance.BusinessIdentityType", object
] = values.unset,
business_registration_authority: Union[
"ComplianceRegistrationInquiriesInstance.BusinessRegistrationAuthority",
object,
] = values.unset,
business_legal_name: Union[str, object] = values.unset,
notification_email: Union[str, object] = values.unset,
accepted_notification_receipt: Union[bool, object] = values.unset,
business_registration_number: Union[str, object] = values.unset,
business_website_url: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
authorized_representative1_first_name: Union[str, object] = values.unset,
authorized_representative1_last_name: Union[str, object] = values.unset,
authorized_representative1_phone: Union[str, object] = values.unset,
authorized_representative1_email: Union[str, object] = values.unset,
authorized_representative1_date_of_birth: Union[str, object] = values.unset,
address_street: Union[str, object] = values.unset,
address_street_secondary: Union[str, object] = values.unset,
address_city: Union[str, object] = values.unset,
address_subdivision: Union[str, object] = values.unset,
address_postal_code: Union[str, object] = values.unset,
address_country_code: Union[str, object] = values.unset,
emergency_address_street: Union[str, object] = values.unset,
emergency_address_street_secondary: Union[str, object] = values.unset,
emergency_address_city: Union[str, object] = values.unset,
emergency_address_subdivision: Union[str, object] = values.unset,
emergency_address_postal_code: Union[str, object] = values.unset,
emergency_address_country_code: Union[str, object] = values.unset,
use_address_as_emergency_address: Union[bool, object] = values.unset,
file_name: Union[str, object] = values.unset,
file: Union[str, object] = values.unset,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
date_of_birth: Union[str, object] = values.unset,
individual_email: Union[str, object] = values.unset,
individual_phone: Union[str, object] = values.unset,
is_isv_embed: Union[bool, object] = values.unset,
isv_registering_for_self_or_tenant: Union[str, object] = values.unset,
status_callback_url: Union[str, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> ComplianceRegistrationInquiriesInstance:
"""
Create the ComplianceRegistrationInquiriesInstance
:param end_user_type:
:param phone_number_type:
:param business_identity_type:
:param business_registration_authority:
:param business_legal_name: he name of the business or organization using the Tollfree number.
:param notification_email: he email address to receive the notification about the verification result.
:param accepted_notification_receipt: The email address to receive the notification about the verification result.
:param business_registration_number: Business registration number of the business
:param business_website_url: The URL of the business website
:param friendly_name: Friendly name for your business information
:param authorized_representative1_first_name: First name of the authorized representative
:param authorized_representative1_last_name: Last name of the authorized representative
:param authorized_representative1_phone: Phone number of the authorized representative
:param authorized_representative1_email: Email address of the authorized representative
:param authorized_representative1_date_of_birth: Birthdate of the authorized representative
:param address_street: Street address of the business
:param address_street_secondary: Street address of the business
:param address_city: City of the business
:param address_subdivision: State or province of the business
:param address_postal_code: Postal code of the business
:param address_country_code: Country code of the business
:param emergency_address_street: Street address of the business
:param emergency_address_street_secondary: Street address of the business
:param emergency_address_city: City of the business
:param emergency_address_subdivision: State or province of the business
:param emergency_address_postal_code: Postal code of the business
:param emergency_address_country_code: Country code of the business
:param use_address_as_emergency_address: Use the business address as the emergency address
:param file_name: The name of the verification document to upload
:param file: The verification document to upload
:param first_name: The first name of the Individual User.
:param last_name: The last name of the Individual User.
:param date_of_birth: The date of birth of the Individual User.
:param individual_email: The email address of the Individual User.
:param individual_phone: The phone number of the Individual User.
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param isv_registering_for_self_or_tenant: Indicates if the isv registering for self or tenant.
:param status_callback_url: The url we call to inform you of bundle changes.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The created ComplianceRegistrationInquiriesInstance
"""
data = values.of(
{
"EndUserType": end_user_type,
"PhoneNumberType": phone_number_type,
"BusinessIdentityType": business_identity_type,
"BusinessRegistrationAuthority": business_registration_authority,
"BusinessLegalName": business_legal_name,
"NotificationEmail": notification_email,
"AcceptedNotificationReceipt": serialize.boolean_to_string(
accepted_notification_receipt
),
"BusinessRegistrationNumber": business_registration_number,
"BusinessWebsiteUrl": business_website_url,
"FriendlyName": friendly_name,
"AuthorizedRepresentative1FirstName": authorized_representative1_first_name,
"AuthorizedRepresentative1LastName": authorized_representative1_last_name,
"AuthorizedRepresentative1Phone": authorized_representative1_phone,
"AuthorizedRepresentative1Email": authorized_representative1_email,
"AuthorizedRepresentative1DateOfBirth": authorized_representative1_date_of_birth,
"AddressStreet": address_street,
"AddressStreetSecondary": address_street_secondary,
"AddressCity": address_city,
"AddressSubdivision": address_subdivision,
"AddressPostalCode": address_postal_code,
"AddressCountryCode": address_country_code,
"EmergencyAddressStreet": emergency_address_street,
"EmergencyAddressStreetSecondary": emergency_address_street_secondary,
"EmergencyAddressCity": emergency_address_city,
"EmergencyAddressSubdivision": emergency_address_subdivision,
"EmergencyAddressPostalCode": emergency_address_postal_code,
"EmergencyAddressCountryCode": emergency_address_country_code,
"UseAddressAsEmergencyAddress": serialize.boolean_to_string(
use_address_as_emergency_address
),
"FileName": file_name,
"File": file,
"FirstName": first_name,
"LastName": last_name,
"DateOfBirth": date_of_birth,
"IndividualEmail": individual_email,
"IndividualPhone": individual_phone,
"IsIsvEmbed": serialize.boolean_to_string(is_isv_embed),
"IsvRegisteringForSelfOrTenant": isv_registering_for_self_or_tenant,
"StatusCallbackUrl": status_callback_url,
"ThemeSetId": theme_set_id,
}
)
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 ComplianceRegistrationInquiriesInstance(self._version, payload)
async def create_async(
self,
end_user_type: "ComplianceRegistrationInquiriesInstance.EndUserType",
phone_number_type: "ComplianceRegistrationInquiriesInstance.PhoneNumberType",
business_identity_type: Union[
"ComplianceRegistrationInquiriesInstance.BusinessIdentityType", object
] = values.unset,
business_registration_authority: Union[
"ComplianceRegistrationInquiriesInstance.BusinessRegistrationAuthority",
object,
] = values.unset,
business_legal_name: Union[str, object] = values.unset,
notification_email: Union[str, object] = values.unset,
accepted_notification_receipt: Union[bool, object] = values.unset,
business_registration_number: Union[str, object] = values.unset,
business_website_url: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
authorized_representative1_first_name: Union[str, object] = values.unset,
authorized_representative1_last_name: Union[str, object] = values.unset,
authorized_representative1_phone: Union[str, object] = values.unset,
authorized_representative1_email: Union[str, object] = values.unset,
authorized_representative1_date_of_birth: Union[str, object] = values.unset,
address_street: Union[str, object] = values.unset,
address_street_secondary: Union[str, object] = values.unset,
address_city: Union[str, object] = values.unset,
address_subdivision: Union[str, object] = values.unset,
address_postal_code: Union[str, object] = values.unset,
address_country_code: Union[str, object] = values.unset,
emergency_address_street: Union[str, object] = values.unset,
emergency_address_street_secondary: Union[str, object] = values.unset,
emergency_address_city: Union[str, object] = values.unset,
emergency_address_subdivision: Union[str, object] = values.unset,
emergency_address_postal_code: Union[str, object] = values.unset,
emergency_address_country_code: Union[str, object] = values.unset,
use_address_as_emergency_address: Union[bool, object] = values.unset,
file_name: Union[str, object] = values.unset,
file: Union[str, object] = values.unset,
first_name: Union[str, object] = values.unset,
last_name: Union[str, object] = values.unset,
date_of_birth: Union[str, object] = values.unset,
individual_email: Union[str, object] = values.unset,
individual_phone: Union[str, object] = values.unset,
is_isv_embed: Union[bool, object] = values.unset,
isv_registering_for_self_or_tenant: Union[str, object] = values.unset,
status_callback_url: Union[str, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
) -> ComplianceRegistrationInquiriesInstance:
"""
Asynchronously create the ComplianceRegistrationInquiriesInstance
:param end_user_type:
:param phone_number_type:
:param business_identity_type:
:param business_registration_authority:
:param business_legal_name: he name of the business or organization using the Tollfree number.
:param notification_email: he email address to receive the notification about the verification result.
:param accepted_notification_receipt: The email address to receive the notification about the verification result.
:param business_registration_number: Business registration number of the business
:param business_website_url: The URL of the business website
:param friendly_name: Friendly name for your business information
:param authorized_representative1_first_name: First name of the authorized representative
:param authorized_representative1_last_name: Last name of the authorized representative
:param authorized_representative1_phone: Phone number of the authorized representative
:param authorized_representative1_email: Email address of the authorized representative
:param authorized_representative1_date_of_birth: Birthdate of the authorized representative
:param address_street: Street address of the business
:param address_street_secondary: Street address of the business
:param address_city: City of the business
:param address_subdivision: State or province of the business
:param address_postal_code: Postal code of the business
:param address_country_code: Country code of the business
:param emergency_address_street: Street address of the business
:param emergency_address_street_secondary: Street address of the business
:param emergency_address_city: City of the business
:param emergency_address_subdivision: State or province of the business
:param emergency_address_postal_code: Postal code of the business
:param emergency_address_country_code: Country code of the business
:param use_address_as_emergency_address: Use the business address as the emergency address
:param file_name: The name of the verification document to upload
:param file: The verification document to upload
:param first_name: The first name of the Individual User.
:param last_name: The last name of the Individual User.
:param date_of_birth: The date of birth of the Individual User.
:param individual_email: The email address of the Individual User.
:param individual_phone: The phone number of the Individual User.
:param is_isv_embed: Indicates if the inquiry is being started from an ISV embedded component.
:param isv_registering_for_self_or_tenant: Indicates if the isv registering for self or tenant.
:param status_callback_url: The url we call to inform you of bundle changes.
:param theme_set_id: Theme id for styling the inquiry form.
:returns: The created ComplianceRegistrationInquiriesInstance
"""
data = values.of(
{
"EndUserType": end_user_type,
"PhoneNumberType": phone_number_type,
"BusinessIdentityType": business_identity_type,
"BusinessRegistrationAuthority": business_registration_authority,
"BusinessLegalName": business_legal_name,
"NotificationEmail": notification_email,
"AcceptedNotificationReceipt": serialize.boolean_to_string(
accepted_notification_receipt
),
"BusinessRegistrationNumber": business_registration_number,
"BusinessWebsiteUrl": business_website_url,
"FriendlyName": friendly_name,
"AuthorizedRepresentative1FirstName": authorized_representative1_first_name,
"AuthorizedRepresentative1LastName": authorized_representative1_last_name,
"AuthorizedRepresentative1Phone": authorized_representative1_phone,
"AuthorizedRepresentative1Email": authorized_representative1_email,
"AuthorizedRepresentative1DateOfBirth": authorized_representative1_date_of_birth,
"AddressStreet": address_street,
"AddressStreetSecondary": address_street_secondary,
"AddressCity": address_city,
"AddressSubdivision": address_subdivision,
"AddressPostalCode": address_postal_code,
"AddressCountryCode": address_country_code,
"EmergencyAddressStreet": emergency_address_street,
"EmergencyAddressStreetSecondary": emergency_address_street_secondary,
"EmergencyAddressCity": emergency_address_city,
"EmergencyAddressSubdivision": emergency_address_subdivision,
"EmergencyAddressPostalCode": emergency_address_postal_code,
"EmergencyAddressCountryCode": emergency_address_country_code,
"UseAddressAsEmergencyAddress": serialize.boolean_to_string(
use_address_as_emergency_address
),
"FileName": file_name,
"File": file,
"FirstName": first_name,
"LastName": last_name,
"DateOfBirth": date_of_birth,
"IndividualEmail": individual_email,
"IndividualPhone": individual_phone,
"IsIsvEmbed": serialize.boolean_to_string(is_isv_embed),
"IsvRegisteringForSelfOrTenant": isv_registering_for_self_or_tenant,
"StatusCallbackUrl": status_callback_url,
"ThemeSetId": theme_set_id,
}
)
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 ComplianceRegistrationInquiriesInstance(self._version, payload)
def get(self, registration_id: str) -> ComplianceRegistrationInquiriesContext:
"""
Constructs a ComplianceRegistrationInquiriesContext
:param registration_id: The unique RegistrationId matching the Regulatory Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Regulatory Compliance Inquiry creation call.
"""
return ComplianceRegistrationInquiriesContext(
self._version, registration_id=registration_id
)
def __call__(self, registration_id: str) -> ComplianceRegistrationInquiriesContext:
"""
Constructs a ComplianceRegistrationInquiriesContext
:param registration_id: The unique RegistrationId matching the Regulatory Compliance Inquiry that should be resumed or resubmitted. This value will have been returned by the initial Regulatory Compliance Inquiry creation call.
"""
return ComplianceRegistrationInquiriesContext(
self._version, registration_id=registration_id
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Trusthub.V1.ComplianceRegistrationInquiriesList>"
|
