task_queue

Documentation

Overview

Package task_queue contains auto-generated files. DO NOT MODIFY

Package task_queue contains auto-generated files. DO NOT MODIFY

Package task_queue contains auto-generated files. DO NOT MODIFY

Package task_queue contains auto-generated files. 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() (*FetchTaskQueueResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchTaskQueueResponse, error)
  • func (c Client) Update(input *UpdateTaskQueueInput) (*UpdateTaskQueueResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateTaskQueueInput) (*UpdateTaskQueueResponse, error)
• type ClientProperties
• type FetchTaskQueueResponse
• type UpdateTaskQueueInput
• type UpdateTaskQueueResponse

Types

type Client

type Client struct {
	CumulativeStatistics func() *cumulative_statistics.Client
	RealTimeStatistics   func() *real_time_statistics.Client
	Statistics           func() *statistics.Client
	// contains filtered or unexported fields
}

Client for managing a specific task queue resource 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 queue client

func (Client) Delete

func (c Client) Delete() error

Delete removes a task queue resource from the account See https://www.twilio.com/docs/taskrouter/api/task-queue#action-delete for more details 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 task queue resource from the account See https://www.twilio.com/docs/taskrouter/api/task-queue#action-delete for more details

func (Client) Fetch

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

Fetch retrieves a task queue resource See https://www.twilio.com/docs/taskrouter/api/task-queue#action-get for more details 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) (*FetchTaskQueueResponse, error)

FetchWithContext retrieves a task queue resource See https://www.twilio.com/docs/taskrouter/api/task-queue#action-get for more details

func (Client) Update

func (c Client) Update(input *UpdateTaskQueueInput) (*UpdateTaskQueueResponse, error)

Update modifies a task queue resource See https://www.twilio.com/docs/taskrouter/api/task-queue#action-update for more details 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 *UpdateTaskQueueInput) (*UpdateTaskQueueResponse, error)

UpdateWithContext modifies a task queue resource See https://www.twilio.com/docs/taskrouter/api/task-queue#action-update for more details

type ClientProperties

type ClientProperties struct {
	Sid          string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the task queue resources

type FetchTaskQueueResponse

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

FetchTaskQueueResponse defines the response fields for the retrieved task queue

type UpdateTaskQueueInput

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

UpdateTaskQueueInput defines input fields for updating a task queue resource

type UpdateTaskQueueResponse

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

UpdateTaskQueueResponse defines the response fields for the updated task queue