omniapiconnect

package
v1.5.1 Latest Latest
Warning

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

Go to latest
Published: May 10, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// OmniApiArchiveCampaignProcedure is the fully-qualified name of the OmniApi's ArchiveCampaign RPC.
	OmniApiArchiveCampaignProcedure = "/api.v1alpha1.omniapi.OmniApi/ArchiveCampaign"
	// OmniApiCreateCampaignProcedure is the fully-qualified name of the OmniApi's CreateCampaign RPC.
	OmniApiCreateCampaignProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateCampaign"
	// OmniApiGetCampaignByIdProcedure is the fully-qualified name of the OmniApi's GetCampaignById RPC.
	OmniApiGetCampaignByIdProcedure = "/api.v1alpha1.omniapi.OmniApi/GetCampaignById"
	// OmniApiPauseCampaignProcedure is the fully-qualified name of the OmniApi's PauseCampaign RPC.
	OmniApiPauseCampaignProcedure = "/api.v1alpha1.omniapi.OmniApi/PauseCampaign"
	// OmniApiResumeCampaignProcedure is the fully-qualified name of the OmniApi's ResumeCampaign RPC.
	OmniApiResumeCampaignProcedure = "/api.v1alpha1.omniapi.OmniApi/ResumeCampaign"
	// OmniApiUpdateCampaignProcedure is the fully-qualified name of the OmniApi's UpdateCampaign RPC.
	OmniApiUpdateCampaignProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateCampaign"
	// OmniApiUpdateCampaignPacingSpeedProcedure is the fully-qualified name of the OmniApi's
	// UpdateCampaignPacingSpeed RPC.
	OmniApiUpdateCampaignPacingSpeedProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateCampaignPacingSpeed"
	// OmniApiSendOmniMessageProcedure is the fully-qualified name of the OmniApi's SendOmniMessage RPC.
	OmniApiSendOmniMessageProcedure = "/api.v1alpha1.omniapi.OmniApi/SendOmniMessage"
	// OmniApiManagerSendOmniMessageProcedure is the fully-qualified name of the OmniApi's
	// ManagerSendOmniMessage RPC.
	OmniApiManagerSendOmniMessageProcedure = "/api.v1alpha1.omniapi.OmniApi/ManagerSendOmniMessage"
	// OmniApiCreateDispositionProcedure is the fully-qualified name of the OmniApi's CreateDisposition
	// RPC.
	OmniApiCreateDispositionProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateDisposition"
	// OmniApiDeleteDispositionProcedure is the fully-qualified name of the OmniApi's DeleteDisposition
	// RPC.
	OmniApiDeleteDispositionProcedure = "/api.v1alpha1.omniapi.OmniApi/DeleteDisposition"
	// OmniApiListDispositionsProcedure is the fully-qualified name of the OmniApi's ListDispositions
	// RPC.
	OmniApiListDispositionsProcedure = "/api.v1alpha1.omniapi.OmniApi/ListDispositions"
	// OmniApiUpdateDispositionProcedure is the fully-qualified name of the OmniApi's UpdateDisposition
	// RPC.
	OmniApiUpdateDispositionProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateDisposition"
	// OmniApiListCustomUnsubscribeLinksProcedure is the fully-qualified name of the OmniApi's
	// ListCustomUnsubscribeLinks RPC.
	OmniApiListCustomUnsubscribeLinksProcedure = "/api.v1alpha1.omniapi.OmniApi/ListCustomUnsubscribeLinks"
	// OmniApiCreateCustomUnsubscribeLinkProcedure is the fully-qualified name of the OmniApi's
	// CreateCustomUnsubscribeLink RPC.
	OmniApiCreateCustomUnsubscribeLinkProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateCustomUnsubscribeLink"
	// OmniApiUpdateCustomUnsubscribeLinkProcedure is the fully-qualified name of the OmniApi's
	// UpdateCustomUnsubscribeLink RPC.
	OmniApiUpdateCustomUnsubscribeLinkProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateCustomUnsubscribeLink"
	// OmniApiDeleteCustomUnsubscribeLinkProcedure is the fully-qualified name of the OmniApi's
	// DeleteCustomUnsubscribeLink RPC.
	OmniApiDeleteCustomUnsubscribeLinkProcedure = "/api.v1alpha1.omniapi.OmniApi/DeleteCustomUnsubscribeLink"
	// OmniApiListCampaignsProcedure is the fully-qualified name of the OmniApi's ListCampaigns RPC.
	OmniApiListCampaignsProcedure = "/api.v1alpha1.omniapi.OmniApi/ListCampaigns"
	// OmniApiManagerListMessagesProcedure is the fully-qualified name of the OmniApi's
	// ManagerListMessages RPC.
	OmniApiManagerListMessagesProcedure = "/api.v1alpha1.omniapi.OmniApi/ManagerListMessages"
	// OmniApiListMessagesProcedure is the fully-qualified name of the OmniApi's ListMessages RPC.
	OmniApiListMessagesProcedure = "/api.v1alpha1.omniapi.OmniApi/ListMessages"
	// OmniApiManagerListConversationsProcedure is the fully-qualified name of the OmniApi's
	// ManagerListConversations RPC.
	OmniApiManagerListConversationsProcedure = "/api.v1alpha1.omniapi.OmniApi/ManagerListConversations"
	// OmniApiListContactListsProcedure is the fully-qualified name of the OmniApi's ListContactLists
	// RPC.
	OmniApiListContactListsProcedure = "/api.v1alpha1.omniapi.OmniApi/ListContactLists"
	// OmniApiGetAvailableHeadersProcedure is the fully-qualified name of the OmniApi's
	// GetAvailableHeaders RPC.
	OmniApiGetAvailableHeadersProcedure = "/api.v1alpha1.omniapi.OmniApi/GetAvailableHeaders"
	// OmniApiGetTaskProcedure is the fully-qualified name of the OmniApi's GetTask RPC.
	OmniApiGetTaskProcedure = "/api.v1alpha1.omniapi.OmniApi/GetTask"
	// OmniApiListTasksProcedure is the fully-qualified name of the OmniApi's ListTasks RPC.
	OmniApiListTasksProcedure = "/api.v1alpha1.omniapi.OmniApi/ListTasks"
	// OmniApiCreateConnectedInboxProcedure is the fully-qualified name of the OmniApi's
	// CreateConnectedInbox RPC.
	OmniApiCreateConnectedInboxProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateConnectedInbox"
	// OmniApiDeleteConnectedInboxBySidProcedure is the fully-qualified name of the OmniApi's
	// DeleteConnectedInboxBySid RPC.
	OmniApiDeleteConnectedInboxBySidProcedure = "/api.v1alpha1.omniapi.OmniApi/DeleteConnectedInboxBySid"
	// OmniApiGetConnectedInboxBySidProcedure is the fully-qualified name of the OmniApi's
	// GetConnectedInboxBySid RPC.
	OmniApiGetConnectedInboxBySidProcedure = "/api.v1alpha1.omniapi.OmniApi/GetConnectedInboxBySid"
	// OmniApiPerformSendgridAccountChecksProcedure is the fully-qualified name of the OmniApi's
	// PerformSendgridAccountChecks RPC.
	OmniApiPerformSendgridAccountChecksProcedure = "/api.v1alpha1.omniapi.OmniApi/PerformSendgridAccountChecks"
	// OmniApiListConnectedInboxesProcedure is the fully-qualified name of the OmniApi's
	// ListConnectedInboxes RPC.
	OmniApiListConnectedInboxesProcedure = "/api.v1alpha1.omniapi.OmniApi/ListConnectedInboxes"
	// OmniApiTestConnectedInboxProcedure is the fully-qualified name of the OmniApi's
	// TestConnectedInbox RPC.
	OmniApiTestConnectedInboxProcedure = "/api.v1alpha1.omniapi.OmniApi/TestConnectedInbox"
	// OmniApiUpdateConnectedInboxProcedure is the fully-qualified name of the OmniApi's
	// UpdateConnectedInbox RPC.
	OmniApiUpdateConnectedInboxProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateConnectedInbox"
	// OmniApiCreateVerifiedEmailProcedure is the fully-qualified name of the OmniApi's
	// CreateVerifiedEmail RPC.
	OmniApiCreateVerifiedEmailProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateVerifiedEmail"
	// OmniApiDeleteVerifiedEmailProcedure is the fully-qualified name of the OmniApi's
	// DeleteVerifiedEmail RPC.
	OmniApiDeleteVerifiedEmailProcedure = "/api.v1alpha1.omniapi.OmniApi/DeleteVerifiedEmail"
	// OmniApiGetVerifiedEmailBySidProcedure is the fully-qualified name of the OmniApi's
	// GetVerifiedEmailBySid RPC.
	OmniApiGetVerifiedEmailBySidProcedure = "/api.v1alpha1.omniapi.OmniApi/GetVerifiedEmailBySid"
	// OmniApiListVerifiedEmailsProcedure is the fully-qualified name of the OmniApi's
	// ListVerifiedEmails RPC.
	OmniApiListVerifiedEmailsProcedure = "/api.v1alpha1.omniapi.OmniApi/ListVerifiedEmails"
	// OmniApiResendVerifiedEmailProcedure is the fully-qualified name of the OmniApi's
	// ResendVerifiedEmail RPC.
	OmniApiResendVerifiedEmailProcedure = "/api.v1alpha1.omniapi.OmniApi/ResendVerifiedEmail"
	// OmniApiUpdateVerifiedEmailProcedure is the fully-qualified name of the OmniApi's
	// UpdateVerifiedEmail RPC.
	OmniApiUpdateVerifiedEmailProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateVerifiedEmail"
	// OmniApiGetPendingGoogleXOAuth2DataProcedure is the fully-qualified name of the OmniApi's
	// GetPendingGoogleXOAuth2Data RPC.
	OmniApiGetPendingGoogleXOAuth2DataProcedure = "/api.v1alpha1.omniapi.OmniApi/GetPendingGoogleXOAuth2Data"
	// OmniApiSendEmailNotificationProcedure is the fully-qualified name of the OmniApi's
	// SendEmailNotification RPC.
	OmniApiSendEmailNotificationProcedure = "/api.v1alpha1.omniapi.OmniApi/SendEmailNotification"
	// OmniApiSendFeedbackEmailProcedure is the fully-qualified name of the OmniApi's SendFeedbackEmail
	// RPC.
	OmniApiSendFeedbackEmailProcedure = "/api.v1alpha1.omniapi.OmniApi/SendFeedbackEmail"
	// OmniApiGetOmniAttachmentProcedure is the fully-qualified name of the OmniApi's GetOmniAttachment
	// RPC.
	OmniApiGetOmniAttachmentProcedure = "/api.v1alpha1.omniapi.OmniApi/GetOmniAttachment"
	// OmniApiCreateTasksProcedure is the fully-qualified name of the OmniApi's CreateTasks RPC.
	OmniApiCreateTasksProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateTasks"
	// OmniApiCreateSignatureProcedure is the fully-qualified name of the OmniApi's CreateSignature RPC.
	OmniApiCreateSignatureProcedure = "/api.v1alpha1.omniapi.OmniApi/CreateSignature"
	// OmniApiDeleteSignatureProcedure is the fully-qualified name of the OmniApi's DeleteSignature RPC.
	OmniApiDeleteSignatureProcedure = "/api.v1alpha1.omniapi.OmniApi/DeleteSignature"
	// OmniApiListSignaturesProcedure is the fully-qualified name of the OmniApi's ListSignatures RPC.
	OmniApiListSignaturesProcedure = "/api.v1alpha1.omniapi.OmniApi/ListSignatures"
	// OmniApiUpdateSignatureProcedure is the fully-qualified name of the OmniApi's UpdateSignature RPC.
	OmniApiUpdateSignatureProcedure = "/api.v1alpha1.omniapi.OmniApi/UpdateSignature"
)

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 (
	// OmniApiName is the fully-qualified name of the OmniApi service.
	OmniApiName = "api.v1alpha1.omniapi.OmniApi"
)

