service

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

Types

type Client

type Client struct {
	Document    func(string) *document.Client
	Documents   *documents.Client
	SyncList    func(string) *sync_list.Client
	SyncLists   *sync_lists.Client
	SyncMap     func(string) *sync_map.Client
	SyncMaps    *sync_maps.Client
	SyncStream  func(string) *sync_stream.Client
	SyncStreams *sync_streams.Client
	// contains filtered or unexported fields
}

Client for managing a specific service resource See https://www.twilio.com/docs/sync/api/service for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the service client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateServiceInput) (*UpdateServiceResponse, error)

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

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

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the service resources

type FetchServiceResponse

type FetchServiceResponse struct {
	AccountSid                    string     `json:"account_sid"`
	AclEnabled                    bool       `json:"acl_enabled"`
	DateCreated                   time.Time  `json:"date_created"`
	DateUpdated                   *time.Time `json:"date_updated,omitempty"`
	FriendlyName                  *string    `json:"friendly_name,omitempty"`
	ReachabilityDebouncingEnabled bool       `json:"reachability_debouncing_enabled"`
	ReachabilityDebouncingWindow  int        `json:"reachability_debouncing_window"`
	ReachabilityWebhooksEnabled   bool       `json:"reachability_webhooks_enabled"`
	Sid                           string     `json:"sid"`
	URL                           string     `json:"url"`
	UniqueName                    *string    `json:"unique_name,omitempty"`
	WebhookURL                    *string    `json:"webhook_url,omitempty"`
	WebhooksFromRestEnabled       bool       `json:"webhooks_from_rest_enabled"`
}

FetchServiceResponse defines the response fields for the retrieved service

type UpdateServiceInput

type UpdateServiceInput struct {
	AclEnabled                    *bool   `form:"AclEnabled,omitempty"`
	FriendlyName                  *string `form:"FriendlyName,omitempty"`
	ReachabilityDebouncingEnabled *bool   `form:"ReachabilityDebouncingEnabled,omitempty"`
	ReachabilityDebouncingWindow  *int    `form:"ReachabilityDebouncingWindow,omitempty"`
	ReachabilityWebhooksEnabled   *bool   `form:"ReachabilityWebhooksEnabled,omitempty"`
	WebhookURL                    *string `form:"WebhookUrl,omitempty"`
	WebhooksFromRestEnabled       *bool   `form:"WebhooksFromRestEnabled,omitempty"`
}

UpdateServiceInput defines input fields for updating a service resource

type UpdateServiceResponse

type UpdateServiceResponse struct {
	AccountSid                    string     `json:"account_sid"`
	AclEnabled                    bool       `json:"acl_enabled"`
	DateCreated                   time.Time  `json:"date_created"`
	DateUpdated                   *time.Time `json:"date_updated,omitempty"`
	FriendlyName                  *string    `json:"friendly_name,omitempty"`
	ReachabilityDebouncingEnabled bool       `json:"reachability_debouncing_enabled"`
	ReachabilityDebouncingWindow  int        `json:"reachability_debouncing_window"`
	ReachabilityWebhooksEnabled   bool       `json:"reachability_webhooks_enabled"`
	Sid                           string     `json:"sid"`
	URL                           string     `json:"url"`
	UniqueName                    *string    `json:"unique_name,omitempty"`
	WebhookURL                    *string    `json:"webhook_url,omitempty"`
	WebhooksFromRestEnabled       bool       `json:"webhooks_from_rest_enabled"`
}

UpdateServiceResponse defines the response fields for the updated service