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

  • 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.



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 899

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 The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Service resource.

Returns:



952
953
954
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 952

def 
    @properties['account_sid']
end

#channels ⇒ channels

Access the channels

Returns:



1261
1262
1263
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1261

def channels
    context.channels
end

#consumption_report_interval ⇒ String

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

Returns:

  • (String) —

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



1012
1013
1014
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1012

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:



937
938
939
940
941
942
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 937

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



964
965
966
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 964

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



970
971
972
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 970

def date_updated
    @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String

Returns The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](www.twilio.com/docs/chat/api/roles) for more details.

Returns:

  • (String) —

    The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](www.twilio.com/docs/chat/api/roles) for more details.



988
989
990
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 988

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. See the [Roles endpoint](www.twilio.com/docs/chat/api/roles) for more details.

Returns:



982
983
984
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 982

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. See the [Roles endpoint](www.twilio.com/docs/chat/api/roles) for more details.

Returns:



976
977
978
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 976

def default_service_role_sid
    @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



1073
1074
1075
1076
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1073

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



1081
1082
1083
1084
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1081

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



958
959
960
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 958

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



1288
1289
1290
1291
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1288

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

#limits ⇒ Hash

Returns An object that describes the limits of the service instance. The limits object contains channel_members to describe the members/channel limit and user_channels to describe the channels/user limit. channel_members can be 1,000 or less, with a default of 250. user_channels can be 1,000 or less, with a default value of 100.

Returns:

  • (Hash) —

    An object that describes the limits of the service instance. The limits object contains channel_members to describe the members/channel limit and user_channels to describe the channels/user limit. channel_members can be 1,000 or less, with a default of 250. user_channels can be 1,000 or less, with a default value of 100.



1018
1019
1020
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1018

def limits
    @properties['limits']
end

#links ⇒ Hash

Returns The absolute URLs of the Service’s [Channels](www.twilio.com/docs/chat/api/channels), [Roles](www.twilio.com/docs/chat/api/roles), and [Users](www.twilio.com/docs/chat/api/users).

Returns:



1066
1067
1068
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1066

def links
    @properties['links']
end

#notifications ⇒ Hash

Returns The notification configuration for the Service instance. See [Push Notification Configuration](www.twilio.com/docs/chat/push-notification-configuration) for more information.

Returns:



1054
1055
1056
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1054

def notifications
    @properties['notifications']
end

#post_webhook_url ⇒ String

Returns The URL for post-event webhooks, which are called by using the webhook_method. See [Webhook Events](www.twilio.com/docs/api/chat/webhooks) for more details.

Returns:



1036
1037
1038
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1036

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String

Returns The URL for pre-event webhooks, which are called by using the webhook_method. See [Webhook Events](www.twilio.com/docs/api/chat/webhooks) for more details.

Returns:



1030
1031
1032
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1030

def pre_webhook_url
    @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean

Returns Whether the [Reachability Indicator](www.twilio.com/docs/chat/reachability-indicator) is enabled for this Service instance. The default is false.

Returns:



1000
1001
1002
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1000

def reachability_enabled
    @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean

Returns Whether the [Message Consumption Horizon](www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is true.

Returns:



994
995
996
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 994

def read_status_enabled
    @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles

Returns:



1268
1269
1270
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1268

def roles
    context.roles
end

#sid ⇒ String

Returns The unique string that we created to identify the Service resource.

Returns:

  • (String) —

    The unique string that we created to identify the Service resource.



946
947
948
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 946

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



1281
1282
1283
1284
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1281

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

#typing_indicator_timeout ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



1006
1007
1008
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1006

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](www.twilio.com/docs/chat/api/roles) 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](www.twilio.com/docs/chat/api/roles) 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](www.twilio.com/docs/chat/api/roles) for more details.

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

    Whether to enable the [Message Consumption Horizon](www.twilio.com/docs/chat/consumption-horizon) feature. The default is true.

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

    Whether to enable the [Reachability Indicator](www.twilio.com/docs/chat/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](www.twilio.com/docs/api/chat/webhooks) 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](www.twilio.com/docs/api/chat/webhooks) 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](www.twilio.com/docs/chat/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](www.twilio.com/docs/chat/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:



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1143

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 The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource.



1060
1061
1062
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1060

def url
    @properties['url']
end

#users ⇒ users

Access the users

Returns:



1275
1276
1277
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1275

def users
    context.users
end

#webhook_filters ⇒ Array<String>

Returns 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.

Returns:



1048
1049
1050
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1048

def webhook_filters
    @properties['webhook_filters']
end

#webhook_method ⇒ String

Returns 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](www.twilio.com/docs/chat/webhook-events) for more details.

Returns:

  • (String) —

    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](www.twilio.com/docs/chat/webhook-events) for more details.



1042
1043
1044
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1042

def webhook_method
    @properties['webhook_method']
end

#webhooks ⇒ Hash

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.



1024
1025
1026
 
# File 'lib/twilio-ruby/rest/chat/v1/service.rb', line 1024

def webhooks
    @properties['webhooks']
end