callqueueconnect

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// CallQueueDequeuePreviewRecordOrCallProcedure is the fully-qualified name of the CallQueue's
	// DequeuePreviewRecordOrCall RPC.
	CallQueueDequeuePreviewRecordOrCallProcedure = "/api.v1alpha1.callqueue.CallQueue/DequeuePreviewRecordOrCall"
	// CallQueueEnqueuePreviewRecordProcedure is the fully-qualified name of the CallQueue's
	// EnqueuePreviewRecord RPC.
	CallQueueEnqueuePreviewRecordProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueuePreviewRecord"
	// CallQueueDequeueScrubbedCallForPreviewRecordProcedure is the fully-qualified name of the
	// CallQueue's DequeueScrubbedCallForPreviewRecord RPC.
	CallQueueDequeueScrubbedCallForPreviewRecordProcedure = "/api.v1alpha1.callqueue.CallQueue/DequeueScrubbedCallForPreviewRecord"
	// CallQueueClearPreviewRecordReturnQueueProcedure is the fully-qualified name of the CallQueue's
	// ClearPreviewRecordReturnQueue RPC.
	CallQueueClearPreviewRecordReturnQueueProcedure = "/api.v1alpha1.callqueue.CallQueue/ClearPreviewRecordReturnQueue"
	// CallQueueEnqueuePreviewDialCallProcedure is the fully-qualified name of the CallQueue's
	// EnqueuePreviewDialCall RPC.
	CallQueueEnqueuePreviewDialCallProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueuePreviewDialCall"
	// CallQueueClearManualDialQueueProcedure is the fully-qualified name of the CallQueue's
	// ClearManualDialQueue RPC.
	CallQueueClearManualDialQueueProcedure = "/api.v1alpha1.callqueue.CallQueue/ClearManualDialQueue"
	// CallQueueProcessManualDialCallProcedure is the fully-qualified name of the CallQueue's
	// ProcessManualDialCall RPC.
	CallQueueProcessManualDialCallProcedure = "/api.v1alpha1.callqueue.CallQueue/ProcessManualDialCall"
	// CallQueueDequeueCallForManualApprovalProcedure is the fully-qualified name of the CallQueue's
	// DequeueCallForManualApproval RPC.
	CallQueueDequeueCallForManualApprovalProcedure = "/api.v1alpha1.callqueue.CallQueue/DequeueCallForManualApproval"
	// CallQueueEnqueueManuallyApprovedCallProcedure is the fully-qualified name of the CallQueue's
	// EnqueueManuallyApprovedCall RPC.
	CallQueueEnqueueManuallyApprovedCallProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueueManuallyApprovedCall"
	// CallQueueEnqueueManuallyRejectedCallProcedure is the fully-qualified name of the CallQueue's
	// EnqueueManuallyRejectedCall RPC.
	CallQueueEnqueueManuallyRejectedCallProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueueManuallyRejectedCall"
	// CallQueueRequeueManuallyApprovedCallProcedure is the fully-qualified name of the CallQueue's
	// RequeueManuallyApprovedCall RPC.
	CallQueueRequeueManuallyApprovedCallProcedure = "/api.v1alpha1.callqueue.CallQueue/RequeueManuallyApprovedCall"
	// CallQueueEnqueueManuallyApprovedSmsProcedure is the fully-qualified name of the CallQueue's
	// EnqueueManuallyApprovedSms RPC.
	CallQueueEnqueueManuallyApprovedSmsProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueueManuallyApprovedSms"
	// CallQueueEnqueueManuallyRejectedSmsProcedure is the fully-qualified name of the CallQueue's
	// EnqueueManuallyRejectedSms RPC.
	CallQueueEnqueueManuallyRejectedSmsProcedure = "/api.v1alpha1.callqueue.CallQueue/EnqueueManuallyRejectedSms"
	// CallQueueRequeueManuallyApprovedSmsProcedure is the fully-qualified name of the CallQueue's
	// RequeueManuallyApprovedSms RPC.
	CallQueueRequeueManuallyApprovedSmsProcedure = "/api.v1alpha1.callqueue.CallQueue/RequeueManuallyApprovedSms"
	// CallQueueDequeueSmsMamForManualApprovalProcedure is the fully-qualified name of the CallQueue's
	// DequeueSmsMamForManualApproval RPC.
	CallQueueDequeueSmsMamForManualApprovalProcedure = "/api.v1alpha1.callqueue.CallQueue/DequeueSmsMamForManualApproval"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// CallQueueName is the fully-qualified name of the CallQueue service.
	CallQueueName = "api.v1alpha1.callqueue.CallQueue"
)

Variables

This section is empty.

Functions

func NewCallQueueHandler

