Help us shape the future of Go! Take the 2026 Go Developer Survey

site

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Oct 24, 2026 License: AGPL-3.0 Imports: 76 Imported by: 0

Documentation

Overview

Package site implements the /site surface: the API of the frontend SPA, authenticated by the session cookie.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuditLog 

type AuditLog interface {
	Licensed() bool
	// Entries returns up to limit entries matching the filter, newest first, preceding
	// the cursor entry id (0 = from the newest), and the next page's cursor (0 = last page).
	Entries(ctx context.Context, s *ent.Scoped, f events.AuditFilter, cursor int64, limit int) ([]*ent.AuditEntry, int64, error)
	// ExportCSV streams the entries matching the filter, newest first, as CSV.
	ExportCSV(ctx context.Context, s *ent.Scoped, f events.AuditFilter, w io.Writer) error
	// RetentionLicensed reports whether the retention window may be set (ADR 0014).
	RetentionLicensed() bool
}

AuditLog is the read seam of the Enterprise Audit log (ADR 0022), implemented by ee/audit. Core knows only this interface: without a license Licensed is false and the page answers 402.

type Deps 

type Deps struct {
	Accounts *accounts.Accounts
	// Deletion is the Workspace deletion cycle (ADR 0043).
	Deletion *workspacedeletion.Module
	// Instance is the Instance state no Workspace owns (ADR 0032).
	Instance *instance.Module
	// Attempts counts failed logins and password-reset mails per account (ADR
	// 0025); login and forgot-password share it.
	Attempts       *accounts.Attempts
	OAuth          *oauthserver.Service
	Bus            *events.Bus
	Webhooks       *webhooks.Module
	Outbound       *outbound.Module
	Segments       *segments.Module
	EventLog       *eventlog.Module
	Contacts       *contacts.Module
	Erasure        *erasure.Module
	Tags           *tags.Module
	Templates      *templates.Module
	BrandKit       *brandkit.Module
	Automations    *automations.Module
	Rules          *rules.Module
	Broadcasts     *broadcasts.Module
	Welcome        WelcomeEnqueuer
	SysMail        SystemMailEnqueuer
	SendingDomains *sendingdomains.Module
	JoinDomains    *joindomains.Module
	Integrations   *integrations.Module
	Tokens         *authtoken.Signer
	Tracker        *tracking.Tracker
	AppURL         string
	Audit          AuditLog
	AbuseWatch     abusewatch.Watch
	// SupportEmail is where a suspended Workspace's owner appeals (SPHERICON_SUPPORT_EMAIL).
	SupportEmail string
	// MCPURL is the public origin of the MCP endpoint (config.MCPOrigin).
	MCPURL    string
	Analytics *analytics.Module
	// Sessions issues the session cookie on login (ADR 0020). The composition
	// root (server.New) builds it from the instance secret and SPHERICON_SESSION_TTL.
	Sessions *auth.Sessions
	// SecondFactor enrolls and verifies a User's TOTP Second factor (ADR 0020).
	SecondFactor *secondfactor.Module
	// Passkeys registers a User's Passkeys (ADR 0052).
	Passkeys *secondfactor.Passkeys
	// Clock is the time the site session's expiry and a Two-factor requirement's
	// grace are checked against (ADR 0020); nil means time.Now. Tests inject one to
	// move past a session's lifetime or a grace period.
	Clock func() time.Time
	// AccountLink mints the Owner's Account link token; nil when the installation is
	// not configured for it, which leaves the operation answering 404.
	AccountLink *accountlink.Link
	// Holds reads a Workspace's standing: the same module, so the same license gate,
	// the send path applies (ADR 0009).
	Holds *holds.Holds
	// RequireEmailVerification is the email verification gate (ADR 0030): when false,
	// registration takes a password and yields a Verified User at once, and login
	// checks no verification.
	RequireEmailVerification bool
	// SignupOpen is SPHERICON_SIGNUP_OPEN (ADR 0042): when false, register answers 403.
	SignupOpen bool
	// SignupSurvey is the Sign-up survey module (built with signupsurvey.Enabled).
	SignupSurvey *signupsurvey.Module
	// Signin is the Sign-in providers the Instance enabled (ADR 0048); none enabled when
	// no provider is configured.
	Signin *signin.Providers
}

Deps is everything the /site handlers are built from. The domain modules are the shared singletons the composition root registers once, so /site and /api cannot diverge on how a module is constructed.

type Handlers 

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

func NewHandlers 

func NewHandlers(d Deps) *Handlers
func (h *Handlers) SiteAnalyticsClicksByLink(ctx context.Context, params siteapi.SiteAnalyticsClicksByLinkParams) (siteapi.SiteAnalyticsClicksByLinkRes, error)

SiteAnalyticsClicksByLink maps the analytics module's Clicks by link report onto the DTO.

func (*Handlers) SiteAnalyticsEvents 

func (h *Handlers) SiteAnalyticsEvents(ctx context.Context, params siteapi.SiteAnalyticsEventsParams) (siteapi.SiteAnalyticsEventsRes, error)

SiteAnalyticsEvents maps the analytics module's Events report onto the DTO.

func (*Handlers) SiteAnalyticsNewPeople 

func (h *Handlers) SiteAnalyticsNewPeople(ctx context.Context, params siteapi.SiteAnalyticsNewPeopleParams) (siteapi.SiteAnalyticsNewPeopleRes, error)

SiteAnalyticsNewPeople maps the New people report onto the DTO.

func (*Handlers) SiteAnalyticsOpensByHour 

func (h *Handlers) SiteAnalyticsOpensByHour(ctx context.Context, params siteapi.SiteAnalyticsOpensByHourParams) (siteapi.SiteAnalyticsOpensByHourRes, error)

SiteAnalyticsOpensByHour maps the analytics module's Opens by hour report onto the DTO.

func (*Handlers) SiteAnalyticsOverview 

func (h *Handlers) SiteAnalyticsOverview(ctx context.Context, params siteapi.SiteAnalyticsOverviewParams) (siteapi.SiteAnalyticsOverviewRes, error)

SiteAnalyticsOverview maps the analytics module's Overview onto the DTO.

func (*Handlers) SiteAnalyticsSubscribedPeople 

func (h *Handlers) SiteAnalyticsSubscribedPeople(ctx context.Context, params siteapi.SiteAnalyticsSubscribedPeopleParams) (siteapi.SiteAnalyticsSubscribedPeopleRes, error)

SiteAnalyticsSubscribedPeople maps the Subscribed people report onto the DTO.

func (*Handlers) SiteAuditExport 

func (h *Handlers) SiteAuditExport(ctx context.Context, params siteapi.SiteAuditExportParams) (siteapi.SiteAuditExportRes, error)

SiteAuditExport downloads the whole Audit log as CSV, newest first. Same access as the list: owner and admin only, 402 without an Enterprise license. It takes the same filter as SiteAuditList, so an export matches what the page shows.

func (*Handlers) SiteAuditGetRetention 

func (h *Handlers) SiteAuditGetRetention(ctx context.Context, params siteapi.SiteAuditGetRetentionParams) (siteapi.SiteAuditGetRetentionRes, error)

SiteAuditGetRetention reads the Audit log retention window. Owner and admin only; 402 without the Enterprise retention license.

func (*Handlers) SiteAuditList 

func (h *Handlers) SiteAuditList(ctx context.Context, params siteapi.SiteAuditListParams) (siteapi.SiteAuditListRes, error)

SiteAuditList shows the Workspace's Audit log, newest first. Owner and admin only; an instance without an Enterprise license answers 402 (ADR 0014, ADR 0022).

func (*Handlers) SiteAuditSetRetention 

func (h *Handlers) SiteAuditSetRetention(ctx context.Context, req *siteapi.SiteAuditRetention, params siteapi.SiteAuditSetRetentionParams) (siteapi.SiteAuditSetRetentionRes, error)

SiteAuditSetRetention sets or clears the Audit log retention window and records the change as a `workspace.update` Audit entry. Owner and admin only.

func (*Handlers) SiteAuthConfirmEmailChange 

func (h *Handlers) SiteAuthConfirmEmailChange(ctx context.Context, req *siteapi.SiteConfirmEmailChangeInput, params siteapi.SiteAuthConfirmEmailChangeParams) (siteapi.SiteAuthConfirmEmailChangeRes, error)

SiteAuthConfirmEmailChange applies a requested email change once the new address is confirmed via the token sent to it. Public: the link may be opened from a browser without a session. The change ends every session of the User (ADR 0020); when the confirming request carries a valid session of that same User, it continues under a fresh token in the same response. The link alone never signs anyone in.

func (*Handlers) SiteAuthForgotPassword 

