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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The sid



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 405

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

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#alexa_skill_id ⇒ String

Returns The alexa_skill_id.

Returns:

  • (String) —

    The alexa_skill_id



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

def alexa_skill_id
  @properties['alexa_skill_id']
end

#apn_credential_sid ⇒ String

Returns The apn_credential_sid.

Returns:

  • (String) —

    The apn_credential_sid



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

def apn_credential_sid
  @properties['apn_credential_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



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

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:



441
442
443
444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 441

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#default_alexa_notification_protocol_version ⇒ String

Returns The default_alexa_notification_protocol_version.

Returns:

  • (String) —

    The default_alexa_notification_protocol_version



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

def default_alexa_notification_protocol_version
  @properties['default_alexa_notification_protocol_version']
end

#default_apn_notification_protocol_version ⇒ String

Returns The default_apn_notification_protocol_version.

Returns:

  • (String) —

    The default_apn_notification_protocol_version



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

def default_apn_notification_protocol_version
  @properties['default_apn_notification_protocol_version']
end

#default_fcm_notification_protocol_version ⇒ String

Returns The default_fcm_notification_protocol_version.

Returns:

  • (String) —

    The default_fcm_notification_protocol_version



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

def default_fcm_notification_protocol_version
  @properties['default_fcm_notification_protocol_version']
end

#default_gcm_notification_protocol_version ⇒ String

Returns The default_gcm_notification_protocol_version.

Returns:

  • (String) —

    The default_gcm_notification_protocol_version



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

def default_gcm_notification_protocol_version
  @properties['default_gcm_notification_protocol_version']
end

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



562
563
564
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 562

def delete
  context.delete
end

#facebook_messenger_page_id ⇒ String

Returns The facebook_messenger_page_id.

Returns:

  • (String) —

    The facebook_messenger_page_id



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

def facebook_messenger_page_id
  @properties['facebook_messenger_page_id']
end

#fcm_credential_sid ⇒ String

Returns The fcm_credential_sid.

Returns:

  • (String) —

    The fcm_credential_sid



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

def fcm_credential_sid
  @properties['fcm_credential_sid']
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#gcm_credential_sid ⇒ String

Returns The gcm_credential_sid.

Returns:

  • (String) —

    The gcm_credential_sid



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

def gcm_credential_sid
  @properties['gcm_credential_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



646
647
648
649
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 646

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#log_enabled ⇒ Boolean

Returns The log_enabled.

Returns:

  • (Boolean) —

    The log_enabled



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

def log_enabled
  @properties['log_enabled']
end

#messaging_service_sid ⇒ String

Returns The messaging_service_sid.

Returns:

  • (String) —

    The messaging_service_sid



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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#notifications ⇒ notifications

Access the notifications

Returns:



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

def notifications
  context.notifications
end

#segments ⇒ segments

Access the segments

Returns:



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

def segments
  context.segments
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



639
640
641
642
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 639

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

Parameters:

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

    The friendly_name

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

    The apn_credential_sid

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

    The gcm_credential_sid

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

    The messaging_service_sid

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

    The facebook_messenger_page_id

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

    The default_apn_notification_protocol_version

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

    The default_gcm_notification_protocol_version

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

    The fcm_credential_sid

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

    The default_fcm_notification_protocol_version

  • log_enabled (Boolean) (defaults to: :unset) —

    The log_enabled

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

    The alexa_skill_id

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

    The default_alexa_notification_protocol_version

Returns:



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/twilio-ruby/rest/notify/v1/service.rb', line 592

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

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#users ⇒ users

Access the users

Returns:



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

def users
  context.users
end