participant

Documentation

Overview

Package participant contains auto-generated files. DO NOT MODIFY

Package participant contains auto-generated files. DO NOT MODIFY

Package participant contains auto-generated files. DO NOT MODIFY

Package participant 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() (*FetchParticipantResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchParticipantResponse, error)
  • func (c Client) Update(input *UpdateParticipantInput) (*UpdateParticipantResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateParticipantInput) (*UpdateParticipantResponse, error)
• type ClientProperties
• type FetchParticipantMessageBindingResponse
• type FetchParticipantResponse
• type UpdateParticipantInput
• type UpdateParticipantMessageBindingInput
• type UpdateParticipantMessageBindingResponse
• type UpdateParticipantResponse

Types

type Client

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

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

func New

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

New creates a new instance of the participant client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateParticipantInput) (*UpdateParticipantResponse, error)

Update modifies a participant resource See https://www.twilio.com/docs/conversations/api/conversation-participant-resource#update-a-conversationparticipant-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 *UpdateParticipantInput) (*UpdateParticipantResponse, error)

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

type ClientProperties

type ClientProperties struct {
	ConversationSid string
	Sid             string
}

ClientProperties are the properties required to manage the participant resources

type FetchParticipantMessageBindingResponse

type FetchParticipantMessageBindingResponse struct {
	Address          string  `json:"address"`
	ProjectedAddress *string `json:"projected_address,omitempty"`
	ProxyAddress     string  `json:"proxy_address"`
	Type             string  `json:"type"`
}

type FetchParticipantResponse

type FetchParticipantResponse struct {
	AccountSid           string                                  `json:"account_sid"`
	Attributes           string                                  `json:"attributes"`
	ConversationSid      string                                  `json:"conversation_sid"`
	DateCreated          time.Time                               `json:"date_created"`
	DateUpdated          *time.Time                              `json:"date_updated,omitempty"`
	Identity             *string                                 `json:"identity,omitempty"`
	LastReadMessageIndex *int                                    `json:"last_read_message_index,omitempty"`
	LastReadTimestamp    *time.Time                              `json:"last_read_timestamp,omitempty"`
	MessagingBinding     *FetchParticipantMessageBindingResponse `json:"messaging_binding,omitempty"`
	RoleSid              *string                                 `json:"role_sid,omitempty"`
	Sid                  string                                  `json:"sid"`
	URL                  string                                  `json:"url"`
}

FetchParticipantResponse defines the response fields for the retrieved participant

type UpdateParticipantInput

type UpdateParticipantInput struct {
	Attributes       *string                               `form:"Attributes,omitempty"`
	DateCreated      *utils.RFC2822Time                    `form:"DateCreated,omitempty"`
	DateUpdated      *utils.RFC2822Time                    `form:"DateUpdated,omitempty"`
	MessagingBinding *UpdateParticipantMessageBindingInput `form:"MessagingBinding,omitempty"`
	RoleSid          *string                               `form:"RoleSid,omitempty"`
}

UpdateParticipantInput defines input fields for updating an participant resource

type UpdateParticipantMessageBindingInput

type UpdateParticipantMessageBindingInput struct {
	ProjectedAddress *string `form:"ProjectedAddress,omitempty"`
	ProxyAddress     *string `form:"ProxyAddress,omitempty"`
}

type UpdateParticipantMessageBindingResponse

type UpdateParticipantMessageBindingResponse struct {
	Address          string  `json:"address"`
	ProjectedAddress *string `json:"projected_address,omitempty"`
	ProxyAddress     string  `json:"proxy_address"`
	Type             string  `json:"type"`
}

type UpdateParticipantResponse

type UpdateParticipantResponse struct {
	AccountSid           string                                   `json:"account_sid"`
	Attributes           string                                   `json:"attributes"`
	ConversationSid      string                                   `json:"conversation_sid"`
	DateCreated          time.Time                                `json:"date_created"`
	DateUpdated          *time.Time                               `json:"date_updated,omitempty"`
	Identity             *string                                  `json:"identity,omitempty"`
	LastReadMessageIndex *int                                     `json:"last_read_message_index,omitempty"`
	LastReadTimestamp    *time.Time                               `json:"last_read_timestamp,omitempty"`
	MessagingBinding     *UpdateParticipantMessageBindingResponse `json:"messaging_binding,omitempty"`
	RoleSid              *string                                  `json:"role_sid,omitempty"`
	Sid                  string                                   `json:"sid"`
	URL                  string                                   `json:"url"`
}

UpdateParticipantResponse defines the response fields for the updated participant