Variables

This section is empty.

Functions

func NewOmniApiHandler

func NewOmniApiHandler(svc OmniApiHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewOmniApiHandler 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 OmniApiClient

type OmniApiClient interface {
	// archive a campaign
	ArchiveCampaign(context.Context, *connect_go.Request[omniapi.ArchiveCampaignReq]) (*connect_go.Response[omniapi.ArchiveCampaignRes], error)
	// Create Omni Campaign defined by CreateOmniCampaign message
	// for the name, skill, Hours of operations, and description.
	// the method will return newly created OmniCampaign for this client
	// Required Permission:
	//
	//	OMNI_BOSS
	CreateCampaign(context.Context, *connect_go.Request[omniapi.CreateCampaignReq]) (*connect_go.Response[commons.OmniCampaign], error)
	// Get campaign defined by GetChatCampaignById.
	GetCampaignById(context.Context, *connect_go.Request[omniapi.GetCampaignByIdReq]) (*connect_go.Response[commons.OmniCampaign], error)
	// pause a campaign
	PauseCampaign(context.Context, *connect_go.Request[omniapi.PauseCampaignReq]) (*connect_go.Response[omniapi.PauseCampaignRes], error)
	// resume a campaign
	ResumeCampaign(context.Context, *connect_go.Request[omniapi.ResumeCampaignReq]) (*connect_go.Response[omniapi.ResumeCampaignRes], error)
	// Updates a campaign
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateCampaign(context.Context, *connect_go.Request[omniapi.UpdateCampaignReq]) (*connect_go.Response[omniapi.UpdateCampaignRes], error)
	// update campaign pacing - speed up/slow down a campaign
	UpdateCampaignPacingSpeed(context.Context, *connect_go.Request[omniapi.UpdateCampaignPacingSpeedReq]) (*connect_go.Response[omniapi.UpdateCampaignPacingSpeedRes], error)
	// Send a chat message
	SendOmniMessage(context.Context, *connect_go.Request[omniapi.SendOmniMessageReq]) (*connect_go.Response[commons.Empty], error)
	// Send a chat message
	ManagerSendOmniMessage(context.Context, *connect_go.Request[omniapi.SendOmniMessageReq]) (*connect_go.Response[commons.Empty], error)
	// Create a disposition
	CreateDisposition(context.Context, *connect_go.Request[omniapi.CreateDispositionReq]) (*connect_go.Response[omniapi.CreateDispositionRes], error)
	// DeleteDisposition - delete an existing disposition
	DeleteDisposition(context.Context, *connect_go.Request[omniapi.DeleteDispositionReq]) (*connect_go.Response[commons.Empty], error)
	// ListDispositions - lists all dispositions
	ListDispositions(context.Context, *connect_go.Request[omniapi.ListDispositionsReq]) (*connect_go.Response[omniapi.ListDispositionsRes], error)
	// UpdateDisposition - update an existing disposition
	UpdateDisposition(context.Context, *connect_go.Request[omniapi.UpdateDispositionReq]) (*connect_go.Response[commons.Empty], error)
	// ListCustomUnsubscribeLinks - retrieves all the custom unsubscribe links
	ListCustomUnsubscribeLinks(context.Context, *connect_go.Request[commons.Empty]) (*connect_go.Response[omniapi.ListCustomUnsubscribeLinksRes], error)
	// CreateUnsubscribeLink - creates a new unsubscribe link
	CreateCustomUnsubscribeLink(context.Context, *connect_go.Request[commons.OmniCustomUnsubscribeLink]) (*connect_go.Response[omniapi.CreateCustomUnsubscribeLinkRes], error)
	// UpdateCustomUnsubscribeLink - update custom unsubscribe link details
	UpdateCustomUnsubscribeLink(context.Context, *connect_go.Request[omniapi.UpdateCustomUnsubscribeLinkReq]) (*connect_go.Response[omniapi.UpdateCustomUnsubscribeLinkRes], error)
	// DeleteCustomUnsubscribeLink - deletes custom unsubscribe link details
	DeleteCustomUnsubscribeLink(context.Context, *connect_go.Request[omniapi.DeleteCustomUnsubscribeLinkReq]) (*connect_go.Response[commons.Empty], error)
	// List campaigns defined by ListCampaignsReq.
	// The method will return a ListCampaignsReq entity that will contain
	// all the campaigns within the specified filter.
	ListCampaigns(context.Context, *connect_go.Request[omniapi.ListCampaignsReq]) (*connect_go.Response[omniapi.ListCampaignsRes], error)
	// Get a stream of new conversation message for a given conversation. Used
	// only for managers. It is not for customers.
	ManagerListMessages(context.Context, *connect_go.Request[omniapi.ManagerListMessagesReq]) (*connect_go.ServerStreamForClient[commons.OmniMessage], error)
	// Get a stream of conversation message for a given conversation. Used
	// only for agents/users. It is not for customers.
	ListMessages(context.Context, *connect_go.Request[omniapi.ListMessagesReq]) (*connect_go.ServerStreamForClient[commons.OmniMessage], error)
	// lists all conversation and assigned users for a given date range.
	// Required permissions:
	//
	//	OMNI_BOSS
	ManagerListConversations(context.Context, *connect_go.Request[omniapi.ListConversationsReq]) (*connect_go.Response[omniapi.ListConversationsRes], error)
	// ListContactLists - retrieves all the contact lists
	ListContactLists(context.Context, *connect_go.Request[omniapi.ListContactListsReq]) (*connect_go.Response[omniapi.ListContactListsRes], error)
	// GetAvailableHeaders - retrieves all the available headers that could be present on a contact list
	// Required permissions:
	//
	//	OMNI_BOSS
	GetAvailableHeaders(context.Context, *connect_go.Request[omniapi.GetAvailableHeadersReq]) (*connect_go.Response[omniapi.GetAvailableHeadersRes], error)
	// GetTask - retrieves a task using the provided criteria
	// Required permissions:
	//
	//	OMNI_AGENT
	GetTask(context.Context, *connect_go.Request[omniapi.GetTaskReq]) (*connect_go.Response[commons.OmniTask], error)
	// ListTasks - retrieves tasks using the provided criteria
	// Required permissions:
	//
	//	OMNI_BOSS
	ListTasks(context.Context, *connect_go.Request[omniapi.ListTasksReq]) (*connect_go.Response[omniapi.ListTasksRes], error)
	// CreateConnectedInbox - create a new connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	CreateConnectedInbox(context.Context, *connect_go.Request[commons.ConnectedInbox]) (*connect_go.Response[omniapi.CreateConnectedInboxRes], error)
	// DeleteConnectedInboxBySid - deletes a connected inbox given it's identifier
	// Required permissions:
	//
	//	OMNI_BOSS
	DeleteConnectedInboxBySid(context.Context, *connect_go.Request[omniapi.DeleteConnectedInboxBySidReq]) (*connect_go.Response[commons.Empty], error)
	// GetConnectedInboxBySid - retrieves a connected inbox given it's identifier
	// Required permissions:
	//
	//	OMNI_BOSS
	GetConnectedInboxBySid(context.Context, *connect_go.Request[omniapi.GetConnectedInboxBySidReq]) (*connect_go.Response[commons.ConnectedInbox], error)
	// Perform sendgrid account check to make sure all the account settings are valid defined by SendgridAccountByClientReq message.
	// The method will return a SendgridAccountByClientRes message/entity that will
	// contain the result true/false verifying account settings with sendgrid for this client
	// Required permissions:
	//
	//	OMNI_BOSS
	PerformSendgridAccountChecks(context.Context, *connect_go.Request[omniapi.SendgridAccountByClientReq]) (*connect_go.Response[omniapi.SendgridAccountByClientRes], error)
	// ListConnectedInboxes - retrieves all the connected inboxes for the organization
	// Required permissions:
	//
	//	OMNI_BOSS
	ListConnectedInboxes(context.Context, *connect_go.Request[omniapi.ListConnectedInboxesReq]) (*connect_go.Response[omniapi.ListConnectedInboxesRes], error)
	// TestConnectedInbox - check if connected inbox login works for a specified email_address,
	// username, password, server_name, and server_port (other fields from ConnectedInbox are ignored).
	// Required permissions:
	//
	//	OMNI_BOSS
	TestConnectedInbox(context.Context, *connect_go.Request[commons.ConnectedInbox]) (*connect_go.Response[omniapi.TestConnectedInboxRes], error)
	// UpdateConnectedInbox - update a connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateConnectedInbox(context.Context, *connect_go.Request[omniapi.UpdateConnectedInboxReq]) (*connect_go.Response[commons.Empty], error)
	// CreateVerifiedEmail.  this will create a new verified email
	// Required permissions
	//
	//	OMNI_BOSS
	CreateVerifiedEmail(context.Context, *connect_go.Request[commons.VerifiedEmail]) (*connect_go.Response[omniapi.CreateVerifiedEmailRes], error)
	// Delete verify email record based on verified email id defined by
	// DeleteVerifiedEmailReq for the specified client.
	// This method will return a DeleteVerifiedEmailRes message/entity.
	// DeleteVerifiedEmail - deletes a verified email record using the given identifier
	// Required permissions
	//
	//	OMNI_BOSS
	DeleteVerifiedEmail(context.Context, *connect_go.Request[omniapi.DeleteVerifiedEmailReq]) (*connect_go.Response[commons.Empty], error)
	// Get the verified email details based on verified email id defined by
	// GetVerifiedEmailByIdReq for the specified client.
	// This method will return an OmniVerifiedEmail message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	GetVerifiedEmailBySid(context.Context, *connect_go.Request[omniapi.GetVerifiedEmailBySidReq]) (*connect_go.Response[commons.VerifiedEmail], error)
	// List all the verified emails and their details defined by
	// ListVerifiedEmailsReq for the specified client.
	// This method will return a ListVerifiedEmailsRes message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	ListVerifiedEmails(context.Context, *connect_go.Request[omniapi.ListVerifiedEmailsReq]) (*connect_go.Response[omniapi.ListVerifiedEmailsRes], error)
	// Resend verify email record based on verified email id defined by
	// ResendVerifiedEmailReq for the specified client.
	// This method will return a ResendVerifiedEmailRes message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	ResendVerifiedEmail(context.Context, *connect_go.Request[omniapi.ResendVerifiedEmailReq]) (*connect_go.Response[omniapi.ResendVerifiedEmailRes], error)
	// Updates verified email description
	UpdateVerifiedEmail(context.Context, *connect_go.Request[omniapi.UpdateVerifiedEmailReq]) (*connect_go.Response[commons.Empty], error)
	// GetPendingGoogleXOAuth2Data - retrieves the pending oauth data required to finish creating a connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	GetPendingGoogleXOAuth2Data(context.Context, *connect_go.Request[omniapi.GetPendingGoogleXOAuth2DataReq]) (*connect_go.Response[omniapi.GetPendingGoogleXOAuth2DataRes], error)
	// Send email notification defined by SendEmailNotificationReq message for the specified
	// subject, message and array of to email addresses.
	// The method will return a stream of SendEmailNotificationRes messages
	// containing result true/false after notified by email for the client_sid.
	// Required permissions:
	//
	//	OMNI_BOSS
	SendEmailNotification(context.Context, *connect_go.Request[omniapi.SendEmailNotificationReq]) (*connect_go.Response[omniapi.SendEmailNotificationRes], error)
	// Send an email to our feedback system. The users email will be populated as the from address to open an email thread with our support.
	SendFeedbackEmail(context.Context, *connect_go.Request[omniapi.SendFeedbackEmailReq]) (*connect_go.Response[omniapi.SendFeedbackEmailRes], error)
	// GetOmniAttachment - retrieves the omni attachment details based on the request
	// Required permissions:
	//
	//	OMNI_BOSS
	GetOmniAttachment(context.Context, *connect_go.Request[omniapi.GetOmniAttachmentReq]) (*connect_go.Response[commons.OmniAttachment], error)
	// Create a task with a given contat list .
	CreateTasks(context.Context, *connect_go.Request[omniapi.CreateTasksReq]) (*connect_go.Response[omniapi.CreateTasksRes], error)
	// CreateSignature - creates a new message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	CreateSignature(context.Context, *connect_go.Request[omniapi.CreateSignatureReq]) (*connect_go.Response[omniapi.CreateSignatureRes], error)
	// DeleteSignature - deletes a message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	DeleteSignature(context.Context, *connect_go.Request[omniapi.DeleteSignatureReq]) (*connect_go.Response[omniapi.DeleteSignatureRes], error)
	// ListSignatures - retrieves the signatures created by the organization
	// Required permissions:
	//
	//	OMNI_BOSS
	ListSignatures(context.Context, *connect_go.Request[omniapi.ListSignaturesReq]) (*connect_go.Response[omniapi.ListSignaturesRes], error)
	// UpdateSignature - updates a message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateSignature(context.Context, *connect_go.Request[omniapi.UpdateSignatureReq]) (*connect_go.Response[omniapi.UpdateSignatureRes], error)
}

OmniApiClient is a client for the api.v1alpha1.omniapi.OmniApi service.

func NewOmniApiClient

func NewOmniApiClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) OmniApiClient

NewOmniApiClient constructs a client for the api.v1alpha1.omniapi.OmniApi 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 OmniApiHandler

type OmniApiHandler interface {
	// archive a campaign
	ArchiveCampaign(context.Context, *connect_go.Request[omniapi.ArchiveCampaignReq]) (*connect_go.Response[omniapi.ArchiveCampaignRes], error)
	// Create Omni Campaign defined by CreateOmniCampaign message
	// for the name, skill, Hours of operations, and description.
	// the method will return newly created OmniCampaign for this client
	// Required Permission:
	//
	//	OMNI_BOSS
	CreateCampaign(context.Context, *connect_go.Request[omniapi.CreateCampaignReq]) (*connect_go.Response[commons.OmniCampaign], error)
	// Get campaign defined by GetChatCampaignById.
	GetCampaignById(context.Context, *connect_go.Request[omniapi.GetCampaignByIdReq]) (*connect_go.Response[commons.OmniCampaign], error)
	// pause a campaign
	PauseCampaign(context.Context, *connect_go.Request[omniapi.PauseCampaignReq]) (*connect_go.Response[omniapi.PauseCampaignRes], error)
	// resume a campaign
	ResumeCampaign(context.Context, *connect_go.Request[omniapi.ResumeCampaignReq]) (*connect_go.Response[omniapi.ResumeCampaignRes], error)
	// Updates a campaign
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateCampaign(context.Context, *connect_go.Request[omniapi.UpdateCampaignReq]) (*connect_go.Response[omniapi.UpdateCampaignRes], error)
	// update campaign pacing - speed up/slow down a campaign
	UpdateCampaignPacingSpeed(context.Context, *connect_go.Request[omniapi.UpdateCampaignPacingSpeedReq]) (*connect_go.Response[omniapi.UpdateCampaignPacingSpeedRes], error)
	// Send a chat message
	SendOmniMessage(context.Context, *connect_go.Request[omniapi.SendOmniMessageReq]) (*connect_go.Response[commons.Empty], error)
	// Send a chat message
	ManagerSendOmniMessage(context.Context, *connect_go.Request[omniapi.SendOmniMessageReq]) (*connect_go.Response[commons.Empty], error)
	// Create a disposition
	CreateDisposition(context.Context, *connect_go.Request[omniapi.CreateDispositionReq]) (*connect_go.Response[omniapi.CreateDispositionRes], error)
	// DeleteDisposition - delete an existing disposition
	DeleteDisposition(context.Context, *connect_go.Request[omniapi.DeleteDispositionReq]) (*connect_go.Response[commons.Empty], error)
	// ListDispositions - lists all dispositions
	ListDispositions(context.Context, *connect_go.Request[omniapi.ListDispositionsReq]) (*connect_go.Response[omniapi.ListDispositionsRes], error)
	// UpdateDisposition - update an existing disposition
	UpdateDisposition(context.Context, *connect_go.Request[omniapi.UpdateDispositionReq]) (*connect_go.Response[commons.Empty], error)
	// ListCustomUnsubscribeLinks - retrieves all the custom unsubscribe links
	ListCustomUnsubscribeLinks(context.Context, *connect_go.Request[commons.Empty]) (*connect_go.Response[omniapi.ListCustomUnsubscribeLinksRes], error)
	// CreateUnsubscribeLink - creates a new unsubscribe link
	CreateCustomUnsubscribeLink(context.Context, *connect_go.Request[commons.OmniCustomUnsubscribeLink]) (*connect_go.Response[omniapi.CreateCustomUnsubscribeLinkRes], error)
	// UpdateCustomUnsubscribeLink - update custom unsubscribe link details
	UpdateCustomUnsubscribeLink(context.Context, *connect_go.Request[omniapi.UpdateCustomUnsubscribeLinkReq]) (*connect_go.Response[omniapi.UpdateCustomUnsubscribeLinkRes], error)
	// DeleteCustomUnsubscribeLink - deletes custom unsubscribe link details
	DeleteCustomUnsubscribeLink(context.Context, *connect_go.Request[omniapi.DeleteCustomUnsubscribeLinkReq]) (*connect_go.Response[commons.Empty], error)
	// List campaigns defined by ListCampaignsReq.
	// The method will return a ListCampaignsReq entity that will contain
	// all the campaigns within the specified filter.
	ListCampaigns(context.Context, *connect_go.Request[omniapi.ListCampaignsReq]) (*connect_go.Response[omniapi.ListCampaignsRes], error)
	// Get a stream of new conversation message for a given conversation. Used
	// only for managers. It is not for customers.
	ManagerListMessages(context.Context, *connect_go.Request[omniapi.ManagerListMessagesReq], *connect_go.ServerStream[commons.OmniMessage]) error
	// Get a stream of conversation message for a given conversation. Used
	// only for agents/users. It is not for customers.
	ListMessages(context.Context, *connect_go.Request[omniapi.ListMessagesReq], *connect_go.ServerStream[commons.OmniMessage]) error
	// lists all conversation and assigned users for a given date range.
	// Required permissions:
	//
	//	OMNI_BOSS
	ManagerListConversations(context.Context, *connect_go.Request[omniapi.ListConversationsReq]) (*connect_go.Response[omniapi.ListConversationsRes], error)
	// ListContactLists - retrieves all the contact lists
	ListContactLists(context.Context, *connect_go.Request[omniapi.ListContactListsReq]) (*connect_go.Response[omniapi.ListContactListsRes], error)
	// GetAvailableHeaders - retrieves all the available headers that could be present on a contact list
	// Required permissions:
	//
	//	OMNI_BOSS
	GetAvailableHeaders(context.Context, *connect_go.Request[omniapi.GetAvailableHeadersReq]) (*connect_go.Response[omniapi.GetAvailableHeadersRes], error)
	// GetTask - retrieves a task using the provided criteria
	// Required permissions:
	//
	//	OMNI_AGENT
	GetTask(context.Context, *connect_go.Request[omniapi.GetTaskReq]) (*connect_go.Response[commons.OmniTask], error)
	// ListTasks - retrieves tasks using the provided criteria
	// Required permissions:
	//
	//	OMNI_BOSS
	ListTasks(context.Context, *connect_go.Request[omniapi.ListTasksReq]) (*connect_go.Response[omniapi.ListTasksRes], error)
	// CreateConnectedInbox - create a new connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	CreateConnectedInbox(context.Context, *connect_go.Request[commons.ConnectedInbox]) (*connect_go.Response[omniapi.CreateConnectedInboxRes], error)
	// DeleteConnectedInboxBySid - deletes a connected inbox given it's identifier
	// Required permissions:
	//
	//	OMNI_BOSS
	DeleteConnectedInboxBySid(context.Context, *connect_go.Request[omniapi.DeleteConnectedInboxBySidReq]) (*connect_go.Response[commons.Empty], error)
	// GetConnectedInboxBySid - retrieves a connected inbox given it's identifier
	// Required permissions:
	//
	//	OMNI_BOSS
	GetConnectedInboxBySid(context.Context, *connect_go.Request[omniapi.GetConnectedInboxBySidReq]) (*connect_go.Response[commons.ConnectedInbox], error)
	// Perform sendgrid account check to make sure all the account settings are valid defined by SendgridAccountByClientReq message.
	// The method will return a SendgridAccountByClientRes message/entity that will
	// contain the result true/false verifying account settings with sendgrid for this client
	// Required permissions:
	//
	//	OMNI_BOSS
	PerformSendgridAccountChecks(context.Context, *connect_go.Request[omniapi.SendgridAccountByClientReq]) (*connect_go.Response[omniapi.SendgridAccountByClientRes], error)
	// ListConnectedInboxes - retrieves all the connected inboxes for the organization
	// Required permissions:
	//
	//	OMNI_BOSS
	ListConnectedInboxes(context.Context, *connect_go.Request[omniapi.ListConnectedInboxesReq]) (*connect_go.Response[omniapi.ListConnectedInboxesRes], error)
	// TestConnectedInbox - check if connected inbox login works for a specified email_address,
	// username, password, server_name, and server_port (other fields from ConnectedInbox are ignored).
	// Required permissions:
	//
	//	OMNI_BOSS
	TestConnectedInbox(context.Context, *connect_go.Request[commons.ConnectedInbox]) (*connect_go.Response[omniapi.TestConnectedInboxRes], error)
	// UpdateConnectedInbox - update a connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateConnectedInbox(context.Context, *connect_go.Request[omniapi.UpdateConnectedInboxReq]) (*connect_go.Response[commons.Empty], error)
	// CreateVerifiedEmail.  this will create a new verified email
	// Required permissions
	//
	//	OMNI_BOSS
	CreateVerifiedEmail(context.Context, *connect_go.Request[commons.VerifiedEmail]) (*connect_go.Response[omniapi.CreateVerifiedEmailRes], error)
	// Delete verify email record based on verified email id defined by
	// DeleteVerifiedEmailReq for the specified client.
	// This method will return a DeleteVerifiedEmailRes message/entity.
	// DeleteVerifiedEmail - deletes a verified email record using the given identifier
	// Required permissions
	//
	//	OMNI_BOSS
	DeleteVerifiedEmail(context.Context, *connect_go.Request[omniapi.DeleteVerifiedEmailReq]) (*connect_go.Response[commons.Empty], error)
	// Get the verified email details based on verified email id defined by
	// GetVerifiedEmailByIdReq for the specified client.
	// This method will return an OmniVerifiedEmail message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	GetVerifiedEmailBySid(context.Context, *connect_go.Request[omniapi.GetVerifiedEmailBySidReq]) (*connect_go.Response[commons.VerifiedEmail], error)
	// List all the verified emails and their details defined by
	// ListVerifiedEmailsReq for the specified client.
	// This method will return a ListVerifiedEmailsRes message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	ListVerifiedEmails(context.Context, *connect_go.Request[omniapi.ListVerifiedEmailsReq]) (*connect_go.Response[omniapi.ListVerifiedEmailsRes], error)
	// Resend verify email record based on verified email id defined by
	// ResendVerifiedEmailReq for the specified client.
	// This method will return a ResendVerifiedEmailRes message/entity.
	// Required permissions
	//
	//	OMNI_BOSS
	ResendVerifiedEmail(context.Context, *connect_go.Request[omniapi.ResendVerifiedEmailReq]) (*connect_go.Response[omniapi.ResendVerifiedEmailRes], error)
	// Updates verified email description
	UpdateVerifiedEmail(context.Context, *connect_go.Request[omniapi.UpdateVerifiedEmailReq]) (*connect_go.Response[commons.Empty], error)
	// GetPendingGoogleXOAuth2Data - retrieves the pending oauth data required to finish creating a connected inbox
	// Required permissions:
	//
	//	OMNI_BOSS
	GetPendingGoogleXOAuth2Data(context.Context, *connect_go.Request[omniapi.GetPendingGoogleXOAuth2DataReq]) (*connect_go.Response[omniapi.GetPendingGoogleXOAuth2DataRes], error)
	// Send email notification defined by SendEmailNotificationReq message for the specified
	// subject, message and array of to email addresses.
	// The method will return a stream of SendEmailNotificationRes messages
	// containing result true/false after notified by email for the client_sid.
	// Required permissions:
	//
	//	OMNI_BOSS
	SendEmailNotification(context.Context, *connect_go.Request[omniapi.SendEmailNotificationReq]) (*connect_go.Response[omniapi.SendEmailNotificationRes], error)
	// Send an email to our feedback system. The users email will be populated as the from address to open an email thread with our support.
	SendFeedbackEmail(context.Context, *connect_go.Request[omniapi.SendFeedbackEmailReq]) (*connect_go.Response[omniapi.SendFeedbackEmailRes], error)
	// GetOmniAttachment - retrieves the omni attachment details based on the request
	// Required permissions:
	//
	//	OMNI_BOSS
	GetOmniAttachment(context.Context, *connect_go.Request[omniapi.GetOmniAttachmentReq]) (*connect_go.Response[commons.OmniAttachment], error)
	// Create a task with a given contat list .
	CreateTasks(context.Context, *connect_go.Request[omniapi.CreateTasksReq]) (*connect_go.Response[omniapi.CreateTasksRes], error)
	// CreateSignature - creates a new message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	CreateSignature(context.Context, *connect_go.Request[omniapi.CreateSignatureReq]) (*connect_go.Response[omniapi.CreateSignatureRes], error)
	// DeleteSignature - deletes a message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	DeleteSignature(context.Context, *connect_go.Request[omniapi.DeleteSignatureReq]) (*connect_go.Response[omniapi.DeleteSignatureRes], error)
	// ListSignatures - retrieves the signatures created by the organization
	// Required permissions:
	//
	//	OMNI_BOSS
	ListSignatures(context.Context, *connect_go.Request[omniapi.ListSignaturesReq]) (*connect_go.Response[omniapi.ListSignaturesRes], error)
	// UpdateSignature - updates a message signature
	// Required permissions:
	//
	//	OMNI_BOSS
	UpdateSignature(context.Context, *connect_go.Request[omniapi.UpdateSignatureReq]) (*connect_go.Response[omniapi.UpdateSignatureRes], error)
}

OmniApiHandler is an implementation of the api.v1alpha1.omniapi.OmniApi service.

type UnimplementedOmniApiHandler

type UnimplementedOmniApiHandler struct{}

UnimplementedOmniApiHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

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