github.com/twilio/twilio-go@v1.20.1/rest/sync/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://sync.twilio.com*
    31  
    32  Class | Method | HTTP request | Description
    33  ------------ | ------------- | ------------- | -------------
    34  *ServicesApi* | [**CreateService**](docs/ServicesApi.md#createservice) | **Post** /v1/Services | 
    35  *ServicesApi* | [**DeleteService**](docs/ServicesApi.md#deleteservice) | **Delete** /v1/Services/{Sid} | 
    36  *ServicesApi* | [**FetchService**](docs/ServicesApi.md#fetchservice) | **Get** /v1/Services/{Sid} | 
    37  *ServicesApi* | [**ListService**](docs/ServicesApi.md#listservice) | **Get** /v1/Services | 
    38  *ServicesApi* | [**UpdateService**](docs/ServicesApi.md#updateservice) | **Post** /v1/Services/{Sid} | 
    39  *ServicesDocumentsApi* | [**CreateDocument**](docs/ServicesDocumentsApi.md#createdocument) | **Post** /v1/Services/{ServiceSid}/Documents | 
    40  *ServicesDocumentsApi* | [**DeleteDocument**](docs/ServicesDocumentsApi.md#deletedocument) | **Delete** /v1/Services/{ServiceSid}/Documents/{Sid} | 
    41  *ServicesDocumentsApi* | [**FetchDocument**](docs/ServicesDocumentsApi.md#fetchdocument) | **Get** /v1/Services/{ServiceSid}/Documents/{Sid} | 
    42  *ServicesDocumentsApi* | [**ListDocument**](docs/ServicesDocumentsApi.md#listdocument) | **Get** /v1/Services/{ServiceSid}/Documents | 
    43  *ServicesDocumentsApi* | [**UpdateDocument**](docs/ServicesDocumentsApi.md#updatedocument) | **Post** /v1/Services/{ServiceSid}/Documents/{Sid} | 
    44  *ServicesDocumentsPermissionsApi* | [**DeleteDocumentPermission**](docs/ServicesDocumentsPermissionsApi.md#deletedocumentpermission) | **Delete** /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | 
    45  *ServicesDocumentsPermissionsApi* | [**FetchDocumentPermission**](docs/ServicesDocumentsPermissionsApi.md#fetchdocumentpermission) | **Get** /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | 
    46  *ServicesDocumentsPermissionsApi* | [**ListDocumentPermission**](docs/ServicesDocumentsPermissionsApi.md#listdocumentpermission) | **Get** /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions | 
    47  *ServicesDocumentsPermissionsApi* | [**UpdateDocumentPermission**](docs/ServicesDocumentsPermissionsApi.md#updatedocumentpermission) | **Post** /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | 
    48  *ServicesListsApi* | [**CreateSyncList**](docs/ServicesListsApi.md#createsynclist) | **Post** /v1/Services/{ServiceSid}/Lists | 
    49  *ServicesListsApi* | [**DeleteSyncList**](docs/ServicesListsApi.md#deletesynclist) | **Delete** /v1/Services/{ServiceSid}/Lists/{Sid} | 
    50  *ServicesListsApi* | [**FetchSyncList**](docs/ServicesListsApi.md#fetchsynclist) | **Get** /v1/Services/{ServiceSid}/Lists/{Sid} | 
    51  *ServicesListsApi* | [**ListSyncList**](docs/ServicesListsApi.md#listsynclist) | **Get** /v1/Services/{ServiceSid}/Lists | 
    52  *ServicesListsApi* | [**UpdateSyncList**](docs/ServicesListsApi.md#updatesynclist) | **Post** /v1/Services/{ServiceSid}/Lists/{Sid} | 
    53  *ServicesListsItemsApi* | [**CreateSyncListItem**](docs/ServicesListsItemsApi.md#createsynclistitem) | **Post** /v1/Services/{ServiceSid}/Lists/{ListSid}/Items | 
    54  *ServicesListsItemsApi* | [**DeleteSyncListItem**](docs/ServicesListsItemsApi.md#deletesynclistitem) | **Delete** /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | 
    55  *ServicesListsItemsApi* | [**FetchSyncListItem**](docs/ServicesListsItemsApi.md#fetchsynclistitem) | **Get** /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | 
    56  *ServicesListsItemsApi* | [**ListSyncListItem**](docs/ServicesListsItemsApi.md#listsynclistitem) | **Get** /v1/Services/{ServiceSid}/Lists/{ListSid}/Items | 
    57  *ServicesListsItemsApi* | [**UpdateSyncListItem**](docs/ServicesListsItemsApi.md#updatesynclistitem) | **Post** /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | 
    58  *ServicesListsPermissionsApi* | [**DeleteSyncListPermission**](docs/ServicesListsPermissionsApi.md#deletesynclistpermission) | **Delete** /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | 
    59  *ServicesListsPermissionsApi* | [**FetchSyncListPermission**](docs/ServicesListsPermissionsApi.md#fetchsynclistpermission) | **Get** /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | 
    60  *ServicesListsPermissionsApi* | [**ListSyncListPermission**](docs/ServicesListsPermissionsApi.md#listsynclistpermission) | **Get** /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions | 
    61  *ServicesListsPermissionsApi* | [**UpdateSyncListPermission**](docs/ServicesListsPermissionsApi.md#updatesynclistpermission) | **Post** /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | 
    62  *ServicesMapsApi* | [**CreateSyncMap**](docs/ServicesMapsApi.md#createsyncmap) | **Post** /v1/Services/{ServiceSid}/Maps | 
    63  *ServicesMapsApi* | [**DeleteSyncMap**](docs/ServicesMapsApi.md#deletesyncmap) | **Delete** /v1/Services/{ServiceSid}/Maps/{Sid} | 
    64  *ServicesMapsApi* | [**FetchSyncMap**](docs/ServicesMapsApi.md#fetchsyncmap) | **Get** /v1/Services/{ServiceSid}/Maps/{Sid} | 
    65  *ServicesMapsApi* | [**ListSyncMap**](docs/ServicesMapsApi.md#listsyncmap) | **Get** /v1/Services/{ServiceSid}/Maps | 
    66  *ServicesMapsApi* | [**UpdateSyncMap**](docs/ServicesMapsApi.md#updatesyncmap) | **Post** /v1/Services/{ServiceSid}/Maps/{Sid} | 
    67  *ServicesMapsItemsApi* | [**CreateSyncMapItem**](docs/ServicesMapsItemsApi.md#createsyncmapitem) | **Post** /v1/Services/{ServiceSid}/Maps/{MapSid}/Items | 
    68  *ServicesMapsItemsApi* | [**DeleteSyncMapItem**](docs/ServicesMapsItemsApi.md#deletesyncmapitem) | **Delete** /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | 
    69  *ServicesMapsItemsApi* | [**FetchSyncMapItem**](docs/ServicesMapsItemsApi.md#fetchsyncmapitem) | **Get** /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | 
    70  *ServicesMapsItemsApi* | [**ListSyncMapItem**](docs/ServicesMapsItemsApi.md#listsyncmapitem) | **Get** /v1/Services/{ServiceSid}/Maps/{MapSid}/Items | 
    71  *ServicesMapsItemsApi* | [**UpdateSyncMapItem**](docs/ServicesMapsItemsApi.md#updatesyncmapitem) | **Post** /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | 
    72  *ServicesMapsPermissionsApi* | [**DeleteSyncMapPermission**](docs/ServicesMapsPermissionsApi.md#deletesyncmappermission) | **Delete** /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | 
    73  *ServicesMapsPermissionsApi* | [**FetchSyncMapPermission**](docs/ServicesMapsPermissionsApi.md#fetchsyncmappermission) | **Get** /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | 
    74  *ServicesMapsPermissionsApi* | [**ListSyncMapPermission**](docs/ServicesMapsPermissionsApi.md#listsyncmappermission) | **Get** /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions | 
    75  *ServicesMapsPermissionsApi* | [**UpdateSyncMapPermission**](docs/ServicesMapsPermissionsApi.md#updatesyncmappermission) | **Post** /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | 
    76  *ServicesStreamsApi* | [**CreateSyncStream**](docs/ServicesStreamsApi.md#createsyncstream) | **Post** /v1/Services/{ServiceSid}/Streams | 
    77  *ServicesStreamsApi* | [**DeleteSyncStream**](docs/ServicesStreamsApi.md#deletesyncstream) | **Delete** /v1/Services/{ServiceSid}/Streams/{Sid} | 
    78  *ServicesStreamsApi* | [**FetchSyncStream**](docs/ServicesStreamsApi.md#fetchsyncstream) | **Get** /v1/Services/{ServiceSid}/Streams/{Sid} | 
    79  *ServicesStreamsApi* | [**ListSyncStream**](docs/ServicesStreamsApi.md#listsyncstream) | **Get** /v1/Services/{ServiceSid}/Streams | 
    80  *ServicesStreamsApi* | [**UpdateSyncStream**](docs/ServicesStreamsApi.md#updatesyncstream) | **Post** /v1/Services/{ServiceSid}/Streams/{Sid} | 
    81  *ServicesStreamsMessagesApi* | [**CreateStreamMessage**](docs/ServicesStreamsMessagesApi.md#createstreammessage) | **Post** /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages | 
    82  
    83  
    84  ## Documentation For Models
    85  
    86   - [ListSyncStreamResponse](docs/ListSyncStreamResponse.md)
    87   - [SyncV1StreamMessage](docs/SyncV1StreamMessage.md)
    88   - [ListDocumentResponse](docs/ListDocumentResponse.md)
    89   - [SyncV1SyncMap](docs/SyncV1SyncMap.md)
    90   - [ListDocumentResponseMeta](docs/ListDocumentResponseMeta.md)
    91   - [ListSyncListPermissionResponse](docs/ListSyncListPermissionResponse.md)
    92   - [SyncV1SyncListItem](docs/SyncV1SyncListItem.md)
    93   - [ListSyncMapPermissionResponse](docs/ListSyncMapPermissionResponse.md)
    94   - [ListSyncMapResponse](docs/ListSyncMapResponse.md)
    95   - [SyncV1SyncListPermission](docs/SyncV1SyncListPermission.md)
    96   - [ListServiceResponse](docs/ListServiceResponse.md)
    97   - [SyncV1SyncMapPermission](docs/SyncV1SyncMapPermission.md)
    98   - [SyncV1DocumentPermission](docs/SyncV1DocumentPermission.md)
    99   - [SyncV1SyncMapItem](docs/SyncV1SyncMapItem.md)
   100   - [ListDocumentPermissionResponse](docs/ListDocumentPermissionResponse.md)
   101   - [SyncV1Document](docs/SyncV1Document.md)
   102   - [SyncV1SyncList](docs/SyncV1SyncList.md)
   103   - [ListSyncListResponse](docs/ListSyncListResponse.md)
   104   - [ListSyncListItemResponse](docs/ListSyncListItemResponse.md)
   105   - [SyncV1SyncStream](docs/SyncV1SyncStream.md)
   106   - [SyncV1Service](docs/SyncV1Service.md)
   107   - [ListSyncMapItemResponse](docs/ListSyncMapItemResponse.md)
   108  
   109  
   110  ## Documentation For Authorization
   111  
   112  
   113  
   114  ## accountSid_authToken
   115  
   116  - **Type**: HTTP basic authentication
   117  
   118  Example
   119  
   120  ```golang
   121  auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
   122      UserName: "username",
   123      Password: "password",
   124  })
   125  r, err := client.Service.Operation(auth, args)
   126  ```
   127