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
|
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, List, Optional, Union
from twilio.base import serialize, values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
class ComplianceTollfreeInquiriesInstance(InstanceResource):
class OptInType(object):
VERBAL = "VERBAL"
WEB_FORM = "WEB_FORM"
PAPER_FORM = "PAPER_FORM"
VIA_TEXT = "VIA_TEXT"
MOBILE_QR_CODE = "MOBILE_QR_CODE"
"""
: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 TolfreeId matching the Tollfree 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]):
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")
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Trusthub.V1.ComplianceTollfreeInquiriesInstance>"
class ComplianceTollfreeInquiriesList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ComplianceTollfreeInquiriesList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/ComplianceInquiries/Tollfree/Initialize"
def create(
self,
tollfree_phone_number: str,
notification_email: str,
business_name: Union[str, object] = values.unset,
business_website: Union[str, object] = values.unset,
use_case_categories: Union[List[str], object] = values.unset,
use_case_summary: Union[str, object] = values.unset,
production_message_sample: Union[str, object] = values.unset,
opt_in_image_urls: Union[List[str], object] = values.unset,
opt_in_type: Union[
"ComplianceTollfreeInquiriesInstance.OptInType", object
] = values.unset,
message_volume: Union[str, object] = values.unset,
business_street_address: Union[str, object] = values.unset,
business_street_address2: Union[str, object] = values.unset,
business_city: Union[str, object] = values.unset,
business_state_province_region: Union[str, object] = values.unset,
business_postal_code: Union[str, object] = values.unset,
business_country: Union[str, object] = values.unset,
additional_information: Union[str, object] = values.unset,
business_contact_first_name: Union[str, object] = values.unset,
business_contact_last_name: Union[str, object] = values.unset,
business_contact_email: Union[str, object] = values.unset,
business_contact_phone: Union[str, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
skip_messaging_use_case: Union[bool, object] = values.unset,
) -> ComplianceTollfreeInquiriesInstance:
"""
Create the ComplianceTollfreeInquiriesInstance
:param tollfree_phone_number: The Tollfree phone number to be verified
:param notification_email: The email address to receive the notification about the verification result.
:param business_name: The name of the business or organization using the Tollfree number.
:param business_website: The website of the business or organization using the Tollfree number.
:param use_case_categories: The category of the use case for the Tollfree Number. List as many are applicable..
:param use_case_summary: Use this to further explain how messaging is used by the business or organization.
:param production_message_sample: An example of message content, i.e. a sample message.
:param opt_in_image_urls: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
:param opt_in_type:
:param message_volume: Estimate monthly volume of messages from the Tollfree Number.
:param business_street_address: The address of the business or organization using the Tollfree number.
:param business_street_address2: The address of the business or organization using the Tollfree number.
:param business_city: The city of the business or organization using the Tollfree number.
:param business_state_province_region: The state/province/region of the business or organization using the Tollfree number.
:param business_postal_code: The postal code of the business or organization using the Tollfree number.
:param business_country: The country of the business or organization using the Tollfree number.
:param additional_information: Additional information to be provided for verification.
:param business_contact_first_name: The first name of the contact for the business or organization using the Tollfree number.
:param business_contact_last_name: The last name of the contact for the business or organization using the Tollfree number.
:param business_contact_email: The email address of the contact for the business or organization using the Tollfree number.
:param business_contact_phone: The phone number of the contact for the business or organization using the Tollfree number.
:param theme_set_id: Theme id for styling the inquiry form.
:param skip_messaging_use_case: Skip the messaging use case screen of the inquiry form.
:returns: The created ComplianceTollfreeInquiriesInstance
"""
data = values.of(
{
"TollfreePhoneNumber": tollfree_phone_number,
"NotificationEmail": notification_email,
"BusinessName": business_name,
"BusinessWebsite": business_website,
"UseCaseCategories": serialize.map(use_case_categories, lambda e: e),
"UseCaseSummary": use_case_summary,
"ProductionMessageSample": production_message_sample,
"OptInImageUrls": serialize.map(opt_in_image_urls, lambda e: e),
"OptInType": opt_in_type,
"MessageVolume": message_volume,
"BusinessStreetAddress": business_street_address,
"BusinessStreetAddress2": business_street_address2,
"BusinessCity": business_city,
"BusinessStateProvinceRegion": business_state_province_region,
"BusinessPostalCode": business_postal_code,
"BusinessCountry": business_country,
"AdditionalInformation": additional_information,
"BusinessContactFirstName": business_contact_first_name,
"BusinessContactLastName": business_contact_last_name,
"BusinessContactEmail": business_contact_email,
"BusinessContactPhone": business_contact_phone,
"ThemeSetId": theme_set_id,
"SkipMessagingUseCase": serialize.boolean_to_string(
skip_messaging_use_case
),
}
)
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 ComplianceTollfreeInquiriesInstance(self._version, payload)
async def create_async(
self,
tollfree_phone_number: str,
notification_email: str,
business_name: Union[str, object] = values.unset,
business_website: Union[str, object] = values.unset,
use_case_categories: Union[List[str], object] = values.unset,
use_case_summary: Union[str, object] = values.unset,
production_message_sample: Union[str, object] = values.unset,
opt_in_image_urls: Union[List[str], object] = values.unset,
opt_in_type: Union[
"ComplianceTollfreeInquiriesInstance.OptInType", object
] = values.unset,
message_volume: Union[str, object] = values.unset,
business_street_address: Union[str, object] = values.unset,
business_street_address2: Union[str, object] = values.unset,
business_city: Union[str, object] = values.unset,
business_state_province_region: Union[str, object] = values.unset,
business_postal_code: Union[str, object] = values.unset,
business_country: Union[str, object] = values.unset,
additional_information: Union[str, object] = values.unset,
business_contact_first_name: Union[str, object] = values.unset,
business_contact_last_name: Union[str, object] = values.unset,
business_contact_email: Union[str, object] = values.unset,
business_contact_phone: Union[str, object] = values.unset,
theme_set_id: Union[str, object] = values.unset,
skip_messaging_use_case: Union[bool, object] = values.unset,
) -> ComplianceTollfreeInquiriesInstance:
"""
Asynchronously create the ComplianceTollfreeInquiriesInstance
:param tollfree_phone_number: The Tollfree phone number to be verified
:param notification_email: The email address to receive the notification about the verification result.
:param business_name: The name of the business or organization using the Tollfree number.
:param business_website: The website of the business or organization using the Tollfree number.
:param use_case_categories: The category of the use case for the Tollfree Number. List as many are applicable..
:param use_case_summary: Use this to further explain how messaging is used by the business or organization.
:param production_message_sample: An example of message content, i.e. a sample message.
:param opt_in_image_urls: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL.
:param opt_in_type:
:param message_volume: Estimate monthly volume of messages from the Tollfree Number.
:param business_street_address: The address of the business or organization using the Tollfree number.
:param business_street_address2: The address of the business or organization using the Tollfree number.
:param business_city: The city of the business or organization using the Tollfree number.
:param business_state_province_region: The state/province/region of the business or organization using the Tollfree number.
:param business_postal_code: The postal code of the business or organization using the Tollfree number.
:param business_country: The country of the business or organization using the Tollfree number.
:param additional_information: Additional information to be provided for verification.
:param business_contact_first_name: The first name of the contact for the business or organization using the Tollfree number.
:param business_contact_last_name: The last name of the contact for the business or organization using the Tollfree number.
:param business_contact_email: The email address of the contact for the business or organization using the Tollfree number.
:param business_contact_phone: The phone number of the contact for the business or organization using the Tollfree number.
:param theme_set_id: Theme id for styling the inquiry form.
:param skip_messaging_use_case: Skip the messaging use case screen of the inquiry form.
:returns: The created ComplianceTollfreeInquiriesInstance
"""
data = values.of(
{
"TollfreePhoneNumber": tollfree_phone_number,
"NotificationEmail": notification_email,
"BusinessName": business_name,
"BusinessWebsite": business_website,
"UseCaseCategories": serialize.map(use_case_categories, lambda e: e),
"UseCaseSummary": use_case_summary,
"ProductionMessageSample": production_message_sample,
"OptInImageUrls": serialize.map(opt_in_image_urls, lambda e: e),
"OptInType": opt_in_type,
"MessageVolume": message_volume,
"BusinessStreetAddress": business_street_address,
"BusinessStreetAddress2": business_street_address2,
"BusinessCity": business_city,
"BusinessStateProvinceRegion": business_state_province_region,
"BusinessPostalCode": business_postal_code,
"BusinessCountry": business_country,
"AdditionalInformation": additional_information,
"BusinessContactFirstName": business_contact_first_name,
"BusinessContactLastName": business_contact_last_name,
"BusinessContactEmail": business_contact_email,
"BusinessContactPhone": business_contact_phone,
"ThemeSetId": theme_set_id,
"SkipMessagingUseCase": serialize.boolean_to_string(
skip_messaging_use_case
),
}
)
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 ComplianceTollfreeInquiriesInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Trusthub.V1.ComplianceTollfreeInquiriesList>"
|
