Documentation ¶
Overview ¶
Package sync_lists contains auto-generated files. DO NOT MODIFY
Package sync_lists contains auto-generated files. DO NOT MODIFY
Package sync_lists contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c Client) Create(input *CreateSyncListInput) (*CreateSyncListResponse, error)
- func (c Client) CreateWithContext(context context.Context, input *CreateSyncListInput) (*CreateSyncListResponse, error)
- func (c *Client) NewSyncListsPaginator() *SyncListsPaginator
- func (c *Client) NewSyncListsPaginatorWithOptions(options *SyncListsPageOptions) *SyncListsPaginator
- func (c Client) Page(options *SyncListsPageOptions) (*SyncListsPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *SyncListsPageOptions) (*SyncListsPageResponse, error)
- type ClientProperties
- type CreateSyncListInput
- type CreateSyncListResponse
- type PageMetaResponse
- type PageSyncListResponse
- type SyncListsPage
- type SyncListsPageOptions
- type SyncListsPageResponse
- type SyncListsPaginator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for managing list resources 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 synclists client
func (Client) Create ¶
func (c Client) Create(input *CreateSyncListInput) (*CreateSyncListResponse, error)
Create creates a new list See https://www.twilio.com/docs/sync/api/list-resource#create-a-list-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 *CreateSyncListInput) (*CreateSyncListResponse, error)
CreateWithContext creates a new list See https://www.twilio.com/docs/sync/api/list-resource#create-a-list-resource for more details
func (*Client) NewSyncListsPaginator ¶
func (c *Client) NewSyncListsPaginator() *SyncListsPaginator
NewSyncListsPaginator creates a new instance of the paginator for Page.
func (*Client) NewSyncListsPaginatorWithOptions ¶
func (c *Client) NewSyncListsPaginatorWithOptions(options *SyncListsPageOptions) *SyncListsPaginator
NewSyncListsPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *SyncListsPageOptions) (*SyncListsPageResponse, error)
Page retrieves a page of lists See https://www.twilio.com/docs/sync/api/list-resource#read-a-list-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 *SyncListsPageOptions) (*SyncListsPageResponse, error)
PageWithContext retrieves a page of lists See https://www.twilio.com/docs/sync/api/list-resource#read-a-list-resource for more details
type ClientProperties ¶
type ClientProperties struct {
ServiceSid string
}
ClientProperties are the properties required to manage the synclists resources
type CreateSyncListInput ¶
type CreateSyncListInput struct { CollectionTtl *int `form:"CollectionTtl,omitempty"` Ttl *int `form:"Ttl,omitempty"` UniqueName *string `form:"UniqueName,omitempty"` }
CreateSyncListInput defines the input fields for creating a new list resource
type CreateSyncListResponse ¶
type CreateSyncListResponse 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"` }
CreateSyncListResponse defines the response fields for the created list
type PageMetaResponse ¶
type PageSyncListResponse ¶
type PageSyncListResponse 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"` }
type SyncListsPage ¶
type SyncListsPage struct { CurrentPage *SyncListsPageResponse Error error // contains filtered or unexported fields }
SyncListsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageSyncListResponse or error that is returned from the api call(s)
type SyncListsPageOptions ¶
SyncListsPageOptions defines the query options for the api operation
type SyncListsPageResponse ¶
type SyncListsPageResponse struct { Meta PageMetaResponse `json:"meta"` SyncLists []PageSyncListResponse `json:"lists"` }
SyncListsPageResponse defines the response fields for the lists page
type SyncListsPaginator ¶
type SyncListsPaginator struct { Page *SyncListsPage SyncLists []PageSyncListResponse // contains filtered or unexported fields }
SyncListsPaginator defines the fields for makings paginated api calls SyncLists is an array of synclists that have been returned from all of the page calls
func (*SyncListsPaginator) CurrentPage ¶
func (p *SyncListsPaginator) CurrentPage() *SyncListsPageResponse
CurrentPage retrieves the results for the current page
func (*SyncListsPaginator) Error ¶
func (p *SyncListsPaginator) Error() error
Error retrieves the error returned from the page
func (*SyncListsPaginator) Next ¶
func (p *SyncListsPaginator) 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 (*SyncListsPaginator) NextWithContext ¶
func (p *SyncListsPaginator) 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