sync_list

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() (*FetchSyncListResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSyncListResponse, error)
  • func (c Client) Update(input *UpdateSyncListInput) (*UpdateSyncListResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncListInput) (*UpdateSyncListResponse, error)
• type ClientProperties
• type FetchSyncListResponse
• type UpdateSyncListInput
• type UpdateSyncListResponse

Types

type Client

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

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

func New

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

New creates a new instance of the synclist client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateSyncListInput) (*UpdateSyncListResponse, error)

Update modifies a list resource See https://www.twilio.com/docs/sync/api/list-resource#update-a-list-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 *UpdateSyncListInput) (*UpdateSyncListResponse, error)

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

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the synclist resources

type FetchSyncListResponse

type FetchSyncListResponse 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"`
}

FetchSyncListResponse defines the response fields for the retrieved list

type UpdateSyncListInput

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

UpdateSyncListInput defines input fields for updating a list resource

type UpdateSyncListResponse

type UpdateSyncListResponse 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"`
}

UpdateSyncListResponse defines the response fields for the updated list