channels

Documentation

Overview

Package channels contains auto-generated files. DO NOT MODIFY

Package channels contains auto-generated files. DO NOT MODIFY

Package channels contains auto-generated files. DO NOT MODIFY

Index

• type ChannelsPage
• type ChannelsPageOptions
• type ChannelsPageResponse
• type ChannelsPaginator
  • func (p *ChannelsPaginator) CurrentPage() *ChannelsPageResponse
  • func (p *ChannelsPaginator) Error() error
  • func (p *ChannelsPaginator) Next() bool
  • func (p *ChannelsPaginator) NextWithContext(context context.Context) bool
• type Client
  • func New(client *client.Client) *Client
  • func (c Client) Create(input *CreateChannelInput) (*CreateChannelResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateChannelInput) (*CreateChannelResponse, error)
  • func (c *Client) NewChannelsPaginator() *ChannelsPaginator
  • func (c *Client) NewChannelsPaginatorWithOptions(options *ChannelsPageOptions) *ChannelsPaginator
  • func (c Client) Page(options *ChannelsPageOptions) (*ChannelsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *ChannelsPageOptions) (*ChannelsPageResponse, error)
• type CreateChannelInput
• type CreateChannelResponse
• type PageChannelResponse
• type PageMetaResponse

Types

type ChannelsPage

type ChannelsPage struct {
	CurrentPage *ChannelsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type ChannelsPageOptions

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

ChannelsPageOptions defines the query options for the api operation

type ChannelsPageResponse

type ChannelsPageResponse struct {
	Channels []PageChannelResponse `json:"flex_chat_channels"`
	Meta     PageMetaResponse      `json:"meta"`
}

ChannelsPageResponse defines the response fields for the channels page

type ChannelsPaginator

type ChannelsPaginator struct {
	Page     *ChannelsPage
	Channels []PageChannelResponse
	// contains filtered or unexported fields
}

ChannelsPaginator defines the fields for makings paginated api calls Channels is an array of channels that have been returned from all of the page calls

func (*ChannelsPaginator) CurrentPage

func (p *ChannelsPaginator) CurrentPage() *ChannelsPageResponse

CurrentPage retrieves the results for the current page

func (*ChannelsPaginator) Error

func (p *ChannelsPaginator) Error() error

Error retrieves the error returned from the page

func (*ChannelsPaginator) Next

func (p *ChannelsPaginator) 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 (*ChannelsPaginator) NextWithContext

func (p *ChannelsPaginator) 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

type Client

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

Client for managing channel resources

func New

func New(client *client.Client) *Client

New creates a new instance of the channels client

func (Client) Create

func (c Client) Create(input *CreateChannelInput) (*CreateChannelResponse, error)

Create creates a new 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 *CreateChannelInput) (*CreateChannelResponse, error)

CreateWithContext creates a new channel

func (*Client) NewChannelsPaginator

func (c *Client) NewChannelsPaginator() *ChannelsPaginator

NewChannelsPaginator creates a new instance of the paginator for Page.

func (*Client) NewChannelsPaginatorWithOptions

func (c *Client) NewChannelsPaginatorWithOptions(options *ChannelsPageOptions) *ChannelsPaginator

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

func (Client) Page

func (c Client) Page(options *ChannelsPageOptions) (*ChannelsPageResponse, error)

Page retrieves a page of 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 *ChannelsPageOptions) (*ChannelsPageResponse, error)

PageWithContext retrieves a page of channels

type CreateChannelInput

type CreateChannelInput struct {
	ChatFriendlyName     string  `validate:"required" form:"ChatFriendlyName"`
	ChatUniqueName       *string `form:"ChatUniqueName,omitempty"`
	ChatUserFriendlyName string  `validate:"required" form:"ChatUserFriendlyName"`
	FlexFlowSid          string  `validate:"required" form:"FlexFlowSid"`
	Identity             string  `validate:"required" form:"Identity"`
	LongLived            *bool   `form:"LongLived,omitempty"`
	PreEngagementData    *string `form:"PreEngagementData,omitempty"`
	Target               *string `form:"Target,omitempty"`
	TaskAttributes       *string `form:"TaskAttributes,omitempty"`
	TaskSid              *string `form:"TaskSid,omitempty"`
}

CreateChannelInput defines the input fields for creating a new channel resource

type CreateChannelResponse

type CreateChannelResponse 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"`
	TaskSid     *string    `json:"task_sid,omitempty"`
	URL         string     `json:"url"`
	UserSid     string     `json:"user_sid"`
}

CreateChannelResponse defines the response fields for the created channel

type PageChannelResponse

type PageChannelResponse 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"`
	TaskSid     *string    `json:"task_sid,omitempty"`
	URL         string     `json:"url"`
	UserSid     string     `json:"user_sid"`
}

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