func NewCallQueueHandler(svc CallQueueHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewCallQueueHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type CallQueueClient

type CallQueueClient interface {
	// Returns either a preview record or preview call from one of multiple queues,
	// it also returns a field for the queue name so record/call can be enqueued back to the same queue.
	// It checks for a record first, if no record is dequeued, then the preview call queues will be checked.
	DequeuePreviewRecordOrCall(context.Context, *connect_go.Request[callqueue.DequeuePreviewRecordOrCallReq]) (*connect_go.Response[callqueue.DequeuePreviewRecordOrCallRes], error)
	// Enqueues the given preview record into the specified queue.
	EnqueuePreviewRecord(context.Context, *connect_go.Request[callqueue.EnqueuePreviewRecordReq]) (*connect_go.Response[callqueue.EnqueuePreviewRecordRes], error)
	// Returns the scrubbed simple call data for the given preview record.
	DequeueScrubbedCallForPreviewRecord(context.Context, *connect_go.Request[callqueue.DequeueScrubbedCallForPreviewRecordReq]) (*connect_go.Response[callqueue.DequeueScrubbedCallForPreviewRecordRes], error)
	// Clears the preview record return queue for the requesting agent.
	ClearPreviewRecordReturnQueue(context.Context, *connect_go.Request[callqueue.ClearPreviewRecordReturnQueueReq]) (*connect_go.Response[callqueue.ClearPreviewRecordReturnQueueRes], error)
	// Enqueues the given preview dial call into the specified queue.
	EnqueuePreviewDialCall(context.Context, *connect_go.Request[callqueue.EnqueuePreviewDialCallReq]) (*connect_go.Response[callqueue.EnqueuePreviewDialCallRes], error)
	// Clears the manual dial return queue of the requesting agent.
	ClearManualDialQueue(context.Context, *connect_go.Request[callqueue.ClearManualDialQueueReq]) (*connect_go.Response[callqueue.ClearManualDialQueueRes], error)
	// Enqueues the call to the manual dial receive queue for scrubbing.
	// The call will then be added to the manual dial return queue of the requesting agent.
	// The scrubbed call is then dequeued from that agent's manual dial return queue and returned.
	ProcessManualDialCall(context.Context, *connect_go.Request[callqueue.ProcessManualDialCallReq]) (*connect_go.Response[callqueue.ProcessManualDialCallRes], error)
	// Dequeues a call for manual approval from the requesting agent's hunt group queues or a client queue,
	// it also returns a field for the queue name so call can be enqueued back to the same queue.
	DequeueCallForManualApproval(context.Context, *connect_go.Request[callqueue.DequeueCallForManualApprovalReq]) (*connect_go.Response[callqueue.DequeueCallForManualApprovalRes], error)
	// Enqueues a call in the MAC approval queue.
	EnqueueManuallyApprovedCall(context.Context, *connect_go.Request[callqueue.EnqueueManuallyApprovedCallReq]) (*connect_go.Response[callqueue.EnqueueManuallyApprovedCallRes], error)
	// Enqueues a call in the MAC rejection queue.
	EnqueueManuallyRejectedCall(context.Context, *connect_go.Request[callqueue.EnqueueManuallyRejectedCallReq]) (*connect_go.Response[callqueue.EnqueueManuallyRejectedCallRes], error)
	// Requeues a call requiring manual approval to the specified queue.
	RequeueManuallyApprovedCall(context.Context, *connect_go.Request[callqueue.RequeueManuallyApprovedCallReq]) (*connect_go.Response[callqueue.RequeueManuallyApprovedCallRes], error)
	// Enqueues sms msg in the MAM approval queue.
	EnqueueManuallyApprovedSms(context.Context, *connect_go.Request[callqueue.EnqueueManuallyApprovedSmsReq]) (*connect_go.Response[callqueue.EnqueueManuallyApprovedSmsRes], error)
	// Enqueues sms msg in the MAM rejection queue.
	EnqueueManuallyRejectedSms(context.Context, *connect_go.Request[callqueue.EnqueueManuallyRejectedSmsReq]) (*connect_go.Response[callqueue.EnqueueManuallyRejectedSmsRes], error)
	// Requeues sms msg requiring manual approval to the specified queue.
	RequeueManuallyApprovedSms(context.Context, *connect_go.Request[callqueue.RequeueManuallyApprovedSmsReq]) (*connect_go.Response[callqueue.RequeueManuallyApprovedSmsRes], error)
	// Dequeues a sms mam msg for manual approval from the requesting agent's hunt group queues or a client queue,
	// it also returns a field for the queue name so sms mam msg can be enqueued back to the same queue.
	DequeueSmsMamForManualApproval(context.Context, *connect_go.Request[callqueue.DequeueSmsMamForManualApprovalReq]) (*connect_go.Response[callqueue.DequeueSmsMamForManualApprovalRes], error)
}

CallQueueClient is a client for the api.v1alpha1.callqueue.CallQueue service.

func NewCallQueueClient

func NewCallQueueClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) CallQueueClient

NewCallQueueClient constructs a client for the api.v1alpha1.callqueue.CallQueue service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type CallQueueHandler

