# 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.0.0
- 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://sync.twilio.com
Class | Method | HTTP request | Description |
---|---|---|---|
ServicesApi | CreateService | Post /v1/Services | |
ServicesApi | DeleteService | Delete /v1/Services/{Sid} | |
ServicesApi | FetchService | Get /v1/Services/{Sid} | |
ServicesApi | ListService | Get /v1/Services | |
ServicesApi | UpdateService | Post /v1/Services/{Sid} | |
ServicesDocumentsApi | CreateDocument | Post /v1/Services/{ServiceSid}/Documents | |
ServicesDocumentsApi | DeleteDocument | Delete /v1/Services/{ServiceSid}/Documents/{Sid} | |
ServicesDocumentsApi | FetchDocument | Get /v1/Services/{ServiceSid}/Documents/{Sid} | |
ServicesDocumentsApi | ListDocument | Get /v1/Services/{ServiceSid}/Documents | |
ServicesDocumentsApi | UpdateDocument | Post /v1/Services/{ServiceSid}/Documents/{Sid} | |
ServicesDocumentsPermissionsApi | DeleteDocumentPermission | Delete /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | |
ServicesDocumentsPermissionsApi | FetchDocumentPermission | Get /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | |
ServicesDocumentsPermissionsApi | ListDocumentPermission | Get /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions | |
ServicesDocumentsPermissionsApi | UpdateDocumentPermission | Post /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity} | |
ServicesListsApi | CreateSyncList | Post /v1/Services/{ServiceSid}/Lists | |
ServicesListsApi | DeleteSyncList | Delete /v1/Services/{ServiceSid}/Lists/{Sid} | |
ServicesListsApi | FetchSyncList | Get /v1/Services/{ServiceSid}/Lists/{Sid} | |
ServicesListsApi | ListSyncList | Get /v1/Services/{ServiceSid}/Lists | |
ServicesListsApi | UpdateSyncList | Post /v1/Services/{ServiceSid}/Lists/{Sid} | |
ServicesListsItemsApi | CreateSyncListItem | Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Items | |
ServicesListsItemsApi | DeleteSyncListItem | Delete /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | |
ServicesListsItemsApi | FetchSyncListItem | Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | |
ServicesListsItemsApi | ListSyncListItem | Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Items | |
ServicesListsItemsApi | UpdateSyncListItem | Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} | |
ServicesListsPermissionsApi | DeleteSyncListPermission | Delete /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | |
ServicesListsPermissionsApi | FetchSyncListPermission | Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | |
ServicesListsPermissionsApi | ListSyncListPermission | Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions | |
ServicesListsPermissionsApi | UpdateSyncListPermission | Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity} | |
ServicesMapsApi | CreateSyncMap | Post /v1/Services/{ServiceSid}/Maps | |
ServicesMapsApi | DeleteSyncMap | Delete /v1/Services/{ServiceSid}/Maps/{Sid} | |
ServicesMapsApi | FetchSyncMap | Get /v1/Services/{ServiceSid}/Maps/{Sid} | |
ServicesMapsApi | ListSyncMap | Get /v1/Services/{ServiceSid}/Maps | |
ServicesMapsApi | UpdateSyncMap | Post /v1/Services/{ServiceSid}/Maps/{Sid} | |
ServicesMapsItemsApi | CreateSyncMapItem | Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Items | |
ServicesMapsItemsApi | DeleteSyncMapItem | Delete /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | |
ServicesMapsItemsApi | FetchSyncMapItem | Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | |
ServicesMapsItemsApi | ListSyncMapItem | Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Items | |
ServicesMapsItemsApi | UpdateSyncMapItem | Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key} | |
ServicesMapsPermissionsApi | DeleteSyncMapPermission | Delete /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | |
ServicesMapsPermissionsApi | FetchSyncMapPermission | Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | |
ServicesMapsPermissionsApi | ListSyncMapPermission | Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions | |
ServicesMapsPermissionsApi | UpdateSyncMapPermission | Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity} | |
ServicesStreamsApi | CreateSyncStream | Post /v1/Services/{ServiceSid}/Streams | |
ServicesStreamsApi | DeleteSyncStream | Delete /v1/Services/{ServiceSid}/Streams/{Sid} | |
ServicesStreamsApi | FetchSyncStream | Get /v1/Services/{ServiceSid}/Streams/{Sid} | |
ServicesStreamsApi | ListSyncStream | Get /v1/Services/{ServiceSid}/Streams | |
ServicesStreamsApi | UpdateSyncStream | Post /v1/Services/{ServiceSid}/Streams/{Sid} | |
ServicesStreamsMessagesApi | CreateStreamMessage | Post /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages |
Documentation For Models
- ListSyncStreamResponse
- SyncV1StreamMessage
- ListDocumentResponse
- SyncV1SyncMap
- ListDocumentResponseMeta
- ListSyncListPermissionResponse
- SyncV1SyncListItem
- ListSyncMapPermissionResponse
- ListSyncMapResponse
- SyncV1SyncListPermission
- ListServiceResponse
- SyncV1SyncMapPermission
- SyncV1DocumentPermission
- SyncV1SyncMapItem
- ListDocumentPermissionResponse
- SyncV1Document
- SyncV1SyncList
- ListSyncListResponse
- ListSyncListItemResponse
- SyncV1SyncStream
- SyncV1Service
- ListSyncMapItemResponse
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)
# Functions
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
Optional parameters for the method 'CreateDocument'.
Optional parameters for the method 'CreateService'.
Optional parameters for the method 'CreateStreamMessage'.
Optional parameters for the method 'CreateSyncListItem'.
Optional parameters for the method 'CreateSyncList'.
Optional parameters for the method 'CreateSyncMapItem'.
Optional parameters for the method 'CreateSyncMap'.
Optional parameters for the method 'CreateSyncStream'.
Optional parameters for the method 'DeleteSyncListItem'.
Optional parameters for the method 'DeleteSyncMapItem'.
Optional parameters for the method 'ListDocument'.
Optional parameters for the method 'ListDocumentPermission'.
ListDocumentPermissionResponse struct for ListDocumentPermissionResponse.
ListDocumentResponse struct for ListDocumentResponse.
ListDocumentResponseMeta struct for ListDocumentResponseMeta.
Optional parameters for the method 'ListService'.
ListServiceResponse struct for ListServiceResponse.
Optional parameters for the method 'ListSyncListItem'.
ListSyncListItemResponse struct for ListSyncListItemResponse.
Optional parameters for the method 'ListSyncList'.
Optional parameters for the method 'ListSyncListPermission'.
ListSyncListPermissionResponse struct for ListSyncListPermissionResponse.
ListSyncListResponse struct for ListSyncListResponse.
Optional parameters for the method 'ListSyncMapItem'.
ListSyncMapItemResponse struct for ListSyncMapItemResponse.
Optional parameters for the method 'ListSyncMap'.
Optional parameters for the method 'ListSyncMapPermission'.
ListSyncMapPermissionResponse struct for ListSyncMapPermissionResponse.
ListSyncMapResponse struct for ListSyncMapResponse.
Optional parameters for the method 'ListSyncStream'.
ListSyncStreamResponse struct for ListSyncStreamResponse.
SyncV1Document struct for SyncV1Document.
SyncV1DocumentPermission struct for SyncV1DocumentPermission.
SyncV1Service struct for SyncV1Service.
SyncV1StreamMessage struct for SyncV1StreamMessage.
SyncV1SyncList struct for SyncV1SyncList.
SyncV1SyncListItem struct for SyncV1SyncListItem.
SyncV1SyncListPermission struct for SyncV1SyncListPermission.
SyncV1SyncMap struct for SyncV1SyncMap.
SyncV1SyncMapItem struct for SyncV1SyncMapItem.
SyncV1SyncMapPermission struct for SyncV1SyncMapPermission.
SyncV1SyncStream struct for SyncV1SyncStream.
Optional parameters for the method 'UpdateDocument'.
Optional parameters for the method 'UpdateDocumentPermission'.
Optional parameters for the method 'UpdateService'.
Optional parameters for the method 'UpdateSyncListItem'.
Optional parameters for the method 'UpdateSyncList'.
Optional parameters for the method 'UpdateSyncListPermission'.
Optional parameters for the method 'UpdateSyncMapItem'.
Optional parameters for the method 'UpdateSyncMap'.
Optional parameters for the method 'UpdateSyncMapPermission'.
Optional parameters for the method 'UpdateSyncStream'.