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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 357

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 



406
407
408
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 406

def 
  @properties['account_sid']
end

#alexa_skill_id ⇒ String 



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

def alexa_skill_id
  @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String 



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

def apn_credential_sid
  @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings



570
571
572
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 570

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



391
392
393
394
395
396
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 391

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String 



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

def default_alexa_notification_protocol_version
  @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String 



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

def default_apn_notification_protocol_version
  @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String 



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

def default_fcm_notification_protocol_version
  @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String 



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

def default_gcm_notification_protocol_version
  @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Deletes the ServiceInstance



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

def delete
  context.delete
end

#facebook_messenger_page_id ⇒ String 



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

def facebook_messenger_page_id
  @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String 



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

def fcm_credential_sid
  @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#gcm_credential_sid ⇒ String 



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

def gcm_credential_sid
  @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#log_enabled ⇒ Boolean 



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

def log_enabled
  @properties['log_enabled']
end

#messaging_service_sid ⇒ String 



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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications



577
578
579
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 577

def notifications
  context.notifications
end

#sid ⇒ String 



400
401
402
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 400

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



583
584
585
586
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 583

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



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 550

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 



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

def url
  @properties['url']
end