email

type BillingEmailChangedEmail struct {
	RecipientInfo
	// OrgName is the organization whose billing email changed
	OrgName string `json:"org_name" jsonschema:"required,description=Organization name"`
	// OldBillingEmail is the previous billing email address
	OldBillingEmail string `json:"old_billing_email" jsonschema:"required,description=Previous billing email"`
	// NewBillingEmail is the new billing email address
	NewBillingEmail string `json:"new_billing_email" jsonschema:"required,description=New billing email"`
	// ChangedAt is the timestamp of the change
	ChangedAt time.Time `json:"changed_at" jsonschema:"required,description=Timestamp of the change"`
}

type BrandedMessageRequest struct {
	RecipientInfo
	CampaignContext
	// Subject is the email subject line
	Subject string `json:"subject" jsonschema:"required,description=Email subject line"`
	// Preheader is hidden preview text shown in the inbox list
	Preheader string `json:"preheader,omitempty" jsonschema:"description=Inbox preview text"`
	// Title is the headline shown above the body paragraphs
	Title string `json:"title" jsonschema:"required,description=Email headline"`
	// Intros are body paragraphs rendered before the optional call-to-action button
	Intros []string `json:"intros,omitempty" jsonschema:"description=Body paragraphs rendered before the call-to-action"`
	// ButtonText is the optional call-to-action button label
	ButtonText string `json:"buttonText,omitempty" jsonschema:"description=Call-to-action button label"`
	// ButtonLink is the URL the call-to-action button navigates to
	ButtonLink string `json:"buttonLink,omitempty" jsonschema:"description=Call-to-action button URL"`
	// Outros are fine-print paragraphs rendered after the call-to-action
	Outros []string `json:"outros,omitempty" jsonschema:"description=Fine-print paragraphs rendered after the call-to-action"`
	// LogoURL overrides the hero logo displayed in the email body for this send
	LogoURL string `json:"logoURL,omitempty" jsonschema:"description=Hero logo URL override for this send"`
	// HeaderLogoURL overrides the small logo/icon in the top header bar for this send
	HeaderLogoURL string `json:"headerLogoURL,omitempty" jsonschema:"description=Header bar logo/icon URL override for this send"`
	// PrimaryColor overrides the headline/emphasis color for this send
	PrimaryColor string `json:"primaryColor,omitempty" jsonschema:"description=Primary headline color override (hex)"`
	// BodyBackgroundColor overrides the outer page background color for this send
	BodyBackgroundColor string `json:"bodyBackgroundColor,omitempty" jsonschema:"description=Outer page background color override (hex)"`
	// CardBackgroundColor overrides the card container background color for this send
	CardBackgroundColor string `json:"cardBackgroundColor,omitempty" jsonschema:"description=Card container background color override (hex)"`
	// HeroBackgroundColor overrides the hero banner background color for this send
	HeroBackgroundColor string `json:"heroBackgroundColor,omitempty" jsonschema:"description=Hero banner background color override (hex)"`
	// ButtonColor overrides the call-to-action button background color for this send
	ButtonColor string `json:"buttonColor,omitempty" jsonschema:"description=CTA button background color override (hex)"`
	// ButtonTextColor overrides the call-to-action button text color for this send
	ButtonTextColor string `json:"buttonTextColor,omitempty" jsonschema:"description=CTA button text color override (hex)"`
	// TextColor overrides the body paragraph text color for this send
	TextColor string `json:"textColor,omitempty" jsonschema:"description=Body text color override (hex)"`
	// FooterTextColor overrides the muted text color for this send
	FooterTextColor string `json:"footerTextColor,omitempty" jsonschema:"description=Muted text color override (hex)"`
}

