openapi

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2021 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.16.1
  • 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
DefaultApi CreateDocument Post /v1/Services/{ServiceSid}/Documents
DefaultApi CreateService Post /v1/Services
DefaultApi CreateStreamMessage Post /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages
DefaultApi CreateSyncList Post /v1/Services/{ServiceSid}/Lists
DefaultApi CreateSyncListItem Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
DefaultApi CreateSyncMap Post /v1/Services/{ServiceSid}/Maps
DefaultApi CreateSyncMapItem Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
DefaultApi CreateSyncStream Post /v1/Services/{ServiceSid}/Streams
DefaultApi DeleteDocument Delete /v1/Services/{ServiceSid}/Documents/{Sid}
DefaultApi DeleteDocumentPermission Delete /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
DefaultApi DeleteService Delete /v1/Services/{Sid}
DefaultApi DeleteSyncList Delete /v1/Services/{ServiceSid}/Lists/{Sid}
DefaultApi DeleteSyncListItem Delete /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
DefaultApi DeleteSyncListPermission Delete /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
DefaultApi DeleteSyncMap Delete /v1/Services/{ServiceSid}/Maps/{Sid}
DefaultApi DeleteSyncMapItem Delete /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
DefaultApi DeleteSyncMapPermission Delete /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
DefaultApi DeleteSyncStream Delete /v1/Services/{ServiceSid}/Streams/{Sid}
DefaultApi FetchDocument Get /v1/Services/{ServiceSid}/Documents/{Sid}
DefaultApi FetchDocumentPermission Get /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
DefaultApi FetchService Get /v1/Services/{Sid}
DefaultApi FetchSyncList Get /v1/Services/{ServiceSid}/Lists/{Sid}
DefaultApi FetchSyncListItem Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
DefaultApi FetchSyncListPermission Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
DefaultApi FetchSyncMap Get /v1/Services/{ServiceSid}/Maps/{Sid}
DefaultApi FetchSyncMapItem Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
DefaultApi FetchSyncMapPermission Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
DefaultApi FetchSyncStream Get /v1/Services/{ServiceSid}/Streams/{Sid}
DefaultApi ListDocument Get /v1/Services/{ServiceSid}/Documents
DefaultApi ListDocumentPermission Get /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions
DefaultApi ListService Get /v1/Services
DefaultApi ListSyncList Get /v1/Services/{ServiceSid}/Lists
DefaultApi ListSyncListItem Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
DefaultApi ListSyncListPermission Get /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions
DefaultApi ListSyncMap Get /v1/Services/{ServiceSid}/Maps
DefaultApi ListSyncMapItem Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
DefaultApi ListSyncMapPermission Get /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions
DefaultApi ListSyncStream Get /v1/Services/{ServiceSid}/Streams
DefaultApi UpdateDocument Post /v1/Services/{ServiceSid}/Documents/{Sid}
DefaultApi UpdateDocumentPermission Post /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
DefaultApi UpdateService Post /v1/Services/{Sid}
DefaultApi UpdateSyncList Post /v1/Services/{ServiceSid}/Lists/{Sid}
DefaultApi UpdateSyncListItem Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
DefaultApi UpdateSyncListPermission Post /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
DefaultApi UpdateSyncMap Post /v1/Services/{ServiceSid}/Maps/{Sid}
DefaultApi UpdateSyncMapItem Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
DefaultApi UpdateSyncMapPermission Post /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
DefaultApi UpdateSyncStream Post /v1/Services/{ServiceSid}/Streams/{Sid}

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)

Author

support@twilio.com

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateDocumentParams 

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

Optional parameters for the method 'CreateDocument'

func (*CreateDocumentParams) SetData 

func (params *CreateDocumentParams) SetData(Data map[string]interface{}) *CreateDocumentParams

func (*CreateDocumentParams) SetTtl 

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

func (*CreateDocumentParams) SetUniqueName 

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

type CreateServiceParams 

type CreateServiceParams struct {
	// 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"`
	// A string that you assign to describe the resource.
	FriendlyName *string `json:"FriendlyName,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 *int32 `json:"ReachabilityDebouncingWindow,omitempty"`
	// Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.
	ReachabilityWebhooksEnabled *bool `json:"ReachabilityWebhooksEnabled,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 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 int32) *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 *map[string]interface{} `json:"Data,omitempty"`
}

