Class: Twilio::REST::Taskrouter::V1::WorkspaceInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the WorkspaceInstance



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 476

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'default_activity_name' => payload['default_activity_name'],
        'default_activity_sid' => payload['default_activity_sid'],
        'event_callback_url' => payload['event_callback_url'],
        'events_filter' => payload['events_filter'],
        'friendly_name' => payload['friendly_name'],
        'multi_task_enabled' => payload['multi_task_enabled'],
        'sid' => payload['sid'],
        'timeout_activity_name' => payload['timeout_activity_name'],
        'timeout_activity_sid' => payload['timeout_activity_sid'],
        'prioritize_queue_order' => payload['prioritize_queue_order'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

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

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#activities ⇒ activities

Access the activities



668
669
670
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 668

def activities
    context.activities
end

#context ⇒ WorkspaceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



507
508
509
510
511
512
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 507

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics



654
655
656
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 654

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time 



522
523
524
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 522

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



528
529
530
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 528

def date_updated
    @properties['date_updated']
end

#default_activity_name ⇒ String 



534
535
536
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 534

def default_activity_name
    @properties['default_activity_name']
end

#default_activity_sid ⇒ String 



540
541
542
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 540

def default_activity_sid
    @properties['default_activity_sid']
end

#delete ⇒ Boolean

Delete the WorkspaceInstance



607
608
609
610
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 607

def delete

    context.delete
end

#event_callback_url ⇒ String 



546
547
548
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 546

def event_callback_url
    @properties['event_callback_url']
end

#events ⇒ events

Access the events



696
697
698
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 696

def events
    context.events
end

#events_filter ⇒ String 



552
553
554
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 552

def events_filter
    @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch the WorkspaceInstance



615
616
617
618
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 615

def fetch

    context.fetch
end

#friendly_name ⇒ String 



558
559
560
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 558

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



730
731
732
733
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 730

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

#links ⇒ Hash 



600
601
602
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 600

def links
    @properties['links']
end

#multi_task_enabled ⇒ Boolean 



564
565
566
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 564

def multi_task_enabled
    @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ QueueOrder 



588
589
590
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 588

def prioritize_queue_order
    @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



675
676
677
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 675

def real_time_statistics
    context.real_time_statistics
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



710
711
712
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 710

def statistics
    context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels



717
718
719
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 717

def task_channels
    context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues



661
662
663
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 661

def task_queues
    context.task_queues
end

#tasks ⇒ tasks

Access the tasks



682
683
684
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 682

def tasks
    context.tasks
end

#timeout_activity_name ⇒ String 



576
577
578
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 576

def timeout_activity_name
    @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String 



582
583
584
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 582

def timeout_activity_sid
    @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



723
724
725
726
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 723

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

#update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset) ⇒ WorkspaceInstance

Update the WorkspaceInstance



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 630

def update(
    default_activity_sid: :unset, 
    event_callback_url: :unset, 
    events_filter: :unset, 
    friendly_name: :unset, 
    multi_task_enabled: :unset, 
    timeout_activity_sid: :unset, 
    prioritize_queue_order: :unset
)

    context.update(
        default_activity_sid: default_activity_sid, 
        event_callback_url: event_callback_url, 
        events_filter: events_filter, 
        friendly_name: friendly_name, 
        multi_task_enabled: multi_task_enabled, 
        timeout_activity_sid: timeout_activity_sid, 
        prioritize_queue_order: prioritize_queue_order, 
    )
end

#url ⇒ String 



594
595
596
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 594

def url
    @properties['url']
end

#workers ⇒ workers

Access the workers



703
704
705
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 703

def workers
    context.workers
end

#workflows ⇒ workflows

Access the workflows



689
690
691
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 689

def workflows
    context.workflows
end