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 {
	Binding  func(string) *binding.Client
	Bindings *bindings.Client
	Channel  func(string) *channel.Client
	Channels *channels.Client
	Role     func(string) *role.Client
	Roles    *roles.Client
	User     func(string) *user.Client
	Users    *users.Client
	// contains filtered or unexported fields
}

Client for managing a specific service resource See https://www.twilio.com/docs/chat/rest/service-resource 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/chat/rest/service-resource#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/chat/rest/service-resource#delete-a-service-resource for more details

func (Client) Fetch

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

Fetch retrieves a service resource See https://www.twilio.com/docs/chat/rest/service-resource#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 a service resource See https://www.twilio.com/docs/chat/rest/service-resource#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/chat/rest/service-resource#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/chat/rest/service-resource#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"`
	ConsumptionReportInterval    int                    `json:"consumption_report_interval"`
	DateCreated                  time.Time              `json:"date_created"`
	DateUpdated                  *time.Time             `json:"date_updated,omitempty"`
	DefaultChannelCreatorRoleSid string                 `json:"default_channel_creator_role_sid"`
	DefaultChannelRoleSid        string                 `json:"default_channel_role_sid"`
	DefaultServiceRoleSid        string                 `json:"default_service_role_sid"`
	FriendlyName                 string                 `json:"friendly_name"`
	Limits                       map[string]interface{} `json:"limits"`
	Media                        map[string]interface{} `json:"media"`
	Notifications                map[string]interface{} `json:"notifications"`
	PostWebhookRetryCount        *int                   `json:"post_webhook_retry_count,omitempty"`
	PostWebhookURL               *string                `json:"post_webhook_url,omitempty"`
	PreWebhookRetryCount         *int                   `json:"pre_webhook_retry_count,omitempty"`
	PreWebhookURL                *string                `json:"pre_webhook_url,omitempty"`
	ReachabilityEnabled          bool                   `json:"reachability_enabled"`
	ReadStatusEnabled            bool                   `json:"read_status_enabled"`
	Sid                          string                 `json:"sid"`
	TypingIndicatorTimeout       int                    `json:"typing_indicator_timeout"`
	URL                          string                 `json:"url"`
	WebhookFilters               *[]string              `json:"webhook_filters,omitempty"`
	WebhookMethod                *string                `json:"webhook_method,omitempty"`
}

FetchServiceResponse defines the response fields for the retrieved service

type UpdateServiceInput

type UpdateServiceInput struct {
	ConsumptionReportInterval                *int      `form:"ConsumptionReportInterval,omitempty"`
	DefaultChannelCreatorRoleSid             *string   `form:"DefaultChannelCreatorRoleSid,omitempty"`
	DefaultChannelRoleSid                    *string   `form:"DefaultChannelRoleSid,omitempty"`
	DefaultServiceRoleSid                    *string   `form:"DefaultServiceRoleSid,omitempty"`
	FriendlyName                             *string   `form:"FriendlyName,omitempty"`
	LimitsChannelMembers                     *int      `form:"Limits.ChannelMembers,omitempty"`
	LimitsUserChannels                       *int      `form:"Limits.UserChannels,omitempty"`
	MediaCompatibilityMessage                *string   `form:"Media.CompatibilityMessage,omitempty"`
	NotificationsAddedToChannelEnabled       *bool     `form:"Notifications.AddedToChannel.Enabled,omitempty"`
	NotificationsAddedToChannelSound         *string   `form:"Notifications.AddedToChannel.Sound,omitempty"`
	NotificationsAddedToChannelTemplate      *string   `form:"Notifications.AddedToChannel.Template,omitempty"`
	NotificationsInvitedToChannelEnabled     *bool     `form:"Notifications.InvitedToChannel.Enabled,omitempty"`
	NotificationsInvitedToChannelSound       *string   `form:"Notifications.InvitedToChannel.Sound,omitempty"`
	NotificationsInvitedToChannelTemplate    *string   `form:"Notifications.InvitedToChannel.Template,omitempty"`
	NotificationsLogEnabled                  *bool     `form:"Notifications.LogEnabled,omitempty"`
	NotificationsNewMessageBadgeCountEnabled *bool     `form:"Notifications.NewMessage.BadgeCountEnabled,omitempty"`
	NotificationsNewMessageEnabled           *bool     `form:"Notifications.NewMessage.Enabled,omitempty"`
	NotificationsNewMessageSound             *string   `form:"Notifications.NewMessage.Sound,omitempty"`
	NotificationsNewMessageTemplate          *string   `form:"Notifications.NewMessage.Template,omitempty"`
	NotificationsRemovedFromChannelEnabled   *bool     `form:"Notifications.RemovedFromChannel.Enabled,omitempty"`
	NotificationsRemovedFromChannelSound     *string   `form:"Notifications.RemovedFromChannel.Sound,omitempty"`
	NotificationsRemovedFromChannelTemplate  *string   `form:"Notifications.RemovedFromChannel.Template,omitempty"`
	PostWebhookRetryCount                    *int      `form:"PostWebhookRetryCount,omitempty"`
	PostWebhookURL                           *string   `form:"PostWebhookUrl,omitempty"`
	PreWebhookRetryCount                     *int      `form:"PreWebhookRetryCount,omitempty"`
	PreWebhookURL                            *string   `form:"PreWebhookUrl,omitempty"`
	ReadStatusEnabled                        *bool     `form:"ReadStatusEnabled,omitempty"`
	TypingIndicatorTimeout                   *int      `form:"TypingIndicatorTimeout,omitempty"`
	WebhookFilters                           *[]string `form:"WebhookFilters,omitempty"`
	WebhookMethod                            *string   `form:"WebhookMethod,omitempty"`
}

UpdateServiceInput defines the input fields for updating a service resource

type UpdateServiceResponse

type UpdateServiceResponse struct {
	AccountSid                   string                 `json:"account_sid"`
	ConsumptionReportInterval    int                    `json:"consumption_report_interval"`
	DateCreated                  time.Time              `json:"date_created"`
	DateUpdated                  *time.Time             `json:"date_updated,omitempty"`
	DefaultChannelCreatorRoleSid string                 `json:"default_channel_creator_role_sid"`
	DefaultChannelRoleSid        string                 `json:"default_channel_role_sid"`
	DefaultServiceRoleSid        string                 `json:"default_service_role_sid"`
	FriendlyName                 string                 `json:"friendly_name"`
	Limits                       map[string]interface{} `json:"limits"`
	Media                        map[string]interface{} `json:"media"`
	Notifications                map[string]interface{} `json:"notifications"`
	PostWebhookRetryCount        *int                   `json:"post_webhook_retry_count,omitempty"`
	PostWebhookURL               *string                `json:"post_webhook_url,omitempty"`
	PreWebhookRetryCount         *int                   `json:"pre_webhook_retry_count,omitempty"`
	PreWebhookURL                *string                `json:"pre_webhook_url,omitempty"`
	ReachabilityEnabled          bool                   `json:"reachability_enabled"`
	ReadStatusEnabled            bool                   `json:"read_status_enabled"`
	Sid                          string                 `json:"sid"`
	TypingIndicatorTimeout       int                    `json:"typing_indicator_timeout"`
	URL                          string                 `json:"url"`
	WebhookFilters               *[]string              `json:"webhook_filters,omitempty"`
	WebhookMethod                *string                `json:"webhook_method,omitempty"`
}

UpdateServiceResponse defines the response fields for the updated service