github.com/twilio/twilio-go@v1.20.1/rest/sync/v1/docs/ServicesStreamsApi.md (about) 1 # ServicesStreamsApi 2 3 All URIs are relative to *https://sync.twilio.com* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateSyncStream**](ServicesStreamsApi.md#CreateSyncStream) | **Post** /v1/Services/{ServiceSid}/Streams | 8 [**DeleteSyncStream**](ServicesStreamsApi.md#DeleteSyncStream) | **Delete** /v1/Services/{ServiceSid}/Streams/{Sid} | 9 [**FetchSyncStream**](ServicesStreamsApi.md#FetchSyncStream) | **Get** /v1/Services/{ServiceSid}/Streams/{Sid} | 10 [**ListSyncStream**](ServicesStreamsApi.md#ListSyncStream) | **Get** /v1/Services/{ServiceSid}/Streams | 11 [**UpdateSyncStream**](ServicesStreamsApi.md#UpdateSyncStream) | **Post** /v1/Services/{ServiceSid}/Streams/{Sid} | 12 13 14 15 ## CreateSyncStream 16 17 > SyncV1SyncStream CreateSyncStream(ctx, ServiceSidoptional) 18 19 20 21 Create a new Stream. 22 23 ### Path Parameters 24 25 26 Name | Type | Description 27 ------------- | ------------- | ------------- 28 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 29 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) to create the new Stream in. 30 31 ### Other Parameters 32 33 Other parameters are passed through a pointer to a CreateSyncStreamParams struct 34 35 36 Name | Type | Description 37 ------------- | ------------- | ------------- 38 **UniqueName** | **string** | An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource. 39 **Ttl** | **int** | How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). 40 41 ### Return type 42 43 [**SyncV1SyncStream**](SyncV1SyncStream.md) 44 45 ### Authorization 46 47 [accountSid_authToken](../README.md#accountSid_authToken) 48 49 ### HTTP request headers 50 51 - **Content-Type**: application/x-www-form-urlencoded 52 - **Accept**: application/json 53 54 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 55 [[Back to Model list]](../README.md#documentation-for-models) 56 [[Back to README]](../README.md) 57 58 59 ## DeleteSyncStream 60 61 > DeleteSyncStream(ctx, ServiceSidSid) 62 63 64 65 Delete a specific Stream. 66 67 ### Path Parameters 68 69 70 Name | Type | Description 71 ------------- | ------------- | ------------- 72 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 73 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to delete. 74 **Sid** | **string** | The SID of the Stream resource to delete. 75 76 ### Other Parameters 77 78 Other parameters are passed through a pointer to a DeleteSyncStreamParams struct 79 80 81 Name | Type | Description 82 ------------- | ------------- | ------------- 83 84 ### Return type 85 86 (empty response body) 87 88 ### Authorization 89 90 [accountSid_authToken](../README.md#accountSid_authToken) 91 92 ### HTTP request headers 93 94 - **Content-Type**: Not defined 95 - **Accept**: Not defined 96 97 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 98 [[Back to Model list]](../README.md#documentation-for-models) 99 [[Back to README]](../README.md) 100 101 102 ## FetchSyncStream 103 104 > SyncV1SyncStream FetchSyncStream(ctx, ServiceSidSid) 105 106 107 108 Fetch a specific Stream. 109 110 ### Path Parameters 111 112 113 Name | Type | Description 114 ------------- | ------------- | ------------- 115 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 116 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to fetch. 117 **Sid** | **string** | The SID of the Stream resource to fetch. 118 119 ### Other Parameters 120 121 Other parameters are passed through a pointer to a FetchSyncStreamParams struct 122 123 124 Name | Type | Description 125 ------------- | ------------- | ------------- 126 127 ### Return type 128 129 [**SyncV1SyncStream**](SyncV1SyncStream.md) 130 131 ### Authorization 132 133 [accountSid_authToken](../README.md#accountSid_authToken) 134 135 ### HTTP request headers 136 137 - **Content-Type**: Not defined 138 - **Accept**: application/json 139 140 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 141 [[Back to Model list]](../README.md#documentation-for-models) 142 [[Back to README]](../README.md) 143 144 145 ## ListSyncStream 146 147 > []SyncV1SyncStream ListSyncStream(ctx, ServiceSidoptional) 148 149 150 151 Retrieve a list of all Streams in a Service Instance. 152 153 ### Path Parameters 154 155 156 Name | Type | Description 157 ------------- | ------------- | ------------- 158 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 159 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Stream resources to read. 160 161 ### Other Parameters 162 163 Other parameters are passed through a pointer to a ListSyncStreamParams struct 164 165 166 Name | Type | Description 167 ------------- | ------------- | ------------- 168 **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000. 169 **Limit** | **int** | Max number of records to return. 170 171 ### Return type 172 173 [**[]SyncV1SyncStream**](SyncV1SyncStream.md) 174 175 ### Authorization 176 177 [accountSid_authToken](../README.md#accountSid_authToken) 178 179 ### HTTP request headers 180 181 - **Content-Type**: Not defined 182 - **Accept**: application/json 183 184 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 185 [[Back to Model list]](../README.md#documentation-for-models) 186 [[Back to README]](../README.md) 187 188 189 ## UpdateSyncStream 190 191 > SyncV1SyncStream UpdateSyncStream(ctx, ServiceSidSidoptional) 192 193 194 195 Update a specific Stream. 196 197 ### Path Parameters 198 199 200 Name | Type | Description 201 ------------- | ------------- | ------------- 202 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 203 **ServiceSid** | **string** | The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) with the Sync Stream resource to update. 204 **Sid** | **string** | The SID of the Stream resource to update. 205 206 ### Other Parameters 207 208 Other parameters are passed through a pointer to a UpdateSyncStreamParams struct 209 210 211 Name | Type | Description 212 ------------- | ------------- | ------------- 213 **Ttl** | **int** | How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live). 214 215 ### Return type 216 217 [**SyncV1SyncStream**](SyncV1SyncStream.md) 218 219 ### Authorization 220 221 [accountSid_authToken](../README.md#accountSid_authToken) 222 223 ### HTTP request headers 224 225 - **Content-Type**: application/x-www-form-urlencoded 226 - **Accept**: application/json 227 228 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 229 [[Back to Model list]](../README.md#documentation-for-models) 230 [[Back to README]](../README.md) 231