worker

Documentation

Overview

Package worker contains auto-generated files. DO NOT MODIFY

Package worker contains auto-generated files. DO NOT MODIFY

Package worker contains auto-generated files. DO NOT MODIFY

Package worker 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() (*FetchWorkerResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchWorkerResponse, error)
  • func (c Client) Update(input *UpdateWorkerInput) (*UpdateWorkflowResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateWorkerInput) (*UpdateWorkflowResponse, error)
• type ClientProperties
• type FetchWorkerResponse
• type UpdateWorkerInput
• type UpdateWorkflowResponse

Types

type Client

type Client struct {
	Channel      func(string) *channel.Client
	Channels     *channels.Client
	Reservation  func(string) *reservation.Client
	Reservations *reservations.Client
	Statistics   func() *statistics.Client
	// contains filtered or unexported fields
}

Client for managing a specific worker resource See https://www.twilio.com/docs/taskrouter/api/worker for more details

func New

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

New creates a new instance of the worker client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

Fetch retrieves an worker resource See https://www.twilio.com/docs/taskrouter/api/worker#fetch-a-worker-resource 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) (*FetchWorkerResponse, error)

FetchWithContext retrieves an worker resource See https://www.twilio.com/docs/taskrouter/api/worker#fetch-a-worker-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateWorkerInput) (*UpdateWorkflowResponse, error)

Update modifies a worker resource See https://www.twilio.com/docs/taskrouter/api/worker#update-a-worker-resource 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 *UpdateWorkerInput) (*UpdateWorkflowResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Sid          string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the worker resources

type FetchWorkerResponse

type FetchWorkerResponse struct {
	AccountSid        string     `json:"account_sid"`
	ActivityName      string     `json:"activity_name"`
	ActivitySid       string     `json:"activity_sid"`
	Attributes        string     `json:"attributes"`
	Available         bool       `json:"available"`
	DateCreated       time.Time  `json:"date_created"`
	DateStatusChanged *time.Time `json:"date_status_changed,omitempty"`
	DateUpdated       *time.Time `json:"date_updated,omitempty"`
	FriendlyName      string     `json:"friendly_name"`
	Sid               string     `json:"sid"`
	URL               string     `json:"url"`
	WorkspaceSid      string     `json:"workspace_sid"`
}

FetchWorkerResponse defines the response fields for the retrieved worker

type UpdateWorkerInput

type UpdateWorkerInput struct {
	ActivitySid               *string `form:"ActivitySid,omitempty"`
	Attributes                *string `form:"Attributes,omitempty"`
	FriendlyName              *string `form:"FriendlyName,omitempty"`
	RejectPendingReservations *bool   `form:"RejectPendingReservations,omitempty"`
}

UpdateWorkerInput defines input fields for updating a worker resource

type UpdateWorkflowResponse

type UpdateWorkflowResponse struct {
	AccountSid        string     `json:"account_sid"`
	ActivityName      string     `json:"activity_name"`
	ActivitySid       string     `json:"activity_sid"`
	Attributes        string     `json:"attributes"`
	Available         bool       `json:"available"`
	DateCreated       time.Time  `json:"date_created"`
	DateStatusChanged *time.Time `json:"date_status_changed,omitempty"`
	DateUpdated       *time.Time `json:"date_updated,omitempty"`
	FriendlyName      string     `json:"friendly_name"`
	Sid               string     `json:"sid"`
	URL               string     `json:"url"`
	WorkspaceSid      string     `json:"workspace_sid"`
}

UpdateWorkflowResponse defines the response fields for the updated worker