func (h *Handlers) SiteAuthForgotPassword(ctx context.Context, req *siteapi.SiteForgotPasswordInput) (siteapi.SiteAuthForgotPasswordRes, error)

SiteAuthForgotPassword mints a reset token and emails a link. It answers 202 whether or not the address matches an account and whether or not the per-address budget is spent, so the endpoint cannot be used to enumerate registered emails (the per-IP cap answers 429 in the rate limit middleware, before this runs). Every request does the same work: take a slot of the address's budget in one atomic step, look the address up, mint a token and enqueue a mail job. Only a known address that was granted a slot gets its mail delivered; for the others the job is a no-send one, so response time does not leak existence either.

func (*Handlers) SiteAuthLogin 

func (h *Handlers) SiteAuthLogin(ctx context.Context, req *siteapi.SiteLoginInput) (siteapi.SiteAuthLoginRes, error)

SiteAuthLogin is the one route that starts a session (ADR 0020). It consults the Login throttle first (ADR 0025): while the address's delay runs it answers 429 even for a correct password, else guessing until one attempt succeeds would skip the delay. An unknown email, a wrong password and a User without a password all answer the same 401, after the same password hash work, and all count as a failure of the address. A success resets the counter, sets the session cookie and is recorded as `user.login` in each of the User's Workspaces (ADR 0022).

A User with an active Second factor gets a challenge instead of the cookie, and the counter is not reset: only the second step resets it, else knowing the password would buy a fresh round of code guesses on every login.

func (*Handlers) SiteAuthLogout 

func (h *Handlers) SiteAuthLogout(context.Context) (*siteapi.SiteAuthLogoutNoContent, error)

SiteAuthLogout ends the session on this browser by clearing its cookie. A token copied elsewhere stays valid until it expires or the User's epoch is bumped.

func (*Handlers) SiteAuthRegister 

func (h *Handlers) SiteAuthRegister(ctx context.Context, req *siteapi.SiteRegisterInput) (siteapi.SiteAuthRegisterRes, error)

SiteAuthRegister creates an Unverified User from a name, an email and a password (ADR 0030): no session, no Workspace. The password is stored hashed, and the mailed token is bound to it and to the browser that registered, whose cookie the answer sets; the link trusts the password only when that browser opens it (SiteAuthVerifyEmail). The Workspace and the welcome email follow the proof.

func (*Handlers) SiteAuthResendVerification 

func (h *Handlers) SiteAuthResendVerification(ctx context.Context, req *siteapi.SiteResendVerificationInput, params siteapi.SiteAuthResendVerificationParams) (siteapi.SiteAuthResendVerificationRes, error)

SiteAuthResendVerification sends the verification link again to an Unverified User (ADR 0030). It answers 202 the same way for an unknown, an already verified and an unverified address, and every request does the same work (a token is minted, a mail job is queued); only an Unverified User's job delivers, the others' is a no-send one, so neither the answer nor its timing says whether the address has an account. The per-IP cap answers 429 in the rate limit middleware, before this runs.

func (*Handlers) SiteAuthResetPassword 

func (h *Handlers) SiteAuthResetPassword(ctx context.Context, req *siteapi.SiteResetPasswordInput) (siteapi.SiteAuthResetPasswordRes, error)

SiteAuthResetPassword sets a new password from a reset token.

func (*Handlers) SiteAuthSecondFactor 

func (h *Handlers) SiteAuthSecondFactor(ctx context.Context, req *siteapi.SiteLoginSecondFactorInput) (siteapi.SiteAuthSecondFactorRes, error)

SiteAuthSecondFactor is the second login step of a User with a Second factor (ADR 0020): the login module parses the challenge, consults the Login throttle (ADR 0025), verifies the code through the adapter and counts. A current TOTP or unused Recovery code starts the session, recorded as `user.login` like a one-step login (a Recovery code is also recorded as `user.recovery_code_use` by the module). Wrong codes count as failures of the User's address, and while its delay runs even a correct code answers 429. A bad challenge has no trusted address, so it is answered 401 without counting; the per-IP login cap still applies to the route.

func (*Handlers) SiteAuthSigninCallback 

func (h *Handlers) SiteAuthSigninCallback(ctx context.Context, params siteapi.SiteAuthSigninCallbackParams) (*siteapi.SiteAuthSigninCallbackFound, error)

SiteAuthSigninCallback is where the provider sends the browser back. Whatever happens it answers with a redirect: to the page the flow began from with the session cookie, or to the login page with the Reason, which the SPA renders. A callback that is not for a flow this browser began (no cookie, another state) is refused before the provider is asked anything.

func (*Handlers) SiteAuthSigninNotMe 

func (h *Handlers) SiteAuthSigninNotMe(ctx context.Context, req *siteapi.SiteSigninNotMeInput) (siteapi.SiteAuthSigninNotMeRes, error)

SiteAuthSigninNotMe is the link of the notice mailed after a silent link: it unlinks the identity the token names and ends every session of its User (ADR 0048). The token is the credential, so it works without a session; it works once, because once the identity is gone there is nothing left to undo.

func (*Handlers) SiteAuthSigninProviders 

func (h *Handlers) SiteAuthSigninProviders(context.Context) (*siteapi.SiteSigninProviders, error)

SiteAuthSigninProviders lists the Sign-in providers the Instance enabled, for the buttons of the login and register pages (empty when none is configured).

func (*Handlers) SiteAuthSigninStart 

func (h *Handlers) SiteAuthSigninStart(_ context.Context, params siteapi.SiteAuthSigninStartParams) (siteapi.SiteAuthSigninStartRes, error)

SiteAuthSigninStart begins a provider sign-in (ADR 0048): it draws the flow, keeps it in the signed flow cookie with the `return_to` that survived validation, and redirects the browser to the provider.

func (*Handlers) SiteAuthVerifyEmail 

func (h *Handlers) SiteAuthVerifyEmail(ctx context.Context, req *siteapi.SiteVerifyEmailInput, params siteapi.SiteAuthVerifyEmailParams) (siteapi.SiteAuthVerifyEmailRes, error)

SiteAuthVerifyEmail completes a registration from its link (ADR 0030): the token proves the address, so it stamps the Verified email, ends every earlier session, creates the User's first Workspace and sends the welcome email, then starts the session through the login issuer. The password stored at registration stays only when the request carries the registration cookie the token was minted for; any other browser must send a password, which replaces it, and without one nothing changes and the token stays valid (a mail scanner consumes nothing). The token is single use (the Verified check) and scoped to the address it was sent to: an old link never verifies a changed address.

func (*Handlers) SiteAutomationReportsGet 

func (h *Handlers) SiteAutomationReportsGet(ctx context.Context, params siteapi.SiteAutomationReportsGetParams) (siteapi.SiteAutomationReportsGetRes, error)

func (*Handlers) SiteAutomationsActivate 

func (h *Handlers) SiteAutomationsActivate(ctx context.Context, params siteapi.SiteAutomationsActivateParams) (siteapi.SiteAutomationsActivateRes, error)

func (*Handlers) SiteAutomationsArchive 

func (h *Handlers) SiteAutomationsArchive(ctx context.Context, params siteapi.SiteAutomationsArchiveParams) (siteapi.SiteAutomationsArchiveRes, error)

SiteAutomationsArchive archives an automation (ADR 0049): it leaves the list and enrolls nobody, and keeps its enrollments. Active enrollments refuse it with 409.

func (*Handlers) SiteAutomationsCreate 

func (h *Handlers) SiteAutomationsCreate(ctx context.Context, req *siteapi.SiteCreateAutomationInput, params siteapi.SiteAutomationsCreateParams) (siteapi.SiteAutomationsCreateRes, error)

func (*Handlers) SiteAutomationsDeactivate 

func (h *Handlers) SiteAutomationsDeactivate(ctx context.Context, params siteapi.SiteAutomationsDeactivateParams) (siteapi.SiteAutomationsDeactivateRes, error)

func (*Handlers) SiteAutomationsDelete 

func (h *Handlers) SiteAutomationsDelete(ctx context.Context, params siteapi.SiteAutomationsDeleteParams) (siteapi.SiteAutomationsDeleteRes, error)

func (*Handlers) SiteAutomationsDryRunHttpStep 

func (h *Handlers) SiteAutomationsDryRunHttpStep(ctx context.Context, req *siteapi.SiteDryRunHttpStepInput, params siteapi.SiteAutomationsDryRunHttpStepParams) (siteapi.SiteAutomationsDryRunHttpStepRes, error)

SiteAutomationsDryRunHttpStep renders an HTTP step's body for a Contact and validates it; nothing is called.

func (*Handlers) SiteAutomationsGet 

