notification

Documentation

Overview

Package notification contains auto-generated files. DO NOT MODIFY

Package notification contains auto-generated files. DO NOT MODIFY

Package notification contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchNotificationResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchNotificationResponse, error)
  • func (c Client) Update(input *UpdateNotificationInput) (*UpdateNotificationResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateNotificationInput) (*UpdateNotificationResponse, error)
• type ClientProperties
• type FetchNotificationResponse
• type FetchNotificationResponseConversationAction
• type FetchNotificationResponseNewMessage
• type UpdateNotificationInput
• type UpdateNotificationResponse
• type UpdateNotificationResponseConversationAction
• type UpdateNotificationResponseNewMessage

Types

type Client

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

Client for managing service notification See https://www.twilio.com/docs/conversations/api/service-notification-resource for more details

func New

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

New creates a new instance of the notification client

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateNotificationInput) (*UpdateNotificationResponse, error)

Update modifies a service notification resource See https://www.twilio.com/docs/conversations/api/service-notification-resource#update-a-servicenotification-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 *UpdateNotificationInput) (*UpdateNotificationResponse, error)

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

type ClientProperties

type ClientProperties struct {
	ServiceSid string
}

ClientProperties are the properties required to manage the notification resources

type FetchNotificationResponse

type FetchNotificationResponse struct {
	AccountSid              string                                      `json:"account_sid"`
	AddedToConversation     FetchNotificationResponseConversationAction `json:"added_to_conversation"`
	ChatServiceSid          string                                      `json:"chat_service_sid"`
	LogEnabled              bool                                        `json:"log_enabled"`
	NewMessage              FetchNotificationResponseNewMessage         `json:"new_message"`
	RemovedFromConversation FetchNotificationResponseConversationAction `json:"removed_from_conversation"`
	URL                     string                                      `json:"url"`
}

FetchNotificationResponse defines the response fields for the retrieved service notification

type FetchNotificationResponseConversationAction

type FetchNotificationResponseConversationAction struct {
	Enabled  bool    `json:"enabled"`
	Sound    *string `json:"sound,omitempty"`
	Template *string `json:"template,omitempty"`
}

type FetchNotificationResponseNewMessage

type FetchNotificationResponseNewMessage struct {
	BadgeCountEnabled *bool   `json:"badge_count_enabled,omitempty"`
	Enabled           bool    `json:"enabled"`
	Sound             *string `json:"sound,omitempty"`
	Template          *string `json:"template,omitempty"`
}

type UpdateNotificationInput

type UpdateNotificationInput struct {
	AddedToConversationEnabled      *bool   `form:"AddedToConversation.Enabled,omitempty"`
	AddedToConversationSound        *string `form:"AddedToConversation.Sound,omitempty"`
	AddedToConversationTemplate     *string `form:"AddedToConversation.Template,omitempty"`
	LogEnabled                      *bool   `form:"LogEnabled,omitempty"`
	NewMessageBadgeCountEnabled     *bool   `form:"NewMessage.BadgeCountEnabled,omitempty"`
	NewMessageEnabled               *bool   `form:"NewMessage.Enabled,omitempty"`
	NewMessageSound                 *string `form:"NewMessage.Sound,omitempty"`
	NewMessageTemplate              *string `form:"NewMessage.Template,omitempty"`
	RemovedFromConversationEnabled  *bool   `form:"RemovedFromConversation.Enabled,omitempty"`
	RemovedFromConversationSound    *string `form:"RemovedFromConversation.Sound,omitempty"`
	RemovedFromConversationTemplate *string `form:"RemovedFromConversation.Template,omitempty"`
}

UpdateNotificationInput defines input fields for updating a service notification resource

type UpdateNotificationResponse

type UpdateNotificationResponse struct {
	AccountSid              string                                       `json:"account_sid"`
	AddedToConversation     UpdateNotificationResponseConversationAction `json:"added_to_conversation"`
	ChatServiceSid          string                                       `json:"chat_service_sid"`
	LogEnabled              bool                                         `json:"log_enabled"`
	NewMessage              UpdateNotificationResponseNewMessage         `json:"new_message"`
	RemovedFromConversation UpdateNotificationResponseConversationAction `json:"removed_from_conversation"`
	URL                     string                                       `json:"url"`
}

UpdateNotificationResponse defines the response fields for the updated service notification

type UpdateNotificationResponseConversationAction

type UpdateNotificationResponseConversationAction struct {
	Enabled  bool    `json:"enabled"`
	Sound    *string `json:"sound,omitempty"`
	Template *string `json:"template,omitempty"`
}

type UpdateNotificationResponseNewMessage

type UpdateNotificationResponseNewMessage struct {
	BadgeCountEnabled *bool   `json:"badge_count_enabled,omitempty"`
	Enabled           bool    `json:"enabled"`
	Sound             *string `json:"sound,omitempty"`
	Template          *string `json:"template,omitempty"`
}