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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 455

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



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

def 
  @properties['account_sid']
end

#activitiesactivities

Access the activities



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

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



486
487
488
489
490
491
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 486

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#default_activity_nameString



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sidString



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

def default_activity_sid
  @properties['default_activity_sid']
end

#deleteBoolean

Delete the WorkspaceInstance



634
635
636
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 634

def delete
  context.delete
end

#event_callback_urlString



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

def event_callback_url
  @properties['event_callback_url']
end

#eventsevents

Access the events



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

def events
  context.events
end

#events_filterString



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

def events_filter
  @properties['events_filter']
end

#fetchWorkspaceInstance

Fetch the WorkspaceInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#multi_task_enabledBoolean



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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_orderworkspace.QueueOrder



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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#task_channelstask_channels

Access the task_channels



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

def task_channels
  context.task_channels
end

#task_queuestask_queues

Access the task_queues



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

def task_queues
  context.task_queues
end

#taskstasks

Access the tasks



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

def tasks
  context.tasks
end

#timeout_activity_nameString



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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sidString



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_sObject

Provide a user friendly representation



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

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



619
620
621
622
623
624
625
626
627
628
629
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 619

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



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

def url
  @properties['url']
end

#workersworkers

Access the workers



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

def workers
  context.workers
end

#workflowsworkflows

Access the workflows



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

def workflows
  context.workflows
end