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 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Api
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, Iterator, AsyncIterator
from twilio.base import deserialize, serialize, values
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.version import Version
from twilio.base.page import Page
class MobileInstance(InstanceResource):
class AddressRequirement(object):
NONE = "none"
ANY = "any"
LOCAL = "local"
FOREIGN = "foreign"
class EmergencyAddressStatus(object):
REGISTERED = "registered"
UNREGISTERED = "unregistered"
PENDING_REGISTRATION = "pending-registration"
REGISTRATION_FAILURE = "registration-failure"
PENDING_UNREGISTRATION = "pending-unregistration"
UNREGISTRATION_FAILURE = "unregistration-failure"
class EmergencyStatus(object):
ACTIVE = "Active"
INACTIVE = "Inactive"
class VoiceReceiveMode(object):
VOICE = "voice"
FAX = "fax"
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource.
:ivar address_sid: The SID of the Address resource associated with the phone number.
:ivar address_requirements:
:ivar api_version: The API version used to start a new TwiML session.
:ivar beta: Whether the phone number is new to the Twilio platform. Can be: `true` or `false`.
:ivar capabilities:
:ivar date_created: The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_updated: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar friendly_name: The string that you assigned to describe the resource.
:ivar identity_sid: The SID of the Identity resource that we associate with the phone number. Some regions require an Identity to meet local regulations.
:ivar phone_number: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
:ivar origin: The phone number's origin. `twilio` identifies Twilio-owned phone numbers and `hosted` identifies hosted phone numbers.
:ivar sid: The unique string that that we created to identify the resource.
:ivar sms_application_sid: The SID of the application that handles SMS messages sent to the phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.
:ivar sms_fallback_method: The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`.
:ivar sms_fallback_url: The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`.
:ivar sms_method: The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`.
:ivar sms_url: The URL we call when the phone number receives an incoming SMS message.
:ivar status_callback: The URL we call using the `status_callback_method` to send status information to your application.
:ivar status_callback_method: The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`.
:ivar trunk_sid: The SID of the Trunk that handles calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
:ivar uri: The URI of the resource, relative to `https://api.twilio.com`.
:ivar voice_receive_mode:
:ivar voice_application_sid: The SID of the application that handles calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
:ivar voice_caller_id_lookup: Whether we look up the caller's caller-ID name from the CNAM database ($0.01 per look up). Can be: `true` or `false`.
:ivar voice_fallback_method: The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`.
:ivar voice_fallback_url: The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`.
:ivar voice_method: The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`.
:ivar voice_url: The URL we call when the phone number receives a call. The `voice_url` will not be used if a `voice_application_sid` or a `trunk_sid` is set.
:ivar emergency_status:
:ivar emergency_address_sid: The SID of the emergency address configuration that we use for emergency calling from this phone number.
:ivar emergency_address_status:
:ivar bundle_sid: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
:ivar status:
"""
def __init__(self, version: Version, payload: Dict[str, Any], account_sid: str):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.address_sid: Optional[str] = payload.get("address_sid")
self.address_requirements: Optional["MobileInstance.AddressRequirement"] = (
payload.get("address_requirements")
)
self.api_version: Optional[str] = payload.get("api_version")
self.beta: Optional[bool] = payload.get("beta")
self.capabilities: Optional[str] = payload.get("capabilities")
self.date_created: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_updated")
)
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.identity_sid: Optional[str] = payload.get("identity_sid")
self.phone_number: Optional[str] = payload.get("phone_number")
self.origin: Optional[str] = payload.get("origin")
self.sid: Optional[str] = payload.get("sid")
self.sms_application_sid: Optional[str] = payload.get("sms_application_sid")
self.sms_fallback_method: Optional[str] = payload.get("sms_fallback_method")
self.sms_fallback_url: Optional[str] = payload.get("sms_fallback_url")
self.sms_method: Optional[str] = payload.get("sms_method")
self.sms_url: Optional[str] = payload.get("sms_url")
self.status_callback: Optional[str] = payload.get("status_callback")
self.status_callback_method: Optional[str] = payload.get(
"status_callback_method"
)
self.trunk_sid: Optional[str] = payload.get("trunk_sid")
self.uri: Optional[str] = payload.get("uri")
self.voice_receive_mode: Optional["MobileInstance.VoiceReceiveMode"] = (
payload.get("voice_receive_mode")
)
self.voice_application_sid: Optional[str] = payload.get("voice_application_sid")
self.voice_caller_id_lookup: Optional[bool] = payload.get(
"voice_caller_id_lookup"
)
self.voice_fallback_method: Optional[str] = payload.get("voice_fallback_method")
self.voice_fallback_url: Optional[str] = payload.get("voice_fallback_url")
self.voice_method: Optional[str] = payload.get("voice_method")
self.voice_url: Optional[str] = payload.get("voice_url")
self.emergency_status: Optional["MobileInstance.EmergencyStatus"] = payload.get(
"emergency_status"
)
self.emergency_address_sid: Optional[str] = payload.get("emergency_address_sid")
self.emergency_address_status: Optional[
"MobileInstance.EmergencyAddressStatus"
] = payload.get("emergency_address_status")
self.bundle_sid: Optional[str] = payload.get("bundle_sid")
self.status: Optional[str] = payload.get("status")
self._solution = {
"account_sid": account_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.Api.V2010.MobileInstance {}>".format(context)
class MobilePage(Page):
def get_instance(self, payload: Dict[str, Any]) -> MobileInstance:
"""
Build an instance of MobileInstance
:param payload: Payload response from the API
"""
return MobileInstance(
self._version, payload, account_sid=self._solution["account_sid"]
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Api.V2010.MobilePage>"
class MobileList(ListResource):
def __init__(self, version: Version, account_sid: str):
"""
Initialize the MobileList
:param version: Version that contains the resource
:param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.
"""
super().__init__(version)
# Path Solution
self._solution = {
"account_sid": account_sid,
}
self._uri = "/Accounts/{account_sid}/IncomingPhoneNumbers/Mobile.json".format(
**self._solution
)
def create(
self,
phone_number: str,
api_version: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
sms_application_sid: Union[str, object] = values.unset,
sms_fallback_method: Union[str, object] = values.unset,
sms_fallback_url: Union[str, object] = values.unset,
sms_method: Union[str, object] = values.unset,
sms_url: Union[str, object] = values.unset,
status_callback: Union[str, object] = values.unset,
status_callback_method: Union[str, object] = values.unset,
voice_application_sid: Union[str, object] = values.unset,
voice_caller_id_lookup: Union[bool, object] = values.unset,
voice_fallback_method: Union[str, object] = values.unset,
voice_fallback_url: Union[str, object] = values.unset,
voice_method: Union[str, object] = values.unset,
voice_url: Union[str, object] = values.unset,
identity_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
emergency_status: Union[
"MobileInstance.EmergencyStatus", object
] = values.unset,
emergency_address_sid: Union[str, object] = values.unset,
trunk_sid: Union[str, object] = values.unset,
voice_receive_mode: Union[
"MobileInstance.VoiceReceiveMode", object
] = values.unset,
bundle_sid: Union[str, object] = values.unset,
) -> MobileInstance:
"""
Create the MobileInstance
:param phone_number: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
:param api_version: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.
:param friendly_name: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.
:param sms_application_sid: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application.
:param sms_fallback_method: The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param sms_fallback_url: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
:param sms_method: The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param sms_url: The URL we should call when the new phone number receives an incoming SMS message.
:param status_callback: The URL we should call using the `status_callback_method` to send status information to your application.
:param status_callback_method: The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_application_sid: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
:param voice_caller_id_lookup: Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
:param voice_fallback_method: The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_fallback_url: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
:param voice_method: The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_url: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
:param identity_sid: The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
:param address_sid: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
:param emergency_status:
:param emergency_address_sid: The SID of the emergency address configuration to use for emergency calling from the new phone number.
:param trunk_sid: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
:param voice_receive_mode:
:param bundle_sid: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
:returns: The created MobileInstance
"""
data = values.of(
{
"PhoneNumber": phone_number,
"ApiVersion": api_version,
"FriendlyName": friendly_name,
"SmsApplicationSid": sms_application_sid,
"SmsFallbackMethod": sms_fallback_method,
"SmsFallbackUrl": sms_fallback_url,
"SmsMethod": sms_method,
"SmsUrl": sms_url,
"StatusCallback": status_callback,
"StatusCallbackMethod": status_callback_method,
"VoiceApplicationSid": voice_application_sid,
"VoiceCallerIdLookup": serialize.boolean_to_string(
voice_caller_id_lookup
),
"VoiceFallbackMethod": voice_fallback_method,
"VoiceFallbackUrl": voice_fallback_url,
"VoiceMethod": voice_method,
"VoiceUrl": voice_url,
"IdentitySid": identity_sid,
"AddressSid": address_sid,
"EmergencyStatus": emergency_status,
"EmergencyAddressSid": emergency_address_sid,
"TrunkSid": trunk_sid,
"VoiceReceiveMode": voice_receive_mode,
"BundleSid": bundle_sid,
}
)
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 MobileInstance(
self._version, payload, account_sid=self._solution["account_sid"]
)
async def create_async(
self,
phone_number: str,
api_version: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
sms_application_sid: Union[str, object] = values.unset,
sms_fallback_method: Union[str, object] = values.unset,
sms_fallback_url: Union[str, object] = values.unset,
sms_method: Union[str, object] = values.unset,
sms_url: Union[str, object] = values.unset,
status_callback: Union[str, object] = values.unset,
status_callback_method: Union[str, object] = values.unset,
voice_application_sid: Union[str, object] = values.unset,
voice_caller_id_lookup: Union[bool, object] = values.unset,
voice_fallback_method: Union[str, object] = values.unset,
voice_fallback_url: Union[str, object] = values.unset,
voice_method: Union[str, object] = values.unset,
voice_url: Union[str, object] = values.unset,
identity_sid: Union[str, object] = values.unset,
address_sid: Union[str, object] = values.unset,
emergency_status: Union[
"MobileInstance.EmergencyStatus", object
] = values.unset,
emergency_address_sid: Union[str, object] = values.unset,
trunk_sid: Union[str, object] = values.unset,
voice_receive_mode: Union[
"MobileInstance.VoiceReceiveMode", object
] = values.unset,
bundle_sid: Union[str, object] = values.unset,
) -> MobileInstance:
"""
Asynchronously create the MobileInstance
:param phone_number: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
:param api_version: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.
:param friendly_name: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.
:param sms_application_sid: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application.
:param sms_fallback_method: The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param sms_fallback_url: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.
:param sms_method: The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param sms_url: The URL we should call when the new phone number receives an incoming SMS message.
:param status_callback: The URL we should call using the `status_callback_method` to send status information to your application.
:param status_callback_method: The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_application_sid: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.
:param voice_caller_id_lookup: Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.
:param voice_fallback_method: The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_fallback_url: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.
:param voice_method: The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.
:param voice_url: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.
:param identity_sid: The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.
:param address_sid: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.
:param emergency_status:
:param emergency_address_sid: The SID of the emergency address configuration to use for emergency calling from the new phone number.
:param trunk_sid: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.
:param voice_receive_mode:
:param bundle_sid: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.
:returns: The created MobileInstance
"""
data = values.of(
{
"PhoneNumber": phone_number,
"ApiVersion": api_version,
"FriendlyName": friendly_name,
"SmsApplicationSid": sms_application_sid,
"SmsFallbackMethod": sms_fallback_method,
"SmsFallbackUrl": sms_fallback_url,
"SmsMethod": sms_method,
"SmsUrl": sms_url,
"StatusCallback": status_callback,
"StatusCallbackMethod": status_callback_method,
"VoiceApplicationSid": voice_application_sid,
"VoiceCallerIdLookup": serialize.boolean_to_string(
voice_caller_id_lookup
),
"VoiceFallbackMethod": voice_fallback_method,
"VoiceFallbackUrl": voice_fallback_url,
"VoiceMethod": voice_method,
"VoiceUrl": voice_url,
"IdentitySid": identity_sid,
"AddressSid": address_sid,
"EmergencyStatus": emergency_status,
"EmergencyAddressSid": emergency_address_sid,
"TrunkSid": trunk_sid,
"VoiceReceiveMode": voice_receive_mode,
"BundleSid": bundle_sid,
}
)
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 MobileInstance(
self._version, payload, account_sid=self._solution["account_sid"]
)
def stream(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[MobileInstance]:
"""
Streams MobileInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param bool beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param str friendly_name: A string that identifies the resources to read.
:param str phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param str origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
beta=beta,
friendly_name=friendly_name,
phone_number=phone_number,
origin=origin,
page_size=limits["page_size"],
)
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[MobileInstance]:
"""
Asynchronously streams MobileInstance records from the API as a generator stream.
This operation lazily loads records as efficiently as possible until the limit
is reached.
The results are returned as a generator, so this operation is memory efficient.
:param bool beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param str friendly_name: A string that identifies the resources to read.
:param str phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param str origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the
limit with the most efficient page size, i.e. min(limit, 1000)
:returns: Generator that will yield up to limit results
"""
limits = self._version.read_limits(limit, page_size)
page = await self.page_async(
beta=beta,
friendly_name=friendly_name,
phone_number=phone_number,
origin=origin,
page_size=limits["page_size"],
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[MobileInstance]:
"""
Lists MobileInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param bool beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param str friendly_name: A string that identifies the resources to read.
:param str phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param str origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: list that will contain up to limit results
"""
return list(
self.stream(
beta=beta,
friendly_name=friendly_name,
phone_number=phone_number,
origin=origin,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[MobileInstance]:
"""
Asynchronously lists MobileInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param bool beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param str friendly_name: A string that identifies the resources to read.
:param str phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param str origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param page_size: Number of records to fetch per request, when not set will use
the default value of 50 records. If no page_size is defined
but a limit is defined, list() will attempt to read the limit
with the most efficient page size, i.e. min(limit, 1000)
:returns: list that will contain up to limit results
"""
return [
record
async for record in await self.stream_async(
beta=beta,
friendly_name=friendly_name,
phone_number=phone_number,
origin=origin,
limit=limit,
page_size=page_size,
)
]
def page(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> MobilePage:
"""
Retrieve a single page of MobileInstance records from the API.
Request is executed immediately
:param beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param friendly_name: A string that identifies the resources to read.
:param phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of MobileInstance
"""
data = values.of(
{
"Beta": serialize.boolean_to_string(beta),
"FriendlyName": friendly_name,
"PhoneNumber": phone_number,
"Origin": origin,
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = self._version.page(
method="GET", uri=self._uri, params=data, headers=headers
)
return MobilePage(self._version, response, self._solution)
async def page_async(
self,
beta: Union[bool, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
phone_number: Union[str, object] = values.unset,
origin: Union[str, object] = values.unset,
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
) -> MobilePage:
"""
Asynchronously retrieve a single page of MobileInstance records from the API.
Request is executed immediately
:param beta: Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.
:param friendly_name: A string that identifies the resources to read.
:param phone_number: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.
:param origin: Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.
:param page_token: PageToken provided by the API
:param page_number: Page Number, this value is simply for client state
:param page_size: Number of records to return, defaults to 50
:returns: Page of MobileInstance
"""
data = values.of(
{
"Beta": serialize.boolean_to_string(beta),
"FriendlyName": friendly_name,
"PhoneNumber": phone_number,
"Origin": origin,
"PageToken": page_token,
"Page": page_number,
"PageSize": page_size,
}
)
headers = values.of({"Content-Type": "application/x-www-form-urlencoded"})
headers["Accept"] = "application/json"
response = await self._version.page_async(
method="GET", uri=self._uri, params=data, headers=headers
)
return MobilePage(self._version, response, self._solution)
def get_page(self, target_url: str) -> MobilePage:
"""
Retrieve a specific page of MobileInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of MobileInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return MobilePage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> MobilePage:
"""
Asynchronously retrieve a specific page of MobileInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of MobileInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return MobilePage(self._version, response, self._solution)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Api.V2010.MobileList>"
|