Class: Twilio::REST::IpMessaging::V1::ServiceInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::IpMessaging::V1::ServiceInstance
- Defined in:
- lib/twilio-ruby/rest/ip_messaging/v1/service.rb
Instance Method Summary collapse
- #account_sid ⇒ String
-
#channels ⇒ channels
Access the channels.
- #consumption_report_interval ⇒ String
-
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions.
- #date_created ⇒ Time
- #date_updated ⇒ Time
- #default_channel_creator_role_sid ⇒ String
- #default_channel_role_sid ⇒ String
- #default_service_role_sid ⇒ String
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
- #friendly_name ⇒ String
-
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
constructor
Initialize the ServiceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
- #limits ⇒ Hash
- #links ⇒ Hash
- #notifications ⇒ Hash
- #post_webhook_url ⇒ String
- #pre_webhook_url ⇒ String
- #reachability_enabled ⇒ Boolean
- #read_status_enabled ⇒ Boolean
-
#roles ⇒ roles
Access the roles.
- #sid ⇒ String
-
#to_s ⇒ Object
Provide a user friendly representation.
- #typing_indicator_timeout ⇒ String
-
#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
- #url ⇒ String
-
#users ⇒ users
Access the users.
- #webhook_filters ⇒ Array<String>
- #webhook_method ⇒ String
- #webhooks ⇒ Hash
Constructor Details
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
Initialize the ServiceInstance
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 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 474 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'friendly_name' => payload['friendly_name'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'default_service_role_sid' => payload['default_service_role_sid'], 'default_channel_role_sid' => payload['default_channel_role_sid'], 'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'], 'read_status_enabled' => payload['read_status_enabled'], 'reachability_enabled' => payload['reachability_enabled'], 'typing_indicator_timeout' => payload['typing_indicator_timeout'] == nil ? payload['typing_indicator_timeout'] : payload['typing_indicator_timeout'].to_i, 'consumption_report_interval' => payload['consumption_report_interval'] == nil ? payload['consumption_report_interval'] : payload['consumption_report_interval'].to_i, 'limits' => payload['limits'], 'webhooks' => payload['webhooks'], 'pre_webhook_url' => payload['pre_webhook_url'], 'post_webhook_url' => payload['post_webhook_url'], 'webhook_method' => payload['webhook_method'], 'webhook_filters' => payload['webhook_filters'], 'notifications' => payload['notifications'], 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
526 527 528 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 526 def account_sid @properties['account_sid'] end |
#channels ⇒ channels
Access the channels
835 836 837 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 835 def channels context.channels end |
#consumption_report_interval ⇒ String
586 587 588 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 586 def consumption_report_interval @properties['consumption_report_interval'] end |
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
511 512 513 514 515 516 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 511 def context unless @instance_context @instance_context = ServiceContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
538 539 540 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 538 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
544 545 546 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 544 def date_updated @properties['date_updated'] end |
#default_channel_creator_role_sid ⇒ String
562 563 564 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 562 def default_channel_creator_role_sid @properties['default_channel_creator_role_sid'] end |
#default_channel_role_sid ⇒ String
556 557 558 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 556 def default_channel_role_sid @properties['default_channel_role_sid'] end |
#default_service_role_sid ⇒ String
550 551 552 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 550 def default_service_role_sid @properties['default_service_role_sid'] end |
#delete ⇒ Boolean
Delete the ServiceInstance
647 648 649 650 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 647 def delete context.delete end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
655 656 657 658 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 655 def fetch context.fetch end |
#friendly_name ⇒ String
532 533 534 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 532 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
862 863 864 865 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 862 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ServiceInstance #{values}>" end |
#limits ⇒ Hash
592 593 594 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 592 def limits @properties['limits'] end |
#links ⇒ Hash
640 641 642 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 640 def links @properties['links'] end |
#notifications ⇒ Hash
628 629 630 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 628 def notifications @properties['notifications'] end |
#post_webhook_url ⇒ String
610 611 612 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 610 def post_webhook_url @properties['post_webhook_url'] end |
#pre_webhook_url ⇒ String
604 605 606 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 604 def pre_webhook_url @properties['pre_webhook_url'] end |
#reachability_enabled ⇒ Boolean
574 575 576 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 574 def reachability_enabled @properties['reachability_enabled'] end |
#read_status_enabled ⇒ Boolean
568 569 570 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 568 def read_status_enabled @properties['read_status_enabled'] end |
#roles ⇒ roles
Access the roles
842 843 844 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 842 def roles context.roles end |
#sid ⇒ String
520 521 522 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 520 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
855 856 857 858 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 855 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ServiceInstance #{values}>" end |
#typing_indicator_timeout ⇒ String
580 581 582 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 580 def typing_indicator_timeout @properties['typing_indicator_timeout'] end |
#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset) ⇒ ServiceInstance
Update the ServiceInstance
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 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 717 def update( friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset ) context.update( friendly_name: friendly_name, default_service_role_sid: default_service_role_sid, default_channel_role_sid: default_channel_role_sid, default_channel_creator_role_sid: default_channel_creator_role_sid, read_status_enabled: read_status_enabled, reachability_enabled: reachability_enabled, typing_indicator_timeout: typing_indicator_timeout, consumption_report_interval: consumption_report_interval, notifications_new_message_enabled: , notifications_new_message_template: , notifications_added_to_channel_enabled: notifications_added_to_channel_enabled, notifications_added_to_channel_template: notifications_added_to_channel_template, notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled, notifications_removed_from_channel_template: notifications_removed_from_channel_template, notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled, notifications_invited_to_channel_template: notifications_invited_to_channel_template, pre_webhook_url: pre_webhook_url, post_webhook_url: post_webhook_url, webhook_method: webhook_method, webhook_filters: webhook_filters, webhooks_on_message_send_url: , webhooks_on_message_send_method: , webhooks_on_message_update_url: , webhooks_on_message_update_method: , webhooks_on_message_remove_url: , webhooks_on_message_remove_method: , webhooks_on_channel_add_url: webhooks_on_channel_add_url, webhooks_on_channel_add_method: webhooks_on_channel_add_method, webhooks_on_channel_destroy_url: webhooks_on_channel_destroy_url, webhooks_on_channel_destroy_method: webhooks_on_channel_destroy_method, webhooks_on_channel_update_url: webhooks_on_channel_update_url, webhooks_on_channel_update_method: webhooks_on_channel_update_method, webhooks_on_member_add_url: webhooks_on_member_add_url, webhooks_on_member_add_method: webhooks_on_member_add_method, webhooks_on_member_remove_url: webhooks_on_member_remove_url, webhooks_on_member_remove_method: webhooks_on_member_remove_method, webhooks_on_message_sent_url: , webhooks_on_message_sent_method: , webhooks_on_message_updated_url: , webhooks_on_message_updated_method: , webhooks_on_message_removed_url: , webhooks_on_message_removed_method: , webhooks_on_channel_added_url: webhooks_on_channel_added_url, webhooks_on_channel_added_method: webhooks_on_channel_added_method, webhooks_on_channel_destroyed_url: webhooks_on_channel_destroyed_url, webhooks_on_channel_destroyed_method: webhooks_on_channel_destroyed_method, webhooks_on_channel_updated_url: webhooks_on_channel_updated_url, webhooks_on_channel_updated_method: webhooks_on_channel_updated_method, webhooks_on_member_added_url: webhooks_on_member_added_url, webhooks_on_member_added_method: webhooks_on_member_added_method, webhooks_on_member_removed_url: webhooks_on_member_removed_url, webhooks_on_member_removed_method: webhooks_on_member_removed_method, limits_channel_members: limits_channel_members, limits_user_channels: limits_user_channels, ) end |
#url ⇒ String
634 635 636 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 634 def url @properties['url'] end |
#users ⇒ users
Access the users
849 850 851 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 849 def users context.users end |
#webhook_filters ⇒ Array<String>
622 623 624 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 622 def webhook_filters @properties['webhook_filters'] end |
#webhook_method ⇒ String
616 617 618 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 616 def webhook_method @properties['webhook_method'] end |
#webhooks ⇒ Hash
598 599 600 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 598 def webhooks @properties['webhooks'] end |