real_time_statistics

Documentation

Overview

Package real_time_statistics contains auto-generated files. DO NOT MODIFY

Package real_time_statistics contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch(options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)
  • func (c Client) FetchWithContext(context context.Context, options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)
• type ClientProperties
• type FetchRealTimeStatisticsOptions
• type FetchRealTimeStatisticsResponse

Types

type Client

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

Client for managing workflow real time statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics for more details

func New

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

New creates a new instance of the real time statistics client

func (Client) Fetch

func (c Client) Fetch(options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)

Fetch retrieves real time statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics#workflow-realtime-statistics 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, options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)

FetchWithContext retrieves real time statistics See https://www.twilio.com/docs/taskrouter/api/workflow-statistics#workflow-realtime-statistics for more details

type ClientProperties

type ClientProperties struct {
	WorkflowSid  string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the real time statistics resources

type FetchRealTimeStatisticsOptions

type FetchRealTimeStatisticsOptions struct {
	TaskChannel *string
}

FetchRealTimeStatisticsOptions defines the query options for the api operation

type FetchRealTimeStatisticsResponse

type FetchRealTimeStatisticsResponse struct {
	AccountSid            string         `json:"account_sid"`
	LongestTaskWaitingAge int            `json:"longest_task_waiting_age"`
	LongestTaskWaitingSid *string        `json:"longest_task_waiting_sid,omitempty"`
	TasksByPriority       map[string]int `json:"tasks_by_priority"`
	TasksByStatus         map[string]int `json:"tasks_by_status"`
	TotalTasks            int            `json:"total_tasks"`
	URL                   string         `json:"url"`
	WorkflowSid           string         `json:"workflow_sid"`
	WorkspaceSid          string         `json:"workspace_sid"`
}

FetchRealTimeStatisticsResponse defines the response fields for the retrieved real time statistics