Class: Twilio::REST::Chat::V2::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v2/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

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

    The sid



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 402

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'],
      'pre_webhook_url' => payload['pre_webhook_url'],
      'post_webhook_url' => payload['post_webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'webhook_filters' => payload['webhook_filters'],
      'pre_webhook_retry_count' => payload['pre_webhook_retry_count'].to_i,
      'post_webhook_retry_count' => payload['post_webhook_retry_count'].to_i,
      'notifications' => payload['notifications'],
      'media' => payload['media'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this service.

Returns:

  • (String) —

    The unique id of the Account responsible for this service.



456
457
458
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 456

def 
  @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



728
729
730
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 728

def bindings
  context.bindings
end

#channels ⇒ channels

Access the channels

Returns:



707
708
709
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 707

def channels
  context.channels
end

#consumption_report_interval ⇒ String

Returns DEPRECATED.

Returns:

  • (String) —

    DEPRECATED.



516
517
518
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 516

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:



441
442
443
444
445
446
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 441

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created



468
469
470
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 468

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated



474
475
476
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 474

def date_updated
  @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String

Returns The channel role assigned to a channel creator when joining a new channel.

Returns:

  • (String) —

    The channel role assigned to a channel creator when joining a new channel.



492
493
494
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 492

def default_channel_creator_role_sid
  @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String

Returns The channel role assigned to users when they are added to a channel.

Returns:

  • (String) —

    The channel role assigned to users when they are added to a channel.



486
487
488
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 486

def default_channel_role_sid
  @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String

Returns The service role assigned to users when they are added to the service.

Returns:

  • (String) —

    The service role assigned to users when they are added to the service.



480
481
482
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 480

def default_service_role_sid
  @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this service.

Returns:

  • (String) —

    The human-readable name of this service.



462
463
464
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 462

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



741
742
743
744
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 741

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

#limits ⇒ Hash

Returns Configuration for service instance level limits.

Returns:

  • (Hash) —

    Configuration for service instance level limits.



522
523
524
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 522

def limits
  @properties['limits']
end

#links ⇒ String

Returns URLs to access the Channels, Roles, and Users for this service.

Returns:

  • (String) —

    URLs to access the Channels, Roles, and Users for this service.



582
583
584
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 582

def links
  @properties['links']
end

#media ⇒ Hash

Returns The media.

Returns:

  • (Hash) —

    The media



570
571
572
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 570

def media
  @properties['media']
end

#notifications ⇒ Hash

Returns Notification configuration for the Service instance.

Returns:

  • (Hash) —

    Notification configuration for the Service instance.



564
565
566
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 564

def notifications
  @properties['notifications']
end

#post_webhook_retry_count ⇒ String

Returns Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.

Returns:

  • (String) —

    Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.



558
559
560
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 558

def post_webhook_retry_count
  @properties['post_webhook_retry_count']
end

#post_webhook_url ⇒ String

Returns The webhook URL for POST-Event webhooks.

Returns:

  • (String) —

    The webhook URL for POST-Event webhooks.



534
535
536
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 534

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_retry_count ⇒ String

Returns Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.

Returns:

  • (String) —

    Count of times webhook will be retried in case of timeout or 429/503/504 HTTP responses.



552
553
554
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 552

def pre_webhook_retry_count
  @properties['pre_webhook_retry_count']
end

#pre_webhook_url ⇒ String

Returns The webhook URL for PRE-Event webhooks.

Returns:

  • (String) —

    The webhook URL for PRE-Event webhooks.



528
529
530
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 528

def pre_webhook_url
  @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean

Returns Indicates whether the the Reachability feature is enabled for this Service instance.

Returns:

  • (Boolean) —

    Indicates whether the the Reachability feature is enabled for this Service instance.



504
505
506
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 504

def reachability_enabled
  @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean

Returns Enable the Message Consumption Horizon feature.

Returns:

  • (Boolean) —

    Enable the Message Consumption Horizon feature.



498
499
500
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 498

def read_status_enabled
  @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles

Returns:



714
715
716
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 714

def roles
  context.roles
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



450
451
452
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 450

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



734
735
736
737
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 734

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

#typing_indicator_timeout ⇒ String

Returns The amount of time in seconds after a “started typing” event when clients should assume that user is no longer typing, even if no “ended typing” message was received.

Returns:

  • (String) —

    The amount of time in seconds after a “started typing” event when clients should assume that user is no longer typing, even if no “ended typing” message was received.



510
511
512
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 510

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_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    Human-readable name for this service instance

  • default_service_role_sid (String) (defaults to: :unset) —

    The default_service_role_sid

  • default_channel_role_sid (String) (defaults to: :unset) —

    Channel role assigned on channel join (see [Roles](www.twilio.com/docs/chat/api/roles) data model for the details)

  • default_channel_creator_role_sid (String) (defaults to: :unset) —

    Channel role assigned to creator of channel when joining for first time

  • read_status_enabled (Boolean) (defaults to: :unset) —

    ‘true` if the member read status feature is enabled, `false` if not. Defaults to `true`.

  • reachability_enabled (Boolean) (defaults to: :unset) —

    ‘true` if the reachability feature should be enabled. Defaults to `false`

  • typing_indicator_timeout (String) (defaults to: :unset) —

    The duration in seconds indicating the timeout after “started typing” event when client should assume that user is not typing anymore even if no “ended typing” message received

  • consumption_report_interval (String) (defaults to: :unset) —

    The consumption_report_interval

  • notifications_new_message_enabled (Boolean) (defaults to: :unset) —

    The notifications.new_message.enabled

  • notifications_new_message_template (String) (defaults to: :unset) —

    The notifications.new_message.template

  • notifications_new_message_sound (String) (defaults to: :unset) —

    The notifications.new_message.sound

  • notifications_new_message_badge_count_enabled (Boolean) (defaults to: :unset) —

    The notifications.new_message.badge_count_enabled

  • notifications_added_to_channel_enabled (Boolean) (defaults to: :unset) —

    The notifications.added_to_channel.enabled

  • notifications_added_to_channel_template (String) (defaults to: :unset) —

    The notifications.added_to_channel.template

  • notifications_added_to_channel_sound (String) (defaults to: :unset) —

    The notifications.added_to_channel.sound

  • notifications_removed_from_channel_enabled (Boolean) (defaults to: :unset) —

    The notifications.removed_from_channel.enabled

  • notifications_removed_from_channel_template (String) (defaults to: :unset) —

    The notifications.removed_from_channel.template

  • notifications_removed_from_channel_sound (String) (defaults to: :unset) —

    The notifications.removed_from_channel.sound

  • notifications_invited_to_channel_enabled (Boolean) (defaults to: :unset) —

    The notifications.invited_to_channel.enabled

  • notifications_invited_to_channel_template (String) (defaults to: :unset) —

    The notifications.invited_to_channel.template

  • notifications_invited_to_channel_sound (String) (defaults to: :unset) —

    The notifications.invited_to_channel.sound

  • pre_webhook_url (String) (defaults to: :unset) —

    The webhook URL for PRE-Event webhooks. See [Webhook Events](www.twilio.com/docs/chat/webhook-events) for more details.

  • post_webhook_url (String) (defaults to: :unset) —

    The webhook URL for POST-Event webhooks. See [Webhook Events](www.twilio.com/docs/chat/webhook-events) for more details.

  • webhook_method (String) (defaults to: :unset) —

    The webhook request format to use. Must be POST or GET. See [Webhook Events](www.twilio.com/docs/chat/webhook-events) for more details.

  • webhook_filters (String) (defaults to: :unset) —

    The list of WebHook events that are enabled for this Service instance. See [Webhook Events](www.twilio.com/docs/chat/webhook-events) for more details.

  • limits_channel_members (String) (defaults to: :unset) —

    The maximum number of Members that can be added to Channels within this Service. The maximum allowed value is 1,000

  • limits_user_channels (String) (defaults to: :unset) —

    The maximum number of Channels Users can be a Member of within this Service. The maximum value allowed is 1,000

  • media_compatibility_message (String) (defaults to: :unset) —

    The media.compatibility_message

  • pre_webhook_retry_count (String) (defaults to: :unset) —

    Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

  • post_webhook_retry_count (String) (defaults to: :unset) —

    Count of times webhook will be retried in case of timeout (5 seconds) or 429/503/504 HTTP responses. Default retry count is 0 times.

  • notifications_log_enabled (Boolean) (defaults to: :unset) —

    The notifications.log_enabled

Returns:



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 668

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_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset, notifications_log_enabled: :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_new_message_sound: notifications_new_message_sound,
      notifications_new_message_badge_count_enabled: notifications_new_message_badge_count_enabled,
      notifications_added_to_channel_enabled: notifications_added_to_channel_enabled,
      notifications_added_to_channel_template: notifications_added_to_channel_template,
      notifications_added_to_channel_sound: notifications_added_to_channel_sound,
      notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled,
      notifications_removed_from_channel_template: notifications_removed_from_channel_template,
      notifications_removed_from_channel_sound: notifications_removed_from_channel_sound,
      notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled,
      notifications_invited_to_channel_template: notifications_invited_to_channel_template,
      notifications_invited_to_channel_sound: notifications_invited_to_channel_sound,
      pre_webhook_url: pre_webhook_url,
      post_webhook_url: post_webhook_url,
      webhook_method: webhook_method,
      webhook_filters: webhook_filters,
      limits_channel_members: limits_channel_members,
      limits_user_channels: limits_user_channels,
      media_compatibility_message: media_compatibility_message,
      pre_webhook_retry_count: pre_webhook_retry_count,
      post_webhook_retry_count: post_webhook_retry_count,
      notifications_log_enabled: notifications_log_enabled,
  )
end

#url ⇒ String

Returns An absolute URL for this service.

Returns:

  • (String) —

    An absolute URL for this service.



576
577
578
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 576

def url
  @properties['url']
end

#users ⇒ users

Access the users

Returns:



721
722
723
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 721

def users
  context.users
end

#webhook_filters ⇒ String

Returns The list of WebHook events that are enabled for this Service instance.

Returns:

  • (String) —

    The list of WebHook events that are enabled for this Service instance.



546
547
548
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 546

def webhook_filters
  @properties['webhook_filters']
end

#webhook_method ⇒ String

Returns The webhook request format to use for both PRE and POST webhooks.

Returns:

  • (String) —

    The webhook request format to use for both PRE and POST webhooks.



540
541
542
 
# File 'lib/twilio-ruby/rest/chat/v2/service.rb', line 540

def webhook_method
  @properties['webhook_method']
end