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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Conversations
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
class AddressConfigurationInstance(InstanceResource):
class AutoCreationType(object):
WEBHOOK = "webhook"
STUDIO = "studio"
DEFAULT = "default"
class Method(object):
GET = "GET"
POST = "POST"
class Type(object):
SMS = "sms"
WHATSAPP = "whatsapp"
MESSENGER = "messenger"
GBM = "gbm"
EMAIL = "email"
"""
:ivar sid: A 34 character string that uniquely identifies this resource.
:ivar account_sid: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) the address belongs to
:ivar type: Type of Address, value can be `whatsapp` or `sms`.
:ivar address: The unique address to be configured. The address can be a whatsapp address or phone number
:ivar friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:ivar auto_creation: Auto Creation configuration for the address.
:ivar date_created: The date that this resource was created.
:ivar date_updated: The date that this resource was last updated.
:ivar url: An absolute API resource URL for this address configuration.
:ivar address_country: An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
"""
def __init__(
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.type: Optional[str] = payload.get("type")
self.address: Optional[str] = payload.get("address")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.auto_creation: Optional[Dict[str, object]] = payload.get("auto_creation")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_updated")
)
self.url: Optional[str] = payload.get("url")
self.address_country: Optional[str] = payload.get("address_country")
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[AddressConfigurationContext] = None
@property
def _proxy(self) -> "AddressConfigurationContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: AddressConfigurationContext for this AddressConfigurationInstance
"""
if self._context is None:
self._context = AddressConfigurationContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the AddressConfigurationInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the AddressConfigurationInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "AddressConfigurationInstance":
"""
Fetch the AddressConfigurationInstance
:returns: The fetched AddressConfigurationInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "AddressConfigurationInstance":
"""
Asynchronous coroutine to fetch the AddressConfigurationInstance
:returns: The fetched AddressConfigurationInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
) -> "AddressConfigurationInstance":
"""
Update the AddressConfigurationInstance
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:returns: The updated AddressConfigurationInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
auto_creation_enabled=auto_creation_enabled,
auto_creation_type=auto_creation_type,
auto_creation_conversation_service_sid=auto_creation_conversation_service_sid,
auto_creation_webhook_url=auto_creation_webhook_url,
auto_creation_webhook_method=auto_creation_webhook_method,
auto_creation_webhook_filters=auto_creation_webhook_filters,
auto_creation_studio_flow_sid=auto_creation_studio_flow_sid,
auto_creation_studio_retry_count=auto_creation_studio_retry_count,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
) -> "AddressConfigurationInstance":
"""
Asynchronous coroutine to update the AddressConfigurationInstance
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:returns: The updated AddressConfigurationInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
auto_creation_enabled=auto_creation_enabled,
auto_creation_type=auto_creation_type,
auto_creation_conversation_service_sid=auto_creation_conversation_service_sid,
auto_creation_webhook_url=auto_creation_webhook_url,
auto_creation_webhook_method=auto_creation_webhook_method,
auto_creation_webhook_filters=auto_creation_webhook_filters,
auto_creation_studio_flow_sid=auto_creation_studio_flow_sid,
auto_creation_studio_retry_count=auto_creation_studio_retry_count,
)
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.Conversations.V1.AddressConfigurationInstance {}>".format(
context
)
class AddressConfigurationContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the AddressConfigurationContext
:param version: Version that contains the resource
:param sid: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Configuration/Addresses/{sid}".format(**self._solution)
def delete(self) -> bool:
"""
Deletes the AddressConfigurationInstance
: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 AddressConfigurationInstance
: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) -> AddressConfigurationInstance:
"""
Fetch the AddressConfigurationInstance
:returns: The fetched AddressConfigurationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return AddressConfigurationInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> AddressConfigurationInstance:
"""
Asynchronous coroutine to fetch the AddressConfigurationInstance
:returns: The fetched AddressConfigurationInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return AddressConfigurationInstance(
self._version,
payload,
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
) -> AddressConfigurationInstance:
"""
Update the AddressConfigurationInstance
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:returns: The updated AddressConfigurationInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"AutoCreation.Enabled": serialize.boolean_to_string(
auto_creation_enabled
),
"AutoCreation.Type": auto_creation_type,
"AutoCreation.ConversationServiceSid": auto_creation_conversation_service_sid,
"AutoCreation.WebhookUrl": auto_creation_webhook_url,
"AutoCreation.WebhookMethod": auto_creation_webhook_method,
"AutoCreation.WebhookFilters": serialize.map(
auto_creation_webhook_filters, lambda e: e
),
"AutoCreation.StudioFlowSid": auto_creation_studio_flow_sid,
"AutoCreation.StudioRetryCount": auto_creation_studio_retry_count,
}
)
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 AddressConfigurationInstance(
self._version, payload, sid=self._solution["sid"]
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
) -> AddressConfigurationInstance:
"""
Asynchronous coroutine to update the AddressConfigurationInstance
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:returns: The updated AddressConfigurationInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"AutoCreation.Enabled": serialize.boolean_to_string(
auto_creation_enabled
),
"AutoCreation.Type": auto_creation_type,
"AutoCreation.ConversationServiceSid": auto_creation_conversation_service_sid,
"AutoCreation.WebhookUrl": auto_creation_webhook_url,
"AutoCreation.WebhookMethod": auto_creation_webhook_method,
"AutoCreation.WebhookFilters": serialize.map(
auto_creation_webhook_filters, lambda e: e
),
"AutoCreation.StudioFlowSid": auto_creation_studio_flow_sid,
"AutoCreation.StudioRetryCount": auto_creation_studio_retry_count,
}
)
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 AddressConfigurationInstance(
self._version, payload, sid=self._solution["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.Conversations.V1.AddressConfigurationContext {}>".format(
context
)
class AddressConfigurationPage(Page):
def get_instance(self, payload: Dict[str, Any]) -> AddressConfigurationInstance:
"""
Build an instance of AddressConfigurationInstance
:param payload: Payload response from the API
"""
return AddressConfigurationInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.AddressConfigurationPage>"
class AddressConfigurationList(ListResource):
def __init__(self, version: Version):
"""
Initialize the AddressConfigurationList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Configuration/Addresses"
def create(
self,
type: "AddressConfigurationInstance.Type",
address: str,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
address_country: Union[str, object] = values.unset,
) -> AddressConfigurationInstance:
"""
Create the AddressConfigurationInstance
:param type:
:param address: The unique address to be configured. The address can be a whatsapp address or phone number
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:param address_country: An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
:returns: The created AddressConfigurationInstance
"""
data = values.of(
{
"Type": type,
"Address": address,
"FriendlyName": friendly_name,
"AutoCreation.Enabled": serialize.boolean_to_string(
auto_creation_enabled
),
"AutoCreation.Type": auto_creation_type,
"AutoCreation.ConversationServiceSid": auto_creation_conversation_service_sid,
"AutoCreation.WebhookUrl": auto_creation_webhook_url,
"AutoCreation.WebhookMethod": auto_creation_webhook_method,
"AutoCreation.WebhookFilters": serialize.map(
auto_creation_webhook_filters, lambda e: e
),
"AutoCreation.StudioFlowSid": auto_creation_studio_flow_sid,
"AutoCreation.StudioRetryCount": auto_creation_studio_retry_count,
"AddressCountry": address_country,
}
)
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 AddressConfigurationInstance(self._version, payload)
async def create_async(
self,
type: "AddressConfigurationInstance.Type",
address: str,
friendly_name: Union[str, object] = values.unset,
auto_creation_enabled: Union[bool, object] = values.unset,
auto_creation_type: Union[
"AddressConfigurationInstance.AutoCreationType", object
] = values.unset,
auto_creation_conversation_service_sid: Union[str, object] = values.unset,
auto_creation_webhook_url: Union[str, object] = values.unset,
auto_creation_webhook_method: Union[
"AddressConfigurationInstance.Method", object
] = values.unset,
auto_creation_webhook_filters: Union[List[str], object] = values.unset,
auto_creation_studio_flow_sid: Union[str, object] = values.unset,
auto_creation_studio_retry_count: Union[int, object] = values.unset,
address_country: Union[str, object] = values.unset,
) -> AddressConfigurationInstance:
"""
Asynchronously create the AddressConfigurationInstance
:param type:
:param address: The unique address to be configured. The address can be a whatsapp address or phone number
:param friendly_name: The human-readable name of this configuration, limited to 256 characters. Optional.
:param auto_creation_enabled: Enable/Disable auto-creating conversations for messages to this address
:param auto_creation_type:
:param auto_creation_conversation_service_sid: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
:param auto_creation_webhook_url: For type `webhook`, the url for the webhook request.
:param auto_creation_webhook_method:
:param auto_creation_webhook_filters: The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`
:param auto_creation_studio_flow_sid: For type `studio`, the studio flow SID where the webhook should be sent to.
:param auto_creation_studio_retry_count: For type `studio`, number of times to retry the webhook request
:param address_country: An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
:returns: The created AddressConfigurationInstance
"""
data = values.of(
{
"Type": type,
"Address": address,
"FriendlyName": friendly_name,
"AutoCreation.Enabled": serialize.boolean_to_string(
auto_creation_enabled
),
"AutoCreation.Type": auto_creation_type,
"AutoCreation.ConversationServiceSid": auto_creation_conversation_service_sid,
"AutoCreation.WebhookUrl": auto_creation_webhook_url,
"AutoCreation.WebhookMethod": auto_creation_webhook_method,
"AutoCreation.WebhookFilters": serialize.map(
auto_creation_webhook_filters, lambda e: e
),
"AutoCreation.StudioFlowSid": auto_creation_studio_flow_sid,
"AutoCreation.StudioRetryCount": auto_creation_studio_retry_count,
"AddressCountry": address_country,
}
)
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 AddressConfigurationInstance(self._version, payload)
def stream(
self,
type: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[AddressConfigurationInstance]:
"""
Streams AddressConfigurationInstance 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 type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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(type=type, page_size=limits["page_size"])
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
type: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[AddressConfigurationInstance]:
"""
Asynchronously streams AddressConfigurationInstance 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 type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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(type=type, page_size=limits["page_size"])
return self._version.stream_async(page, limits["limit"])
def list(
self,
type: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[AddressConfigurationInstance]:
"""
Lists AddressConfigurationInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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(
type=type,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
type: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[AddressConfigurationInstance]:
"""
Asynchronously lists AddressConfigurationInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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(
type=type,
limit=limit,
page_size=page_size,
)
]
def page(
self,
type: 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,
) -> AddressConfigurationPage:
"""
Retrieve a single page of AddressConfigurationInstance records from the API.
Request is executed immediately
:param type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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 AddressConfigurationInstance
"""
data = values.of(
{
"Type": type,
"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 AddressConfigurationPage(self._version, response)
async def page_async(
self,
type: 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,
) -> AddressConfigurationPage:
"""
Asynchronously retrieve a single page of AddressConfigurationInstance records from the API.
Request is executed immediately
:param type: Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
: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 AddressConfigurationInstance
"""
data = values.of(
{
"Type": type,
"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 AddressConfigurationPage(self._version, response)
def get_page(self, target_url: str) -> AddressConfigurationPage:
"""
Retrieve a specific page of AddressConfigurationInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of AddressConfigurationInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return AddressConfigurationPage(self._version, response)
async def get_page_async(self, target_url: str) -> AddressConfigurationPage:
"""
Asynchronously retrieve a specific page of AddressConfigurationInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of AddressConfigurationInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return AddressConfigurationPage(self._version, response)
def get(self, sid: str) -> AddressConfigurationContext:
"""
Constructs a AddressConfigurationContext
:param sid: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
"""
return AddressConfigurationContext(self._version, sid=sid)
def __call__(self, sid: str) -> AddressConfigurationContext:
"""
Constructs a AddressConfigurationContext
:param sid: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
"""
return AddressConfigurationContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Conversations.V1.AddressConfigurationList>"
|