openapi

package
v0.14.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 25, 2021 License: MIT Imports: 6 Imported by: 1

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.20.1
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://taskrouter.twilio.com

Class Method HTTP request Description
WorkspacesApi CreateWorkspace Post /v1/Workspaces
WorkspacesApi DeleteWorkspace Delete /v1/Workspaces/{Sid}
WorkspacesApi FetchWorkspace Get /v1/Workspaces/{Sid}
WorkspacesApi ListWorkspace Get /v1/Workspaces
WorkspacesApi UpdateWorkspace Post /v1/Workspaces/{Sid}
WorkspacesActivitiesApi CreateActivity Post /v1/Workspaces/{WorkspaceSid}/Activities
WorkspacesActivitiesApi DeleteActivity Delete /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspacesActivitiesApi FetchActivity Get /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspacesActivitiesApi ListActivity Get /v1/Workspaces/{WorkspaceSid}/Activities
WorkspacesActivitiesApi UpdateActivity Post /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspacesCumulativeStatisticsApi FetchWorkspaceCumulativeStatistics Get /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics
WorkspacesEventsApi FetchEvent Get /v1/Workspaces/{WorkspaceSid}/Events/{Sid}
WorkspacesEventsApi ListEvent Get /v1/Workspaces/{WorkspaceSid}/Events
WorkspacesRealTimeStatisticsApi FetchWorkspaceRealTimeStatistics Get /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics
WorkspacesStatisticsApi FetchWorkspaceStatistics Get /v1/Workspaces/{WorkspaceSid}/Statistics
WorkspacesTaskChannelsApi CreateTaskChannel Post /v1/Workspaces/{WorkspaceSid}/TaskChannels
WorkspacesTaskChannelsApi DeleteTaskChannel Delete /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}
WorkspacesTaskChannelsApi FetchTaskChannel Get /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}
WorkspacesTaskChannelsApi ListTaskChannel Get /v1/Workspaces/{WorkspaceSid}/TaskChannels
WorkspacesTaskChannelsApi UpdateTaskChannel Post /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}
WorkspacesTaskQueuesApi CreateTaskQueue Post /v1/Workspaces/{WorkspaceSid}/TaskQueues
WorkspacesTaskQueuesApi DeleteTaskQueue Delete /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
WorkspacesTaskQueuesApi FetchTaskQueue Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
WorkspacesTaskQueuesApi ListTaskQueue Get /v1/Workspaces/{WorkspaceSid}/TaskQueues
WorkspacesTaskQueuesApi UpdateTaskQueue Post /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid}
WorkspacesTaskQueuesCumulativeStatisticsApi FetchTaskQueueCumulativeStatistics Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics
WorkspacesTaskQueuesRealTimeStatisticsApi FetchTaskQueueRealTimeStatistics Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics
WorkspacesTaskQueuesStatisticsApi FetchTaskQueueStatistics Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics
WorkspacesTaskQueuesStatisticsApi ListTaskQueuesStatistics Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics
WorkspacesTasksApi CreateTask Post /v1/Workspaces/{WorkspaceSid}/Tasks
WorkspacesTasksApi DeleteTask Delete /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
WorkspacesTasksApi FetchTask Get /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
WorkspacesTasksApi ListTask Get /v1/Workspaces/{WorkspaceSid}/Tasks
WorkspacesTasksApi UpdateTask Post /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid}
WorkspacesTasksReservationsApi FetchTaskReservation Get /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}
WorkspacesTasksReservationsApi ListTaskReservation Get /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations
WorkspacesTasksReservationsApi UpdateTaskReservation Post /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid}
WorkspacesWorkersApi CreateWorker Post /v1/Workspaces/{WorkspaceSid}/Workers
WorkspacesWorkersApi DeleteWorker Delete /v1/Workspaces/{WorkspaceSid}/Workers/{Sid}
WorkspacesWorkersApi FetchWorker Get /v1/Workspaces/{WorkspaceSid}/Workers/{Sid}
WorkspacesWorkersApi ListWorker Get /v1/Workspaces/{WorkspaceSid}/Workers
WorkspacesWorkersApi UpdateWorker Post /v1/Workspaces/{WorkspaceSid}/Workers/{Sid}
WorkspacesWorkersChannelsApi FetchWorkerChannel Get /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}
WorkspacesWorkersChannelsApi ListWorkerChannel Get /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels
WorkspacesWorkersChannelsApi UpdateWorkerChannel Post /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}
WorkspacesWorkersCumulativeStatisticsApi FetchWorkersCumulativeStatistics Get /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics
WorkspacesWorkersRealTimeStatisticsApi FetchWorkersRealTimeStatistics Get /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics
WorkspacesWorkersReservationsApi FetchWorkerReservation Get /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}
WorkspacesWorkersReservationsApi ListWorkerReservation Get /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations
WorkspacesWorkersReservationsApi UpdateWorkerReservation Post /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}
WorkspacesWorkersStatisticsApi FetchWorkerInstanceStatistics Get /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics
WorkspacesWorkersStatisticsApi FetchWorkerStatistics Get /v1/Workspaces/{WorkspaceSid}/Workers/Statistics
WorkspacesWorkflowsApi CreateWorkflow Post /v1/Workspaces/{WorkspaceSid}/Workflows
WorkspacesWorkflowsApi DeleteWorkflow Delete /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
WorkspacesWorkflowsApi FetchWorkflow Get /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
WorkspacesWorkflowsApi ListWorkflow Get /v1/Workspaces/{WorkspaceSid}/Workflows
WorkspacesWorkflowsApi UpdateWorkflow Post /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid}
WorkspacesWorkflowsCumulativeStatisticsApi FetchWorkflowCumulativeStatistics Get /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics
WorkspacesWorkflowsRealTimeStatisticsApi FetchWorkflowRealTimeStatistics Get /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics
WorkspacesWorkflowsStatisticsApi FetchWorkflowStatistics Get /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService added in v0.11.0

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateActivity added in v0.11.0

func (c *ApiService) CreateActivity(WorkspaceSid string, params *CreateActivityParams) (*TaskrouterV1Activity, error)

func (*ApiService) CreateTask added in v0.11.0

func (c *ApiService) CreateTask(WorkspaceSid string, params *CreateTaskParams) (*TaskrouterV1Task, error)

func (*ApiService) CreateTaskChannel added in v0.11.0

func (c *ApiService) CreateTaskChannel(WorkspaceSid string, params *CreateTaskChannelParams) (*TaskrouterV1TaskChannel, error)

func (*ApiService) CreateTaskQueue added in v0.11.0

func (c *ApiService) CreateTaskQueue(WorkspaceSid string, params *CreateTaskQueueParams) (*TaskrouterV1TaskQueue, error)

func (*ApiService) CreateWorker added in v0.11.0

func (c *ApiService) CreateWorker(WorkspaceSid string, params *CreateWorkerParams) (*TaskrouterV1Worker, error)

func (*ApiService) CreateWorkflow added in v0.11.0

func (c *ApiService) CreateWorkflow(WorkspaceSid string, params *CreateWorkflowParams) (*TaskrouterV1Workflow, error)

func (*ApiService) CreateWorkspace added in v0.11.0

func (c *ApiService) CreateWorkspace(params *CreateWorkspaceParams) (*TaskrouterV1Workspace, error)

func (*ApiService) DeleteActivity added in v0.11.0

func (c *ApiService) DeleteActivity(WorkspaceSid string, Sid string) error

func (*ApiService) DeleteTask added in v0.11.0

func (c *ApiService) DeleteTask(WorkspaceSid string, Sid string, params *DeleteTaskParams) error

func (*ApiService) DeleteTaskChannel added in v0.11.0

func (c *ApiService) DeleteTaskChannel(WorkspaceSid string, Sid string) error

func (*ApiService) DeleteTaskQueue added in v0.11.0

func (c *ApiService) DeleteTaskQueue(WorkspaceSid string, Sid string) error

func (*ApiService) DeleteWorker added in v0.11.0

func (c *ApiService) DeleteWorker(WorkspaceSid string, Sid string) error

func (*ApiService) DeleteWorkflow added in v0.11.0

func (c *ApiService) DeleteWorkflow(WorkspaceSid string, Sid string) error

func (*ApiService) DeleteWorkspace added in v0.11.0

func (c *ApiService) DeleteWorkspace(Sid string) error

func (*ApiService) FetchActivity added in v0.11.0

func (c *ApiService) FetchActivity(WorkspaceSid string, Sid string) (*TaskrouterV1Activity, error)

func (*ApiService) FetchEvent added in v0.11.0

func (c *ApiService) FetchEvent(WorkspaceSid string, Sid string) (*TaskrouterV1Event, error)

func (*ApiService) FetchTask added in v0.11.0

func (c *ApiService) FetchTask(WorkspaceSid string, Sid string) (*TaskrouterV1Task, error)

func (*ApiService) FetchTaskChannel added in v0.11.0

func (c *ApiService) FetchTaskChannel(WorkspaceSid string, Sid string) (*TaskrouterV1TaskChannel, error)

func (*ApiService) FetchTaskQueue added in v0.11.0

func (c *ApiService) FetchTaskQueue(WorkspaceSid string, Sid string) (*TaskrouterV1TaskQueue, error)

func (*ApiService) FetchTaskQueueCumulativeStatistics added in v0.11.0

func (c *ApiService) FetchTaskQueueCumulativeStatistics(WorkspaceSid string, TaskQueueSid string, params *FetchTaskQueueCumulativeStatisticsParams) (*TaskrouterV1TaskQueueCumulativeStatistics, error)

func (*ApiService) FetchTaskQueueRealTimeStatistics added in v0.11.0

func (c *ApiService) FetchTaskQueueRealTimeStatistics(WorkspaceSid string, TaskQueueSid string, params *FetchTaskQueueRealTimeStatisticsParams) (*TaskrouterV1TaskQueueRealTimeStatistics, error)

func (*ApiService) FetchTaskQueueStatistics added in v0.11.0

func (c *ApiService) FetchTaskQueueStatistics(WorkspaceSid string, TaskQueueSid string, params *FetchTaskQueueStatisticsParams) (*TaskrouterV1TaskQueueStatistics, error)

func (*ApiService) FetchTaskReservation added in v0.11.0

func (c *ApiService) FetchTaskReservation(WorkspaceSid string, TaskSid string, Sid string) (*TaskrouterV1TaskReservation, error)

func (*ApiService) FetchWorker added in v0.11.0

func (c *ApiService) FetchWorker(WorkspaceSid string, Sid string) (*TaskrouterV1Worker, error)

func (*ApiService) FetchWorkerChannel added in v0.11.0

func (c *ApiService) FetchWorkerChannel(WorkspaceSid string, WorkerSid string, Sid string) (*TaskrouterV1WorkerChannel, error)

func (*ApiService) FetchWorkerInstanceStatistics added in v0.11.0

func (c *ApiService) FetchWorkerInstanceStatistics(WorkspaceSid string, WorkerSid string, params *FetchWorkerInstanceStatisticsParams) (*TaskrouterV1WorkerInstanceStatistics, error)

func (*ApiService) FetchWorkerReservation added in v0.11.0

func (c *ApiService) FetchWorkerReservation(WorkspaceSid string, WorkerSid string, Sid string) (*TaskrouterV1WorkerReservation, error)

func (*ApiService) FetchWorkerStatistics added in v0.11.0

func (c *ApiService) FetchWorkerStatistics(WorkspaceSid string, params *FetchWorkerStatisticsParams) (*TaskrouterV1WorkerStatistics, error)

func (*ApiService) FetchWorkersCumulativeStatistics added in v0.11.0

func (c *ApiService) FetchWorkersCumulativeStatistics(WorkspaceSid string, params *FetchWorkersCumulativeStatisticsParams) (*TaskrouterV1WorkersCumulativeStatistics, error)

func (*ApiService) FetchWorkersRealTimeStatistics added in v0.11.0

func (c *ApiService) FetchWorkersRealTimeStatistics(WorkspaceSid string, params *FetchWorkersRealTimeStatisticsParams) (*TaskrouterV1WorkersRealTimeStatistics, error)

func (*ApiService) FetchWorkflow added in v0.11.0

func (c *ApiService) FetchWorkflow(WorkspaceSid string, Sid string) (*TaskrouterV1Workflow, error)

func (*ApiService) FetchWorkflowCumulativeStatistics added in v0.11.0

func (c *ApiService) FetchWorkflowCumulativeStatistics(WorkspaceSid string, WorkflowSid string, params *FetchWorkflowCumulativeStatisticsParams) (*TaskrouterV1WorkflowCumulativeStatistics, error)

func (*ApiService) FetchWorkflowRealTimeStatistics added in v0.11.0

func (c *ApiService) FetchWorkflowRealTimeStatistics(WorkspaceSid string, WorkflowSid string, params *FetchWorkflowRealTimeStatisticsParams) (*TaskrouterV1WorkflowRealTimeStatistics, error)

func (*ApiService) FetchWorkflowStatistics added in v0.11.0

func (c *ApiService) FetchWorkflowStatistics(WorkspaceSid string, WorkflowSid string, params *FetchWorkflowStatisticsParams) (*TaskrouterV1WorkflowStatistics, error)

func (*ApiService) FetchWorkspace added in v0.11.0

func (c *ApiService) FetchWorkspace(Sid string) (*TaskrouterV1Workspace, error)

func (*ApiService) FetchWorkspaceCumulativeStatistics added in v0.11.0

func (c *ApiService) FetchWorkspaceCumulativeStatistics(WorkspaceSid string, params *FetchWorkspaceCumulativeStatisticsParams) (*TaskrouterV1WorkspaceCumulativeStatistics, error)

func (*ApiService) FetchWorkspaceRealTimeStatistics added in v0.11.0

func (c *ApiService) FetchWorkspaceRealTimeStatistics(WorkspaceSid string, params *FetchWorkspaceRealTimeStatisticsParams) (*TaskrouterV1WorkspaceRealTimeStatistics, error)

func (*ApiService) FetchWorkspaceStatistics added in v0.11.0

func (c *ApiService) FetchWorkspaceStatistics(WorkspaceSid string, params *FetchWorkspaceStatisticsParams) (*TaskrouterV1WorkspaceStatistics, error)

func (*ApiService) ListActivity added in v0.11.0

func (c *ApiService) ListActivity(WorkspaceSid string, params *ListActivityParams) ([]TaskrouterV1Activity, error)

Lists Activity records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEvent added in v0.11.0

func (c *ApiService) ListEvent(WorkspaceSid string, params *ListEventParams) ([]TaskrouterV1Event, error)

Lists Event records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListTask added in v0.11.0

func (c *ApiService) ListTask(WorkspaceSid string, params *ListTaskParams) ([]TaskrouterV1Task, error)

Lists Task records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListTaskChannel added in v0.11.0

func (c *ApiService) ListTaskChannel(WorkspaceSid string, params *ListTaskChannelParams) ([]TaskrouterV1TaskChannel, error)

Lists TaskChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListTaskQueue added in v0.11.0

func (c *ApiService) ListTaskQueue(WorkspaceSid string, params *ListTaskQueueParams) ([]TaskrouterV1TaskQueue, error)

Lists TaskQueue records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListTaskQueuesStatistics added in v0.11.0

func (c *ApiService) ListTaskQueuesStatistics(WorkspaceSid string, params *ListTaskQueuesStatisticsParams) ([]TaskrouterV1TaskQueuesStatistics, error)

Lists TaskQueuesStatistics records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListTaskReservation added in v0.11.0

func (c *ApiService) ListTaskReservation(WorkspaceSid string, TaskSid string, params *ListTaskReservationParams) ([]TaskrouterV1TaskReservation, error)

Lists TaskReservation records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWorker added in v0.11.0

func (c *ApiService) ListWorker(WorkspaceSid string, params *ListWorkerParams) ([]TaskrouterV1Worker, error)

Lists Worker records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWorkerChannel added in v0.11.0

func (c *ApiService) ListWorkerChannel(WorkspaceSid string, WorkerSid string, params *ListWorkerChannelParams) ([]TaskrouterV1WorkerChannel, error)

Lists WorkerChannel records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWorkerReservation added in v0.11.0

func (c *ApiService) ListWorkerReservation(WorkspaceSid string, WorkerSid string, params *ListWorkerReservationParams) ([]TaskrouterV1WorkerReservation, error)

Lists WorkerReservation records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWorkflow added in v0.11.0

func (c *ApiService) ListWorkflow(WorkspaceSid string, params *ListWorkflowParams) ([]TaskrouterV1Workflow, error)

Lists Workflow records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWorkspace added in v0.11.0

func (c *ApiService) ListWorkspace(params *ListWorkspaceParams) ([]TaskrouterV1Workspace, error)

Lists Workspace records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageActivity added in v0.13.0

func (c *ApiService) PageActivity(WorkspaceSid string, params *ListActivityParams, pageToken string, pageNumber string) (*ListActivityResponse, error)

Retrieve a single page of Activity records from the API. Request is executed immediately.

func (*ApiService) PageEvent added in v0.13.0

func (c *ApiService) PageEvent(WorkspaceSid string, params *ListEventParams, pageToken string, pageNumber string) (*ListEventResponse, error)

Retrieve a single page of Event records from the API. Request is executed immediately.

func (*ApiService) PageTask added in v0.13.0

func (c *ApiService) PageTask(WorkspaceSid string, params *ListTaskParams, pageToken string, pageNumber string) (*ListTaskResponse, error)

Retrieve a single page of Task records from the API. Request is executed immediately.

func (*ApiService) PageTaskChannel added in v0.13.0

func (c *ApiService) PageTaskChannel(WorkspaceSid string, params *ListTaskChannelParams, pageToken string, pageNumber string) (*ListTaskChannelResponse, error)

Retrieve a single page of TaskChannel records from the API. Request is executed immediately.

func (*ApiService) PageTaskQueue added in v0.13.0

func (c *ApiService) PageTaskQueue(WorkspaceSid string, params *ListTaskQueueParams, pageToken string, pageNumber string) (*ListTaskQueueResponse, error)

Retrieve a single page of TaskQueue records from the API. Request is executed immediately.

func (*ApiService) PageTaskQueuesStatistics added in v0.13.0

func (c *ApiService) PageTaskQueuesStatistics(WorkspaceSid string, params *ListTaskQueuesStatisticsParams, pageToken string, pageNumber string) (*ListTaskQueuesStatisticsResponse, error)

Retrieve a single page of TaskQueuesStatistics records from the API. Request is executed immediately.

func (*ApiService) PageTaskReservation added in v0.13.0

func (c *ApiService) PageTaskReservation(WorkspaceSid string, TaskSid string, params *ListTaskReservationParams, pageToken string, pageNumber string) (*ListTaskReservationResponse, error)

Retrieve a single page of TaskReservation records from the API. Request is executed immediately.

func (*ApiService) PageWorker added in v0.13.0

func (c *ApiService) PageWorker(WorkspaceSid string, params *ListWorkerParams, pageToken string, pageNumber string) (*ListWorkerResponse, error)

Retrieve a single page of Worker records from the API. Request is executed immediately.

func (*ApiService) PageWorkerChannel added in v0.13.0

func (c *ApiService) PageWorkerChannel(WorkspaceSid string, WorkerSid string, params *ListWorkerChannelParams, pageToken string, pageNumber string) (*ListWorkerChannelResponse, error)

Retrieve a single page of WorkerChannel records from the API. Request is executed immediately.

func (*ApiService) PageWorkerReservation added in v0.13.0

func (c *ApiService) PageWorkerReservation(WorkspaceSid string, WorkerSid string, params *ListWorkerReservationParams, pageToken string, pageNumber string) (*ListWorkerReservationResponse, error)

Retrieve a single page of WorkerReservation records from the API. Request is executed immediately.

func (*ApiService) PageWorkflow added in v0.13.0

func (c *ApiService) PageWorkflow(WorkspaceSid string, params *ListWorkflowParams, pageToken string, pageNumber string) (*ListWorkflowResponse, error)

Retrieve a single page of Workflow records from the API. Request is executed immediately.

func (*ApiService) PageWorkspace added in v0.13.0

func (c *ApiService) PageWorkspace(params *ListWorkspaceParams, pageToken string, pageNumber string) (*ListWorkspaceResponse, error)

Retrieve a single page of Workspace records from the API. Request is executed immediately.

func (*ApiService) StreamActivity added in v0.13.0

func (c *ApiService) StreamActivity(WorkspaceSid string, params *ListActivityParams) (chan TaskrouterV1Activity, error)

Streams Activity records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEvent added in v0.13.0

func (c *ApiService) StreamEvent(WorkspaceSid string, params *ListEventParams) (chan TaskrouterV1Event, error)

Streams Event records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamTask added in v0.13.0

func (c *ApiService) StreamTask(WorkspaceSid string, params *ListTaskParams) (chan TaskrouterV1Task, error)

Streams Task records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamTaskChannel added in v0.13.0

func (c *ApiService) StreamTaskChannel(WorkspaceSid string, params *ListTaskChannelParams) (chan TaskrouterV1TaskChannel, error)

Streams TaskChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamTaskQueue added in v0.13.0

func (c *ApiService) StreamTaskQueue(WorkspaceSid string, params *ListTaskQueueParams) (chan TaskrouterV1TaskQueue, error)

Streams TaskQueue records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamTaskQueuesStatistics added in v0.13.0

func (c *ApiService) StreamTaskQueuesStatistics(WorkspaceSid string, params *ListTaskQueuesStatisticsParams) (chan TaskrouterV1TaskQueuesStatistics, error)

Streams TaskQueuesStatistics records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamTaskReservation added in v0.13.0

func (c *ApiService) StreamTaskReservation(WorkspaceSid string, TaskSid string, params *ListTaskReservationParams) (chan TaskrouterV1TaskReservation, error)

Streams TaskReservation records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWorker added in v0.13.0

func (c *ApiService) StreamWorker(WorkspaceSid string, params *ListWorkerParams) (chan TaskrouterV1Worker, error)

Streams Worker records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWorkerChannel added in v0.13.0

func (c *ApiService) StreamWorkerChannel(WorkspaceSid string, WorkerSid string, params *ListWorkerChannelParams) (chan TaskrouterV1WorkerChannel, error)

Streams WorkerChannel records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWorkerReservation added in v0.13.0

func (c *ApiService) StreamWorkerReservation(WorkspaceSid string, WorkerSid string, params *ListWorkerReservationParams) (chan TaskrouterV1WorkerReservation, error)

Streams WorkerReservation records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWorkflow added in v0.13.0

func (c *ApiService) StreamWorkflow(WorkspaceSid string, params *ListWorkflowParams) (chan TaskrouterV1Workflow, error)

Streams Workflow records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWorkspace added in v0.13.0

func (c *ApiService) StreamWorkspace(params *ListWorkspaceParams) (chan TaskrouterV1Workspace, error)

Streams Workspace records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateActivity added in v0.11.0

func (c *ApiService) UpdateActivity(WorkspaceSid string, Sid string, params *UpdateActivityParams) (*TaskrouterV1Activity, error)

func (*ApiService) UpdateTask added in v0.11.0

func (c *ApiService) UpdateTask(WorkspaceSid string, Sid string, params *UpdateTaskParams) (*TaskrouterV1Task, error)

func (*ApiService) UpdateTaskChannel added in v0.11.0

func (c *ApiService) UpdateTaskChannel(WorkspaceSid string, Sid string, params *UpdateTaskChannelParams) (*TaskrouterV1TaskChannel, error)

func (*ApiService) UpdateTaskQueue added in v0.11.0

func (c *ApiService) UpdateTaskQueue(WorkspaceSid string, Sid string, params *UpdateTaskQueueParams) (*TaskrouterV1TaskQueue, error)

func (*ApiService) UpdateTaskReservation added in v0.11.0

func (c *ApiService) UpdateTaskReservation(WorkspaceSid string, TaskSid string, Sid string, params *UpdateTaskReservationParams) (*TaskrouterV1TaskReservation, error)

func (*ApiService) UpdateWorker added in v0.11.0

func (c *ApiService) UpdateWorker(WorkspaceSid string, Sid string, params *UpdateWorkerParams) (*TaskrouterV1Worker, error)

func (*ApiService) UpdateWorkerChannel added in v0.11.0

func (c *ApiService) UpdateWorkerChannel(WorkspaceSid string, WorkerSid string, Sid string, params *UpdateWorkerChannelParams) (*TaskrouterV1WorkerChannel, error)

func (*ApiService) UpdateWorkerReservation added in v0.11.0

func (c *ApiService) UpdateWorkerReservation(WorkspaceSid string, WorkerSid string, Sid string, params *UpdateWorkerReservationParams) (*TaskrouterV1WorkerReservation, error)

func (*ApiService) UpdateWorkflow added in v0.11.0

func (c *ApiService) UpdateWorkflow(WorkspaceSid string, Sid string, params *UpdateWorkflowParams) (*TaskrouterV1Workflow, error)

func (*ApiService) UpdateWorkspace added in v0.11.0

func (c *ApiService) UpdateWorkspace(Sid string, params *UpdateWorkspaceParams) (*TaskrouterV1Workspace, error)

type CreateActivityParams