Optional parameters for the method 'CreateStreamMessage'

func (*CreateStreamMessageParams) SetData 

func (params *CreateStreamMessageParams) SetData(Data map[string]interface{}) *CreateStreamMessageParams

type CreateSyncListItemParams 

type CreateSyncListItemParams struct {
	// 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 *int32 `json:"CollectionTtl,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 *map[string]interface{} `json:"Data,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 *int32 `json:"ItemTtl,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateSyncListItem'

func (*CreateSyncListItemParams) SetCollectionTtl 

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

func (*CreateSyncListItemParams) SetData 

func (params *CreateSyncListItemParams) SetData(Data map[string]interface{}) *CreateSyncListItemParams

func (*CreateSyncListItemParams) SetItemTtl 

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

func (*CreateSyncListItemParams) SetTtl 

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

type CreateSyncListParams 

type CreateSyncListParams struct {
	// 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 *int32 `json:"CollectionTtl,omitempty"`
	// Alias for collection_ttl. If both are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
	// 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"`
}

Optional parameters for the method 'CreateSyncList'

func (*CreateSyncListParams) SetCollectionTtl 

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

func (*CreateSyncListParams) SetTtl 

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

func (*CreateSyncListParams) SetUniqueName 

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

type CreateSyncMapItemParams 

type CreateSyncMapItemParams struct {
	// 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 *int32 `json:"CollectionTtl,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 *map[string]interface{} `json:"Data,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 *int32 `json:"ItemTtl,omitempty"`
	// The unique, user-defined key for the Map Item. Can be up to 320 characters long.
	Key *string `json:"Key,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateSyncMapItem'

func (*CreateSyncMapItemParams) SetCollectionTtl 

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

func (*CreateSyncMapItemParams) SetData 

func (params *CreateSyncMapItemParams) SetData(Data map[string]interface{}) *CreateSyncMapItemParams

func (*CreateSyncMapItemParams) SetItemTtl 

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

func (*CreateSyncMapItemParams) SetKey 

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

func (*CreateSyncMapItemParams) SetTtl 

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

type CreateSyncMapParams 

type CreateSyncMapParams struct {
	// 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 *int32 `json:"CollectionTtl,omitempty"`
	// An alias for `collection_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
	// 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"`
}

Optional parameters for the method 'CreateSyncMap'

func (*CreateSyncMapParams) SetCollectionTtl 

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

func (*CreateSyncMapParams) SetTtl 

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

func (*CreateSyncMapParams) SetUniqueName 

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

type CreateSyncStreamParams 

type CreateSyncStreamParams 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 *int32 `json:"Ttl,omitempty"`
	// 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"`
}

Optional parameters for the method 'CreateSyncStream'

func (*CreateSyncStreamParams) SetTtl 

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

func (*CreateSyncStreamParams) SetUniqueName 

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

type DefaultApiService 

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

func NewDefaultApiService 

func NewDefaultApiService(requestHandler *twilio.RequestHandler) *DefaultApiService

func NewDefaultApiServiceWithClient added in v0.9.0 

func NewDefaultApiServiceWithClient(client twilio.BaseClient) *DefaultApiService

func (*DefaultApiService) CreateDocument 

func (c *DefaultApiService) CreateDocument(ServiceSid string, params *CreateDocumentParams) (*SyncV1ServiceDocument, error)

func (*DefaultApiService) CreateService 

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

func (*DefaultApiService) CreateStreamMessage 

func (c *DefaultApiService) CreateStreamMessage(ServiceSid string, StreamSid string, params *CreateStreamMessageParams) (*SyncV1ServiceSyncStreamStreamMessage, error)

Create a new Stream Message.

func (*DefaultApiService) CreateSyncList 

func (c *DefaultApiService) CreateSyncList(ServiceSid string, params *CreateSyncListParams) (*SyncV1ServiceSyncList, error)

func (*DefaultApiService) CreateSyncListItem 

func (c *DefaultApiService) CreateSyncListItem(ServiceSid string, ListSid string, params *CreateSyncListItemParams) (*SyncV1ServiceSyncListSyncListItem, error)

