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.


454
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
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 454

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

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#activitiesactivities

Access the activities

Returns:


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

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

Returns:


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

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics

Returns:


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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#default_activity_nameString

Returns The name of the default activity.

Returns:

  • (String)

    The name of the default activity


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

def default_activity_name
  @properties['default_activity_name']
end

#default_activity_sidString

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


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

def default_activity_sid
  @properties['default_activity_sid']
end

#deleteBoolean

Delete the WorkspaceInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#event_callback_urlString

Returns The URL we call when an event occurs.

Returns:

  • (String)

    The URL we call when an event occurs


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

def event_callback_url
  @properties['event_callback_url']
end

#eventsevents

Access the events

Returns:


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

def events
  context.events
end

#events_filterString

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


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

def events_filter
  @properties['events_filter']
end

#fetchWorkspaceInstance

Fetch the WorkspaceInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

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

Returns:

  • (String)

    The string that you assigned to describe the Workspace resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The URLs of related resources.

Returns:

  • (String)

    The URLs of related resources


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

def links
  @properties['links']
end

#multi_task_enabledBoolean

Returns Whether multi-tasking is enabled.

Returns:

  • (Boolean)

    Whether multi-tasking is enabled


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

def multi_task_enabled
  @properties['multi_task_enabled']
end

#prioritize_queue_orderworkspace.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


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

def prioritize_queue_order
  @properties['prioritize_queue_order']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics

Returns:


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

def real_time_statistics
  context.real_time_statistics
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics

Returns:


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

def statistics
  context.statistics
end

#task_channelstask_channels

Access the task_channels

Returns:


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

def task_channels
  context.task_channels
end

#task_queuestask_queues

Access the task_queues

Returns:


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

def task_queues
  context.task_queues
end

#taskstasks

Access the tasks

Returns:


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

def tasks
  context.tasks
end

#timeout_activity_nameString

Returns The name of the timeout activity.

Returns:

  • (String)

    The name of the timeout activity


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

def timeout_activity_name
  @properties['timeout_activity_name']
end

#timeout_activity_sidString

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


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

def timeout_activity_sid
  @properties['timeout_activity_sid']
end

#to_sObject

Provide a user friendly representation


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

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:


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

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

Returns The absolute URL of the Workspace resource.

Returns:

  • (String)

    The absolute URL of the Workspace resource


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

def url
  @properties['url']
end

#workersworkers

Access the workers

Returns:


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

def workers
  context.workers
end

#workflowsworkflows

Access the workflows

Returns:


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

def workflows
  context.workflows
end