web_channel

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() (*FetchWebChannelResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchWebChannelResponse, error)
  • func (c Client) Update(input *UpdateWebChannelInput) (*UpdateWebChannelResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateWebChannelInput) (*UpdateWebChannelResponse, error)
• type ClientProperties
• type FetchWebChannelResponse
• type UpdateWebChannelInput
• type UpdateWebChannelResponse

Types

type Client

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

Client for managing a specific web channel resource

func New

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

New creates a new instance of the web channel client

func (Client) Delete

func (c Client) Delete() error

Delete removes a web channel resource from the account 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 web channel resource from the account

func (Client) Fetch

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

Fetch retrieves a web channel resource 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) (*FetchWebChannelResponse, error)

FetchWithContext retrieves a web channel resource

func (Client) Update

func (c Client) Update(input *UpdateWebChannelInput) (*UpdateWebChannelResponse, error)

Update modifies a web channel resource 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 *UpdateWebChannelInput) (*UpdateWebChannelResponse, error)

UpdateWithContext modifies a web channel resource

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the web channel resources

type FetchWebChannelResponse

type FetchWebChannelResponse struct {
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	FlexFlowSid string     `json:"flex_flow_sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
}

FetchWebChannelResponse defines the response fields for the retrieved web channel

type UpdateWebChannelInput

type UpdateWebChannelInput struct {
	ChatStatus        *string `form:"ChatStatus,omitempty"`
	PreEngagementData *string `form:"PreEngagementData,omitempty"`
}

UpdateWebChannelInput defines input fields for updating a web channel resource

type UpdateWebChannelResponse

type UpdateWebChannelResponse struct {
	AccountSid  string     `json:"account_sid"`
	DateCreated time.Time  `json:"date_created"`
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	FlexFlowSid string     `json:"flex_flow_sid"`
	Sid         string     `json:"sid"`
	URL         string     `json:"url"`
}

UpdateWebChannelResponse defines the response fields for the updated web channel