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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 434

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'] == nil ? payload['typing_indicator_timeout'] : payload['typing_indicator_timeout'].to_i,
        'consumption_report_interval' => payload['consumption_report_interval'] == nil ? payload['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'] == nil ? payload['pre_webhook_retry_count'] : payload['pre_webhook_retry_count'].to_i,
        'post_webhook_retry_count' => payload['post_webhook_retry_count'] == nil ? payload['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 



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

def 
    @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings



740
741
742
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 740

def bindings
    context.bindings
end

#channels ⇒ channels

Access the channels



747
748
749
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 747

def channels
    context.channels
end

#consumption_report_interval ⇒ String 



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

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



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

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#default_channel_creator_role_sid ⇒ String 



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

def default_channel_creator_role_sid
    @properties['default_channel_creator_role_sid']
end

#default_channel_role_sid ⇒ String 



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

def default_channel_role_sid
    @properties['default_channel_role_sid']
end

#default_service_role_sid ⇒ String 



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

def default_service_role_sid
    @properties['default_service_role_sid']
end

#delete ⇒ Boolean

Delete the ServiceInstance



621
622
623
624
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 621

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance



629
630
631
632
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 629

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



774
775
776
777
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 774

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

#limits ⇒ Hash 



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

def limits
    @properties['limits']
end

#links ⇒ Hash 



614
615
616
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 614

def links
    @properties['links']
end

#media ⇒ Hash 



602
603
604
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 602

def media
    @properties['media']
end

#notifications ⇒ Hash 



596
597
598
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 596

def notifications
    @properties['notifications']
end

#post_webhook_retry_count ⇒ String 



590
591
592
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 590

def post_webhook_retry_count
    @properties['post_webhook_retry_count']
end

#post_webhook_url ⇒ String 



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

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_retry_count ⇒ String 



584
585
586
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 584

def pre_webhook_retry_count
    @properties['pre_webhook_retry_count']
end

#pre_webhook_url ⇒ String 



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

def pre_webhook_url
    @properties['pre_webhook_url']
end

#reachability_enabled ⇒ Boolean 



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

def reachability_enabled
    @properties['reachability_enabled']
end

#read_status_enabled ⇒ Boolean 



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

def read_status_enabled
    @properties['read_status_enabled']
end

#roles ⇒ roles

Access the roles



754
755
756
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 754

def roles
    context.roles
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



767
768
769
770
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 767

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

#typing_indicator_timeout ⇒ String 



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

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, notifications_log_enabled: :unset) ⇒ ServiceInstance

Update the ServiceInstance



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 668

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, 
    notifications_log_enabled: :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, 
        notifications_log_enabled: notifications_log_enabled, 
    )
end

#url ⇒ String 



608
609
610
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 608

def url
    @properties['url']
end

#users ⇒ users

Access the users



761
762
763
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 761

def users
    context.users
end

#webhook_filters ⇒ Array<String> 



578
579
580
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service.rb', line 578

def webhook_filters
    @properties['webhook_filters']
end

#webhook_method ⇒ String 



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

def webhook_method
    @properties['webhook_method']
end