permission

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. 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() (*FetchSyncListPermissionsResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSyncListPermissionsResponse, error)
  • func (c Client) Update(input *UpdateSyncListPermissionsInput) (*UpdateSyncListPermissionsResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncListPermissionsInput) (*UpdateSyncListPermissionsResponse, error)
• type ClientProperties
• type FetchSyncListPermissionsResponse
• type UpdateSyncListPermissionsInput
• type UpdateSyncListPermissionsResponse

Types

type Client

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

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateSyncListPermissionsInput) (*UpdateSyncListPermissionsResponse, error)

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

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

type ClientProperties

type ClientProperties struct {
	Identity    string
	ServiceSid  string
	SyncListSid string
}

ClientProperties are the properties required to manage the permission resources

type FetchSyncListPermissionsResponse

type FetchSyncListPermissionsResponse struct {
	AccountSid string `json:"account_sid"`
	Identity   string `json:"identity"`
	ListSid    string `json:"list_sid"`
	Manage     bool   `json:"manage"`
	Read       bool   `json:"read"`
	ServiceSid string `json:"service_sid"`
	URL        string `json:"url"`
	Write      bool   `json:"write"`
}

FetchSyncListPermissionsResponse defines the response fields for the retrieved list permission

type UpdateSyncListPermissionsInput

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

UpdateSyncListPermissionsInput defines input fields for updating a list permission resource

type UpdateSyncListPermissionsResponse

type UpdateSyncListPermissionsResponse struct {
	AccountSid string `json:"account_sid"`
	Identity   string `json:"identity"`
	ListSid    string `json:"list_sid"`
	Manage     bool   `json:"manage"`
	Read       bool   `json:"read"`
	ServiceSid string `json:"service_sid"`
	URL        string `json:"url"`
	Write      bool   `json:"write"`
}

UpdateSyncListPermissionsResponse defines the response fields for the updated list permission