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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 380

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 



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

def 
    @properties['account_sid']
end

#alexa_skill_id ⇒ String 



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

def alexa_skill_id
    @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String 



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

def apn_credential_sid
    @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings



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

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String 



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

def default_alexa_notification_protocol_version
    @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String 



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

def default_apn_notification_protocol_version
    @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String 



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

def default_fcm_notification_protocol_version
    @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String 



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

def default_gcm_notification_protocol_version
    @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Delete the ServiceInstance



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

def delete

    context.delete
end

#delivery_callback_enabled ⇒ Boolean 



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

def delivery_callback_enabled
    @properties['delivery_callback_enabled']
end

#delivery_callback_url ⇒ String 



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

def delivery_callback_url
    @properties['delivery_callback_url']
end

#facebook_messenger_page_id ⇒ String 



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

def facebook_messenger_page_id
    @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String 



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

def fcm_credential_sid
    @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



554
555
556
557
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 554

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#gcm_credential_sid ⇒ String 



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

def gcm_credential_sid
    @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



634
635
636
637
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 634

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#log_enabled ⇒ Boolean 



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

def log_enabled
    @properties['log_enabled']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications



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

def notifications
    context.notifications
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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
603
604
605
606
607
608
609
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 576

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 



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

def url
    @properties['url']
end