Class: Twilio::REST::Notify::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/notify/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.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 373

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']),
        'apn_credential_sid' => payload['apn_credential_sid'],
        'gcm_credential_sid' => payload['gcm_credential_sid'],
        'fcm_credential_sid' => payload['fcm_credential_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'facebook_messenger_page_id' => payload['facebook_messenger_page_id'],
        'default_apn_notification_protocol_version' => payload['default_apn_notification_protocol_version'],
        'default_gcm_notification_protocol_version' => payload['default_gcm_notification_protocol_version'],
        'default_fcm_notification_protocol_version' => payload['default_fcm_notification_protocol_version'],
        'log_enabled' => payload['log_enabled'],
        'url' => payload['url'],
        'links' => payload['links'],
        'alexa_skill_id' => payload['alexa_skill_id'],
        'default_alexa_notification_protocol_version' => payload['default_alexa_notification_protocol_version'],
        'delivery_callback_url' => payload['delivery_callback_url'],
        'delivery_callback_enabled' => payload['delivery_callback_enabled'],
    }

    # 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/iam/api/account) that created the Service resource.

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 424

def 
    @properties['account_sid']
end

#alexa_skill_id ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



514
515
516
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 514

def alexa_skill_id
    @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.

Returns:



448
449
450
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 448

def apn_credential_sid
    @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



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

def bindings
    context.bindings
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:



409
410
411
412
413
414
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 409

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:



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

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:



442
443
444
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 442

def date_updated
    @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



520
521
522
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 520

def default_alexa_notification_protocol_version
    @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String

Returns The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.

Returns:



478
479
480
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 478

def default_apn_notification_protocol_version
    @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String

Returns The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.

Returns:



490
491
492
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 490

def default_fcm_notification_protocol_version
    @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String

Returns The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](www.twilio.com/docs/notify/api/binding-resource) resource.

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 484

def default_gcm_notification_protocol_version
    @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



539
540
541
542
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 539

def delete

    context.delete
end

#delivery_callback_enabled ⇒ Boolean

Returns Callback configuration that enables delivery callbacks, default false.

Returns:

  • (Boolean) —

    Callback configuration that enables delivery callbacks, default false



532
533
534
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 532

def delivery_callback_enabled
    @properties['delivery_callback_enabled']
end

#delivery_callback_url ⇒ String

Returns URL to send delivery status callback.

Returns:

  • (String) —

    URL to send delivery status callback.



526
527
528
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 526

def delivery_callback_url
    @properties['delivery_callback_url']
end

#facebook_messenger_page_id ⇒ String

Returns Deprecated.

Returns:

  • (String) —

    Deprecated.



472
473
474
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 472

def facebook_messenger_page_id
    @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.

Returns:



460
461
462
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 460

def fcm_credential_sid
    @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



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

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.



430
431
432
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 430

def friendly_name
    @properties['friendly_name']
end

#gcm_credential_sid ⇒ String

Returns The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.

Returns:



454
455
456
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 454

def gcm_credential_sid
    @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



627
628
629
630
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 627

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

#links ⇒ Hash

Returns The URLs of the Binding, Notification, Segment, and User resources related to the service.

Returns:

  • (Hash) —

    The URLs of the Binding, Notification, Segment, and User resources related to the service.



508
509
510
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 508

def links
    @properties['links']
end

#log_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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



496
497
498
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 496

def log_enabled
    @properties['log_enabled']
end

#messaging_service_sid ⇒ String

Returns The SID of the [Messaging Service](www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. In order to send SMS notifications this parameter has to be set.

Returns:



466
467
468
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 466

def messaging_service_sid
    @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications

Returns:



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

def notifications
    context.notifications
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.



418
419
420
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 418

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



620
621
622
623
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 620

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Notify.V1.ServiceInstance #{values}>"
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](www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.

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

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.

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

    The SID of the [Messaging Service](www.twilio.com/docs/sms/send-messages#messaging-services) 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](www.twilio.com/docs/notify/api/binding-resource) 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](www.twilio.com/docs/notify/api/binding-resource) resource.

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

    The SID of the [Credential](www.twilio.com/docs/notify/api/credential-resource) 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](www.twilio.com/docs/notify/api/binding-resource) 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:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 569

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
)

    context.update(
        friendly_name: friendly_name, 
        apn_credential_sid: apn_credential_sid, 
        gcm_credential_sid: gcm_credential_sid, 
        messaging_service_sid: messaging_service_sid, 
        facebook_messenger_page_id: facebook_messenger_page_id, 
        default_apn_notification_protocol_version: default_apn_notification_protocol_version, 
        default_gcm_notification_protocol_version: default_gcm_notification_protocol_version, 
        fcm_credential_sid: fcm_credential_sid, 
        default_fcm_notification_protocol_version: default_fcm_notification_protocol_version, 
        log_enabled: log_enabled, 
        alexa_skill_id: alexa_skill_id, 
        default_alexa_notification_protocol_version: default_alexa_notification_protocol_version, 
        delivery_callback_url: delivery_callback_url, 
        delivery_callback_enabled: delivery_callback_enabled, 
    )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource.



502
503
504
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 502

def url
    @properties['url']
end