items

Documentation

Overview

Package items contains auto-generated files. DO NOT MODIFY

Package items contains auto-generated files. DO NOT MODIFY

Package items contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateSyncListItemInput) (*CreateSyncListItemResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateSyncListItemInput) (*CreateSyncListItemResponse, error)
  • func (c *Client) NewSyncListItemsPaginator() *SyncListItemsPaginator
  • func (c *Client) NewSyncListItemsPaginatorWithOptions(options *SyncListItemsPageOptions) *SyncListItemsPaginator
  • func (c Client) Page(options *SyncListItemsPageOptions) (*SyncListItemsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *SyncListItemsPageOptions) (*SyncListItemsPageResponse, error)
• type ClientProperties
• type CreateSyncListItemInput
• type CreateSyncListItemResponse
• type PageMetaResponse
• type PageSyncListItemResponse
• type SyncListItemsPage
• type SyncListItemsPageOptions
• type SyncListItemsPageResponse
• type SyncListItemsPaginator
  • func (p *SyncListItemsPaginator) CurrentPage() *SyncListItemsPageResponse
  • func (p *SyncListItemsPaginator) Error() error
  • func (p *SyncListItemsPaginator) Next() bool
  • func (p *SyncListItemsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing list item resources See https://www.twilio.com/docs/sync/api/listitem-resource for more details

func New

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

New creates a new instance of the items client

func (Client) Create

func (c Client) Create(input *CreateSyncListItemInput) (*CreateSyncListItemResponse, error)

Create creates a new list item See https://www.twilio.com/docs/sync/api/listitem-resource#create-a-listitem-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateSyncListItemInput) (*CreateSyncListItemResponse, error)

CreateWithContext creates a new list item See https://www.twilio.com/docs/sync/api/listitem-resource#create-a-listitem-resource for more details

func (*Client) NewSyncListItemsPaginator

func (c *Client) NewSyncListItemsPaginator() *SyncListItemsPaginator

NewSyncListItemsPaginator creates a new instance of the paginator for Page.

func (*Client) NewSyncListItemsPaginatorWithOptions

func (c *Client) NewSyncListItemsPaginatorWithOptions(options *SyncListItemsPageOptions) *SyncListItemsPaginator

NewSyncListItemsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *SyncListItemsPageOptions) (*SyncListItemsPageResponse, error)

Page retrieves a page of list items See https://www.twilio.com/docs/sync/api/listitem-resource#read-a-listitem-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *SyncListItemsPageOptions) (*SyncListItemsPageResponse, error)

PageWithContext retrieves a page of list items See https://www.twilio.com/docs/sync/api/listitem-resource#read-a-listitem-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid  string
	SyncListSid string
}

ClientProperties are the properties required to manage the items resources

type CreateSyncListItemInput

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

CreateSyncListItemInput defines the input fields for creating a new list item resource

type CreateSyncListItemResponse

type CreateSyncListItemResponse 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"`
	Index       int                    `json:"index"`
	ListSid     string                 `json:"list_sid"`
	Revision    string                 `json:"revision"`
	ServiceSid  string                 `json:"service_Sid"`
	URL         string                 `json:"url"`
}

CreateSyncListItemResponse defines the response fields for the created list item

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}

type PageSyncListItemResponse

type PageSyncListItemResponse 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"`
	Index       int                    `json:"index"`
	ListSid     string                 `json:"list_sid"`
	Revision    string                 `json:"revision"`
	ServiceSid  string                 `json:"service_Sid"`
	URL         string                 `json:"url"`
}

type SyncListItemsPage

type SyncListItemsPage struct {
	CurrentPage *SyncListItemsPageResponse
	Error       error
	// contains filtered or unexported fields
}

SyncListItemsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageSyncListItemResponse or error that is returned from the api call(s)

type SyncListItemsPageOptions

type SyncListItemsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
	Order     *string
	From      *string
	Bounds    *string
}

SyncListItemsPageOptions defines the query options for the api operation

type SyncListItemsPageResponse

type SyncListItemsPageResponse struct {
	Items []PageSyncListItemResponse `json:"items"`
	Meta  PageMetaResponse           `json:"meta"`
}

SyncListItemsPageResponse defines the response fields for the list items page

type SyncListItemsPaginator

type SyncListItemsPaginator struct {
	Page  *SyncListItemsPage
	Items []PageSyncListItemResponse
	// contains filtered or unexported fields
}

SyncListItemsPaginator defines the fields for makings paginated api calls Items is an array of items that have been returned from all of the page calls

func (*SyncListItemsPaginator) CurrentPage

func (p *SyncListItemsPaginator) CurrentPage() *SyncListItemsPageResponse

CurrentPage retrieves the results for the current page

func (*SyncListItemsPaginator) Error

func (p *SyncListItemsPaginator) Error() error

Error retrieves the error returned from the page

func (*SyncListItemsPaginator) Next

func (p *SyncListItemsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*SyncListItemsPaginator) NextWithContext

func (p *SyncListItemsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate