permission

Documentation

Overview

Package permission contains auto-generated files. DO NOT MODIFY

Package permission contains auto-generated files. DO NOT MODIFY

Package permission contains auto-generated files. DO NOT MODIFY

Package permission contains auto-generated files. 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() (*FetchDocumentPermissionsResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchDocumentPermissionsResponse, error)
  • func (c Client) Update(input *UpdateDocumentPermissionsInput) (*UpdateDocumentPermissionsResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateDocumentPermissionsInput) (*UpdateDocumentPermissionsResponse, error)
• type ClientProperties
• type FetchDocumentPermissionsResponse
• type UpdateDocumentPermissionsInput
• type UpdateDocumentPermissionsResponse

Types

type Client

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

Client for managing a specific document permissions resource 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 permission client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateDocumentPermissionsInput) (*UpdateDocumentPermissionsResponse, error)

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

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

type ClientProperties

type ClientProperties struct {
	DocumentSid string
	Identity    string
	ServiceSid  string
}

ClientProperties are the properties required to manage the permission resources

type FetchDocumentPermissionsResponse

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

FetchDocumentPermissionsResponse defines the response fields for the retrieved document permission

type UpdateDocumentPermissionsInput

type UpdateDocumentPermissionsInput struct {
	Manage bool `form:"Manage"`
	Read   bool `form:"Read"`
	Write  bool `form:"Write"`
}

UpdateDocumentPermissionsInput defines input fields for updating a document permission resource

type UpdateDocumentPermissionsResponse

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

UpdateDocumentPermissionsResponse defines the response fields for the updated document permission