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



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

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 



512
513
514
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 512

def 
    @properties['account_sid']
end

#activities ⇒ activities

Access the activities



664
665
666
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 664

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



503
504
505
506
507
508
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 503

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics



650
651
652
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 650

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#default_activity_name ⇒ String 



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

def default_activity_name
    @properties['default_activity_name']
end

#default_activity_sid ⇒ String 



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

def default_activity_sid
    @properties['default_activity_sid']
end

#delete ⇒ Boolean

Delete the WorkspaceInstance



603
604
605
606
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 603

def delete

    context.delete
end

#event_callback_url ⇒ String 



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

def event_callback_url
    @properties['event_callback_url']
end

#events ⇒ events

Access the events



692
693
694
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 692

def events
    context.events
end

#events_filter ⇒ String 



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

def events_filter
    @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch the WorkspaceInstance



611
612
613
614
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 611

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



726
727
728
729
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 726

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#multi_task_enabled ⇒ Boolean 



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

def multi_task_enabled
    @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ QueueOrder 



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

def prioritize_queue_order
    @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



671
672
673
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 671

def real_time_statistics
    context.real_time_statistics
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



706
707
708
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 706

def statistics
    context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels



713
714
715
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 713

def task_channels
    context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues



657
658
659
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 657

def task_queues
    context.task_queues
end

#tasks ⇒ tasks

Access the tasks



678
679
680
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 678

def tasks
    context.tasks
end

#timeout_activity_name ⇒ String 



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

def timeout_activity_name
    @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String 



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

def timeout_activity_sid
    @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



719
720
721
722
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 719

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



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

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 



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

def url
    @properties['url']
end

#workers ⇒ workers

Access the workers



699
700
701
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 699

def workers
    context.workers
end

#workflows ⇒ workflows

Access the workflows



685
686
687
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 685

def workflows
    context.workflows
end