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

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the Service resource to fetch.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#channelschannels

Access the channels

Returns:


869
870
871
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 869

def channels
  context.channels
end

#consumption_report_intervalString

Returns DEPRECATED.

Returns:

  • (String)

    DEPRECATED


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

def consumption_report_interval
  @properties['consumption_report_interval']
end

#contextServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


514
515
516
517
518
519
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 514

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

#date_createdTime

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#default_channel_creator_role_sidString

Returns The channel role assigned to a channel creator when they join a new channel.

Returns:

  • (String)

    The channel role assigned to a channel creator when they join a new channel


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

def default_channel_creator_role_sid
  @properties['default_channel_creator_role_sid']
end

#default_channel_role_sidString

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


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

def default_channel_role_sid
  @properties['default_channel_role_sid']
end

#default_service_role_sidString

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


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

def default_service_role_sid
  @properties['default_service_role_sid']
end

#deleteBoolean

Delete the ServiceInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchServiceInstance

Fetch the ServiceInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#limitsHash

Returns An object that describes the limits of the service instance.

Returns:

  • (Hash)

    An object that describes the limits of the service instance


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

def limits
  @properties['limits']
end

Returns The absolute URLs of the Service's Channels, Roles, and Users.

Returns:

  • (String)

    The absolute URLs of the Service's Channels, Roles, and Users


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

def links
  @properties['links']
end

#notificationsHash

Returns The notification configuration for the Service instance.

Returns:

  • (Hash)

    The notification configuration for the Service instance


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

def notifications
  @properties['notifications']
end

#post_webhook_urlString

Returns The URL for post-event webhooks.

Returns:

  • (String)

    The URL for post-event webhooks


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

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_urlString

Returns The webhook URL for pre-event webhooks.

Returns:

  • (String)

    The webhook URL for pre-event webhooks


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

def pre_webhook_url
  @properties['pre_webhook_url']
end

#reachability_enabledBoolean

Returns Whether the Reachability Indicator feature is enabled for this Service instance.

Returns:

  • (Boolean)

    Whether the Reachability Indicator feature is enabled for this Service instance


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

def reachability_enabled
  @properties['reachability_enabled']
end

#read_status_enabledBoolean

Returns Whether the Message Consumption Horizon feature is enabled.

Returns:

  • (Boolean)

    Whether the Message Consumption Horizon feature is enabled


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

def read_status_enabled
  @properties['read_status_enabled']
end

#rolesroles

Access the roles

Returns:


876
877
878
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 876

def roles
  context.roles
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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

#typing_indicator_timeoutString

Returns How long in seconds to wait before assuming the user is no longer typing.

Returns:

  • (String)

    How long in seconds to wait before assuming the user is no longer typing


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

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)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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

    The service role assigned to users when they are added to the service. See the Roles endpoint for more details.

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

    The channel role assigned to users when they are added to a channel. See the Roles endpoint for more details.

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

    The channel role assigned to a channel creator when they join a new channel. See the Roles endpoint for more details.

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

    Whether to enable the Message Consumption Horizon feature. The default is `true`.

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

    Whether to enable the Reachability Indicator for this Service instance. The default is `false`.

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

    How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.

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

    DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.

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

    Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.

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

    The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.

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

    Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.

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

    The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.

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

    Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.

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

    The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.

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

    Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.

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

    The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.

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

    The URL for pre-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details.

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

    The URL for post-event webhooks, which are called by using the `webhook_method`. See Webhook Events for more details.

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

    The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See Webhook Events for more details.

  • webhook_filters (Array[String]) (defaults to: :unset)

    The list of WebHook events that are enabled for this Service instance. See Webhook Events for more details.

  • webhooks_on_message_send_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.

  • webhooks_on_message_send_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_message_send.url`.

  • webhooks_on_message_update_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.

  • webhooks_on_message_update_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_message_update.url`.

  • webhooks_on_message_remove_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.

  • webhooks_on_message_remove_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_message_remove.url`.

  • webhooks_on_channel_add_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.

  • webhooks_on_channel_add_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_add.url`.

  • webhooks_on_channel_destroy_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.

  • webhooks_on_channel_destroy_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.

  • webhooks_on_channel_update_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.

  • webhooks_on_channel_update_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_update.url`.

  • webhooks_on_member_add_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.

  • webhooks_on_member_add_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_member_add.url`.

  • webhooks_on_member_remove_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.

  • webhooks_on_member_remove_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_member_remove.url`.

  • webhooks_on_message_sent_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.

  • webhooks_on_message_sent_method (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_sent` event`.

  • webhooks_on_message_updated_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.

  • webhooks_on_message_updated_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_message_updated.url`.

  • webhooks_on_message_removed_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.

  • webhooks_on_message_removed_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_message_removed.url`.

  • webhooks_on_channel_added_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.

  • webhooks_on_channel_added_method (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_added` event`.

  • webhooks_on_channel_destroyed_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.

  • webhooks_on_channel_destroyed_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.

  • webhooks_on_channel_updated_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.

  • webhooks_on_channel_updated_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_updated.url`.

  • webhooks_on_member_added_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.

  • webhooks_on_member_added_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_channel_updated.url`.

  • webhooks_on_member_removed_url (String) (defaults to: :unset)

    The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.

  • webhooks_on_member_removed_method (String) (defaults to: :unset)

    The HTTP method to use when calling the `webhooks.on_member_removed.url`.

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

    The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.

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

    The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.

Returns:


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
852
853
854
855
856
857
858
859
860
861
862
863
864
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 807

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

#urlString

Returns The absolute URL of the Service resource.

Returns:

  • (String)

    The absolute URL of the Service resource


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

def url
  @properties['url']
end

#usersusers

Access the users

Returns:


883
884
885
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 883

def users
  context.users
end

#webhook_filtersArray[String]

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

Returns:

  • (Array[String])

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


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

def webhook_filters
  @properties['webhook_filters']
end

#webhook_methodString

Returns The HTTP method to use for both PRE and POST webhooks.

Returns:

  • (String)

    The HTTP method to use for both PRE and POST webhooks


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

def webhook_method
  @properties['webhook_method']
end

#webhooksHash

Returns An object that contains information about the webhooks configured for this service.

Returns:

  • (Hash)

    An object that contains information about the webhooks configured for this service


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

def webhooks
  @properties['webhooks']
end