message

Documentation

Overview

Package message contains auto-generated files. DO NOT MODIFY

Package message contains auto-generated files. DO NOT MODIFY

Package message contains auto-generated files. DO NOT MODIFY

Package message 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() (*FetchMessageResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchMessageResponse, error)
  • func (c Client) Update(input *UpdateMessageInput) (*UpdateMessageResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateMessageInput) (*UpdateMessageResponse, error)
• type ClientProperties
• type FetchMessageDeliveryResponse
• type FetchMessageMediaResponse
• type FetchMessageResponse
• type UpdateMessageDeliveryResponse
• type UpdateMessageInput
• type UpdateMessageMediaResponse
• type UpdateMessageResponse

Types

type Client

type Client struct {
	DeliveryReceipt  func(string) *delivery_receipt.Client
	DeliveryReceipts *delivery_receipts.Client
	// contains filtered or unexported fields
}

Client for managing a specific message resource See https://www.twilio.com/docs/conversations/api/conversation-message-resource for more details

func New

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

New creates a new instance of the message client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

Fetch retrieves a message resource See https://www.twilio.com/docs/conversations/api/conversation-message-resource#fetch-a-conversationmessage-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) (*FetchMessageResponse, error)

FetchWithContext retrieves a message resource See https://www.twilio.com/docs/conversations/api/conversation-message-resource#fetch-a-conversationmessage-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateMessageInput) (*UpdateMessageResponse, error)

Update modifies a message resource See https://www.twilio.com/docs/conversations/api/conversation-message-resource#update-a-conversationmessage-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 *UpdateMessageInput) (*UpdateMessageResponse, error)

UpdateWithContext modifies a message resource See https://www.twilio.com/docs/conversations/api/conversation-message-resource#update-a-conversationmessage-resource for more details

type ClientProperties

type ClientProperties struct {
	ConversationSid string
	ServiceSid      string
	Sid             string
}

ClientProperties are the properties required to manage the message resources

type FetchMessageDeliveryResponse

type FetchMessageDeliveryResponse struct {
	Delivered   string `json:"delivered"`
	Failed      string `json:"failed"`
	Read        string `json:"read"`
	Sent        string `json:"sent"`
	Total       int    `json:"total"`
	Undelivered string `json:"undelivered"`
}

type FetchMessageMediaResponse

type FetchMessageMediaResponse struct {
	ContentType string `json:"content_type"`
	Filename    string `json:"filename"`
	Sid         string `json:"sid"`
	Size        int    `json:"size"`
}

type FetchMessageResponse

type FetchMessageResponse struct {
	AccountSid      string                        `json:"account_sid"`
	Attributes      string                        `json:"attributes"`
	Author          string                        `json:"author"`
	Body            *string                       `json:"body,omitempty"`
	ChatServiceSid  string                        `json:"chat_service_sid"`
	ConversationSid string                        `json:"conversation_sid"`
	DateCreated     time.Time                     `json:"date_created"`
	DateUpdated     *time.Time                    `json:"date_updated,omitempty"`
	Delivery        *FetchMessageDeliveryResponse `json:"delivery,omitempty"`
	Index           int                           `json:"index"`
	Media           *[]FetchMessageMediaResponse  `json:"media,omitempty"`
	ParticipantSid  *string                       `json:"participant_sid,omitempty"`
	Sid             string                        `json:"sid"`
	URL             string                        `json:"url"`
}

FetchMessageResponse defines the response fields for the retrieved message

type UpdateMessageDeliveryResponse

type UpdateMessageDeliveryResponse struct {
	Delivered   string `json:"delivered"`
	Failed      string `json:"failed"`
	Read        string `json:"read"`
	Sent        string `json:"sent"`
	Total       int    `json:"total"`
	Undelivered string `json:"undelivered"`
}

type UpdateMessageInput

type UpdateMessageInput struct {
	Attributes  *string            `form:"Attributes,omitempty"`
	Author      *string            `form:"Author,omitempty"`
	Body        *string            `form:"Body,omitempty"`
	DateCreated *utils.RFC2822Time `form:"DateCreated,omitempty"`
	DateUpdated *utils.RFC2822Time `form:"DateUpdated,omitempty"`
}

UpdateMessageInput defines input fields for updating a message resource

type UpdateMessageMediaResponse

type UpdateMessageMediaResponse struct {
	ContentType string `json:"content_type"`
	Filename    string `json:"filename"`
	Sid         string `json:"sid"`
	Size        int    `json:"size"`
}

type UpdateMessageResponse

type UpdateMessageResponse struct {
	AccountSid      string                         `json:"account_sid"`
	Attributes      string                         `json:"attributes"`
	Author          string                         `json:"author"`
	Body            *string                        `json:"body,omitempty"`
	ChatServiceSid  string                         `json:"chat_service_sid"`
	ConversationSid string                         `json:"conversation_sid"`
	DateCreated     time.Time                      `json:"date_created"`
	DateUpdated     *time.Time                     `json:"date_updated,omitempty"`
	Delivery        *UpdateMessageDeliveryResponse `json:"delivery,omitempty"`
	Index           int                            `json:"index"`
	Media           *[]UpdateMessageMediaResponse  `json:"media,omitempty"`
	ParticipantSid  *string                        `json:"participant_sid,omitempty"`
	Sid             string                         `json:"sid"`
	URL             string                         `json:"url"`
}

UpdateMessageResponse defines the response fields for the updated message