type CampaignContext struct {
	// CampaignID is the identifier of the campaign producing the send
	CampaignID string `json:"campaignId,omitempty" jsonschema:"description=Campaign identifier"`
	// CampaignName is the display name of the campaign
	CampaignName string `json:"campaignName,omitempty" jsonschema:"description=Campaign display name"`
	// CampaignDescription is the long-form description of the campaign
	CampaignDescription string `json:"campaignDescription,omitempty" jsonschema:"description=Campaign description"`
	// CampaignDueDate is the response deadline for the campaign, formatted for display
	CampaignDueDate string `json:"campaignDueDate,omitempty" jsonschema:"description=Campaign response due date"`
}

type CampaignDispatchInput struct {
	// CampaignID is the identifier of the campaign to dispatch
	CampaignID string `json:"campaignId" jsonschema:"required,description=Campaign identifier"`
	// Resend allows previously sent, incomplete targets to receive another message
	Resend bool `json:"resend,omitempty" jsonschema:"description=Whether to include previously sent targets"`
	// IncludeOverdue includes overdue targets when dispatching incomplete recipients
	IncludeOverdue bool `json:"includeOverdue,omitempty" jsonschema:"description=Whether overdue targets should be included"`
}

type CampaignDispatchResult struct {
	// SentCount is the number of messages successfully sent
	SentCount int `json:"sentCount"`
	// SkippedCount is the number of targets skipped (already sent, completed, filtered)
	SkippedCount int `json:"skippedCount"`
	// FailedCount is the number of targets that failed to render or send
	FailedCount int `json:"failedCount"`
}

type Client struct {
	// Sender is the configured email provider client
	Sender newman.EmailSender
	// Config holds branding and URL configuration for template rendering
	Config RuntimeEmailConfig
}

type Credential struct {
	// APIKey is the email provider API key
	APIKey string `json:"apiKey" jsonschema:"required,description=Email provider API key"`
	// Provider is the email service provider name
	Provider string `json:"provider" jsonschema:"required,enum=resend,enum=sendgrid,enum=postmark,description=Email service provider"`
}

type Dispatcher interface {
	// Name returns the catalog key identifying the dispatcher
	Name() string
	// Registration returns the integration operation registration for this entry
	Registration() types.OperationRegistration
	// SendByKey decodes the payload into the entry's typed input, runs any registered PreHook,
	// and dispatches through the shared render/send pipeline. Additional newman options are
	// appended after the operation's own MessageOptions
	SendByKey(ctx context.Context, req types.OperationRequest, client *Client, payload json.RawMessage, extraOpts ...newman.MessageOption) error
	// RenderMessage decodes the payload and renders the email into a newman message without sending it, for use in batch send paths
	RenderMessage(ctx context.Context, client *Client, payload json.RawMessage, extraOpts ...newman.MessageOption) (*newman.EmailMessage, error)
}

type HealthCheck struct{}

type InviteJoinedRequest struct {
	RecipientInfo
	// OrgName is the organization the user joined
	OrgName string `json:"org_name" jsonschema:"required,description=Organization name"`
}

type InviteRequest struct {
	RecipientInfo
	// InviterName is the name of the person who sent the invite
	InviterName string `json:"inviter_name" jsonschema:"required,description=Name of the person sending the invite"`
	// OrgName is the organization being invited to
	OrgName string `json:"org_name" jsonschema:"required,description=Organization name"`
	// Role is the invited role
	Role string `json:"role,omitempty" jsonschema:"description=Invited role"`
	// Token is the invite token appended to the invite URL
	Token string `json:"token" jsonschema:"required,description=Invite token"`
}

