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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The sid



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 501

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

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



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

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

Returns:



534
535
536
537
538
539
540
541
542
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 534

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#default_activity_name ⇒ String

Returns The default_activity_name.

Returns:

  • (String) —

    The default_activity_name



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sid ⇒ String

Returns The default_activity_sid.

Returns:

  • (String) —

    The default_activity_sid



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

def default_activity_sid
  @properties['default_activity_sid']
end

#delete ⇒ Boolean

Deletes the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#event_callback_url ⇒ String

Returns The event_callback_url.

Returns:

  • (String) —

    The event_callback_url



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

def event_callback_url
  @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



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

def events
  context.events
end

#events_filter ⇒ String

Returns The events_filter.

Returns:

  • (String) —

    The events_filter



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

def events_filter
  @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch a WorkspaceInstance

Returns:



637
638
639
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 637

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



749
750
751
752
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 749

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



630
631
632
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 630

def links
  @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns The multi_task_enabled.

Returns:

  • (Boolean) —

    The multi_task_enabled



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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ workspace.QueueOrder

Returns The prioritize_queue_order.

Returns:

  • (workspace.QueueOrder) —

    The prioritize_queue_order



618
619
620
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 618

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



736
737
738
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 736

def task_channels
  context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



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

def task_queues
  context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
  context.tasks
end

#timeout_activity_name ⇒ String

Returns The timeout_activity_name.

Returns:

  • (String) —

    The timeout_activity_name



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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String

Returns The timeout_activity_sid.

Returns:

  • (String) —

    The timeout_activity_sid



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



742
743
744
745
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 742

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

Parameters:

  • default_activity_sid (String) (defaults to: :unset) —

    The default_activity_sid

  • event_callback_url (String) (defaults to: :unset) —

    The event_callback_url

  • events_filter (String) (defaults to: :unset) —

    The events_filter

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • multi_task_enabled (Boolean) (defaults to: :unset) —

    The multi_task_enabled

  • timeout_activity_sid (String) (defaults to: :unset) —

    The timeout_activity_sid

  • prioritize_queue_order (workspace.QueueOrder) (defaults to: :unset) —

    The prioritize_queue_order

Returns:



651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 651

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

Returns The url.

Returns:

  • (String) —

    The url



624
625
626
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 624

def url
  @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



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

def workers
  context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



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

def workflows
  context.workflows
end