reservation

Documentation

Overview

Package reservation contains auto-generated files. DO NOT MODIFY

Package reservation contains auto-generated files. DO NOT MODIFY

Package reservation contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchReservationResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchReservationResponse, error)
  • func (c Client) Update(input *UpdateReservationInput) (*UpdateReservationResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateReservationInput) (*UpdateReservationResponse, error)
• type ClientProperties
• type FetchReservationResponse
• type UpdateReservationInput
• type UpdateReservationResponse

Types

type Client

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

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

func New

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

New creates a new instance of the reservation client

func (Client) Fetch

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

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

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

func (Client) Update

func (c Client) Update(input *UpdateReservationInput) (*UpdateReservationResponse, error)

Update modifies a worker reservation resource See https://www.twilio.com/docs/taskrouter/api/worker-reservation#update-a-workerreservation-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 *UpdateReservationInput) (*UpdateReservationResponse, error)

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

type ClientProperties

type ClientProperties struct {
	Sid          string
	WorkerSid    string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the reservation resources

type FetchReservationResponse

type FetchReservationResponse struct {
	AccountSid        string     `json:"account_sid"`
	DateCreated       time.Time  `json:"date_created"`
	DateUpdated       *time.Time `json:"date_updated,omitempty"`
	ReservationStatus string     `json:"reservation_status"`
	Sid               string     `json:"sid"`
	TaskSid           string     `json:"task_sid"`
	URL               string     `json:"url"`
	WorkerName        string     `json:"worker_name"`
	WorkerSid         string     `json:"worker_sid"`
	WorkspaceSid      string     `json:"workspace_sid"`
}

FetchReservationResponse defines the response fields for the retrieved worker reservation

type UpdateReservationInput

type UpdateReservationInput struct {
	Beep                                    *string   `form:"Beep,omitempty"`
	BeepOnCustomerEntrance                  *bool     `form:"BeepOnCustomerEntrance,omitempty"`
	CallAccept                              *bool     `form:"CallAccept,omitempty"`
	CallFrom                                *string   `form:"CallFrom,omitempty"`
	CallRecord                              *string   `form:"CallRecord,omitempty"`
	CallStatusCallbackURL                   *string   `form:"CallStatusCallbackUrl,omitempty"`
	CallTimeout                             *int      `form:"CallTimeout,omitempty"`
	CallTo                                  *string   `form:"CallTo,omitempty"`
	CallURL                                 *string   `form:"CallUrl,omitempty"`
	ConferenceRecord                        *string   `form:"ConferenceRecord,omitempty"`
	ConferenceRecordingStatusCallback       *string   `form:"ConferenceRecordingStatusCallback,omitempty"`
	ConferenceRecordingStatusCallbackMethod *string   `form:"ConferenceRecordingStatusCallbackMethod,omitempty"`
	ConferenceStatusCallback                *string   `form:"ConferenceStatusCallback,omitempty"`
	ConferenceStatusCallbackEvents          *[]string `form:"ConferenceStatusCallbackEvent,omitempty"`
	ConferenceStatusCallbackMethod          *string   `form:"ConferenceStatusCallbackMethod,omitempty"`
	ConferenceTrim                          *string   `form:"ConferenceTrim,omitempty"`
	DequeueFrom                             *string   `form:"DequeueFrom,omitempty"`
	DequeuePostWorkActivitySid              *string   `form:"DequeuePostWorkActivitySid,omitempty"`
	DequeueRecord                           *string   `form:"DequeueRecord,omitempty"`
	DequeueStatusCallbackEvents             *[]string `form:"DequeueStatusCallbackEvent,omitempty"`
	DequeueStatusCallbackURL                *string   `form:"DequeueStatusCallbackUrl,omitempty"`
	DequeueTimeout                          *int      `form:"DequeueTimeout,omitempty"`
	DequeueTo                               *string   `form:"DequeueTo,omitempty"`
	EarlyMedia                              *bool     `form:"EarlyMedia,omitempty"`
	EndConferenceOnCustomerExit             *bool     `form:"EndConferenceOnCustomerExit,omitempty"`
	EndConferenceOnExit                     *bool     `form:"EndConferenceOnExit,omitempty"`
	From                                    *string   `form:"From,omitempty"`
	Instruction                             *string   `form:"Instruction,omitempty"`
	MaxParticipants                         *int      `form:"MaxParticipants,omitempty"`
	Muted                                   *bool     `form:"Muted,omitempty"`
	PostWorkActivitySid                     *string   `form:"PostWorkActivitySid,omitempty"`
	Record                                  *bool     `form:"Record,omitempty"`
	RecordingChannels                       *string   `form:"RecordingChannels,omitempty"`
	RecordingStatusCallback                 *string   `form:"RecordingStatusCallback,omitempty"`
	RecordingStatusCallbackMethod           *string   `form:"RecordingStatusCallbackMethod,omitempty"`
	RedirectAccept                          *string   `form:"RedirectAccept,omitempty"`
	RedirectCallSid                         *string   `form:"RedirectCallSid,omitempty"`
	RedirectURL                             *string   `form:"RedirectUrl,omitempty"`
	Region                                  *string   `form:"Region,omitempty"`
	ReservationStatus                       string    `validate:"required" form:"ReservationStatus"`
	SipAuthPassword                         *string   `form:"SipAuthPassword,omitempty"`
	SipAuthUsername                         *string   `form:"SipAuthUsername,omitempty"`
	StartConferenceOnEnter                  *bool     `form:"StartConferenceOnEnter,omitempty"`
	StatusCallback                          *string   `form:"StatusCallback,omitempty"`
	StatusCallbackEvents                    *[]string `form:"StatusCallbackEvent,omitempty"`
	StatusCallbackMethod                    *string   `form:"StatusCallbackMethod,omitempty"`
	Timeout                                 *int      `form:"Timeout,omitempty"`
	To                                      *string   `form:"To,omitempty"`
	WaitMethod                              *string   `form:"WaitMethod,omitempty"`
	WaitURL                                 *string   `form:"WaitUrl,omitempty"`
	WorkerActivitySid                       *string   `form:"WorkerActivitySid,omitempty"`
}

UpdateReservationInput defines input fields for updating a worker reservation resource

type UpdateReservationResponse

type UpdateReservationResponse struct {
	AccountSid        string     `json:"account_sid"`
	DateCreated       time.Time  `json:"date_created"`
	DateUpdated       *time.Time `json:"date_updated,omitempty"`
	ReservationStatus string     `json:"reservation_status"`
	Sid               string     `json:"sid"`
	TaskSid           string     `json:"task_sid"`
	URL               string     `json:"url"`
	WorkerName        string     `json:"worker_name"`
	WorkerSid         string     `json:"worker_sid"`
	WorkspaceSid      string     `json:"workspace_sid"`
}

UpdateReservationResponse defines the response fields for the updated worker reservation