func (h *Handlers) SiteAutomationsGet(ctx context.Context, params siteapi.SiteAutomationsGetParams) (siteapi.SiteAutomationsGetRes, error)

func (*Handlers) SiteAutomationsList 

func (h *Handlers) SiteAutomationsList(ctx context.Context, params siteapi.SiteAutomationsListParams) (siteapi.SiteAutomationsListRes, error)

func (*Handlers) SiteAutomationsUnarchive 

func (h *Handlers) SiteAutomationsUnarchive(ctx context.Context, params siteapi.SiteAutomationsUnarchiveParams) (siteapi.SiteAutomationsUnarchiveRes, error)

SiteAutomationsUnarchive restores an archived automation to the list.

func (*Handlers) SiteAutomationsUpdate 

func (h *Handlers) SiteAutomationsUpdate(ctx context.Context, req *siteapi.SiteUpdateAutomationInput, params siteapi.SiteAutomationsUpdateParams) (siteapi.SiteAutomationsUpdateRes, error)

func (*Handlers) SiteBrandKitGet 

func (h *Handlers) SiteBrandKitGet(ctx context.Context, params siteapi.SiteBrandKitGetParams) (siteapi.SiteBrandKitGetRes, error)

SiteBrandKitGet returns the Workspace's Brand kit; every member may read it.

func (*Handlers) SiteBrandKitRecreateStarterTemplates 

func (h *Handlers) SiteBrandKitRecreateStarterTemplates(ctx context.Context, params siteapi.SiteBrandKitRecreateStarterTemplatesParams) (siteapi.SiteBrandKitRecreateStarterTemplatesRes, error)

SiteBrandKitRecreateStarterTemplates makes the starter Templates again from the saved Brand kit. Owners only.

func (*Handlers) SiteBrandKitSave 

func (h *Handlers) SiteBrandKitSave(ctx context.Context, req *siteapi.SiteSaveBrandKitInput, params siteapi.SiteBrandKitSaveParams) (siteapi.SiteBrandKitSaveRes, error)

SiteBrandKitSave saves the Brand kit: the first save also makes the starter Templates. Owners only. 

func (h *Handlers) SiteBroadcastLinksList(ctx context.Context, params siteapi.SiteBroadcastLinksListParams) (siteapi.SiteBroadcastLinksListRes, error)

func (*Handlers) SiteBroadcastsArchive 

func (h *Handlers) SiteBroadcastsArchive(ctx context.Context, params siteapi.SiteBroadcastsArchiveParams) (siteapi.SiteBroadcastsArchiveRes, error)

SiteBroadcastsArchive archives a sent or failed broadcast (ADR 0049): it leaves the list but keeps its report, tracking and figures.

func (*Handlers) SiteBroadcastsCreate 

func (h *Handlers) SiteBroadcastsCreate(ctx context.Context, req *siteapi.SiteCreateBroadcastInput, params siteapi.SiteBroadcastsCreateParams) (siteapi.SiteBroadcastsCreateRes, error)

func (*Handlers) SiteBroadcastsDelete 

func (h *Handlers) SiteBroadcastsDelete(ctx context.Context, params siteapi.SiteBroadcastsDeleteParams) (siteapi.SiteBroadcastsDeleteRes, error)

func (*Handlers) SiteBroadcastsGet 

func (h *Handlers) SiteBroadcastsGet(ctx context.Context, params siteapi.SiteBroadcastsGetParams) (siteapi.SiteBroadcastsGetRes, error)

func (*Handlers) SiteBroadcastsList 

func (h *Handlers) SiteBroadcastsList(ctx context.Context, params siteapi.SiteBroadcastsListParams) (siteapi.SiteBroadcastsListRes, error)

func (*Handlers) SiteBroadcastsSchedule 

func (h *Handlers) SiteBroadcastsSchedule(ctx context.Context, req *siteapi.SiteScheduleBroadcastInput, params siteapi.SiteBroadcastsScheduleParams) (siteapi.SiteBroadcastsScheduleRes, error)

SiteBroadcastsSchedule schedules a draft broadcast to send at a future time.

func (*Handlers) SiteBroadcastsSend 

func (h *Handlers) SiteBroadcastsSend(ctx context.Context, params siteapi.SiteBroadcastsSendParams) (siteapi.SiteBroadcastsSendRes, error)

SiteBroadcastsSend sends a draft or scheduled broadcast immediately. The state machine lives in the broadcasts module; this is the HTTP adapter.

func (*Handlers) SiteBroadcastsTestSend 

func (h *Handlers) SiteBroadcastsTestSend(ctx context.Context, req *siteapi.SiteTestSendBroadcastInput, params siteapi.SiteBroadcastsTestSendParams) (siteapi.SiteBroadcastsTestSendRes, error)

SiteBroadcastsTestSend renders the broadcast with sample merge data and sends it to a single address — no recipient rows, no tracking (a token would point at a nonexistent recipient). Used to preview the rendered email.

func (*Handlers) SiteBroadcastsUnarchive 

func (h *Handlers) SiteBroadcastsUnarchive(ctx context.Context, params siteapi.SiteBroadcastsUnarchiveParams) (siteapi.SiteBroadcastsUnarchiveRes, error)

SiteBroadcastsUnarchive restores an archived broadcast to the list.

func (*Handlers) SiteBroadcastsUpdate 

func (h *Handlers) SiteBroadcastsUpdate(ctx context.Context, req *siteapi.SiteUpdateBroadcastInput, params siteapi.SiteBroadcastsUpdateParams) (siteapi.SiteBroadcastsUpdateRes, error)

func (*Handlers) SiteContactsCreate 

func (h *Handlers) SiteContactsCreate(ctx context.Context, req *siteapi.SiteCreateContactInput, params siteapi.SiteContactsCreateParams) (siteapi.SiteContactsCreateRes, error)

func (*Handlers) SiteContactsDelete 

func (h *Handlers) SiteContactsDelete(ctx context.Context, params siteapi.SiteContactsDeleteParams) (siteapi.SiteContactsDeleteRes, error)

SiteContactsDelete is Erasure (ADR 0021): irreversible, so owner or admin only.

func (*Handlers) SiteContactsErase 

func (h *Handlers) SiteContactsErase(ctx context.Context, params siteapi.SiteContactsEraseParams) (siteapi.SiteContactsEraseRes, error)

SiteContactsErase is Erasure by email address (ADR 0021, a Privacy request): the one erasure module, with the signed-in User as requester. Owner or admin only, like deleting a Contact. Not-found means neither a Contact nor delivery records hold the address.

func (*Handlers) SiteContactsExport 

func (h *Handlers) SiteContactsExport(ctx context.Context, params siteapi.SiteContactsExportParams) (siteapi.SiteContactsExportRes, error)

SiteContactsExport streams the subject-access Data export of one contact (ADR 0021). Any Workspace member may export: it needs contact read access only.

func (*Handlers) SiteContactsGet 

func (h *Handlers) SiteContactsGet(ctx context.Context, params siteapi.SiteContactsGetParams) (siteapi.SiteContactsGetRes, error)

func (*Handlers) SiteContactsList 

func (h *Handlers) SiteContactsList(ctx context.Context, params siteapi.SiteContactsListParams) (siteapi.SiteContactsListRes, error)

func (*Handlers) SiteContactsLookup 

func (h *Handlers) SiteContactsLookup(ctx context.Context, params siteapi.SiteContactsLookupParams) (siteapi.SiteContactsLookupRes, error)

SiteContactsLookup answers a Privacy request's first question (ADR 0021): what the Workspace holds for an email address, as counts. It sits beside Erasure, so owner or admin only; an address nothing holds answers with zeros.

func (*Handlers) SiteContactsUpdate 

func (h *Handlers) SiteContactsUpdate(ctx context.Context, req *siteapi.SiteUpdateContactInput, params siteapi.SiteContactsUpdateParams) (siteapi.SiteContactsUpdateRes, error)

func (*Handlers) SiteCustomFieldsList 

func (h *Handlers) SiteCustomFieldsList(ctx context.Context, params siteapi.SiteCustomFieldsListParams) (siteapi.SiteCustomFieldsListRes, error)

SiteCustomFieldsList returns the workspace's Custom field definitions — the typed, named attribute catalogue (ADR 0006) that feeds the segment builder. Definitions are auto-created on first sight at ingest; this is a read-only catalogue. The full set is returned in a single page (the catalogue is small and unpaginated).

func (*Handlers) SiteDomainJoinGet 

func (h *Handlers) SiteDomainJoinGet(ctx context.Context, params siteapi.SiteDomainJoinGetParams) (siteapi.SiteDomainJoinGetRes, error)

SiteDomainJoinGet reads the Workspace's domain join switch. Owners only.