func (*DefaultApiService) CreateSyncMap 

func (c *DefaultApiService) CreateSyncMap(ServiceSid string, params *CreateSyncMapParams) (*SyncV1ServiceSyncMap, error)

func (*DefaultApiService) CreateSyncMapItem 

func (c *DefaultApiService) CreateSyncMapItem(ServiceSid string, MapSid string, params *CreateSyncMapItemParams) (*SyncV1ServiceSyncMapSyncMapItem, error)

func (*DefaultApiService) CreateSyncStream 

func (c *DefaultApiService) CreateSyncStream(ServiceSid string, params *CreateSyncStreamParams) (*SyncV1ServiceSyncStream, error)

Create a new Stream.

func (*DefaultApiService) DeleteDocument 

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

func (*DefaultApiService) DeleteDocumentPermission 

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

Delete a specific Sync Document Permission.

func (*DefaultApiService) DeleteService 

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

func (*DefaultApiService) DeleteSyncList 

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

func (*DefaultApiService) DeleteSyncListItem 

func (c *DefaultApiService) DeleteSyncListItem(ServiceSid string, ListSid string, Index int32, params *DeleteSyncListItemParams) error

func (*DefaultApiService) DeleteSyncListPermission 

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

Delete a specific Sync List Permission.

func (*DefaultApiService) DeleteSyncMap 

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

func (*DefaultApiService) DeleteSyncMapItem 

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

func (*DefaultApiService) DeleteSyncMapPermission 

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

Delete a specific Sync Map Permission.

func (*DefaultApiService) DeleteSyncStream 

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

Delete a specific Stream.

func (*DefaultApiService) FetchDocument 

func (c *DefaultApiService) FetchDocument(ServiceSid string, Sid string) (*SyncV1ServiceDocument, error)

func (*DefaultApiService) FetchDocumentPermission 

func (c *DefaultApiService) FetchDocumentPermission(ServiceSid string, DocumentSid string, Identity string) (*SyncV1ServiceDocumentDocumentPermission, error)

Fetch a specific Sync Document Permission.

func (*DefaultApiService) FetchService 

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

func (*DefaultApiService) FetchSyncList 

func (c *DefaultApiService) FetchSyncList(ServiceSid string, Sid string) (*SyncV1ServiceSyncList, error)

func (*DefaultApiService) FetchSyncListItem 

func (c *DefaultApiService) FetchSyncListItem(ServiceSid string, ListSid string, Index int32) (*SyncV1ServiceSyncListSyncListItem, error)

func (*DefaultApiService) FetchSyncListPermission 

func (c *DefaultApiService) FetchSyncListPermission(ServiceSid string, ListSid string, Identity string) (*SyncV1ServiceSyncListSyncListPermission, error)

Fetch a specific Sync List Permission.

func (*DefaultApiService) FetchSyncMap 

func (c *DefaultApiService) FetchSyncMap(ServiceSid string, Sid string) (*SyncV1ServiceSyncMap, error)

func (*DefaultApiService) FetchSyncMapItem 

func (c *DefaultApiService) FetchSyncMapItem(ServiceSid string, MapSid string, Key string) (*SyncV1ServiceSyncMapSyncMapItem, error)

func (*DefaultApiService) FetchSyncMapPermission 

func (c *DefaultApiService) FetchSyncMapPermission(ServiceSid string, MapSid string, Identity string) (*SyncV1ServiceSyncMapSyncMapPermission, error)

Fetch a specific Sync Map Permission.

func (*DefaultApiService) FetchSyncStream 

func (c *DefaultApiService) FetchSyncStream(ServiceSid string, Sid string) (*SyncV1ServiceSyncStream, error)

Fetch a specific Stream.

func (*DefaultApiService) ListDocument 

func (c *DefaultApiService) ListDocument(ServiceSid string, params *ListDocumentParams) (*ListDocumentResponse, error)

func (*DefaultApiService) ListDocumentPermission 

func (c *DefaultApiService) ListDocumentPermission(ServiceSid string, DocumentSid string, params *ListDocumentPermissionParams) (*ListDocumentPermissionResponse, error)

Retrieve a list of all Permissions applying to a Sync Document.

func (*DefaultApiService) ListService 

func (c *DefaultApiService) ListService(params *ListServiceParams) (*ListServiceResponse, error)

func (*DefaultApiService) ListSyncList 

func (c *DefaultApiService) ListSyncList(ServiceSid string, params *ListSyncListParams) (*ListSyncListResponse, error)

func (*DefaultApiService) ListSyncListItem 

func (c *DefaultApiService) ListSyncListItem(ServiceSid string, ListSid string, params *ListSyncListItemParams) (*ListSyncListItemResponse, error)

func (*DefaultApiService) ListSyncListPermission 

func (c *DefaultApiService) ListSyncListPermission(ServiceSid string, ListSid string, params *ListSyncListPermissionParams) (*ListSyncListPermissionResponse, error)

Retrieve a list of all Permissions applying to a Sync List.

func (*DefaultApiService) ListSyncMap 

func (c *DefaultApiService) ListSyncMap(ServiceSid string, params *ListSyncMapParams) (*ListSyncMapResponse, error)

func (*DefaultApiService) ListSyncMapItem 

func (c *DefaultApiService) ListSyncMapItem(ServiceSid string, MapSid string, params *ListSyncMapItemParams) (*ListSyncMapItemResponse, error)

func (*DefaultApiService) ListSyncMapPermission 

func (c *DefaultApiService) ListSyncMapPermission(ServiceSid string, MapSid string, params *ListSyncMapPermissionParams) (*ListSyncMapPermissionResponse, error)

Retrieve a list of all Permissions applying to a Sync Map.

func (*DefaultApiService) ListSyncStream 

func (c *DefaultApiService) ListSyncStream(ServiceSid string, params *ListSyncStreamParams) (*ListSyncStreamResponse, error)

Retrieve a list of all Streams in a Service Instance.

func (*DefaultApiService) UpdateDocument 

func (c *DefaultApiService) UpdateDocument(ServiceSid string, Sid string, params *UpdateDocumentParams) (*SyncV1ServiceDocument, error)

func (*DefaultApiService) UpdateDocumentPermission 

func (c *DefaultApiService) UpdateDocumentPermission(ServiceSid string, DocumentSid string, Identity string, params *UpdateDocumentPermissionParams) (*SyncV1ServiceDocumentDocumentPermission, error)

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

func (*DefaultApiService) UpdateService 

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

func (*DefaultApiService) UpdateSyncList 

func (c *DefaultApiService) UpdateSyncList(ServiceSid string, Sid string, params *UpdateSyncListParams) (*SyncV1ServiceSyncList, error)

func (*DefaultApiService) UpdateSyncListItem 

func (c *DefaultApiService) UpdateSyncListItem(ServiceSid string, ListSid string, Index int32, params *UpdateSyncListItemParams) (*SyncV1ServiceSyncListSyncListItem, error)

func (*DefaultApiService) UpdateSyncListPermission 

func (c *DefaultApiService) UpdateSyncListPermission(ServiceSid string, ListSid string, Identity string, params *UpdateSyncListPermissionParams) (*SyncV1ServiceSyncListSyncListPermission, error)

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

func (*DefaultApiService) UpdateSyncMap 

func (c *DefaultApiService) UpdateSyncMap(ServiceSid string, Sid string, params *UpdateSyncMapParams) (*SyncV1ServiceSyncMap, error)

func (*DefaultApiService) UpdateSyncMapItem 

func (c *DefaultApiService) UpdateSyncMapItem(ServiceSid string, MapSid string, Key string, params *UpdateSyncMapItemParams) (*SyncV1ServiceSyncMapSyncMapItem, error)

func (*DefaultApiService) UpdateSyncMapPermission 

func (c *DefaultApiService) UpdateSyncMapPermission(ServiceSid string, MapSid string, Identity string, params *UpdateSyncMapPermissionParams) (*SyncV1ServiceSyncMapSyncMapPermission, error)

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

func (*DefaultApiService) UpdateSyncStream 

func (c *DefaultApiService) UpdateSyncStream(ServiceSid string, Sid string, params *UpdateSyncStreamParams) (*SyncV1ServiceSyncStream, error)

Update a specific Stream.

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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListDocument'

func (*ListDocumentParams) SetPageSize 

func (params *ListDocumentParams) SetPageSize(PageSize int32) *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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListDocumentPermission'

func (*ListDocumentPermissionParams) SetPageSize 

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

type ListDocumentPermissionResponse 

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

ListDocumentPermissionResponse struct for ListDocumentPermissionResponse

type ListDocumentResponse 

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

ListDocumentResponse struct for ListDocumentResponse

type ListServiceParams 

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

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetPageSize 

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

type ListServiceResponse 

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

ListServiceResponse struct for ListServiceResponse

type ListServiceResponseMeta 

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

ListServiceResponseMeta struct for ListServiceResponseMeta

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 *int32 `json:"PageSize,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) SetOrder 

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

func (*ListSyncListItemParams) SetPageSize 

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

type ListSyncListItemResponse 

type ListSyncListItemResponse struct {
	Items []SyncV1ServiceSyncListSyncListItem `json:"items,omitempty"`
	Meta  ListServiceResponseMeta             `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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSyncList'

func (*ListSyncListParams) SetPageSize 

func (params *ListSyncListParams) SetPageSize(PageSize int32) *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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSyncListPermission'

func (*ListSyncListPermissionParams) SetPageSize 

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

type ListSyncListPermissionResponse 

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

ListSyncListPermissionResponse struct for ListSyncListPermissionResponse

type ListSyncListResponse 

type ListSyncListResponse struct {
	Lists []SyncV1ServiceSyncList `json:"lists,omitempty"`
	Meta  ListServiceResponseMeta `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 *int32 `json:"PageSize,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) SetOrder 

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

func (*ListSyncMapItemParams) SetPageSize 

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

type ListSyncMapItemResponse 

type ListSyncMapItemResponse struct {
	Items []SyncV1ServiceSyncMapSyncMapItem `json:"items,omitempty"`
	Meta  ListServiceResponseMeta           `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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSyncMap'

func (*ListSyncMapParams) SetPageSize 

func (params *ListSyncMapParams) SetPageSize(PageSize int32) *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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSyncMapPermission'

func (*ListSyncMapPermissionParams) SetPageSize 

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

type ListSyncMapPermissionResponse 

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

ListSyncMapPermissionResponse struct for ListSyncMapPermissionResponse

type ListSyncMapResponse 

type ListSyncMapResponse struct {
	Maps []SyncV1ServiceSyncMap  `json:"maps,omitempty"`
	Meta ListServiceResponseMeta `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 *int32 `json:"PageSize,omitempty"`
}

Optional parameters for the method 'ListSyncStream'

func (*ListSyncStreamParams) SetPageSize 

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

type ListSyncStreamResponse 

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

ListSyncStreamResponse struct for ListSyncStreamResponse

type SyncV1Service 

type SyncV1Service struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource
	AclEnabled *bool `json:"acl_enabled,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The string that you assigned to describe the resource
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The URLs of related resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// Whether every endpoint_disconnected event occurs after a configurable delay
	ReachabilityDebouncingEnabled *bool `json:"reachability_debouncing_enabled,omitempty"`
	// The reachability event delay in milliseconds
	ReachabilityDebouncingWindow *int32 `json:"reachability_debouncing_window,omitempty"`
	// Whether the service instance calls webhook_url when client endpoints connect to Sync
	ReachabilityWebhooksEnabled *bool `json:"reachability_webhooks_enabled,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,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
	WebhooksFromRestEnabled *bool `json:"webhooks_from_rest_enabled,omitempty"`
}

SyncV1Service struct for SyncV1Service

type SyncV1ServiceDocument 

type SyncV1ServiceDocument struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the Sync Document's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// An arbitrary, schema-less object that the Sync Document stores
	Data *map[string]interface{} `json:"data,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Sync Document expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,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 by a string identifier
	Revision *string `json:"revision,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Document resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceDocument struct for SyncV1ServiceDocument

type SyncV1ServiceDocumentDocumentPermission 

type SyncV1ServiceDocumentDocumentPermission struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The Sync Document SID
	DocumentSid *string `json:"document_sid,omitempty"`
	// The identity of the user to whom the Sync Document Permission applies
	Identity *string `json:"identity,omitempty"`
	// Manage access
	Manage *bool `json:"manage,omitempty"`
	// Read access
	Read *bool `json:"read,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Sync Document Permission resource
	Url *string `json:"url,omitempty"`
	// Write access
	Write *bool `json:"write,omitempty"`
}

SyncV1ServiceDocumentDocumentPermission struct for SyncV1ServiceDocumentDocumentPermission

type SyncV1ServiceSyncList 

type SyncV1ServiceSyncList struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the Sync List's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Sync List expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,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 SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Sync List resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceSyncList struct for SyncV1ServiceSyncList

type SyncV1ServiceSyncListSyncListItem 

type SyncV1ServiceSyncListSyncListItem struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the List Item's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// An arbitrary, schema-less object that the List Item stores
	Data *map[string]interface{} `json:"data,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the List Item expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The automatically generated index of the List Item
	Index *int32 `json:"index,omitempty"`
	// The SID of the Sync List that contains the List Item
	ListSid *string `json:"list_sid,omitempty"`
	// The current revision of the item, represented as a string
	Revision *string `json:"revision,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the List Item resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceSyncListSyncListItem struct for SyncV1ServiceSyncListSyncListItem

type SyncV1ServiceSyncListSyncListPermission 

type SyncV1ServiceSyncListSyncListPermission struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the user to whom the Sync List Permission applies
	Identity *string `json:"identity,omitempty"`
	// The SID of the Sync List to which the Permission applies
	ListSid *string `json:"list_sid,omitempty"`
	// Manage access
	Manage *bool `json:"manage,omitempty"`
	// Read access
	Read *bool `json:"read,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Sync List Permission resource
	Url *string `json:"url,omitempty"`
	// Write access
	Write *bool `json:"write,omitempty"`
}

SyncV1ServiceSyncListSyncListPermission struct for SyncV1ServiceSyncListSyncListPermission

type SyncV1ServiceSyncMap 

type SyncV1ServiceSyncMap struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the Sync Map's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Sync Map expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,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 SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Sync Map resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceSyncMap struct for SyncV1ServiceSyncMap

type SyncV1ServiceSyncMapSyncMapItem 

type SyncV1ServiceSyncMapSyncMapItem struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the Map Item's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// An arbitrary, schema-less object that the Map Item stores
	Data *map[string]interface{} `json:"data,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Map Item expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The unique, user-defined key for the Map Item
	Key *string `json:"key,omitempty"`
	// The SID of the Sync Map that contains the Map Item
	MapSid *string `json:"map_sid,omitempty"`
	// The current revision of the Map Item, represented as a string
	Revision *string `json:"revision,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Map Item resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceSyncMapSyncMapItem struct for SyncV1ServiceSyncMapSyncMapItem

type SyncV1ServiceSyncMapSyncMapPermission 

type SyncV1ServiceSyncMapSyncMapPermission struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The identity of the user to whom the Sync Document Permission applies
	Identity *string `json:"identity,omitempty"`
	// Manage access
	Manage *bool `json:"manage,omitempty"`
	// Sync Map SID
	MapSid *string `json:"map_sid,omitempty"`
	// Read access
	Read *bool `json:"read,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The absolute URL of the Sync Map Permission resource
	Url *string `json:"url,omitempty"`
	// Write access
	Write *bool `json:"write,omitempty"`
}

SyncV1ServiceSyncMapSyncMapPermission struct for SyncV1ServiceSyncMapSyncMapPermission

type SyncV1ServiceSyncStream 

type SyncV1ServiceSyncStream struct {
	// The SID of the Account that created the resource
	AccountSid *string `json:"account_sid,omitempty"`
	// The Identity of the Stream's creator
	CreatedBy *string `json:"created_by,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was created
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The ISO 8601 date and time in GMT when the Message Stream expires
	DateExpires *time.Time `json:"date_expires,omitempty"`
	// The ISO 8601 date and time in GMT when the resource was last updated
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URLs of the Stream's nested resources
	Links *map[string]interface{} `json:"links,omitempty"`
	// The SID of the Sync Service that the resource is associated with
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
	// An application-defined string that uniquely identifies the resource
	UniqueName *string `json:"unique_name,omitempty"`
	// The absolute URL of the Message Stream resource
	Url *string `json:"url,omitempty"`
}

