com.twilio.sdk.resource.instance.taskrouter

Class Workspace

java.lang.Object

com.twilio.sdk.resource.Resource<C>

com.twilio.sdk.resource.InstanceResource<C>

com.twilio.sdk.resource.NextGenInstanceResource<TwilioTaskRouterClient>

com.twilio.sdk.resource.instance.taskrouter.Workspace

public class Workspace
extends NextGenInstanceResource<TwilioTaskRouterClient>

A Workspace is a container for your Tasks, Workers, TaskQueues, Workflows and Activities. Each of these items exists within a single Workspace and will not be shared across Workspaces.

Constructor Summary

Constructors

Constructor and Description
Workspace(TwilioTaskRouterClient client) Instantiates a workspace.
Workspace(TwilioTaskRouterClient client, Map<String,Object> properties) Instantiates a workspace.
Workspace(TwilioTaskRouterClient client, String sid) Instantiates a workspace.

Method Summary

Modifier and Type	Method and Description
Activity	createActivity(List<org.apache.http.NameValuePair> params) Creates an Activity.
Activity	createActivity(Map<String,String> params) Creates an Activity.
Task	createTask(List<org.apache.http.NameValuePair> params) Creates a Task.
Task	createTask(Map<String,String> params) Creates a Task.
Task	createTask(String workflowSid, Map<String,String> attributes, Integer priority, Integer timeout) Creates a Task.
TaskQueue	createTaskQueue(List<org.apache.http.NameValuePair> params) Creates a TaskQueue.
TaskQueue	createTaskQueue(Map<String,String> params) Creates a TaskQueue.
Worker	createWorker(List<org.apache.http.NameValuePair> params) Creates a Worker.
Worker	createWorker(Map<String,String> params) Creates a Worker.
Worker	createWorker(String friendlyName, Map<String,String> attributes, String activitySid) Creates a Worker.
Workflow	createWorkflow(List<org.apache.http.NameValuePair> params) Creates a Workflow.
Workflow	createWorkflow(Map<String,String> params) Creates a Workflow.
String	getAccountSid() The ID of the Account that owns this Workspace.
ActivityList	getActivities() Retrieves the ActivityList for this Workspace
ActivityList	getActivities(Map<String,String> filters) Retrieves the ActivityList for this Workspace
Activity	getActivity(String activitySid) Retrieves an Activity from this Workspace by ID.
Date	getDateCreated() The date and time this Workspace was created.
Date	getDateUpdated() The date and time this Workspace was last updated.
String	getDefaultActivityName() The human-readable name of the default activity.
String	getDefaultActivitySid() The ID of the Activity that will be used when new Workers are created in this Workspace.
Event	getEvent(String eventSid) Retrieves an Event from this Workspace
String	getEventCallbackUrl() An optional URL where the Workspace will publish events.
EventList	getEvents() Retrieves the EventList for this Workspace
EventList	getEvents(Calendar startDate, Calendar endDate, Integer minutes, Map<String,String> filters) Retrieves the EventList for this Workspace
EventList	getEvents(Map<String,String> filters) Retrieves the EventList for this Workspace
String	getFriendlyName() A human-readable description of this Workspace.
String	getSid() The unique ID for this Workspace.
WorkspaceStatistics	getStatistics() Get workspace statistics.
WorkspaceStatistics	getStatistics(Map<String,String> filters) Get workspace statistics.
WorkspaceStatistics	getStatistics(StatisticsQueryBuilder queryBuilder) Get workspace statistics.
Task	getTask(String taskSid) Retrieves a Task from this Workspace.
TaskQueue	getTaskQueue(String taskQueueSid) Retrieves a TaskQueue from a Workspace
TaskQueueList	getTaskQueues() Retrieves the TaskQueueList for this Workspace
TaskQueueList	getTaskQueues(Map<String,String> filters) Retrieves the TaskQueueList for this Workspace
TaskList	getTasks() Retrieves the TaskList for this Workspace.
TaskList	getTasks(Map<String,String> filters) Retrieves the TaskList for this Workspace.
String	getTimeoutActivityName() The human-readable name of the timeout activity.
String	getTimeoutActivitySid() The ID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.
Worker	getWorker(String workerSid) Retrieves a Worker from a Workspace
WorkerList	getWorkers() Retrieves the WorkerList for this Workspace
WorkerList	getWorkers(Map<String,String> filters) Retrieves the WorkerList for this Workspace
Workflow	getWorkflow(String workflowSid) Retrieves a Workflow from a Workspace
WorkflowList	getWorkflows() Retrieves the WorkflowList for this Workspace
WorkflowList	getWorkflows(Map<String,String> filters) Retrieves the WorkflowList for this Workspace

