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 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Notify
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.notify.v1.service.binding import BindingList
from twilio.rest.notify.v1.service.notification import NotificationList
class ServiceInstance(InstanceResource):
"""
:ivar sid: The unique string that we created to identify the Service resource.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
:ivar friendly_name: The string that you assigned to describe the resource.
:ivar date_created: The date and time in GMT when 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 when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:ivar gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:ivar fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:ivar messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.
:ivar facebook_messenger_page_id: Deprecated.
:ivar default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:ivar default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:ivar default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:ivar log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:ivar url: The absolute URL of the Service resource.
:ivar links: The URLs of the Binding, Notification, Segment, and User resources related to the service.
:ivar alexa_skill_id: Deprecated.
:ivar default_alexa_notification_protocol_version: Deprecated.
:ivar delivery_callback_url: URL to send delivery status callback.
:ivar delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
"""
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.friendly_name: Optional[str] = payload.get("friendly_name")
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.apn_credential_sid: Optional[str] = payload.get("apn_credential_sid")
self.gcm_credential_sid: Optional[str] = payload.get("gcm_credential_sid")
self.fcm_credential_sid: Optional[str] = payload.get("fcm_credential_sid")
self.messaging_service_sid: Optional[str] = payload.get("messaging_service_sid")
self.facebook_messenger_page_id: Optional[str] = payload.get(
"facebook_messenger_page_id"
)
self.default_apn_notification_protocol_version: Optional[str] = payload.get(
"default_apn_notification_protocol_version"
)
self.default_gcm_notification_protocol_version: Optional[str] = payload.get(
"default_gcm_notification_protocol_version"
)
self.default_fcm_notification_protocol_version: Optional[str] = payload.get(
"default_fcm_notification_protocol_version"
)
self.log_enabled: Optional[bool] = payload.get("log_enabled")
self.url: Optional[str] = payload.get("url")
self.links: Optional[Dict[str, object]] = payload.get("links")
self.alexa_skill_id: Optional[str] = payload.get("alexa_skill_id")
self.default_alexa_notification_protocol_version: Optional[str] = payload.get(
"default_alexa_notification_protocol_version"
)
self.delivery_callback_url: Optional[str] = payload.get("delivery_callback_url")
self.delivery_callback_enabled: Optional[bool] = payload.get(
"delivery_callback_enabled"
)
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[ServiceContext] = None
@property
def _proxy(self) -> "ServiceContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: ServiceContext for this ServiceInstance
"""
if self._context is None:
self._context = ServiceContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the ServiceInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the ServiceInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "ServiceInstance":
"""
Fetch the ServiceInstance
:returns: The fetched ServiceInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "ServiceInstance":
"""
Asynchronous coroutine to fetch the ServiceInstance
:returns: The fetched ServiceInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> "ServiceInstance":
"""
Update the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The updated ServiceInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
apn_credential_sid=apn_credential_sid,
gcm_credential_sid=gcm_credential_sid,
messaging_service_sid=messaging_service_sid,
facebook_messenger_page_id=facebook_messenger_page_id,
default_apn_notification_protocol_version=default_apn_notification_protocol_version,
default_gcm_notification_protocol_version=default_gcm_notification_protocol_version,
fcm_credential_sid=fcm_credential_sid,
default_fcm_notification_protocol_version=default_fcm_notification_protocol_version,
log_enabled=log_enabled,
alexa_skill_id=alexa_skill_id,
default_alexa_notification_protocol_version=default_alexa_notification_protocol_version,
delivery_callback_url=delivery_callback_url,
delivery_callback_enabled=delivery_callback_enabled,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> "ServiceInstance":
"""
Asynchronous coroutine to update the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The updated ServiceInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
apn_credential_sid=apn_credential_sid,
gcm_credential_sid=gcm_credential_sid,
messaging_service_sid=messaging_service_sid,
facebook_messenger_page_id=facebook_messenger_page_id,
default_apn_notification_protocol_version=default_apn_notification_protocol_version,
default_gcm_notification_protocol_version=default_gcm_notification_protocol_version,
fcm_credential_sid=fcm_credential_sid,
default_fcm_notification_protocol_version=default_fcm_notification_protocol_version,
log_enabled=log_enabled,
alexa_skill_id=alexa_skill_id,
default_alexa_notification_protocol_version=default_alexa_notification_protocol_version,
delivery_callback_url=delivery_callback_url,
delivery_callback_enabled=delivery_callback_enabled,
)
@property
def bindings(self) -> BindingList:
"""
Access the bindings
"""
return self._proxy.bindings
@property
def notifications(self) -> NotificationList:
"""
Access the notifications
"""
return self._proxy.notifications
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.Notify.V1.ServiceInstance {}>".format(context)
class ServiceContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the ServiceContext
:param version: Version that contains the resource
:param sid: The Twilio-provided string that uniquely identifies the Service resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Services/{sid}".format(**self._solution)
self._bindings: Optional[BindingList] = None
self._notifications: Optional[NotificationList] = None
def delete(self) -> bool:
"""
Deletes the ServiceInstance
: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 ServiceInstance
: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) -> ServiceInstance:
"""
Fetch the ServiceInstance
:returns: The fetched ServiceInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return ServiceInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> ServiceInstance:
"""
Asynchronous coroutine to fetch the ServiceInstance
:returns: The fetched ServiceInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return ServiceInstance(
self._version,
payload,
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> ServiceInstance:
"""
Update the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The updated ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"ApnCredentialSid": apn_credential_sid,
"GcmCredentialSid": gcm_credential_sid,
"MessagingServiceSid": messaging_service_sid,
"FacebookMessengerPageId": facebook_messenger_page_id,
"DefaultApnNotificationProtocolVersion": default_apn_notification_protocol_version,
"DefaultGcmNotificationProtocolVersion": default_gcm_notification_protocol_version,
"FcmCredentialSid": fcm_credential_sid,
"DefaultFcmNotificationProtocolVersion": default_fcm_notification_protocol_version,
"LogEnabled": serialize.boolean_to_string(log_enabled),
"AlexaSkillId": alexa_skill_id,
"DefaultAlexaNotificationProtocolVersion": default_alexa_notification_protocol_version,
"DeliveryCallbackUrl": delivery_callback_url,
"DeliveryCallbackEnabled": serialize.boolean_to_string(
delivery_callback_enabled
),
}
)
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 ServiceInstance(self._version, payload, sid=self._solution["sid"])
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> ServiceInstance:
"""
Asynchronous coroutine to update the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The updated ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"ApnCredentialSid": apn_credential_sid,
"GcmCredentialSid": gcm_credential_sid,
"MessagingServiceSid": messaging_service_sid,
"FacebookMessengerPageId": facebook_messenger_page_id,
"DefaultApnNotificationProtocolVersion": default_apn_notification_protocol_version,
"DefaultGcmNotificationProtocolVersion": default_gcm_notification_protocol_version,
"FcmCredentialSid": fcm_credential_sid,
"DefaultFcmNotificationProtocolVersion": default_fcm_notification_protocol_version,
"LogEnabled": serialize.boolean_to_string(log_enabled),
"AlexaSkillId": alexa_skill_id,
"DefaultAlexaNotificationProtocolVersion": default_alexa_notification_protocol_version,
"DeliveryCallbackUrl": delivery_callback_url,
"DeliveryCallbackEnabled": serialize.boolean_to_string(
delivery_callback_enabled
),
}
)
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 ServiceInstance(self._version, payload, sid=self._solution["sid"])
@property
def bindings(self) -> BindingList:
"""
Access the bindings
"""
if self._bindings is None:
self._bindings = BindingList(
self._version,
self._solution["sid"],
)
return self._bindings
@property
def notifications(self) -> NotificationList:
"""
Access the notifications
"""
if self._notifications is None:
self._notifications = NotificationList(
self._version,
self._solution["sid"],
)
return self._notifications
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.Notify.V1.ServiceContext {}>".format(context)
class ServicePage(Page):
def get_instance(self, payload: Dict[str, Any]) -> ServiceInstance:
"""
Build an instance of ServiceInstance
:param payload: Payload response from the API
"""
return ServiceInstance(self._version, payload)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Notify.V1.ServicePage>"
class ServiceList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ServiceList
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/Services"
def create(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> ServiceInstance:
"""
Create the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The created ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"ApnCredentialSid": apn_credential_sid,
"GcmCredentialSid": gcm_credential_sid,
"MessagingServiceSid": messaging_service_sid,
"FacebookMessengerPageId": facebook_messenger_page_id,
"DefaultApnNotificationProtocolVersion": default_apn_notification_protocol_version,
"DefaultGcmNotificationProtocolVersion": default_gcm_notification_protocol_version,
"FcmCredentialSid": fcm_credential_sid,
"DefaultFcmNotificationProtocolVersion": default_fcm_notification_protocol_version,
"LogEnabled": serialize.boolean_to_string(log_enabled),
"AlexaSkillId": alexa_skill_id,
"DefaultAlexaNotificationProtocolVersion": default_alexa_notification_protocol_version,
"DeliveryCallbackUrl": delivery_callback_url,
"DeliveryCallbackEnabled": serialize.boolean_to_string(
delivery_callback_enabled
),
}
)
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 ServiceInstance(self._version, payload)
async def create_async(
self,
friendly_name: Union[str, object] = values.unset,
apn_credential_sid: Union[str, object] = values.unset,
gcm_credential_sid: Union[str, object] = values.unset,
messaging_service_sid: Union[str, object] = values.unset,
facebook_messenger_page_id: Union[str, object] = values.unset,
default_apn_notification_protocol_version: Union[str, object] = values.unset,
default_gcm_notification_protocol_version: Union[str, object] = values.unset,
fcm_credential_sid: Union[str, object] = values.unset,
default_fcm_notification_protocol_version: Union[str, object] = values.unset,
log_enabled: Union[bool, object] = values.unset,
alexa_skill_id: Union[str, object] = values.unset,
default_alexa_notification_protocol_version: Union[str, object] = values.unset,
delivery_callback_url: Union[str, object] = values.unset,
delivery_callback_enabled: Union[bool, object] = values.unset,
) -> ServiceInstance:
"""
Asynchronously create the ServiceInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param apn_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.
:param gcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.
:param messaging_service_sid: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/quickstart#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.
:param facebook_messenger_page_id: Deprecated.
:param default_apn_notification_protocol_version: The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param default_gcm_notification_protocol_version: The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param fcm_credential_sid: The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.
:param default_fcm_notification_protocol_version: The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.
:param log_enabled: Whether to log notifications. Can be: `true` or `false` and the default is `true`.
:param alexa_skill_id: Deprecated.
:param default_alexa_notification_protocol_version: Deprecated.
:param delivery_callback_url: URL to send delivery status callback.
:param delivery_callback_enabled: Callback configuration that enables delivery callbacks, default false
:returns: The created ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"ApnCredentialSid": apn_credential_sid,
"GcmCredentialSid": gcm_credential_sid,
"MessagingServiceSid": messaging_service_sid,
"FacebookMessengerPageId": facebook_messenger_page_id,
"DefaultApnNotificationProtocolVersion": default_apn_notification_protocol_version,
"DefaultGcmNotificationProtocolVersion": default_gcm_notification_protocol_version,
"FcmCredentialSid": fcm_credential_sid,
"DefaultFcmNotificationProtocolVersion": default_fcm_notification_protocol_version,
"LogEnabled": serialize.boolean_to_string(log_enabled),
"AlexaSkillId": alexa_skill_id,
"DefaultAlexaNotificationProtocolVersion": default_alexa_notification_protocol_version,
"DeliveryCallbackUrl": delivery_callback_url,
"DeliveryCallbackEnabled": serialize.boolean_to_string(
delivery_callback_enabled
),
}
)
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 ServiceInstance(self._version, payload)
def stream(
self,
friendly_name: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> Iterator[ServiceInstance]:
"""
Streams ServiceInstance 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 friendly_name: The string that identifies the Service 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(friendly_name=friendly_name, page_size=limits["page_size"])
return self._version.stream(page, limits["limit"])
async def stream_async(
self,
friendly_name: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> AsyncIterator[ServiceInstance]:
"""
Asynchronously streams ServiceInstance 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 friendly_name: The string that identifies the Service 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(
friendly_name=friendly_name, page_size=limits["page_size"]
)
return self._version.stream_async(page, limits["limit"])
def list(
self,
friendly_name: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[ServiceInstance]:
"""
Lists ServiceInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str friendly_name: The string that identifies the Service 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(
friendly_name=friendly_name,
limit=limit,
page_size=page_size,
)
)
async def list_async(
self,
friendly_name: Union[str, object] = values.unset,
limit: Optional[int] = None,
page_size: Optional[int] = None,
) -> List[ServiceInstance]:
"""
Asynchronously lists ServiceInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param str friendly_name: The string that identifies the Service 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(
friendly_name=friendly_name,
limit=limit,
page_size=page_size,
)
]
def page(
self,
friendly_name: 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,
) -> ServicePage:
"""
Retrieve a single page of ServiceInstance records from the API.
Request is executed immediately
:param friendly_name: The string that identifies the Service 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 ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"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 ServicePage(self._version, response)
async def page_async(
self,
friendly_name: 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,
) -> ServicePage:
"""
Asynchronously retrieve a single page of ServiceInstance records from the API.
Request is executed immediately
:param friendly_name: The string that identifies the Service 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 ServiceInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"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 ServicePage(self._version, response)
def get_page(self, target_url: str) -> ServicePage:
"""
Retrieve a specific page of ServiceInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of ServiceInstance
"""
response = self._version.domain.twilio.request("GET", target_url)
return ServicePage(self._version, response)
async def get_page_async(self, target_url: str) -> ServicePage:
"""
Asynchronously retrieve a specific page of ServiceInstance records from the API.
Request is executed immediately
:param target_url: API-generated URL for the requested results page
:returns: Page of ServiceInstance
"""
response = await self._version.domain.twilio.request_async("GET", target_url)
return ServicePage(self._version, response)
def get(self, sid: str) -> ServiceContext:
"""
Constructs a ServiceContext
:param sid: The Twilio-provided string that uniquely identifies the Service resource to update.
"""
return ServiceContext(self._version, sid=sid)
def __call__(self, sid: str) -> ServiceContext:
"""
Constructs a ServiceContext
:param sid: The Twilio-provided string that uniquely identifies the Service resource to update.
"""
return ServiceContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Notify.V1.ServiceList>"
|