queue

Documentation

Overview

Package queue contains auto-generated files. DO NOT MODIFY

Package queue contains auto-generated files. DO NOT MODIFY

Package queue contains auto-generated files. DO NOT MODIFY

Package 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() (*FetchQueueResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchQueueResponse, error)
  • func (c Client) Update(input *UpdateQueueInput) (*UpdateQueueResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateQueueInput) (*UpdateQueueResponse, error)
• type ClientProperties
• type FetchQueueResponse
• type UpdateQueueInput
• type UpdateQueueResponse

Types

type Client

type Client struct {
	Member  func(string) *member.Client
	Members *members.Client
	// contains filtered or unexported fields
}

Client for managing a specific queue resource See https://www.twilio.com/docs/voice/api/queue-resource for more details

func New

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

New creates a new instance of the queue client

func (Client) Delete

func (c Client) Delete() error

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

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateQueueInput) (*UpdateQueueResponse, error)

Update modifies a queue resource See https://www.twilio.com/docs/voice/api/queue-resource#update-a-queue-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 *UpdateQueueInput) (*UpdateQueueResponse, error)

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

type ClientProperties

type ClientProperties struct {
	AccountSid string
	Sid        string
}

ClientProperties are the properties required to manage the queue resources

type FetchQueueResponse

type FetchQueueResponse struct {
	AccountSid      string             `json:"account_sid"`
	AverageWaitTime int                `json:"average_wait_time"`
	CurrentSize     int                `json:"current_size"`
	DateCreated     utils.RFC2822Time  `json:"date_created"`
	DateUpdated     *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName    string             `json:"friendly_name"`
	MaxSize         int                `json:"max_size"`
	Sid             string             `json:"sid"`
}

FetchQueueResponse defines the response fields for retrieving a queue

type UpdateQueueInput

type UpdateQueueInput struct {
	FriendlyName *string `form:"FriendlyName,omitempty"`
	MaxSize      *int    `form:"MaxSize,omitempty"`
}

UpdateQueueInput defines input fields for updating a queue

type UpdateQueueResponse

type UpdateQueueResponse struct {
	AccountSid      string             `json:"account_sid"`
	AverageWaitTime int                `json:"average_wait_time"`
	CurrentSize     int                `json:"current_size"`
	DateCreated     utils.RFC2822Time  `json:"date_created"`
	DateUpdated     *utils.RFC2822Time `json:"date_updated,omitempty"`
	FriendlyName    string             `json:"friendly_name"`
	MaxSize         int                `json:"max_size"`
	Sid             string             `json:"sid"`
}

UpdateQueueResponse defines the response fields for the updated queue