Class: Twilio::REST::IpMessaging::V2::ServiceInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the ServiceInstance



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
407
408
409
410
411
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 378

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']),
      'default_service_role_sid' => payload['default_service_role_sid'],
      'default_channel_role_sid' => payload['default_channel_role_sid'],
      'default_channel_creator_role_sid' => payload['default_channel_creator_role_sid'],
      'read_status_enabled' => payload['read_status_enabled'],
      'reachability_enabled' => payload['reachability_enabled'],
      'typing_indicator_timeout' => payload['typing_indicator_timeout'].to_i,
      'consumption_report_interval' => payload['consumption_report_interval'].to_i,
      'limits' => payload['limits'],
      'pre_webhook_url' => payload['pre_webhook_url'],
      'post_webhook_url' => payload['post_webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'webhook_filters' => payload['webhook_filters'],
      'pre_webhook_retry_count' => payload['pre_webhook_retry_count'].to_i,
      'post_webhook_retry_count' => payload['post_webhook_retry_count'].to_i,
      'notifications' => payload['notifications'],
      'media' => payload['media'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String 



432
433
434
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 432

def 
  @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings



682
683
684
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 682

def bindings
  context.bindings
end

#channels ⇒ channels

Access the channels



661
662
663
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 661

def channels
  context.channels
end

#consumption_report_interval ⇒ String 



492
493
494
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 492

def consumption_report_interval
  @properties['consumption_report_interval']
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



417
418
419
420
421
422
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 417

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

#date_created ⇒ Time 



444
445
446
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 444

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



450
451
452
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 450

def date_updated
  @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String 



468
469
470
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 468

def default_channel_creator_role_sid
  @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String 



462
463
464
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 462

def default_channel_role_sid
  @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String 



456
457
458
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 456

def default_service_role_sid
  @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Deletes the ServiceInstance



572
573
574
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 572

def delete
  context.delete
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance



565
566
567
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 565

def fetch
  context.fetch
end

#friendly_name ⇒ String 



438
439
440
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 438

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



695
696
697
698
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 695

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

#limits ⇒ Hash 



498
499
500
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 498

def limits
  @properties['limits']
end

#links ⇒ String 



558
559
560
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 558

def links
  @properties['links']
end

#media ⇒ Hash 



546
547
548
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 546

def media
  @properties['media']
end

#notifications ⇒ Hash 



540
541
542
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 540

def notifications
  @properties['notifications']
end

#post_webhook_retry_count ⇒ String 



534
535
536
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 534

def post_webhook_retry_count
  @properties['post_webhook_retry_count']
end

#post_webhook_url ⇒ String 



510
511
512
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 510

def post_webhook_url
  @properties['post_webhook_url']
end

#pre_webhook_retry_count ⇒ String 



528
529
530
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 528

def pre_webhook_retry_count
  @properties['pre_webhook_retry_count']
end

#pre_webhook_url ⇒ String 



504
505
506
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 504

def pre_webhook_url
  @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean 



480
481
482
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 480

def reachability_enabled
  @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean 



474
475
476
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 474

def read_status_enabled
  @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles



668
669
670
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 668

def roles
  context.roles
end

#sid ⇒ String 



426
427
428
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 426

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



688
689
690
691
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 688

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.IpMessaging.V2.ServiceInstance #{values}>"
end

#typing_indicator_timeout ⇒ String 



486
487
488
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 486

def typing_indicator_timeout
  @properties['typing_indicator_timeout']
end

#update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset) ⇒ ServiceInstance

Update the ServiceInstance



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 623

def update(friendly_name: :unset, default_service_role_sid: :unset, default_channel_role_sid: :unset, default_channel_creator_role_sid: :unset, read_status_enabled: :unset, reachability_enabled: :unset, typing_indicator_timeout: :unset, consumption_report_interval: :unset, notifications_new_message_enabled: :unset, notifications_new_message_template: :unset, notifications_new_message_sound: :unset, notifications_new_message_badge_count_enabled: :unset, notifications_added_to_channel_enabled: :unset, notifications_added_to_channel_template: :unset, notifications_added_to_channel_sound: :unset, notifications_removed_from_channel_enabled: :unset, notifications_removed_from_channel_template: :unset, notifications_removed_from_channel_sound: :unset, notifications_invited_to_channel_enabled: :unset, notifications_invited_to_channel_template: :unset, notifications_invited_to_channel_sound: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, webhook_method: :unset, webhook_filters: :unset, limits_channel_members: :unset, limits_user_channels: :unset, media_compatibility_message: :unset, pre_webhook_retry_count: :unset, post_webhook_retry_count: :unset)
  context.update(
      friendly_name: friendly_name,
      default_service_role_sid: default_service_role_sid,
      default_channel_role_sid: default_channel_role_sid,
      default_channel_creator_role_sid: default_channel_creator_role_sid,
      read_status_enabled: read_status_enabled,
      reachability_enabled: reachability_enabled,
      typing_indicator_timeout: typing_indicator_timeout,
      consumption_report_interval: consumption_report_interval,
      notifications_new_message_enabled: notifications_new_message_enabled,
      notifications_new_message_template: notifications_new_message_template,
      notifications_new_message_sound: notifications_new_message_sound,
      notifications_new_message_badge_count_enabled: notifications_new_message_badge_count_enabled,
      notifications_added_to_channel_enabled: notifications_added_to_channel_enabled,
      notifications_added_to_channel_template: notifications_added_to_channel_template,
      notifications_added_to_channel_sound: notifications_added_to_channel_sound,
      notifications_removed_from_channel_enabled: notifications_removed_from_channel_enabled,
      notifications_removed_from_channel_template: notifications_removed_from_channel_template,
      notifications_removed_from_channel_sound: notifications_removed_from_channel_sound,
      notifications_invited_to_channel_enabled: notifications_invited_to_channel_enabled,
      notifications_invited_to_channel_template: notifications_invited_to_channel_template,
      notifications_invited_to_channel_sound: notifications_invited_to_channel_sound,
      pre_webhook_url: pre_webhook_url,
      post_webhook_url: post_webhook_url,
      webhook_method: webhook_method,
      webhook_filters: webhook_filters,
      limits_channel_members: limits_channel_members,
      limits_user_channels: limits_user_channels,
      media_compatibility_message: media_compatibility_message,
      pre_webhook_retry_count: pre_webhook_retry_count,
      post_webhook_retry_count: post_webhook_retry_count,
  )
end

#url ⇒ String 



552
553
554
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 552

def url
  @properties['url']
end

#users ⇒ users

Access the users



675
676
677
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 675

def users
  context.users
end

#webhook_filters ⇒ String 



522
523
524
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 522

def webhook_filters
  @properties['webhook_filters']
end

#webhook_method ⇒ String 



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

def webhook_method
  @properties['webhook_method']
end