Class: Twilio::REST::IpMessaging::V1::ServiceInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Service resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 475

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

Returns:

  • (String) 


527
528
529
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 527

def 
    @properties['account_sid']
end

#channels ⇒ channels

Access the channels

Returns:



836
837
838
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 836

def channels
    context.channels
end

#consumption_report_interval ⇒ String

Returns:

  • (String) 


587
588
589
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 587

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

Returns:



512
513
514
515
516
517
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 512

def context
    unless @instance_context
        @instance_context = ServiceContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns:

  • (Time) 


539
540
541
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 539

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


545
546
547
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 545

def date_updated
    @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String

Returns:

  • (String) 


563
564
565
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 563

def default_channel_creator_role_sid
    @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String

Returns:

  • (String) 


557
558
559
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 557

def default_channel_role_sid
    @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String

Returns:

  • (String) 


551
552
553
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 551

def default_service_role_sid
    @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



648
649
650
651
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 648

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



656
657
658
659
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 656

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


533
534
535
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 533

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



863
864
865
866
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 863

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V1.ServiceInstance #{values}>"
end

#limits ⇒ Hash

Returns:

  • (Hash) 


593
594
595
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 593

def limits
    @properties['limits']
end

#links ⇒ Hash

Returns:

  • (Hash) 


641
642
643
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 641

def links
    @properties['links']
end

#notifications ⇒ Hash

Returns:

  • (Hash) 


629
630
631
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 629

def notifications
    @properties['notifications']
end

#post_webhook_url ⇒ String

Returns:

  • (String) 


611
612
613
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 611

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String

Returns:

  • (String) 


605
606
607
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 605

def pre_webhook_url
    @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean

Returns:

  • (Boolean) 


575
576
577
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 575

def reachability_enabled
    @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean

Returns:

  • (Boolean) 


569
570
571
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 569

def read_status_enabled
    @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles

Returns:



843
844
845
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 843

def roles
    context.roles
end

#sid ⇒ String

Returns:

  • (String) 


521
522
523
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 521

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



856
857
858
859
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 856

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V1.ServiceInstance #{values}>"
end

#typing_indicator_timeout ⇒ String

Returns:

  • (String) 


581
582
583
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 581

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

Parameters:

  • friendly_name (String) (defaults to: :unset)
  • default_service_role_sid (String) (defaults to: :unset)
  • default_channel_role_sid (String) (defaults to: :unset)
  • default_channel_creator_role_sid (String) (defaults to: :unset)
  • read_status_enabled (Boolean) (defaults to: :unset)
  • reachability_enabled (Boolean) (defaults to: :unset)
  • typing_indicator_timeout (String) (defaults to: :unset)
  • consumption_report_interval (String) (defaults to: :unset)
  • notifications_new_message_enabled (Boolean) (defaults to: :unset)
  • notifications_new_message_template (String) (defaults to: :unset)
  • notifications_added_to_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_added_to_channel_template (String) (defaults to: :unset)
  • notifications_removed_from_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_removed_from_channel_template (String) (defaults to: :unset)
  • notifications_invited_to_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_invited_to_channel_template (String) (defaults to: :unset)
  • pre_webhook_url (String) (defaults to: :unset)
  • post_webhook_url (String) (defaults to: :unset)
  • webhook_method (String) (defaults to: :unset)
  • webhook_filters (Array[String]) (defaults to: :unset)
  • webhooks_on_message_send_url (String) (defaults to: :unset)
  • webhooks_on_message_send_method (String) (defaults to: :unset)
  • webhooks_on_message_update_url (String) (defaults to: :unset)
  • webhooks_on_message_update_method (String) (defaults to: :unset)
  • webhooks_on_message_remove_url (String) (defaults to: :unset)
  • webhooks_on_message_remove_method (String) (defaults to: :unset)
  • webhooks_on_channel_add_url (String) (defaults to: :unset)
  • webhooks_on_channel_add_method (String) (defaults to: :unset)
  • webhooks_on_channel_destroy_url (String) (defaults to: :unset)
  • webhooks_on_channel_destroy_method (String) (defaults to: :unset)
  • webhooks_on_channel_update_url (String) (defaults to: :unset)
  • webhooks_on_channel_update_method (String) (defaults to: :unset)
  • webhooks_on_member_add_url (String) (defaults to: :unset)
  • webhooks_on_member_add_method (String) (defaults to: :unset)
  • webhooks_on_member_remove_url (String) (defaults to: :unset)
  • webhooks_on_member_remove_method (String) (defaults to: :unset)
  • webhooks_on_message_sent_url (String) (defaults to: :unset)
  • webhooks_on_message_sent_method (String) (defaults to: :unset)
  • webhooks_on_message_updated_url (String) (defaults to: :unset)
  • webhooks_on_message_updated_method (String) (defaults to: :unset)
  • webhooks_on_message_removed_url (String) (defaults to: :unset)
  • webhooks_on_message_removed_method (String) (defaults to: :unset)
  • webhooks_on_channel_added_url (String) (defaults to: :unset)
  • webhooks_on_channel_added_method (String) (defaults to: :unset)
  • webhooks_on_channel_destroyed_url (String) (defaults to: :unset)
  • webhooks_on_channel_destroyed_method (String) (defaults to: :unset)
  • webhooks_on_channel_updated_url (String) (defaults to: :unset)
  • webhooks_on_channel_updated_method (String) (defaults to: :unset)
  • webhooks_on_member_added_url (String) (defaults to: :unset)
  • webhooks_on_member_added_method (String) (defaults to: :unset)
  • webhooks_on_member_removed_url (String) (defaults to: :unset)
  • webhooks_on_member_removed_method (String) (defaults to: :unset)
  • limits_channel_members (String) (defaults to: :unset)
  • limits_user_channels (String) (defaults to: :unset)

Returns:



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
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 718

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_enabled, 
        notifications_new_message_template: 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_url, 
        webhooks_on_message_send_method: webhooks_on_message_send_method, 
        webhooks_on_message_update_url: webhooks_on_message_update_url, 
        webhooks_on_message_update_method: webhooks_on_message_update_method, 
        webhooks_on_message_remove_url: webhooks_on_message_remove_url, 
        webhooks_on_message_remove_method: 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_url, 
        webhooks_on_message_sent_method: webhooks_on_message_sent_method, 
        webhooks_on_message_updated_url: webhooks_on_message_updated_url, 
        webhooks_on_message_updated_method: webhooks_on_message_updated_method, 
        webhooks_on_message_removed_url: webhooks_on_message_removed_url, 
        webhooks_on_message_removed_method: 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

Returns:

  • (String) 


635
636
637
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 635

def url
    @properties['url']
end

#users ⇒ users

Access the users

Returns:



850
851
852
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 850

def users
    context.users
end

#webhook_filters ⇒ Array<String>

Returns:

  • (Array<String>) 


623
624
625
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 623

def webhook_filters
    @properties['webhook_filters']
end

#webhook_method ⇒ String

Returns:

  • (String) 


617
618
619
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 617

def webhook_method
    @properties['webhook_method']
end

#webhooks ⇒ Hash

Returns:

  • (Hash) 


599
600
601
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 599

def webhooks
    @properties['webhooks']
end