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() (*FetchSyncMapPermissionsResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchSyncMapPermissionsResponse, error)
  • func (c Client) Update(input *UpdateSyncMapPermissionsInput) (*UpdateSyncMapPermissionsResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateSyncMapPermissionsInput) (*UpdateSyncMapPermissionsResponse, error)
• type ClientProperties
• type FetchSyncMapPermissionsResponse
• type UpdateSyncMapPermissionsInput
• type UpdateSyncMapPermissionsResponse

Types

type Client

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

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateSyncMapPermissionsInput) (*UpdateSyncMapPermissionsResponse, error)

Update modifies an map item permission resource See https://www.twilio.com/docs/sync/api/sync-map-permission-resource#update-a-sync-map-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 *UpdateSyncMapPermissionsInput) (*UpdateSyncMapPermissionsResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Identity   string
	ServiceSid string
	SyncMapSid string
}

ClientProperties are the properties required to manage the permission resources

type FetchSyncMapPermissionsResponse

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

FetchSyncMapPermissionsResponse defines the response fields for the retrieved map item permission

type UpdateSyncMapPermissionsInput

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

UpdateSyncMapPermissionsInput defines input fields for updating a map item permission resource

type UpdateSyncMapPermissionsResponse

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

UpdateSyncMapPermissionsResponse defines the response fields for the updated map item permission