type CreateActivityParams struct {
	// Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.
	Available *bool `json:"Available,omitempty"`
	// A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateActivity'

func (*CreateActivityParams) SetAvailable

func (params *CreateActivityParams) SetAvailable(Available bool) *CreateActivityParams

func (*CreateActivityParams) SetFriendlyName

func (params *CreateActivityParams) SetFriendlyName(FriendlyName string) *CreateActivityParams

type CreateTaskChannelParams

type CreateTaskChannelParams struct {
	// Whether the Task Channel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
	ChannelOptimizedRouting *bool `json:"ChannelOptimizedRouting,omitempty"`
	// A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`.
	UniqueName *string `json:"UniqueName,omitempty"`
}

Optional parameters for the method 'CreateTaskChannel'

func (*CreateTaskChannelParams) SetChannelOptimizedRouting

func (params *CreateTaskChannelParams) SetChannelOptimizedRouting(ChannelOptimizedRouting bool) *CreateTaskChannelParams

func (*CreateTaskChannelParams) SetFriendlyName

func (params *CreateTaskChannelParams) SetFriendlyName(FriendlyName string) *CreateTaskChannelParams

func (*CreateTaskChannelParams) SetUniqueName

func (params *CreateTaskChannelParams) SetUniqueName(UniqueName string) *CreateTaskChannelParams

type CreateTaskParams

type CreateTaskParams struct {
	// A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \\\"task_type\\\": \\\"call\\\", \\\"twilio_call_sid\\\": \\\"CAxxx\\\", \\\"customer_ticket_number\\\": \\\"12345\\\" }`.
	Attributes *string `json:"Attributes,omitempty"`
	// The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).
	Priority *int `json:"Priority,omitempty"`
	// When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// The amount of time in seconds the new task can live before being assigned. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.
	Timeout *int `json:"Timeout,omitempty"`
	// The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.
	WorkflowSid *string `json:"WorkflowSid,omitempty"`
}

Optional parameters for the method 'CreateTask'

func (*CreateTaskParams) SetAttributes

func (params *CreateTaskParams) SetAttributes(Attributes string) *CreateTaskParams

func (*CreateTaskParams) SetPriority

func (params *CreateTaskParams) SetPriority(Priority int) *CreateTaskParams

func (*CreateTaskParams) SetTaskChannel

func (params *CreateTaskParams) SetTaskChannel(TaskChannel string) *CreateTaskParams

func (*CreateTaskParams) SetTimeout

func (params *CreateTaskParams) SetTimeout(Timeout int) *CreateTaskParams

func (*CreateTaskParams) SetWorkflowSid

func (params *CreateTaskParams) SetWorkflowSid(WorkflowSid string) *CreateTaskParams

type CreateTaskQueueParams

type CreateTaskQueueParams struct {
	// The SID of the Activity to assign Workers when a task is assigned to them.
	AssignmentActivitySid *string `json:"AssignmentActivitySid,omitempty"`
	// A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.
	MaxReservedWorkers *int `json:"MaxReservedWorkers,omitempty"`
	// The SID of the Activity to assign Workers when a task is reserved for them.
	ReservationActivitySid *string `json:"ReservationActivitySid,omitempty"`
	// A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `'\\\"language\\\" == \\\"spanish\\\"'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).
	TargetWorkers *string `json:"TargetWorkers,omitempty"`
	// How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or FIFO to assign the oldest Task first. Default is `FIFO`. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.
	TaskOrder *string `json:"TaskOrder,omitempty"`
}

Optional parameters for the method 'CreateTaskQueue'

func (*CreateTaskQueueParams) SetAssignmentActivitySid

func (params *CreateTaskQueueParams) SetAssignmentActivitySid(AssignmentActivitySid string) *CreateTaskQueueParams

func (*CreateTaskQueueParams) SetFriendlyName

func (params *CreateTaskQueueParams) SetFriendlyName(FriendlyName string) *CreateTaskQueueParams

func (*CreateTaskQueueParams) SetMaxReservedWorkers

func (params *CreateTaskQueueParams) SetMaxReservedWorkers(MaxReservedWorkers int) *CreateTaskQueueParams

func (*CreateTaskQueueParams) SetReservationActivitySid

func (params *CreateTaskQueueParams) SetReservationActivitySid(ReservationActivitySid string) *CreateTaskQueueParams

func (*CreateTaskQueueParams) SetTargetWorkers

func (params *CreateTaskQueueParams) SetTargetWorkers(TargetWorkers string) *CreateTaskQueueParams

func (*CreateTaskQueueParams) SetTaskOrder

func (params *CreateTaskQueueParams) SetTaskOrder(TaskOrder string) *CreateTaskQueueParams

type CreateWorkerParams

type CreateWorkerParams struct {
	// The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.
	ActivitySid *string `json:"ActivitySid,omitempty"`
	// A valid JSON string that describes the new Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'CreateWorker'

func (*CreateWorkerParams) SetActivitySid

func (params *CreateWorkerParams) SetActivitySid(ActivitySid string) *CreateWorkerParams

func (*CreateWorkerParams) SetAttributes

func (params *CreateWorkerParams) SetAttributes(Attributes string) *CreateWorkerParams

func (*CreateWorkerParams) SetFriendlyName

func (params *CreateWorkerParams) SetFriendlyName(FriendlyName string) *CreateWorkerParams

type CreateWorkflowParams

type CreateWorkflowParams struct {
	// The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.
	AssignmentCallbackUrl *string `json:"AssignmentCallbackUrl,omitempty"`
	// A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.
	Configuration *string `json:"Configuration,omitempty"`
	// The URL that we should call when a call to the `assignment_callback_url` fails.
	FallbackAssignmentCallbackUrl *string `json:"FallbackAssignmentCallbackUrl,omitempty"`
	// A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.
	TaskReservationTimeout *int `json:"TaskReservationTimeout,omitempty"`
}

Optional parameters for the method 'CreateWorkflow'

func (*CreateWorkflowParams) SetAssignmentCallbackUrl

func (params *CreateWorkflowParams) SetAssignmentCallbackUrl(AssignmentCallbackUrl string) *CreateWorkflowParams

func (*CreateWorkflowParams) SetConfiguration

func (params *CreateWorkflowParams) SetConfiguration(Configuration string) *CreateWorkflowParams

func (*CreateWorkflowParams) SetFallbackAssignmentCallbackUrl

func (params *CreateWorkflowParams) SetFallbackAssignmentCallbackUrl(FallbackAssignmentCallbackUrl string) *CreateWorkflowParams

func (*CreateWorkflowParams) SetFriendlyName

func (params *CreateWorkflowParams) SetFriendlyName(FriendlyName string) *CreateWorkflowParams

func (*CreateWorkflowParams) SetTaskReservationTimeout

func (params *CreateWorkflowParams) SetTaskReservationTimeout(TaskReservationTimeout int) *CreateWorkflowParams

type CreateWorkspaceParams

type CreateWorkspaceParams struct {
	// The URL we should 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](https://www.twilio.com/docs/taskrouter/api/event) for more information.
	EventCallbackUrl *string `json:"EventCallbackUrl,omitempty"`
	// 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.
	EventsFilter *string `json:"EventsFilter,omitempty"`
	// A descriptive string that you create to describe the Workspace resource. It can be up to 64 characters long. For example: `Customer Support` or `2014 Election Campaign`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// 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](https://www.twilio.com/docs/taskrouter/multitasking).
	MultiTaskEnabled *bool `json:"MultiTaskEnabled,omitempty"`
	// 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](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
	PrioritizeQueueOrder *string `json:"PrioritizeQueueOrder,omitempty"`
	// An available template name. Can be: `NONE` or `FIFO` and the default is `NONE`. Pre-configures the Workspace with the Workflow and Activities specified in the template. `NONE` will create a Workspace with only a set of default activities. `FIFO` will configure TaskRouter with a set of default activities and a single TaskQueue for first-in, first-out distribution, which can be useful when you are getting started with TaskRouter.
	Template *string `json:"Template,omitempty"`
}

Optional parameters for the method 'CreateWorkspace'

func (*CreateWorkspaceParams) SetEventCallbackUrl

func (params *CreateWorkspaceParams) SetEventCallbackUrl(EventCallbackUrl string) *CreateWorkspaceParams

func (*CreateWorkspaceParams) SetEventsFilter

func (params *CreateWorkspaceParams) SetEventsFilter(EventsFilter string) *CreateWorkspaceParams

func (*CreateWorkspaceParams) SetFriendlyName

func (params *CreateWorkspaceParams) SetFriendlyName(FriendlyName string) *CreateWorkspaceParams

func (*CreateWorkspaceParams) SetMultiTaskEnabled

func (params *CreateWorkspaceParams) SetMultiTaskEnabled(MultiTaskEnabled bool) *CreateWorkspaceParams

func (*CreateWorkspaceParams) SetPrioritizeQueueOrder

func (params *CreateWorkspaceParams) SetPrioritizeQueueOrder(PrioritizeQueueOrder string) *CreateWorkspaceParams

func (*CreateWorkspaceParams) SetTemplate

func (params *CreateWorkspaceParams) SetTemplate(Template string) *CreateWorkspaceParams

type DeleteTaskParams

type DeleteTaskParams struct {
	// If provided, deletes this Task if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
}

Optional parameters for the method 'DeleteTask'

func (*DeleteTaskParams) SetIfMatch

func (params *DeleteTaskParams) SetIfMatch(IfMatch string) *DeleteTaskParams

type FetchTaskQueueCumulativeStatisticsParams

type FetchTaskQueueCumulativeStatisticsParams struct {
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default is 15 minutes.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchTaskQueueCumulativeStatistics'

func (*FetchTaskQueueCumulativeStatisticsParams) SetEndDate

func (*FetchTaskQueueCumulativeStatisticsParams) SetMinutes

func (*FetchTaskQueueCumulativeStatisticsParams) SetSplitByWaitTime

func (*FetchTaskQueueCumulativeStatisticsParams) SetStartDate

func (*FetchTaskQueueCumulativeStatisticsParams) SetTaskChannel

type FetchTaskQueueRealTimeStatisticsParams

type FetchTaskQueueRealTimeStatisticsParams struct {
	// The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchTaskQueueRealTimeStatistics'

func (*FetchTaskQueueRealTimeStatisticsParams) SetTaskChannel

type FetchTaskQueueStatisticsParams

type FetchTaskQueueStatisticsParams struct {
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default is 15 minutes.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate real-time and cumulative statistics for the specified TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchTaskQueueStatistics'

func (*FetchTaskQueueStatisticsParams) SetEndDate

func (*FetchTaskQueueStatisticsParams) SetMinutes

func (*FetchTaskQueueStatisticsParams) SetSplitByWaitTime

func (params *FetchTaskQueueStatisticsParams) SetSplitByWaitTime(SplitByWaitTime string) *FetchTaskQueueStatisticsParams

func (*FetchTaskQueueStatisticsParams) SetStartDate

func (*FetchTaskQueueStatisticsParams) SetTaskChannel

func (params *FetchTaskQueueStatisticsParams) SetTaskChannel(TaskChannel string) *FetchTaskQueueStatisticsParams

type FetchWorkerInstanceStatisticsParams

type FetchWorkerInstanceStatisticsParams struct {
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkerInstanceStatistics'

func (*FetchWorkerInstanceStatisticsParams) SetEndDate

func (*FetchWorkerInstanceStatisticsParams) SetMinutes

func (*FetchWorkerInstanceStatisticsParams) SetStartDate

func (*FetchWorkerInstanceStatisticsParams) SetTaskChannel

type FetchWorkerStatisticsParams

type FetchWorkerStatisticsParams struct {
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// The SID of the TaskQueue for which to fetch Worker statistics.
	TaskQueueSid *string `json:"TaskQueueSid,omitempty"`
	// The `friendly_name` of the TaskQueue for which to fetch Worker statistics.
	TaskQueueName *string `json:"TaskQueueName,omitempty"`
	// Only include Workers with `friendly_name` values that match this parameter.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkerStatistics'

func (*FetchWorkerStatisticsParams) SetEndDate

func (*FetchWorkerStatisticsParams) SetFriendlyName

func (params *FetchWorkerStatisticsParams) SetFriendlyName(FriendlyName string) *FetchWorkerStatisticsParams

func (*FetchWorkerStatisticsParams) SetMinutes

func (params *FetchWorkerStatisticsParams) SetMinutes(Minutes int) *FetchWorkerStatisticsParams

func (*FetchWorkerStatisticsParams) SetStartDate

func (params *FetchWorkerStatisticsParams) SetStartDate(StartDate time.Time) *FetchWorkerStatisticsParams

func (*FetchWorkerStatisticsParams) SetTaskChannel

func (params *FetchWorkerStatisticsParams) SetTaskChannel(TaskChannel string) *FetchWorkerStatisticsParams

func (*FetchWorkerStatisticsParams) SetTaskQueueName

func (params *FetchWorkerStatisticsParams) SetTaskQueueName(TaskQueueName string) *FetchWorkerStatisticsParams

func (*FetchWorkerStatisticsParams) SetTaskQueueSid

func (params *FetchWorkerStatisticsParams) SetTaskQueueSid(TaskQueueSid string) *FetchWorkerStatisticsParams

type FetchWorkersCumulativeStatisticsParams

type FetchWorkersCumulativeStatisticsParams struct {
	// Only calculate statistics from this date and time and earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkersCumulativeStatistics'

func (*FetchWorkersCumulativeStatisticsParams) SetEndDate

func (*FetchWorkersCumulativeStatisticsParams) SetMinutes

func (*FetchWorkersCumulativeStatisticsParams) SetStartDate

func (*FetchWorkersCumulativeStatisticsParams) SetTaskChannel

type FetchWorkersRealTimeStatisticsParams

type FetchWorkersRealTimeStatisticsParams struct {
	// Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkersRealTimeStatistics'

func (*FetchWorkersRealTimeStatisticsParams) SetTaskChannel

type FetchWorkflowCumulativeStatisticsParams

type FetchWorkflowCumulativeStatisticsParams struct {
	// Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchWorkflowCumulativeStatistics'

func (*FetchWorkflowCumulativeStatisticsParams) SetEndDate

func (*FetchWorkflowCumulativeStatisticsParams) SetMinutes

func (*FetchWorkflowCumulativeStatisticsParams) SetSplitByWaitTime

func (params *FetchWorkflowCumulativeStatisticsParams) SetSplitByWaitTime(SplitByWaitTime string) *FetchWorkflowCumulativeStatisticsParams

func (*FetchWorkflowCumulativeStatisticsParams) SetStartDate

func (*FetchWorkflowCumulativeStatisticsParams) SetTaskChannel

type FetchWorkflowRealTimeStatisticsParams

type FetchWorkflowRealTimeStatisticsParams struct {
	// Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkflowRealTimeStatistics'

func (*FetchWorkflowRealTimeStatisticsParams) SetTaskChannel

type FetchWorkflowStatisticsParams

type FetchWorkflowStatisticsParams struct {
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchWorkflowStatistics'

func (*FetchWorkflowStatisticsParams) SetEndDate

func (*FetchWorkflowStatisticsParams) SetMinutes

func (*FetchWorkflowStatisticsParams) SetSplitByWaitTime

func (params *FetchWorkflowStatisticsParams) SetSplitByWaitTime(SplitByWaitTime string) *FetchWorkflowStatisticsParams

func (*FetchWorkflowStatisticsParams) SetStartDate

func (params *FetchWorkflowStatisticsParams) SetStartDate(StartDate time.Time) *FetchWorkflowStatisticsParams

func (*FetchWorkflowStatisticsParams) SetTaskChannel

func (params *FetchWorkflowStatisticsParams) SetTaskChannel(TaskChannel string) *FetchWorkflowStatisticsParams

type FetchWorkspaceCumulativeStatisticsParams

type FetchWorkspaceCumulativeStatisticsParams struct {
	// Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchWorkspaceCumulativeStatistics'

func (*FetchWorkspaceCumulativeStatisticsParams) SetEndDate

func (*FetchWorkspaceCumulativeStatisticsParams) SetMinutes

func (*FetchWorkspaceCumulativeStatisticsParams) SetSplitByWaitTime

func (*FetchWorkspaceCumulativeStatisticsParams) SetStartDate

func (*FetchWorkspaceCumulativeStatisticsParams) SetTaskChannel

type FetchWorkspaceRealTimeStatisticsParams

type FetchWorkspaceRealTimeStatisticsParams struct {
	// Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'FetchWorkspaceRealTimeStatistics'

func (*FetchWorkspaceRealTimeStatisticsParams) SetTaskChannel

type FetchWorkspaceStatisticsParams

type FetchWorkspaceStatisticsParams struct {
	// Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
}

Optional parameters for the method 'FetchWorkspaceStatistics'

func (*FetchWorkspaceStatisticsParams) SetEndDate

func (*FetchWorkspaceStatisticsParams) SetMinutes

func (*FetchWorkspaceStatisticsParams) SetSplitByWaitTime

func (params *FetchWorkspaceStatisticsParams) SetSplitByWaitTime(SplitByWaitTime string) *FetchWorkspaceStatisticsParams

func (*FetchWorkspaceStatisticsParams) SetStartDate

func (*FetchWorkspaceStatisticsParams) SetTaskChannel

func (params *FetchWorkspaceStatisticsParams) SetTaskChannel(TaskChannel string) *FetchWorkspaceStatisticsParams

type ListActivityParams

type ListActivityParams struct {
	// The `friendly_name` of the Activity resources to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.
	Available *string `json:"Available,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListActivity'

func (*ListActivityParams) SetAvailable

func (params *ListActivityParams) SetAvailable(Available string) *ListActivityParams

func (*ListActivityParams) SetFriendlyName

func (params *ListActivityParams) SetFriendlyName(FriendlyName string) *ListActivityParams

func (*ListActivityParams) SetLimit added in v0.13.0

func (params *ListActivityParams) SetLimit(Limit int) *ListActivityParams

func (*ListActivityParams) SetPageSize

func (params *ListActivityParams) SetPageSize(PageSize int) *ListActivityParams

type ListActivityResponse

type ListActivityResponse struct {
	Activities []TaskrouterV1Activity    `json:"activities,omitempty"`
	Meta       ListWorkspaceResponseMeta `json:"meta,omitempty"`
}

ListActivityResponse struct for ListActivityResponse

type ListEventParams

type ListEventParams struct {
	// Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// The type of Events to read. Returns only Events of the type specified.
	EventType *string `json:"EventType,omitempty"`
	// The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted.
	Minutes *int `json:"Minutes,omitempty"`
	// The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.
	ReservationSid *string `json:"ReservationSid,omitempty"`
	// Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Task Attributes for Events older than 30 days will be redacted.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.
	TaskQueueSid *string `json:"TaskQueueSid,omitempty"`
	// The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.
	TaskSid *string `json:"TaskSid,omitempty"`
	// The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.
	WorkerSid *string `json:"WorkerSid,omitempty"`
	// The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.
	WorkflowSid *string `json:"WorkflowSid,omitempty"`
	// The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// The SID of the Event resource to read.
	Sid *string `json:"Sid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEvent'

func (*ListEventParams) SetEndDate

func (params *ListEventParams) SetEndDate(EndDate time.Time) *ListEventParams

func (*ListEventParams) SetEventType

func (params *ListEventParams) SetEventType(EventType string) *ListEventParams

func (*ListEventParams) SetLimit added in v0.13.0

func (params *ListEventParams) SetLimit(Limit int) *ListEventParams

func (*ListEventParams) SetMinutes

func (params *ListEventParams) SetMinutes(Minutes int) *ListEventParams

func (*ListEventParams) SetPageSize

func (params *ListEventParams) SetPageSize(PageSize int) *ListEventParams

func (*ListEventParams) SetReservationSid

func (params *ListEventParams) SetReservationSid(ReservationSid string) *ListEventParams

func (*ListEventParams) SetSid

func (params *ListEventParams) SetSid(Sid string) *ListEventParams

func (*ListEventParams) SetStartDate

func (params *ListEventParams) SetStartDate(StartDate time.Time) *ListEventParams

func (*ListEventParams) SetTaskChannel

func (params *ListEventParams) SetTaskChannel(TaskChannel string) *ListEventParams

func (*ListEventParams) SetTaskQueueSid

func (params *ListEventParams) SetTaskQueueSid(TaskQueueSid string) *ListEventParams

func (*ListEventParams) SetTaskSid

func (params *ListEventParams) SetTaskSid(TaskSid string) *ListEventParams

func (*ListEventParams) SetWorkerSid

func (params *ListEventParams) SetWorkerSid(WorkerSid string) *ListEventParams

func (*ListEventParams) SetWorkflowSid

func (params *ListEventParams) SetWorkflowSid(WorkflowSid string) *ListEventParams

type ListEventResponse

type ListEventResponse struct {
	Events []TaskrouterV1Event       `json:"events,omitempty"`
	Meta   ListWorkspaceResponseMeta `json:"meta,omitempty"`
}

ListEventResponse struct for ListEventResponse

type ListTaskChannelParams

type ListTaskChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListTaskChannel'

func (*ListTaskChannelParams) SetLimit added in v0.13.0

func (params *ListTaskChannelParams) SetLimit(Limit int) *ListTaskChannelParams

func (*ListTaskChannelParams) SetPageSize

func (params *ListTaskChannelParams) SetPageSize(PageSize int) *ListTaskChannelParams

type ListTaskChannelResponse

type ListTaskChannelResponse struct {
	Channels []TaskrouterV1TaskChannel `json:"channels,omitempty"`
	Meta     ListWorkspaceResponseMeta `json:"meta,omitempty"`
}

ListTaskChannelResponse struct for ListTaskChannelResponse

type ListTaskParams

type ListTaskParams struct {
	// The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.
	Priority *int `json:"Priority,omitempty"`
	// The `assignment_status` of the Tasks you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.
	AssignmentStatus *[]string `json:"AssignmentStatus,omitempty"`
	// The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.
	WorkflowSid *string `json:"WorkflowSid,omitempty"`
	// The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.
	WorkflowName *string `json:"WorkflowName,omitempty"`
	// The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.
	TaskQueueSid *string `json:"TaskQueueSid,omitempty"`
	// The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.
	TaskQueueName *string `json:"TaskQueueName,omitempty"`
	// The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.
	EvaluateTaskAttributes *string `json:"EvaluateTaskAttributes,omitempty"`
	// How to order the returned Task resources. y default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Multiple sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order.
	Ordering *string `json:"Ordering,omitempty"`
	// Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.
	HasAddons *bool `json:"HasAddons,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListTask'

func (*ListTaskParams) SetAssignmentStatus

func (params *ListTaskParams) SetAssignmentStatus(AssignmentStatus []string) *ListTaskParams

func (*ListTaskParams) SetEvaluateTaskAttributes

func (params *ListTaskParams) SetEvaluateTaskAttributes(EvaluateTaskAttributes string) *ListTaskParams

func (*ListTaskParams) SetHasAddons

func (params *ListTaskParams) SetHasAddons(HasAddons bool) *ListTaskParams

func (*ListTaskParams) SetLimit added in v0.13.0

func (params *ListTaskParams) SetLimit(Limit int) *ListTaskParams

func (*ListTaskParams) SetOrdering

func (params *ListTaskParams) SetOrdering(Ordering string) *ListTaskParams

func (*ListTaskParams) SetPageSize

func (params *ListTaskParams) SetPageSize(PageSize int) *ListTaskParams

func (*ListTaskParams) SetPriority

func (params *ListTaskParams) SetPriority(Priority int) *ListTaskParams

func (*ListTaskParams) SetTaskQueueName

func (params *ListTaskParams) SetTaskQueueName(TaskQueueName string) *ListTaskParams

func (*ListTaskParams) SetTaskQueueSid

func (params *ListTaskParams) SetTaskQueueSid(TaskQueueSid string) *ListTaskParams

func (*ListTaskParams) SetWorkflowName

func (params *ListTaskParams) SetWorkflowName(WorkflowName string) *ListTaskParams

func (*ListTaskParams) SetWorkflowSid

func (params *ListTaskParams) SetWorkflowSid(WorkflowSid string) *ListTaskParams

type ListTaskQueueParams

type ListTaskQueueParams struct {
	// The `friendly_name` of the TaskQueue resources to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.
	EvaluateWorkerAttributes *string `json:"EvaluateWorkerAttributes,omitempty"`
	// The SID of the Worker with the TaskQueue resources to read.
	WorkerSid *string `json:"WorkerSid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListTaskQueue'

func (*ListTaskQueueParams) SetEvaluateWorkerAttributes

func (params *ListTaskQueueParams) SetEvaluateWorkerAttributes(EvaluateWorkerAttributes string) *ListTaskQueueParams

func (*ListTaskQueueParams) SetFriendlyName

func (params *ListTaskQueueParams) SetFriendlyName(FriendlyName string) *ListTaskQueueParams

func (*ListTaskQueueParams) SetLimit added in v0.13.0

func (params *ListTaskQueueParams) SetLimit(Limit int) *ListTaskQueueParams

func (*ListTaskQueueParams) SetPageSize

func (params *ListTaskQueueParams) SetPageSize(PageSize int) *ListTaskQueueParams

func (*ListTaskQueueParams) SetWorkerSid

func (params *ListTaskQueueParams) SetWorkerSid(WorkerSid string) *ListTaskQueueParams

type ListTaskQueueResponse

type ListTaskQueueResponse struct {
	Meta       ListWorkspaceResponseMeta `json:"meta,omitempty"`
	TaskQueues []TaskrouterV1TaskQueue   `json:"task_queues,omitempty"`
}

ListTaskQueueResponse struct for ListTaskQueueResponse

type ListTaskQueuesStatisticsParams

type ListTaskQueuesStatisticsParams struct {
	// Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
	EndDate *time.Time `json:"EndDate,omitempty"`
	// The `friendly_name` of the TaskQueue statistics to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Only calculate statistics since this many minutes in the past. The default is 15 minutes.
	Minutes *int `json:"Minutes,omitempty"`
	// Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	StartDate *time.Time `json:"StartDate,omitempty"`
	// Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
	// A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
	SplitByWaitTime *string `json:"SplitByWaitTime,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListTaskQueuesStatistics'

func (*ListTaskQueuesStatisticsParams) SetEndDate

func (*ListTaskQueuesStatisticsParams) SetFriendlyName

func (params *ListTaskQueuesStatisticsParams) SetFriendlyName(FriendlyName string) *ListTaskQueuesStatisticsParams

func (*ListTaskQueuesStatisticsParams) SetLimit added in v0.13.0

func (*ListTaskQueuesStatisticsParams) SetMinutes

func (*ListTaskQueuesStatisticsParams) SetPageSize

func (params *ListTaskQueuesStatisticsParams) SetPageSize(PageSize int) *ListTaskQueuesStatisticsParams

func (*ListTaskQueuesStatisticsParams) SetSplitByWaitTime

func (params *ListTaskQueuesStatisticsParams) SetSplitByWaitTime(SplitByWaitTime string) *ListTaskQueuesStatisticsParams

func (*ListTaskQueuesStatisticsParams) SetStartDate

func (*ListTaskQueuesStatisticsParams) SetTaskChannel

func (params *ListTaskQueuesStatisticsParams) SetTaskChannel(TaskChannel string) *ListTaskQueuesStatisticsParams

type ListTaskQueuesStatisticsResponse

type ListTaskQueuesStatisticsResponse struct {
	Meta                 ListWorkspaceResponseMeta          `json:"meta,omitempty"`
	TaskQueuesStatistics []TaskrouterV1TaskQueuesStatistics `json:"task_queues_statistics,omitempty"`
}

ListTaskQueuesStatisticsResponse struct for ListTaskQueuesStatisticsResponse

type ListTaskReservationParams

type ListTaskReservationParams struct {
	// Returns the list of reservations for a task with a specified ReservationStatus.  Can be: `pending`, `accepted`, `rejected`, or `timeout`.
	ReservationStatus *string `json:"ReservationStatus,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListTaskReservation'

func (*ListTaskReservationParams) SetLimit added in v0.13.0

func (params *ListTaskReservationParams) SetLimit(Limit int) *ListTaskReservationParams

func (*ListTaskReservationParams) SetPageSize

func (params *ListTaskReservationParams) SetPageSize(PageSize int) *ListTaskReservationParams

func (*ListTaskReservationParams) SetReservationStatus

func (params *ListTaskReservationParams) SetReservationStatus(ReservationStatus string) *ListTaskReservationParams

type ListTaskReservationResponse

type ListTaskReservationResponse struct {
	Meta         ListWorkspaceResponseMeta     `json:"meta,omitempty"`
	Reservations []TaskrouterV1TaskReservation `json:"reservations,omitempty"`
}

ListTaskReservationResponse struct for ListTaskReservationResponse

type ListTaskResponse

type ListTaskResponse struct {
	Meta  ListWorkspaceResponseMeta `json:"meta,omitempty"`
	Tasks []TaskrouterV1Task        `json:"tasks,omitempty"`
}

ListTaskResponse struct for ListTaskResponse

type ListWorkerChannelParams

type ListWorkerChannelParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWorkerChannel'

func (*ListWorkerChannelParams) SetLimit added in v0.13.0

func (params *ListWorkerChannelParams) SetLimit(Limit int) *ListWorkerChannelParams

func (*ListWorkerChannelParams) SetPageSize

func (params *ListWorkerChannelParams) SetPageSize(PageSize int) *ListWorkerChannelParams

type ListWorkerChannelResponse

type ListWorkerChannelResponse struct {
	Channels []TaskrouterV1WorkerChannel `json:"channels,omitempty"`
	Meta     ListWorkspaceResponseMeta   `json:"meta,omitempty"`
}

ListWorkerChannelResponse struct for ListWorkerChannelResponse

type ListWorkerParams

type ListWorkerParams struct {
	// The `activity_name` of the Worker resources to read.
	ActivityName *string `json:"ActivityName,omitempty"`
	// The `activity_sid` of the Worker resources to read.
	ActivitySid *string `json:"ActivitySid,omitempty"`
	// Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
	Available *string `json:"Available,omitempty"`
	// The `friendly_name` of the Worker resources to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
	TargetWorkersExpression *string `json:"TargetWorkersExpression,omitempty"`
	// The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
	TaskQueueName *string `json:"TaskQueueName,omitempty"`
	// The SID of the TaskQueue that the Workers to read are eligible for.
	TaskQueueSid *string `json:"TaskQueueSid,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWorker'

func (*ListWorkerParams) SetActivityName

func (params *ListWorkerParams) SetActivityName(ActivityName string) *ListWorkerParams

func (*ListWorkerParams) SetActivitySid

func (params *ListWorkerParams) SetActivitySid(ActivitySid string) *ListWorkerParams

func (*ListWorkerParams) SetAvailable

func (params *ListWorkerParams) SetAvailable(Available string) *ListWorkerParams

func (*ListWorkerParams) SetFriendlyName

func (params *ListWorkerParams) SetFriendlyName(FriendlyName string) *ListWorkerParams

func (*ListWorkerParams) SetLimit added in v0.13.0

func (params *ListWorkerParams) SetLimit(Limit int) *ListWorkerParams

func (*ListWorkerParams) SetPageSize

func (params *ListWorkerParams) SetPageSize(PageSize int) *ListWorkerParams

func (*ListWorkerParams) SetTargetWorkersExpression

func (params *ListWorkerParams) SetTargetWorkersExpression(TargetWorkersExpression string) *ListWorkerParams

func (*ListWorkerParams) SetTaskQueueName

func (params *ListWorkerParams) SetTaskQueueName(TaskQueueName string) *ListWorkerParams

func (*ListWorkerParams) SetTaskQueueSid

func (params *ListWorkerParams) SetTaskQueueSid(TaskQueueSid string) *ListWorkerParams

type ListWorkerReservationParams

type ListWorkerReservationParams struct {
	// Returns the list of reservations for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.
	ReservationStatus *string `json:"ReservationStatus,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWorkerReservation'

func (*ListWorkerReservationParams) SetLimit added in v0.13.0

func (*ListWorkerReservationParams) SetPageSize

func (params *ListWorkerReservationParams) SetPageSize(PageSize int) *ListWorkerReservationParams

func (*ListWorkerReservationParams) SetReservationStatus

func (params *ListWorkerReservationParams) SetReservationStatus(ReservationStatus string) *ListWorkerReservationParams

type ListWorkerReservationResponse

type ListWorkerReservationResponse struct {
	Meta         ListWorkspaceResponseMeta       `json:"meta,omitempty"`
	Reservations []TaskrouterV1WorkerReservation `json:"reservations,omitempty"`
}

ListWorkerReservationResponse struct for ListWorkerReservationResponse

type ListWorkerResponse

type ListWorkerResponse struct {
	Meta    ListWorkspaceResponseMeta `json:"meta,omitempty"`
	Workers []TaskrouterV1Worker      `json:"workers,omitempty"`
}

ListWorkerResponse struct for ListWorkerResponse

type ListWorkflowParams

type ListWorkflowParams struct {
	// The `friendly_name` of the Workflow resources to read.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWorkflow'

func (*ListWorkflowParams) SetFriendlyName

func (params *ListWorkflowParams) SetFriendlyName(FriendlyName string) *ListWorkflowParams

func (*ListWorkflowParams) SetLimit added in v0.13.0

func (params *ListWorkflowParams) SetLimit(Limit int) *ListWorkflowParams

func (*ListWorkflowParams) SetPageSize

func (params *ListWorkflowParams) SetPageSize(PageSize int) *ListWorkflowParams

type ListWorkflowResponse

type ListWorkflowResponse struct {
	Meta      ListWorkspaceResponseMeta `json:"meta,omitempty"`
	Workflows []TaskrouterV1Workflow    `json:"workflows,omitempty"`
}

ListWorkflowResponse struct for ListWorkflowResponse

type ListWorkspaceParams

type ListWorkspaceParams struct {
	// The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWorkspace'

func (*ListWorkspaceParams) SetFriendlyName

func (params *ListWorkspaceParams) SetFriendlyName(FriendlyName string) *ListWorkspaceParams

func (*ListWorkspaceParams) SetLimit added in v0.13.0

func (params *ListWorkspaceParams) SetLimit(Limit int) *ListWorkspaceParams

func (*ListWorkspaceParams) SetPageSize

func (params *ListWorkspaceParams) SetPageSize(PageSize int) *ListWorkspaceParams

type ListWorkspaceResponse

type ListWorkspaceResponse struct {
	Meta       ListWorkspaceResponseMeta `json:"meta,omitempty"`
	Workspaces []TaskrouterV1Workspace   `json:"workspaces,omitempty"`
}

ListWorkspaceResponse struct for ListWorkspaceResponse

type ListWorkspaceResponseMeta

type ListWorkspaceResponseMeta struct {
	FirstPageUrl    string `json:"first_page_url,omitempty"`
	Key             string `json:"key,omitempty"`
	NextPageUrl     string `json:"next_page_url,omitempty"`
	Page            int    `json:"page,omitempty"`
	PageSize        int    `json:"page_size,omitempty"`
	PreviousPageUrl string `json:"previous_page_url,omitempty"`
	Url             string `json:"url,omitempty"`
}

ListWorkspaceResponseMeta struct for ListWorkspaceResponseMeta

type TaskrouterV1Activity added in v0.14.0

type TaskrouterV1Activity struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Whether the Worker should be eligible to receive a Task when it occupies the Activity
	Available *bool `json:"available,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the Activity resource
	FriendlyName *string                 `json:"friendly_name,omitempty"`
	Links        *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Activity resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Activity
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1Activity struct for TaskrouterV1Activity

type TaskrouterV1Event added in v0.14.0

type TaskrouterV1Event struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the resource that triggered the event
	ActorSid *string `json:"actor_sid,omitempty"`
	// The type of resource that triggered the event
	ActorType *string `json:"actor_type,omitempty"`
	// The absolute URL of the resource that triggered the event
	ActorUrl *string `json:"actor_url,omitempty"`
	// A description of the event
	Description *string `json:"description,omitempty"`
	// Data about the event
	EventData *map[string]interface{} `json:"event_data,omitempty"`
	// The time the event was sent
	EventDate *time.Time `json:"event_date,omitempty"`
	// The time the event was sent in milliseconds
	EventDateMs *int `json:"event_date_ms,omitempty"`
	// The identifier for the event
	EventType *string `json:"event_type,omitempty"`
	// The SID of the object the event is most relevant to
	ResourceSid *string `json:"resource_sid,omitempty"`
	// The type of object the event is most relevant to
	ResourceType *string `json:"resource_type,omitempty"`
	// The URL of the resource the event is most relevant to
	ResourceUrl *string `json:"resource_url,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// Where the Event originated
	Source *string `json:"source,omitempty"`
	// The IP from which the Event originated
	SourceIpAddress *string `json:"source_ip_address,omitempty"`
	// The absolute URL of the Event resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Event
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1Event struct for TaskrouterV1Event

type TaskrouterV1Task added in v0.14.0

type TaskrouterV1Task struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the addon data for all installed addons
	Addons *string `json:"addons,omitempty"`
	// The number of seconds since the Task was created
	Age *int `json:"age,omitempty"`
	// The current status of the Task's assignment
	AssignmentStatus *string `json:"assignment_status,omitempty"`
	// The JSON string with custom attributes of the work
	Attributes *string `json:"attributes,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// Retrieve the list of all Tasks in the Workspace with the specified priority
	Priority *int `json:"priority,omitempty"`
	// The reason the Task was canceled or completed
	Reason *string `json:"reason,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the TaskChannel
	TaskChannelSid *string `json:"task_channel_sid,omitempty"`
	// The unique name of the TaskChannel
	TaskChannelUniqueName *string `json:"task_channel_unique_name,omitempty"`
	// The ISO 8601 date and time in GMT when the Task entered the TaskQueue.
	TaskQueueEnteredDate *time.Time `json:"task_queue_entered_date,omitempty"`
	// The friendly name of the TaskQueue
	TaskQueueFriendlyName *string `json:"task_queue_friendly_name,omitempty"`
	// The SID of the TaskQueue
	TaskQueueSid *string `json:"task_queue_sid,omitempty"`
	// The amount of time in seconds that the Task can live before being assigned
	Timeout *int `json:"timeout,omitempty"`
	// The absolute URL of the Task resource
	Url *string `json:"url,omitempty"`
	// The friendly name of the Workflow that is controlling the Task
	WorkflowFriendlyName *string `json:"workflow_friendly_name,omitempty"`
	// The SID of the Workflow that is controlling the Task
	WorkflowSid *string `json:"workflow_sid,omitempty"`
	// The SID of the Workspace that contains the Task
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1Task struct for TaskrouterV1Task

type TaskrouterV1TaskChannel added in v0.14.0

type TaskrouterV1TaskChannel struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Whether the Task Channel will prioritize Workers that have been idle
	ChannelOptimizedRouting *bool `json:"channel_optimized_routing,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the Task Channel
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Task Channel resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Task Channel
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskChannel struct for TaskrouterV1TaskChannel

type TaskrouterV1TaskQueue added in v0.14.0

type TaskrouterV1TaskQueue struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The name of the Activity to assign Workers when a task is assigned for them
	AssignmentActivityName *string `json:"assignment_activity_name,omitempty"`
	// The SID of the Activity to assign Workers when a task is assigned for them
	AssignmentActivitySid *string `json:"assignment_activity_sid,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The maximum number of Workers to reserve
	MaxReservedWorkers *int `json:"max_reserved_workers,omitempty"`
	// The name of the Activity to assign Workers once a task is reserved for them
	ReservationActivityName *string `json:"reservation_activity_name,omitempty"`
	// The SID of the Activity to assign Workers once a task is reserved for them
	ReservationActivitySid *string `json:"reservation_activity_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// A string describing the Worker selection criteria for any Tasks that enter the TaskQueue
	TargetWorkers *string `json:"target_workers,omitempty"`
	// How Tasks will be assigned to Workers
	TaskOrder *string `json:"task_order,omitempty"`
	// The absolute URL of the TaskQueue resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the TaskQueue
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskQueue struct for TaskrouterV1TaskQueue

type TaskrouterV1TaskQueueCumulativeStatistics added in v0.14.0

type TaskrouterV1TaskQueueCumulativeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The average time in seconds between Task creation and acceptance
	AvgTaskAcceptanceTime *int `json:"avg_task_acceptance_time,omitempty"`
	// The end of the interval during which these statistics were calculated
	EndTime *time.Time `json:"end_time,omitempty"`
	// The total number of Reservations accepted for Tasks in the TaskQueue
	ReservationsAccepted *int `json:"reservations_accepted,omitempty"`
	// The total number of Reservations canceled for Tasks in the TaskQueue
	ReservationsCanceled *int `json:"reservations_canceled,omitempty"`
	// The total number of Reservations created for Tasks in the TaskQueue
	ReservationsCreated *int `json:"reservations_created,omitempty"`
	// The total number of Reservations rejected for Tasks in the TaskQueue
	ReservationsRejected *int `json:"reservations_rejected,omitempty"`
	// The total number of Reservations rescinded
	ReservationsRescinded *int `json:"reservations_rescinded,omitempty"`
	// The total number of Reservations that timed out for Tasks in the TaskQueue
	ReservationsTimedOut *int `json:"reservations_timed_out,omitempty"`
	// A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
	SplitByWaitTime *map[string]interface{} `json:"split_by_wait_time,omitempty"`
	// The beginning of the interval during which these statistics were calculated
	StartTime *time.Time `json:"start_time,omitempty"`
	// The SID of the TaskQueue from which these statistics were calculated
	TaskQueueSid *string `json:"task_queue_sid,omitempty"`
	// The total number of Tasks canceled in the TaskQueue
	TasksCanceled *int `json:"tasks_canceled,omitempty"`
	// The total number of Tasks completed in the TaskQueue
	TasksCompleted *int `json:"tasks_completed,omitempty"`
	// The total number of Tasks deleted in the TaskQueue
	TasksDeleted *int `json:"tasks_deleted,omitempty"`
	// The total number of Tasks entered into the TaskQueue
	TasksEntered *int `json:"tasks_entered,omitempty"`
	// The total number of Tasks that were moved from one queue to another
	TasksMoved *int `json:"tasks_moved,omitempty"`
	// The absolute URL of the TaskQueue statistics resource
	Url *string `json:"url,omitempty"`
	// The relative wait duration statistics for Tasks accepted while in the TaskQueue
	WaitDurationInQueueUntilAccepted *map[string]interface{} `json:"wait_duration_in_queue_until_accepted,omitempty"`
	// The wait duration statistics for Tasks accepted while in the TaskQueue
	WaitDurationUntilAccepted *map[string]interface{} `json:"wait_duration_until_accepted,omitempty"`
	// The wait duration statistics for Tasks canceled while in the TaskQueue
	WaitDurationUntilCanceled *map[string]interface{} `json:"wait_duration_until_canceled,omitempty"`
	// The SID of the Workspace that contains the TaskQueue
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskQueueCumulativeStatistics struct for TaskrouterV1TaskQueueCumulativeStatistics

type TaskrouterV1TaskQueueRealTimeStatistics added in v0.14.0

type TaskrouterV1TaskQueueRealTimeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The number of current Workers by Activity
	ActivityStatistics *[]map[string]interface{} `json:"activity_statistics,omitempty"`
	// The relative age in the TaskQueue for the longest waiting Task.
	LongestRelativeTaskAgeInQueue *int `json:"longest_relative_task_age_in_queue,omitempty"`
	// The SID of the Task waiting in the TaskQueue the longest.
	LongestRelativeTaskSidInQueue *string `json:"longest_relative_task_sid_in_queue,omitempty"`
	// The age of the longest waiting Task
	LongestTaskWaitingAge *int `json:"longest_task_waiting_age,omitempty"`
	// The SID of the longest waiting Task
	LongestTaskWaitingSid *string `json:"longest_task_waiting_sid,omitempty"`
	// The SID of the TaskQueue from which these statistics were calculated
	TaskQueueSid *string `json:"task_queue_sid,omitempty"`
	// The number of Tasks by priority
	TasksByPriority *map[string]interface{} `json:"tasks_by_priority,omitempty"`
	// The number of Tasks by their current status
	TasksByStatus *map[string]interface{} `json:"tasks_by_status,omitempty"`
	// The total number of Workers available for Tasks in the TaskQueue
	TotalAvailableWorkers *int `json:"total_available_workers,omitempty"`
	// The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state
	TotalEligibleWorkers *int `json:"total_eligible_workers,omitempty"`
	// The total number of Tasks
	TotalTasks *int `json:"total_tasks,omitempty"`
	// The absolute URL of the TaskQueue statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the TaskQueue
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskQueueRealTimeStatistics struct for TaskrouterV1TaskQueueRealTimeStatistics

type TaskrouterV1TaskQueueStatistics added in v0.14.0

type TaskrouterV1TaskQueueStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the TaskQueue
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// An object that contains the real-time statistics for the TaskQueue
	Realtime *map[string]interface{} `json:"realtime,omitempty"`
	// The SID of the TaskQueue from which these statistics were calculated
	TaskQueueSid *string `json:"task_queue_sid,omitempty"`
	// The absolute URL of the TaskQueue statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the TaskQueue
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskQueueStatistics struct for TaskrouterV1TaskQueueStatistics

type TaskrouterV1TaskQueuesStatistics added in v0.14.0

type TaskrouterV1TaskQueuesStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the TaskQueues
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// An object that contains the real-time statistics for the TaskQueues
	Realtime *map[string]interface{} `json:"realtime,omitempty"`
	// The SID of the TaskQueue from which these statistics were calculated
	TaskQueueSid *string `json:"task_queue_sid,omitempty"`
	// The SID of the Workspace that contains the TaskQueues
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskQueuesStatistics struct for TaskrouterV1TaskQueuesStatistics

type TaskrouterV1TaskReservation added in v0.14.0

type TaskrouterV1TaskReservation struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The current status of the reservation
	ReservationStatus *string `json:"reservation_status,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the reserved Task resource
	TaskSid *string `json:"task_sid,omitempty"`
	// The absolute URL of the TaskReservation reservation
	Url *string `json:"url,omitempty"`
	// The friendly_name of the Worker that is reserved
	WorkerName *string `json:"worker_name,omitempty"`
	// The SID of the reserved Worker resource
	WorkerSid *string `json:"worker_sid,omitempty"`
	// The SID of the Workspace that this task is contained within.
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1TaskReservation struct for TaskrouterV1TaskReservation

type TaskrouterV1Worker added in v0.14.0

type TaskrouterV1Worker struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The friendly_name of the Worker's current Activity
	ActivityName *string `json:"activity_name,omitempty"`
	// The SID of the Worker's current Activity
	ActivitySid *string `json:"activity_sid,omitempty"`
	// The JSON string that describes the Worker
	Attributes *string `json:"attributes,omitempty"`
	// Whether the Worker is available to perform tasks
	Available *bool `json:"available,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT of the last change to the Worker's activity
	DateStatusChanged *time.Time `json:"date_status_changed,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The absolute URL of the Worker resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Worker
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1Worker struct for TaskrouterV1Worker

type TaskrouterV1WorkerChannel added in v0.14.0

type TaskrouterV1WorkerChannel struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The total number of Tasks assigned to Worker for the TaskChannel type
	AssignedTasks *int `json:"assigned_tasks,omitempty"`
	// Whether the Worker should receive Tasks of the TaskChannel type
	Available *bool `json:"available,omitempty"`
	// The current available capacity between 0 to 100 for the TaskChannel
	AvailableCapacityPercentage *int `json:"available_capacity_percentage,omitempty"`
	// The current configured capacity for the WorkerChannel
	ConfiguredCapacity *int `json:"configured_capacity,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the TaskChannel
	TaskChannelSid *string `json:"task_channel_sid,omitempty"`
	// The unique name of the TaskChannel, such as 'voice' or 'sms'
	TaskChannelUniqueName *string `json:"task_channel_unique_name,omitempty"`
	// The absolute URL of the WorkerChannel resource
	Url *string `json:"url,omitempty"`
	// The SID of the Worker that contains the WorkerChannel
	WorkerSid *string `json:"worker_sid,omitempty"`
	// The SID of the Workspace that contains the WorkerChannel
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkerChannel struct for TaskrouterV1WorkerChannel

type TaskrouterV1WorkerInstanceStatistics added in v0.14.0

type TaskrouterV1WorkerInstanceStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the Worker
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// The absolute URL of the WorkerChannel statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Worker that contains the WorkerChannel
	WorkerSid *string `json:"worker_sid,omitempty"`
	// The SID of the Workspace that contains the WorkerChannel
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkerInstanceStatistics struct for TaskrouterV1WorkerInstanceStatistics

type TaskrouterV1WorkerReservation added in v0.14.0

type TaskrouterV1WorkerReservation struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The current status of the reservation
	ReservationStatus *string `json:"reservation_status,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The SID of the reserved Task resource
	TaskSid *string `json:"task_sid,omitempty"`
	// The absolute URL of the WorkerReservation resource
	Url *string `json:"url,omitempty"`
	// The friendly_name of the Worker that is reserved
	WorkerName *string `json:"worker_name,omitempty"`
	// The SID of the reserved Worker resource
	WorkerSid *string `json:"worker_sid,omitempty"`
	// The SID of the Workspace that this worker is contained within.
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkerReservation struct for TaskrouterV1WorkerReservation

type TaskrouterV1WorkerStatistics added in v0.14.0

type TaskrouterV1WorkerStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the Worker
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// An object that contains the real-time statistics for the Worker
	Realtime *map[string]interface{} `json:"realtime,omitempty"`
	// The absolute URL of the Worker statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Worker
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkerStatistics struct for TaskrouterV1WorkerStatistics

type TaskrouterV1WorkersCumulativeStatistics added in v0.14.0

type TaskrouterV1WorkersCumulativeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The minimum, average, maximum, and total time that Workers spent in each Activity
	ActivityDurations *[]map[string]interface{} `json:"activity_durations,omitempty"`
	// The end of the interval during which these statistics were calculated
	EndTime *time.Time `json:"end_time,omitempty"`
	// The total number of Reservations that were accepted
	ReservationsAccepted *int `json:"reservations_accepted,omitempty"`
	// The total number of Reservations that were canceled
	ReservationsCanceled *int `json:"reservations_canceled,omitempty"`
	// The total number of Reservations that were created
	ReservationsCreated *int `json:"reservations_created,omitempty"`
	// The total number of Reservations that were rejected
	ReservationsRejected *int `json:"reservations_rejected,omitempty"`
	// The total number of Reservations that were rescinded
	ReservationsRescinded *int `json:"reservations_rescinded,omitempty"`
	// The total number of Reservations that were timed out
	ReservationsTimedOut *int `json:"reservations_timed_out,omitempty"`
	// The beginning of the interval during which these statistics were calculated
	StartTime *time.Time `json:"start_time,omitempty"`
	// The absolute URL of the Workers statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Workers
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkersCumulativeStatistics struct for TaskrouterV1WorkersCumulativeStatistics

type TaskrouterV1WorkersRealTimeStatistics added in v0.14.0

type TaskrouterV1WorkersRealTimeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The number of current Workers by Activity
	ActivityStatistics *[]map[string]interface{} `json:"activity_statistics,omitempty"`
	// The total number of Workers
	TotalWorkers *int `json:"total_workers,omitempty"`
	// The absolute URL of the Workers statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Workers
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkersRealTimeStatistics struct for TaskrouterV1WorkersRealTimeStatistics

type TaskrouterV1Workflow added in v0.14.0

type TaskrouterV1Workflow struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The URL that we call when a task managed by the Workflow is assigned to a Worker
	AssignmentCallbackUrl *string `json:"assignment_callback_url,omitempty"`
	// A JSON string that contains the Workflow's configuration
	Configuration *string `json:"configuration,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The RFC 2822 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The MIME type of the document
	DocumentContentType *string `json:"document_content_type,omitempty"`
	// The URL that we call when a call to the `assignment_callback_url` fails
	FallbackAssignmentCallbackUrl *string `json:"fallback_assignment_callback_url,omitempty"`
	// The string that you assigned to describe the Workflow resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker
	TaskReservationTimeout *int `json:"task_reservation_timeout,omitempty"`
	// The absolute URL of the Workflow resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace that contains the Workflow
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1Workflow struct for TaskrouterV1Workflow

type TaskrouterV1WorkflowCumulativeStatistics added in v0.14.0

type TaskrouterV1WorkflowCumulativeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The average time in seconds between Task creation and acceptance
	AvgTaskAcceptanceTime *int `json:"avg_task_acceptance_time,omitempty"`
	// The end of the interval during which these statistics were calculated
	EndTime *time.Time `json:"end_time,omitempty"`
	// The total number of Reservations accepted by Workers
	ReservationsAccepted *int `json:"reservations_accepted,omitempty"`
	// The total number of Reservations that were canceled
	ReservationsCanceled *int `json:"reservations_canceled,omitempty"`
	// The total number of Reservations that were created for Workers
	ReservationsCreated *int `json:"reservations_created,omitempty"`
	// The total number of Reservations that were rejected
	ReservationsRejected *int `json:"reservations_rejected,omitempty"`
	// The total number of Reservations that were rescinded
	ReservationsRescinded *int `json:"reservations_rescinded,omitempty"`
	// The total number of Reservations that were timed out
	ReservationsTimedOut *int `json:"reservations_timed_out,omitempty"`
	// A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
	SplitByWaitTime *map[string]interface{} `json:"split_by_wait_time,omitempty"`
	// The beginning of the interval during which these statistics were calculated
	StartTime *time.Time `json:"start_time,omitempty"`
	// The total number of Tasks that were canceled
	TasksCanceled *int `json:"tasks_canceled,omitempty"`
	// The total number of Tasks that were completed
	TasksCompleted *int `json:"tasks_completed,omitempty"`
	// The total number of Tasks that were deleted
	TasksDeleted *int `json:"tasks_deleted,omitempty"`
	// The total number of Tasks that entered the Workflow
	TasksEntered *int `json:"tasks_entered,omitempty"`
	// The total number of Tasks that were moved from one queue to another
	TasksMoved *int `json:"tasks_moved,omitempty"`
	// The total number of Tasks that were timed out of their Workflows
	TasksTimedOutInWorkflow *int `json:"tasks_timed_out_in_workflow,omitempty"`
	// The absolute URL of the Workflow statistics resource
	Url *string `json:"url,omitempty"`
	// The wait duration statistics for Tasks that were accepted
	WaitDurationUntilAccepted *map[string]interface{} `json:"wait_duration_until_accepted,omitempty"`
	// The wait duration statistics for Tasks that were canceled
	WaitDurationUntilCanceled *map[string]interface{} `json:"wait_duration_until_canceled,omitempty"`
	// Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value
	WorkflowSid *string `json:"workflow_sid,omitempty"`
	// The SID of the Workspace that contains the Workflow.
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkflowCumulativeStatistics struct for TaskrouterV1WorkflowCumulativeStatistics

type TaskrouterV1WorkflowRealTimeStatistics added in v0.14.0

type TaskrouterV1WorkflowRealTimeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The age of the longest waiting Task
	LongestTaskWaitingAge *int `json:"longest_task_waiting_age,omitempty"`
	// The SID of the longest waiting Task
	LongestTaskWaitingSid *string `json:"longest_task_waiting_sid,omitempty"`
	// The number of Tasks by priority
	TasksByPriority *map[string]interface{} `json:"tasks_by_priority,omitempty"`
	// The number of Tasks by their current status
	TasksByStatus *map[string]interface{} `json:"tasks_by_status,omitempty"`
	// The total number of Tasks
	TotalTasks *int `json:"total_tasks,omitempty"`
	// The absolute URL of the Workflow statistics resource
	Url *string `json:"url,omitempty"`
	// Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
	WorkflowSid *string `json:"workflow_sid,omitempty"`
	// The SID of the Workspace that contains the Workflow.
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkflowRealTimeStatistics struct for TaskrouterV1WorkflowRealTimeStatistics

type TaskrouterV1WorkflowStatistics added in v0.14.0

type TaskrouterV1WorkflowStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the Workflow
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// An object that contains the real-time statistics for the Workflow
	Realtime *map[string]interface{} `json:"realtime,omitempty"`
	// The absolute URL of the Workflow statistics resource
	Url *string `json:"url,omitempty"`
	// Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
	WorkflowSid *string `json:"workflow_sid,omitempty"`
	// The SID of the Workspace that contains the Workflow
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkflowStatistics struct for TaskrouterV1WorkflowStatistics

type TaskrouterV1Workspace

type TaskrouterV1Workspace struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The name of the default activity
	DefaultActivityName *string `json:"default_activity_name,omitempty"`
	// The SID of the Activity that will be used when new Workers are created in the Workspace
	DefaultActivitySid *string `json:"default_activity_sid,omitempty"`
	// The URL we call when an event occurs
	EventCallbackUrl *string `json:"event_callback_url,omitempty"`
	// The list of Workspace events for which to call event_callback_url
	EventsFilter *string `json:"events_filter,omitempty"`
	// The string that you assigned to describe the Workspace resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// Whether multi-tasking is enabled
	MultiTaskEnabled *bool `json:"multi_task_enabled,omitempty"`
	// The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues
	PrioritizeQueueOrder *string `json:"prioritize_queue_order,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// The name of the timeout activity
	TimeoutActivityName *string `json:"timeout_activity_name,omitempty"`
	// The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response
	TimeoutActivitySid *string `json:"timeout_activity_sid,omitempty"`
	// The absolute URL of the Workspace resource
	Url *string `json:"url,omitempty"`
}

TaskrouterV1Workspace struct for TaskrouterV1Workspace

type TaskrouterV1WorkspaceCumulativeStatistics added in v0.14.0

type TaskrouterV1WorkspaceCumulativeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The average time in seconds between Task creation and acceptance
	AvgTaskAcceptanceTime *int `json:"avg_task_acceptance_time,omitempty"`
	// The end of the interval during which these statistics were calculated
	EndTime *time.Time `json:"end_time,omitempty"`
	// The total number of Reservations accepted by Workers
	ReservationsAccepted *int `json:"reservations_accepted,omitempty"`
	// The total number of Reservations that were canceled
	ReservationsCanceled *int `json:"reservations_canceled,omitempty"`
	// The total number of Reservations that were created for Workers
	ReservationsCreated *int `json:"reservations_created,omitempty"`
	// The total number of Reservations that were rejected
	ReservationsRejected *int `json:"reservations_rejected,omitempty"`
	// The total number of Reservations that were rescinded
	ReservationsRescinded *int `json:"reservations_rescinded,omitempty"`
	// The total number of Reservations that were timed out
	ReservationsTimedOut *int `json:"reservations_timed_out,omitempty"`
	// A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
	SplitByWaitTime *map[string]interface{} `json:"split_by_wait_time,omitempty"`
	// The beginning of the interval during which these statistics were calculated
	StartTime *time.Time `json:"start_time,omitempty"`
	// The total number of Tasks that were canceled
	TasksCanceled *int `json:"tasks_canceled,omitempty"`
	// The total number of Tasks that were completed
	TasksCompleted *int `json:"tasks_completed,omitempty"`
	// The total number of Tasks created
	TasksCreated *int `json:"tasks_created,omitempty"`
	// The total number of Tasks that were deleted
	TasksDeleted *int `json:"tasks_deleted,omitempty"`
	// The total number of Tasks that were moved from one queue to another
	TasksMoved *int `json:"tasks_moved,omitempty"`
	// The total number of Tasks that were timed out of their Workflows
	TasksTimedOutInWorkflow *int `json:"tasks_timed_out_in_workflow,omitempty"`
	// The absolute URL of the Workspace statistics resource
	Url *string `json:"url,omitempty"`
	// The wait duration statistics for Tasks that were accepted
	WaitDurationUntilAccepted *map[string]interface{} `json:"wait_duration_until_accepted,omitempty"`
	// The wait duration statistics for Tasks that were canceled
	WaitDurationUntilCanceled *map[string]interface{} `json:"wait_duration_until_canceled,omitempty"`
	// The SID of the Workspace
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkspaceCumulativeStatistics struct for TaskrouterV1WorkspaceCumulativeStatistics

type TaskrouterV1WorkspaceRealTimeStatistics added in v0.14.0

type TaskrouterV1WorkspaceRealTimeStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The number of current Workers by Activity
	ActivityStatistics *[]map[string]interface{} `json:"activity_statistics,omitempty"`
	// The age of the longest waiting Task
	LongestTaskWaitingAge *int `json:"longest_task_waiting_age,omitempty"`
	// The SID of the longest waiting Task
	LongestTaskWaitingSid *string `json:"longest_task_waiting_sid,omitempty"`
	// The number of Tasks by priority
	TasksByPriority *map[string]interface{} `json:"tasks_by_priority,omitempty"`
	// The number of Tasks by their current status
	TasksByStatus *map[string]interface{} `json:"tasks_by_status,omitempty"`
	// The total number of Tasks
	TotalTasks *int `json:"total_tasks,omitempty"`
	// The total number of Workers in the Workspace
	TotalWorkers *int `json:"total_workers,omitempty"`
	// The absolute URL of the Workspace statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkspaceRealTimeStatistics struct for TaskrouterV1WorkspaceRealTimeStatistics

type TaskrouterV1WorkspaceStatistics added in v0.14.0

type TaskrouterV1WorkspaceStatistics struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// An object that contains the cumulative statistics for the Workspace
	Cumulative *map[string]interface{} `json:"cumulative,omitempty"`
	// n object that contains the real-time statistics for the Workspace
	Realtime *map[string]interface{} `json:"realtime,omitempty"`
	// The absolute URL of the Workspace statistics resource
	Url *string `json:"url,omitempty"`
	// The SID of the Workspace
	WorkspaceSid *string `json:"workspace_sid,omitempty"`
}

TaskrouterV1WorkspaceStatistics struct for TaskrouterV1WorkspaceStatistics

type UpdateActivityParams

type UpdateActivityParams struct {
	// A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateActivity'

func (*UpdateActivityParams) SetFriendlyName

func (params *UpdateActivityParams) SetFriendlyName(FriendlyName string) *UpdateActivityParams

type UpdateTaskChannelParams

type UpdateTaskChannelParams struct {
	// Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
	ChannelOptimizedRouting *bool `json:"ChannelOptimizedRouting,omitempty"`
	// A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
}

Optional parameters for the method 'UpdateTaskChannel'

func (*UpdateTaskChannelParams) SetChannelOptimizedRouting

func (params *UpdateTaskChannelParams) SetChannelOptimizedRouting(ChannelOptimizedRouting bool) *UpdateTaskChannelParams

func (*UpdateTaskChannelParams) SetFriendlyName

func (params *UpdateTaskChannelParams) SetFriendlyName(FriendlyName string) *UpdateTaskChannelParams

type UpdateTaskParams

type UpdateTaskParams struct {
	// If provided, applies this mutation if (and only if) the [ETag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
	// The new status of the task. Can be: `canceled`, to cancel a Task that is currently `pending` or `reserved`; `wrapping`, to move the Task to wrapup state; or `completed`, to move a Task to the completed state.
	AssignmentStatus *string `json:"AssignmentStatus,omitempty"`
	// The JSON string that describes the custom attributes of the task.
	Attributes *string `json:"Attributes,omitempty"`
	// The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).
	Priority *int `json:"Priority,omitempty"`
	// The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.
	Reason *string `json:"Reason,omitempty"`
	// When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
	TaskChannel *string `json:"TaskChannel,omitempty"`
}

Optional parameters for the method 'UpdateTask'

func (*UpdateTaskParams) SetAssignmentStatus

func (params *UpdateTaskParams) SetAssignmentStatus(AssignmentStatus string) *UpdateTaskParams

func (*UpdateTaskParams) SetAttributes

func (params *UpdateTaskParams) SetAttributes(Attributes string) *UpdateTaskParams

func (*UpdateTaskParams) SetIfMatch

func (params *UpdateTaskParams) SetIfMatch(IfMatch string) *UpdateTaskParams

func (*UpdateTaskParams) SetPriority

func (params *UpdateTaskParams) SetPriority(Priority int) *UpdateTaskParams

func (*UpdateTaskParams) SetReason

func (params *UpdateTaskParams) SetReason(Reason string) *UpdateTaskParams

func (*UpdateTaskParams) SetTaskChannel

func (params *UpdateTaskParams) SetTaskChannel(TaskChannel string) *UpdateTaskParams

type UpdateTaskQueueParams

type UpdateTaskQueueParams struct {
	// The SID of the Activity to assign Workers when a task is assigned for them.
	AssignmentActivitySid *string `json:"AssignmentActivitySid,omitempty"`
	// A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.
	MaxReservedWorkers *int `json:"MaxReservedWorkers,omitempty"`
	// The SID of the Activity to assign Workers when a task is reserved for them.
	ReservationActivitySid *string `json:"ReservationActivitySid,omitempty"`
	// A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '\\\"language\\\" == \\\"spanish\\\"' If no TargetWorkers parameter is provided, Tasks will wait in the queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.
	TargetWorkers *string `json:"TargetWorkers,omitempty"`
	// How Tasks will be assigned to Workers. Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
	TaskOrder *string `json:"TaskOrder,omitempty"`
}

Optional parameters for the method 'UpdateTaskQueue'

func (*UpdateTaskQueueParams) SetAssignmentActivitySid

func (params *UpdateTaskQueueParams) SetAssignmentActivitySid(AssignmentActivitySid string) *UpdateTaskQueueParams

func (*UpdateTaskQueueParams) SetFriendlyName

func (params *UpdateTaskQueueParams) SetFriendlyName(FriendlyName string) *UpdateTaskQueueParams

func (*UpdateTaskQueueParams) SetMaxReservedWorkers

func (params *UpdateTaskQueueParams) SetMaxReservedWorkers(MaxReservedWorkers int) *UpdateTaskQueueParams

func (*UpdateTaskQueueParams) SetReservationActivitySid

func (params *UpdateTaskQueueParams) SetReservationActivitySid(ReservationActivitySid string) *UpdateTaskQueueParams

func (*UpdateTaskQueueParams) SetTargetWorkers

func (params *UpdateTaskQueueParams) SetTargetWorkers(TargetWorkers string) *UpdateTaskQueueParams

func (*UpdateTaskQueueParams) SetTaskOrder

func (params *UpdateTaskQueueParams) SetTaskOrder(TaskOrder string) *UpdateTaskQueueParams

type UpdateTaskReservationParams

type UpdateTaskReservationParams struct {
	// Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
	Beep *string `json:"Beep,omitempty"`
	// Whether to play a notification beep when the customer joins.
	BeepOnCustomerEntrance *bool `json:"BeepOnCustomerEntrance,omitempty"`
	// Whether to accept a reservation when executing a Call instruction.
	CallAccept *bool `json:"CallAccept,omitempty"`
	// The Caller ID of the outbound call when executing a Call instruction.
	CallFrom *string `json:"CallFrom,omitempty"`
	// Whether to record both legs of a call when executing a Call instruction or which leg to record.
	CallRecord *string `json:"CallRecord,omitempty"`
	// The URL to call  for the completed call event when executing a Call instruction.
	CallStatusCallbackUrl *string `json:"CallStatusCallbackUrl,omitempty"`
	// Timeout for call when executing a Call instruction.
	CallTimeout *int `json:"CallTimeout,omitempty"`
	// The Contact URI of the worker when executing a Call instruction.  Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	CallTo *string `json:"CallTo,omitempty"`
	// TwiML URI executed on answering the worker's leg as a result of the Call instruction.
	CallUrl *string `json:"CallUrl,omitempty"`
	// Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
	ConferenceRecord *string `json:"ConferenceRecord,omitempty"`
	// The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
	ConferenceRecordingStatusCallback *string `json:"ConferenceRecordingStatusCallback,omitempty"`
	// The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	ConferenceRecordingStatusCallbackMethod *string `json:"ConferenceRecordingStatusCallbackMethod,omitempty"`
	// The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
	ConferenceStatusCallback *string `json:"ConferenceStatusCallback,omitempty"`
	// The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
	ConferenceStatusCallbackEvent *[]string `json:"ConferenceStatusCallbackEvent,omitempty"`
	// The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	ConferenceStatusCallbackMethod *string `json:"ConferenceStatusCallbackMethod,omitempty"`
	// How to trim the leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
	ConferenceTrim *string `json:"ConferenceTrim,omitempty"`
	// The Caller ID of the call to the worker when executing a Dequeue instruction.
	DequeueFrom *string `json:"DequeueFrom,omitempty"`
	// The SID of the Activity resource to start after executing a Dequeue instruction.
	DequeuePostWorkActivitySid *string `json:"DequeuePostWorkActivitySid,omitempty"`
	// Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
	DequeueRecord *string `json:"DequeueRecord,omitempty"`
	// The Call progress events sent via webhooks as a result of a Dequeue instruction.
	DequeueStatusCallbackEvent *[]string `json:"DequeueStatusCallbackEvent,omitempty"`
	// The Callback URL for completed call event when executing a Dequeue instruction.
	DequeueStatusCallbackUrl *string `json:"DequeueStatusCallbackUrl,omitempty"`
	// Timeout for call when executing a Dequeue instruction.
	DequeueTimeout *int `json:"DequeueTimeout,omitempty"`
	// The Contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	DequeueTo *string `json:"DequeueTo,omitempty"`
	// Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.
	EarlyMedia *bool `json:"EarlyMedia,omitempty"`
	// Whether to end the conference when the customer leaves.
	EndConferenceOnCustomerExit *bool `json:"EndConferenceOnCustomerExit,omitempty"`
	// Whether to end the conference when the agent leaves.
	EndConferenceOnExit *bool `json:"EndConferenceOnExit,omitempty"`
	// The Caller ID of the call to the worker when executing a Conference instruction.
	From *string `json:"From,omitempty"`
	// The assignment instruction for reservation.
	Instruction *string `json:"Instruction,omitempty"`
	// The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
	MaxParticipants *int `json:"MaxParticipants,omitempty"`
	// Whether the agent is muted in the conference. The default is `false`.
	Muted *bool `json:"Muted,omitempty"`
	// The new worker activity SID after executing a Conference instruction.
	PostWorkActivitySid *string `json:"PostWorkActivitySid,omitempty"`
	// Whether to record the participant and their conferences, including the time between conferences. The default is `false`.
	Record *bool `json:"Record,omitempty"`
	// The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
	RecordingChannels *string `json:"RecordingChannels,omitempty"`
	// The URL that we should call using the `recording_status_callback_method` when the recording status changes.
	RecordingStatusCallback *string `json:"RecordingStatusCallback,omitempty"`
	// The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	RecordingStatusCallbackMethod *string `json:"RecordingStatusCallbackMethod,omitempty"`
	// Whether the reservation should be accepted when executing a Redirect instruction.
	RedirectAccept *bool `json:"RedirectAccept,omitempty"`
	// The Call SID of the call parked in the queue when executing a Redirect instruction.
	RedirectCallSid *string `json:"RedirectCallSid,omitempty"`
	// TwiML URI to redirect the call to when executing the Redirect instruction.
	RedirectUrl *string `json:"RedirectUrl,omitempty"`
	// The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
	Region *string `json:"Region,omitempty"`
	// The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`.
	ReservationStatus *string `json:"ReservationStatus,omitempty"`
	// The SIP password for authentication.
	SipAuthPassword *string `json:"SipAuthPassword,omitempty"`
	// The SIP username used for authentication.
	SipAuthUsername *string `json:"SipAuthUsername,omitempty"`
	// Whether to start the conference when the participant joins, if it has not already started. The default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
	StartConferenceOnEnter *bool `json:"StartConferenceOnEnter,omitempty"`
	// The URL we should call using the `status_callback_method` to send status information to your application.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.
	StatusCallbackEvent *[]string `json:"StatusCallbackEvent,omitempty"`
	// The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"StatusCallbackMethod,omitempty"`
	// The Supervisor SID/URI when executing the Supervise instruction.
	Supervisor *string `json:"Supervisor,omitempty"`
	// The Supervisor mode when executing the Supervise instruction.
	SupervisorMode *string `json:"SupervisorMode,omitempty"`
	// Timeout for call when executing a Conference instruction.
	Timeout *int `json:"Timeout,omitempty"`
	// The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	To *string `json:"To,omitempty"`
	// The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
	WaitMethod *string `json:"WaitMethod,omitempty"`
	// The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
	WaitUrl *string `json:"WaitUrl,omitempty"`
	// The new worker activity SID if rejecting a reservation.
	WorkerActivitySid *string `json:"WorkerActivitySid,omitempty"`
}

Optional parameters for the method 'UpdateTaskReservation'

func (*UpdateTaskReservationParams) SetBeep

func (*UpdateTaskReservationParams) SetBeepOnCustomerEntrance

func (params *UpdateTaskReservationParams) SetBeepOnCustomerEntrance(BeepOnCustomerEntrance bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallAccept

func (params *UpdateTaskReservationParams) SetCallAccept(CallAccept bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallFrom

func (params *UpdateTaskReservationParams) SetCallFrom(CallFrom string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallRecord

func (params *UpdateTaskReservationParams) SetCallRecord(CallRecord string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallStatusCallbackUrl

func (params *UpdateTaskReservationParams) SetCallStatusCallbackUrl(CallStatusCallbackUrl string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallTimeout

func (params *UpdateTaskReservationParams) SetCallTimeout(CallTimeout int) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetCallTo

func (*UpdateTaskReservationParams) SetCallUrl

func (params *UpdateTaskReservationParams) SetCallUrl(CallUrl string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceRecord

func (params *UpdateTaskReservationParams) SetConferenceRecord(ConferenceRecord string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceRecordingStatusCallback

func (params *UpdateTaskReservationParams) SetConferenceRecordingStatusCallback(ConferenceRecordingStatusCallback string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceRecordingStatusCallbackMethod

func (params *UpdateTaskReservationParams) SetConferenceRecordingStatusCallbackMethod(ConferenceRecordingStatusCallbackMethod string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceStatusCallback

func (params *UpdateTaskReservationParams) SetConferenceStatusCallback(ConferenceStatusCallback string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceStatusCallbackEvent

func (params *UpdateTaskReservationParams) SetConferenceStatusCallbackEvent(ConferenceStatusCallbackEvent []string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceStatusCallbackMethod

func (params *UpdateTaskReservationParams) SetConferenceStatusCallbackMethod(ConferenceStatusCallbackMethod string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetConferenceTrim

func (params *UpdateTaskReservationParams) SetConferenceTrim(ConferenceTrim string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueFrom

func (params *UpdateTaskReservationParams) SetDequeueFrom(DequeueFrom string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeuePostWorkActivitySid

func (params *UpdateTaskReservationParams) SetDequeuePostWorkActivitySid(DequeuePostWorkActivitySid string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueRecord

func (params *UpdateTaskReservationParams) SetDequeueRecord(DequeueRecord string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueStatusCallbackEvent

func (params *UpdateTaskReservationParams) SetDequeueStatusCallbackEvent(DequeueStatusCallbackEvent []string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueStatusCallbackUrl

func (params *UpdateTaskReservationParams) SetDequeueStatusCallbackUrl(DequeueStatusCallbackUrl string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueTimeout

func (params *UpdateTaskReservationParams) SetDequeueTimeout(DequeueTimeout int) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetDequeueTo

func (params *UpdateTaskReservationParams) SetDequeueTo(DequeueTo string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetEarlyMedia

func (params *UpdateTaskReservationParams) SetEarlyMedia(EarlyMedia bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetEndConferenceOnCustomerExit

func (params *UpdateTaskReservationParams) SetEndConferenceOnCustomerExit(EndConferenceOnCustomerExit bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetEndConferenceOnExit

func (params *UpdateTaskReservationParams) SetEndConferenceOnExit(EndConferenceOnExit bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetFrom

func (*UpdateTaskReservationParams) SetInstruction

func (params *UpdateTaskReservationParams) SetInstruction(Instruction string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetMaxParticipants

func (params *UpdateTaskReservationParams) SetMaxParticipants(MaxParticipants int) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetMuted

func (*UpdateTaskReservationParams) SetPostWorkActivitySid

func (params *UpdateTaskReservationParams) SetPostWorkActivitySid(PostWorkActivitySid string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRecord

func (*UpdateTaskReservationParams) SetRecordingChannels

func (params *UpdateTaskReservationParams) SetRecordingChannels(RecordingChannels string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRecordingStatusCallback

func (params *UpdateTaskReservationParams) SetRecordingStatusCallback(RecordingStatusCallback string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRecordingStatusCallbackMethod

func (params *UpdateTaskReservationParams) SetRecordingStatusCallbackMethod(RecordingStatusCallbackMethod string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRedirectAccept

func (params *UpdateTaskReservationParams) SetRedirectAccept(RedirectAccept bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRedirectCallSid

func (params *UpdateTaskReservationParams) SetRedirectCallSid(RedirectCallSid string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRedirectUrl

func (params *UpdateTaskReservationParams) SetRedirectUrl(RedirectUrl string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetRegion

func (*UpdateTaskReservationParams) SetReservationStatus

func (params *UpdateTaskReservationParams) SetReservationStatus(ReservationStatus string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetSipAuthPassword

func (params *UpdateTaskReservationParams) SetSipAuthPassword(SipAuthPassword string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetSipAuthUsername

func (params *UpdateTaskReservationParams) SetSipAuthUsername(SipAuthUsername string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetStartConferenceOnEnter

func (params *UpdateTaskReservationParams) SetStartConferenceOnEnter(StartConferenceOnEnter bool) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetStatusCallback

func (params *UpdateTaskReservationParams) SetStatusCallback(StatusCallback string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetStatusCallbackEvent

func (params *UpdateTaskReservationParams) SetStatusCallbackEvent(StatusCallbackEvent []string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetStatusCallbackMethod

func (params *UpdateTaskReservationParams) SetStatusCallbackMethod(StatusCallbackMethod string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetSupervisor

func (params *UpdateTaskReservationParams) SetSupervisor(Supervisor string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetSupervisorMode

func (params *UpdateTaskReservationParams) SetSupervisorMode(SupervisorMode string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetTimeout

func (params *UpdateTaskReservationParams) SetTimeout(Timeout int) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetTo

func (*UpdateTaskReservationParams) SetWaitMethod

func (params *UpdateTaskReservationParams) SetWaitMethod(WaitMethod string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetWaitUrl

func (params *UpdateTaskReservationParams) SetWaitUrl(WaitUrl string) *UpdateTaskReservationParams

func (*UpdateTaskReservationParams) SetWorkerActivitySid

func (params *UpdateTaskReservationParams) SetWorkerActivitySid(WorkerActivitySid string) *UpdateTaskReservationParams

type UpdateWorkerChannelParams

type UpdateWorkerChannelParams struct {
	// Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.
	Available *bool `json:"Available,omitempty"`
	// The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.
	Capacity *int `json:"Capacity,omitempty"`
}

Optional parameters for the method 'UpdateWorkerChannel'

func (*UpdateWorkerChannelParams) SetAvailable

func (params *UpdateWorkerChannelParams) SetAvailable(Available bool) *UpdateWorkerChannelParams

func (*UpdateWorkerChannelParams) SetCapacity

func (params *UpdateWorkerChannelParams) SetCapacity(Capacity int) *UpdateWorkerChannelParams

type UpdateWorkerParams

type UpdateWorkerParams struct {
	// The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.
	ActivitySid *string `json:"ActivitySid,omitempty"`
	// The JSON string that describes the Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
	Attributes *string `json:"Attributes,omitempty"`
	// A descriptive string that you create to describe the Worker. It can be up to 64 characters long.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether to reject pending reservations.
	RejectPendingReservations *bool `json:"RejectPendingReservations,omitempty"`
}

Optional parameters for the method 'UpdateWorker'

func (*UpdateWorkerParams) SetActivitySid

func (params *UpdateWorkerParams) SetActivitySid(ActivitySid string) *UpdateWorkerParams

func (*UpdateWorkerParams) SetAttributes

func (params *UpdateWorkerParams) SetAttributes(Attributes string) *UpdateWorkerParams

func (*UpdateWorkerParams) SetFriendlyName

func (params *UpdateWorkerParams) SetFriendlyName(FriendlyName string) *UpdateWorkerParams

func (*UpdateWorkerParams) SetRejectPendingReservations

func (params *UpdateWorkerParams) SetRejectPendingReservations(RejectPendingReservations bool) *UpdateWorkerParams

type UpdateWorkerReservationParams

type UpdateWorkerReservationParams struct {
	// Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.
	Beep *string `json:"Beep,omitempty"`
	// Whether to play a notification beep when the customer joins.
	BeepOnCustomerEntrance *bool `json:"BeepOnCustomerEntrance,omitempty"`
	// Whether to accept a reservation when executing a Call instruction.
	CallAccept *bool `json:"CallAccept,omitempty"`
	// The Caller ID of the outbound call when executing a Call instruction.
	CallFrom *string `json:"CallFrom,omitempty"`
	// Whether to record both legs of a call when executing a Call instruction.
	CallRecord *string `json:"CallRecord,omitempty"`
	// The URL to call for the completed call event when executing a Call instruction.
	CallStatusCallbackUrl *string `json:"CallStatusCallbackUrl,omitempty"`
	// The timeout for a call when executing a Call instruction.
	CallTimeout *int `json:"CallTimeout,omitempty"`
	// The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	CallTo *string `json:"CallTo,omitempty"`
	// TwiML URI executed on answering the worker's leg as a result of the Call instruction.
	CallUrl *string `json:"CallUrl,omitempty"`
	// Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.
	ConferenceRecord *string `json:"ConferenceRecord,omitempty"`
	// The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.
	ConferenceRecordingStatusCallback *string `json:"ConferenceRecordingStatusCallback,omitempty"`
	// The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	ConferenceRecordingStatusCallbackMethod *string `json:"ConferenceRecordingStatusCallbackMethod,omitempty"`
	// The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.
	ConferenceStatusCallback *string `json:"ConferenceStatusCallback,omitempty"`
	// The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.
	ConferenceStatusCallbackEvent *[]string `json:"ConferenceStatusCallbackEvent,omitempty"`
	// The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	ConferenceStatusCallbackMethod *string `json:"ConferenceStatusCallbackMethod,omitempty"`
	// Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.
	ConferenceTrim *string `json:"ConferenceTrim,omitempty"`
	// The caller ID of the call to the worker when executing a Dequeue instruction.
	DequeueFrom *string `json:"DequeueFrom,omitempty"`
	// The SID of the Activity resource to start after executing a Dequeue instruction.
	DequeuePostWorkActivitySid *string `json:"DequeuePostWorkActivitySid,omitempty"`
	// Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.
	DequeueRecord *string `json:"DequeueRecord,omitempty"`
	// The call progress events sent via webhooks as a result of a Dequeue instruction.
	DequeueStatusCallbackEvent *[]string `json:"DequeueStatusCallbackEvent,omitempty"`
	// The callback URL for completed call event when executing a Dequeue instruction.
	DequeueStatusCallbackUrl *string `json:"DequeueStatusCallbackUrl,omitempty"`
	// The timeout for call when executing a Dequeue instruction.
	DequeueTimeout *int `json:"DequeueTimeout,omitempty"`
	// The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	DequeueTo *string `json:"DequeueTo,omitempty"`
	// Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.
	EarlyMedia *bool `json:"EarlyMedia,omitempty"`
	// Whether to end the conference when the customer leaves.
	EndConferenceOnCustomerExit *bool `json:"EndConferenceOnCustomerExit,omitempty"`
	// Whether to end the conference when the agent leaves.
	EndConferenceOnExit *bool `json:"EndConferenceOnExit,omitempty"`
	// The caller ID of the call to the worker when executing a Conference instruction.
	From *string `json:"From,omitempty"`
	// The assignment instruction for the reservation.
	Instruction *string `json:"Instruction,omitempty"`
	// The maximum number of participants allowed in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.
	MaxParticipants *int `json:"MaxParticipants,omitempty"`
	// Whether the agent is muted in the conference. Defaults to `false`.
	Muted *bool `json:"Muted,omitempty"`
	// The new worker activity SID after executing a Conference instruction.
	PostWorkActivitySid *string `json:"PostWorkActivitySid,omitempty"`
	// Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.
	Record *bool `json:"Record,omitempty"`
	// The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.
	RecordingChannels *string `json:"RecordingChannels,omitempty"`
	// The URL that we should call using the `recording_status_callback_method` when the recording status changes.
	RecordingStatusCallback *string `json:"RecordingStatusCallback,omitempty"`
	// The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.
	RecordingStatusCallbackMethod *string `json:"RecordingStatusCallbackMethod,omitempty"`
	// Whether the reservation should be accepted when executing a Redirect instruction.
	RedirectAccept *bool `json:"RedirectAccept,omitempty"`
	// The Call SID of the call parked in the queue when executing a Redirect instruction.
	RedirectCallSid *string `json:"RedirectCallSid,omitempty"`
	// TwiML URI to redirect the call to when executing the Redirect instruction.
	RedirectUrl *string `json:"RedirectUrl,omitempty"`
	// The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.
	Region *string `json:"Region,omitempty"`
	// The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.
	ReservationStatus *string `json:"ReservationStatus,omitempty"`
	// The SIP password for authentication.
	SipAuthPassword *string `json:"SipAuthPassword,omitempty"`
	// The SIP username used for authentication.
	SipAuthUsername *string `json:"SipAuthUsername,omitempty"`
	// Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
	StartConferenceOnEnter *bool `json:"StartConferenceOnEnter,omitempty"`
	// The URL we should call using the `status_callback_method` to send status information to your application.
	StatusCallback *string `json:"StatusCallback,omitempty"`
	// The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.
	StatusCallbackEvent *[]string `json:"StatusCallbackEvent,omitempty"`
	// The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.
	StatusCallbackMethod *string `json:"StatusCallbackMethod,omitempty"`
	// The timeout for a call when executing a Conference instruction.
	Timeout *int `json:"Timeout,omitempty"`
	// The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.
	To *string `json:"To,omitempty"`
	// The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.
	WaitMethod *string `json:"WaitMethod,omitempty"`
	// The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).
	WaitUrl *string `json:"WaitUrl,omitempty"`
	// The new worker activity SID if rejecting a reservation.
	WorkerActivitySid *string `json:"WorkerActivitySid,omitempty"`
}

Optional parameters for the method 'UpdateWorkerReservation'

func (*UpdateWorkerReservationParams) SetBeep

func (*UpdateWorkerReservationParams) SetBeepOnCustomerEntrance

func (params *UpdateWorkerReservationParams) SetBeepOnCustomerEntrance(BeepOnCustomerEntrance bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetCallAccept

func (params *UpdateWorkerReservationParams) SetCallAccept(CallAccept bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetCallFrom

func (*UpdateWorkerReservationParams) SetCallRecord

func (params *UpdateWorkerReservationParams) SetCallRecord(CallRecord string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetCallStatusCallbackUrl

func (params *UpdateWorkerReservationParams) SetCallStatusCallbackUrl(CallStatusCallbackUrl string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetCallTimeout

func (params *UpdateWorkerReservationParams) SetCallTimeout(CallTimeout int) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetCallTo

func (*UpdateWorkerReservationParams) SetCallUrl

func (*UpdateWorkerReservationParams) SetConferenceRecord

func (params *UpdateWorkerReservationParams) SetConferenceRecord(ConferenceRecord string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceRecordingStatusCallback

func (params *UpdateWorkerReservationParams) SetConferenceRecordingStatusCallback(ConferenceRecordingStatusCallback string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceRecordingStatusCallbackMethod

func (params *UpdateWorkerReservationParams) SetConferenceRecordingStatusCallbackMethod(ConferenceRecordingStatusCallbackMethod string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceStatusCallback

func (params *UpdateWorkerReservationParams) SetConferenceStatusCallback(ConferenceStatusCallback string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceStatusCallbackEvent

func (params *UpdateWorkerReservationParams) SetConferenceStatusCallbackEvent(ConferenceStatusCallbackEvent []string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceStatusCallbackMethod

func (params *UpdateWorkerReservationParams) SetConferenceStatusCallbackMethod(ConferenceStatusCallbackMethod string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetConferenceTrim

func (params *UpdateWorkerReservationParams) SetConferenceTrim(ConferenceTrim string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueFrom

func (params *UpdateWorkerReservationParams) SetDequeueFrom(DequeueFrom string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeuePostWorkActivitySid

func (params *UpdateWorkerReservationParams) SetDequeuePostWorkActivitySid(DequeuePostWorkActivitySid string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueRecord

func (params *UpdateWorkerReservationParams) SetDequeueRecord(DequeueRecord string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueStatusCallbackEvent

func (params *UpdateWorkerReservationParams) SetDequeueStatusCallbackEvent(DequeueStatusCallbackEvent []string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueStatusCallbackUrl

func (params *UpdateWorkerReservationParams) SetDequeueStatusCallbackUrl(DequeueStatusCallbackUrl string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueTimeout

func (params *UpdateWorkerReservationParams) SetDequeueTimeout(DequeueTimeout int) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetDequeueTo

func (params *UpdateWorkerReservationParams) SetDequeueTo(DequeueTo string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetEarlyMedia

func (params *UpdateWorkerReservationParams) SetEarlyMedia(EarlyMedia bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetEndConferenceOnCustomerExit

func (params *UpdateWorkerReservationParams) SetEndConferenceOnCustomerExit(EndConferenceOnCustomerExit bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetEndConferenceOnExit

func (params *UpdateWorkerReservationParams) SetEndConferenceOnExit(EndConferenceOnExit bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetFrom

func (*UpdateWorkerReservationParams) SetInstruction

func (params *UpdateWorkerReservationParams) SetInstruction(Instruction string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetMaxParticipants

func (params *UpdateWorkerReservationParams) SetMaxParticipants(MaxParticipants int) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetMuted

func (*UpdateWorkerReservationParams) SetPostWorkActivitySid

func (params *UpdateWorkerReservationParams) SetPostWorkActivitySid(PostWorkActivitySid string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRecord

func (*UpdateWorkerReservationParams) SetRecordingChannels

func (params *UpdateWorkerReservationParams) SetRecordingChannels(RecordingChannels string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRecordingStatusCallback

func (params *UpdateWorkerReservationParams) SetRecordingStatusCallback(RecordingStatusCallback string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRecordingStatusCallbackMethod

func (params *UpdateWorkerReservationParams) SetRecordingStatusCallbackMethod(RecordingStatusCallbackMethod string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRedirectAccept

func (params *UpdateWorkerReservationParams) SetRedirectAccept(RedirectAccept bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRedirectCallSid

func (params *UpdateWorkerReservationParams) SetRedirectCallSid(RedirectCallSid string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRedirectUrl

func (params *UpdateWorkerReservationParams) SetRedirectUrl(RedirectUrl string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetRegion

func (*UpdateWorkerReservationParams) SetReservationStatus

func (params *UpdateWorkerReservationParams) SetReservationStatus(ReservationStatus string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetSipAuthPassword

func (params *UpdateWorkerReservationParams) SetSipAuthPassword(SipAuthPassword string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetSipAuthUsername

func (params *UpdateWorkerReservationParams) SetSipAuthUsername(SipAuthUsername string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetStartConferenceOnEnter

func (params *UpdateWorkerReservationParams) SetStartConferenceOnEnter(StartConferenceOnEnter bool) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetStatusCallback

func (params *UpdateWorkerReservationParams) SetStatusCallback(StatusCallback string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetStatusCallbackEvent

func (params *UpdateWorkerReservationParams) SetStatusCallbackEvent(StatusCallbackEvent []string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetStatusCallbackMethod

func (params *UpdateWorkerReservationParams) SetStatusCallbackMethod(StatusCallbackMethod string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetTimeout

func (*UpdateWorkerReservationParams) SetTo

func (*UpdateWorkerReservationParams) SetWaitMethod

func (params *UpdateWorkerReservationParams) SetWaitMethod(WaitMethod string) *UpdateWorkerReservationParams

func (*UpdateWorkerReservationParams) SetWaitUrl

func (*UpdateWorkerReservationParams) SetWorkerActivitySid

func (params *UpdateWorkerReservationParams) SetWorkerActivitySid(WorkerActivitySid string) *UpdateWorkerReservationParams

type UpdateWorkflowParams

type UpdateWorkflowParams struct {
	// The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.
	AssignmentCallbackUrl *string `json:"AssignmentCallbackUrl,omitempty"`
	// A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.
	Configuration *string `json:"Configuration,omitempty"`
	// The URL that we should call when a call to the `assignment_callback_url` fails.
	FallbackAssignmentCallbackUrl *string `json:"FallbackAssignmentCallbackUrl,omitempty"`
	// A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again.
	ReEvaluateTasks *string `json:"ReEvaluateTasks,omitempty"`
	// How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.
	TaskReservationTimeout *int `json:"TaskReservationTimeout,omitempty"`
}

Optional parameters for the method 'UpdateWorkflow'

func (*UpdateWorkflowParams) SetAssignmentCallbackUrl

func (params *UpdateWorkflowParams) SetAssignmentCallbackUrl(AssignmentCallbackUrl string) *UpdateWorkflowParams

func (*UpdateWorkflowParams) SetConfiguration

func (params *UpdateWorkflowParams) SetConfiguration(Configuration string) *UpdateWorkflowParams

func (*UpdateWorkflowParams) SetFallbackAssignmentCallbackUrl

func (params *UpdateWorkflowParams) SetFallbackAssignmentCallbackUrl(FallbackAssignmentCallbackUrl string) *UpdateWorkflowParams

func (*UpdateWorkflowParams) SetFriendlyName

func (params *UpdateWorkflowParams) SetFriendlyName(FriendlyName string) *UpdateWorkflowParams

func (*UpdateWorkflowParams) SetReEvaluateTasks

func (params *UpdateWorkflowParams) SetReEvaluateTasks(ReEvaluateTasks string) *UpdateWorkflowParams

func (*UpdateWorkflowParams) SetTaskReservationTimeout

func (params *UpdateWorkflowParams) SetTaskReservationTimeout(TaskReservationTimeout int) *UpdateWorkflowParams

type UpdateWorkspaceParams

type UpdateWorkspaceParams struct {
	// The SID of the Activity that will be used when new Workers are created in the Workspace.
	DefaultActivitySid *string `json:"DefaultActivitySid,omitempty"`
	// The URL we should call when an event occurs. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.
	EventCallbackUrl *string `json:"EventCallbackUrl,omitempty"`
	// 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.
	EventsFilter *string `json:"EventsFilter,omitempty"`
	// A descriptive string that you create to describe the Workspace resource. For example: `Sales Call Center` or `Customer Support Team`.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// 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](https://www.twilio.com/docs/taskrouter/multitasking).
	MultiTaskEnabled *bool `json:"MultiTaskEnabled,omitempty"`
	// 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](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
	PrioritizeQueueOrder *string `json:"PrioritizeQueueOrder,omitempty"`
	// The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.
	TimeoutActivitySid *string `json:"TimeoutActivitySid,omitempty"`
}

Optional parameters for the method 'UpdateWorkspace'

func (*UpdateWorkspaceParams) SetDefaultActivitySid

func (params *UpdateWorkspaceParams) SetDefaultActivitySid(DefaultActivitySid string) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetEventCallbackUrl

func (params *UpdateWorkspaceParams) SetEventCallbackUrl(EventCallbackUrl string) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetEventsFilter

func (params *UpdateWorkspaceParams) SetEventsFilter(EventsFilter string) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetFriendlyName

func (params *UpdateWorkspaceParams) SetFriendlyName(FriendlyName string) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetMultiTaskEnabled

func (params *UpdateWorkspaceParams) SetMultiTaskEnabled(MultiTaskEnabled bool) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetPrioritizeQueueOrder

func (params *UpdateWorkspaceParams) SetPrioritizeQueueOrder(PrioritizeQueueOrder string) *UpdateWorkspaceParams

func (*UpdateWorkspaceParams) SetTimeoutActivitySid

func (params *UpdateWorkspaceParams) SetTimeoutActivitySid(TimeoutActivitySid string) *UpdateWorkspaceParams

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL