sync_maps

Documentation

Overview

Package sync_maps contains auto-generated files. DO NOT MODIFY

Package sync_maps contains auto-generated files. DO NOT MODIFY

Package sync_maps contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateSyncMapInput) (*CreateSyncMapResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateSyncMapInput) (*CreateSyncMapResponse, error)
  • func (c *Client) NewSyncMapsPaginator() *SyncMapsPaginator
  • func (c *Client) NewSyncMapsPaginatorWithOptions(options *SyncMapsPageOptions) *SyncMapsPaginator
  • func (c Client) Page(options *SyncMapsPageOptions) (*SyncMapsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *SyncMapsPageOptions) (*SyncMapsPageResponse, error)
• type ClientProperties
• type CreateSyncMapInput
• type CreateSyncMapResponse
• type PageMetaResponse
• type PageSyncMapResponse
• type SyncMapsPage
• type SyncMapsPageOptions
• type SyncMapsPageResponse
• type SyncMapsPaginator
  • func (p *SyncMapsPaginator) CurrentPage() *SyncMapsPageResponse
  • func (p *SyncMapsPaginator) Error() error
  • func (p *SyncMapsPaginator) Next() bool
  • func (p *SyncMapsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing map resources 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 syncmaps client

func (Client) Create

func (c Client) Create(input *CreateSyncMapInput) (*CreateSyncMapResponse, error)

Create creates a new map See https://www.twilio.com/docs/sync/api/map-resource#create-a-syncmap-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 *CreateSyncMapInput) (*CreateSyncMapResponse, error)

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

func (*Client) NewSyncMapsPaginator

func (c *Client) NewSyncMapsPaginator() *SyncMapsPaginator

NewSyncMapsPaginator creates a new instance of the paginator for Page.

func (*Client) NewSyncMapsPaginatorWithOptions

func (c *Client) NewSyncMapsPaginatorWithOptions(options *SyncMapsPageOptions) *SyncMapsPaginator

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

func (Client) Page

func (c Client) Page(options *SyncMapsPageOptions) (*SyncMapsPageResponse, error)

Page retrieves a page of maps See https://www.twilio.com/docs/sync/api/map-resource#read-multiple-syncmap-resources 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 *SyncMapsPageOptions) (*SyncMapsPageResponse, error)

PageWithContext retrieves a page of maps See https://www.twilio.com/docs/sync/api/map-resource#read-multiple-syncmap-resources for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the syncmaps resources

type CreateSyncMapInput

type CreateSyncMapInput struct {
	CollectionTtl *int    `form:"CollectionTtl,omitempty"`
	Ttl           *int    `form:"Ttl,omitempty"`
	UniqueName    *string `form:"UniqueName,omitempty"`
}

CreateSyncMapInput defines the input fields for creating a new map resource

type CreateSyncMapResponse

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

CreateSyncMapResponse defines the response fields for the created map

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 PageSyncMapResponse

type PageSyncMapResponse 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 SyncMapsPage

type SyncMapsPage struct {
	CurrentPage *SyncMapsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type SyncMapsPageOptions

type SyncMapsPageOptions struct {
	PageSize    *int
	Page        *int
	PageToken   *string
	HideExpired *bool
}

SyncMapsPageOptions defines the query options for the api operation

type SyncMapsPageResponse

type SyncMapsPageResponse struct {
	Meta     PageMetaResponse      `json:"meta"`
	SyncMaps []PageSyncMapResponse `json:"maps"`
}

SyncMapsPageResponse defines the response fields for the maps page

type SyncMapsPaginator

type SyncMapsPaginator struct {
	Page     *SyncMapsPage
	SyncMaps []PageSyncMapResponse
	// contains filtered or unexported fields
}

SyncMapsPaginator defines the fields for makings paginated api calls SyncMaps is an array of syncmaps that have been returned from all of the page calls

func (*SyncMapsPaginator) CurrentPage

func (p *SyncMapsPaginator) CurrentPage() *SyncMapsPageResponse

CurrentPage retrieves the results for the current page

func (*SyncMapsPaginator) Error

func (p *SyncMapsPaginator) Error() error

Error retrieves the error returned from the page

func (*SyncMapsPaginator) Next

func (p *SyncMapsPaginator) 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 (*SyncMapsPaginator) NextWithContext

func (p *SyncMapsPaginator) 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