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



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

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



500
501
502
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 500

def 
  @properties['account_sid']
end

#activitiesactivities

Access the activities



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

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



491
492
493
494
495
496
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 491

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#default_activity_nameString



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sidString



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

def default_activity_sid
  @properties['default_activity_sid']
end

#deleteBoolean

Delete the WorkspaceInstance



643
644
645
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 643

def delete
  context.delete
end

#event_callback_urlString



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

def event_callback_url
  @properties['event_callback_url']
end

#eventsevents

Access the events



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

def events
  context.events
end

#events_filterString



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

def events_filter
  @properties['events_filter']
end

#fetchWorkspaceInstance

Fetch the WorkspaceInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

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


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

def links
  @properties['links']
end

#multi_task_enabledBoolean



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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_orderworkspace.QueueOrder



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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#task_channelstask_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_queuestask_queues

Access the task_queues



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

def task_queues
  context.task_queues
end

#taskstasks

Access the tasks



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

def tasks
  context.tasks
end

#timeout_activity_nameString



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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sidString



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_sObject

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



628
629
630
631
632
633
634
635
636
637
638
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 628

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



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

def url
  @properties['url']
end

#workersworkers

Access the workers



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

def workers
  context.workers
end

#workflowsworkflows

Access the workflows



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

def workflows
  context.workflows
end