Class: Twilio::REST::Notify::V1::ServiceContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service.rb,
lib/twilio-ruby/rest/notify/v1/service/binding.rb,
lib/twilio-ruby/rest/notify/v1/service/notification.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: BindingContext, BindingInstance, BindingList, BindingPage, NotificationInstance, NotificationList, NotificationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

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


223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 223

def initialize(version, sid)
  super(version)

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

  # Dependents
  @bindings = nil
  @notifications = nil
end

Instance Method Details

#bindings(sid = :unset) ⇒ BindingList, BindingContext

Access the bindings

Returns:

Raises:

  • (ArgumentError) 

316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 316

def bindings(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

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

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

  @bindings
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


238
239
240
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 238

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

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:


245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 245

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


351
352
353
354
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 351

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

#notifications ⇒ NotificationList, NotificationContext

Access the notifications

Returns:


334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 334

def notifications
  unless @notifications
    @notifications = NotificationList.new(@version, service_sid: @solution[:sid], )
  end

  @notifications
end

#to_s ⇒ Object

Provide a user friendly representation


344
345
346
347
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 344

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

#update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :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.

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

    The SID of the Credential to use for APN Bindings.

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

    The SID of the Credential to use for GCM Bindings.

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

    The SID of the Messaging Service to use for SMS Bindings. This parameter must be set in order to send SMS notifications.

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

    Deprecated.

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

    The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

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

    The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

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

    The SID of the Credential to use for FCM Bindings.

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

    The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a Binding resource.

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

    Whether to log notifications. Can be: `true` or `false` and the default is `true`.

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

    Deprecated.

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

    Deprecated.

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

    URL to send delivery status callback.

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

    Callback configuration that enables delivery callbacks, default false

Returns:


289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 289

def update(friendly_name: :unset, apn_credential_sid: :unset, gcm_credential_sid: :unset, messaging_service_sid: :unset, facebook_messenger_page_id: :unset, default_apn_notification_protocol_version: :unset, default_gcm_notification_protocol_version: :unset, fcm_credential_sid: :unset, default_fcm_notification_protocol_version: :unset, log_enabled: :unset, alexa_skill_id: :unset, default_alexa_notification_protocol_version: :unset, delivery_callback_url: :unset, delivery_callback_enabled: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'ApnCredentialSid' => apn_credential_sid,
      'GcmCredentialSid' => gcm_credential_sid,
      'MessagingServiceSid' => messaging_service_sid,
      'FacebookMessengerPageId' => facebook_messenger_page_id,
      'DefaultApnNotificationProtocolVersion' => default_apn_notification_protocol_version,
      'DefaultGcmNotificationProtocolVersion' => default_gcm_notification_protocol_version,
      'FcmCredentialSid' => fcm_credential_sid,
      'DefaultFcmNotificationProtocolVersion' => default_fcm_notification_protocol_version,
      'LogEnabled' => log_enabled,
      'AlexaSkillId' => alexa_skill_id,
      'DefaultAlexaNotificationProtocolVersion' => default_alexa_notification_protocol_version,
      'DeliveryCallbackUrl' => delivery_callback_url,
      'DeliveryCallbackEnabled' => delivery_callback_enabled,
  })

  payload = @version.update('POST', @uri, data: data)

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