sync_map

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Delete() error
  • func (c Client) DeleteWithContext(context context.Context) error
  • func (c Client) Fetch() (*FetchSyncMapResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSyncMapResponse, error)
  • func (c Client) Update(input *UpdateSyncMapInput) (*UpdateSyncMapResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncMapInput) (*UpdateSyncMapResponse, error)
• type ClientProperties
• type FetchSyncMapResponse
• type UpdateSyncMapInput
• type UpdateSyncMapResponse

Types

type Client

type Client struct {
	Item        func(string) *item.Client
	Items       *items.Client
	Permission  func(string) *permission.Client
	Permissions *permissions.Client
	// contains filtered or unexported fields
}

Client for managing a specific map resource See https://www.twilio.com/docs/sync/api/map-resource for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the syncmap client

func (Client) Delete

func (c Client) Delete() error

Delete removes a map resource from the account See https://www.twilio.com/docs/sync/api/map-resource#delete-a-map-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) DeleteWithContext

func (c Client) DeleteWithContext(context context.Context) error

DeleteWithContext removes a map resource from the account See https://www.twilio.com/docs/sync/api/map-resource#delete-a-map-resource for more details

func (Client) Fetch

func (c Client) Fetch() (*FetchSyncMapResponse, error)

Fetch retrieves an map resource See https://www.twilio.com/docs/sync/api/map-resource#fetch-a-syncmap-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchSyncMapResponse, error)

FetchWithContext retrieves an map resource See https://www.twilio.com/docs/sync/api/map-resource#fetch-a-syncmap-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateSyncMapInput) (*UpdateSyncMapResponse, error)

Update modifies an map resource See https://www.twilio.com/docs/sync/api/map-resource#update-a-syncmap-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncMapInput) (*UpdateSyncMapResponse, error)

UpdateWithContext modifies an map resource See https://www.twilio.com/docs/sync/api/map-resource#update-a-syncmap-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the syncmap resources

type FetchSyncMapResponse

type FetchSyncMapResponse struct {
	AccountSid  string     `json:"account_sid"`
	CreatedBy   string     `json:"created_by"`
	DateCreated time.Time  `json:"date_created"`
	DateExpires *time.Time `json:"date_expires,omitempty"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Revision    string     `json:"revision"`
	ServiceSid  string     `json:"service_Sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
	UniqueName  *string    `json:"unique_name,omitempty"`
}

FetchSyncMapResponse defines the response fields for the retrieved map

type UpdateSyncMapInput

type UpdateSyncMapInput struct {
	CollectionTtl *int `form:"CollectionTtl,omitempty"`
	Ttl           *int `form:"Ttl,omitempty"`
}

UpdateSyncMapInput defines input fields for updating a map resource

type UpdateSyncMapResponse

type UpdateSyncMapResponse struct {
	AccountSid  string     `json:"account_sid"`
	CreatedBy   string     `json:"created_by"`
	DateCreated time.Time  `json:"date_created"`
	DateExpires *time.Time `json:"date_expires,omitempty"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	Revision    string     `json:"revision"`
	ServiceSid  string     `json:"service_Sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
	UniqueName  *string    `json:"unique_name,omitempty"`
}

UpdateSyncMapResponse defines the response fields for the updated map