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



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 464

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_sidString



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

def 
  @properties['account_sid']
end

#activitiesactivities

Access the activities



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

def activities
  context.activities
end

#contextWorkspaceContext

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



495
496
497
498
499
500
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 495

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#default_activity_nameString



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sidString



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

def default_activity_sid
  @properties['default_activity_sid']
end

#deleteBoolean

Delete the WorkspaceInstance



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

def delete
  context.delete
end

#event_callback_urlString



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

def event_callback_url
  @properties['event_callback_url']
end

#eventsevents

Access the events



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

def events
  context.events
end

#events_filterString



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

def events_filter
  @properties['events_filter']
end

#fetchWorkspaceInstance

Fetch the WorkspaceInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#multi_task_enabledBoolean



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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_orderworkspace.QueueOrder



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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#task_channelstask_channels

Access the task_channels



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

def task_channels
  context.task_channels
end

#task_queuestask_queues

Access the task_queues



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

def task_queues
  context.task_queues
end

#taskstasks

Access the tasks



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

def tasks
  context.tasks
end

#timeout_activity_nameString



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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sidString



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_sObject

Provide a user friendly representation



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

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



634
635
636
637
638
639
640
641
642
643
644
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 634

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

#urlString



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

def url
  @properties['url']
end

#workersworkers

Access the workers



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

def workers
  context.workers
end

#workflowsworkflows

Access the workflows



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

def workflows
  context.workflows
end