item

Documentation

Overview

Package item contains auto-generated files. DO NOT MODIFY

Package item contains auto-generated files. DO NOT MODIFY

Package item contains auto-generated files. DO NOT MODIFY

Package item contains auto-generated files. 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() (*FetchSyncMapItemResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSyncMapItemResponse, error)
  • func (c Client) Update(input *UpdateSyncMapItemInput) (*UpdateSyncMapItemResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncMapItemInput) (*UpdateSyncMapItemResponse, error)
• type ClientProperties
• type FetchSyncMapItemResponse
• type UpdateSyncMapItemInput
• type UpdateSyncMapItemResponse

Types

type Client

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

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

func New

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

New creates a new instance of the item client

func (Client) Delete

func (c Client) Delete() error

Delete removes a map item resource from the account See https://www.twilio.com/docs/sync/api/map-item-resource#delete-a-mapitem-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 item resource from the account See https://www.twilio.com/docs/sync/api/map-item-resource#delete-a-mapitem-resource for more details

func (Client) Fetch

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

Fetch retrieves an map item resource See https://www.twilio.com/docs/sync/api/map-item-resource#fetch-a-mapitem-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) (*FetchSyncMapItemResponse, error)

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

func (Client) Update

func (c Client) Update(input *UpdateSyncMapItemInput) (*UpdateSyncMapItemResponse, error)

Update modifies an map item resource See https://www.twilio.com/docs/sync/api/map-item-resource#update-a-mapitem-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 *UpdateSyncMapItemInput) (*UpdateSyncMapItemResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Key        string
	ServiceSid string
	SyncMapSid string
}

ClientProperties are the properties required to manage the item resources

type FetchSyncMapItemResponse

type FetchSyncMapItemResponse struct {
	AccountSid  string                 `json:"account_sid"`
	CreatedBy   string                 `json:"created_by"`
	Data        map[string]interface{} `json:"data"`
	DateCreated time.Time              `json:"date_created"`
	DateExpires *time.Time             `json:"date_expires,omitempty"`
	DateUpdated *time.Time             `json:"date_updated,omitempty"`
	Key         string                 `json:"key"`
	MapSid      string                 `json:"map_sid"`
	Revision    string                 `json:"revision"`
	ServiceSid  string                 `json:"service_Sid"`
	URL         string                 `json:"url"`
}

FetchSyncMapItemResponse defines the response fields for the retrieved map item

type UpdateSyncMapItemInput

type UpdateSyncMapItemInput struct {
	CollectionTtl *int    `form:"CollectionTtl,omitempty"`
	Data          *string `form:"Data,omitempty"`
	ItemTtl       *int    `form:"ItemTtl,omitempty"`
	Ttl           *int    `form:"Ttl,omitempty"`
}

UpdateSyncMapItemInput defines input fields for updating a map item resource

type UpdateSyncMapItemResponse

type UpdateSyncMapItemResponse struct {
	AccountSid  string                 `json:"account_sid"`
	CreatedBy   string                 `json:"created_by"`
	Data        map[string]interface{} `json:"data"`
	DateCreated time.Time              `json:"date_created"`
	DateExpires *time.Time             `json:"date_expires,omitempty"`
	DateUpdated *time.Time             `json:"date_updated,omitempty"`
	Key         string                 `json:"key"`
	MapSid      string                 `json:"map_sid"`
	Revision    string                 `json:"revision"`
	ServiceSid  string                 `json:"service_Sid"`
	URL         string                 `json:"url"`
}

UpdateSyncMapItemResponse defines the response fields for the updated map item