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)

    The sid


160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 160

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)

346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 346

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

#deleteBoolean

Delete the ServiceInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


185
186
187
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 185

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

#fetchServiceInstance

Fetch the ServiceInstance

Returns:


176
177
178
179
180
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 176

def fetch
  payload = @version.fetch('GET', @uri)

  ServiceInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


405
406
407
408
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 405

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)

364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 364

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_sObject

Provide a user friendly representation


398
399
400
401
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 398

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)

    The friendly_name

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

    The default_service_role_sid

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

    The default_channel_role_sid

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

    The default_channel_creator_role_sid

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

    The read_status_enabled

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

    The reachability_enabled

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

    The typing_indicator_timeout

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

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

    The pre_webhook_url

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

    The post_webhook_url

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

    The webhook_method

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

    The webhook_filters

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

    The webhooks.on_message_send.url

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

    The webhooks.on_message_send.method

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

    The webhooks.on_message_update.url

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

    The webhooks.on_message_update.method

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

    The webhooks.on_message_remove.url

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

    The webhooks.on_message_remove.method

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

    The webhooks.on_channel_add.url

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

    The webhooks.on_channel_add.method

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

    The webhooks.on_channel_destroy.url

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

    The webhooks.on_channel_destroy.method

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

    The webhooks.on_channel_update.url

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

    The webhooks.on_channel_update.method

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

    The webhooks.on_member_add.url

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

    The webhooks.on_member_add.method

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

    The webhooks.on_member_remove.url

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

    The webhooks.on_member_remove.method

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

    The webhooks.on_message_sent.url

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

    The webhooks.on_message_sent.method

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

    The webhooks.on_message_updated.url

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

    The webhooks.on_message_updated.method

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

    The webhooks.on_message_removed.url

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

    The webhooks.on_message_removed.method

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

    The webhooks.on_channel_added.url

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

    The webhooks.on_channel_added.method

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

    The webhooks.on_channel_destroyed.url

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

    The webhooks.on_channel_destroyed.method

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

    The webhooks.on_channel_updated.url

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

    The webhooks.on_channel_updated.method

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

    The webhooks.on_member_added.url

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

    The webhooks.on_member_added.method

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

    The webhooks.on_member_removed.url

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

    The webhooks.on_member_removed.method

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

    The limits.channel_members

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

    The limits.user_channels

Returns:


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

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)

382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service.rb', line 382

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