Class: Twilio::REST::IpMessaging::V1::ServiceContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v1/service.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/role.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/user.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/invite.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/member.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb,
lib/twilio-ruby/rest/ip_messaging/v1/service/user/user_channel.rb

Defined Under Namespace

Classes: ChannelContext, ChannelInstance, ChannelList, ChannelPage, RoleContext, RoleInstance, RoleList, RolePage, UserContext, UserInstance, UserList, UserPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) 


153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 153

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Services/#{@solution[:sid]}"

    # Dependents
    @channels = nil
    @roles = nil
    @users = nil
end

Instance Method Details

#channels(sid = :unset) ⇒ ChannelList, ChannelContext

Access the channels

Returns:

Raises:

  • (ArgumentError) 


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 372

def channels(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return ChannelContext.new(@version, @solution[:sid],sid )
    end

    unless @channels
        @channels = ChannelList.new(
            @version, service_sid: @solution[:sid], )
    end

 @channels
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



168
169
170
171
172
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 168

def delete

    
    @version.delete('DELETE', @uri)
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 177

def fetch

    
    payload = @version.fetch('GET', @uri)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



435
436
437
438
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 435

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V1.ServiceContext #{context}>"
end

#roles(sid = :unset) ⇒ RoleList, RoleContext

Access the roles

Returns:

Raises:

  • (ArgumentError) 


391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 391

def roles(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return RoleContext.new(@version, @solution[:sid],sid )
    end

    unless @roles
        @roles = RoleList.new(
            @version, service_sid: @solution[:sid], )
    end

 @roles
end

#to_s ⇒ Object

Provide a user friendly representation



428
429
430
431
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 428

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.IpMessaging.V1.ServiceContext #{context}>"
end

#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, webhooks_on_message_send_url: :unset, webhooks_on_message_send_method: :unset, webhooks_on_message_update_url: :unset, webhooks_on_message_update_method: :unset, webhooks_on_message_remove_url: :unset, webhooks_on_message_remove_method: :unset, webhooks_on_channel_add_url: :unset, webhooks_on_channel_add_method: :unset, webhooks_on_channel_destroy_url: :unset, webhooks_on_channel_destroy_method: :unset, webhooks_on_channel_update_url: :unset, webhooks_on_channel_update_method: :unset, webhooks_on_member_add_url: :unset, webhooks_on_member_add_method: :unset, webhooks_on_member_remove_url: :unset, webhooks_on_member_remove_method: :unset, webhooks_on_message_sent_url: :unset, webhooks_on_message_sent_method: :unset, webhooks_on_message_updated_url: :unset, webhooks_on_message_updated_method: :unset, webhooks_on_message_removed_url: :unset, webhooks_on_message_removed_method: :unset, webhooks_on_channel_added_url: :unset, webhooks_on_channel_added_method: :unset, webhooks_on_channel_destroyed_url: :unset, webhooks_on_channel_destroyed_method: :unset, webhooks_on_channel_updated_url: :unset, webhooks_on_channel_updated_method: :unset, webhooks_on_member_added_url: :unset, webhooks_on_member_added_method: :unset, webhooks_on_member_removed_url: :unset, webhooks_on_member_removed_method: :unset, limits_channel_members: :unset, limits_user_channels: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

  • friendly_name (String) (defaults to: :unset)
  • default_service_role_sid (String) (defaults to: :unset)
  • default_channel_role_sid (String) (defaults to: :unset)
  • default_channel_creator_role_sid (String) (defaults to: :unset)
  • read_status_enabled (Boolean) (defaults to: :unset)
  • reachability_enabled (Boolean) (defaults to: :unset)
  • typing_indicator_timeout (String) (defaults to: :unset)
  • consumption_report_interval (String) (defaults to: :unset)
  • notifications_new_message_enabled (Boolean) (defaults to: :unset)
  • notifications_new_message_template (String) (defaults to: :unset)
  • notifications_added_to_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_added_to_channel_template (String) (defaults to: :unset)
  • notifications_removed_from_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_removed_from_channel_template (String) (defaults to: :unset)
  • notifications_invited_to_channel_enabled (Boolean) (defaults to: :unset)
  • notifications_invited_to_channel_template (String) (defaults to: :unset)
  • pre_webhook_url (String) (defaults to: :unset)
  • post_webhook_url (String) (defaults to: :unset)
  • webhook_method (String) (defaults to: :unset)
  • webhook_filters (Array[String]) (defaults to: :unset)
  • webhooks_on_message_send_url (String) (defaults to: :unset)
  • webhooks_on_message_send_method (String) (defaults to: :unset)
  • webhooks_on_message_update_url (String) (defaults to: :unset)
  • webhooks_on_message_update_method (String) (defaults to: :unset)
  • webhooks_on_message_remove_url (String) (defaults to: :unset)
  • webhooks_on_message_remove_method (String) (defaults to: :unset)
  • webhooks_on_channel_add_url (String) (defaults to: :unset)
  • webhooks_on_channel_add_method (String) (defaults to: :unset)
  • webhooks_on_channel_destroy_url (String) (defaults to: :unset)
  • webhooks_on_channel_destroy_method (String) (defaults to: :unset)
  • webhooks_on_channel_update_url (String) (defaults to: :unset)
  • webhooks_on_channel_update_method (String) (defaults to: :unset)
  • webhooks_on_member_add_url (String) (defaults to: :unset)
  • webhooks_on_member_add_method (String) (defaults to: :unset)
  • webhooks_on_member_remove_url (String) (defaults to: :unset)
  • webhooks_on_member_remove_method (String) (defaults to: :unset)
  • webhooks_on_message_sent_url (String) (defaults to: :unset)
  • webhooks_on_message_sent_method (String) (defaults to: :unset)
  • webhooks_on_message_updated_url (String) (defaults to: :unset)
  • webhooks_on_message_updated_method (String) (defaults to: :unset)
  • webhooks_on_message_removed_url (String) (defaults to: :unset)
  • webhooks_on_message_removed_method (String) (defaults to: :unset)
  • webhooks_on_channel_added_url (String) (defaults to: :unset)
  • webhooks_on_channel_added_method (String) (defaults to: :unset)
  • webhooks_on_channel_destroyed_url (String) (defaults to: :unset)
  • webhooks_on_channel_destroyed_method (String) (defaults to: :unset)
  • webhooks_on_channel_updated_url (String) (defaults to: :unset)
  • webhooks_on_channel_updated_method (String) (defaults to: :unset)
  • webhooks_on_member_added_url (String) (defaults to: :unset)
  • webhooks_on_member_added_method (String) (defaults to: :unset)
  • webhooks_on_member_removed_url (String) (defaults to: :unset)
  • webhooks_on_member_removed_method (String) (defaults to: :unset)
  • limits_channel_members (String) (defaults to: :unset)
  • limits_user_channels (String) (defaults to: :unset)

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 245

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
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'DefaultServiceRoleSid' => default_service_role_sid,
        'DefaultChannelRoleSid' => default_channel_role_sid,
        'DefaultChannelCreatorRoleSid' => default_channel_creator_role_sid,
        'ReadStatusEnabled' => read_status_enabled,
        'ReachabilityEnabled' => reachability_enabled,
        'TypingIndicatorTimeout' => typing_indicator_timeout,
        'ConsumptionReportInterval' => consumption_report_interval,
        'Notifications.NewMessage.Enabled' => notifications_new_message_enabled,
        'Notifications.NewMessage.Template' => notifications_new_message_template,
        'Notifications.AddedToChannel.Enabled' => notifications_added_to_channel_enabled,
        'Notifications.AddedToChannel.Template' => notifications_added_to_channel_template,
        'Notifications.RemovedFromChannel.Enabled' => notifications_removed_from_channel_enabled,
        'Notifications.RemovedFromChannel.Template' => notifications_removed_from_channel_template,
        'Notifications.InvitedToChannel.Enabled' => notifications_invited_to_channel_enabled,
        'Notifications.InvitedToChannel.Template' => notifications_invited_to_channel_template,
        'PreWebhookUrl' => pre_webhook_url,
        'PostWebhookUrl' => post_webhook_url,
        'WebhookMethod' => webhook_method,
        'WebhookFilters' => Twilio.serialize_list(webhook_filters) { |e| e },
        'Webhooks.OnMessageSend.Url' => webhooks_on_message_send_url,
        'Webhooks.OnMessageSend.Method' => webhooks_on_message_send_method,
        'Webhooks.OnMessageUpdate.Url' => webhooks_on_message_update_url,
        'Webhooks.OnMessageUpdate.Method' => webhooks_on_message_update_method,
        'Webhooks.OnMessageRemove.Url' => webhooks_on_message_remove_url,
        'Webhooks.OnMessageRemove.Method' => webhooks_on_message_remove_method,
        'Webhooks.OnChannelAdd.Url' => webhooks_on_channel_add_url,
        'Webhooks.OnChannelAdd.Method' => webhooks_on_channel_add_method,
        'Webhooks.OnChannelDestroy.Url' => webhooks_on_channel_destroy_url,
        'Webhooks.OnChannelDestroy.Method' => webhooks_on_channel_destroy_method,
        'Webhooks.OnChannelUpdate.Url' => webhooks_on_channel_update_url,
        'Webhooks.OnChannelUpdate.Method' => webhooks_on_channel_update_method,
        'Webhooks.OnMemberAdd.Url' => webhooks_on_member_add_url,
        'Webhooks.OnMemberAdd.Method' => webhooks_on_member_add_method,
        'Webhooks.OnMemberRemove.Url' => webhooks_on_member_remove_url,
        'Webhooks.OnMemberRemove.Method' => webhooks_on_member_remove_method,
        'Webhooks.OnMessageSent.Url' => webhooks_on_message_sent_url,
        'Webhooks.OnMessageSent.Method' => webhooks_on_message_sent_method,
        'Webhooks.OnMessageUpdated.Url' => webhooks_on_message_updated_url,
        'Webhooks.OnMessageUpdated.Method' => webhooks_on_message_updated_method,
        'Webhooks.OnMessageRemoved.Url' => webhooks_on_message_removed_url,
        'Webhooks.OnMessageRemoved.Method' => webhooks_on_message_removed_method,
        'Webhooks.OnChannelAdded.Url' => webhooks_on_channel_added_url,
        'Webhooks.OnChannelAdded.Method' => webhooks_on_channel_added_method,
        'Webhooks.OnChannelDestroyed.Url' => webhooks_on_channel_destroyed_url,
        'Webhooks.OnChannelDestroyed.Method' => webhooks_on_channel_destroyed_method,
        'Webhooks.OnChannelUpdated.Url' => webhooks_on_channel_updated_url,
        'Webhooks.OnChannelUpdated.Method' => webhooks_on_channel_updated_method,
        'Webhooks.OnMemberAdded.Url' => webhooks_on_member_added_url,
        'Webhooks.OnMemberAdded.Method' => webhooks_on_member_added_method,
        'Webhooks.OnMemberRemoved.Url' => webhooks_on_member_removed_url,
        'Webhooks.OnMemberRemoved.Method' => webhooks_on_member_removed_method,
        'Limits.ChannelMembers' => limits_channel_members,
        'Limits.UserChannels' => limits_user_channels,
    })

    
    payload = @version.update('POST', @uri, data: data)
    ServiceInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#users(sid = :unset) ⇒ UserList, UserContext

Access the users

Returns:

Raises:

  • (ArgumentError) 


410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 410

def users(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return UserContext.new(@version, @solution[:sid],sid )
    end

    unless @users
        @users = UserList.new(
            @version, service_sid: @solution[:sid], )
    end

 @users
end