task_channels

Documentation

Overview

Package task_channels contains auto-generated files. DO NOT MODIFY

Package task_channels contains auto-generated files. DO NOT MODIFY

Package task_channels contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateTaskChannelInput) (*CreateTaskChannelResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateTaskChannelInput) (*CreateTaskChannelResponse, error)
  • func (c *Client) NewTaskChannelsPaginator() *TaskChannelsPaginator
  • func (c *Client) NewTaskChannelsPaginatorWithOptions(options *TaskChannelsPageOptions) *TaskChannelsPaginator
  • func (c Client) Page(options *TaskChannelsPageOptions) (*TaskChannelsPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *TaskChannelsPageOptions) (*TaskChannelsPageResponse, error)
• type ClientProperties
• type CreateTaskChannelInput
• type CreateTaskChannelResponse
• type PageMetaResponse
• type PageTaskChannelResponse
• type TaskChannelsPage
• type TaskChannelsPageOptions
• type TaskChannelsPageResponse
• type TaskChannelsPaginator
  • func (p *TaskChannelsPaginator) CurrentPage() *TaskChannelsPageResponse
  • func (p *TaskChannelsPaginator) Error() error
  • func (p *TaskChannelsPaginator) Next() bool
  • func (p *TaskChannelsPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing task channel resources See https://www.twilio.com/docs/taskrouter/api/task-channel for more details

func New

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

New creates a new instance of the task channels client

func (Client) Create

func (c Client) Create(input *CreateTaskChannelInput) (*CreateTaskChannelResponse, error)

Create creates a new task channel See https://www.twilio.com/docs/taskrouter/api/task-channel#create-a-taskchannel-resource for more details 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 *CreateTaskChannelInput) (*CreateTaskChannelResponse, error)

CreateWithContext creates a new task channel See https://www.twilio.com/docs/taskrouter/api/task-channel#create-a-taskchannel-resource for more details

func (*Client) NewTaskChannelsPaginator

func (c *Client) NewTaskChannelsPaginator() *TaskChannelsPaginator

NewTaskChannelsPaginator creates a new instance of the paginator for Page.

func (*Client) NewTaskChannelsPaginatorWithOptions

func (c *Client) NewTaskChannelsPaginatorWithOptions(options *TaskChannelsPageOptions) *TaskChannelsPaginator

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

func (Client) Page

func (c Client) Page(options *TaskChannelsPageOptions) (*TaskChannelsPageResponse, error)

Page retrieves a page of task channels See https://www.twilio.com/docs/taskrouter/api/task-channel#read-multiple-taskchannel-resources for more details 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 *TaskChannelsPageOptions) (*TaskChannelsPageResponse, error)

PageWithContext retrieves a page of task channels See https://www.twilio.com/docs/taskrouter/api/task-channel#read-multiple-taskchannel-resources for more details

type ClientProperties

type ClientProperties struct {
	WorkspaceSid string
}

ClientProperties are the properties required to manage the task channels resources

type CreateTaskChannelInput

type CreateTaskChannelInput struct {
	ChannelOptimizedRouting *bool  `form:"ChannelOptimizedRouting,omitempty"`
	FriendlyName            string `validate:"required" form:"FriendlyName"`
	UniqueName              string `validate:"required" form:"UniqueName"`
}

CreateTaskChannelInput defines the input fields for creating a new task channel resource

type CreateTaskChannelResponse

type CreateTaskChannelResponse struct {
	AccountSid              string     `json:"account_sid"`
	ChannelOptimizedRouting *bool      `json:"channel_optimized_routing,omitempty"`
	DateCreated             time.Time  `json:"date_created"`
	DateUpdated             *time.Time `json:"date_updated,omitempty"`
	FriendlyName            string     `json:"friendly_name"`
	Sid                     string     `json:"sid"`
	URL                     string     `json:"url"`
	UniqueName              string     `json:"unique_name"`
	WorkspaceSid            string     `json:"workspace_sid"`
}

CreateTaskChannelResponse defines the response fields for the created task 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 PageTaskChannelResponse

type PageTaskChannelResponse struct {
	AccountSid              string     `json:"account_sid"`
	ChannelOptimizedRouting *bool      `json:"channel_optimized_routing,omitempty"`
	DateCreated             time.Time  `json:"date_created"`
	DateUpdated             *time.Time `json:"date_updated,omitempty"`
	FriendlyName            string     `json:"friendly_name"`
	Sid                     string     `json:"sid"`
	URL                     string     `json:"url"`
	UniqueName              string     `json:"unique_name"`
	WorkspaceSid            string     `json:"workspace_sid"`
}

type TaskChannelsPage

type TaskChannelsPage struct {
	CurrentPage *TaskChannelsPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type TaskChannelsPageOptions

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

TaskChannelsPageOptions defines the query options for the api operation

type TaskChannelsPageResponse

type TaskChannelsPageResponse struct {
	Meta         PageMetaResponse          `json:"meta"`
	TaskChannels []PageTaskChannelResponse `json:"channels"`
}

TaskChannelsPageResponse defines the response fields for the task channels page

type TaskChannelsPaginator

type TaskChannelsPaginator struct {
	Page         *TaskChannelsPage
	TaskChannels []PageTaskChannelResponse
	// contains filtered or unexported fields
}

TaskChannelsPaginator defines the fields for makings paginated api calls TaskChannels is an array of taskchannels that have been returned from all of the page calls

func (*TaskChannelsPaginator) CurrentPage

func (p *TaskChannelsPaginator) CurrentPage() *TaskChannelsPageResponse

CurrentPage retrieves the results for the current page

func (*TaskChannelsPaginator) Error

func (p *TaskChannelsPaginator) Error() error

Error retrieves the error returned from the page

func (*TaskChannelsPaginator) Next

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

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