Documentation ¶
Overview ¶
Package permissions contains auto-generated files. DO NOT MODIFY
Package permissions contains auto-generated files. DO NOT MODIFY
Index ¶
- type Client
- func (c *Client) NewDocumentPermissionsPaginator() *DocumentPermissionsPaginator
- func (c *Client) NewDocumentPermissionsPaginatorWithOptions(options *DocumentPermissionsPageOptions) *DocumentPermissionsPaginator
- func (c Client) Page(options *DocumentPermissionsPageOptions) (*DocumentPermissionsPageResponse, error)
- func (c Client) PageWithContext(context context.Context, options *DocumentPermissionsPageOptions) (*DocumentPermissionsPageResponse, error)
- type ClientProperties
- type DocumentPermissionsPage
- type DocumentPermissionsPageOptions
- type DocumentPermissionsPageResponse
- type DocumentPermissionsPaginator
- type PageDocumentPermissionsResponse
- type PageMetaResponse
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 document permission resources See https://www.twilio.com/docs/sync/api/document-permission-resource for more details
func New ¶
func New(client *client.Client, properties ClientProperties) *Client
New creates a new instance of the permissions client
func (*Client) NewDocumentPermissionsPaginator ¶
func (c *Client) NewDocumentPermissionsPaginator() *DocumentPermissionsPaginator
NewDocumentPermissionsPaginator creates a new instance of the paginator for Page.
func (*Client) NewDocumentPermissionsPaginatorWithOptions ¶
func (c *Client) NewDocumentPermissionsPaginatorWithOptions(options *DocumentPermissionsPageOptions) *DocumentPermissionsPaginator
NewDocumentPermissionsPaginatorWithOptions creates a new instance of the paginator for Page with options.
func (Client) Page ¶
func (c Client) Page(options *DocumentPermissionsPageOptions) (*DocumentPermissionsPageResponse, error)
Page retrieves a page of document permissions See https://www.twilio.com/docs/sync/api/document-permission-resource#read-multiple-document-permission-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 *DocumentPermissionsPageOptions) (*DocumentPermissionsPageResponse, error)
PageWithContext retrieves a page of document permissions See https://www.twilio.com/docs/sync/api/document-permission-resource#read-multiple-document-permission-resources for more details
type ClientProperties ¶
ClientProperties are the properties required to manage the permissions resources
type DocumentPermissionsPage ¶
type DocumentPermissionsPage struct { CurrentPage *DocumentPermissionsPageResponse Error error // contains filtered or unexported fields }
DocumentPermissionsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageDocumentPermissionsResponse or error that is returned from the api call(s)
type DocumentPermissionsPageOptions ¶
DocumentPermissionsPageOptions defines the query options for the api operation
type DocumentPermissionsPageResponse ¶
type DocumentPermissionsPageResponse struct { Meta PageMetaResponse `json:"meta"` Permissions []PageDocumentPermissionsResponse `json:"permissions"` }
DocumentPermissionsPageResponse defines the response fields for the document permissions page
type DocumentPermissionsPaginator ¶
type DocumentPermissionsPaginator struct { Page *DocumentPermissionsPage Permissions []PageDocumentPermissionsResponse // contains filtered or unexported fields }
DocumentPermissionsPaginator defines the fields for makings paginated api calls Permissions is an array of permissions that have been returned from all of the page calls
func (*DocumentPermissionsPaginator) CurrentPage ¶
func (p *DocumentPermissionsPaginator) CurrentPage() *DocumentPermissionsPageResponse
CurrentPage retrieves the results for the current page
func (*DocumentPermissionsPaginator) Error ¶
func (p *DocumentPermissionsPaginator) Error() error
Error retrieves the error returned from the page
func (*DocumentPermissionsPaginator) Next ¶
func (p *DocumentPermissionsPaginator) 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 (*DocumentPermissionsPaginator) NextWithContext ¶
func (p *DocumentPermissionsPaginator) 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
type PageDocumentPermissionsResponse ¶
type PageDocumentPermissionsResponse struct { AccountSid string `json:"account_sid"` DocumentSid string `json:"document_sid"` Identity string `json:"identity"` Manage bool `json:"manage"` Read bool `json:"read"` ServiceSid string `json:"service_sid"` URL string `json:"url"` Write bool `json:"write"` }