type Operation[T Recipient] struct {
	// Op is the typed operation ref with name derived from the schema definition key
	Op types.OperationRef[T]
	// Schema is the reflected JSON schema for the input type
	Schema json.RawMessage
	// Description is the human-readable summary shown in the catalog picker
	Description string
	// CustomerSelectable gates whether the entry is exposed via the customer-facing catalog query
	CustomerSelectable *bool
	// Subject returns the rendered subject line for the email
	Subject func(cfg RuntimeEmailConfig, input T) string
	// Theme is the newman render theme applied to this email
	Theme *render.Theme
	// Build returns the structured body content for newman rendering
	Build func(cfg RuntimeEmailConfig, input T) render.ContentBody
	// Config is an optional per-op override for the installation config
	Config func(cfg RuntimeEmailConfig, input T) RuntimeEmailConfig
	// MessageOptions returns additional newman message options for per-operation customization such as attachment
	MessageOptions func(cfg RuntimeEmailConfig, input T) []newman.MessageOption
	// PreHook is an optional hook invoked before rendering to resolve dynamic fields
	PreHook func(ctx context.Context, req types.OperationRequest, input *T) error
}

type PasswordResetEmailRequest struct {
	RecipientInfo
	// Token is the password reset token appended to the reset URL
	Token string `json:"token" jsonschema:"required,description=Password reset token"`
}

type PasswordResetSuccessRequest struct {
	RecipientInfo
}

type QuestionnaireAuthEmail struct {
	RecipientInfo
	// AssessmentName is the name of the assessment/questionnaire
	AssessmentName string `json:"assessment_name" jsonschema:"required,description=Assessment name"`
	// AuthURL is the authentication URL for questionnaire access
	AuthURL string `json:"auth_url" jsonschema:"required,description=Questionnaire auth URL"`
}

type Recipient interface {
	// GetRecipient returns the RecipientInfo
	GetRecipient() RecipientInfo
}

type RecipientInfo struct {
	// Email is the recipient email address
	Email string `json:"email" jsonschema:"required,description=Recipient email address"`
	// FirstName is the recipient first name
	FirstName string `json:"firstName,omitempty" jsonschema:"description=Recipient first name"`
	// LastName is the recipient last name
	LastName string `json:"lastName,omitempty" jsonschema:"description=Recipient last name"`
	// Tags are delivery tracking tags forwarded to the email provider for webhook correlation
	Tags []newman.Tag `json:"tags,omitempty" jsonschema:"description=Delivery tracking tags"`
}

