openapi

package
v1.7.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 1, 2023 License: MIT Imports: 6 Imported by: 1

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.43.2
  • 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

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)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

type ApiService struct {
	// contains filtered or unexported fields
}

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateDocument added in v0.11.0 

func (c *ApiService) CreateDocument(ServiceSid string, params *CreateDocumentParams) (*SyncV1Document, error)

func (*ApiService) CreateService added in v0.11.0 

func (c *ApiService) CreateService(params *CreateServiceParams) (*SyncV1Service, error)

func (*ApiService) CreateStreamMessage added in v0.11.0 

func (c *ApiService) CreateStreamMessage(ServiceSid string, StreamSid string, params *CreateStreamMessageParams) (*SyncV1StreamMessage, error)

Create a new Stream Message.

func (*ApiService) CreateSyncList added in v0.11.0 

func (c *ApiService) CreateSyncList(ServiceSid string, params *CreateSyncListParams) (*SyncV1SyncList, error)

func (*ApiService) CreateSyncListItem added in v0.11.0 

func (c *ApiService) CreateSyncListItem(ServiceSid string, ListSid string, params *CreateSyncListItemParams) (*SyncV1SyncListItem, error)

func (*ApiService) CreateSyncMap added in v0.11.0 

func (c *ApiService) CreateSyncMap(ServiceSid string, params *CreateSyncMapParams) (*SyncV1SyncMap, error)

func (*ApiService) CreateSyncMapItem added in v0.11.0 

func (c *ApiService) CreateSyncMapItem(ServiceSid string, MapSid string, params *CreateSyncMapItemParams) (*SyncV1SyncMapItem, error)

func (*ApiService) CreateSyncStream added in v0.11.0 

func (c *ApiService) CreateSyncStream(ServiceSid string, params *CreateSyncStreamParams) (*SyncV1SyncStream, error)

Create a new Stream.

func (*ApiService) DeleteDocument added in v0.11.0 

func (c *ApiService) DeleteDocument(ServiceSid string, Sid string) error

func (*ApiService) DeleteDocumentPermission added in v0.11.0 

func (c *ApiService) DeleteDocumentPermission(ServiceSid string, DocumentSid string, Identity string) error

Delete a specific Sync Document Permission.

func (*ApiService) DeleteService added in v0.11.0 

func (c *ApiService) DeleteService(Sid string) error

func (*ApiService) DeleteSyncList added in v0.11.0 

func (c *ApiService) DeleteSyncList(ServiceSid string, Sid string) error

func (*ApiService) DeleteSyncListItem added in v0.11.0 

func (c *ApiService) DeleteSyncListItem(ServiceSid string, ListSid string, Index int, params *DeleteSyncListItemParams) error

func (*ApiService) DeleteSyncListPermission added in v0.11.0 

func (c *ApiService) DeleteSyncListPermission(ServiceSid string, ListSid string, Identity string) error

Delete a specific Sync List Permission.

func (*ApiService) DeleteSyncMap added in v0.11.0 

func (c *ApiService) DeleteSyncMap(ServiceSid string, Sid string) error

func (*ApiService) DeleteSyncMapItem added in v0.11.0 

func (c *ApiService) DeleteSyncMapItem(ServiceSid string, MapSid string, Key string, params *DeleteSyncMapItemParams) error

func (*ApiService) DeleteSyncMapPermission added in v0.11.0 

func (c *ApiService) DeleteSyncMapPermission(ServiceSid string, MapSid string, Identity string) error

Delete a specific Sync Map Permission.

func (*ApiService) DeleteSyncStream added in v0.11.0 

func (c *ApiService) DeleteSyncStream(ServiceSid string, Sid string) error

Delete a specific Stream.

func (*ApiService) FetchDocument added in v0.11.0 

func (c *ApiService) FetchDocument(ServiceSid string, Sid string) (*SyncV1Document, error)

func (*ApiService) FetchDocumentPermission added in v0.11.0 

func (c *ApiService) FetchDocumentPermission(ServiceSid string, DocumentSid string, Identity string) (*SyncV1DocumentPermission, error)

Fetch a specific Sync Document Permission.

func (*ApiService) FetchService added in v0.11.0 

func (c *ApiService) FetchService(Sid string) (*SyncV1Service, error)

func (*ApiService) FetchSyncList added in v0.11.0 

func (c *ApiService) FetchSyncList(ServiceSid string, Sid string) (*SyncV1SyncList, error)

func (*ApiService) FetchSyncListItem added in v0.11.0 

func (c *ApiService) FetchSyncListItem(ServiceSid string, ListSid string, Index int) (*SyncV1SyncListItem, error)

func (*ApiService) FetchSyncListPermission added in v0.11.0 

func (c *ApiService) FetchSyncListPermission(ServiceSid string, ListSid string, Identity string) (*SyncV1SyncListPermission, error)

Fetch a specific Sync List Permission.

func (*ApiService) FetchSyncMap added in v0.11.0 

func (c *ApiService) FetchSyncMap(ServiceSid string, Sid string) (*SyncV1SyncMap, error)

func (*ApiService) FetchSyncMapItem added in v0.11.0 

func (c *ApiService) FetchSyncMapItem(ServiceSid string, MapSid string, Key string) (*SyncV1SyncMapItem, error)

func (*ApiService) FetchSyncMapPermission added in v0.11.0 

func (c *ApiService) FetchSyncMapPermission(ServiceSid string, MapSid string, Identity string) (*SyncV1SyncMapPermission, error)

Fetch a specific Sync Map Permission.

func (*ApiService) FetchSyncStream added in v0.11.0 

func (c *ApiService) FetchSyncStream(ServiceSid string, Sid string) (*SyncV1SyncStream, error)

Fetch a specific Stream.

func (*ApiService) ListDocument added in v0.11.0 

func (c *ApiService) ListDocument(ServiceSid string, params *ListDocumentParams) ([]SyncV1Document, error)

Lists Document records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListDocumentPermission added in v0.11.0 

