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.



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 768

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:



809
810
811
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 809

def 
    @properties['account_sid']
end

#activities ⇒ activities

Access the activities

Returns:



961
962
963
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 961

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:



800
801
802
803
804
805
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 800

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:



947
948
949
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 947

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:



815
816
817
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 815

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:



821
822
823
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 821

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.



827
828
829
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 827

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.



833
834
835
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 833

def default_activity_sid
    @properties['default_activity_sid']
end

#delete ⇒ Boolean

Delete the WorkspaceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



900
901
902
903
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 900

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:



839
840
841
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 839

def event_callback_url
    @properties['event_callback_url']
end

#events ⇒ events

Access the events

Returns:



989
990
991
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 989

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.



845
846
847
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 845

def events_filter
    @properties['events_filter']
end

#fetch ⇒ WorkspaceInstance

Fetch the WorkspaceInstance

Returns:



908
909
910
911
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 908

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



851
852
853
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 851

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



1023
1024
1025
1026
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 1023

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.



893
894
895
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 893

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



857
858
859
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 857

def multi_task_enabled
    @properties['multi_task_enabled']
end

#prioritize_queue_order ⇒ QueueOrder

Returns:

  • (QueueOrder) 


881
882
883
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 881

def prioritize_queue_order
    @properties['prioritize_queue_order']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



968
969
970
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 968

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.



863
864
865
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 863

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



1003
1004
1005
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 1003

def statistics
    context.statistics
end

#task_channels ⇒ task_channels

Access the task_channels

Returns:



1010
1011
1012
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 1010

def task_channels
    context.task_channels
end

#task_queues ⇒ task_queues

Access the task_queues

Returns:



954
955
956
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 954

def task_queues
    context.task_queues
end

#tasks ⇒ tasks

Access the tasks

Returns:



975
976
977
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 975

def tasks
    context.tasks
end

#timeout_activity_name ⇒ String

Returns The name of the timeout activity.

Returns:

  • (String) —

    The name of the timeout activity.



869
870
871
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 869

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.



875
876
877
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 875

def timeout_activity_sid
    @properties['timeout_activity_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



1016
1017
1018
1019
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 1016

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:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 923

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.



887
888
889
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 887

def url
    @properties['url']
end

#workers ⇒ workers

Access the workers

Returns:



996
997
998
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 996

def workers
    context.workers
end

#workflows ⇒ workflows

Access the workflows

Returns:



982
983
984
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace.rb', line 982

def workflows
    context.workflows
end