type RuntimeEmailConfig struct {
	// APIKey is the email provider API key
	APIKey string `json:"apiKey" koanf:"apiKey" jsonschema:"required,description=Email provider API key"`
	// Provider is the email service provider name (resend, sendgrid, postmark)
	Provider string `` /* 146-byte string literal not displayed */
	// FromEmail is the default sender email address
	FromEmail string `` /* 127-byte string literal not displayed */
	// SupportEmail is the support contact email address
	SupportEmail string `` /* 128-byte string literal not displayed */
	// QuestionnaireEmail is an optional sender override for questionnaire auth emails
	QuestionnaireEmail string `` /* 171-byte string literal not displayed */
	// RootURL is the root application URL used to construct email action links
	RootURL string `` /* 150-byte string literal not displayed */
	// ProductURL is the product home URL
	ProductURL string `json:"productURL" koanf:"productURL" jsonschema:"description=Product home URL" default:"https://console.theopenlane.io"`
	// DocsURL is the documentation URL
	DocsURL string `json:"docsURL" koanf:"docsURL" jsonschema:"description=Documentation URL" default:"https://docs.theopenlane.io"`
	// CompanyName is the display name of the sending company
	CompanyName string `json:"companyName" jsonschema:"description=Company display name" default:"Openlane"`
	// CompanyAddress is the mailing address of the company
	CompanyAddress string `json:"companyAddress" jsonschema:"description=Company mailing address" default:""`
	// Corporation is the legal corporation name
	Corporation string `json:"corporation" jsonschema:"description=Legal corporation name" default:"theopenlane, Inc."`
	// LogoURL is the hero logo image URL displayed prominently in the email body
	LogoURL string `json:"logoURL,omitempty" jsonschema:"description=Hero logo URL displayed in the email body"`
	// HeaderLogoURL is the small logo/icon displayed in the top header bar
	HeaderLogoURL string `` /* 243-byte string literal not displayed */
	// Copyright is an optional copyright override for email footers; when empty the template renders © {year} {corporation}
	Copyright string `` /* 176-byte string literal not displayed */
	// TroubleText is the fallback help text shown below action buttons; {ACTION} is replaced with button text at render time
	TroubleText string `` /* 271-byte string literal not displayed */
	// TermsURL is the terms of service link for email footers
	TermsURL string `` /* 150-byte string literal not displayed */
	// PrivacyURL is the privacy policy link for email footers
	PrivacyURL string `` /* 141-byte string literal not displayed */
	// UnsubscribeURL is an optional unsubscribe link override for email footers; when empty the template constructs one from ProductURL and the recipient email
	UnsubscribeURL string `` /* 180-byte string literal not displayed */
	// HeaderText is the optional text displayed in the upper-right corner of the modern theme header row
	HeaderText string `json:"headerText,omitempty" jsonschema:"description=Text displayed in the upper-right corner of the modern theme header"`
	// CardStyle controls the card visual style; elevated adds rounded corners and a drop shadow
	CardStyle string `json:"cardStyle,omitempty" jsonschema:"enum=flat,enum=elevated,description=Card visual style" default:"elevated"`
	// BodyBackgroundColor is the outer page background color
	BodyBackgroundColor string `json:"bodyBackgroundColor,omitempty" jsonschema:"description=Outer page background color" default:"#e8eaed"`
	// CardBackgroundColor is the card container background color
	CardBackgroundColor string `json:"cardBackgroundColor,omitempty" jsonschema:"description=Card container background color" default:"#ffffff"`
	// HeroBackgroundColor is the hero banner section background color
	HeroBackgroundColor string `json:"heroBackgroundColor,omitempty" jsonschema:"description=Hero banner section background color" default:"#f3f4f6"`
	// ButtonColor is the call-to-action button background color
	ButtonColor string `json:"buttonColor,omitempty" jsonschema:"description=Call-to-action button background color" default:"#14171e"`
	// ButtonTextColor is the call-to-action button text color
	ButtonTextColor string `json:"buttonTextColor,omitempty" jsonschema:"description=Call-to-action button text color" default:"#ffffff"`
	// HeadingColor is the heading and title text color
	HeadingColor string `json:"headingColor,omitempty" jsonschema:"description=Heading and title text color" default:"#14171e"`
	// TextColor is the body paragraph text color
	TextColor string `json:"textColor,omitempty" jsonschema:"description=Body paragraph text color" default:"#43454b"`
	// FooterTextColor is the muted text color for headers, footers, and secondary content
	FooterTextColor string `` /* 134-byte string literal not displayed */
	// Tagline is a short descriptive footer line rendered in modern themes above the social row
	Tagline string `` /* 126-byte string literal not displayed */
	// Social is the ordered list of social footer entries rendered by modern themes
	Social []SocialLink `json:"social,omitempty" jsonschema:"-"`
}

type SendBrandedCampaign struct{}

type SendBrandedCampaignRequest struct {
	CampaignDispatchInput
}

type SendEmail struct{}

type SendEmailRequest struct {
	// TemplateID references the email template by database ID
	TemplateID string `json:"templateId" jsonschema:"required,description=Email template ID"`
	// OwnerID is the organization owner for template resolution
	OwnerID string `json:"ownerId" jsonschema:"required,description=Organization owner ID"`
	// To is the recipient email address
	To string `json:"to" jsonschema:"required,description=Recipient email address"`
	// Tags are delivery metadata tags for provider webhook correlation
	Tags []newman.Tag `json:"tags,omitempty" jsonschema:"description=Delivery tracking tags"`
	// From is an optional sender address override
	From string `json:"from,omitempty" jsonschema:"description=Sender email address override"`
	// ReplyTo is an optional reply-to address
	ReplyTo string `json:"replyTo,omitempty" jsonschema:"description=Reply-to email address"`
}

type SendQuestionnaireCampaign struct{}

