package
1.22.3
Repository: https://github.com/twilio/twilio-go.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
ServicesApiCreateServicePost /v1/Services
ServicesApiDeleteServiceDelete /v1/Services/{Sid}
ServicesApiFetchServiceGet /v1/Services/{Sid}
ServicesApiListServiceGet /v1/Services
ServicesApiUpdateServicePost /v1/Services/{Sid}
ServicesDocumentsApiCreateDocumentPost /v1/Services/{ServiceSid}/Documents
ServicesDocumentsApiDeleteDocumentDelete /v1/Services/{ServiceSid}/Documents/{Sid}
ServicesDocumentsApiFetchDocumentGet /v1/Services/{ServiceSid}/Documents/{Sid}
ServicesDocumentsApiListDocumentGet /v1/Services/{ServiceSid}/Documents
ServicesDocumentsApiUpdateDocumentPost /v1/Services/{ServiceSid}/Documents/{Sid}
ServicesDocumentsPermissionsApiDeleteDocumentPermissionDelete /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
ServicesDocumentsPermissionsApiFetchDocumentPermissionGet /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
ServicesDocumentsPermissionsApiListDocumentPermissionGet /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions
ServicesDocumentsPermissionsApiUpdateDocumentPermissionPost /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
ServicesListsApiCreateSyncListPost /v1/Services/{ServiceSid}/Lists
ServicesListsApiDeleteSyncListDelete /v1/Services/{ServiceSid}/Lists/{Sid}
ServicesListsApiFetchSyncListGet /v1/Services/{ServiceSid}/Lists/{Sid}
ServicesListsApiListSyncListGet /v1/Services/{ServiceSid}/Lists
ServicesListsApiUpdateSyncListPost /v1/Services/{ServiceSid}/Lists/{Sid}
ServicesListsItemsApiCreateSyncListItemPost /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
ServicesListsItemsApiDeleteSyncListItemDelete /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
ServicesListsItemsApiFetchSyncListItemGet /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
ServicesListsItemsApiListSyncListItemGet /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
ServicesListsItemsApiUpdateSyncListItemPost /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
ServicesListsPermissionsApiDeleteSyncListPermissionDelete /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
ServicesListsPermissionsApiFetchSyncListPermissionGet /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
ServicesListsPermissionsApiListSyncListPermissionGet /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions
ServicesListsPermissionsApiUpdateSyncListPermissionPost /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
ServicesMapsApiCreateSyncMapPost /v1/Services/{ServiceSid}/Maps
ServicesMapsApiDeleteSyncMapDelete /v1/Services/{ServiceSid}/Maps/{Sid}
ServicesMapsApiFetchSyncMapGet /v1/Services/{ServiceSid}/Maps/{Sid}
ServicesMapsApiListSyncMapGet /v1/Services/{ServiceSid}/Maps
ServicesMapsApiUpdateSyncMapPost /v1/Services/{ServiceSid}/Maps/{Sid}
ServicesMapsItemsApiCreateSyncMapItemPost /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
ServicesMapsItemsApiDeleteSyncMapItemDelete /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
ServicesMapsItemsApiFetchSyncMapItemGet /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
ServicesMapsItemsApiListSyncMapItemGet /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
ServicesMapsItemsApiUpdateSyncMapItemPost /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
ServicesMapsPermissionsApiDeleteSyncMapPermissionDelete /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
ServicesMapsPermissionsApiFetchSyncMapPermissionGet /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
ServicesMapsPermissionsApiListSyncMapPermissionGet /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions
ServicesMapsPermissionsApiUpdateSyncMapPermissionPost /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
ServicesStreamsApiCreateSyncStreamPost /v1/Services/{ServiceSid}/Streams
ServicesStreamsApiDeleteSyncStreamDelete /v1/Services/{ServiceSid}/Streams/{Sid}
ServicesStreamsApiFetchSyncStreamGet /v1/Services/{ServiceSid}/Streams/{Sid}
ServicesStreamsApiListSyncStreamGet /v1/Services/{ServiceSid}/Streams
ServicesStreamsApiUpdateSyncStreamPost /v1/Services/{ServiceSid}/Streams/{Sid}
ServicesStreamsMessagesApiCreateStreamMessagePost /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages

Documentation For Models

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'.