participant

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

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)
• type ClientProperties
• type FetchParticipantResponse

Types

type Client

type Client struct {
	MessageInteractions *message_interactions.Client
	// contains filtered or unexported fields
}

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

func (Client) Fetch

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

Fetch retrieves a participant resource See https://www.twilio.com/docs/proxy/api/participant#fetch-a-participant-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 a participant resource See https://www.twilio.com/docs/proxy/api/participant#fetch-a-participant-resource for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	SessionSid string
	Sid        string
}

ClientProperties are the properties required to manage the participant resources

type FetchParticipantResponse

type FetchParticipantResponse struct {
	AccountSid         string     `json:"account_sid"`
	DateCreated        time.Time  `json:"date_created"`
	DateDeleted        *time.Time `json:"date_deleted,omitempty"`
	DateUpdated        *time.Time `json:"date_updated,omitempty"`
	FriendlyName       *string    `json:"friendly_name,omitempty"`
	Identifier         string     `json:"identifier"`
	ProxyIdentifier    *string    `json:"proxy_identifier,omitempty"`
	ProxyIdentifierSid *string    `json:"proxy_identifier_sid,omitempty"`
	ServiceSid         string     `json:"service_sid"`
	SessionSid         string     `json:"session_sid"`
	Sid                string     `json:"sid"`
	URL                string     `json:"url"`
}

FetchParticipantResponse defines the response fields for the retrieved participant