func (*Handlers) SiteDomainJoinSet 

func (h *Handlers) SiteDomainJoinSet(ctx context.Context, req *siteapi.SiteSetDomainJoinInput, params siteapi.SiteDomainJoinSetParams) (siteapi.SiteDomainJoinSetRes, error)

SiteDomainJoinSet switches the Workspace's domain join on or off. Owners only.

func (*Handlers) SiteEnrollmentsGet 

func (h *Handlers) SiteEnrollmentsGet(ctx context.Context, params siteapi.SiteEnrollmentsGetParams) (siteapi.SiteEnrollmentsGetRes, error)

func (*Handlers) SiteEnrollmentsList 

func (h *Handlers) SiteEnrollmentsList(ctx context.Context, params siteapi.SiteEnrollmentsListParams) (siteapi.SiteEnrollmentsListRes, error)

func (*Handlers) SiteEventsActions 

func (h *Handlers) SiteEventsActions(ctx context.Context, params siteapi.SiteEventsActionsParams) (siteapi.SiteEventsActionsRes, error)

SiteEventsActions returns the distinct event actions in the workspace, sorted — used to populate the segment builder's event-condition picker.

func (*Handlers) SiteEventsList 

func (h *Handlers) SiteEventsList(ctx context.Context, params siteapi.SiteEventsListParams) (siteapi.SiteEventsListRes, error)

SiteEventsList returns the workspace's events, most recent first. 

func (h *Handlers) SiteIdentitiesLink(ctx context.Context, params siteapi.SiteIdentitiesLinkParams) (siteapi.SiteIdentitiesLinkRes, error)

SiteIdentitiesLink begins linking a provider account to the session User: the same flow as a sign-in, but the signed flow cookie also names the User the callback adds the subject to.

func (*Handlers) SiteIdentitiesList 

func (h *Handlers) SiteIdentitiesList(ctx context.Context) (*siteapi.SiteLinkedIdentities, error)

SiteIdentitiesList lists the session User's Linked identities (ADR 0048). 

func (h *Handlers) SiteIdentitiesUnlink(ctx context.Context, params siteapi.SiteIdentitiesUnlinkParams) (siteapi.SiteIdentitiesUnlinkRes, error)

SiteIdentitiesUnlink removes a Linked identity of the session User, unless it is the last way to sign in, ends the other sessions and reissues the acting one.

func (*Handlers) SiteInstanceAcknowledgeNotice 

func (h *Handlers) SiteInstanceAcknowledgeNotice(ctx context.Context) (siteapi.SiteInstanceAcknowledgeNoticeRes, error)

SiteInstanceAcknowledgeNotice records that an Owner saw the one-time notice.

func (*Handlers) SiteInstanceGetState 

func (h *Handlers) SiteInstanceGetState(ctx context.Context) (siteapi.SiteInstanceGetStateRes, error)

SiteInstanceGetState returns the Instance state to an Owner of the oldest Workspace.

func (*Handlers) SiteInstancePreviewTelemetryReport 

func (h *Handlers) SiteInstancePreviewTelemetryReport(ctx context.Context) (siteapi.SiteInstancePreviewTelemetryReportRes, error)

SiteInstancePreviewTelemetryReport returns the Telemetry report exactly as the Instance would send it now, whether or not sending is on. It is the body of the same builder the daily sender uses, so the Owner reads the real payload.

func (*Handlers) SiteInstanceSetTelemetry 

func (h *Handlers) SiteInstanceSetTelemetry(ctx context.Context, req *siteapi.SiteInstanceTelemetryInput) (siteapi.SiteInstanceSetTelemetryRes, error)

SiteInstanceSetTelemetry stores the Owner's Telemetry report choice; 409 while the environment decides.

func (*Handlers) SiteIntegrationsArchive 

func (h *Handlers) SiteIntegrationsArchive(ctx context.Context, params siteapi.SiteIntegrationsArchiveParams) (siteapi.SiteIntegrationsArchiveRes, error)

SiteIntegrationsArchive archives an integration (ADR 0049): it leaves the list and gives up the default, unless live work uses it (409). Owners and admins only.

func (*Handlers) SiteIntegrationsCreate 

func (h *Handlers) SiteIntegrationsCreate(ctx context.Context, req *siteapi.SiteCreateIntegrationInput, params siteapi.SiteIntegrationsCreateParams) (siteapi.SiteIntegrationsCreateRes, error)

SiteIntegrationsCreate stores a new provider integration; credentials are encrypted at rest and never returned. Owners and admins only.

func (*Handlers) SiteIntegrationsGet 

func (h *Handlers) SiteIntegrationsGet(ctx context.Context, params siteapi.SiteIntegrationsGetParams) (siteapi.SiteIntegrationsGetRes, error)

SiteIntegrationsGet returns one integration with secrets redacted.

func (*Handlers) SiteIntegrationsList 

func (h *Handlers) SiteIntegrationsList(ctx context.Context, params siteapi.SiteIntegrationsListParams) (siteapi.SiteIntegrationsListRes, error)

SiteIntegrationsList returns the workspace's sending-provider integrations with secrets redacted.

func (*Handlers) SiteIntegrationsRegenerateKey 

func (h *Handlers) SiteIntegrationsRegenerateKey(ctx context.Context, params siteapi.SiteIntegrationsRegenerateKeyParams) (siteapi.SiteIntegrationsRegenerateKeyRes, error)

SiteIntegrationsRegenerateKey gives the integration a new hook key; the old hook URL stops working at once. Owners and admins only.

func (*Handlers) SiteIntegrationsUnarchive 

func (h *Handlers) SiteIntegrationsUnarchive(ctx context.Context, params siteapi.SiteIntegrationsUnarchiveParams) (siteapi.SiteIntegrationsUnarchiveRes, error)

SiteIntegrationsUnarchive restores an archived integration to the list. It is not the default. Owners and admins only.

func (*Handlers) SiteIntegrationsUpdate 

func (h *Handlers) SiteIntegrationsUpdate(ctx context.Context, req *siteapi.SiteUpdateIntegrationInput, params siteapi.SiteIntegrationsUpdateParams) (siteapi.SiteIntegrationsUpdateRes, error)

SiteIntegrationsUpdate edits an integration. Omitting config keeps the stored credentials; a supplied config must match the integration's provider kind. Within a supplied config, blank secret fields (password, secret access key) keep the stored secret rather than clearing it, since secrets are never echoed back on read — so a partial edit cannot accidentally wipe a credential.

func (*Handlers) SiteInvitationsCreate 

func (h *Handlers) SiteInvitationsCreate(ctx context.Context, req *siteapi.SiteCreateInvitationInput, params siteapi.SiteInvitationsCreateParams) (siteapi.SiteInvitationsCreateRes, error)

SiteInvitationsCreate invites an email address to the workspace. Owner/admin only. The one-time accept link is returned (copy-link path) and an invite email is sent best-effort — a missing/failed mailer must not fail the invite.

func (*Handlers) SiteInvitationsDelete 

func (h *Handlers) SiteInvitationsDelete(ctx context.Context, params siteapi.SiteInvitationsDeleteParams) (siteapi.SiteInvitationsDeleteRes, error)

SiteInvitationsDelete revokes a pending invitation. Owner/admin only.

func (*Handlers) SiteInvitationsList 

func (h *Handlers) SiteInvitationsList(ctx context.Context, params siteapi.SiteInvitationsListParams) (siteapi.SiteInvitationsListRes, error)

SiteInvitationsList returns the workspace's pending (unaccepted) invitations.

func (*Handlers) SiteJoinDomainsAdd 

func (h *Handlers) SiteJoinDomainsAdd(ctx context.Context, req *siteapi.SiteAddJoinDomainInput, params siteapi.SiteJoinDomainsAddParams) (siteapi.SiteJoinDomainsAddRes, error)

SiteJoinDomainsAdd adds a pending Join domain. Owners only.

func (*Handlers) SiteJoinDomainsList 

func (h *Handlers) SiteJoinDomainsList(ctx context.Context, params siteapi.SiteJoinDomainsListParams) (siteapi.SiteJoinDomainsListRes, error)

SiteJoinDomainsList lists the Workspace's Join domains. Owners only.

func (*Handlers) SiteJoinDomainsRemove 

func (h *Handlers) SiteJoinDomainsRemove(ctx context.Context, params siteapi.SiteJoinDomainsRemoveParams) (siteapi.SiteJoinDomainsRemoveRes, error)

SiteJoinDomainsRemove removes a Join domain claim. Owners only.

func (*Handlers) SiteJoinDomainsVerify 

func (h *Handlers) SiteJoinDomainsVerify(ctx context.Context, params siteapi.SiteJoinDomainsVerifyParams) (siteapi.SiteJoinDomainsVerifyRes, error)

SiteJoinDomainsVerify checks the TXT record live and verifies the domain. Owners only.

func (*Handlers) SiteMembershipsDelete 

func (h *Handlers) SiteMembershipsDelete(ctx context.Context, params siteapi.SiteMembershipsDeleteParams) (siteapi.SiteMembershipsDeleteRes, error)

SiteMembershipsDelete removes a member. Owner/admin only; the last owner cannot be removed.

func (*Handlers) SiteMembershipsList 

func (h *Handlers) SiteMembershipsList(ctx context.Context, params siteapi.SiteMembershipsListParams) (siteapi.SiteMembershipsListRes, error)

SiteMembershipsList returns the workspace's members. Any member may view them.

func (*Handlers) SiteMembershipsResetSecondFactor 

func (h *Handlers) SiteMembershipsResetSecondFactor(ctx context.Context, params siteapi.SiteMembershipsResetSecondFactorParams) (siteapi.SiteMembershipsResetSecondFactorRes, error)

SiteMembershipsResetSecondFactor resets a member's Second factor (ADR 0020): owner/admin only, owner-only for an owner's. It ends every session of the member and records `user.second_factor_reset` in this Workspace; the acting session is someone else's, so nothing is reissued. A member resets nobody, and nobody resets their own here (disabling takes a password and a code).

func (*Handlers) SiteMembershipsUpdate 

func (h *Handlers) SiteMembershipsUpdate(ctx context.Context, req *siteapi.SiteUpdateMembershipInput, params siteapi.SiteMembershipsUpdateParams) (siteapi.SiteMembershipsUpdateRes, error)

SiteMembershipsUpdate changes a member's role. Owner/admin only; only an owner may grant the owner role, and the last owner can never be demoted.

func (*Handlers) SiteOAuthDecide 

func (h *Handlers) SiteOAuthDecide(ctx context.Context, req *siteapi.SiteOAuthDecisionInput) (siteapi.SiteOAuthDecideRes, error)

SiteOAuthDecide records the signed-in user's consent decision. The token the client later receives belongs to the chosen workspace, which the user must be a member of with a role that may manage API tokens: consent mints one.

func (*Handlers) SiteOAuthDescribe 

func (h *Handlers) SiteOAuthDescribe(ctx context.Context, params siteapi.SiteOAuthDescribeParams) (siteapi.SiteOAuthDescribeRes, error)

SiteOAuthDescribe validates an OAuth authorization request for the consent screen (the client is untrusted: only its registered redirect URIs are honored).

func (*Handlers) SitePasskeyLoginBegin 

func (h *Handlers) SitePasskeyLoginBegin(context.Context) (siteapi.SitePasskeyLoginBeginRes, error)

SitePasskeyLoginBegin answers the request options for a usernameless Passkey login and sets the ceremony cookie. It is anonymous and writes nothing (ADR 0052).

func (*Handlers) SitePasskeyLoginFinish 

func (h *Handlers) SitePasskeyLoginFinish(ctx context.Context, req *siteapi.SitePasskeyLoginInput, params siteapi.SitePasskeyLoginFinishParams) (siteapi.SitePasskeyLoginFinishRes, error)

SitePasskeyLoginFinish logs in with the authenticator's response. It runs through the login module as its third step: the User is found by the credential id, the Login throttle is consulted for that User before anything is verified, and every other refusal (an unknown credential, a response that does not verify, a spent or expired challenge, the verification gate) is the one 401 and counts nothing. The session is issued through the one issuer, with the Passkey method: it replaces the password and the Second factor.

func (*Handlers) SitePasskeysBeginCheck 

func (h *Handlers) SitePasskeysBeginCheck(ctx context.Context) (siteapi.SitePasskeysBeginCheckRes, error)

SitePasskeysBeginCheck answers the request options of a fresh Passkey check of the session User, who holds at least one Passkey, and sets the ceremony cookie.

func (*Handlers) SitePasskeysBeginRegistration 

func (h *Handlers) SitePasskeysBeginRegistration(ctx context.Context) (siteapi.SitePasskeysBeginRegistrationRes, error)

SitePasskeysBeginRegistration answers the creation options for the browser and sets the ceremony cookie. It writes nothing.

func (*Handlers) SitePasskeysFinishCheck 

func (h *Handlers) SitePasskeysFinishCheck(ctx context.Context, req *siteapi.SitePasskeyCheckInput, params siteapi.SitePasskeysFinishCheckParams) (siteapi.SitePasskeysFinishCheckRes, error)

SitePasskeysFinishCheck verifies a fresh Passkey check: the response must be made with a Passkey of the session's own User and verify against the ceremony. The acting session is reissued with the time of the check, which stands in for the password for a few minutes (identityProofTTL). Every refusal is the one 403: there is nothing to throttle, a guess cannot succeed without the private key.

func (*Handlers) SitePasskeysFinishRegistration 

func (h *Handlers) SitePasskeysFinishRegistration(ctx context.Context, req *siteapi.SitePasskeyRegistrationInput, params siteapi.SitePasskeysFinishRegistrationParams) (siteapi.SitePasskeysFinishRegistrationRes, error)

SitePasskeysFinishRegistration stores the Passkey once the User proves their identity (the password, or a fresh provider login) and the authenticator's response checks out. It ends the other sessions, reissues the acting one and mails the owner.

func (*Handlers) SitePasskeysList 

func (h *Handlers) SitePasskeysList(ctx context.Context) (*siteapi.SitePasskeyList, error)

SitePasskeysList lists the session User's Passkeys, oldest first (ADR 0052).

func (*Handlers) SitePasskeysRemove 

func (h *Handlers) SitePasskeysRemove(ctx context.Context, req *siteapi.SitePasskeyRemoveInput, params siteapi.SitePasskeysRemoveParams) (siteapi.SitePasskeysRemoveRes, error)

SitePasskeysRemove removes a Passkey of the session User once they prove their identity (the password, or a fresh provider login). It ends the other sessions, reissues the acting one and mails the owner.

func (*Handlers) SitePasskeysRename 

func (h *Handlers) SitePasskeysRename(ctx context.Context, req *siteapi.SitePasskeyRenameInput, params siteapi.SitePasskeysRenameParams) (siteapi.SitePasskeysRenameRes, error)

SitePasskeysRename renames a Passkey of the session User.

func (*Handlers) SitePresetsList 

func (h *Handlers) SitePresetsList(_ context.Context) ([]siteapi.SitePresetResource, error)

SitePresetsList returns the Presets the Instance offers with their params schemas.

func (*Handlers) SitePublicConfirmationsPerform 

func (h *Handlers) SitePublicConfirmationsPerform(ctx context.Context, params siteapi.SitePublicConfirmationsPerformParams) (siteapi.SitePublicConfirmationsPerformRes, error)

SitePublicConfirmationsPerform is the double opt-in confirmation page's button (ADR 0013): the one place a confirmation is performed.

func (*Handlers) SitePublicInvitationsAccept 

func (h *Handlers) SitePublicInvitationsAccept(ctx context.Context, req *siteapi.SiteAcceptInvitationInput, params siteapi.SitePublicInvitationsAcceptParams) (siteapi.SitePublicInvitationsAcceptRes, error)

SitePublicInvitationsAccept turns an invite into a Membership: it attaches an Verified User (their own session) or sets up the account (name + password), then joins them to the workspace. Link possession authorizes an address with no Verified User; a Verified User's address also needs that User's session.

func (*Handlers) SitePublicInvitationsLookup 

func (h *Handlers) SitePublicInvitationsLookup(ctx context.Context, params siteapi.SitePublicInvitationsLookupParams) (siteapi.SitePublicInvitationsLookupRes, error)

SitePublicInvitationsLookup reveals a pending invite (workspace + email) so the public accept page can render. Session-less: the token is the authorization.

func (*Handlers) SitePublicUnsubscribesPerform 

func (h *Handlers) SitePublicUnsubscribesPerform(ctx context.Context, params siteapi.SitePublicUnsubscribesPerformParams) (siteapi.SitePublicUnsubscribesPerformRes, error)

SitePublicUnsubscribesPerform is the unsubscribe page's button (ADR 0012): the same effect as POST /e/u/{token}, which stays for the mailbox one-click POST.

func (*Handlers) SiteRuleFiringsList 

func (h *Handlers) SiteRuleFiringsList(ctx context.Context, params siteapi.SiteRuleFiringsListParams) (siteapi.SiteRuleFiringsListRes, error)

SiteRuleFiringsList lists a Rule's Firings, newest first.

func (*Handlers) SiteRulesActivate 

func (h *Handlers) SiteRulesActivate(ctx context.Context, params siteapi.SiteRulesActivateParams) (siteapi.SiteRulesActivateRes, error)

SiteRulesActivate makes the Rule react to the Events recorded from now on.

func (*Handlers) SiteRulesArchive 

func (h *Handlers) SiteRulesArchive(ctx context.Context, params siteapi.SiteRulesArchiveParams) (siteapi.SiteRulesArchiveRes, error)

SiteRulesArchive archives a Rule (ADR 0049): it acts on nothing and keeps its Firings.

func (*Handlers) SiteRulesCreate 

func (h *Handlers) SiteRulesCreate(ctx context.Context, req *siteapi.SiteCreateRuleInput, params siteapi.SiteRulesCreateParams) (siteapi.SiteRulesCreateRes, error)

SiteRulesCreate always stores a draft.

func (*Handlers) SiteRulesDeactivate 

func (h *Handlers) SiteRulesDeactivate(ctx context.Context, params siteapi.SiteRulesDeactivateParams) (siteapi.SiteRulesDeactivateRes, error)

func (*Handlers) SiteRulesDelete 

func (h *Handlers) SiteRulesDelete(ctx context.Context, params siteapi.SiteRulesDeleteParams) (siteapi.SiteRulesDeleteRes, error)

SiteRulesDelete purges a Rule that has no Firings; one with Firings is archived instead (409).

func (*Handlers) SiteRulesDryRun 

func (h *Handlers) SiteRulesDryRun(ctx context.Context, req *siteapi.SiteDryRunRuleInput, params siteapi.SiteRulesDryRunParams) (siteapi.SiteRulesDryRunRes, error)

SiteRulesDryRun reports what a stored Event would do to the Rule, writing and running nothing.

func (*Handlers) SiteRulesGet 

func (h *Handlers) SiteRulesGet(ctx context.Context, params siteapi.SiteRulesGetParams) (siteapi.SiteRulesGetRes, error)

func (*Handlers) SiteRulesList 

func (h *Handlers) SiteRulesList(ctx context.Context, params siteapi.SiteRulesListParams) (siteapi.SiteRulesListRes, error)

func (*Handlers) SiteRulesUnarchive 

func (h *Handlers) SiteRulesUnarchive(ctx context.Context, params siteapi.SiteRulesUnarchiveParams) (siteapi.SiteRulesUnarchiveRes, error)

SiteRulesUnarchive restores an archived Rule to the list, as a draft.

func (*Handlers) SiteRulesUpdate 

func (h *Handlers) SiteRulesUpdate(ctx context.Context, req *siteapi.SiteUpdateRuleInput, params siteapi.SiteRulesUpdateParams) (siteapi.SiteRulesUpdateRes, error)

func (*Handlers) SiteSecondFactorConfirmEnrollment 

func (h *Handlers) SiteSecondFactorConfirmEnrollment(ctx context.Context, req *siteapi.SiteSecondFactorConfirmInput) (siteapi.SiteSecondFactorConfirmEnrollmentRes, error)

SiteSecondFactorConfirmEnrollment activates the pending secret with the password and a valid code, returns the Recovery codes once and reissues the acting session (the epoch moved).

func (*Handlers) SiteSecondFactorDisable 

func (h *Handlers) SiteSecondFactorDisable(ctx context.Context, req *siteapi.SiteSecondFactorDisableInput) (siteapi.SiteSecondFactorDisableRes, error)

SiteSecondFactorDisable removes the Second factor after the password and a current code are proven, and reissues the acting session.

func (*Handlers) SiteSecondFactorGetStatus 

func (h *Handlers) SiteSecondFactorGetStatus(ctx context.Context) (*siteapi.SiteSecondFactorStatus, error)

SiteSecondFactorGetStatus answers whether the User has a Second factor, a pending enrollment, and how many Recovery codes are left (never the codes).

func (*Handlers) SiteSecondFactorRegenerateRecoveryCodes 

func (h *Handlers) SiteSecondFactorRegenerateRecoveryCodes(ctx context.Context, req *siteapi.SiteRecoveryCodesInput) (siteapi.SiteSecondFactorRegenerateRecoveryCodesRes, error)

SiteSecondFactorRegenerateRecoveryCodes replaces the Recovery codes after the password is proven, and reissues the acting session.

func (*Handlers) SiteSecondFactorStartEnrollment 

func (h *Handlers) SiteSecondFactorStartEnrollment(ctx context.Context, req *siteapi.SiteSecondFactorStartInput) (siteapi.SiteSecondFactorStartEnrollmentRes, error)

SiteSecondFactorStartEnrollment creates a pending TOTP secret (ADR 0020) once the password is proven: a hijacked session alone cannot enroll a factor of its own.

func (*Handlers) SiteSegmentContactsList 

func (h *Handlers) SiteSegmentContactsList(ctx context.Context, params siteapi.SiteSegmentContactsListParams) (siteapi.SiteSegmentContactsListRes, error)

SiteSegmentContactsList lists the Contacts a Segment matches right now: its rule alone, like the Segment's count; Send-eligibility is subtracted only at send (ADR 0001).

func (*Handlers) SiteSegmentsArchive 

func (h *Handlers) SiteSegmentsArchive(ctx context.Context, params siteapi.SiteSegmentsArchiveParams) (siteapi.SiteSegmentsArchiveRes, error)

SiteSegmentsArchive archives a segment (ADR 0049): it leaves the list and new work, and a sent Broadcast's report still names it. A draft or scheduled Broadcast refuses it with 409.

func (*Handlers) SiteSegmentsCreate 

func (h *Handlers) SiteSegmentsCreate(ctx context.Context, req *siteapi.SiteCreateSegmentInput, params siteapi.SiteSegmentsCreateParams) (siteapi.SiteSegmentsCreateRes, error)

func (*Handlers) SiteSegmentsGet 

func (h *Handlers) SiteSegmentsGet(ctx context.Context, params siteapi.SiteSegmentsGetParams) (siteapi.SiteSegmentsGetRes, error)

func (*Handlers) SiteSegmentsList 

func (h *Handlers) SiteSegmentsList(ctx context.Context, params siteapi.SiteSegmentsListParams) (siteapi.SiteSegmentsListRes, error)

func (*Handlers) SiteSegmentsPreview 

func (h *Handlers) SiteSegmentsPreview(ctx context.Context, req *siteapi.SitePreviewSegmentInput, params siteapi.SiteSegmentsPreviewParams) (siteapi.SiteSegmentsPreviewRes, error)

SiteSegmentsPreview reports how many *deliverable* (active) contacts match a rule definition. It applies the same active filter the broadcast send path uses, so the previewed number matches what a broadcast to this segment ships.

func (*Handlers) SiteSegmentsUnarchive 

func (h *Handlers) SiteSegmentsUnarchive(ctx context.Context, params siteapi.SiteSegmentsUnarchiveParams) (siteapi.SiteSegmentsUnarchiveRes, error)

SiteSegmentsUnarchive restores an archived segment to the list.

func (*Handlers) SiteSegmentsUpdate 

func (h *Handlers) SiteSegmentsUpdate(ctx context.Context, req *siteapi.SiteUpdateSegmentInput, params siteapi.SiteSegmentsUpdateParams) (siteapi.SiteSegmentsUpdateRes, error)

func (*Handlers) SiteSendingDomainsArchive 

func (h *Handlers) SiteSendingDomainsArchive(ctx context.Context, params siteapi.SiteSendingDomainsArchiveParams) (siteapi.SiteSendingDomainsArchiveRes, error)

SiteSendingDomainsArchive archives a sending domain (ADR 0049): it leaves the list and serves no Tracking domain host. Live sends from it refuse it with 409.

func (*Handlers) SiteSendingDomainsCreate 

func (h *Handlers) SiteSendingDomainsCreate(ctx context.Context, req *siteapi.SiteCreateSendingDomainInput, params siteapi.SiteSendingDomainsCreateParams) (siteapi.SiteSendingDomainsCreateRes, error)

func (*Handlers) SiteSendingDomainsGet 

func (h *Handlers) SiteSendingDomainsGet(ctx context.Context, params siteapi.SiteSendingDomainsGetParams) (siteapi.SiteSendingDomainsGetRes, error)

func (*Handlers) SiteSendingDomainsList 

func (h *Handlers) SiteSendingDomainsList(ctx context.Context, params siteapi.SiteSendingDomainsListParams) (siteapi.SiteSendingDomainsListRes, error)

func (*Handlers) SiteSendingDomainsUnarchive 

func (h *Handlers) SiteSendingDomainsUnarchive(ctx context.Context, params siteapi.SiteSendingDomainsUnarchiveParams) (siteapi.SiteSendingDomainsUnarchiveRes, error)

SiteSendingDomainsUnarchive restores an archived sending domain and starts a DNS check.

func (*Handlers) SiteSendingDomainsVerify 

func (h *Handlers) SiteSendingDomainsVerify(ctx context.Context, params siteapi.SiteSendingDomainsVerifyParams) (siteapi.SiteSendingDomainsVerifyRes, error)

func (*Handlers) SiteSetupChecklistGet 

func (h *Handlers) SiteSetupChecklistGet(ctx context.Context, params siteapi.SiteSetupChecklistGetParams) (siteapi.SiteSetupChecklistGetRes, error)

SiteSetupChecklistGet maps the Workspace's Setup checklist onto the DTO.

func (*Handlers) SiteSignupSurveySubmit 

func (h *Handlers) SiteSignupSurveySubmit(ctx context.Context, req *siteapi.SiteSignupSurveyInput) (siteapi.SiteSignupSurveySubmitRes, error)

SiteSignupSurveySubmit stores the authenticated User's answers to the Sign-up survey and clears the "survey due" marker. The survey belongs to the User, so no Workspace is read.

func (*Handlers) SiteSuppressionsCreate 

func (h *Handlers) SiteSuppressionsCreate(ctx context.Context, req *siteapi.SiteCreateSuppressionInput, params siteapi.SiteSuppressionsCreateParams) (siteapi.SiteSuppressionsCreateRes, error)

func (*Handlers) SiteSuppressionsDelete 

func (h *Handlers) SiteSuppressionsDelete(ctx context.Context, params siteapi.SiteSuppressionsDeleteParams) (siteapi.SiteSuppressionsDeleteRes, error)

func (*Handlers) SiteSuppressionsList 

func (h *Handlers) SiteSuppressionsList(ctx context.Context, params siteapi.SiteSuppressionsListParams) (siteapi.SiteSuppressionsListRes, error)

func (*Handlers) SiteTagsApply 

func (h *Handlers) SiteTagsApply(ctx context.Context, req *siteapi.SiteApplyTagInput, params siteapi.SiteTagsApplyParams) (siteapi.SiteTagsApplyRes, error)

func (*Handlers) SiteTagsDelete 

func (h *Handlers) SiteTagsDelete(ctx context.Context, params siteapi.SiteTagsDeleteParams) (siteapi.SiteTagsDeleteRes, error)

SiteTagsDelete deletes a Tag from the catalogue unless a Segment rule or an Automation step names it (ADR 0049).

func (*Handlers) SiteTagsList 

func (h *Handlers) SiteTagsList(ctx context.Context, params siteapi.SiteTagsListParams) (siteapi.SiteTagsListRes, error)

func (*Handlers) SiteTagsListForContact 

func (h *Handlers) SiteTagsListForContact(ctx context.Context, params siteapi.SiteTagsListForContactParams) (siteapi.SiteTagsListForContactRes, error)

func (*Handlers) SiteTagsRemove 

func (h *Handlers) SiteTagsRemove(ctx context.Context, params siteapi.SiteTagsRemoveParams) (siteapi.SiteTagsRemoveRes, error)

func (*Handlers) SiteTemplatesCreate 

func (h *Handlers) SiteTemplatesCreate(ctx context.Context, req *siteapi.SiteCreateEmailTemplateInput, params siteapi.SiteTemplatesCreateParams) (siteapi.SiteTemplatesCreateRes, error)

func (*Handlers) SiteTemplatesDelete 

func (h *Handlers) SiteTemplatesDelete(ctx context.Context, params siteapi.SiteTemplatesDeleteParams) (siteapi.SiteTemplatesDeleteRes, error)

func (*Handlers) SiteTemplatesGet 

func (h *Handlers) SiteTemplatesGet(ctx context.Context, params siteapi.SiteTemplatesGetParams) (siteapi.SiteTemplatesGetRes, error)

func (*Handlers) SiteTemplatesList 

func (h *Handlers) SiteTemplatesList(ctx context.Context, params siteapi.SiteTemplatesListParams) (siteapi.SiteTemplatesListRes, error)

func (*Handlers) SiteTemplatesUpdate 

func (h *Handlers) SiteTemplatesUpdate(ctx context.Context, req *siteapi.SiteUpdateEmailTemplateInput, params siteapi.SiteTemplatesUpdateParams) (siteapi.SiteTemplatesUpdateRes, error)

func (*Handlers) SiteTokensCreate 

func (h *Handlers) SiteTokensCreate(ctx context.Context, req *siteapi.SiteCreateTokenInput, params siteapi.SiteTokensCreateParams) (siteapi.SiteTokensCreateRes, error)

SiteTokensCreate mints a workspace API token. The full secret is returned once; only its bcrypt hash and public prefix are stored.

func (*Handlers) SiteTokensDelete 

func (h *Handlers) SiteTokensDelete(ctx context.Context, params siteapi.SiteTokensDeleteParams) (siteapi.SiteTokensDeleteRes, error)

SiteTokensDelete revokes (soft-deletes) a workspace API token.

func (*Handlers) SiteTokensList 

func (h *Handlers) SiteTokensList(ctx context.Context, params siteapi.SiteTokensListParams) (siteapi.SiteTokensListRes, error)

SiteTokensList returns the workspace's API tokens; a revoked one stays listed, marked by its revoked_at, so an owner sees a connector that was revoked (by hand or by reuse detection).

func (*Handlers) SiteTokensUpdate 

func (h *Handlers) SiteTokensUpdate(ctx context.Context, req *siteapi.SiteUpdateTokenInput, params siteapi.SiteTokensUpdateParams) (siteapi.SiteTokensUpdateRes, error)

SiteTokensUpdate renames an active workspace API token.

func (*Handlers) SiteTransactionalEmailsList 

func (h *Handlers) SiteTransactionalEmailsList(ctx context.Context, params siteapi.SiteTransactionalEmailsListParams) (siteapi.SiteTransactionalEmailsListRes, error)

SiteTransactionalEmailsList returns the workspace's transactional send history (the Outbound messages the /api/emails surface wrote), most recent first.

func (*Handlers) SiteUserDeleteUser 

func (h *Handlers) SiteUserDeleteUser(ctx context.Context, req *siteapi.SiteDeleteUserInput) (siteapi.SiteUserDeleteUserRes, error)

SiteUserDeleteUser deletes the caller's own User at once (User deletion, ADR 0050), after the typed email, the password (through the login module's one prove path, so a wrong one is counted on the Login throttle) and, with a Second factor, a current code. The accounts operation does the rest in one transaction; this handler authenticates, proves and maps the outcomes. 

func (h *Handlers) SiteUserDeleteUserLink(ctx context.Context, req *siteapi.SiteDeleteUserLinkInput) (siteapi.SiteUserDeleteUserLinkRes, error)

SiteUserDeleteUserLink mails the one-time deletion link to a User with no password (ADR 0050): the typed email must be the User's, and the link goes to that Verified address. The token is bound to the User and their session epoch, not to the address, and works once (the deletion removes the User it names).

func (*Handlers) SiteUserEmailChange 

func (h *Handlers) SiteUserEmailChange(ctx context.Context, req *siteapi.SiteEmailChangeInput) (siteapi.SiteUserEmailChangeRes, error)

SiteUserEmailChange requests a change of the login email. It verifies the current password, and emails a confirmation link to the NEW address (or, when that address is Taken, a notice to its owner: the answer is the same) — the change only takes effect once that link is confirmed (SiteAuthConfirmEmailChange). Returns 202.

func (*Handlers) SiteUserGetMe 

func (h *Handlers) SiteUserGetMe(ctx context.Context) (*siteapi.SiteUserResource, error)

SiteUserGetMe returns the authenticated user's profile. Auth is enforced by the security handler, so SiteAuth is always present here.

func (*Handlers) SiteUserSignOutEverywhere 

func (h *Handlers) SiteUserSignOutEverywhere(ctx context.Context) (*siteapi.SiteUserSignOutEverywhereNoContent, error)

SiteUserSignOutEverywhere ends every session of the authenticated user, on every device, and clears the acting browser's cookie: no session survives.

func (*Handlers) SiteUserUpdateMe 

func (h *Handlers) SiteUserUpdateMe(ctx context.Context, req *siteapi.SiteUpdateMeInput) (siteapi.SiteUserUpdateMeRes, error)

SiteUserUpdateMe updates the authenticated user's name and/or password. Email is the login identity and is not editable here. Changing the password requires the correct current password.

func (*Handlers) SiteWebhooksCreate 

func (h *Handlers) SiteWebhooksCreate(ctx context.Context, req *siteapi.SiteCreateWebhookEndpointInput, params siteapi.SiteWebhooksCreateParams) (siteapi.SiteWebhooksCreateRes, error)

