emailbridgeep

type CreateEmailDomainEndpoint struct{}

type CreateEmailDomainRequest struct {
	// The fully-qualified domain name to register (e.g. `support.acme.com`).
	//
	// Supply a bare domain, not an email address; the value is lowercased before it is stored.
	Domain string `json:"domain" validate:"required"`
}

type CreateEmailInboxEndpoint struct{}

type CreateEmailInboxRequest struct {
	// The verified domain this inbox belongs to.
	EmailDomainID string `json:"email_domain_id" validate:"required"`
	// The full inbox address (e.g. `support@acme.com`).
	//
	// Its domain part must match the selected domain, which must already be verified. The address is lowercased before it is stored, and it must not already be in use by another inbox.
	Address string `json:"address" validate:"required"`
	// Display name for the `From` header of outbound mail.
	FromName field.Optional[string] `json:"from_name,omitzero"`
	// The agent to bind to this inbox to handle incoming mail.
	//
	// With no agent bound, mail is still threaded into a conversation for your team, but nothing runs on it automatically.
	AgentConfigID field.Optional[string] `json:"agent_config_id,omitzero"`
	// How the bound agent decides whether to run on incoming mail.
	//
	// - `mention`: runs only when the agent is @mentioned, matched against the trigger keywords below.
	// - `keyword`: runs when the message contains any of the trigger keywords.
	// - `always`: runs on every incoming message.
	//
	// Leaving this unset makes the agent run on every incoming message, since email has no reliable @mention convention.
	AgentTriggerPolicy field.Optional[constants.AgentTriggerPolicy] `json:"agent_trigger_policy,omitzero"`
	// The keywords that decide whether the agent runs on an incoming message.
	//
	// Under the `keyword` policy a keyword matches anywhere in the message; under `mention` it only counts where it is prefixed with `@`.
	AgentTriggerKeywords []string `json:"agent_trigger_keywords,omitzero"`
	// The messaging group (roster) whose members are seated on every conversation this inbox opens.
	//
	// Must name a group in your own account. Agents in the group are seated to run only when @mentioned, so they do not all fire alongside the inbox's own agent.
	GroupID field.Optional[string] `json:"group_id,omitzero"`
}

type DeleteEmailDomainEndpoint struct{}

type DeleteEmailDomainRequest struct {
	// Email domain ID.
	ID string `path:"id" validate:"required"`
}

type DeleteEmailInboxEndpoint struct{}

type DeleteEmailInboxRequest struct {
	// Email inbox ID.
	ID string `path:"id" validate:"required"`
}

type EmailBridgeSvc interface {
	CreateDomain(ctx context.Context, req *CreateEmailDomainRequest) (*apiresource.EmailDomain, *apierror.APIError)
	ListDomains(ctx context.Context, req *ListEmailDomainsRequest) (*apiresource.List[apiresource.EmailDomain], *apierror.APIError)
	GetDomain(ctx context.Context, req *GetEmailDomainRequest) (*apiresource.EmailDomain, *apierror.APIError)
	VerifyDomain(ctx context.Context, req *VerifyEmailDomainRequest) (*apiresource.EmailDomain, *apierror.APIError)
	DeleteDomain(ctx context.Context, req *DeleteEmailDomainRequest) (*apiresource.EmptyResource, *apierror.APIError)

	CreateInbox(ctx context.Context, req *CreateEmailInboxRequest) (*apiresource.EmailInbox, *apierror.APIError)
	ListInboxes(ctx context.Context, req *ListEmailInboxesRequest) (*apiresource.List[apiresource.EmailInbox], *apierror.APIError)
	GetInbox(ctx context.Context, req *GetEmailInboxRequest) (*apiresource.EmailInbox, *apierror.APIError)
	UpdateInbox(ctx context.Context, req *UpdateEmailInboxRequest) (*apiresource.EmailInbox, *apierror.APIError)
	DeleteInbox(ctx context.Context, req *DeleteEmailInboxRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type EmailBridgeSvcConfig struct {
	// EmailBridgeClient (required) is the notification-service EmailBridgeService gRPC client.
	EmailBridgeClient pb.EmailBridgeServiceClient
}

type GetEmailDomainEndpoint struct{}

type GetEmailDomainRequest struct {
	// Email domain ID.
	ID string `path:"id" validate:"required"`
}

type GetEmailInboxEndpoint struct{}

type GetEmailInboxRequest struct {
	// Email inbox ID.
	ID string `path:"id" validate:"required"`
}

type ListEmailDomainsEndpoint struct{}

type ListEmailDomainsRequest struct{}

type ListEmailInboxesEndpoint struct{}

type ListEmailInboxesRequest struct{}

type UpdateEmailInboxEndpoint struct{}

type UpdateEmailInboxRequest struct {
	// Email inbox ID.
	ID string `path:"id" validate:"required"`
	// Whether the inbox accepts mail.
	//
	// - `active`: inbound mail is threaded into a conversation.
	// - `disabled`: the inbox stays provisioned and keeps its history, but inbound mail is dropped without being threaded.
	Status constants.EmailInboxStatus `json:"status" validate:"required"`
	// Display name for the `From` header of outbound mail.
	FromName field.Optional[string] `json:"from_name,omitzero"`
	// The agent to bind to this inbox to handle incoming mail.
	AgentConfigID field.Optional[string] `json:"agent_config_id,omitzero"`
	// How the bound agent decides whether to run on incoming mail.
	//
	// - `mention`: runs only when the agent is @mentioned, matched against the trigger keywords below.
	// - `keyword`: runs when the message contains any of the trigger keywords.
	// - `always`: runs on every incoming message.
	//
	// While no policy has been set, the agent runs on every incoming message, since email has no reliable @mention convention.
	AgentTriggerPolicy field.Optional[constants.AgentTriggerPolicy] `json:"agent_trigger_policy,omitzero"`
	// The keywords that decide whether the agent runs on an incoming message.
	//
	// Under the `keyword` policy a keyword matches anywhere in the message; under `mention` it only counts where it is prefixed with `@`.
	AgentTriggerKeywords []string `json:"agent_trigger_keywords,omitzero"`
	// The messaging group (roster) whose members are seated on every conversation this inbox opens.
	//
	// Must name a group in your own account. Changing it only affects conversations opened afterwards.
	GroupID field.Optional[string] `json:"group_id,omitzero"`
}

type VerifyEmailDomainEndpoint struct{}

type VerifyEmailDomainRequest struct {
	// Email domain ID.
	ID string `path:"id" validate:"required"`
}