task_queues

Documentation

Overview

Package task_queues contains auto-generated files. DO NOT MODIFY

Package task_queues contains auto-generated files. DO NOT MODIFY

Package task_queues contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateTaskQueueInput) (*CreateTaskQueueResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateTaskQueueInput) (*CreateTaskQueueResponse, error)
  • func (c *Client) NewTaskQueuesPaginator() *TaskQueuesPaginator
  • func (c *Client) NewTaskQueuesPaginatorWithOptions(options *TaskQueuesPageOptions) *TaskQueuesPaginator
  • func (c Client) Page(options *TaskQueuesPageOptions) (*TaskQueuesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *TaskQueuesPageOptions) (*TaskQueuesPageResponse, error)
• type ClientProperties
• type CreateTaskQueueInput
• type CreateTaskQueueResponse
• type PageMetaResponse
• type PageTaskQueueResponse
• type TaskQueuesPage
• type TaskQueuesPageOptions
• type TaskQueuesPageResponse
• type TaskQueuesPaginator
  • func (p *TaskQueuesPaginator) CurrentPage() *TaskQueuesPageResponse
  • func (p *TaskQueuesPaginator) Error() error
  • func (p *TaskQueuesPaginator) Next() bool
  • func (p *TaskQueuesPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

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

func New

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

New creates a new instance of the task queues client

func (Client) Create

func (c Client) Create(input *CreateTaskQueueInput) (*CreateTaskQueueResponse, error)

Create creates a new task queue See https://www.twilio.com/docs/taskrouter/api/task-queue#action-create 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 *CreateTaskQueueInput) (*CreateTaskQueueResponse, error)

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

func (*Client) NewTaskQueuesPaginator

func (c *Client) NewTaskQueuesPaginator() *TaskQueuesPaginator

NewTaskQueuesPaginator creates a new instance of the paginator for Page.

func (*Client) NewTaskQueuesPaginatorWithOptions

func (c *Client) NewTaskQueuesPaginatorWithOptions(options *TaskQueuesPageOptions) *TaskQueuesPaginator

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

func (Client) Page

func (c Client) Page(options *TaskQueuesPageOptions) (*TaskQueuesPageResponse, error)

Page retrieves a page of task queues See https://www.twilio.com/docs/taskrouter/api/task-queue#action-list 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 *TaskQueuesPageOptions) (*TaskQueuesPageResponse, error)

PageWithContext retrieves a page of task queues See https://www.twilio.com/docs/taskrouter/api/task-queue#action-list for more details

type ClientProperties

type ClientProperties struct {
	WorkspaceSid string
}

ClientProperties are the properties required to manage the task queues resources

type CreateTaskQueueInput

type CreateTaskQueueInput struct {
	AssignmentActivitySid  *string `form:"AssignmentActivitySid,omitempty"`
	FriendlyName           string  `validate:"required" form:"FriendlyName"`
	MaxReservedWorkers     *int    `form:"MaxReservedWorkers,omitempty"`
	ReservationActivitySid *string `form:"ReservationActivitySid,omitempty"`
	TargetWorkers          *string `form:"TargetWorkers,omitempty"`
	TaskOrder              *string `form:"TaskOrder,omitempty"`
}

CreateTaskQueueInput defines the input fields for creating a new task queue resource

type CreateTaskQueueResponse

type CreateTaskQueueResponse struct {
	AccountSid              string     `json:"account_sid"`
	AssignmentActivityName  *string    `json:"assignment_activity_name,omitempty"`
	AssignmentActivitySid   *string    `json:"assignment_activity_sid,omitempty"`
	DateCreated             time.Time  `json:"date_created"`
	DateUpdated             *time.Time `json:"date_updated,omitempty"`
	EventCallbackURL        *string    `json:"event_callback_url,omitempty"`
	FriendlyName            string     `json:"friendly_name"`
	MaxReservedWorkers      int        `json:"max_reserved_workers"`
	ReservationActivityName *string    `json:"reservation_activity_name,omitempty"`
	ReservationActivitySid  *string    `json:"reservation_activity_sid,omitempty"`
	Sid                     string     `json:"sid"`
	TargetWorkers           *string    `json:"target_workers,omitempty"`
	TaskOrder               string     `json:"task_order"`
	URL                     string     `json:"url"`
	WorkspaceSid            string     `json:"workspace_sid"`
}

CreateTaskQueueResponse defines the response fields for the created task queue

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 PageTaskQueueResponse

type PageTaskQueueResponse struct {
	AccountSid              string     `json:"account_sid"`
	AssignmentActivityName  *string    `json:"assignment_activity_name,omitempty"`
	AssignmentActivitySid   *string    `json:"assignment_activity_sid,omitempty"`
	DateCreated             time.Time  `json:"date_created"`
	DateUpdated             *time.Time `json:"date_updated,omitempty"`
	EventCallbackURL        *string    `json:"event_callback_url,omitempty"`
	FriendlyName            string     `json:"friendly_name"`
	MaxReservedWorkers      int        `json:"max_reserved_workers"`
	ReservationActivityName *string    `json:"reservation_activity_name,omitempty"`
	ReservationActivitySid  *string    `json:"reservation_activity_sid,omitempty"`
	Sid                     string     `json:"sid"`
	TargetWorkers           *string    `json:"target_workers,omitempty"`
	TaskOrder               string     `json:"task_order"`
	URL                     string     `json:"url"`
	WorkspaceSid            string     `json:"workspace_sid"`
}

type TaskQueuesPage

type TaskQueuesPage struct {
	CurrentPage *TaskQueuesPageResponse
	Error       error
	// contains filtered or unexported fields
}

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

type TaskQueuesPageOptions

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

TaskQueuesPageOptions defines the query options for the api operation

type TaskQueuesPageResponse

type TaskQueuesPageResponse struct {
	Meta       PageMetaResponse        `json:"meta"`
	TaskQueues []PageTaskQueueResponse `json:"task_queues"`
}

TaskQueuesPageResponse defines the response fields for the task queues page

type TaskQueuesPaginator

type TaskQueuesPaginator struct {
	Page       *TaskQueuesPage
	TaskQueues []PageTaskQueueResponse
	// contains filtered or unexported fields
}

TaskQueuesPaginator defines the fields for makings paginated api calls TaskQueues is an array of taskqueues that have been returned from all of the page calls

func (*TaskQueuesPaginator) CurrentPage

func (p *TaskQueuesPaginator) CurrentPage() *TaskQueuesPageResponse

CurrentPage retrieves the results for the current page

func (*TaskQueuesPaginator) Error

func (p *TaskQueuesPaginator) Error() error

Error retrieves the error returned from the page

func (*TaskQueuesPaginator) Next

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

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