type CallQueueHandler interface {
	// Returns either a preview record or preview call from one of multiple queues,
	// it also returns a field for the queue name so record/call can be enqueued back to the same queue.
	// It checks for a record first, if no record is dequeued, then the preview call queues will be checked.
	DequeuePreviewRecordOrCall(context.Context, *connect_go.Request[callqueue.DequeuePreviewRecordOrCallReq]) (*connect_go.Response[callqueue.DequeuePreviewRecordOrCallRes], error)
	// Enqueues the given preview record into the specified queue.
	EnqueuePreviewRecord(context.Context, *connect_go.Request[callqueue.EnqueuePreviewRecordReq]) (*connect_go.Response[callqueue.EnqueuePreviewRecordRes], error)
	// Returns the scrubbed simple call data for the given preview record.
	DequeueScrubbedCallForPreviewRecord(context.Context, *connect_go.Request[callqueue.DequeueScrubbedCallForPreviewRecordReq]) (*connect_go.Response[callqueue.DequeueScrubbedCallForPreviewRecordRes], error)
	// Clears the preview record return queue for the requesting agent.
	ClearPreviewRecordReturnQueue(context.Context, *connect_go.Request[callqueue.ClearPreviewRecordReturnQueueReq]) (*connect_go.Response[callqueue.ClearPreviewRecordReturnQueueRes], error)
	// Enqueues the given preview dial call into the specified queue.
	EnqueuePreviewDialCall(context.Context, *connect_go.Request[callqueue.EnqueuePreviewDialCallReq]) (*connect_go.Response[callqueue.EnqueuePreviewDialCallRes], error)
	// Clears the manual dial return queue of the requesting agent.
	ClearManualDialQueue(context.Context, *connect_go.Request[callqueue.ClearManualDialQueueReq]) (*connect_go.Response[callqueue.ClearManualDialQueueRes], error)
	// Enqueues the call to the manual dial receive queue for scrubbing.
	// The call will then be added to the manual dial return queue of the requesting agent.
	// The scrubbed call is then dequeued from that agent's manual dial return queue and returned.
	ProcessManualDialCall(context.Context, *connect_go.Request[callqueue.ProcessManualDialCallReq]) (*connect_go.Response[callqueue.ProcessManualDialCallRes], error)
	// Dequeues a call for manual approval from the requesting agent's hunt group queues or a client queue,
	// it also returns a field for the queue name so call can be enqueued back to the same queue.
	DequeueCallForManualApproval(context.Context, *connect_go.Request[callqueue.DequeueCallForManualApprovalReq]) (*connect_go.Response[callqueue.DequeueCallForManualApprovalRes], error)
	// Enqueues a call in the MAC approval queue.
	EnqueueManuallyApprovedCall(context.Context, *connect_go.Request[callqueue.EnqueueManuallyApprovedCallReq]) (*connect_go.Response[callqueue.EnqueueManuallyApprovedCallRes], error)
	// Enqueues a call in the MAC rejection queue.
	EnqueueManuallyRejectedCall(context.Context, *connect_go.Request[callqueue.EnqueueManuallyRejectedCallReq]) (*connect_go.Response[callqueue.EnqueueManuallyRejectedCallRes], error)
	// Requeues a call requiring manual approval to the specified queue.
	RequeueManuallyApprovedCall(context.Context, *connect_go.Request[callqueue.RequeueManuallyApprovedCallReq]) (*connect_go.Response[callqueue.RequeueManuallyApprovedCallRes], error)
	// Enqueues sms msg in the MAM approval queue.
	EnqueueManuallyApprovedSms(context.Context, *connect_go.Request[callqueue.EnqueueManuallyApprovedSmsReq]) (*connect_go.Response[callqueue.EnqueueManuallyApprovedSmsRes], error)
	// Enqueues sms msg in the MAM rejection queue.
	EnqueueManuallyRejectedSms(context.Context, *connect_go.Request[callqueue.EnqueueManuallyRejectedSmsReq]) (*connect_go.Response[callqueue.EnqueueManuallyRejectedSmsRes], error)
	// Requeues sms msg requiring manual approval to the specified queue.
	RequeueManuallyApprovedSms(context.Context, *connect_go.Request[callqueue.RequeueManuallyApprovedSmsReq]) (*connect_go.Response[callqueue.RequeueManuallyApprovedSmsRes], error)
	// Dequeues a sms mam msg for manual approval from the requesting agent's hunt group queues or a client queue,
	// it also returns a field for the queue name so sms mam msg can be enqueued back to the same queue.
	DequeueSmsMamForManualApproval(context.Context, *connect_go.Request[callqueue.DequeueSmsMamForManualApprovalReq]) (*connect_go.Response[callqueue.DequeueSmsMamForManualApprovalRes], error)
}

CallQueueHandler is an implementation of the api.v1alpha1.callqueue.CallQueue service.

type UnimplementedCallQueueHandler

type UnimplementedCallQueueHandler struct{}

UnimplementedCallQueueHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL