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 of the Workspace resource to fetch.



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_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



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

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:



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_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#default_activity_name ⇒ String

Returns The name of the default activity.

Returns:

  • (String) —

    The name of the default activity



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_sid ⇒ String

Returns The SID of the Activity that will be used when new Workers are created in the Workspace.

Returns:

  • (String) —

    The SID of the Activity that will be used when new Workers are created in the Workspace



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

def default_activity_sid
  @properties['default_activity_sid']
end

#delete ⇒ Boolean

Delete the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#event_callback_url ⇒ String

Returns The URL we call when an event occurs.

Returns:

  • (String) —

    The URL we call when an event occurs



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

def event_callback_url
  @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



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

def events
  context.events
end

#events_filter ⇒ String

Returns The list of Workspace events for which to call event_callback_url.

Returns:

  • (String) —

    The list of Workspace events for which to call event_callback_url



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

def events_filter
  @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch the WorkspaceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Workspace resource.

Returns:

  • (String) —

    The string that you assigned to describe the Workspace resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns Whether multi-tasking is enabled.

Returns:

  • (Boolean) —

    Whether multi-tasking is enabled



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_order ⇒ workspace.QueueOrder

Returns The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues.

Returns:

  • (workspace.QueueOrder) —

    The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues



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_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



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

def task_channels
  context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



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

def task_queues
  context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
  context.tasks
end

#timeout_activity_name ⇒ String

Returns The name of the timeout activity.

Returns:

  • (String) —

    The name of the timeout activity



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_sid ⇒ String

Returns The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.

Returns:

  • (String) —

    The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_s ⇒ Object

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

Parameters:

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

    The SID of the Activity that will be used when new Workers are created in the Workspace.

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

    The URL we should call when an event occurs. See Workspace Events for more information.

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

    The list of Workspace events for which to call event_callback_url. For example if ‘EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.

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

    A descriptive string that you create to describe the Workspace resource. For example: ‘Sales Call Center` or `Customer Support Team`.

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

    Whether to enable multi-tasking. Can be: ‘true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking].

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

    The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.

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

    The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: ‘LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering].

Returns:



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

#url ⇒ String

Returns The absolute URL of the Workspace resource.

Returns:

  • (String) —

    The absolute URL of the Workspace resource



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

def url
  @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



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

def workers
  context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



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

def workflows
  context.workflows
end