type SendQuestionnaireCampaignRequest struct {
	CampaignDispatchInput
	// TestEmail dispatches a single test questionnaire email without adding a campaign target
	TestEmail string `json:"testEmail,omitempty" jsonschema:"description=Recipient email for a test questionnaire send"`
}

type SocialLink struct {
	// Platform is the display label for the social network (e.g. X, LinkedIn)
	Platform string `json:"platform" koanf:"platform" jsonschema:"required,description=Display label for the social network"`
	// IconURL is the publicly reachable URL of the icon image
	IconURL string `json:"iconURL" koanf:"iconURL" jsonschema:"required,description=Publicly reachable icon image URL"`
	// URL is the destination the icon links to
	URL string `json:"url" koanf:"url" jsonschema:"required,description=Destination URL the icon links to"`
}

type SubscribeRequest struct {
	RecipientInfo
	// OrgName is the display name of the subscribing organization
	OrgName string `json:"org_name" jsonschema:"required,description=Organization display name"`
	// Token is the subscriber verification token appended to the verify URL
	Token string `json:"token" jsonschema:"required,description=Subscriber verification token"`
}

type TargetSendFunc func(ctx context.Context, target *generated.CampaignTarget) error

type TrustCenterAuthEmail struct {
	RecipientInfo
	// OrgName is the organization whose trust center is being accessed; resolved from TrustCenterID when empty
	OrgName string `json:"org_name,omitempty" jsonschema:"description=Organization name"`
	// RequestID is the NDA request identifier used for JWT subject construction
	RequestID string `json:"requestId,omitempty" jsonschema:"description=NDA request ID for token generation"`
	// TrustCenterID is the trust center identifier used for URL construction
	TrustCenterID string `json:"trustCenterId,omitempty" jsonschema:"description=Trust center ID for URL construction"`
	// AuthURL is the authentication URL for trust center access; when empty the operation constructs it from RequestID and TrustCenterID
	AuthURL string `json:"authUrl,omitempty" jsonschema:"description=Trust center auth URL"`
}

type TrustCenterNDARequestEmail struct {
	RecipientInfo
	// OrgName is the organization requesting the NDA; resolved from TrustCenterID when empty
	OrgName string `json:"org_name,omitempty" jsonschema:"description=Organization name"`
	// RequestID is the NDA request identifier used for JWT subject construction
	RequestID string `json:"requestId,omitempty" jsonschema:"description=NDA request ID for token generation"`
	// TrustCenterID is the trust center identifier used for URL construction
	TrustCenterID string `json:"trustCenterId,omitempty" jsonschema:"description=Trust center ID for URL construction"`
	// NDAURL is the direct URL to the NDA signing page; when empty the operation constructs it from RequestID and TrustCenterID
	NDAURL string `json:"ndaUrl,omitempty" jsonschema:"description=NDA signing URL"`
}

type TrustCenterNDASignedEmail struct {
	RecipientInfo
	// OrgName is the organization whose NDA was signed
	OrgName string `json:"org_name" jsonschema:"required,description=Organization name"`
	// TrustCenterURL is the URL to the trust center
	TrustCenterURL string `json:"trust_center_url" jsonschema:"required,description=Trust center URL"`
	// AttachmentFilename is the filename for the signed NDA attachment
	AttachmentFilename string `json:"attachment_filename,omitempty" jsonschema:"description=Signed NDA attachment filename"`
	// AttachmentData is the raw content of the signed NDA attachment
	AttachmentData []byte `json:"attachment_data,omitempty" jsonschema:"description=Signed NDA attachment content"`
}