func (c *ApiService) ListDocumentPermission(ServiceSid string, DocumentSid string, params *ListDocumentPermissionParams) ([]SyncV1DocumentPermission, error)

Lists DocumentPermission records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListService added in v0.11.0 

func (c *ApiService) ListService(params *ListServiceParams) ([]SyncV1Service, error)

Lists Service records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncList added in v0.11.0 

func (c *ApiService) ListSyncList(ServiceSid string, params *ListSyncListParams) ([]SyncV1SyncList, error)

Lists SyncList records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncListItem added in v0.11.0 

func (c *ApiService) ListSyncListItem(ServiceSid string, ListSid string, params *ListSyncListItemParams) ([]SyncV1SyncListItem, error)

Lists SyncListItem records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncListPermission added in v0.11.0 

func (c *ApiService) ListSyncListPermission(ServiceSid string, ListSid string, params *ListSyncListPermissionParams) ([]SyncV1SyncListPermission, error)

Lists SyncListPermission records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncMap added in v0.11.0 

func (c *ApiService) ListSyncMap(ServiceSid string, params *ListSyncMapParams) ([]SyncV1SyncMap, error)

Lists SyncMap records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncMapItem added in v0.11.0 

func (c *ApiService) ListSyncMapItem(ServiceSid string, MapSid string, params *ListSyncMapItemParams) ([]SyncV1SyncMapItem, error)

Lists SyncMapItem records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncMapPermission added in v0.11.0 

func (c *ApiService) ListSyncMapPermission(ServiceSid string, MapSid string, params *ListSyncMapPermissionParams) ([]SyncV1SyncMapPermission, error)

Lists SyncMapPermission records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListSyncStream added in v0.11.0 

func (c *ApiService) ListSyncStream(ServiceSid string, params *ListSyncStreamParams) ([]SyncV1SyncStream, error)

Lists SyncStream records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageDocument added in v0.13.0 

func (c *ApiService) PageDocument(ServiceSid string, params *ListDocumentParams, pageToken, pageNumber string) (*ListDocumentResponse, error)

Retrieve a single page of Document records from the API. Request is executed immediately.

func (*ApiService) PageDocumentPermission added in v0.13.0 

func (c *ApiService) PageDocumentPermission(ServiceSid string, DocumentSid string, params *ListDocumentPermissionParams, pageToken, pageNumber string) (*ListDocumentPermissionResponse, error)

Retrieve a single page of DocumentPermission records from the API. Request is executed immediately.

func (*ApiService) PageService added in v0.13.0 

func (c *ApiService) PageService(params *ListServiceParams, pageToken, pageNumber string) (*ListServiceResponse, error)

Retrieve a single page of Service records from the API. Request is executed immediately.

func (*ApiService) PageSyncList added in v0.13.0 

func (c *ApiService) PageSyncList(ServiceSid string, params *ListSyncListParams, pageToken, pageNumber string) (*ListSyncListResponse, error)

Retrieve a single page of SyncList records from the API. Request is executed immediately.

func (*ApiService) PageSyncListItem added in v0.13.0 

func (c *ApiService) PageSyncListItem(ServiceSid string, ListSid string, params *ListSyncListItemParams, pageToken, pageNumber string) (*ListSyncListItemResponse, error)

Retrieve a single page of SyncListItem records from the API. Request is executed immediately.

func (*ApiService) PageSyncListPermission added in v0.13.0 

func (c *ApiService) PageSyncListPermission(ServiceSid string, ListSid string, params *ListSyncListPermissionParams, pageToken, pageNumber string) (*ListSyncListPermissionResponse, error)

Retrieve a single page of SyncListPermission records from the API. Request is executed immediately.

func (*ApiService) PageSyncMap added in v0.13.0 

func (c *ApiService) PageSyncMap(ServiceSid string, params *ListSyncMapParams, pageToken, pageNumber string) (*ListSyncMapResponse, error)

Retrieve a single page of SyncMap records from the API. Request is executed immediately.

func (*ApiService) PageSyncMapItem added in v0.13.0 

func (c *ApiService) PageSyncMapItem(ServiceSid string, MapSid string, params *ListSyncMapItemParams, pageToken, pageNumber string) (*ListSyncMapItemResponse, error)

Retrieve a single page of SyncMapItem records from the API. Request is executed immediately.

func (*ApiService) PageSyncMapPermission added in v0.13.0 

func (c *ApiService) PageSyncMapPermission(ServiceSid string, MapSid string, params *ListSyncMapPermissionParams, pageToken, pageNumber string) (*ListSyncMapPermissionResponse, error)

Retrieve a single page of SyncMapPermission records from the API. Request is executed immediately.

func (*ApiService) PageSyncStream added in v0.13.0 

func (c *ApiService) PageSyncStream(ServiceSid string, params *ListSyncStreamParams, pageToken, pageNumber string) (*ListSyncStreamResponse, error)

Retrieve a single page of SyncStream records from the API. Request is executed immediately.

func (*ApiService) StreamDocument added in v0.13.0 

func (c *ApiService) StreamDocument(ServiceSid string, params *ListDocumentParams) (chan SyncV1Document, chan error)

Streams Document records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamDocumentPermission added in v0.13.0 

func (c *ApiService) StreamDocumentPermission(ServiceSid string, DocumentSid string, params *ListDocumentPermissionParams) (chan SyncV1DocumentPermission, chan error)

Streams DocumentPermission records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamService added in v0.13.0 

func (c *ApiService) StreamService(params *ListServiceParams) (chan SyncV1Service, chan error)

Streams Service records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncList added in v0.13.0 

func (c *ApiService) StreamSyncList(ServiceSid string, params *ListSyncListParams) (chan SyncV1SyncList, chan error)

Streams SyncList records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncListItem added in v0.13.0 

func (c *ApiService) StreamSyncListItem(ServiceSid string, ListSid string, params *ListSyncListItemParams) (chan SyncV1SyncListItem, chan error)

Streams SyncListItem records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncListPermission added in v0.13.0 

func (c *ApiService) StreamSyncListPermission(ServiceSid string, ListSid string, params *ListSyncListPermissionParams) (chan SyncV1SyncListPermission, chan error)

