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 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
|
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_context import InstanceContext
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
from twilio.rest.api.v2010.account.address.dependent_phone_number import (
DependentPhoneNumberList,
)
class AddressInstance(InstanceResource):
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource.
:ivar city: The city in which the address is located.
:ivar customer_name: The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.
: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 iso_country: The ISO country code of the address.
:ivar postal_code: The postal code of the address.
:ivar region: The state or region of the address.
:ivar sid: The unique string that that we created to identify the Address resource.
:ivar street: The number and street address of the address.
:ivar uri: The URI of the resource, relative to `https://api.twilio.com`.
:ivar emergency_enabled: Whether emergency calling has been enabled on this number.
:ivar validated: Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been validated. `false` indicate the country doesn't require validation or the Address is not valid.
:ivar verified: Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been verified. `false` indicate the country doesn't require verified or the Address is not valid.
:ivar street_secondary: The additional number and street address of the address.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
account_sid: str,
sid: Optional[str] = None,
):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.city: Optional[str] = payload.get("city")
self.customer_name: Optional[str] = payload.get("customer_name")
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.iso_country: Optional[str] = payload.get("iso_country")
self.postal_code: Optional[str] = payload.get("postal_code")
self.region: Optional[str] = payload.get("region")
self.sid: Optional[str] = payload.get("sid")
self.street: Optional[str] = payload.get("street")
self.uri: Optional[str] = payload.get("uri")
self.emergency_enabled: Optional[bool] = payload.get("emergency_enabled")
self.validated: Optional[bool] = payload.get("validated")
self.verified: Optional[bool] = payload.get("verified")
self.street_secondary: Optional[str] = payload.get("street_secondary")
self._solution = {
"account_sid": account_sid,
"sid": sid or self.sid,
}
self._context: Optional[AddressContext] = None
@property
def _proxy(self) -> "AddressContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: AddressContext for this AddressInstance
"""
if self._context is None:
self._context = AddressContext(
self._version,
account_sid=self._solution["account_sid"],
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the AddressInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the AddressInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "AddressInstance":
"""
Fetch the AddressInstance
:returns: The fetched AddressInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "AddressInstance":
"""
Asynchronous coroutine to fetch the AddressInstance
:returns: The fetched AddressInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
customer_name: Union[str, object] = values.unset,
street: Union[str, object] = values.unset,
city: Union[str, object] = values.unset,
region: Union[str, object] = values.unset,
postal_code: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> "AddressInstance":
"""
Update the AddressInstance
:param friendly_name: A descriptive string that you create to describe the address. It can be up to 64 characters long.
:param customer_name: The name to associate with the address.
:param street: The number and street address of the address.
:param city: The city of the address.
:param region: The state or region of the address.
:param postal_code: The postal code of the address.
:param emergency_enabled: Whether to enable emergency calling on the address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The updated AddressInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
customer_name=customer_name,
street=street,
city=city,
region=region,
postal_code=postal_code,
emergency_enabled=emergency_enabled,
auto_correct_address=auto_correct_address,
street_secondary=street_secondary,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
customer_name: Union[str, object] = values.unset,
street: Union[str, object] = values.unset,
city: Union[str, object] = values.unset,
region: Union[str, object] = values.unset,
postal_code: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> "AddressInstance":
"""
Asynchronous coroutine to update the AddressInstance
:param friendly_name: A descriptive string that you create to describe the address. It can be up to 64 characters long.
:param customer_name: The name to associate with the address.
:param street: The number and street address of the address.
:param city: The city of the address.
:param region: The state or region of the address.
:param postal_code: The postal code of the address.
:param emergency_enabled: Whether to enable emergency calling on the address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The updated AddressInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
customer_name=customer_name,
street=street,
city=city,
region=region,
postal_code=postal_code,
emergency_enabled=emergency_enabled,
auto_correct_address=auto_correct_address,
street_secondary=street_secondary,
)
@property
def dependent_phone_numbers(self) -> DependentPhoneNumberList:
"""
Access the dependent_phone_numbers
"""
return self._proxy.dependent_phone_numbers
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.AddressInstance {}>".format(context)
class AddressContext(InstanceContext):
def __init__(self, version: Version, account_sid: str, sid: str):
"""
Initialize the AddressContext
:param version: Version that contains the resource
:param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to update.
:param sid: The Twilio-provided string that uniquely identifies the Address resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"account_sid": account_sid,
"sid": sid,
}
self._uri = "/Accounts/{account_sid}/Addresses/{sid}.json".format(
**self._solution
)
self._dependent_phone_numbers: Optional[DependentPhoneNumberList] = None
def delete(self) -> bool:
"""
Deletes the AddressInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the AddressInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> AddressInstance:
"""
Fetch the AddressInstance
:returns: The fetched AddressInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return AddressInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
sid=self._solution["sid"],
)
async def fetch_async(self) -> AddressInstance:
"""
Asynchronous coroutine to fetch the AddressInstance
:returns: The fetched AddressInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return AddressInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
customer_name: Union[str, object] = values.unset,
street: Union[str, object] = values.unset,
city: Union[str, object] = values.unset,
region: Union[str, object] = values.unset,
postal_code: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> AddressInstance:
"""
Update the AddressInstance
:param friendly_name: A descriptive string that you create to describe the address. It can be up to 64 characters long.
:param customer_name: The name to associate with the address.
:param street: The number and street address of the address.
:param city: The city of the address.
:param region: The state or region of the address.
:param postal_code: The postal code of the address.
:param emergency_enabled: Whether to enable emergency calling on the address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The updated AddressInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"CustomerName": customer_name,
"Street": street,
"City": city,
"Region": region,
"PostalCode": postal_code,
"EmergencyEnabled": serialize.boolean_to_string(emergency_enabled),
"AutoCorrectAddress": serialize.boolean_to_string(auto_correct_address),
"StreetSecondary": street_secondary,
}
)
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 AddressInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
sid=self._solution["sid"],
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
customer_name: Union[str, object] = values.unset,
street: Union[str, object] = values.unset,
city: Union[str, object] = values.unset,
region: Union[str, object] = values.unset,
postal_code: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> AddressInstance:
"""
Asynchronous coroutine to update the AddressInstance
:param friendly_name: A descriptive string that you create to describe the address. It can be up to 64 characters long.
:param customer_name: The name to associate with the address.
:param street: The number and street address of the address.
:param city: The city of the address.
:param region: The state or region of the address.
:param postal_code: The postal code of the address.
:param emergency_enabled: Whether to enable emergency calling on the address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The updated AddressInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"CustomerName": customer_name,
"Street": street,
"City": city,
"Region": region,
"PostalCode": postal_code,
"EmergencyEnabled": serialize.boolean_to_string(emergency_enabled),
"AutoCorrectAddress": serialize.boolean_to_string(auto_correct_address),
"StreetSecondary": street_secondary,
}
)
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 AddressInstance(
self._version,
payload,
account_sid=self._solution["account_sid"],
sid=self._solution["sid"],
)
@property
def dependent_phone_numbers(self) -> DependentPhoneNumberList:
"""
Access the dependent_phone_numbers
"""
if self._dependent_phone_numbers is None:
self._dependent_phone_numbers = DependentPhoneNumberList(
self._version,
self._solution["account_sid"],
self._solution["sid"],
)
return self._dependent_phone_numbers
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.AddressContext {}>".format(context)
class AddressPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> AddressInstance:
"""
Build an instance of AddressInstance
:param payload: Payload response from the API
"""
return AddressInstance(
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.AddressPage>"
class AddressList(ListResource):
def __init__(self, version: Version, account_sid: str):
"""
Initialize the AddressList
:param version: Version that contains the resource
:param account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to read.
"""
super().__init__(version)
# Path Solution
self._solution = {
"account_sid": account_sid,
}
self._uri = "/Accounts/{account_sid}/Addresses.json".format(**self._solution)
def create(
self,
customer_name: str,
street: str,
city: str,
region: str,
postal_code: str,
iso_country: str,
friendly_name: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> AddressInstance:
"""
Create the AddressInstance
:param customer_name: The name to associate with the new address.
:param street: The number and street address of the new address.
:param city: The city of the new address.
:param region: The state or region of the new address.
:param postal_code: The postal code of the new address.
:param iso_country: The ISO country code of the new address.
:param friendly_name: A descriptive string that you create to describe the new address. It can be up to 64 characters long.
:param emergency_enabled: Whether to enable emergency calling on the new address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The created AddressInstance
"""
data = values.of(
{
"CustomerName": customer_name,
"Street": street,
"City": city,
"Region": region,
"PostalCode": postal_code,
"IsoCountry": iso_country,
"FriendlyName": friendly_name,
"EmergencyEnabled": serialize.boolean_to_string(emergency_enabled),
"AutoCorrectAddress": serialize.boolean_to_string(auto_correct_address),
"StreetSecondary": street_secondary,
}
)
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 AddressInstance(
self._version, payload, account_sid=self._solution["account_sid"]
)
async def create_async(
self,
customer_name: str,
street: str,
city: str,
region: str,
postal_code: str,
iso_country: str,
friendly_name: Union[str, object] = values.unset,
emergency_enabled: Union[bool, object] = values.unset,
auto_correct_address: Union[bool, object] = values.unset,
street_secondary: Union[str, object] = values.unset,
) -> AddressInstance:
"""
Asynchronously create the AddressInstance
:param customer_name: The name to associate with the new address.
:param street: The number and street address of the new address.
:param city: The city of the new address.
:param region: The state or region of the new address.
:param postal_code: The postal code of the new address.
:param iso_country: The ISO country code of the new address.
:param friendly_name: A descriptive string that you create to describe the new address. It can be up to 64 characters long.
:param emergency_enabled: Whether to enable emergency calling on the new address. Can be: `true` or `false`.
:param auto_correct_address: Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
:param street_secondary: The additional number and street address of the address.
:returns: The created AddressInstance
"""
data = values.of(
{
"CustomerName": customer_name,
"Street": street,
"City": city,
"Region": region,
"PostalCode": postal_code,
"IsoCountry": iso_country,
"FriendlyName": friendly_name,
"EmergencyEnabled": serialize.boolean_to_string(emergency_enabled),
"AutoCorrectAddress": serialize.boolean_to_string(auto_correct_address),
"StreetSecondary": street_secondary,
}
)
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 AddressInstance(
self._version, payload, account_sid=self._solution["account_sid"]
)
def stream(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[AddressInstance]:
"""
Streams AddressInstance 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 str customer_name: The `customer_name` of the Address resources to read.
:param str friendly_name: The string that identifies the Address resources to read.
:param str iso_country: The ISO country code of the Address resources to read.
: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(
customer_name=customer_name,
friendly_name=friendly_name,
iso_country=iso_country,
page_size=limits["page_size"],
)
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[AddressInstance]:
"""
Asynchronously streams AddressInstance 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 str customer_name: The `customer_name` of the Address resources to read.
:param str friendly_name: The string that identifies the Address resources to read.
:param str iso_country: The ISO country code of the Address resources to read.
: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(
customer_name=customer_name,
friendly_name=friendly_name,
iso_country=iso_country,
page_size=limits["page_size"],
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[AddressInstance]:
"""
Lists AddressInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str customer_name: The `customer_name` of the Address resources to read.
:param str friendly_name: The string that identifies the Address resources to read.
:param str iso_country: The ISO country code of the Address resources to read.
: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(
customer_name=customer_name,
friendly_name=friendly_name,
iso_country=iso_country,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[AddressInstance]:
"""
Asynchronously lists AddressInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str customer_name: The `customer_name` of the Address resources to read.
:param str friendly_name: The string that identifies the Address resources to read.
:param str iso_country: The ISO country code of the Address resources to read.
: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(
customer_name=customer_name,
friendly_name=friendly_name,
iso_country=iso_country,
limit=limit,
page_size=page_size,
)
]
def page(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: 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,
) -> AddressPage:
"""
Retrieve a single page of AddressInstance records from the API.
Request is executed immediately
:param customer_name: The `customer_name` of the Address resources to read.
:param friendly_name: The string that identifies the Address resources to read.
:param iso_country: The ISO country code of the Address resources to read.
: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 AddressInstance
"""
data = values.of(
{
"CustomerName": customer_name,
"FriendlyName": friendly_name,
"IsoCountry": iso_country,
"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 AddressPage(self._version, response, self._solution)
async def page_async(
self,
customer_name: Union[str, object] = values.unset,
friendly_name: Union[str, object] = values.unset,
iso_country: 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,
) -> AddressPage:
"""
Asynchronously retrieve a single page of AddressInstance records from the API.
Request is executed immediately
:param customer_name: The `customer_name` of the Address resources to read.
:param friendly_name: The string that identifies the Address resources to read.
:param iso_country: The ISO country code of the Address resources to read.
: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 AddressInstance
"""
data = values.of(
{
"CustomerName": customer_name,
"FriendlyName": friendly_name,
"IsoCountry": iso_country,
"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 AddressPage(self._version, response, self._solution)
def get_page(self, target_url: str) -> AddressPage:
"""
Retrieve a specific page of AddressInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of AddressInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return AddressPage(self._version, response, self._solution)
async def get_page_async(self, target_url: str) -> AddressPage:
"""
Asynchronously retrieve a specific page of AddressInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of AddressInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return AddressPage(self._version, response, self._solution)
def get(self, sid: str) -> AddressContext:
"""
Constructs a AddressContext
:param sid: The Twilio-provided string that uniquely identifies the Address resource to update.
"""
return AddressContext(
self._version, account_sid=self._solution["account_sid"], sid=sid
)
def __call__(self, sid: str) -> AddressContext:
"""
Constructs a AddressContext
:param sid: The Twilio-provided string that uniquely identifies the Address resource to update.
"""
return AddressContext(
self._version, account_sid=self._solution["account_sid"], sid=sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Api.V2010.AddressList>"
|