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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance



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

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'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String 



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

def 
  @properties['account_sid']
end

#alexa_skill_id ⇒ String 



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

def alexa_skill_id
  @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String 



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

def apn_credential_sid
  @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings



592
593
594
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 592

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



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

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String 



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

def default_alexa_notification_protocol_version
  @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String 



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

def default_apn_notification_protocol_version
  @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String 



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

def default_fcm_notification_protocol_version
  @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String 



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

def default_gcm_notification_protocol_version
  @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Deletes the ServiceInstance



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

def delete
  context.delete
end

#facebook_messenger_page_id ⇒ String 



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

def facebook_messenger_page_id
  @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String 



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

def fcm_credential_sid
  @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#gcm_credential_sid ⇒ String 



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

def gcm_credential_sid
  @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#log_enabled ⇒ Boolean 



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

def log_enabled
  @properties['log_enabled']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications



599
600
601
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 599

def notifications
  context.notifications
end

#sid ⇒ String 



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) ⇒ ServiceInstance

Update the ServiceInstance



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# 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)
  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,
  )
end

#url ⇒ String 



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

def url
  @properties['url']
end