SyncV1ServiceSyncStream struct for SyncV1ServiceSyncStream

type SyncV1ServiceSyncStreamStreamMessage 

type SyncV1ServiceSyncStreamStreamMessage struct {
	// Stream Message body
	Data *map[string]interface{} `json:"data,omitempty"`
	// The unique string that identifies the resource
	Sid *string `json:"sid,omitempty"`
}

SyncV1ServiceSyncStreamStreamMessage struct for SyncV1ServiceSyncStreamStreamMessage

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 *map[string]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 *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateDocument'

func (*UpdateDocumentParams) SetData 

func (params *UpdateDocumentParams) SetData(Data map[string]interface{}) *UpdateDocumentParams

func (*UpdateDocumentParams) SetIfMatch 

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

func (*UpdateDocumentParams) SetTtl 

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

type UpdateDocumentPermissionParams 

type UpdateDocumentPermissionParams struct {
	// Whether the identity can delete the Sync Document. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
	// 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"`
}

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 {
	// 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"`
	// A string that you assign to describe the resource.
	FriendlyName *string `json:"FriendlyName,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 *int32 `json:"ReachabilityDebouncingWindow,omitempty"`
	// Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.
	ReachabilityWebhooksEnabled *bool `json:"ReachabilityWebhooksEnabled,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 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 int32) *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"`
	// 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 *int32 `json:"CollectionTtl,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 *map[string]interface{} `json:"Data,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 *int32 `json:"ItemTtl,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncListItem'

func (*UpdateSyncListItemParams) SetCollectionTtl 

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

func (*UpdateSyncListItemParams) SetData 

func (params *UpdateSyncListItemParams) SetData(Data map[string]interface{}) *UpdateSyncListItemParams

func (*UpdateSyncListItemParams) SetIfMatch 

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

func (*UpdateSyncListItemParams) SetItemTtl 

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

func (*UpdateSyncListItemParams) SetTtl 

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

type UpdateSyncListParams 

type UpdateSyncListParams struct {
	// 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 *int32 `json:"CollectionTtl,omitempty"`
	// An alias for `collection_ttl`. If both are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncList'

func (*UpdateSyncListParams) SetCollectionTtl 

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

func (*UpdateSyncListParams) SetTtl 

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

type UpdateSyncListPermissionParams 

type UpdateSyncListPermissionParams struct {
	// Whether the identity can delete the Sync List. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
	// 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"`
}

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"`
	// 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 *int32 `json:"CollectionTtl,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 *map[string]interface{} `json:"Data,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 *int32 `json:"ItemTtl,omitempty"`
	// An alias for `item_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncMapItem'

func (*UpdateSyncMapItemParams) SetCollectionTtl 

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

func (*UpdateSyncMapItemParams) SetData 

func (params *UpdateSyncMapItemParams) SetData(Data map[string]interface{}) *UpdateSyncMapItemParams

func (*UpdateSyncMapItemParams) SetIfMatch 

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

func (*UpdateSyncMapItemParams) SetItemTtl 

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

func (*UpdateSyncMapItemParams) SetTtl 

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

type UpdateSyncMapParams 

type UpdateSyncMapParams struct {
	// 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 *int32 `json:"CollectionTtl,omitempty"`
	// An alias for `collection_ttl`. If both parameters are provided, this value is ignored.
	Ttl *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncMap'

func (*UpdateSyncMapParams) SetCollectionTtl 

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

func (*UpdateSyncMapParams) SetTtl 

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

type UpdateSyncMapPermissionParams 

type UpdateSyncMapPermissionParams struct {
	// Whether the identity can delete the Sync Map. Default value is `false`.
	Manage *bool `json:"Manage,omitempty"`
	// 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"`
}

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 *int32 `json:"Ttl,omitempty"`
}

Optional parameters for the method 'UpdateSyncStream'

func (*UpdateSyncStreamParams) SetTtl 

func (params *UpdateSyncStreamParams) SetTtl(Ttl int32) *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.