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
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
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 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 473 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.
525 526 527 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 525 def account_sid @properties['account_sid'] end |
#channels ⇒ channels
Access the channels
856 857 858 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 856 def channels context.channels end |
#consumption_report_interval ⇒ String
Returns The consumption_report_interval.
585 586 587 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 585 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
510 511 512 513 514 515 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 510 def context unless @instance_context @instance_context = ServiceContext.new(@version, @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The date_created.
537 538 539 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 537 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date_updated.
543 544 545 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 543 def date_updated @properties['date_updated'] end |
#default_channel_creator_role_sid ⇒ String
Returns The default_channel_creator_role_sid.
561 562 563 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 561 def default_channel_creator_role_sid @properties['default_channel_creator_role_sid'] end |
#default_channel_role_sid ⇒ String
Returns The default_channel_role_sid.
555 556 557 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 555 def default_channel_role_sid @properties['default_channel_role_sid'] end |
#default_service_role_sid ⇒ String
Returns The default_service_role_sid.
549 550 551 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 549 def default_service_role_sid @properties['default_service_role_sid'] end |
#delete ⇒ Boolean
Deletes the ServiceInstance
653 654 655 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 653 def delete context.delete end |
#fetch ⇒ ServiceInstance
Fetch a ServiceInstance
646 647 648 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 646 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The friendly_name.
531 532 533 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 531 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
883 884 885 886 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 883 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ServiceInstance #{values}>" end |
#limits ⇒ Hash
Returns The limits.
591 592 593 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 591 def limits @properties['limits'] end |
#links ⇒ String
Returns The links.
639 640 641 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 639 def links @properties['links'] end |
#notifications ⇒ Hash
Returns The notifications.
627 628 629 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 627 def notifications @properties['notifications'] end |
#post_webhook_url ⇒ String
Returns The post_webhook_url.
609 610 611 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 609 def post_webhook_url @properties['post_webhook_url'] end |
#pre_webhook_url ⇒ String
Returns The pre_webhook_url.
603 604 605 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 603 def pre_webhook_url @properties['pre_webhook_url'] end |
#reachability_enabled ⇒ Boolean
Returns The reachability_enabled.
573 574 575 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 573 def reachability_enabled @properties['reachability_enabled'] end |
#read_status_enabled ⇒ Boolean
Returns The read_status_enabled.
567 568 569 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 567 def read_status_enabled @properties['read_status_enabled'] end |
#roles ⇒ roles
Access the roles
863 864 865 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 863 def roles context.roles end |
#sid ⇒ String
Returns The sid.
519 520 521 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 519 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
876 877 878 879 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 876 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.IpMessaging.V1.ServiceInstance #{values}>" end |
#typing_indicator_timeout ⇒ String
Returns The typing_indicator_timeout.
579 580 581 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 579 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
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 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 778 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.
633 634 635 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 633 def url @properties['url'] end |
#users ⇒ users
Access the users
870 871 872 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 870 def users context.users end |
#webhook_filters ⇒ String
Returns The webhook_filters.
621 622 623 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 621 def webhook_filters @properties['webhook_filters'] end |
#webhook_method ⇒ String
Returns The webhook_method.
615 616 617 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 615 def webhook_method @properties['webhook_method'] end |
#webhooks ⇒ Hash
Returns The webhooks.
597 598 599 |
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 597 def webhooks @properties['webhooks'] end |