Methods inherited from class com.twilio.sdk.resource.InstanceResource

getCastedObject, getObject, getProperty, toJSON, update, update

Methods inherited from class com.twilio.sdk.resource.Resource

setRequestAccountSid

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Workspace

public Workspace(TwilioTaskRouterClient client)

Instantiates a workspace.

Parameters:

client - the client

Workspace

public Workspace(TwilioTaskRouterClient client,
                 Map<String,Object> properties)

Instantiates a workspace.

Parameters:

client - the client

properties - the properties

Workspace

public Workspace(TwilioTaskRouterClient client,
                 String sid)

Instantiates a workspace.

Parameters:

client - the client

sid - the sid

Method Detail

getAccountSid

public String getAccountSid()

The ID of the Account that owns this Workspace.

Returns:

the account sid

getActivities

public ActivityList getActivities()

Retrieves the ActivityList for this Workspace

Returns:

the ActivityList

getActivities

public ActivityList getActivities(Map<String,String> filters)

Retrieves the ActivityList for this Workspace

Returns:

the ActivityList

getActivity

public Activity getActivity(String activitySid)

Retrieves an Activity from this Workspace by ID.

createActivity

public Activity createActivity(Map<String,String> params)
                        throws TwilioRestException

Creates an Activity.

Parameters:

params - the params list

Returns:

a Activity

Throws:

TwilioRestException

createActivity

public Activity createActivity(List<org.apache.http.NameValuePair> params)
                        throws TwilioRestException

Creates an Activity.

Parameters:

params - the params list

Returns:

a Activity

Throws:

TwilioRestException

getDateCreated

public Date getDateCreated()

The date and time this Workspace was created.

Returns:

the date created

getDateUpdated

public Date getDateUpdated()

The date and time this Workspace was last updated.

Returns:

the date updated

getDefaultActivityName

public String getDefaultActivityName()

The human-readable name of the default activity. Read only.

Returns:

the default activity name

getDefaultActivitySid

public String getDefaultActivitySid()

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

Returns:

the default activity sid

getEvent

public Event getEvent(String eventSid)

Retrieves an Event from this Workspace

getEvents

public EventList getEvents()

Retrieves the EventList for this Workspace

Returns:

the EventList

getEvents

public EventList getEvents(Calendar startDate,
                           Calendar endDate,
                           Integer minutes,
                           Map<String,String> filters)

Retrieves the EventList for this Workspace

Returns:

the EventList

getEvents

public EventList getEvents(Map<String,String> filters)

Retrieves the EventList for this Workspace

Returns:

the EventList

getEventCallbackUrl

public String getEventCallbackUrl()

An optional URL where the Workspace will publish events. You can use this to gather data for reporting.

Returns:

the event callback URL

getFriendlyName

public String getFriendlyName()

A human-readable description of this Workspace.

Returns:

the friendly name

getSid

public String getSid()

The unique ID for this Workspace.

Returns:

the sid

getTask

public Task getTask(String taskSid)

Retrieves a Task from this Workspace.

getTasks

public TaskList getTasks()

Retrieves the TaskList for this Workspace.

Returns:

the TaskList

getTasks

public TaskList getTasks(Map<String,String> filters)

Retrieves the TaskList for this Workspace.

Returns:

the TaskList

createTask

public Task createTask(Map<String,String> params)
                throws TwilioRestException

Creates a Task.

Parameters:

params - the params list

Returns:

a Worker

Throws:

TwilioRestException

createTask

public Task createTask(List<org.apache.http.NameValuePair> params)
                throws TwilioRestException

Creates a Task.

Parameters:

params - the params list

