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

  • account_sid (String) —

    The SID of the Account that created this Workspace resource.

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

    The SID of the Call resource to fetch.



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 493

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](www.twilio.com/docs/iam/api/account) that created the Workspace resource.

Returns:



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

def 
    @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



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

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:



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

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:



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

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

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.



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

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.



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

def default_activity_sid
    @properties['default_activity_sid']
end

#delete ⇒ Boolean

Delete the WorkspaceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#event_callback_url ⇒ String

Returns The URL we call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See [Workspace Events](www.twilio.com/docs/taskrouter/api/event) for more information. This parameter supports Twilio’s [Webhooks (HTTP callbacks) Connection Overrides](www.twilio.com/docs/usage/webhooks/webhooks-connection-overrides).

Returns:



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

def event_callback_url
    @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



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

def events
    context.events
end

#events_filter ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



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

def events_filter
    @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch the WorkspaceInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Workspace resource. For example ‘Customer Support` or `2014 Election Campaign`.

Returns:

  • (String) —

    The string that you assigned to describe the Workspace resource. For example ‘Customer Support` or `2014 Election Campaign`.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#multi_task_enabled ⇒ Boolean

Returns Whether multi-tasking is enabled. The default is ‘true`, which enables multi-tasking. 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. In single-tasking each Worker would only receive a new reservation when the previous task is completed. Learn more at [Multitasking](www.twilio.com/docs/taskrouter/multitasking).

Returns:

  • (Boolean) —

    Whether multi-tasking is enabled. The default is ‘true`, which enables multi-tasking. 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. In single-tasking each Worker would only receive a new reservation when the previous task is completed. Learn more at [Multitasking](www.twilio.com/docs/taskrouter/multitasking).



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

def multi_task_enabled
    @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ QueueOrder

Returns:

  • (QueueOrder) 


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

def prioritize_queue_order
    @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
    context.real_time_statistics
end

#sid ⇒ String

Returns The unique string that we created to identify the Workspace resource.

Returns:

  • (String) —

    The unique string that we created to identify the Workspace resource.



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
    context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



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

def task_channels
    context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



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

def task_queues
    context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



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

def tasks
    context.tasks
end

#timeout_activity_name ⇒ String

Returns The name of the timeout activity.

Returns:

  • (String) —

    The name of the timeout activity.



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

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.



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

def timeout_activity_sid
    @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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](www.twilio.com/docs/taskrouter/api/event) for more information. This parameter supports Twilio’s [Webhooks (HTTP callbacks) Connection Overrides](www.twilio.com/docs/usage/webhooks/webhooks-connection-overrides).

  • 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. However, all workspaces should be maintained as multi-tasking. There is no default when omitting this parameter. A multi-tasking Workspace can’t be updated to single-tasking unless it is not a Flex Project and another (legacy) single-tasking Workspace exists. Multi-tasking allows Workers to handle multiple Tasks simultaneously. In multi-tasking mode, each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. In single-tasking mode (legacy mode), each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking](www.twilio.com/docs/taskrouter/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 (QueueOrder) (defaults to: :unset)

Returns:



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 647

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.



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

def url
    @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



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

def workers
    context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



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

def workflows
    context.workflows
end