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



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

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 ID of the account that owns this Workflow.

Returns:

  • (String) —

    The ID of the account that owns this Workflow



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

def 
  @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



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

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:



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

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:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The time the Workspace was created, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The time the Workspace was created, given as GMT in ISO 8601 format.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The time the Workspace was last updated, given as GMT in ISO 8601 format.

Returns:

  • (Time) —

    The time the Workspace was last updated, given as GMT in ISO 8601 format.



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

def date_updated
  @properties['date_updated']
end

#default_activity_name ⇒ String

Returns The human readable name of the default activity.

Returns:

  • (String) —

    The human readable name of the default activity.



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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sid ⇒ String

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

Returns:

  • (String) —

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



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

def default_activity_sid
  @properties['default_activity_sid']
end

#delete ⇒ Boolean

Deletes the WorkspaceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#event_callback_url ⇒ String

Returns If provided, the Workspace will publish events to this URL.

Returns:

  • (String) —

    If provided, the Workspace will publish events to this URL.



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

def event_callback_url
  @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



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

def events
  context.events
end

#events_filter ⇒ String

Returns Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace.

Returns:

  • (String) —

    Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace.



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

def events_filter
  @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch a WorkspaceInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns Filter by a workspace’s friendly name.

Returns:

  • (String) —

    Filter by a workspace’s friendly name.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def links
  @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns Multi tasking allows workers to handle multiple tasks simultaneously.

Returns:

  • (Boolean) —

    Multi tasking allows workers to handle multiple tasks simultaneously.



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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ workspace.QueueOrder

Returns Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues.

Returns:

  • (workspace.QueueOrder) —

    Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues.



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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String

Returns The unique ID of the Workspace.

Returns:

  • (String) —

    The unique ID of the Workspace



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



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

def task_channels
  context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



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

def task_queues
  context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
  context.tasks
end

#timeout_activity_name ⇒ String

Returns The human readable name of the timeout activity.

Returns:

  • (String) —

    The human readable name of the timeout activity.



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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sid ⇒ String

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

Returns:

  • (String) —

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



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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 ID of the Activity that will be used when new Workers are created in this Workspace.

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

    The Workspace will publish events to this URL. You can use this to gather data for reporting. See

    Events][/docs/taskrouter/api/events

    for more information.

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

    Use this parameter to receive webhooks on EventCallbackUrl for specific events on a workspace. For example if ‘EventsFilter=task.created,task.canceled,worker.activity.update’, then TaskRouter will webhook to EventCallbackUrl only when a task is created, canceled or a worker activity is updated.

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

    Human readable description of this workspace (for example “Sales Call Center” or “Customer Support Team”)

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

    Enable or Disable Multitasking by passing either true or False with the POST request. Learn more by visiting [Multitasking].

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

    The ID 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) —

    Use this parameter to configure whether to prioritize LIFO or FIFO when workers are receiving Tasks from combination of LIFO and FIFO TaskQueues. Default is FIFO. [Click here] to learn more about LIFO and the use of the parameter.

Returns:



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

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



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

def url
  @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



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

def workers
  context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



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

def workflows
  context.workflows
end