Streams SyncListPermission records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncMap added in v0.13.0 

func (c *ApiService) StreamSyncMap(ServiceSid string, params *ListSyncMapParams) (chan SyncV1SyncMap, chan error)

Streams SyncMap records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncMapItem added in v0.13.0 

func (c *ApiService) StreamSyncMapItem(ServiceSid string, MapSid string, params *ListSyncMapItemParams) (chan SyncV1SyncMapItem, chan error)

Streams SyncMapItem records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncMapPermission added in v0.13.0 

func (c *ApiService) StreamSyncMapPermission(ServiceSid string, MapSid string, params *ListSyncMapPermissionParams) (chan SyncV1SyncMapPermission, chan error)

Streams SyncMapPermission records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamSyncStream added in v0.13.0 

func (c *ApiService) StreamSyncStream(ServiceSid string, params *ListSyncStreamParams) (chan SyncV1SyncStream, chan error)

Streams SyncStream records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateDocument added in v0.11.0 

func (c *ApiService) UpdateDocument(ServiceSid string, Sid string, params *UpdateDocumentParams) (*SyncV1Document, error)

func (*ApiService) UpdateDocumentPermission added in v0.11.0 

func (c *ApiService) UpdateDocumentPermission(ServiceSid string, DocumentSid string, Identity string, params *UpdateDocumentPermissionParams) (*SyncV1DocumentPermission, error)

Update an identity's access to a specific Sync Document.

func (*ApiService) UpdateService added in v0.11.0 

func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*SyncV1Service, error)

func (*ApiService) UpdateSyncList added in v0.11.0 

func (c *ApiService) UpdateSyncList(ServiceSid string, Sid string, params *UpdateSyncListParams) (*SyncV1SyncList, error)

func (*ApiService) UpdateSyncListItem added in v0.11.0 

func (c *ApiService) UpdateSyncListItem(ServiceSid string, ListSid string, Index int, params *UpdateSyncListItemParams) (*SyncV1SyncListItem, error)

func (*ApiService) UpdateSyncListPermission added in v0.11.0 

func (c *ApiService) UpdateSyncListPermission(ServiceSid string, ListSid string, Identity string, params *UpdateSyncListPermissionParams) (*SyncV1SyncListPermission, error)

Update an identity's access to a specific Sync List.

func (*ApiService) UpdateSyncMap added in v0.11.0 

func (c *ApiService) UpdateSyncMap(ServiceSid string, Sid string, params *UpdateSyncMapParams) (*SyncV1SyncMap, error)

func (*ApiService) UpdateSyncMapItem added in v0.11.0 

func (c *ApiService) UpdateSyncMapItem(ServiceSid string, MapSid string, Key string, params *UpdateSyncMapItemParams) (*SyncV1SyncMapItem, error)

func (*ApiService) UpdateSyncMapPermission added in v0.11.0 

func (c *ApiService) UpdateSyncMapPermission(ServiceSid string, MapSid string, Identity string, params *UpdateSyncMapPermissionParams) (*SyncV1SyncMapPermission, error)

Update an identity's access to a specific Sync Map.

func (*ApiService) UpdateSyncStream added in v0.11.0 

func (c *ApiService) UpdateSyncStream(ServiceSid string, Sid string, params *UpdateSyncStreamParams) (*SyncV1SyncStream, error)

Update a specific Stream.

type CreateDocumentParams 

