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
|
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 datetime import datetime
from typing import Any, Dict, List, 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 BulkHostedNumberOrderInstance(InstanceResource):
class RequestStatus(object):
QUEUED = "QUEUED"
IN_PROGRESS = "IN_PROGRESS"
PROCESSED = "PROCESSED"
"""
:ivar bulk_hosting_sid: A 34 character string that uniquely identifies this BulkHostedNumberOrder.
:ivar request_status:
:ivar friendly_name: A 128 character string that is a human-readable text that describes this resource.
:ivar notification_email: Email address used for send notifications about this Bulk hosted number request.
:ivar date_created: The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_completed: The date that this resource was completed, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
:ivar url: The URL of this BulkHostedNumberOrder resource.
:ivar total_count: The total count of phone numbers in this Bulk hosting request.
:ivar results: Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
bulk_hosting_sid: Optional[str] = None,
):
super().__init__(version)
self.bulk_hosting_sid: Optional[str] = payload.get("bulk_hosting_sid")
self.request_status: Optional["BulkHostedNumberOrderInstance.RequestStatus"] = (
payload.get("request_status")
)
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.notification_email: Optional[str] = payload.get("notification_email")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_completed: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_completed")
)
self.url: Optional[str] = payload.get("url")
self.total_count: Optional[int] = deserialize.integer(
payload.get("total_count")
)
self.results: Optional[List[Dict[str, object]]] = payload.get("results")
self._solution = {
"bulk_hosting_sid": bulk_hosting_sid or self.bulk_hosting_sid,
}
self._context: Optional[BulkHostedNumberOrderContext] = None
@property
def _proxy(self) -> "BulkHostedNumberOrderContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: BulkHostedNumberOrderContext for this BulkHostedNumberOrderInstance
"""
if self._context is None:
self._context = BulkHostedNumberOrderContext(
self._version,
bulk_hosting_sid=self._solution["bulk_hosting_sid"],
)
return self._context
def fetch(
self, order_status: Union[str, object] = values.unset
) -> "BulkHostedNumberOrderInstance":
"""
Fetch the BulkHostedNumberOrderInstance
:param order_status: Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
:returns: The fetched BulkHostedNumberOrderInstance
"""
return self._proxy.fetch(
order_status=order_status,
)
async def fetch_async(
self, order_status: Union[str, object] = values.unset
) -> "BulkHostedNumberOrderInstance":
"""
Asynchronous coroutine to fetch the BulkHostedNumberOrderInstance
:param order_status: Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
:returns: The fetched BulkHostedNumberOrderInstance
"""
return await self._proxy.fetch_async(
order_status=order_status,
)
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.V2.BulkHostedNumberOrderInstance {}>".format(context)
class BulkHostedNumberOrderContext(InstanceContext):
def __init__(self, version: Version, bulk_hosting_sid: str):
"""
Initialize the BulkHostedNumberOrderContext
:param version: Version that contains the resource
:param bulk_hosting_sid: A 34 character string that uniquely identifies this BulkHostedNumberOrder.
"""
super().__init__(version)
# Path Solution
self._solution = {
"bulk_hosting_sid": bulk_hosting_sid,
}
self._uri = "/HostedNumber/Orders/Bulk/{bulk_hosting_sid}".format(
**self._solution
)
def fetch(
self, order_status: Union[str, object] = values.unset
) -> BulkHostedNumberOrderInstance:
"""
Fetch the BulkHostedNumberOrderInstance
:param order_status: Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
:returns: The fetched BulkHostedNumberOrderInstance
"""
data = values.of(
{
"OrderStatus": order_status,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(
method="GET", uri=self._uri, params=data, headers=headers
)
return BulkHostedNumberOrderInstance(
self._version,
payload,
bulk_hosting_sid=self._solution["bulk_hosting_sid"],
)
async def fetch_async(
self, order_status: Union[str, object] = values.unset
) -> BulkHostedNumberOrderInstance:
"""
Asynchronous coroutine to fetch the BulkHostedNumberOrderInstance
:param order_status: Order status can be used for filtering on Hosted Number Order status values. To see a complete list of order statuses, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.
:returns: The fetched BulkHostedNumberOrderInstance
"""
data = values.of(
{
"OrderStatus": order_status,
}
)
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return BulkHostedNumberOrderInstance(
self._version,
payload,
bulk_hosting_sid=self._solution["bulk_hosting_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.V2.BulkHostedNumberOrderContext {}>".format(context)
class BulkHostedNumberOrderList(ListResource):
def __init__(self, version: Version):
"""
Initialize the BulkHostedNumberOrderList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/HostedNumber/Orders/Bulk"
def create(
self, body: Union[object, object] = values.unset
) -> BulkHostedNumberOrderInstance:
"""
Create the BulkHostedNumberOrderInstance
:param body:
:returns: The created BulkHostedNumberOrderInstance
"""
data = body.to_dict()
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/json"
headers["Accept"] = "application/json"
payload = self._version.create(
method="POST", uri=self._uri, data=data, headers=headers
)
return BulkHostedNumberOrderInstance(self._version, payload)
async def create_async(
self, body: Union[object, object] = values.unset
) -> BulkHostedNumberOrderInstance:
"""
Asynchronously create the BulkHostedNumberOrderInstance
:param body:
:returns: The created BulkHostedNumberOrderInstance
"""
data = body.to_dict()
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Content-Type"] = "application/json"
headers["Accept"] = "application/json"
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return BulkHostedNumberOrderInstance(self._version, payload)
def get(self, bulk_hosting_sid: str) -> BulkHostedNumberOrderContext:
"""
Constructs a BulkHostedNumberOrderContext
:param bulk_hosting_sid: A 34 character string that uniquely identifies this BulkHostedNumberOrder.
"""
return BulkHostedNumberOrderContext(
self._version, bulk_hosting_sid=bulk_hosting_sid
)
def __call__(self, bulk_hosting_sid: str) -> BulkHostedNumberOrderContext:
"""
Constructs a BulkHostedNumberOrderContext
:param bulk_hosting_sid: A 34 character string that uniquely identifies this BulkHostedNumberOrder.
"""
return BulkHostedNumberOrderContext(
self._version, bulk_hosting_sid=bulk_hosting_sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Numbers.V2.BulkHostedNumberOrderList>"
|
