cumulative_statistics

Documentation

Overview

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) Fetch(options *FetchCumulativeStatisticsOptions) (*FetchCumulativeStatisticsResponse, error)
  • func (c Client) FetchWithContext(context context.Context, options *FetchCumulativeStatisticsOptions) (*FetchCumulativeStatisticsResponse, error)
• type ClientProperties
• type FetchCumulativeStatisticsOptions
• type FetchCumulativeStatisticsResponse
• type FetchStatisticsBreakdown
• type FetchWaitTime
• type FetchWaitTimeTasks

Types

type Client

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

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

func New

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

New creates a new instance of the cumulative statistics client

func (Client) Fetch

func (c Client) Fetch(options *FetchCumulativeStatisticsOptions) (*FetchCumulativeStatisticsResponse, error)

Fetch retrieves cumulative statistics See https://www.twilio.com/docs/taskrouter/api/taskqueue-statistics#taskqueue-cumulative-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 *FetchCumulativeStatisticsOptions) (*FetchCumulativeStatisticsResponse, error)

FetchWithContext retrieves cumulative statistics See https://www.twilio.com/docs/taskrouter/api/taskqueue-statistics#taskqueue-cumulative-statistics for more details

type ClientProperties

type ClientProperties struct {
	TaskQueueSid string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the cumulative statistics resources

type FetchCumulativeStatisticsOptions

type FetchCumulativeStatisticsOptions struct {
	Minutes         *int
	StartDate       *time.Time
	EndDate         *time.Time
	TaskChannel     *string
	SplitByWaitTime *string
}

FetchCumulativeStatisticsOptions defines the query options for the api operation

type FetchCumulativeStatisticsResponse

type FetchCumulativeStatisticsResponse struct {
	AccountSid                       string                    `json:"account_sid"`
	AvgTaskAcceptanceTime            int                       `json:"avg_task_acceptance_time"`
	EndTime                          time.Time                 `json:"end_time"`
	ReservationsAccepted             int                       `json:"reservations_accepted"`
	ReservationsCanceled             int                       `json:"reservations_canceled"`
	ReservationsCreated              int                       `json:"reservations_created"`
	ReservationsRejected             int                       `json:"reservations_rejected"`
	ReservationsRescinded            int                       `json:"reservations_rescinded"`
	ReservationsTimedOut             int                       `json:"reservations_timed_out"`
	SplitByWaitTime                  *map[string]FetchWaitTime `json:"split_by_wait_time,omitempty"`
	StartTime                        time.Time                 `json:"start_time"`
	TaskQueueSid                     string                    `json:"task_queue_sid"`
	TasksCanceled                    int                       `json:"tasks_canceled"`
	TasksCompleted                   int                       `json:"tasks_completed"`
	TasksDeleted                     int                       `json:"tasks_deleted"`
	TasksEntered                     int                       `json:"tasks_entered"`
	TasksMoved                       int                       `json:"tasks_moved"`
	URL                              string                    `json:"url"`
	WaitDurationInQueueUntilAccepted FetchStatisticsBreakdown  `json:"wait_duration_in_queue_until_accepted"`
	WaitDurationUntilAccepted        FetchStatisticsBreakdown  `json:"wait_duration_until_accepted"`
	WaitDurationUntilCanceled        FetchStatisticsBreakdown  `json:"wait_duration_until_canceled"`
	WorkspaceSid                     string                    `json:"workspace_sid"`
}

FetchCumulativeStatisticsResponse defines the response fields for the retrieved cumulative statistics

type FetchStatisticsBreakdown

type FetchStatisticsBreakdown struct {
	Avg   int `json:"avg"`
	Max   int `json:"max"`
	Min   int `json:"min"`
	Total int `json:"total"`
}

type FetchWaitTime

type FetchWaitTime struct {
	Above FetchWaitTimeTasks `json:"above"`
	Below FetchWaitTimeTasks `json:"below"`
}

type FetchWaitTimeTasks

type FetchWaitTimeTasks struct {
	ReservationsAccepted int `json:"reservations_accepted"`
	TasksCanceled        int `json:"tasks_canceled"`
}