type UserInput struct {
	// FromEmail is the default sender email address
	FromEmail string `json:"fromEmail" jsonschema:"required,description=Default sender email address"`
	// CompanyName is the display name used in email templates
	CompanyName string `json:"companyName" jsonschema:"required,description=Company display name for email templates"`
	// CompanyAddress is the mailing address for CAN-SPAM compliance
	CompanyAddress string `json:"companyAddress,omitempty" jsonschema:"description=Company mailing address"`
	// Corporation is the legal corporation name
	Corporation string `json:"corporation,omitempty" jsonschema:"description=Legal corporation name"`
	// SupportEmail is the support contact email address
	SupportEmail string `json:"supportEmail,omitempty" jsonschema:"description=Support contact email address"`
	// LogoURL is the hero logo URL displayed prominently in the email body
	LogoURL string `json:"logoURL,omitempty" jsonschema:"description=Hero logo URL displayed in the email body"`
	// HeaderLogoURL is the small logo/icon displayed in the top header bar
	HeaderLogoURL string `json:"headerLogoURL,omitempty" jsonschema:"description=Small logo or icon displayed in the top header bar"`
	// RootURL is the root application URL used to construct email action links
	RootURL string `json:"rootURL,omitempty" jsonschema:"description=Root application URL"`
	// ProductURL is the product home URL
	ProductURL string `json:"productURL,omitempty" jsonschema:"description=Product home URL"`
	// DocsURL is the documentation URL
	DocsURL string `json:"docsURL,omitempty" jsonschema:"description=Documentation URL"`
	// Copyright is the copyright notice for email footers
	Copyright string `` /* 139-byte string literal not displayed */
	// TroubleText is the fallback help text shown below action buttons
	TroubleText string `json:"troubleText,omitempty" jsonschema:"description=Help text shown below action buttons"`
	// UnsubscribeURL is the unsubscribe link for email footers
	UnsubscribeURL string `json:"unsubscribeURL,omitempty" jsonschema:"description=Unsubscribe URL for email footers"`
	// Tagline is a short descriptive footer line rendered in modern themes above the social row
	Tagline string `` /* 126-byte string literal not displayed */
	// Social is the ordered list of social footer entries rendered by modern themes
	Social []SocialLink `json:"social,omitempty" jsonschema:"-"`
	// CardStyle controls the card visual style; elevated adds rounded corners and a drop shadow
	CardStyle string `json:"cardStyle,omitempty" jsonschema:"enum=flat,enum=elevated,description=Card visual style"`
	// BodyBackgroundColor is the outer page background color
	BodyBackgroundColor string `json:"bodyBackgroundColor,omitempty" jsonschema:"description=Outer page background color"`
	// CardBackgroundColor is the card container background color
	CardBackgroundColor string `json:"cardBackgroundColor,omitempty" jsonschema:"description=Card container background color"`
	// HeroBackgroundColor is the hero banner section background color
	HeroBackgroundColor string `json:"heroBackgroundColor,omitempty" jsonschema:"description=Hero banner section background color"`
	// ButtonColor is the call-to-action button background color
	ButtonColor string `json:"buttonColor,omitempty" jsonschema:"description=Call-to-action button background color"`
	// ButtonTextColor is the call-to-action button text color
	ButtonTextColor string `json:"buttonTextColor,omitempty" jsonschema:"description=Call-to-action button text color"`
	// HeadingColor is the heading and title text color
	HeadingColor string `json:"headingColor,omitempty" jsonschema:"description=Heading and title text color"`
	// TextColor is the body paragraph text color
	TextColor string `json:"textColor,omitempty" jsonschema:"description=Body paragraph text color"`
	// FooterTextColor is the muted text color for headers, footers, and secondary content
	FooterTextColor string `json:"footerTextColor,omitempty" jsonschema:"description=Muted text color for headers footers and secondary content"`
}

type VerifyBillingRequest struct {
	RecipientInfo
	// Token is the billing verification token appended to the verify URL
	Token string `json:"token" jsonschema:"required,description=Billing verification token"`
}

type VerifyEmailRequest struct {
	RecipientInfo
	// Token is the email verification token appended to the verify URL
	Token string `json:"token" jsonschema:"required,description=Email verification token"`
}

type WelcomeRequest struct {
	RecipientInfo
}