Class: Twilio::REST::Chat::V1::ServiceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Chat::V1::ServiceInstance
- Defined in:
- lib/twilio-ruby/rest/chat/v1/service.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The account_sid.
-
#channels ⇒ channels
Access the channels.
-
#consumption_report_interval ⇒ String
The consumption_report_interval.
-
#context ⇒ ServiceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date_created.
-
#date_updated ⇒ Time
The date_updated.
-
#default_channel_creator_role_sid ⇒ String
The default_channel_creator_role_sid.
-
#default_channel_role_sid ⇒ String
The default_channel_role_sid.
-
#default_service_role_sid ⇒ String
The default_service_role_sid.
-
#delete ⇒ Boolean
Deletes the ServiceInstance.
-
#fetch ⇒ ServiceInstance
Fetch a ServiceInstance.
-
#friendly_name ⇒ String
The friendly_name.
-
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
constructor
Initialize the ServiceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#limits ⇒ Hash
The limits.
-
#links ⇒ String
The links.
-
#notifications ⇒ Hash
The notifications.
-
#post_webhook_url ⇒ String
The post_webhook_url.
-
#pre_webhook_url ⇒ String
The pre_webhook_url.
-
#reachability_enabled ⇒ Boolean
The reachability_enabled.
-
#read_status_enabled ⇒ Boolean
The read_status_enabled.
-
#roles ⇒ roles
Access the roles.
-
#sid ⇒ String
The sid.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#typing_indicator_timeout ⇒ String
The typing_indicator_timeout.
-
#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_send_format: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_update_format: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_message_remove_format: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_add_format: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_destroy_format: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_channel_update_format: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_add_format: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_member_remove_format: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_sent_format: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_updated_format: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_message_removed_format: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_added_format: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_destroyed_format: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_channel_updated_format: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_added_format: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, webhooks_on_member_removed_format: :unset, limits_channel_members: :unset, limits_user_channels: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
-
#url ⇒ String
The url.
-
#users ⇒ users
Access the users.
-
#webhook_filters ⇒ String
The webhook_filters.
-
#webhook_method ⇒ String
The webhook_method.
-
#webhooks ⇒ Hash
The webhooks.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ ServiceInstance
Initialize the ServiceInstance
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 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 519 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'].to_i, '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
Returns The account_sid.
576 577 578 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 576 def account_sid @properties['account_sid'] end |
#channels ⇒ channels
Access the channels
907 908 909 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 907 def channels context.channels end |
#consumption_report_interval ⇒ String
Returns The consumption_report_interval.
636 637 638 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 636 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
558 559 560 561 562 563 564 565 566 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 558 def context unless @instance_context @instance_context = ServiceContext.new( @version, @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The date_created.
588 589 590 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 588 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date_updated.
594 595 596 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 594 def date_updated @properties['date_updated'] end |
#default_channel_creator_role_sid ⇒ String
Returns The default_channel_creator_role_sid.
612 613 614 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 612 def default_channel_creator_role_sid @properties['default_channel_creator_role_sid'] end |
#default_channel_role_sid ⇒ String
Returns The default_channel_role_sid.
606 607 608 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 606 def default_channel_role_sid @properties['default_channel_role_sid'] end |
#default_service_role_sid ⇒ String
Returns The default_service_role_sid.
600 601 602 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 600 def default_service_role_sid @properties['default_service_role_sid'] end |
#delete ⇒ Boolean
Deletes the ServiceInstance
704 705 706 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 704 def delete context.delete end |
#fetch ⇒ ServiceInstance
Fetch a ServiceInstance
697 698 699 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 697 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The friendly_name.
582 583 584 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 582 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
934 935 936 937 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 934 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.ServiceInstance #{values}>" end |
#limits ⇒ Hash
Returns The limits.
642 643 644 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 642 def limits @properties['limits'] end |
#links ⇒ String
Returns The links.
690 691 692 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 690 def links @properties['links'] end |
#notifications ⇒ Hash
Returns The notifications.
678 679 680 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 678 def notifications @properties['notifications'] end |
#post_webhook_url ⇒ String
Returns The post_webhook_url.
660 661 662 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 660 def post_webhook_url @properties['post_webhook_url'] end |
#pre_webhook_url ⇒ String
Returns The pre_webhook_url.
654 655 656 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 654 def pre_webhook_url @properties['pre_webhook_url'] end |
#reachability_enabled ⇒ Boolean
Returns The reachability_enabled.
624 625 626 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 624 def reachability_enabled @properties['reachability_enabled'] end |
#read_status_enabled ⇒ Boolean
Returns The read_status_enabled.
618 619 620 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 618 def read_status_enabled @properties['read_status_enabled'] end |
#roles ⇒ roles
Access the roles
914 915 916 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 914 def roles context.roles end |
#sid ⇒ String
Returns The sid.
570 571 572 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 570 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
927 928 929 930 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 927 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Chat.V1.ServiceInstance #{values}>" end |
#typing_indicator_timeout ⇒ String
Returns The typing_indicator_timeout.
630 631 632 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 630 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_send_format: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_update_format: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_message_remove_format: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_add_format: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_destroy_format: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_channel_update_format: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_add_format: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_member_remove_format: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_sent_format: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_updated_format: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_message_removed_format: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_added_format: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_destroyed_format: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_channel_updated_format: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_added_format: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, webhooks_on_member_removed_format: :unset, limits_channel_members: :unset, limits_user_channels: :unset) ⇒ ServiceInstance
Update the ServiceInstance
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 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 829 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_send_format: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_update_format: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_message_remove_format: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_add_format: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_destroy_format: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_channel_update_format: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_add_format: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_member_remove_format: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_sent_format: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_updated_format: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_message_removed_format: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_added_format: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_destroyed_format: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_channel_updated_format: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_added_format: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, webhooks_on_member_removed_format: :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_send_format: , webhooks_on_message_update_url: , webhooks_on_message_update_method: , webhooks_on_message_update_format: , webhooks_on_message_remove_url: , webhooks_on_message_remove_method: , webhooks_on_message_remove_format: , webhooks_on_channel_add_url: webhooks_on_channel_add_url, webhooks_on_channel_add_method: webhooks_on_channel_add_method, webhooks_on_channel_add_format: webhooks_on_channel_add_format, webhooks_on_channel_destroy_url: webhooks_on_channel_destroy_url, webhooks_on_channel_destroy_method: webhooks_on_channel_destroy_method, webhooks_on_channel_destroy_format: webhooks_on_channel_destroy_format, webhooks_on_channel_update_url: webhooks_on_channel_update_url, webhooks_on_channel_update_method: webhooks_on_channel_update_method, webhooks_on_channel_update_format: webhooks_on_channel_update_format, webhooks_on_member_add_url: webhooks_on_member_add_url, webhooks_on_member_add_method: webhooks_on_member_add_method, webhooks_on_member_add_format: webhooks_on_member_add_format, webhooks_on_member_remove_url: webhooks_on_member_remove_url, webhooks_on_member_remove_method: webhooks_on_member_remove_method, webhooks_on_member_remove_format: webhooks_on_member_remove_format, webhooks_on_message_sent_url: , webhooks_on_message_sent_method: , webhooks_on_message_sent_format: , webhooks_on_message_updated_url: , webhooks_on_message_updated_method: , webhooks_on_message_updated_format: , webhooks_on_message_removed_url: , webhooks_on_message_removed_method: , webhooks_on_message_removed_format: , webhooks_on_channel_added_url: webhooks_on_channel_added_url, webhooks_on_channel_added_method: webhooks_on_channel_added_method, webhooks_on_channel_added_format: webhooks_on_channel_added_format, webhooks_on_channel_destroyed_url: webhooks_on_channel_destroyed_url, webhooks_on_channel_destroyed_method: webhooks_on_channel_destroyed_method, webhooks_on_channel_destroyed_format: webhooks_on_channel_destroyed_format, webhooks_on_channel_updated_url: webhooks_on_channel_updated_url, webhooks_on_channel_updated_method: webhooks_on_channel_updated_method, webhooks_on_channel_updated_format: webhooks_on_channel_updated_format, webhooks_on_member_added_url: webhooks_on_member_added_url, webhooks_on_member_added_method: webhooks_on_member_added_method, webhooks_on_member_added_format: webhooks_on_member_added_format, webhooks_on_member_removed_url: webhooks_on_member_removed_url, webhooks_on_member_removed_method: webhooks_on_member_removed_method, webhooks_on_member_removed_format: webhooks_on_member_removed_format, limits_channel_members: limits_channel_members, limits_user_channels: limits_user_channels, ) end |
#url ⇒ String
Returns The url.
684 685 686 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 684 def url @properties['url'] end |
#users ⇒ users
Access the users
921 922 923 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 921 def users context.users end |
#webhook_filters ⇒ String
Returns The webhook_filters.
672 673 674 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 672 def webhook_filters @properties['webhook_filters'] end |
#webhook_method ⇒ String
Returns The webhook_method.
666 667 668 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 666 def webhook_method @properties['webhook_method'] end |
#webhooks ⇒ Hash
Returns The webhooks.
648 649 650 |
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 648 def webhooks @properties['webhooks'] end |