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.



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

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) 


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

def 
    @properties['account_sid']
end

#channels ⇒ channels

Access the channels

Returns:



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

def channels
    context.channels
end

#consumption_report_interval ⇒ String

Returns:

  • (String) 


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

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:



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

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String

Returns:

  • (String) 


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

def default_channel_creator_role_sid
    @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String

Returns:

  • (String) 


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

def default_channel_role_sid
    @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String

Returns:

  • (String) 


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

def default_service_role_sid
    @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



664
665
666
667
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 664

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



871
872
873
874
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 871

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

#limits ⇒ Hash

Returns:

  • (Hash) 


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

def limits
    @properties['limits']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#notifications ⇒ Hash

Returns:

  • (Hash) 


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

def notifications
    @properties['notifications']
end

#post_webhook_url ⇒ String

Returns:

  • (String) 


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

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String

Returns:

  • (String) 


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

def pre_webhook_url
    @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def reachability_enabled
    @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean

Returns:

  • (Boolean) 


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

def read_status_enabled
    @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles

Returns:



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

def roles
    context.roles
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#typing_indicator_timeout ⇒ String

Returns:

  • (String) 


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

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:



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

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) 


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

def url
    @properties['url']
end

#users ⇒ users

Access the users

Returns:



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

def users
    context.users
end

#webhook_filters ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def webhook_filters
    @properties['webhook_filters']
end

#webhook_method ⇒ String

Returns:

  • (String) 


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

def webhook_method
    @properties['webhook_method']
end

#webhooks ⇒ Hash

Returns:

  • (Hash) 


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

def webhooks
    @properties['webhooks']
end