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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Numbers
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 deserialize, 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 PortingPortabilityInstance(InstanceResource):
class NumberType(object):
LOCAL = "LOCAL"
UNKNOWN = "UNKNOWN"
MOBILE = "MOBILE"
TOLL_FREE = "TOLL-FREE"
"""
:ivar phone_number: The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
:ivar account_sid: Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.
:ivar portable: Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.
:ivar pin_and_account_number_required: Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.
:ivar not_portable_reason: Reason why the phone number cannot be ported into Twilio, `null` otherwise.
:ivar not_portable_reason_code: The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise.
:ivar number_type:
:ivar country: Country the phone number belongs to.
:ivar url: This is the url of the request that you're trying to reach out to locate the resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
phone_number: Optional[str] = None,
):
super().__init__(version)
self.phone_number: Optional[str] = payload.get("phone_number")
self.account_sid: Optional[str] = payload.get("account_sid")
self.portable: Optional[bool] = payload.get("portable")
self.pin_and_account_number_required: Optional[bool] = payload.get(
"pin_and_account_number_required"
)
self.not_portable_reason: Optional[str] = payload.get("not_portable_reason")
self.not_portable_reason_code: Optional[int] = deserialize.integer(
payload.get("not_portable_reason_code")
)
self.number_type: Optional["PortingPortabilityInstance.NumberType"] = (
payload.get("number_type")
)
self.country: Optional[str] = payload.get("country")
self.url: Optional[str] = payload.get("url")
self._solution = {
"phone_number": phone_number or self.phone_number,
}
self._context: Optional[PortingPortabilityContext] = None
@property
def _proxy(self) -> "PortingPortabilityContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: PortingPortabilityContext for this PortingPortabilityInstance
"""
if self._context is None:
self._context = PortingPortabilityContext(
self._version,
phone_number=self._solution["phone_number"],
)
return self._context
def fetch(
self,
target_account_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
) -> "PortingPortabilityInstance":
"""
Fetch the PortingPortabilityInstance
:param target_account_sid: Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
:param address_sid: Address Sid of customer to which the number will be ported.
:returns: The fetched PortingPortabilityInstance
"""
return self._proxy.fetch(
target_account_sid=target_account_sid,
address_sid=address_sid,
)
async def fetch_async(
self,
target_account_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
) -> "PortingPortabilityInstance":
"""
Asynchronous coroutine to fetch the PortingPortabilityInstance
:param target_account_sid: Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
:param address_sid: Address Sid of customer to which the number will be ported.
:returns: The fetched PortingPortabilityInstance
"""
return await self._proxy.fetch_async(
target_account_sid=target_account_sid,
address_sid=address_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.Numbers.V1.PortingPortabilityInstance {}>".format(context)
class PortingPortabilityContext(InstanceContext):
def __init__(self, version: Version, phone_number: str):
"""
Initialize the PortingPortabilityContext
:param version: Version that contains the resource
:param phone_number: Phone number to check portability in e164 format.
"""
super().__init__(version)
# Path Solution
self._solution = {
"phone_number": phone_number,
}
self._uri = "/Porting/Portability/PhoneNumber/{phone_number}".format(
**self._solution
)
def fetch(
self,
target_account_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
) -> PortingPortabilityInstance:
"""
Fetch the PortingPortabilityInstance
:param target_account_sid: Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
:param address_sid: Address Sid of customer to which the number will be ported.
:returns: The fetched PortingPortabilityInstance
"""
data = values.of(
{
"TargetAccountSid": target_account_sid,
"AddressSid": address_sid,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return PortingPortabilityInstance(
self._version,
payload,
phone_number=self._solution["phone_number"],
)
async def fetch_async(
self,
target_account_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
) -> PortingPortabilityInstance:
"""
Asynchronous coroutine to fetch the PortingPortabilityInstance
:param target_account_sid: Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
:param address_sid: Address Sid of customer to which the number will be ported.
:returns: The fetched PortingPortabilityInstance
"""
data = values.of(
{
"TargetAccountSid": target_account_sid,
"AddressSid": address_sid,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return PortingPortabilityInstance(
self._version,
payload,
phone_number=self._solution["phone_number"],
)
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.Numbers.V1.PortingPortabilityContext {}>".format(context)
class PortingPortabilityList(ListResource):
def __init__(self, version: Version):
"""
Initialize the PortingPortabilityList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, phone_number: str) -> PortingPortabilityContext:
"""
Constructs a PortingPortabilityContext
:param phone_number: Phone number to check portability in e164 format.
"""
return PortingPortabilityContext(self._version, phone_number=phone_number)
def __call__(self, phone_number: str) -> PortingPortabilityContext:
"""
Constructs a PortingPortabilityContext
:param phone_number: Phone number to check portability in e164 format.
"""
return PortingPortabilityContext(self._version, phone_number=phone_number)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Numbers.V1.PortingPortabilityList>"
|
