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



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
404
405
406
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 376

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 



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

def 
    @properties['account_sid']
end

#alexa_skill_id ⇒ String 



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

def alexa_skill_id
    @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String 



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

def apn_credential_sid
    @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings



617
618
619
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 617

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



412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 412

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String 



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

def default_alexa_notification_protocol_version
    @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String 



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

def default_apn_notification_protocol_version
    @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String 



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

def default_fcm_notification_protocol_version
    @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String 



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

def default_gcm_notification_protocol_version
    @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Delete the ServiceInstance



542
543
544
545
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 542

def delete

    context.delete
end

#delivery_callback_enabled ⇒ Boolean 



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

def delivery_callback_enabled
    @properties['delivery_callback_enabled']
end

#delivery_callback_url ⇒ String 



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

def delivery_callback_url
    @properties['delivery_callback_url']
end

#facebook_messenger_page_id ⇒ String 



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

def facebook_messenger_page_id
    @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String 



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

def fcm_credential_sid
    @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



550
551
552
553
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 550

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#gcm_credential_sid ⇒ String 



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

def gcm_credential_sid
    @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



630
631
632
633
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 630

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#log_enabled ⇒ Boolean 



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

def log_enabled
    @properties['log_enabled']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
    @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications



610
611
612
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 610

def notifications
    context.notifications
end

#sid ⇒ String 



421
422
423
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 421

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



623
624
625
626
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 623

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



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

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 



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

def url
    @properties['url']
end