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