queues

Documentation

Overview

Package queues contains auto-generated files. DO NOT MODIFY

Package queues contains auto-generated files. DO NOT MODIFY

Package queues contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Create(input *CreateQueueInput) (*CreateQueueResponse, error)
  • func (c Client) CreateWithContext(context context.Context, input *CreateQueueInput) (*CreateQueueResponse, error)
  • func (c *Client) NewQueuesPaginator() *QueuesPaginator
  • func (c *Client) NewQueuesPaginatorWithOptions(options *QueuesPageOptions) *QueuesPaginator
  • func (c Client) Page(options *QueuesPageOptions) (*QueuesPageResponse, error)
  • func (c Client) PageWithContext(context context.Context, options *QueuesPageOptions) (*QueuesPageResponse, error)
• type ClientProperties
• type CreateQueueInput
• type CreateQueueResponse
• type PageQueueResponse
• type QueuesPage
• type QueuesPageOptions
• type QueuesPageResponse
• type QueuesPaginator
  • func (p *QueuesPaginator) CurrentPage() *QueuesPageResponse
  • func (p *QueuesPaginator) Error() error
  • func (p *QueuesPaginator) Next() bool
  • func (p *QueuesPaginator) NextWithContext(context context.Context) bool

Types

type Client

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

Client for managing queue resources 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 queues client

func (Client) Create

func (c Client) Create(input *CreateQueueInput) (*CreateQueueResponse, error)

Create creates a new queue resource See https://www.twilio.com/docs/voice/api/queue-resource#create-a-queue-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) CreateWithContext

func (c Client) CreateWithContext(context context.Context, input *CreateQueueInput) (*CreateQueueResponse, error)

CreateWithContext creates a new queue resource See https://www.twilio.com/docs/voice/api/queue-resource#create-a-queue-resource for more details

func (*Client) NewQueuesPaginator

func (c *Client) NewQueuesPaginator() *QueuesPaginator

NewQueuesPaginator creates a new instance of the paginator for Page.

func (*Client) NewQueuesPaginatorWithOptions

func (c *Client) NewQueuesPaginatorWithOptions(options *QueuesPageOptions) *QueuesPaginator

NewQueuesPaginatorWithOptions creates a new instance of the paginator for Page with options.

func (Client) Page

func (c Client) Page(options *QueuesPageOptions) (*QueuesPageResponse, error)

Page retrieves a page of queues See https://www.twilio.com/docs/voice/api/queue-resource#read-multiple-queue-resources for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) PageWithContext

func (c Client) PageWithContext(context context.Context, options *QueuesPageOptions) (*QueuesPageResponse, error)

PageWithContext retrieves a page of queues See https://www.twilio.com/docs/voice/api/queue-resource#read-multiple-queue-resources for more details

type ClientProperties

type ClientProperties struct {
	AccountSid string
}

ClientProperties are the properties required to manage the queues resources

type CreateQueueInput

type CreateQueueInput struct {
	FriendlyName string `validate:"required" form:"FriendlyName"`
	MaxSize      *int   `form:"MaxSize,omitempty"`
}

CreateQueueInput defines input fields for creating a new queue

type CreateQueueResponse

type CreateQueueResponse 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"`
}

CreateQueueResponse defines the response fields for creating a new queue

type PageQueueResponse

type PageQueueResponse 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"`
}

type QueuesPage

type QueuesPage struct {
	CurrentPage *QueuesPageResponse
	Error       error
	// contains filtered or unexported fields
}

QueuesPage defines the fields for the page The CurrentPage and Error fields can be used to access the PageQueueResponse or error that is returned from the api call(s)

type QueuesPageOptions

type QueuesPageOptions struct {
	PageSize  *int
	Page      *int
	PageToken *string
}

QueuesPageOptions defines the query options for the api operation

type QueuesPageResponse

type QueuesPageResponse struct {
	End             int                 `json:"end"`
	FirstPageURI    string              `json:"first_page_uri"`
	NextPageURI     *string             `json:"next_page_uri,omitempty"`
	Page            int                 `json:"page"`
	PageSize        int                 `json:"page_size"`
	PreviousPageURI *string             `json:"previous_page_uri,omitempty"`
	Queues          []PageQueueResponse `json:"queues"`
	Start           int                 `json:"start"`
	URI             string              `json:"uri"`
}

QueuesPageResponse defines the response fields for the queues page

type QueuesPaginator

type QueuesPaginator struct {
	Page   *QueuesPage
	Queues []PageQueueResponse
	// contains filtered or unexported fields
}

QueuesPaginator defines the fields for makings paginated api calls Queues is an array of queues that have been returned from all of the page calls

func (*QueuesPaginator) CurrentPage

func (p *QueuesPaginator) CurrentPage() *QueuesPageResponse

CurrentPage retrieves the results for the current page

func (*QueuesPaginator) Error

func (p *QueuesPaginator) Error() error

Error retrieves the error returned from the page

func (*QueuesPaginator) Next

func (p *QueuesPaginator) Next() bool

Next retrieves the next page of results. Next will return false when either an error occurs or there are no more pages to iterate Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (*QueuesPaginator) NextWithContext

func (p *QueuesPaginator) NextWithContext(context context.Context) bool

NextWithContext retrieves the next page of results. NextWithContext will return false when either an error occurs or there are no more pages to iterate