workspace

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. 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() (*FetchWorkspaceResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchWorkspaceResponse, error)
  • func (c Client) Update(input *UpdateWorkspaceInput) (*UpdateWorkspaceResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateWorkspaceInput) (*UpdateWorkspaceResponse, error)
• type ClientProperties
• type FetchWorkspaceResponse
• type UpdateWorkspaceInput
• type UpdateWorkspaceResponse

Types

type Client

type Client struct {
	Activities           *activities.Client
	Activity             func(string) *activity.Client
	CumulativeStatistics func() *cumulative_statistics.Client
	RealTimeStatistics   func() *real_time_statistics.Client
	Statistics           func() *statistics.Client
	Task                 func(string) *task.Client
	TaskChannel          func(string) *task_channel.Client
	TaskChannels         *task_channels.Client
	TaskQueue            func(string) *task_queue.Client
	TaskQueues           *task_queues.Client
	Tasks                *tasks.Client
	Worker               func(string) *worker.Client
	Workers              *workers.Client
	Workflow             func(string) *workflow.Client
	Workflows            *workflows.Client
	// contains filtered or unexported fields
}

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

func New

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

New creates a new instance of the workspace client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateWorkspaceInput) (*UpdateWorkspaceResponse, error)

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

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

type ClientProperties

type ClientProperties struct {
	Sid string
}

ClientProperties are the properties required to manage the workspace resources

type FetchWorkspaceResponse

type FetchWorkspaceResponse struct {
	AccountSid           string     `json:"account_sid"`
	DateCreated          time.Time  `json:"date_created"`
	DateUpdated          *time.Time `json:"date_updated,omitempty"`
	DefaultActivityName  string     `json:"default_activity_name"`
	DefaultActivitySid   string     `json:"default_activity_sid"`
	EventCallbackURL     *string    `json:"event_callback_url,omitempty"`
	EventsFilter         *string    `json:"events_filter,omitempty"`
	FriendlyName         string     `json:"friendly_name"`
	MultiTaskEnabled     bool       `json:"multi_task_enabled"`
	PrioritizeQueueOrder string     `json:"prioritize_queue_order"`
	Sid                  string     `json:"sid"`
	TimeoutActivityName  string     `json:"timeout_activity_name"`
	TimeoutActivitySid   string     `json:"timeout_activity_sid"`
	URL                  string     `json:"url"`
}

FetchWorkspaceResponse defines the response fields for the retrieved workspace

type UpdateWorkspaceInput

type UpdateWorkspaceInput struct {
	EventCallbackURL     *string `form:"EventCallbackUrl,omitempty"`
	EventsFilter         *string `form:"EventsFilter,omitempty"`
	FriendlyName         *string `form:"FriendlyName,omitempty"`
	MultiTaskEnabled     *bool   `form:"MultiTaskEnabled,omitempty"`
	PrioritizeQueueOrder *string `form:"PrioritizeQueueOrder,omitempty"`
	Template             *string `form:"Template,omitempty"`
}

UpdateWorkspaceInput defines input fields for updating a workspace resource

type UpdateWorkspaceResponse

type UpdateWorkspaceResponse struct {
	AccountSid           string     `json:"account_sid"`
	DateCreated          time.Time  `json:"date_created"`
	DateUpdated          *time.Time `json:"date_updated,omitempty"`
	DefaultActivityName  string     `json:"default_activity_name"`
	DefaultActivitySid   string     `json:"default_activity_sid"`
	EventCallbackURL     *string    `json:"event_callback_url,omitempty"`
	EventsFilter         *string    `json:"events_filter,omitempty"`
	FriendlyName         string     `json:"friendly_name"`
	MultiTaskEnabled     bool       `json:"multi_task_enabled"`
	PrioritizeQueueOrder string     `json:"prioritize_queue_order"`
	Sid                  string     `json:"sid"`
	TimeoutActivityName  string     `json:"timeout_activity_name"`
	TimeoutActivitySid   string     `json:"timeout_activity_sid"`
	URL                  string     `json:"url"`
}

UpdateWorkspaceResponse defines the response fields for the updated workspace