Class: Twilio::REST::Chat::V1::ServiceInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ServiceInstance



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
515
516
517
518
519
520
521
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 490

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 



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

def 
  @properties['account_sid']
end

#channels ⇒ channels

Access the channels



888
889
890
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 888

def channels
  context.channels
end

#consumption_report_interval ⇒ String 



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

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



527
528
529
530
531
532
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 527

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String 



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

def default_channel_creator_role_sid
  @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String 



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

def default_channel_role_sid
  @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String 



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

def default_service_role_sid
  @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Deletes the ServiceInstance



670
671
672
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 670

def delete
  context.delete
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance



663
664
665
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 663

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



915
916
917
918
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 915

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

#limits ⇒ Hash 



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

def limits
  @properties['limits']
end

#links ⇒ String 



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

def links
  @properties['links']
end

#notifications ⇒ Hash 



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

def notifications
  @properties['notifications']
end

#post_webhook_url ⇒ String 



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

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String 



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

def pre_webhook_url
  @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean 



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

def reachability_enabled
  @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean 



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

def read_status_enabled
  @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles



895
896
897
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 895

def roles
  context.roles
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



908
909
910
911
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 908

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

#typing_indicator_timeout ⇒ String 



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

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



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

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_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_send_format: webhooks_on_message_send_format,
      webhooks_on_message_update_url: webhooks_on_message_update_url,
      webhooks_on_message_update_method: webhooks_on_message_update_method,
      webhooks_on_message_update_format: webhooks_on_message_update_format,
      webhooks_on_message_remove_url: webhooks_on_message_remove_url,
      webhooks_on_message_remove_method: webhooks_on_message_remove_method,
      webhooks_on_message_remove_format: 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_url,
      webhooks_on_message_sent_method: webhooks_on_message_sent_method,
      webhooks_on_message_sent_format: webhooks_on_message_sent_format,
      webhooks_on_message_updated_url: webhooks_on_message_updated_url,
      webhooks_on_message_updated_method: webhooks_on_message_updated_method,
      webhooks_on_message_updated_format: webhooks_on_message_updated_format,
      webhooks_on_message_removed_url: webhooks_on_message_removed_url,
      webhooks_on_message_removed_method: webhooks_on_message_removed_method,
      webhooks_on_message_removed_format: 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 



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

def url
  @properties['url']
end

#users ⇒ users

Access the users



902
903
904
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 902

def users
  context.users
end

#webhook_filters ⇒ String 



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

def webhook_filters
  @properties['webhook_filters']
end

#webhook_method ⇒ String 



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

def webhook_method
  @properties['webhook_method']
end

#webhooks ⇒ Hash 



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

def webhooks
  @properties['webhooks']
end