type CreateDocumentParams struct {
	// An application-defined string that uniquely identifies the Sync Document
	UniqueName *string `json:"UniqueName,omitempty"`
	// A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// 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).
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateDocument'

func (*CreateDocumentParams) SetData 

func (params *CreateDocumentParams) SetData(Data interface{}) *CreateDocumentParams

func (*CreateDocumentParams) SetTtl 

func (params *CreateDocumentParams) SetTtl(Ttl int) *CreateDocumentParams

func (*CreateDocumentParams) SetUniqueName 

func (params *CreateDocumentParams) SetUniqueName(UniqueName string) *CreateDocumentParams

type CreateServiceParams 

type CreateServiceParams struct {
	// A string that you assign to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The URL we should call when Sync objects are manipulated.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	// Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.
	ReachabilityWebhooksEnabled *bool `json:"ReachabilityWebhooksEnabled,omitempty"`
	// Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
	AclEnabled *bool `json:"AclEnabled,omitempty"`
	// Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.
	ReachabilityDebouncingEnabled *bool `json:"ReachabilityDebouncingEnabled,omitempty"`
	// The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the `webhook_url` is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to `webhook_url`.
	ReachabilityDebouncingWindow *int `json:"ReachabilityDebouncingWindow,omitempty"`
	// Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.
	WebhooksFromRestEnabled *bool `json:"WebhooksFromRestEnabled,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetAclEnabled 

func (params *CreateServiceParams) SetAclEnabled(AclEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetFriendlyName 

func (params *CreateServiceParams) SetFriendlyName(FriendlyName string) *CreateServiceParams

func (*CreateServiceParams) SetReachabilityDebouncingEnabled 

func (params *CreateServiceParams) SetReachabilityDebouncingEnabled(ReachabilityDebouncingEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetReachabilityDebouncingWindow 

func (params *CreateServiceParams) SetReachabilityDebouncingWindow(ReachabilityDebouncingWindow int) *CreateServiceParams

func (*CreateServiceParams) SetReachabilityWebhooksEnabled 

func (params *CreateServiceParams) SetReachabilityWebhooksEnabled(ReachabilityWebhooksEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetWebhookUrl 

func (params *CreateServiceParams) SetWebhookUrl(WebhookUrl string) *CreateServiceParams

func (*CreateServiceParams) SetWebhooksFromRestEnabled 

func (params *CreateServiceParams) SetWebhooksFromRestEnabled(WebhooksFromRestEnabled bool) *CreateServiceParams

type CreateStreamMessageParams 

type CreateStreamMessageParams struct {
	// A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
}

Optional parameters for the method 'CreateStreamMessage'

func (*CreateStreamMessageParams) SetData 

func (params *CreateStreamMessageParams) SetData(Data interface{}) *CreateStreamMessageParams

type CreateSyncListItemParams 

type CreateSyncListItemParams struct {
	// A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted.
	ItemTtl *int `json:"ItemTtl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'CreateSyncListItem'

func (*CreateSyncListItemParams) SetCollectionTtl 

func (params *CreateSyncListItemParams) SetCollectionTtl(CollectionTtl int) *CreateSyncListItemParams

func (*CreateSyncListItemParams) SetData 

func (params *CreateSyncListItemParams) SetData(Data interface{}) *CreateSyncListItemParams

func (*CreateSyncListItemParams) SetItemTtl 

func (params *CreateSyncListItemParams) SetItemTtl(ItemTtl int) *CreateSyncListItemParams

func (*CreateSyncListItemParams) SetTtl 

func (params *CreateSyncListItemParams) SetTtl(Ttl int) *CreateSyncListItemParams

type CreateSyncListParams 

type CreateSyncListParams struct {
	// 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.
	UniqueName *string `json:"UniqueName,omitempty"`
	// Alias for collection_ttl. If both are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'CreateSyncList'

func (*CreateSyncListParams) SetCollectionTtl 

func (params *CreateSyncListParams) SetCollectionTtl(CollectionTtl int) *CreateSyncListParams

func (*CreateSyncListParams) SetTtl 

func (params *CreateSyncListParams) SetTtl(Ttl int) *CreateSyncListParams

func (*CreateSyncListParams) SetUniqueName 

func (params *CreateSyncListParams) SetUniqueName(UniqueName string) *CreateSyncListParams

type CreateSyncMapItemParams 

type CreateSyncMapItemParams struct {
	// The unique, user-defined key for the Map Item. Can be up to 320 characters long.
	Key *string `json:"Key,omitempty"`
	// A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
	ItemTtl *int `json:"ItemTtl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'CreateSyncMapItem'

func (*CreateSyncMapItemParams) SetCollectionTtl 

func (params *CreateSyncMapItemParams) SetCollectionTtl(CollectionTtl int) *CreateSyncMapItemParams

func (*CreateSyncMapItemParams) SetData 

func (params *CreateSyncMapItemParams) SetData(Data interface{}) *CreateSyncMapItemParams

func (*CreateSyncMapItemParams) SetItemTtl 

func (params *CreateSyncMapItemParams) SetItemTtl(ItemTtl int) *CreateSyncMapItemParams

func (*CreateSyncMapItemParams) SetKey 

func (params *CreateSyncMapItemParams) SetKey(Key string) *CreateSyncMapItemParams

func (*CreateSyncMapItemParams) SetTtl 

func (params *CreateSyncMapItemParams) SetTtl(Ttl int) *CreateSyncMapItemParams

type CreateSyncMapParams 

type CreateSyncMapParams struct {
	// An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource.
	UniqueName *string `json:"UniqueName,omitempty"`
	// An alias for `collection_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'CreateSyncMap'

func (*CreateSyncMapParams) SetCollectionTtl 

func (params *CreateSyncMapParams) SetCollectionTtl(CollectionTtl int) *CreateSyncMapParams

func (*CreateSyncMapParams) SetTtl 

func (params *CreateSyncMapParams) SetTtl(Ttl int) *CreateSyncMapParams

func (*CreateSyncMapParams) SetUniqueName 

func (params *CreateSyncMapParams) SetUniqueName(UniqueName string) *CreateSyncMapParams

type CreateSyncStreamParams 

type CreateSyncStreamParams struct {
	// 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.
	UniqueName *string `json:"UniqueName,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live).
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateSyncStream'

func (*CreateSyncStreamParams) SetTtl 

func (params *CreateSyncStreamParams) SetTtl(Ttl int) *CreateSyncStreamParams

func (*CreateSyncStreamParams) SetUniqueName 

func (params *CreateSyncStreamParams) SetUniqueName(UniqueName string) *CreateSyncStreamParams

type DeleteSyncListItemParams 

type DeleteSyncListItemParams struct {
	// If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
}

Optional parameters for the method 'DeleteSyncListItem'

func (*DeleteSyncListItemParams) SetIfMatch 

func (params *DeleteSyncListItemParams) SetIfMatch(IfMatch string) *DeleteSyncListItemParams

type DeleteSyncMapItemParams 

type DeleteSyncMapItemParams struct {
	// If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
}

Optional parameters for the method 'DeleteSyncMapItem'

func (*DeleteSyncMapItemParams) SetIfMatch 

func (params *DeleteSyncMapItemParams) SetIfMatch(IfMatch string) *DeleteSyncMapItemParams

type ListDocumentParams 

type ListDocumentParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListDocument'

func (*ListDocumentParams) SetLimit added in v0.13.0 

func (params *ListDocumentParams) SetLimit(Limit int) *ListDocumentParams

func (*ListDocumentParams) SetPageSize 

func (params *ListDocumentParams) SetPageSize(PageSize int) *ListDocumentParams

type ListDocumentPermissionParams 

type ListDocumentPermissionParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListDocumentPermission'

func (*ListDocumentPermissionParams) SetLimit added in v0.13.0 

func (params *ListDocumentPermissionParams) SetLimit(Limit int) *ListDocumentPermissionParams

func (*ListDocumentPermissionParams) SetPageSize 

func (params *ListDocumentPermissionParams) SetPageSize(PageSize int) *ListDocumentPermissionParams

type ListDocumentPermissionResponse 

type ListDocumentPermissionResponse struct {
	Permissions []SyncV1DocumentPermission `json:"permissions,omitempty"`
	Meta        ListDocumentResponseMeta   `json:"meta,omitempty"`
}

ListDocumentPermissionResponse struct for ListDocumentPermissionResponse

type ListDocumentResponse 

type ListDocumentResponse struct {
	Documents []SyncV1Document         `json:"documents,omitempty"`
	Meta      ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListDocumentResponse struct for ListDocumentResponse

type ListDocumentResponseMeta added in v1.0.0 

type ListDocumentResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	NextPageUrl     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page,omitempty"`
	PageSize        int     `json:"page_size,omitempty"`
	PreviousPageUrl *string `json:"previous_page_url,omitempty"`
	Url             string  `json:"url,omitempty"`
	Key             string  `json:"key,omitempty"`
}

ListDocumentResponseMeta struct for ListDocumentResponseMeta

type ListServiceParams 

type ListServiceParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetLimit added in v0.13.0 

func (params *ListServiceParams) SetLimit(Limit int) *ListServiceParams

func (*ListServiceParams) SetPageSize 

func (params *ListServiceParams) SetPageSize(PageSize int) *ListServiceParams

type ListServiceResponse 

type ListServiceResponse struct {
	Services []SyncV1Service          `json:"services,omitempty"`
	Meta     ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListServiceResponse struct for ListServiceResponse

type ListSyncListItemParams 

type ListSyncListItemParams struct {
	// How to order the List Items returned by their `index` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending.
	Order *string `json:"Order,omitempty"`
	// The `index` of the first Sync List Item resource to read. See also `bounds`.
	From *string `json:"From,omitempty"`
	// Whether to include the List Item referenced by the `from` parameter. Can be: `inclusive` to include the List Item referenced by the `from` parameter or `exclusive` to start with the next List Item. The default value is `inclusive`.
	Bounds *string `json:"Bounds,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncListItem'

func (*ListSyncListItemParams) SetBounds 

func (params *ListSyncListItemParams) SetBounds(Bounds string) *ListSyncListItemParams

func (*ListSyncListItemParams) SetFrom 

func (params *ListSyncListItemParams) SetFrom(From string) *ListSyncListItemParams

func (*ListSyncListItemParams) SetLimit added in v0.13.0 

func (params *ListSyncListItemParams) SetLimit(Limit int) *ListSyncListItemParams

func (*ListSyncListItemParams) SetOrder 

func (params *ListSyncListItemParams) SetOrder(Order string) *ListSyncListItemParams

func (*ListSyncListItemParams) SetPageSize 

func (params *ListSyncListItemParams) SetPageSize(PageSize int) *ListSyncListItemParams

type ListSyncListItemResponse 

type ListSyncListItemResponse struct {
	Items []SyncV1SyncListItem     `json:"items,omitempty"`
	Meta  ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListSyncListItemResponse struct for ListSyncListItemResponse

type ListSyncListParams 

type ListSyncListParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncList'

func (*ListSyncListParams) SetLimit added in v0.13.0 

func (params *ListSyncListParams) SetLimit(Limit int) *ListSyncListParams

func (*ListSyncListParams) SetPageSize 

func (params *ListSyncListParams) SetPageSize(PageSize int) *ListSyncListParams

type ListSyncListPermissionParams 

type ListSyncListPermissionParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncListPermission'

func (*ListSyncListPermissionParams) SetLimit added in v0.13.0 

func (params *ListSyncListPermissionParams) SetLimit(Limit int) *ListSyncListPermissionParams

func (*ListSyncListPermissionParams) SetPageSize 

func (params *ListSyncListPermissionParams) SetPageSize(PageSize int) *ListSyncListPermissionParams

type ListSyncListPermissionResponse 

type ListSyncListPermissionResponse struct {
	Permissions []SyncV1SyncListPermission `json:"permissions,omitempty"`
	Meta        ListDocumentResponseMeta   `json:"meta,omitempty"`
}

ListSyncListPermissionResponse struct for ListSyncListPermissionResponse

type ListSyncListResponse 

type ListSyncListResponse struct {
	Lists []SyncV1SyncList         `json:"lists,omitempty"`
	Meta  ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListSyncListResponse struct for ListSyncListResponse

type ListSyncMapItemParams 

type ListSyncMapItemParams struct {
	// How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.
	Order *string `json:"Order,omitempty"`
	// The `key` of the first Sync Map Item resource to read. See also `bounds`.
	From *string `json:"From,omitempty"`
	// Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.
	Bounds *string `json:"Bounds,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncMapItem'

func (*ListSyncMapItemParams) SetBounds 

func (params *ListSyncMapItemParams) SetBounds(Bounds string) *ListSyncMapItemParams

func (*ListSyncMapItemParams) SetFrom 

func (params *ListSyncMapItemParams) SetFrom(From string) *ListSyncMapItemParams

func (*ListSyncMapItemParams) SetLimit added in v0.13.0 

func (params *ListSyncMapItemParams) SetLimit(Limit int) *ListSyncMapItemParams

func (*ListSyncMapItemParams) SetOrder 

func (params *ListSyncMapItemParams) SetOrder(Order string) *ListSyncMapItemParams

func (*ListSyncMapItemParams) SetPageSize 

func (params *ListSyncMapItemParams) SetPageSize(PageSize int) *ListSyncMapItemParams

type ListSyncMapItemResponse 

type ListSyncMapItemResponse struct {
	Items []SyncV1SyncMapItem      `json:"items,omitempty"`
	Meta  ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListSyncMapItemResponse struct for ListSyncMapItemResponse

type ListSyncMapParams 

type ListSyncMapParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncMap'

func (*ListSyncMapParams) SetLimit added in v0.13.0 

func (params *ListSyncMapParams) SetLimit(Limit int) *ListSyncMapParams

func (*ListSyncMapParams) SetPageSize 

func (params *ListSyncMapParams) SetPageSize(PageSize int) *ListSyncMapParams

type ListSyncMapPermissionParams 

type ListSyncMapPermissionParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncMapPermission'

func (*ListSyncMapPermissionParams) SetLimit added in v0.13.0 

func (params *ListSyncMapPermissionParams) SetLimit(Limit int) *ListSyncMapPermissionParams

func (*ListSyncMapPermissionParams) SetPageSize 

func (params *ListSyncMapPermissionParams) SetPageSize(PageSize int) *ListSyncMapPermissionParams

type ListSyncMapPermissionResponse 

type ListSyncMapPermissionResponse struct {
	Permissions []SyncV1SyncMapPermission `json:"permissions,omitempty"`
	Meta        ListDocumentResponseMeta  `json:"meta,omitempty"`
}

ListSyncMapPermissionResponse struct for ListSyncMapPermissionResponse

type ListSyncMapResponse 

type ListSyncMapResponse struct {
	Maps []SyncV1SyncMap          `json:"maps,omitempty"`
	Meta ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListSyncMapResponse struct for ListSyncMapResponse

type ListSyncStreamParams 

type ListSyncStreamParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListSyncStream'

func (*ListSyncStreamParams) SetLimit added in v0.13.0 

func (params *ListSyncStreamParams) SetLimit(Limit int) *ListSyncStreamParams

func (*ListSyncStreamParams) SetPageSize 

func (params *ListSyncStreamParams) SetPageSize(PageSize int) *ListSyncStreamParams

type ListSyncStreamResponse 

type ListSyncStreamResponse struct {
	Streams []SyncV1SyncStream       `json:"streams,omitempty"`
	Meta    ListDocumentResponseMeta `json:"meta,omitempty"`
}

ListSyncStreamResponse struct for ListSyncStreamResponse

type SyncV1Document added in v0.14.0 

type SyncV1Document struct {
	// The unique string that we created to identify the Document resource.
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource and can be up to 320 characters long.
	UniqueName *string `json:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Document resource.
	Url *string `json:"url,omitempty"`
	// The URLs of resources related to the Sync Document.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The current revision of the Sync Document, represented as a string. The `revision` property is used with conditional updates to ensure data consistency.
	Revision *string `json:"revision,omitempty"`
	// An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"data,omitempty"`
	// The date and time in GMT when the Sync Document expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Document does not expire, this value is `null`. The Document resource might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the Sync Document's creator. If the Sync Document is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Document was created from the REST API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1Document struct for SyncV1Document

type SyncV1DocumentPermission added in v0.14.0 

type SyncV1DocumentPermission struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Document Permission resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the Sync Document to which the Document Permission applies.
	DocumentSid *string `json:"document_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.
	Identity *string `json:"identity,omitempty"`
	// Whether the identity can read the Sync Document.
	Read *bool `json:"read,omitempty"`
	// Whether the identity can update the Sync Document.
	Write *bool `json:"write,omitempty"`
	// Whether the identity can delete the Sync Document.
	Manage *bool `json:"manage,omitempty"`
	// The absolute URL of the Sync Document Permission resource.
	Url *string `json:"url,omitempty"`
}

SyncV1DocumentPermission struct for SyncV1DocumentPermission

type SyncV1Service 

type SyncV1Service struct {
	// The unique string that we created to identify the Service resource.
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.
	UniqueName *string `json:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the resource.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Service resource.
	Url *string `json:"url,omitempty"`
	// The URL we call when Sync objects are manipulated.
	WebhookUrl *string `json:"webhook_url,omitempty"`
	// Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.
	WebhooksFromRestEnabled *bool `json:"webhooks_from_rest_enabled,omitempty"`
	// Whether the service instance calls `webhook_url` when client endpoints connect to Sync. The default is `false`.
	ReachabilityWebhooksEnabled *bool `json:"reachability_webhooks_enabled,omitempty"`
	// Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource. It is disabled (false) by default.
	AclEnabled *bool `json:"acl_enabled,omitempty"`
	// Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.
	ReachabilityDebouncingEnabled *bool `json:"reachability_debouncing_enabled,omitempty"`
	// The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before `webhook_url` is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.
	ReachabilityDebouncingWindow *int `json:"reachability_debouncing_window,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

SyncV1Service struct for SyncV1Service

type SyncV1StreamMessage added in v0.14.0 

type SyncV1StreamMessage struct {
	// The unique string that we created to identify the Stream Message resource.
	Sid *string `json:"sid,omitempty"`
	// An arbitrary, schema-less object that contains the Stream Message body. Can be up to 4 KiB in length.
	Data *interface{} `json:"data,omitempty"`
}

SyncV1StreamMessage struct for SyncV1StreamMessage

type SyncV1SyncList added in v0.14.0 

type SyncV1SyncList struct {
	// The unique string that we created to identify the Sync List resource.
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Sync List resource.
	Url *string `json:"url,omitempty"`
	// The URLs of the Sync List's nested resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The current revision of the Sync List, represented as a string.
	Revision *string `json:"revision,omitempty"`
	// The date and time in GMT when the Sync List expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync List does not expire, this value is `null`. The Sync List might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the Sync List's creator. If the Sync List is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync List was created from the REST API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1SyncList struct for SyncV1SyncList

type SyncV1SyncListItem added in v0.14.0 

type SyncV1SyncListItem struct {
	// The automatically generated index of the List Item. The `index` values of the List Items in a Sync List can have gaps in their sequence.
	Index *int `json:"index,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the List Item resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the Sync List that contains the List Item.
	ListSid *string `json:"list_sid,omitempty"`
	// The absolute URL of the List Item resource.
	Url *string `json:"url,omitempty"`
	// The current revision of the item, represented as a string.
	Revision *string `json:"revision,omitempty"`
	// An arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"data,omitempty"`
	// The date and time in GMT when the List Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the List Item does not expire, this value is `null`. The List Item resource might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the List Item's creator. If the item is created from the client SDK, the value matches the Access Token's `identity` field. If the item was created from the REST API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1SyncListItem struct for SyncV1SyncListItem

type SyncV1SyncListPermission added in v0.14.0 

type SyncV1SyncListPermission struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync List Permission resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the Sync List to which the Permission applies.
	ListSid *string `json:"list_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.
	Identity *string `json:"identity,omitempty"`
	// Whether the identity can read the Sync List and its Items.
	Read *bool `json:"read,omitempty"`
	// Whether the identity can create, update, and delete Items in the Sync List.
	Write *bool `json:"write,omitempty"`
	// Whether the identity can delete the Sync List.
	Manage *bool `json:"manage,omitempty"`
	// The absolute URL of the Sync List Permission resource.
	Url *string `json:"url,omitempty"`
}

SyncV1SyncListPermission struct for SyncV1SyncListPermission

type SyncV1SyncMap added in v0.14.0 

type SyncV1SyncMap struct {
	// The unique string that we created to identify the Sync Map resource.
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Sync Map resource.
	Url *string `json:"url,omitempty"`
	// The URLs of the Sync Map's nested resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The current revision of the Sync Map, represented as a string.
	Revision *string `json:"revision,omitempty"`
	// The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is `null`. The Sync Map might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's `identity` field. If the Sync Map was created from the REST API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1SyncMap struct for SyncV1SyncMap

type SyncV1SyncMapItem added in v0.14.0 

type SyncV1SyncMapItem struct {
	// The unique, user-defined key for the Map Item.
	Key *string `json:"key,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Map Item resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the Sync Map that contains the Map Item.
	MapSid *string `json:"map_sid,omitempty"`
	// The absolute URL of the Map Item resource.
	Url *string `json:"url,omitempty"`
	// The current revision of the Map Item, represented as a string.
	Revision *string `json:"revision,omitempty"`
	// An arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"data,omitempty"`
	// The date and time in GMT when the Map Item expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map Item does not expire, this value is `null`.  The Map Item might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's `identity` field. If the Map Item was created from the REST API, the value is `system`.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1SyncMapItem struct for SyncV1SyncMapItem

type SyncV1SyncMapPermission added in v0.14.0 

type SyncV1SyncMapPermission struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map Permission resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the Sync Map to which the Permission applies.
	MapSid *string `json:"map_sid,omitempty"`
	// The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.
	Identity *string `json:"identity,omitempty"`
	// Whether the identity can read the Sync Map and its Items.
	Read *bool `json:"read,omitempty"`
	// Whether the identity can create, update, and delete Items in the Sync Map.
	Write *bool `json:"write,omitempty"`
	// Whether the identity can delete the Sync Map.
	Manage *bool `json:"manage,omitempty"`
	// The absolute URL of the Sync Map Permission resource.
	Url *string `json:"url,omitempty"`
}

SyncV1SyncMapPermission struct for SyncV1SyncMapPermission

type SyncV1SyncStream added in v0.14.0 

type SyncV1SyncStream struct {
	// The unique string that we created to identify the Sync Stream resource.
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.
	UniqueName *string `json:"unique_name,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Stream resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Message Stream resource.
	Url *string `json:"url,omitempty"`
	// The URLs of the Stream's nested resources.
	Links *map[string]interface{} `json:"links,omitempty"`
	// The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is `null`. The Stream might not be deleted immediately after it expires.
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The identity of the Stream's creator. If the Stream is created from the client SDK, the value matches the Access Token's `identity` field. If the Stream was created from the REST API, the value is 'system'.
	CreatedBy *string `json:"created_by,omitempty"`
}

SyncV1SyncStream struct for SyncV1SyncStream

type UpdateDocumentParams 

type UpdateDocumentParams struct {
	// The If-Match HTTP request header
	IfMatch *string `json:"If-Match,omitempty"`
	// A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// 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).
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateDocument'

func (*UpdateDocumentParams) SetData 

func (params *UpdateDocumentParams) SetData(Data interface{}) *UpdateDocumentParams

func (*UpdateDocumentParams) SetIfMatch 

func (params *UpdateDocumentParams) SetIfMatch(IfMatch string) *UpdateDocumentParams

func (*UpdateDocumentParams) SetTtl 

func (params *UpdateDocumentParams) SetTtl(Ttl int) *UpdateDocumentParams

type UpdateDocumentPermissionParams 

type UpdateDocumentPermissionParams struct {
	// Whether the identity can read the Sync Document. Default value is `false`.
	Read *bool `json:"Read,omitempty"`
	// Whether the identity can update the Sync Document. Default value is `false`.
	Write *bool `json:"Write,omitempty"`
	// Whether the identity can delete the Sync Document. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
}

Optional parameters for the method 'UpdateDocumentPermission'

func (*UpdateDocumentPermissionParams) SetManage 

func (params *UpdateDocumentPermissionParams) SetManage(Manage bool) *UpdateDocumentPermissionParams

func (*UpdateDocumentPermissionParams) SetRead 

func (params *UpdateDocumentPermissionParams) SetRead(Read bool) *UpdateDocumentPermissionParams

func (*UpdateDocumentPermissionParams) SetWrite 

func (params *UpdateDocumentPermissionParams) SetWrite(Write bool) *UpdateDocumentPermissionParams

type UpdateServiceParams 

type UpdateServiceParams struct {
	// The URL we should call when Sync objects are manipulated.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	// A string that you assign to describe the resource.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.
	ReachabilityWebhooksEnabled *bool `json:"ReachabilityWebhooksEnabled,omitempty"`
	// Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.
	AclEnabled *bool `json:"AclEnabled,omitempty"`
	// Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.
	ReachabilityDebouncingEnabled *bool `json:"ReachabilityDebouncingEnabled,omitempty"`
	// The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`.  Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.
	ReachabilityDebouncingWindow *int `json:"ReachabilityDebouncingWindow,omitempty"`
	// Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.
	WebhooksFromRestEnabled *bool `json:"WebhooksFromRestEnabled,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetAclEnabled 

func (params *UpdateServiceParams) SetAclEnabled(AclEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetFriendlyName 

func (params *UpdateServiceParams) SetFriendlyName(FriendlyName string) *UpdateServiceParams

func (*UpdateServiceParams) SetReachabilityDebouncingEnabled 

func (params *UpdateServiceParams) SetReachabilityDebouncingEnabled(ReachabilityDebouncingEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetReachabilityDebouncingWindow 

func (params *UpdateServiceParams) SetReachabilityDebouncingWindow(ReachabilityDebouncingWindow int) *UpdateServiceParams

func (*UpdateServiceParams) SetReachabilityWebhooksEnabled 

func (params *UpdateServiceParams) SetReachabilityWebhooksEnabled(ReachabilityWebhooksEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhookUrl 

func (params *UpdateServiceParams) SetWebhookUrl(WebhookUrl string) *UpdateServiceParams

func (*UpdateServiceParams) SetWebhooksFromRestEnabled 

func (params *UpdateServiceParams) SetWebhooksFromRestEnabled(WebhooksFromRestEnabled bool) *UpdateServiceParams

type UpdateSyncListItemParams 

type UpdateSyncListItemParams struct {
	// If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
	// A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item expires (time-to-live) and is deleted.
	ItemTtl *int `json:"ItemTtl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'UpdateSyncListItem'

func (*UpdateSyncListItemParams) SetCollectionTtl 

func (params *UpdateSyncListItemParams) SetCollectionTtl(CollectionTtl int) *UpdateSyncListItemParams

func (*UpdateSyncListItemParams) SetData 

func (params *UpdateSyncListItemParams) SetData(Data interface{}) *UpdateSyncListItemParams

func (*UpdateSyncListItemParams) SetIfMatch 

func (params *UpdateSyncListItemParams) SetIfMatch(IfMatch string) *UpdateSyncListItemParams

func (*UpdateSyncListItemParams) SetItemTtl 

func (params *UpdateSyncListItemParams) SetItemTtl(ItemTtl int) *UpdateSyncListItemParams

func (*UpdateSyncListItemParams) SetTtl 

func (params *UpdateSyncListItemParams) SetTtl(Ttl int) *UpdateSyncListItemParams

type UpdateSyncListParams 

type UpdateSyncListParams struct {
	// An alias for `collection_ttl`. If both are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync List expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'UpdateSyncList'

func (*UpdateSyncListParams) SetCollectionTtl 

func (params *UpdateSyncListParams) SetCollectionTtl(CollectionTtl int) *UpdateSyncListParams

func (*UpdateSyncListParams) SetTtl 

func (params *UpdateSyncListParams) SetTtl(Ttl int) *UpdateSyncListParams

type UpdateSyncListPermissionParams 

type UpdateSyncListPermissionParams struct {
	// Whether the identity can read the Sync List and its Items. Default value is `false`.
	Read *bool `json:"Read,omitempty"`
	// Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`.
	Write *bool `json:"Write,omitempty"`
	// Whether the identity can delete the Sync List. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
}

Optional parameters for the method 'UpdateSyncListPermission'

func (*UpdateSyncListPermissionParams) SetManage 

func (params *UpdateSyncListPermissionParams) SetManage(Manage bool) *UpdateSyncListPermissionParams

func (*UpdateSyncListPermissionParams) SetRead 

func (params *UpdateSyncListPermissionParams) SetRead(Read bool) *UpdateSyncListPermissionParams

func (*UpdateSyncListPermissionParams) SetWrite 

func (params *UpdateSyncListPermissionParams) SetWrite(Write bool) *UpdateSyncListPermissionParams

type UpdateSyncMapItemParams 

type UpdateSyncMapItemParams struct {
	// If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).
	IfMatch *string `json:"If-Match,omitempty"`
	// A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16 KiB in length.
	Data *interface{} `json:"Data,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item expires (time-to-live) and is deleted.
	ItemTtl *int `json:"ItemTtl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Map Item's parent Sync Map expires (time-to-live) and is deleted. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'UpdateSyncMapItem'

func (*UpdateSyncMapItemParams) SetCollectionTtl 

func (params *UpdateSyncMapItemParams) SetCollectionTtl(CollectionTtl int) *UpdateSyncMapItemParams

func (*UpdateSyncMapItemParams) SetData 

func (params *UpdateSyncMapItemParams) SetData(Data interface{}) *UpdateSyncMapItemParams

func (*UpdateSyncMapItemParams) SetIfMatch 

func (params *UpdateSyncMapItemParams) SetIfMatch(IfMatch string) *UpdateSyncMapItemParams

func (*UpdateSyncMapItemParams) SetItemTtl 

func (params *UpdateSyncMapItemParams) SetItemTtl(ItemTtl int) *UpdateSyncMapItemParams

func (*UpdateSyncMapItemParams) SetTtl 

func (params *UpdateSyncMapItemParams) SetTtl(Ttl int) *UpdateSyncMapItemParams

type UpdateSyncMapParams 

type UpdateSyncMapParams struct {
	// An alias for `collection_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int `json:"Ttl,omitempty"`
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted.
	CollectionTtl *int `json:"CollectionTtl,omitempty"`
}

Optional parameters for the method 'UpdateSyncMap'

func (*UpdateSyncMapParams) SetCollectionTtl 

func (params *UpdateSyncMapParams) SetCollectionTtl(CollectionTtl int) *UpdateSyncMapParams

func (*UpdateSyncMapParams) SetTtl 

func (params *UpdateSyncMapParams) SetTtl(Ttl int) *UpdateSyncMapParams

type UpdateSyncMapPermissionParams 

type UpdateSyncMapPermissionParams struct {
	// Whether the identity can read the Sync Map and its Items. Default value is `false`.
	Read *bool `json:"Read,omitempty"`
	// Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`.
	Write *bool `json:"Write,omitempty"`
	// Whether the identity can delete the Sync Map. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
}

Optional parameters for the method 'UpdateSyncMapPermission'

func (*UpdateSyncMapPermissionParams) SetManage 

func (params *UpdateSyncMapPermissionParams) SetManage(Manage bool) *UpdateSyncMapPermissionParams

func (*UpdateSyncMapPermissionParams) SetRead 

func (params *UpdateSyncMapPermissionParams) SetRead(Read bool) *UpdateSyncMapPermissionParams

func (*UpdateSyncMapPermissionParams) SetWrite 

func (params *UpdateSyncMapPermissionParams) SetWrite(Write bool) *UpdateSyncMapPermissionParams

type UpdateSyncStreamParams 

type UpdateSyncStreamParams struct {
	// How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Stream expires and is deleted (time-to-live).
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncStream'

func (*UpdateSyncStreamParams) SetTtl 

func (params *UpdateSyncStreamParams) SetTtl(Ttl int) *UpdateSyncStreamParams

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.