Returns:

a Workflow

Throws:

TwilioRestException

createTask

public Task createTask(String workflowSid,
                       Map<String,String> attributes,
                       Integer priority,
                       Integer timeout)
                throws TwilioRestException

Creates a Task.

Parameters:

workflowSid - workflow sid

attributes - attributes

priority - priority for the task

timeout - timeout for the task

Returns:

a Task

Throws:

TwilioRestException

getTimeoutActivityName

public String getTimeoutActivityName()

The human-readable name of the timeout activity. Read only.

Returns:

the timeout activity name

getTimeoutActivitySid

public String getTimeoutActivitySid()

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

Returns:

the timeout activity sid

getWorker

public Worker getWorker(String workerSid)

Retrieves a Worker from a Workspace

getWorkers

public WorkerList getWorkers()

Retrieves the WorkerList for this Workspace

Returns:

the WorkerList

getWorkers

public WorkerList getWorkers(Map<String,String> filters)

Retrieves the WorkerList for this Workspace

Returns:

the WorkerList

createWorker

public Worker createWorker(Map<String,String> params)
                    throws TwilioRestException

Creates a Worker.

Parameters:

params - the params list

Returns:

a Worker

Throws:

TwilioRestException

createWorker

public Worker createWorker(List<org.apache.http.NameValuePair> params)
                    throws TwilioRestException

Creates a Worker.

Parameters:

params - the params list

Returns:

a Worker

Throws:

TwilioRestException

createWorker

public Worker createWorker(String friendlyName,
                           Map<String,String> attributes,
                           String activitySid)
                    throws TwilioRestException

Creates a Worker.

Parameters:

friendlyName - the friendly name of the worker

attributes - the attributes of the worker

activitySid - the default activity for the worker

Returns:

a Worker

Throws:

TwilioRestException

getWorkflow

public Workflow getWorkflow(String workflowSid)

Retrieves a Workflow from a Workspace

getWorkflows

public WorkflowList getWorkflows()

Retrieves the WorkflowList for this Workspace

Returns:

the WorkflowList

getWorkflows

public WorkflowList getWorkflows(Map<String,String> filters)

Retrieves the WorkflowList for this Workspace

Returns:

the WorkflowList

createWorkflow

public Workflow createWorkflow(Map<String,String> params)
                        throws TwilioRestException

Creates a Workflow.

Parameters:

params - the params list

Returns:

a Workflow

Throws:

TwilioRestException

createWorkflow

public Workflow createWorkflow(List<org.apache.http.NameValuePair> params)
                        throws TwilioRestException

Creates a Workflow.

Parameters:

params - the params list

Returns:

a Workflow

Throws:

TwilioRestException

getTaskQueue

public TaskQueue getTaskQueue(String taskQueueSid)

Retrieves a TaskQueue from a Workspace

getTaskQueues

public TaskQueueList getTaskQueues()

Retrieves the TaskQueueList for this Workspace

Returns:

the TaskQueueList

getTaskQueues

public TaskQueueList getTaskQueues(Map<String,String> filters)

Retrieves the TaskQueueList for this Workspace

Returns:

the TaskQueueList

createTaskQueue

public TaskQueue createTaskQueue(Map<String,String> params)
                          throws TwilioRestException

Creates a TaskQueue.

Parameters:

params - the params list

Returns:

a TaskQueue

Throws:

TwilioRestException

createTaskQueue

public TaskQueue createTaskQueue(List<org.apache.http.NameValuePair> params)
                          throws TwilioRestException

Creates a TaskQueue.

Parameters:

params - the params list

Returns:

a TaskQueue

Throws:

TwilioRestException

getStatistics

public WorkspaceStatistics getStatistics()

Get workspace statistics.

Returns:

workspace statistics

getStatistics

public WorkspaceStatistics getStatistics(StatisticsQueryBuilder queryBuilder)

Get workspace statistics.

Parameters:

queryBuilder - query builder which contains all parameters for the stats query request

Returns:

workspace statistics

getStatistics

public WorkspaceStatistics getStatistics(Map<String,String> filters)

Get workspace statistics.

Parameters:

filters - the filters

Returns:

workspace statistics