web_channels

Documentation

Overview

Package web_channels contains auto-generated files. DO NOT MODIFY

Package web_channels contains auto-generated files. DO NOT MODIFY

Package web_channels contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateWebChannelInput) (*CreateWebChannelResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateWebChannelInput) (*CreateWebChannelResponse, error)
  • func (c *Client) NewWebChannelsPaginator() *WebChannelsPaginator
  • func (c *Client) NewWebChannelsPaginatorWithOptions(options *WebChannelsPageOptions) *WebChannelsPaginator
  • func (c Client) Page(options *WebChannelsPageOptions) (*WebChannelsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *WebChannelsPageOptions) (*WebChannelsPageResponse, error)
• type CreateWebChannelInput
• type CreateWebChannelResponse
• type PageMetaResponse
• type PageWebChannelResponse
• type WebChannelsPage
• type WebChannelsPageOptions
• type WebChannelsPageResponse
• type WebChannelsPaginator
  • func (p *WebChannelsPaginator) CurrentPage() *WebChannelsPageResponse
  • func (p *WebChannelsPaginator) Error() error
  • func (p *WebChannelsPaginator) Next() bool
  • func (p *WebChannelsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing web channel resources

func New

func New(client *client.Client) *Client

New creates a new instance of the web channels client

func (Client) Create

func (c Client) Create(input *CreateWebChannelInput) (*CreateWebChannelResponse, error)

Create creates a new web channel Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateWebChannelInput) (*CreateWebChannelResponse, error)

CreateWithContext creates a new web channel

func (*Client) NewWebChannelsPaginator

func (c *Client) NewWebChannelsPaginator() *WebChannelsPaginator

NewWebChannelsPaginator creates a new instance of the paginator for Page.

func (*Client) NewWebChannelsPaginatorWithOptions

func (c *Client) NewWebChannelsPaginatorWithOptions(options *WebChannelsPageOptions) *WebChannelsPaginator

NewWebChannelsPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *WebChannelsPageOptions) (*WebChannelsPageResponse, error)

Page retrieves a page of web channels Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *WebChannelsPageOptions) (*WebChannelsPageResponse, error)

PageWithContext retrieves a page of web channels

type CreateWebChannelInput

type CreateWebChannelInput struct {
	ChatFriendlyName     string  `validate:"required" form:"ChatFriendlyName"`
	ChatUniqueName       *string `form:"ChatUniqueName,omitempty"`
	CustomerFriendlyName string  `validate:"required" form:"CustomerFriendlyName"`
	FlexFlowSid          string  `validate:"required" form:"FlexFlowSid"`
	Identity             string  `validate:"required" form:"Identity"`
	PreEngagementData    *string `form:"PreEngagementData,omitempty"`
}

CreateWebChannelInput defines the input fields for creating a new web channel resource

type CreateWebChannelResponse

type CreateWebChannelResponse 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"`
}

CreateWebChannelResponse defines the response fields for the created web channel

type PageMetaResponse

type PageMetaResponse struct {
	FirstPageURL    string  `json:"first_page_url"`
	Key             string  `json:"key"`
	NextPageURL     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page"`
	PageSize        int     `json:"page_size"`
	PreviousPageURL *string `json:"previous_page_url,omitempty"`
	URL             string  `json:"url"`
}

type PageWebChannelResponse

type PageWebChannelResponse 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"`
}

type WebChannelsPage

type WebChannelsPage struct {
	CurrentPage *WebChannelsPageResponse
	Error       error
	// contains filtered or unexported fields
}

WebChannelsPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageWebChannelResponse or error that is returned from the api call(s)

type WebChannelsPageOptions

type WebChannelsPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

WebChannelsPageOptions defines the query options for the api operation

type WebChannelsPageResponse

type WebChannelsPageResponse struct {
	Meta        PageMetaResponse         `json:"meta"`
	WebChannels []PageWebChannelResponse `json:"flex_chat_channels"`
}

WebChannelsPageResponse defines the response fields for the web channels page

type WebChannelsPaginator

type WebChannelsPaginator struct {
	Page        *WebChannelsPage
	WebChannels []PageWebChannelResponse
	// contains filtered or unexported fields
}

WebChannelsPaginator defines the fields for makings paginated api calls WebChannels is an array of webchannels that have been returned from all of the page calls

func (*WebChannelsPaginator) CurrentPage

func (p *WebChannelsPaginator) CurrentPage() *WebChannelsPageResponse

CurrentPage retrieves the results for the current page

func (*WebChannelsPaginator) Error

func (p *WebChannelsPaginator) Error() error

Error retrieves the error returned from the page

func (*WebChannelsPaginator) Next

func (p *WebChannelsPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*WebChannelsPaginator) NextWithContext

func (p *WebChannelsPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate