github.com/twilio/twilio-go@v1.20.1/rest/taskrouter/v1/README.md (about) 1 # Go API client for openapi 2 3 This is the public Twilio REST API. 4 5 ## Overview 6 This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project from the OpenAPI specs located at [twilio/twilio-oai](https://github.com/twilio/twilio-oai/tree/main/spec). By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. 7 8 - API version: 1.0.0 9 - Package version: 1.0.0 10 - Build package: com.twilio.oai.TwilioGoGenerator 11 For more information, please visit [https://support.twilio.com](https://support.twilio.com) 12 13 ## Installation 14 15 Install the following dependencies: 16 17 ```shell 18 go get github.com/stretchr/testify/assert 19 go get golang.org/x/net/context 20 ``` 21 22 Put the package under your project folder and add the following in import: 23 24 ```golang 25 import "./openapi" 26 ``` 27 28 ## Documentation for API Endpoints 29 30 All URIs are relative to *https://taskrouter.twilio.com* 31 32 Class | Method | HTTP request | Description 33 ------------ | ------------- | ------------- | ------------- 34 *WorkspacesApi* | [**CreateWorkspace**](docs/WorkspacesApi.md#createworkspace) | **Post** /v1/Workspaces | 35 *WorkspacesApi* | [**DeleteWorkspace**](docs/WorkspacesApi.md#deleteworkspace) | **Delete** /v1/Workspaces/{Sid} | 36 *WorkspacesApi* | [**FetchWorkspace**](docs/WorkspacesApi.md#fetchworkspace) | **Get** /v1/Workspaces/{Sid} | 37 *WorkspacesApi* | [**ListWorkspace**](docs/WorkspacesApi.md#listworkspace) | **Get** /v1/Workspaces | 38 *WorkspacesApi* | [**UpdateWorkspace**](docs/WorkspacesApi.md#updateworkspace) | **Post** /v1/Workspaces/{Sid} | 39 *WorkspacesActivitiesApi* | [**CreateActivity**](docs/WorkspacesActivitiesApi.md#createactivity) | **Post** /v1/Workspaces/{WorkspaceSid}/Activities | 40 *WorkspacesActivitiesApi* | [**DeleteActivity**](docs/WorkspacesActivitiesApi.md#deleteactivity) | **Delete** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 41 *WorkspacesActivitiesApi* | [**FetchActivity**](docs/WorkspacesActivitiesApi.md#fetchactivity) | **Get** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 42 *WorkspacesActivitiesApi* | [**ListActivity**](docs/WorkspacesActivitiesApi.md#listactivity) | **Get** /v1/Workspaces/{WorkspaceSid}/Activities | 43 *WorkspacesActivitiesApi* | [**UpdateActivity**](docs/WorkspacesActivitiesApi.md#updateactivity) | **Post** /v1/Workspaces/{WorkspaceSid}/Activities/{Sid} | 44 *WorkspacesCumulativeStatisticsApi* | [**FetchWorkspaceCumulativeStatistics**](docs/WorkspacesCumulativeStatisticsApi.md#fetchworkspacecumulativestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/CumulativeStatistics | 45 *WorkspacesEventsApi* | [**FetchEvent**](docs/WorkspacesEventsApi.md#fetchevent) | **Get** /v1/Workspaces/{WorkspaceSid}/Events/{Sid} | 46 *WorkspacesEventsApi* | [**ListEvent**](docs/WorkspacesEventsApi.md#listevent) | **Get** /v1/Workspaces/{WorkspaceSid}/Events | 47 *WorkspacesRealTimeStatisticsApi* | [**FetchWorkspaceRealTimeStatistics**](docs/WorkspacesRealTimeStatisticsApi.md#fetchworkspacerealtimestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/RealTimeStatistics | 48 *WorkspacesStatisticsApi* | [**FetchWorkspaceStatistics**](docs/WorkspacesStatisticsApi.md#fetchworkspacestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Statistics | 49 *WorkspacesTaskChannelsApi* | [**CreateTaskChannel**](docs/WorkspacesTaskChannelsApi.md#createtaskchannel) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskChannels | 50 *WorkspacesTaskChannelsApi* | [**DeleteTaskChannel**](docs/WorkspacesTaskChannelsApi.md#deletetaskchannel) | **Delete** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 51 *WorkspacesTaskChannelsApi* | [**FetchTaskChannel**](docs/WorkspacesTaskChannelsApi.md#fetchtaskchannel) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 52 *WorkspacesTaskChannelsApi* | [**ListTaskChannel**](docs/WorkspacesTaskChannelsApi.md#listtaskchannel) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskChannels | 53 *WorkspacesTaskChannelsApi* | [**UpdateTaskChannel**](docs/WorkspacesTaskChannelsApi.md#updatetaskchannel) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid} | 54 *WorkspacesTaskQueuesApi* | [**CreateTaskQueue**](docs/WorkspacesTaskQueuesApi.md#createtaskqueue) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskQueues | 55 *WorkspacesTaskQueuesApi* | [**DeleteTaskQueue**](docs/WorkspacesTaskQueuesApi.md#deletetaskqueue) | **Delete** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 56 *WorkspacesTaskQueuesApi* | [**FetchTaskQueue**](docs/WorkspacesTaskQueuesApi.md#fetchtaskqueue) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 57 *WorkspacesTaskQueuesApi* | [**ListTaskQueue**](docs/WorkspacesTaskQueuesApi.md#listtaskqueue) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues | 58 *WorkspacesTaskQueuesApi* | [**UpdateTaskQueue**](docs/WorkspacesTaskQueuesApi.md#updatetaskqueue) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | 59 *WorkspacesTaskQueuesCumulativeStatisticsApi* | [**FetchTaskQueueCumulativeStatistics**](docs/WorkspacesTaskQueuesCumulativeStatisticsApi.md#fetchtaskqueuecumulativestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/CumulativeStatistics | 60 *WorkspacesTaskQueuesRealTimeStatisticsApi* | [**CreateTaskQueueBulkRealTimeStatistics**](docs/WorkspacesTaskQueuesRealTimeStatisticsApi.md#createtaskqueuebulkrealtimestatistics) | **Post** /v1/Workspaces/{WorkspaceSid}/TaskQueues/RealTimeStatistics | 61 *WorkspacesTaskQueuesRealTimeStatisticsApi* | [**FetchTaskQueueRealTimeStatistics**](docs/WorkspacesTaskQueuesRealTimeStatisticsApi.md#fetchtaskqueuerealtimestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/RealTimeStatistics | 62 *WorkspacesTaskQueuesStatisticsApi* | [**FetchTaskQueueStatistics**](docs/WorkspacesTaskQueuesStatisticsApi.md#fetchtaskqueuestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/{TaskQueueSid}/Statistics | 63 *WorkspacesTaskQueuesStatisticsApi* | [**ListTaskQueuesStatistics**](docs/WorkspacesTaskQueuesStatisticsApi.md#listtaskqueuesstatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/TaskQueues/Statistics | 64 *WorkspacesTasksApi* | [**CreateTask**](docs/WorkspacesTasksApi.md#createtask) | **Post** /v1/Workspaces/{WorkspaceSid}/Tasks | 65 *WorkspacesTasksApi* | [**DeleteTask**](docs/WorkspacesTasksApi.md#deletetask) | **Delete** /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid} | 66 *WorkspacesTasksApi* | [**FetchTask**](docs/WorkspacesTasksApi.md#fetchtask) | **Get** /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid} | 67 *WorkspacesTasksApi* | [**ListTask**](docs/WorkspacesTasksApi.md#listtask) | **Get** /v1/Workspaces/{WorkspaceSid}/Tasks | 68 *WorkspacesTasksApi* | [**UpdateTask**](docs/WorkspacesTasksApi.md#updatetask) | **Post** /v1/Workspaces/{WorkspaceSid}/Tasks/{Sid} | 69 *WorkspacesTasksReservationsApi* | [**FetchTaskReservation**](docs/WorkspacesTasksReservationsApi.md#fetchtaskreservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid} | 70 *WorkspacesTasksReservationsApi* | [**ListTaskReservation**](docs/WorkspacesTasksReservationsApi.md#listtaskreservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations | 71 *WorkspacesTasksReservationsApi* | [**UpdateTaskReservation**](docs/WorkspacesTasksReservationsApi.md#updatetaskreservation) | **Post** /v1/Workspaces/{WorkspaceSid}/Tasks/{TaskSid}/Reservations/{Sid} | 72 *WorkspacesWorkersApi* | [**CreateWorker**](docs/WorkspacesWorkersApi.md#createworker) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers | 73 *WorkspacesWorkersApi* | [**DeleteWorker**](docs/WorkspacesWorkersApi.md#deleteworker) | **Delete** /v1/Workspaces/{WorkspaceSid}/Workers/{Sid} | 74 *WorkspacesWorkersApi* | [**FetchWorker**](docs/WorkspacesWorkersApi.md#fetchworker) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{Sid} | 75 *WorkspacesWorkersApi* | [**ListWorker**](docs/WorkspacesWorkersApi.md#listworker) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers | 76 *WorkspacesWorkersApi* | [**UpdateWorker**](docs/WorkspacesWorkersApi.md#updateworker) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers/{Sid} | 77 *WorkspacesWorkersChannelsApi* | [**FetchWorkerChannel**](docs/WorkspacesWorkersChannelsApi.md#fetchworkerchannel) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid} | 78 *WorkspacesWorkersChannelsApi* | [**ListWorkerChannel**](docs/WorkspacesWorkersChannelsApi.md#listworkerchannel) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels | 79 *WorkspacesWorkersChannelsApi* | [**UpdateWorkerChannel**](docs/WorkspacesWorkersChannelsApi.md#updateworkerchannel) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid} | 80 *WorkspacesWorkersCumulativeStatisticsApi* | [**FetchWorkersCumulativeStatistics**](docs/WorkspacesWorkersCumulativeStatisticsApi.md#fetchworkerscumulativestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics | 81 *WorkspacesWorkersRealTimeStatisticsApi* | [**FetchWorkersRealTimeStatistics**](docs/WorkspacesWorkersRealTimeStatisticsApi.md#fetchworkersrealtimestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics | 82 *WorkspacesWorkersReservationsApi* | [**FetchWorkerReservation**](docs/WorkspacesWorkersReservationsApi.md#fetchworkerreservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid} | 83 *WorkspacesWorkersReservationsApi* | [**ListWorkerReservation**](docs/WorkspacesWorkersReservationsApi.md#listworkerreservation) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations | 84 *WorkspacesWorkersReservationsApi* | [**UpdateWorkerReservation**](docs/WorkspacesWorkersReservationsApi.md#updateworkerreservation) | **Post** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid} | 85 *WorkspacesWorkersStatisticsApi* | [**FetchWorkerInstanceStatistics**](docs/WorkspacesWorkersStatisticsApi.md#fetchworkerinstancestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Statistics | 86 *WorkspacesWorkersStatisticsApi* | [**FetchWorkerStatistics**](docs/WorkspacesWorkersStatisticsApi.md#fetchworkerstatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workers/Statistics | 87 *WorkspacesWorkflowsApi* | [**CreateWorkflow**](docs/WorkspacesWorkflowsApi.md#createworkflow) | **Post** /v1/Workspaces/{WorkspaceSid}/Workflows | 88 *WorkspacesWorkflowsApi* | [**DeleteWorkflow**](docs/WorkspacesWorkflowsApi.md#deleteworkflow) | **Delete** /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid} | 89 *WorkspacesWorkflowsApi* | [**FetchWorkflow**](docs/WorkspacesWorkflowsApi.md#fetchworkflow) | **Get** /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid} | 90 *WorkspacesWorkflowsApi* | [**ListWorkflow**](docs/WorkspacesWorkflowsApi.md#listworkflow) | **Get** /v1/Workspaces/{WorkspaceSid}/Workflows | 91 *WorkspacesWorkflowsApi* | [**UpdateWorkflow**](docs/WorkspacesWorkflowsApi.md#updateworkflow) | **Post** /v1/Workspaces/{WorkspaceSid}/Workflows/{Sid} | 92 *WorkspacesWorkflowsCumulativeStatisticsApi* | [**FetchWorkflowCumulativeStatistics**](docs/WorkspacesWorkflowsCumulativeStatisticsApi.md#fetchworkflowcumulativestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/CumulativeStatistics | 93 *WorkspacesWorkflowsRealTimeStatisticsApi* | [**FetchWorkflowRealTimeStatistics**](docs/WorkspacesWorkflowsRealTimeStatisticsApi.md#fetchworkflowrealtimestatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/RealTimeStatistics | 94 *WorkspacesWorkflowsStatisticsApi* | [**FetchWorkflowStatistics**](docs/WorkspacesWorkflowsStatisticsApi.md#fetchworkflowstatistics) | **Get** /v1/Workspaces/{WorkspaceSid}/Workflows/{WorkflowSid}/Statistics | 95 96 97 ## Documentation For Models 98 99 - [TaskrouterV1Task](docs/TaskrouterV1Task.md) 100 - [ListTaskChannelResponse](docs/ListTaskChannelResponse.md) 101 - [TaskrouterV1TaskQueueBulkRealTimeStatistics](docs/TaskrouterV1TaskQueueBulkRealTimeStatistics.md) 102 - [TaskrouterV1TaskQueuesStatistics](docs/TaskrouterV1TaskQueuesStatistics.md) 103 - [TaskrouterV1WorkspaceCumulativeStatistics](docs/TaskrouterV1WorkspaceCumulativeStatistics.md) 104 - [TaskrouterV1Activity](docs/TaskrouterV1Activity.md) 105 - [TaskrouterV1TaskChannel](docs/TaskrouterV1TaskChannel.md) 106 - [ListTaskReservationResponse](docs/ListTaskReservationResponse.md) 107 - [TaskrouterV1WorkerInstanceStatistics](docs/TaskrouterV1WorkerInstanceStatistics.md) 108 - [ListWorkflowResponse](docs/ListWorkflowResponse.md) 109 - [TaskrouterV1WorkerStatistics](docs/TaskrouterV1WorkerStatistics.md) 110 - [TaskrouterV1WorkflowRealTimeStatistics](docs/TaskrouterV1WorkflowRealTimeStatistics.md) 111 - [ListTaskQueuesStatisticsResponse](docs/ListTaskQueuesStatisticsResponse.md) 112 - [ListWorkspaceResponse](docs/ListWorkspaceResponse.md) 113 - [TaskrouterV1WorkflowCumulativeStatistics](docs/TaskrouterV1WorkflowCumulativeStatistics.md) 114 - [TaskrouterV1TaskQueueStatistics](docs/TaskrouterV1TaskQueueStatistics.md) 115 - [TaskrouterV1WorkersCumulativeStatistics](docs/TaskrouterV1WorkersCumulativeStatistics.md) 116 - [TaskrouterV1TaskReservation](docs/TaskrouterV1TaskReservation.md) 117 - [TaskrouterV1Workflow](docs/TaskrouterV1Workflow.md) 118 - [ListActivityResponseMeta](docs/ListActivityResponseMeta.md) 119 - [ListWorkerResponse](docs/ListWorkerResponse.md) 120 - [TaskrouterV1WorkspaceStatistics](docs/TaskrouterV1WorkspaceStatistics.md) 121 - [ListTaskResponse](docs/ListTaskResponse.md) 122 - [ListWorkerChannelResponse](docs/ListWorkerChannelResponse.md) 123 - [TaskrouterV1WorkerChannel](docs/TaskrouterV1WorkerChannel.md) 124 - [TaskrouterV1Workspace](docs/TaskrouterV1Workspace.md) 125 - [TaskrouterV1TaskQueueCumulativeStatistics](docs/TaskrouterV1TaskQueueCumulativeStatistics.md) 126 - [TaskrouterV1WorkersRealTimeStatistics](docs/TaskrouterV1WorkersRealTimeStatistics.md) 127 - [TaskrouterV1Worker](docs/TaskrouterV1Worker.md) 128 - [TaskrouterV1TaskQueueRealTimeStatistics](docs/TaskrouterV1TaskQueueRealTimeStatistics.md) 129 - [TaskrouterV1WorkerReservation](docs/TaskrouterV1WorkerReservation.md) 130 - [ListWorkerReservationResponse](docs/ListWorkerReservationResponse.md) 131 - [TaskrouterV1Event](docs/TaskrouterV1Event.md) 132 - [ListTaskQueueResponse](docs/ListTaskQueueResponse.md) 133 - [ListEventResponse](docs/ListEventResponse.md) 134 - [TaskrouterV1WorkflowStatistics](docs/TaskrouterV1WorkflowStatistics.md) 135 - [TaskrouterV1WorkspaceRealTimeStatistics](docs/TaskrouterV1WorkspaceRealTimeStatistics.md) 136 - [ListActivityResponse](docs/ListActivityResponse.md) 137 - [TaskrouterV1TaskQueue](docs/TaskrouterV1TaskQueue.md) 138 139 140 ## Documentation For Authorization 141 142 143 144 ## accountSid_authToken 145 146 - **Type**: HTTP basic authentication 147 148 Example 149 150 ```golang 151 auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ 152 UserName: "username", 153 Password: "password", 154 }) 155 r, err := client.Service.Operation(auth, args) 156 ``` 157