func (*Handlers) SiteWebhooksDelete 

func (h *Handlers) SiteWebhooksDelete(ctx context.Context, params siteapi.SiteWebhooksDeleteParams) (siteapi.SiteWebhooksDeleteRes, error)

func (*Handlers) SiteWebhooksGet 

func (h *Handlers) SiteWebhooksGet(ctx context.Context, params siteapi.SiteWebhooksGetParams) (siteapi.SiteWebhooksGetRes, error)

func (*Handlers) SiteWebhooksList 

func (h *Handlers) SiteWebhooksList(ctx context.Context, params siteapi.SiteWebhooksListParams) (siteapi.SiteWebhooksListRes, error)

func (*Handlers) SiteWebhooksRegenerateSecret 

func (h *Handlers) SiteWebhooksRegenerateSecret(ctx context.Context, params siteapi.SiteWebhooksRegenerateSecretParams) (siteapi.SiteWebhooksRegenerateSecretRes, error)

SiteWebhooksRegenerateSecret replaces the endpoint's signing secret and returns the endpoint with the new one.

func (*Handlers) SiteWebhooksTest 

func (h *Handlers) SiteWebhooksTest(ctx context.Context, req *siteapi.SiteTestWebhookInput, params siteapi.SiteWebhooksTestParams) (siteapi.SiteWebhooksTestRes, error)

SiteWebhooksTest sends a sample event to the endpoint and returns what the receiver answered, at once.

func (*Handlers) SiteWebhooksUpdate 

func (h *Handlers) SiteWebhooksUpdate(ctx context.Context, req *siteapi.SiteUpdateWebhookEndpointInput, params siteapi.SiteWebhooksUpdateParams) (siteapi.SiteWebhooksUpdateRes, error)
func (h *Handlers) SiteWorkspacesAccountLink(ctx context.Context, params siteapi.SiteWorkspacesAccountLinkParams) (siteapi.SiteWorkspacesAccountLinkRes, error)

SiteWorkspacesAccountLink mints the Owner's Account link token. Without the installation's configuration it answers 404 before anything else; any role but Owner is refused.

func (*Handlers) SiteWorkspacesCreate 

func (h *Handlers) SiteWorkspacesCreate(ctx context.Context, req *siteapi.SiteCreateWorkspaceInput) (siteapi.SiteWorkspacesCreateRes, error)

SiteWorkspacesCreate creates a Workspace for the authenticated User, who becomes its Owner (ADR 0043). Only a Verified User may create one.

func (*Handlers) SiteWorkspacesDelete 

func (h *Handlers) SiteWorkspacesDelete(ctx context.Context, req *siteapi.SiteDeleteWorkspaceInput, params siteapi.SiteWorkspacesDeleteParams) (siteapi.SiteWorkspacesDeleteRes, error)

SiteWorkspacesDelete deletes a Workspace (Owner only) after the typed name matches.

func (*Handlers) SiteWorkspacesLeave 

func (h *Handlers) SiteWorkspacesLeave(ctx context.Context, params siteapi.SiteWorkspacesLeaveParams) (siteapi.SiteWorkspacesLeaveRes, error)

SiteWorkspacesLeave removes the caller's own Membership (Leaving, ADR 0050). Any Role may leave; the only Owner is refused.

func (*Handlers) SiteWorkspacesList 

func (h *Handlers) SiteWorkspacesList(ctx context.Context) ([]siteapi.SiteWorkspaceResource, error)

SiteWorkspacesList returns the workspaces the authenticated user is a member of.

func (*Handlers) SiteWorkspacesListDeleted 

func (h *Handlers) SiteWorkspacesListDeleted(ctx context.Context) ([]siteapi.SiteDeletedWorkspaceResource, error)

SiteWorkspacesListDeleted lists the caller's Owner Workspaces in their deletion window.

func (*Handlers) SiteWorkspacesRestore 

func (h *Handlers) SiteWorkspacesRestore(ctx context.Context, params siteapi.SiteWorkspacesRestoreParams) (siteapi.SiteWorkspacesRestoreRes, error)

SiteWorkspacesRestore restores a Workspace in its deletion window (Owner only).

func (*Handlers) SiteWorkspacesSetSecondFactorRequirement 

func (h *Handlers) SiteWorkspacesSetSecondFactorRequirement(ctx context.Context, req *siteapi.SiteSecondFactorRequirementInput, params siteapi.SiteWorkspacesSetSecondFactorRequirementParams) (siteapi.SiteWorkspacesSetSecondFactorRequirementRes, error)

SiteWorkspacesSetSecondFactorRequirement switches the Workspace's Two-factor requirement on or off; owner and admin only. Turning it off is the one operation a User withheld by the requirement may still perform in the Workspace, so an Owner or Admin without a Second factor is never locked out of lifting it.

func (*Handlers) SiteWorkspacesSetTimezone 

func (h *Handlers) SiteWorkspacesSetTimezone(ctx context.Context, req *siteapi.SiteWorkspaceTimezoneInput, params siteapi.SiteWorkspacesSetTimezoneParams) (siteapi.SiteWorkspacesSetTimezoneRes, error)

SiteWorkspacesSetTimezone sets the Workspace time zone (Owner only, ADR 0057).

func (*Handlers) SiteWorkspacesUpdate 

func (h *Handlers) SiteWorkspacesUpdate(ctx context.Context, req *siteapi.SiteUpdateWorkspaceInput, params siteapi.SiteWorkspacesUpdateParams) (siteapi.SiteWorkspacesUpdateRes, error)

SiteWorkspacesUpdate renames a workspace (Owner and Admin only). The id never changes.

type SystemMailEnqueuer 

type SystemMailEnqueuer interface {
	// EnqueuePasswordReset queues the reset mail. With send false the job is queued
	// all the same but nothing is delivered, so forgot-password costs the same
	// for every address.
	EnqueuePasswordReset(ctx context.Context, email, token string, send bool) error
	EnqueueEmailVerification(ctx context.Context, email, token string, send bool) error
	EnqueueEmailChangeConfirm(ctx context.Context, email, token string, send bool) error
	// EnqueueAddressTakenNotice queues the tokenless notice to the owner of a Taken
	// address (ADR 0031). With send false the job is queued but its mail is dropped.
	EnqueueAddressTakenNotice(ctx context.Context, email string, send bool) error
	// EnqueueIdentityLinkedNotice queues the notice to the owner of an account that a Sign-in
	// provider was linked to silently (ADR 0048); token is its "this was not me" link.
	EnqueueIdentityLinkedNotice(ctx context.Context, email, provider, token string) error
	// EnqueueUserDeletedNotice queues the one mail that tells an address its User was deleted
	// (ADR 0050).
	EnqueueUserDeletedNotice(ctx context.Context, email string) error
	// EnqueueUserDeletionLink queues the one-time link that confirms a passwordless User's
	// deletion (ADR 0050). With send false the job is queued but its mail is dropped.
	EnqueueUserDeletionLink(ctx context.Context, email, token string, send bool) error
	// EnqueueMemberInvite sends the workspace invite email. It is best-effort:
	// the invite also returns a copy-link, so a missing/failed mailer (common on
	// self-hosted with no SMTP) must not fail the invite.
	EnqueueMemberInvite(ctx context.Context, email, inviteURL, workspaceName, inviterName string) error
	// EnqueueSecondFactorRequired emails the Workspace's Users without a Second
	// factor that its Two-factor requirement is now on, with their deadline (ADR 0020).
	EnqueueSecondFactorRequired(ctx context.Context, workspaceID int64) error
	// EnqueuePasskeyNotice queues the notice to the owner of an account that a Passkey was
	// added or removed (ADR 0052), so a change they did not make is noticed.
	EnqueuePasskeyNotice(ctx context.Context, email string, change jobs.PasskeyChange, name string) error
}

SystemMailEnqueuer schedules the self-service account emails (password reset, email verification, email-change confirmation) through the platform system sender. Same jobs enqueue seam (river prod, inline tests). The token is minted by the handler; the job builds the link.

type WelcomeEnqueuer 

type WelcomeEnqueuer interface {
	EnqueueWelcome(ctx context.Context, email, name string) error
}

WelcomeEnqueuer schedules the platform welcome email after registration. Same jobs enqueue seam (river prod, inline tests).

Source Files

View all Source files

Directories

Path Synopsis
Package resources holds goverter-generated mappers from ent entities to site API resources (the ogen *Resource DTOs), plus the custom conversions goverter cannot infer on its own.
 Package resources holds goverter-generated mappers from ent entities to site API resources (the ogen *Resource DTOs), plus the custom conversions goverter cannot infer on its own.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.