generated_types.go

// Code generated by lettermint/sdk-generator. DO NOT EDIT.
// Spec: lettermint/lettermint@a14a098fd3173b67bc366163127ee3715457cd59 (main)
// sending-openapi.json SHA-256: 8d5e962e57d79ab08be52147c094657b681768f06940a76c8eec1b1e03df54cc
// team-openapi.json SHA-256: da4398ead370c9b61eadb4007087a6da945df3c609801325fd38fc780cc0e707
// Naming profile: next

package lettermint

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
)

// Nullable is an optional value that may also be null: absent (the zero
// value), null, or a value. Fields of this type are optional and nullable in
// the API. With the omitzero JSON tag an absent value is left out, so an
// update can tell "leave unchanged" (absent) from "clear" (null).
type Nullable[T any] struct {
	value T
	state nullableState
}

type nullableState uint8

const (
	nullableAbsent nullableState = iota
	nullableNull
	nullableValue
)

// Value returns a Nullable that holds v.
func Value[T any](v T) Nullable[T] {
	return Nullable[T]{value: v, state: nullableValue}
}

// Null returns a Nullable that is explicitly null.
func Null[T any]() Nullable[T] {
	return Nullable[T]{state: nullableNull}
}

// Get returns the value and true when n holds a value, or the zero value and
// false when n is absent or null.
func (n Nullable[T]) Get() (T, bool) {
	return n.value, n.state == nullableValue
}

// ValueOrZero returns the value, or the zero value when n is absent or null.
func (n Nullable[T]) ValueOrZero() T {
	return n.value
}

// IsNull reports whether n is explicitly null.
func (n Nullable[T]) IsNull() bool {
	return n.state == nullableNull
}

// IsSet reports whether n is present: null or a value.
func (n Nullable[T]) IsSet() bool {
	return n.state != nullableAbsent
}

// IsZero reports whether n is absent. The omitzero JSON tag uses it.
func (n Nullable[T]) IsZero() bool {
	return n.state == nullableAbsent
}

// Format prints the value, null or <absent>, so that printing a struct shows
// a Nullable like the value it holds and uses that value's own formatting.
func (n Nullable[T]) Format(f fmt.State, verb rune) {
	switch n.state {
	case nullableValue:
		fmt.Fprintf(f, fmt.FormatString(f, verb), n.value)
	case nullableNull:
		_, _ = io.WriteString(f, "null")
	default:
		_, _ = io.WriteString(f, "<absent>")
	}
}

// MarshalJSON encodes null or the value. An absent value also encodes as
// null; use the omitzero tag to leave it out. HTML characters are not
// escaped here, so the encoder of the enclosing value decides.
func (n Nullable[T]) MarshalJSON() ([]byte, error) {
	if n.state != nullableValue {
		return []byte("null"), nil
	}
	var buffer bytes.Buffer
	encoder := json.NewEncoder(&buffer)
	encoder.SetEscapeHTML(false)
	if err := encoder.Encode(n.value); err != nil {
		return nil, err
	}
	return bytes.TrimSuffix(buffer.Bytes(), []byte("\n")), nil
}

// UnmarshalJSON decodes null or a value. A property that is missing from the
// JSON leaves n absent.
func (n *Nullable[T]) UnmarshalJSON(data []byte) error {
	if string(bytes.TrimSpace(data)) == "null" {
		var zero T
		n.value, n.state = zero, nullableNull
		return nil
	}
	var value T
	if err := json.Unmarshal(data, &value); err != nil {
		return err
	}
	n.value, n.state = value, nullableValue
	return nil
}

// AnalyticsBreakdownRow: Metric values for one group of dimension values.
type AnalyticsBreakdownRow struct {
	Metrics    AnalyticsMetricValues            `json:"metrics"`
	RateBases  AnalyticsRateBases               `json:"rate_bases"`
	Previous   *AnalyticsComparisonValues       `json:"previous,omitzero"`
	Change     map[string]AnalyticsMetricChange `json:"change,omitzero"`
	Dimensions map[string]*string               `json:"dimensions"`
	Trend      []AnalyticsTimeSeriesPoint       `json:"trend,omitzero"`
}

// AnalyticsCatalogueDimension is an open enum: values the API adds later decode unchanged.
type AnalyticsCatalogueDimension string

// Known values of AnalyticsCatalogueDimension.
const (
	AnalyticsCatalogueDimensionProjectID              AnalyticsCatalogueDimension = "project_id"
	AnalyticsCatalogueDimensionRouteID                AnalyticsCatalogueDimension = "route_id"
	AnalyticsCatalogueDimensionMessageType            AnalyticsCatalogueDimension = "message_type"
	AnalyticsCatalogueDimensionSendingDomain          AnalyticsCatalogueDimension = "sending_domain"
	AnalyticsCatalogueDimensionRecipientDomain        AnalyticsCatalogueDimension = "recipient_domain"
	AnalyticsCatalogueDimensionProviderFamily         AnalyticsCatalogueDimension = "provider_family"
	AnalyticsCatalogueDimensionProviderSubtype        AnalyticsCatalogueDimension = "provider_subtype"
	AnalyticsCatalogueDimensionFromAddress            AnalyticsCatalogueDimension = "from_address"
	AnalyticsCatalogueDimensionSubject                AnalyticsCatalogueDimension = "subject"
	AnalyticsCatalogueDimensionDedicatedIP            AnalyticsCatalogueDimension = "dedicated_ip"
	AnalyticsCatalogueDimensionDedicatedPoolID        AnalyticsCatalogueDimension = "dedicated_pool_id"
	AnalyticsCatalogueDimensionInfrastructureState    AnalyticsCatalogueDimension = "infrastructure_state"
	AnalyticsCatalogueDimensionSMTPCode               AnalyticsCatalogueDimension = "smtp_code"
	AnalyticsCatalogueDimensionEnhancedStatusCode     AnalyticsCatalogueDimension = "enhanced_status_code"
	AnalyticsCatalogueDimensionEnhancedStatusCategory AnalyticsCatalogueDimension = "enhanced_status_category"
	AnalyticsCatalogueDimensionBounceClassification   AnalyticsCatalogueDimension = "bounce_classification"
	AnalyticsCatalogueDimensionFailureReason          AnalyticsCatalogueDimension = "failure_reason"
	AnalyticsCatalogueDimensionEngagementState        AnalyticsCatalogueDimension = "engagement_state"
	AnalyticsCatalogueDimensionRequestActor           AnalyticsCatalogueDimension = "request_actor"
	AnalyticsCatalogueDimensionProxyType              AnalyticsCatalogueDimension = "proxy_type"
	AnalyticsCatalogueDimensionIsHuman                AnalyticsCatalogueDimension = "is_human"
	AnalyticsCatalogueDimensionIsPrivacy              AnalyticsCatalogueDimension = "is_privacy"
	AnalyticsCatalogueDimensionIsBot                  AnalyticsCatalogueDimension = "is_bot"
	AnalyticsCatalogueDimensionIsScanner              AnalyticsCatalogueDimension = "is_scanner"
)

// AnalyticsCatalogueGroupDimension is an open enum: values the API adds later decode unchanged.
type AnalyticsCatalogueGroupDimension string

// Known values of AnalyticsCatalogueGroupDimension.
const (
	AnalyticsCatalogueGroupDimensionProjectID              AnalyticsCatalogueGroupDimension = "project_id"
	AnalyticsCatalogueGroupDimensionRouteID                AnalyticsCatalogueGroupDimension = "route_id"
	AnalyticsCatalogueGroupDimensionMessageType            AnalyticsCatalogueGroupDimension = "message_type"
	AnalyticsCatalogueGroupDimensionSendingDomain          AnalyticsCatalogueGroupDimension = "sending_domain"
	AnalyticsCatalogueGroupDimensionRecipientDomain        AnalyticsCatalogueGroupDimension = "recipient_domain"
	AnalyticsCatalogueGroupDimensionProviderFamily         AnalyticsCatalogueGroupDimension = "provider_family"
	AnalyticsCatalogueGroupDimensionProviderSubtype        AnalyticsCatalogueGroupDimension = "provider_subtype"
	AnalyticsCatalogueGroupDimensionFromAddress            AnalyticsCatalogueGroupDimension = "from_address"
	AnalyticsCatalogueGroupDimensionSubject                AnalyticsCatalogueGroupDimension = "subject"
	AnalyticsCatalogueGroupDimensionDedicatedIP            AnalyticsCatalogueGroupDimension = "dedicated_ip"
	AnalyticsCatalogueGroupDimensionDedicatedPoolID        AnalyticsCatalogueGroupDimension = "dedicated_pool_id"
	AnalyticsCatalogueGroupDimensionInfrastructureState    AnalyticsCatalogueGroupDimension = "infrastructure_state"
	AnalyticsCatalogueGroupDimensionSMTPCode               AnalyticsCatalogueGroupDimension = "smtp_code"
	AnalyticsCatalogueGroupDimensionEnhancedStatusCode     AnalyticsCatalogueGroupDimension = "enhanced_status_code"
	AnalyticsCatalogueGroupDimensionEnhancedStatusCategory AnalyticsCatalogueGroupDimension = "enhanced_status_category"
	AnalyticsCatalogueGroupDimensionBounceClassification   AnalyticsCatalogueGroupDimension = "bounce_classification"
	AnalyticsCatalogueGroupDimensionFailureReason          AnalyticsCatalogueGroupDimension = "failure_reason"
	AnalyticsCatalogueGroupDimensionSMTPResponseGroup      AnalyticsCatalogueGroupDimension = "smtp_response_group"
	AnalyticsCatalogueGroupDimensionEngagementState        AnalyticsCatalogueGroupDimension = "engagement_state"
	AnalyticsCatalogueGroupDimensionRequestActor           AnalyticsCatalogueGroupDimension = "request_actor"
	AnalyticsCatalogueGroupDimensionProxyType              AnalyticsCatalogueGroupDimension = "proxy_type"
)

// AnalyticsComparison: A comparison period.
//
// AnalyticsComparison is an open enum: values the API adds later decode unchanged.
type AnalyticsComparison string

// Known values of AnalyticsComparison.
const (
	AnalyticsComparisonPreviousPeriod AnalyticsComparison = "previous_period"
)

// AnalyticsComparisonValues: Metric values for the comparison period.
type AnalyticsComparisonValues struct {
	Metrics   AnalyticsMetricValues `json:"metrics"`
	RateBases AnalyticsRateBases    `json:"rate_bases"`
}

// AnalyticsDimension: A catalogue dimension or tag:<case-sensitive name> to filter by. is_human, is_privacy, is_bot and is_scanner select an engagement class: filter them with the value 1 to restrict engagement metrics to that class.
type AnalyticsDimension = AnalyticsCatalogueDimension

// AnalyticsFilter: A dimension filter.
type AnalyticsFilter struct {
	Dimension AnalyticsDimension `json:"dimension"`
	// eq requires one value; in and not_in require one or more values; is_null and is_not_null require no values.
	Operator AnalyticsFilterOperator `json:"operator"`
	// String values to match. Supply one for eq, one or more for in/not_in, and none for null checks. project_id and route_id take UUIDs; smtp_code takes a three-digit reply code.
	Values []string `json:"values,omitzero"`
}

// AnalyticsFilterOperator: A filter operator.
//
// AnalyticsFilterOperator is an open enum: values the API adds later decode unchanged.
type AnalyticsFilterOperator string

// Known values of AnalyticsFilterOperator.
const (
	AnalyticsFilterOperatorEq        AnalyticsFilterOperator = "eq"
	AnalyticsFilterOperatorIn        AnalyticsFilterOperator = "in"
	AnalyticsFilterOperatorNotIn     AnalyticsFilterOperator = "not_in"
	AnalyticsFilterOperatorIsNull    AnalyticsFilterOperator = "is_null"
	AnalyticsFilterOperatorIsNotNull AnalyticsFilterOperator = "is_not_null"
)

// AnalyticsGroupDimension: A catalogue dimension or tag:<case-sensitive name> to group breakdown rows by. Engagement class dimensions (is_human, is_privacy, is_bot and is_scanner) can only filter. smtp_response_group can only group: each row reads the SMTP reply of the group as its reply code, enhanced status code and response text, with addresses and other identifiers replaced by placeholders.
type AnalyticsGroupDimension = AnalyticsCatalogueGroupDimension

// AnalyticsInterval: A time-series bucket size.
//
// AnalyticsInterval is an open enum: values the API adds later decode unchanged.
type AnalyticsInterval string

// Known values of AnalyticsInterval.
const (
	AnalyticsIntervalHour AnalyticsInterval = "hour"
	AnalyticsIntervalDay  AnalyticsInterval = "day"
)

// AnalyticsMeta: The time window and data availability of the results.
type AnalyticsMeta struct {
	TimeBasis AnalyticsMetaTimeBasis `json:"time_basis"`
	Timezone  string                 `json:"timezone"`
	Interval  AnalyticsInterval      `json:"interval"`
	// Start of the window read, aligned down to the alignment grain.
	From string `json:"from"`
	// Exclusive end of the window, aligned up to the alignment grain.
	To string `json:"to"`
	// Exclusive end of the counted data: to, or generated_at while the window is ongoing.
	EffectiveTo string `json:"effective_to"`
	// Grain the requested boundaries were widened to: whole UTC hours, or whole UTC days for personal-data dimensions. Counts cover exactly from to effective_to.
	Alignment              AnalyticsMetaAlignment              `json:"alignment"`
	GeneratedAt            string                              `json:"generated_at"`
	AvailableSince         string                              `json:"available_since"`
	Partial                bool                                `json:"partial"`
	Ongoing                bool                                `json:"ongoing"`
	CollectionCompleteness AnalyticsMetaCollectionCompleteness `json:"collection_completeness"`
	// Latest ingestion among matching rollup rows. This is not a completeness watermark.
	LastIngestedAt          *string                  `json:"last_ingested_at"`
	MetricDefinitionVersion string                   `json:"metric_definition_version"`
	RankedGroupLimit        int                      `json:"ranked_group_limit"`
	Comparison              *AnalyticsMetaComparison `json:"comparison,omitzero"`
}

// AnalyticsMetaAlignment: Grain the requested boundaries were widened to: whole UTC hours, or whole UTC days for personal-data dimensions. Counts cover exactly from to effective_to.
//
// AnalyticsMetaAlignment is an open enum: values the API adds later decode unchanged.
type AnalyticsMetaAlignment string

// Known values of AnalyticsMetaAlignment.
const (
	AnalyticsMetaAlignmentHour AnalyticsMetaAlignment = "hour"
	AnalyticsMetaAlignmentDay  AnalyticsMetaAlignment = "day"
)

// AnalyticsMetaCollectionCompleteness is an open enum: values the API adds later decode unchanged.
type AnalyticsMetaCollectionCompleteness string

// Known values of AnalyticsMetaCollectionCompleteness.
const (
	AnalyticsMetaCollectionCompletenessBestEffort AnalyticsMetaCollectionCompleteness = "best_effort"
)

type AnalyticsMetaComparison struct {
	From    string `json:"from"`
	To      string `json:"to"`
	Partial bool   `json:"partial"`
}

// AnalyticsMetaTimeBasis is an open enum: values the API adds later decode unchanged.
type AnalyticsMetaTimeBasis string

// Known values of AnalyticsMetaTimeBasis.
const (
	AnalyticsMetaTimeBasisEvent AnalyticsMetaTimeBasis = "event"
)

// AnalyticsMetric: A metric from the analytics catalogue.
//
// AnalyticsMetric is an open enum: values the API adds later decode unchanged.
type AnalyticsMetric string

// Known values of AnalyticsMetric.
const (
	AnalyticsMetricAccepted                   AnalyticsMetric = "accepted"
	AnalyticsMetricProcessed                  AnalyticsMetric = "processed"
	AnalyticsMetricSuppressed                 AnalyticsMetric = "suppressed"
	AnalyticsMetricPolicyRejected             AnalyticsMetric = "policy_rejected"
	AnalyticsMetricApplicationFailed          AnalyticsMetric = "application_failed"
	AnalyticsMetricMtaAccepted                AnalyticsMetric = "mta_accepted"
	AnalyticsMetricCanceled                   AnalyticsMetric = "canceled"
	AnalyticsMetricMessages                   AnalyticsMetric = "messages"
	AnalyticsMetricDelivered                  AnalyticsMetric = "delivered"
	AnalyticsMetricBounced                    AnalyticsMetric = "bounced"
	AnalyticsMetricSoftBounced                AnalyticsMetric = "soft_bounced"
	AnalyticsMetricAdministrativelyBounced    AnalyticsMetric = "administratively_bounced"
	AnalyticsMetricDeferredRecipients         AnalyticsMetric = "deferred_recipients"
	AnalyticsMetricDeferredEvents             AnalyticsMetric = "deferred_events"
	AnalyticsMetricDeliveryAttempts           AnalyticsMetric = "delivery_attempts"
	AnalyticsMetricAttemptedRecipients        AnalyticsMetric = "attempted_recipients"
	AnalyticsMetricTransportOutcomeRecipients AnalyticsMetric = "transport_outcome_recipients"
	AnalyticsMetricEffectiveDelivered         AnalyticsMetric = "effective_delivered"
	AnalyticsMetricOpenTrackedDelivered       AnalyticsMetric = "open_tracked_delivered"
	AnalyticsMetricClickTrackedDelivered      AnalyticsMetric = "click_tracked_delivered"
	AnalyticsMetricOutOfBandBouncedRecipients AnalyticsMetric = "out_of_band_bounced_recipients"
	AnalyticsMetricOutOfBandBounceEvents      AnalyticsMetric = "out_of_band_bounce_events"
	AnalyticsMetricComplained                 AnalyticsMetric = "complained"
	AnalyticsMetricUnsubscribed               AnalyticsMetric = "unsubscribed"
	AnalyticsMetricHumanOpens                 AnalyticsMetric = "human_opens"
	AnalyticsMetricHumanOpensEvents           AnalyticsMetric = "human_opens_events"
	AnalyticsMetricHumanClicks                AnalyticsMetric = "human_clicks"
	AnalyticsMetricHumanClicksEvents          AnalyticsMetric = "human_clicks_events"
	AnalyticsMetricMachineOpens               AnalyticsMetric = "machine_opens"
	AnalyticsMetricMachineOpensEvents         AnalyticsMetric = "machine_opens_events"
	AnalyticsMetricMachineClicks              AnalyticsMetric = "machine_clicks"
	AnalyticsMetricMachineClicksEvents        AnalyticsMetric = "machine_clicks_events"
	AnalyticsMetricPrivacyOpens               AnalyticsMetric = "privacy_opens"
	AnalyticsMetricPrivacyOpensEvents         AnalyticsMetric = "privacy_opens_events"
	AnalyticsMetricPrivacyClicks              AnalyticsMetric = "privacy_clicks"
	AnalyticsMetricPrivacyClicksEvents        AnalyticsMetric = "privacy_clicks_events"
	AnalyticsMetricBotOpens                   AnalyticsMetric = "bot_opens"
	AnalyticsMetricBotOpensEvents             AnalyticsMetric = "bot_opens_events"
	AnalyticsMetricBotClicks                  AnalyticsMetric = "bot_clicks"
	AnalyticsMetricBotClicksEvents            AnalyticsMetric = "bot_clicks_events"
	AnalyticsMetricScannerOpens               AnalyticsMetric = "scanner_opens"
	AnalyticsMetricScannerOpensEvents         AnalyticsMetric = "scanner_opens_events"
	AnalyticsMetricScannerClicks              AnalyticsMetric = "scanner_clicks"
	AnalyticsMetricScannerClicksEvents        AnalyticsMetric = "scanner_clicks_events"
	AnalyticsMetricObservedOpens              AnalyticsMetric = "observed_opens"
	AnalyticsMetricObservedOpensEvents        AnalyticsMetric = "observed_opens_events"
	AnalyticsMetricObservedClicks             AnalyticsMetric = "observed_clicks"
	AnalyticsMetricObservedClicksEvents       AnalyticsMetric = "observed_clicks_events"
	AnalyticsMetricDeliveryRate               AnalyticsMetric = "delivery_rate"
	AnalyticsMetricEffectiveDeliveryRate      AnalyticsMetric = "effective_delivery_rate"
	AnalyticsMetricBounceRate                 AnalyticsMetric = "bounce_rate"
	AnalyticsMetricDeferralRate               AnalyticsMetric = "deferral_rate"
	AnalyticsMetricComplaintRate              AnalyticsMetric = "complaint_rate"
	AnalyticsMetricHumanOpenRate              AnalyticsMetric = "human_open_rate"
	AnalyticsMetricHumanClickRate             AnalyticsMetric = "human_click_rate"
	AnalyticsMetricProcessingLatencyP50Ms     AnalyticsMetric = "processing_latency_p50_ms"
	AnalyticsMetricProcessingLatencyP95Ms     AnalyticsMetric = "processing_latency_p95_ms"
	AnalyticsMetricProcessingLatencyP99Ms     AnalyticsMetric = "processing_latency_p99_ms"
	AnalyticsMetricProcessingLatencySamples   AnalyticsMetric = "processing_latency_samples"
	AnalyticsMetricDeliveryLatencyP50Ms       AnalyticsMetric = "delivery_latency_p50_ms"
	AnalyticsMetricDeliveryLatencyP95Ms       AnalyticsMetric = "delivery_latency_p95_ms"
	AnalyticsMetricDeliveryLatencyP99Ms       AnalyticsMetric = "delivery_latency_p99_ms"
	AnalyticsMetricDeliveryLatencySamples     AnalyticsMetric = "delivery_latency_samples"
	AnalyticsMetricTotalLatencyP50Ms          AnalyticsMetric = "total_latency_p50_ms"
	AnalyticsMetricTotalLatencyP95Ms          AnalyticsMetric = "total_latency_p95_ms"
	AnalyticsMetricTotalLatencyP99Ms          AnalyticsMetric = "total_latency_p99_ms"
	AnalyticsMetricTotalLatencySamples        AnalyticsMetric = "total_latency_samples"
)

// AnalyticsMetricChange: Change of a metric against the comparison period.
type AnalyticsMetricChange struct {
	Absolute         Nullable[float64] `json:"absolute,omitzero"`
	Relative         Nullable[float64] `json:"relative,omitzero"`
	PercentagePoints Nullable[float64] `json:"percentage_points,omitzero"`
}

// AnalyticsMetricValues: Values of the selected metrics. Rates are fractions; null when not available.
type AnalyticsMetricValues struct {
	Accepted                   Nullable[int]     `json:"accepted,omitzero"`
	Processed                  Nullable[int]     `json:"processed,omitzero"`
	Suppressed                 Nullable[int]     `json:"suppressed,omitzero"`
	PolicyRejected             Nullable[int]     `json:"policy_rejected,omitzero"`
	ApplicationFailed          Nullable[int]     `json:"application_failed,omitzero"`
	MtaAccepted                Nullable[int]     `json:"mta_accepted,omitzero"`
	Canceled                   Nullable[int]     `json:"canceled,omitzero"`
	Messages                   Nullable[int]     `json:"messages,omitzero"`
	Delivered                  Nullable[int]     `json:"delivered,omitzero"`
	Bounced                    Nullable[int]     `json:"bounced,omitzero"`
	SoftBounced                Nullable[int]     `json:"soft_bounced,omitzero"`
	AdministrativelyBounced    Nullable[int]     `json:"administratively_bounced,omitzero"`
	DeferredRecipients         Nullable[int]     `json:"deferred_recipients,omitzero"`
	DeferredEvents             Nullable[int]     `json:"deferred_events,omitzero"`
	DeliveryAttempts           Nullable[int]     `json:"delivery_attempts,omitzero"`
	AttemptedRecipients        Nullable[int]     `json:"attempted_recipients,omitzero"`
	TransportOutcomeRecipients Nullable[int]     `json:"transport_outcome_recipients,omitzero"`
	EffectiveDelivered         Nullable[int]     `json:"effective_delivered,omitzero"`
	OpenTrackedDelivered       Nullable[int]     `json:"open_tracked_delivered,omitzero"`
	ClickTrackedDelivered      Nullable[int]     `json:"click_tracked_delivered,omitzero"`
	OutOfBandBouncedRecipients Nullable[int]     `json:"out_of_band_bounced_recipients,omitzero"`
	OutOfBandBounceEvents      Nullable[int]     `json:"out_of_band_bounce_events,omitzero"`
	Complained                 Nullable[int]     `json:"complained,omitzero"`
	Unsubscribed               Nullable[int]     `json:"unsubscribed,omitzero"`
	HumanOpens                 Nullable[int]     `json:"human_opens,omitzero"`
	HumanOpensEvents           Nullable[int]     `json:"human_opens_events,omitzero"`
	HumanClicks                Nullable[int]     `json:"human_clicks,omitzero"`
	HumanClicksEvents          Nullable[int]     `json:"human_clicks_events,omitzero"`
	MachineOpens               Nullable[int]     `json:"machine_opens,omitzero"`
	MachineOpensEvents         Nullable[int]     `json:"machine_opens_events,omitzero"`
	MachineClicks              Nullable[int]     `json:"machine_clicks,omitzero"`
	MachineClicksEvents        Nullable[int]     `json:"machine_clicks_events,omitzero"`
	PrivacyOpens               Nullable[int]     `json:"privacy_opens,omitzero"`
	PrivacyOpensEvents         Nullable[int]     `json:"privacy_opens_events,omitzero"`
	PrivacyClicks              Nullable[int]     `json:"privacy_clicks,omitzero"`
	PrivacyClicksEvents        Nullable[int]     `json:"privacy_clicks_events,omitzero"`
	BotOpens                   Nullable[int]     `json:"bot_opens,omitzero"`
	BotOpensEvents             Nullable[int]     `json:"bot_opens_events,omitzero"`
	BotClicks                  Nullable[int]     `json:"bot_clicks,omitzero"`
	BotClicksEvents            Nullable[int]     `json:"bot_clicks_events,omitzero"`
	ScannerOpens               Nullable[int]     `json:"scanner_opens,omitzero"`
	ScannerOpensEvents         Nullable[int]     `json:"scanner_opens_events,omitzero"`
	ScannerClicks              Nullable[int]     `json:"scanner_clicks,omitzero"`
	ScannerClicksEvents        Nullable[int]     `json:"scanner_clicks_events,omitzero"`
	ObservedOpens              Nullable[int]     `json:"observed_opens,omitzero"`
	ObservedOpensEvents        Nullable[int]     `json:"observed_opens_events,omitzero"`
	ObservedClicks             Nullable[int]     `json:"observed_clicks,omitzero"`
	ObservedClicksEvents       Nullable[int]     `json:"observed_clicks_events,omitzero"`
	DeliveryRate               Nullable[float64] `json:"delivery_rate,omitzero"`
	EffectiveDeliveryRate      Nullable[float64] `json:"effective_delivery_rate,omitzero"`
	BounceRate                 Nullable[float64] `json:"bounce_rate,omitzero"`
	DeferralRate               Nullable[float64] `json:"deferral_rate,omitzero"`
	ComplaintRate              Nullable[float64] `json:"complaint_rate,omitzero"`
	HumanOpenRate              Nullable[float64] `json:"human_open_rate,omitzero"`
	HumanClickRate             Nullable[float64] `json:"human_click_rate,omitzero"`
	ProcessingLatencyP50Ms     Nullable[float64] `json:"processing_latency_p50_ms,omitzero"`
	ProcessingLatencyP95Ms     Nullable[float64] `json:"processing_latency_p95_ms,omitzero"`
	ProcessingLatencyP99Ms     Nullable[float64] `json:"processing_latency_p99_ms,omitzero"`
	ProcessingLatencySamples   Nullable[int]     `json:"processing_latency_samples,omitzero"`
	DeliveryLatencyP50Ms       Nullable[float64] `json:"delivery_latency_p50_ms,omitzero"`
	DeliveryLatencyP95Ms       Nullable[float64] `json:"delivery_latency_p95_ms,omitzero"`
	DeliveryLatencyP99Ms       Nullable[float64] `json:"delivery_latency_p99_ms,omitzero"`
	DeliveryLatencySamples     Nullable[int]     `json:"delivery_latency_samples,omitzero"`
	TotalLatencyP50Ms          Nullable[float64] `json:"total_latency_p50_ms,omitzero"`
	TotalLatencyP95Ms          Nullable[float64] `json:"total_latency_p95_ms,omitzero"`
	TotalLatencyP99Ms          Nullable[float64] `json:"total_latency_p99_ms,omitzero"`
	TotalLatencySamples        Nullable[int]     `json:"total_latency_samples,omitzero"`
}

// AnalyticsPagination: Breakdown pagination.
type AnalyticsPagination struct {
	TotalGroups    int     `json:"total_groups"`
	ReturnedGroups int     `json:"returned_groups"`
	NextCursor     *string `json:"next_cursor"`
	Truncated      bool    `json:"truncated"`
}

// AnalyticsQuery: An analytics query.
type AnalyticsQuery struct {
	// Every count is attributed to the time its event occurred, so a message accepted in one bucket can be delivered in the next. Delivery outcomes happen once per recipient, so their event counts equal recipient counts. messages counts accepted messages; mta_accepted and attempted_recipients count recipients the MTA received. Under provider, infrastructure and diagnosis dimensions, sent/attempted count delivery attempts: mta_accepted and attempted_recipients equal delivery_attempts when a query groups or filters by provider_family, provider_subtype, dedicated_ip, dedicated_pool_id, infrastructure_state or an SMTP diagnosis dimension, because the MTA assigns those values at the delivery attempt; the other lifecycle metrics return null there, and a breakdown by those dimensions omits the unknown group. deferred_recipients counts recipients delayed on the first attempt; deferred_events counts every deferral. delivery_attempts counts delivered, deferred and in-band bounced attempts. transport_outcome_recipients = delivered + bounced + soft_bounced. effective_delivered = delivered minus out-of-band bounces in the same period and can be negative for a single bucket or group. Engagement counts per class are unique per recipient, counted when the first qualifying open or click occurred; _events variants count every observation. Rates are fractions; zero denominators return null, and event-time rates can exceed 1. Latency percentiles are milliseconds read from log-scale histograms (error below 15 percent); _samples returns the sample count. Personal message dimensions support daily buckets over the message retention period. delivery_rate = delivered / transport_outcome_recipients. effective_delivery_rate = effective_delivered / transport_outcome_recipients. bounce_rate = bounced / transport_outcome_recipients. deferral_rate = deferred_events / delivery_attempts. complaint_rate = complained / delivered. human_open_rate = human_opens / open_tracked_delivered. human_click_rate = human_clicks / click_tracked_delivered.
	Metrics []AnalyticsMetric `json:"metrics"`
	// Inclusive calendar date or RFC 3339 instant. Default: 30 calendar days including today. Instants are aligned outward to whole UTC hours, or whole UTC days when from_address or subject is grouped or filtered; meta.from, meta.to, meta.effective_to and meta.alignment report the exact window used.
	From *string `json:"from,omitzero"`
	// Inclusive calendar date or exclusive RFC 3339 instant. Maximum window: 90 days. Instants are aligned outward to whole UTC hours, or whole UTC days when from_address or subject is grouped or filtered; meta.from, meta.to, meta.effective_to and meta.alignment report the exact window used.
	To *string `json:"to,omitzero"`
	// IANA time zone. Default: UTC.
	Timezone *string `json:"timezone,omitzero"`
	// Result sections. Default: summary only. breakdown requires group_by, and group_by requires breakdown.
	Include []AnalyticsSection `json:"include,omitzero"`
	// Up to three grouping dimensions for breakdown rows. Requires breakdown in include. Default: no grouping.
	GroupBy []AnalyticsGroupDimension `json:"group_by,omitzero"`
	// Dimension filters combined with AND. Default: no filters. Each metric must support every filter dimension.
	Filters []AnalyticsFilter `json:"filters,omitzero"`
	// Time-series bucket size. Default: day.
	Interval *AnalyticsInterval `json:"interval,omitzero"`
	// Compares with the preceding period of the same duration. Omit for no comparison.
	Compare *AnalyticsComparison `json:"compare,omitzero"`
	// Includes trends for breakdown rows. Requires breakdown and group_by. Default: false.
	IncludeTrend *bool `json:"include_trend,omitzero"`
	// Optional breakdown sort. Omit to use the default row order.
	Sort *AnalyticsSort `json:"sort,omitzero"`
	// Maximum breakdown rows per page. Default: 50; maximum: 200.
	Limit *int `json:"limit,omitzero"`
	// Repeat the same query with this cursor. It expires within 60 seconds.
	Cursor *string `json:"cursor,omitzero"`
}

// AnalyticsRateBase: Numerator and denominator of a rate metric.
type AnalyticsRateBase struct {
	Numerator   *int `json:"numerator"`
	Denominator *int `json:"denominator"`
}

// AnalyticsRateBases: Numerators and denominators of the selected rate metrics.
type AnalyticsRateBases struct {
	DeliveryRate          *AnalyticsRateBase `json:"delivery_rate,omitzero"`
	EffectiveDeliveryRate *AnalyticsRateBase `json:"effective_delivery_rate,omitzero"`
	BounceRate            *AnalyticsRateBase `json:"bounce_rate,omitzero"`
	DeferralRate          *AnalyticsRateBase `json:"deferral_rate,omitzero"`
	ComplaintRate         *AnalyticsRateBase `json:"complaint_rate,omitzero"`
	HumanOpenRate         *AnalyticsRateBase `json:"human_open_rate,omitzero"`
	HumanClickRate        *AnalyticsRateBase `json:"human_click_rate,omitzero"`
}

// AnalyticsResponse: Analytics results with their window metadata and pagination.
type AnalyticsResponse struct {
	Data       AnalyticsResults    `json:"data"`
	Meta       AnalyticsMeta       `json:"meta"`
	Pagination AnalyticsPagination `json:"pagination"`
}

// AnalyticsResults: The selected result sections.
type AnalyticsResults struct {
	Summary    *AnalyticsSummary          `json:"summary,omitzero"`
	TimeSeries []AnalyticsTimeSeriesPoint `json:"time_series,omitzero"`
	Breakdown  []AnalyticsBreakdownRow    `json:"breakdown,omitzero"`
}

// AnalyticsSection: A result section.
//
// AnalyticsSection is an open enum: values the API adds later decode unchanged.
type AnalyticsSection string

// Known values of AnalyticsSection.
const (
	AnalyticsSectionSummary    AnalyticsSection = "summary"
	AnalyticsSectionTimeSeries AnalyticsSection = "time_series"
	AnalyticsSectionBreakdown  AnalyticsSection = "breakdown"
)

// AnalyticsSort: A breakdown sort order.
type AnalyticsSort struct {
	// Metric used to sort breakdown rows. Must also be selected in metrics.
	Metric AnalyticsMetric `json:"metric"`
	// Ascending or descending order for the selected sort metric.
	Direction AnalyticsSortDirection `json:"direction"`
}

// AnalyticsSortDirection: Ascending or descending order for the selected sort metric.
//
// AnalyticsSortDirection is an open enum: values the API adds later decode unchanged.
type AnalyticsSortDirection string

// Known values of AnalyticsSortDirection.
const (
	AnalyticsSortDirectionAsc  AnalyticsSortDirection = "asc"
	AnalyticsSortDirectionDesc AnalyticsSortDirection = "desc"
)

// AnalyticsSummary: Metric values for the whole window.
type AnalyticsSummary struct {
	Metrics   AnalyticsMetricValues            `json:"metrics"`
	RateBases AnalyticsRateBases               `json:"rate_bases"`
	Previous  *AnalyticsComparisonValues       `json:"previous,omitzero"`
	Change    map[string]AnalyticsMetricChange `json:"change,omitzero"`
}

// AnalyticsTimeSeriesPoint: Metric values for one time-series bucket.
type AnalyticsTimeSeriesPoint struct {
	Metrics   AnalyticsMetricValues            `json:"metrics"`
	RateBases AnalyticsRateBases               `json:"rate_bases"`
	Previous  *AnalyticsComparisonValues       `json:"previous,omitzero"`
	Change    map[string]AnalyticsMetricChange `json:"change,omitzero"`
	From      string                           `json:"from"`
	To        string                           `json:"to"`
	Available bool                             `json:"available"`
	Partial   bool                             `json:"partial"`
}

// ApiErrorBody: Structured API error.
type ApiErrorBody struct {
	Error ApiErrorDetail `json:"error"`
}

type ApiErrorDetail struct {
	// Machine-readable error code, for example `RESOURCE_NOT_FOUND`.
	Code string `json:"code"`
	// Human-readable error message.
	Message string `json:"message"`
	// Additional context. Its shape depends on the error code.
	Details Nullable[any] `json:"details,omitzero"`
}

// AttachmentDelivery is an open enum: values the API adds later decode unchanged.
type AttachmentDelivery string

// Known values of AttachmentDelivery.
const (
	AttachmentDeliveryInline AttachmentDelivery = "inline"
	AttachmentDeliveryURL    AttachmentDelivery = "url"
)

// BlockedFileTypes: File types that cannot be sent as email attachments.
type BlockedFileTypes struct {
	// Blocked file extensions, without the leading dot
	Extensions []string `json:"extensions"`
	// Blocked MIME types
	MimeTypes []string `json:"mime_types"`
}

// BuiltInTeamRole is an open enum: values the API adds later decode unchanged.
type BuiltInTeamRole string

// Known values of BuiltInTeamRole.
const (
	BuiltInTeamRoleOwner  BuiltInTeamRole = "owner"
	BuiltInTeamRoleAdmin  BuiltInTeamRole = "admin"
	BuiltInTeamRoleMember BuiltInTeamRole = "member"
)

type CreateTeamInviteData struct {
	Email         string                            `json:"email"`
	RoleID        string                            `json:"role_id"`
	ProjectAccess CreateTeamInviteDataProjectAccess `json:"project_access"`
}

type CreateTeamInviteDataProjectAccess struct {
	Scope      ProjectAccessScope `json:"scope"`
	ProjectIDs []string           `json:"project_ids,omitzero"`
}

type CreateTeamRoleData struct {
	Name        string           `json:"name"`
	Description Nullable[string] `json:"description,omitzero"`
	Permissions []RbacPermission `json:"permissions"`
}

// CursorPage is a page of a cursor-paginated list. Pass NextCursor back as the
// cursor query parameter to read the next page; it is nil on the last page.
type CursorPage[T any] struct {
	Data []T `json:"data"`
	// Base path for paginator generated URLs.
	Path *string `json:"path"`
	// Number of items shown per page.
	PerPage int `json:"per_page"`
	// The "cursor" that points to the next set of items.
	NextCursor  *string `json:"next_cursor"`
	NextPageURL *string `json:"next_page_url"`
	// The "cursor" that points to the previous set of items.
	PrevCursor  *string `json:"prev_cursor"`
	PrevPageURL *string `json:"prev_page_url"`
}

type DeleteSuppressionResponse struct {
	Success bool                            `json:"success"`
	Status  DeleteSuppressionResponseStatus `json:"status"`
	// Human-readable confirmation
	Message string `json:"message"`
	// Confidence of the automated removal assessment, when one ran
	Confidence *float64 `json:"confidence,omitzero"`
	// The identifier of the support ticket that reviews the removal
	TicketIdentifier *string `json:"ticket_identifier,omitzero"`
}

// DeleteSuppressionResponseStatus is an open enum: values the API adds later decode unchanged.
type DeleteSuppressionResponseStatus string

// Known values of DeleteSuppressionResponseStatus.
const (
	DeleteSuppressionResponseStatusRemoved             DeleteSuppressionResponseStatus = "removed"
	DeleteSuppressionResponseStatusReviewTicketCreated DeleteSuppressionResponseStatus = "review_ticket_created"
	DeleteSuppressionResponseStatusReviewTicketExists  DeleteSuppressionResponseStatus = "review_ticket_exists"
)

// DeleteTeamRoleQuery holds the query parameters of DELETE /team/roles/{roleId} (deleteTeamRole).
// A zero value is not sent; booleans are pointers so that false can be sent.
type DeleteTeamRoleQuery struct {
	// Same-team non-Owner role that receives existing assignments. Required only while the deleted role is assigned.
	ReplacementRoleID string `query:"replacement_role_id"`
}

// DeliveryMode is an open enum: values the API adds later decode unchanged.
type DeliveryMode string

// Known values of DeliveryMode.
const (
	DeliveryModeLive    DeliveryMode = "live"
	DeliveryModeSandbox DeliveryMode = "sandbox"
)

// DkimMode is an open enum: values the API adds later decode unchanged.
type DkimMode string

// Known values of DkimMode.
const (
	DkimModeLegacyTxt    DkimMode = "legacy_txt"
	DkimModeManagedCname DkimMode = "managed_cname"
)

// DmarcPolicy is an open enum: values the API adds later decode unchanged.
type DmarcPolicy string

// Known values of DmarcPolicy.
const (
	DmarcPolicyNone       DmarcPolicy = "none"
	DmarcPolicyQuarantine DmarcPolicy = "quarantine"
	DmarcPolicyReject     DmarcPolicy = "reject"
)

// DnsRecordPurpose is an open enum: values the API adds later decode unchanged.
type DnsRecordPurpose string

// Known values of DnsRecordPurpose.
const (
	DnsRecordPurposeReturnPath    DnsRecordPurpose = "return_path"
	DnsRecordPurposeDmarc         DnsRecordPurpose = "dmarc"
	DnsRecordPurposeDkimLegacy    DnsRecordPurpose = "dkim_legacy"
	DnsRecordPurposeDkimPrimary   DnsRecordPurpose = "dkim_primary"
	DnsRecordPurposeDkimSecondary DnsRecordPurpose = "dkim_secondary"
)

// DnsRecordStatus: | |
// |---|
// | `active` <br/> The record is active and verified. |
// | `failed` <br/> The record could not be verified. |
// | `pending` <br/> The record is pending verification. |
//
// DnsRecordStatus is an open enum: values the API adds later decode unchanged.
type DnsRecordStatus string

// Known values of DnsRecordStatus.
const (
	DnsRecordStatusActive  DnsRecordStatus = "active"
	DnsRecordStatusFailed  DnsRecordStatus = "failed"
	DnsRecordStatusPending DnsRecordStatus = "pending"
)

// DnsRecordVerificationFailureResponse: A DNS record that did not pass verification, with the verification details.
type DnsRecordVerificationFailureResponse struct {
	// Human-readable verification error
	Message string                    `json:"message"`
	Result  DnsVerificationResultData `json:"result"`
}

// DnsVerificationError: Why a DNS record did not pass verification.
type DnsVerificationError struct {
	// The DNS record ID
	RecordID string `json:"record_id"`
	Error    string `json:"error"`
}

// DnsVerificationFailedRecord: A DNS record that did not pass verification.
type DnsVerificationFailedRecord struct {
	// The DNS record ID
	ID   string     `json:"id"`
	Type RecordType `json:"type"`
	// The record hostname
	Name string `json:"name"`
}

// DnsVerificationFailureResponse: One or more required DNS records of the domain did not pass verification.
type DnsVerificationFailureResponse struct {
	// Human-readable verification result
	Message string `json:"message"`
	// Required records that did not pass verification
	FailedRecords []DnsVerificationFailedRecord `json:"failed_records"`
	// Verification errors of every failed record, including recommended records
	Errors []DnsVerificationError `json:"errors"`
	// The number of required records that failed
	FailedCount int `json:"failed_count"`
	// The number of required records
	TotalCount int `json:"total_count"`
}

type DnsVerificationResultData struct {
	DmarcSpfAlignmentIssue *DnsVerificationResultDataDmarcSpfAlignmentIssue `json:"dmarc_spf_alignment_issue"`
	Verified               bool                                             `json:"verified"`
	Error                  *string                                          `json:"error"`
	ExpectedRecord         *string                                          `json:"expected_record"`
	FoundRecord            *string                                          `json:"found_record"`
	DmarcPolicyDomain      *string                                          `json:"dmarc_policy_domain"`
	DmarcEffectivePolicy   *DmarcPolicy                                     `json:"dmarc_effective_policy"`
}

type DnsVerificationResultDataDmarcSpfAlignmentIssue struct {
	Code               string `json:"code"`
	BlocksVerification bool   `json:"blocks_verification"`
	ReturnPathDomain   string `json:"return_path_domain"`
}

// DnsVerificationScope is an open enum: values the API adds later decode unchanged.
type DnsVerificationScope string

// Known values of DnsVerificationScope.
const (
	DnsVerificationScopeRequired    DnsVerificationScope = "required"
	DnsVerificationScopeRecommended DnsVerificationScope = "recommended"
	DnsVerificationScopeMigration   DnsVerificationScope = "migration"
	DnsVerificationScopeDeprecated  DnsVerificationScope = "deprecated"
)

// DnsVerificationSuccessResponse: All required DNS records of the domain passed verification.
type DnsVerificationSuccessResponse struct {
	// Human-readable verification result
	Message string `json:"message"`
	// Recommended records that did not pass verification. They do not block verification
	RecommendedFailedRecords []DnsVerificationFailedRecord `json:"recommended_failed_records"`
}

type DomainData struct {
	ID              string                   `json:"id"`
	Domain          string                   `json:"domain"`
	DkimMode        DkimMode                 `json:"dkim_mode"`
	RotationReady   bool                     `json:"rotation_ready"`
	StatusChangedAt *string                  `json:"status_changed_at"`
	DNSRecords      []DomainDnsRecordData    `json:"dns_records,omitzero"`
	Projects        []DomainDataProjectsItem `json:"projects,omitzero"`
	CreatedAt       string                   `json:"created_at"`
}

type DomainDataProjectsItem struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type DomainDnsRecordData struct {
	ID                      string               `json:"id"`
	Type                    RecordType           `json:"type"`
	Hostname                string               `json:"hostname"`
	Fqdn                    string               `json:"fqdn"`
	Content                 string               `json:"content"`
	Status                  DnsRecordStatus      `json:"status"`
	Purpose                 DnsRecordPurpose     `json:"purpose"`
	VerificationScope       DnsVerificationScope `json:"verification_scope"`
	RequiredForVerification bool                 `json:"required_for_verification"`
	VerifiedAt              *string              `json:"verified_at"`
	LastCheckedAt           *string              `json:"last_checked_at"`
}

type DomainListData struct {
	ID              string       `json:"id"`
	Domain          string       `json:"domain"`
	Status          DomainStatus `json:"status"`
	DkimMode        DkimMode     `json:"dkim_mode"`
	StatusChangedAt *string      `json:"status_changed_at"`
	CreatedAt       string       `json:"created_at"`
}

// DomainMutationResponse: The domain after a change, with a confirmation message.
type DomainMutationResponse struct {
	Data DomainData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}

// DomainStatus: | |
// |---|
// | `verified` <br/> The domain is active and verified. |
// | `partially_verified` <br/> Some DNS records of the domain could not be verified. |
// | `pending_verification` <br/> The domain is new and verification is pending. |
// | `failed_verification` <br/> The domain verification failed. |
//
// DomainStatus is an open enum: values the API adds later decode unchanged.
type DomainStatus string

// Known values of DomainStatus.
const (
	DomainStatusVerified            DomainStatus = "verified"
	DomainStatusPartiallyVerified   DomainStatus = "partially_verified"
	DomainStatusPendingVerification DomainStatus = "pending_verification"
	DomainStatusFailedVerification  DomainStatus = "failed_verification"
)

type DuplicateTeamRoleData struct {
	Name        string           `json:"name"`
	Description Nullable[string] `json:"description,omitzero"`
}

// ErrorMessage: Error with only a message.
type ErrorMessage struct {
	// Error overview.
	Message string `json:"message"`
}

// GetDomainQuery holds the query parameters of GET /domains/{domainId} (getDomain).
// A zero value is not sent; booleans are pointers so that false can be sent.
type GetDomainQuery struct {
	Include []GetDomainQueryIncludeItem `query:"include"`
}

// GetDomainQueryIncludeItem is an open enum: values the API adds later decode unchanged.
type GetDomainQueryIncludeItem string

// Known values of GetDomainQueryIncludeItem.
const (
	GetDomainQueryIncludeItemDNSRecords GetDomainQueryIncludeItem = "dnsRecords"
	GetDomainQueryIncludeItemProjects   GetDomainQueryIncludeItem = "projects"
)

// GetProjectQuery holds the query parameters of GET /projects/{projectId} (getProject).
// A zero value is not sent; booleans are pointers so that false can be sent.
type GetProjectQuery struct {
	Include []GetProjectQueryIncludeItem `query:"include"`
}

// GetProjectQueryIncludeItem is an open enum: values the API adds later decode unchanged.
type GetProjectQueryIncludeItem string

// Known values of GetProjectQueryIncludeItem.
const (
	GetProjectQueryIncludeItemRoutes             GetProjectQueryIncludeItem = "routes"
	GetProjectQueryIncludeItemRoutesCount        GetProjectQueryIncludeItem = "routesCount"
	GetProjectQueryIncludeItemRoutesExists       GetProjectQueryIncludeItem = "routesExists"
	GetProjectQueryIncludeItemDomains            GetProjectQueryIncludeItem = "domains"
	GetProjectQueryIncludeItemDomainsCount       GetProjectQueryIncludeItem = "domainsCount"
	GetProjectQueryIncludeItemDomainsExists      GetProjectQueryIncludeItem = "domainsExists"
	GetProjectQueryIncludeItemMessageStats       GetProjectQueryIncludeItem = "messageStats"
	GetProjectQueryIncludeItemMessageStatsCount  GetProjectQueryIncludeItem = "messageStatsCount"
	GetProjectQueryIncludeItemMessageStatsExists GetProjectQueryIncludeItem = "messageStatsExists"
)

type GetReportForwardingResponse struct {
	Data ReportForwardingResource `json:"data"`
}

// GetRouteQuery holds the query parameters of GET /routes/{routeId} (getRoute).
// A zero value is not sent; booleans are pointers so that false can be sent.
type GetRouteQuery struct {
	// Include legacy machine observations in open and click totals. Privacy opens are reported in the observed and privacy fields without this option.
	IncludeMachine *bool                      `query:"include_machine"`
	Include        []GetRouteQueryIncludeItem `query:"include"`
}

// GetRouteQueryIncludeItem is an open enum: values the API adds later decode unchanged.
type GetRouteQueryIncludeItem string

// Known values of GetRouteQueryIncludeItem.
const (
	GetRouteQueryIncludeItemProject       GetRouteQueryIncludeItem = "project"
	GetRouteQueryIncludeItemProjectCount  GetRouteQueryIncludeItem = "projectCount"
	GetRouteQueryIncludeItemProjectExists GetRouteQueryIncludeItem = "projectExists"
	GetRouteQueryIncludeItemStatistics    GetRouteQueryIncludeItem = "statistics"
)

// GetStatsQuery holds the query parameters of GET /stats (getStats).
// A zero value is not sent; booleans are pointers so that false can be sent.
type GetStatsQuery struct {
	From           string `query:"from"`
	To             string `query:"to"`
	ProjectID      string `query:"project_id"`
	IncludeMachine *bool  `query:"include_machine"`
}

// GetTeamQuery holds the query parameters of GET /team (getTeam).
// A zero value is not sent; booleans are pointers so that false can be sent.
type GetTeamQuery struct {
	Include []GetTeamQueryIncludeItem `query:"include"`
}

// GetTeamQueryIncludeItem is an open enum: values the API adds later decode unchanged.
type GetTeamQueryIncludeItem string

// Known values of GetTeamQueryIncludeItem.
const (
	GetTeamQueryIncludeItemFeatures GetTeamQueryIncludeItem = "features"
	GetTeamQueryIncludeItemAddons   GetTeamQueryIncludeItem = "addons"
)

// InboundDomainVerification: Whether the inbound domain MX records point to Lettermint. The MX record lists are only returned when verification fails.
type InboundDomainVerification struct {
	Verified bool `json:"verified"`
	// Human-readable verification result
	Message string `json:"message"`
	// The MX records the inbound domain must publish
	ExpectedMXRecords []string `json:"expected_mx_records,omitzero"`
	// The MX records found for the inbound domain
	FoundMXRecords []string `json:"found_mx_records,omitzero"`
}

// InboundDomainVerificationResponse: The result of an inbound domain MX verification.
type InboundDomainVerificationResponse struct {
	Data InboundDomainVerification `json:"data"`
}

// InitialRoutes is an open enum: values the API adds later decode unchanged.
type InitialRoutes string

// Known values of InitialRoutes.
const (
	InitialRoutesBoth          InitialRoutes = "both"
	InitialRoutesTransactional InitialRoutes = "transactional"
	InitialRoutesBroadcast     InitialRoutes = "broadcast"
)

// ListDomainsQuery holds the query parameters of GET /domains (listDomains).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListDomainsQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor string                     `query:"page[cursor]"`
	Sort       []ListDomainsQuerySortItem `query:"sort"`
	// Filter by project ID
	FilterProject string       `query:"filter[project]"`
	FilterStatus  DomainStatus `query:"filter[status]"`
	// Search by domain name (partial match, case insensitive)
	FilterDomain string `query:"filter[domain]"`
}

// ListDomainsQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListDomainsQuerySortItem string

// Known values of ListDomainsQuerySortItem.
const (
	ListDomainsQuerySortItemDomain              ListDomainsQuerySortItem = "domain"
	ListDomainsQuerySortItemDomainDesc          ListDomainsQuerySortItem = "-domain"
	ListDomainsQuerySortItemCreatedAt           ListDomainsQuerySortItem = "created_at"
	ListDomainsQuerySortItemCreatedAtDesc       ListDomainsQuerySortItem = "-created_at"
	ListDomainsQuerySortItemStatusChangedAt     ListDomainsQuerySortItem = "status_changed_at"
	ListDomainsQuerySortItemStatusChangedAtDesc ListDomainsQuerySortItem = "-status_changed_at"
)

type ListDomainsResponse = CursorPage[DomainListData]

// ListMessageEventsQuery holds the query parameters of GET /messages/{messageId}/events (listMessageEvents).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListMessageEventsQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor string `query:"page[cursor]"`
	// Include security scanner, preview, and other machine-only tracking events. Supported privacy opens are included without this option.
	IncludeMachineEvents *bool                            `query:"include_machine_events"`
	Sort                 []ListMessageEventsQuerySortItem `query:"sort"`
}

// ListMessageEventsQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListMessageEventsQuerySortItem string

// Known values of ListMessageEventsQuerySortItem.
const (
	ListMessageEventsQuerySortItemTimestamp     ListMessageEventsQuerySortItem = "timestamp"
	ListMessageEventsQuerySortItemTimestampDesc ListMessageEventsQuerySortItem = "-timestamp"
	ListMessageEventsQuerySortItemEvent         ListMessageEventsQuerySortItem = "event"
	ListMessageEventsQuerySortItemEventDesc     ListMessageEventsQuerySortItem = "-event"
)

type ListMessageEventsResponse = CursorPage[MessageEventData]

// ListMessagesQuery holds the query parameters of GET /messages (listMessages).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListMessagesQuery struct {
	Sort []ListMessagesQuerySortItem `query:"sort"`
	// Search in sender, recipients, and subject. A complete email address matches the sender, To, CC or BCC address exactly and does not search the subject.
	FilterSearch string `query:"filter[search]"`
	// Search by sender email (partial match)
	FilterFromEmail string `query:"filter[from_email]"`
	// Search by subject (partial match)
	FilterSubject string `query:"filter[subject]"`
	// Number of results per page
	PageSize int `query:"page[size]"`
	// Cursor for the next or previous page
	PageCursor    string                   `query:"page[cursor]"`
	Filter        *ListMessagesQueryFilter `query:"filter"`
	FilterTags    string                   `query:"filter[tags]"`
	FilterOverdue string                   `query:"filter[overdue]"`
	// Filter by project ID
	FilterProject      string        `query:"filter[project]"`
	FilterType         MessageType   `query:"filter[type]"`
	FilterStatus       MessageStatus `query:"filter[status]"`
	FilterDeliveryMode DeliveryMode  `query:"filter[delivery_mode]"`
	// Filter by route ID
	FilterRouteID string `query:"filter[route_id]"`
	// Filter by domain ID
	FilterDomainID string `query:"filter[domain_id]"`
	// Filter by tag name
	FilterTag string `query:"filter[tag]"`
	// Filter messages created on or after this date
	FilterFromDate string `query:"filter[from_date]"`
	// Filter messages created on or before this date
	FilterToDate string `query:"filter[to_date]"`
}

type ListMessagesQueryFilter struct {
	Tags []ListMessagesQueryFilterTagsItem `query:"tags"`
}

type ListMessagesQueryFilterTagsItem struct {
	Name  string `query:"name"`
	Value string `query:"value"`
}

// ListMessagesQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListMessagesQuerySortItem string

// Known values of ListMessagesQuerySortItem.
const (
	ListMessagesQuerySortItemType                ListMessagesQuerySortItem = "type"
	ListMessagesQuerySortItemTypeDesc            ListMessagesQuerySortItem = "-type"
	ListMessagesQuerySortItemStatus              ListMessagesQuerySortItem = "status"
	ListMessagesQuerySortItemStatusDesc          ListMessagesQuerySortItem = "-status"
	ListMessagesQuerySortItemFromEmail           ListMessagesQuerySortItem = "from_email"
	ListMessagesQuerySortItemFromEmailDesc       ListMessagesQuerySortItem = "-from_email"
	ListMessagesQuerySortItemSubject             ListMessagesQuerySortItem = "subject"
	ListMessagesQuerySortItemSubjectDesc         ListMessagesQuerySortItem = "-subject"
	ListMessagesQuerySortItemCreatedAt           ListMessagesQuerySortItem = "created_at"
	ListMessagesQuerySortItemCreatedAtDesc       ListMessagesQuerySortItem = "-created_at"
	ListMessagesQuerySortItemStatusChangedAt     ListMessagesQuerySortItem = "status_changed_at"
	ListMessagesQuerySortItemStatusChangedAtDesc ListMessagesQuerySortItem = "-status_changed_at"
	ListMessagesQuerySortItemScheduledAt         ListMessagesQuerySortItem = "scheduled_at"
	ListMessagesQuerySortItemScheduledAtDesc     ListMessagesQuerySortItem = "-scheduled_at"
)

type ListMessagesResponse = CursorPage[MessageListData]

// ListProjectsQuery holds the query parameters of GET /projects (listProjects).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListProjectsQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor   string                      `query:"page[cursor]"`
	FilterSearch string                      `query:"filter[search]"`
	Sort         []ListProjectsQuerySortItem `query:"sort"`
}

// ListProjectsQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListProjectsQuerySortItem string

// Known values of ListProjectsQuerySortItem.
const (
	ListProjectsQuerySortItemName          ListProjectsQuerySortItem = "name"
	ListProjectsQuerySortItemNameDesc      ListProjectsQuerySortItem = "-name"
	ListProjectsQuerySortItemCreatedAt     ListProjectsQuerySortItem = "created_at"
	ListProjectsQuerySortItemCreatedAtDesc ListProjectsQuerySortItem = "-created_at"
)

type ListProjectsResponse = CursorPage[ProjectListData]

// ListRoutesQuery holds the query parameters of GET /projects/{projectId}/routes (listRoutes).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListRoutesQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor      string                    `query:"page[cursor]"`
	Sort            []ListRoutesQuerySortItem `query:"sort"`
	FilterRouteType RouteType                 `query:"filter[route_type]"`
	FilterIsDefault *bool                     `query:"filter[is_default]"`
	// Search by name or slug
	FilterSearch string `query:"filter[search]"`
}

// ListRoutesQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListRoutesQuerySortItem string

// Known values of ListRoutesQuerySortItem.
const (
	ListRoutesQuerySortItemName          ListRoutesQuerySortItem = "name"
	ListRoutesQuerySortItemNameDesc      ListRoutesQuerySortItem = "-name"
	ListRoutesQuerySortItemSlug          ListRoutesQuerySortItem = "slug"
	ListRoutesQuerySortItemSlugDesc      ListRoutesQuerySortItem = "-slug"
	ListRoutesQuerySortItemCreatedAt     ListRoutesQuerySortItem = "created_at"
	ListRoutesQuerySortItemCreatedAtDesc ListRoutesQuerySortItem = "-created_at"
)

type ListRoutesResponse = CursorPage[RouteListData]

// ListSuppressionsQuery holds the query parameters of GET /suppressions (listSuppressions).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListSuppressionsQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor string                          `query:"page[cursor]"`
	Sort       []ListSuppressionsQuerySortItem `query:"sort"`
	// Filter by scope (team, project, route)
	FilterScope string `query:"filter[scope]"`
	// Filter by route ID
	FilterRouteID string `query:"filter[route_id]"`
	// Filter by project ID
	FilterProjectID string `query:"filter[project_id]"`
	// Search by email/domain value (partial match)
	FilterValue  string            `query:"filter[value]"`
	FilterReason SuppressionReason `query:"filter[reason]"`
	// Filter suppressions created or updated on or after this ISO 8601 date or datetime
	FilterStartDate string `query:"filter[startDate]"`
	// Filter suppressions created or updated on or before this ISO 8601 date or datetime
	FilterEndDate string `query:"filter[endDate]"`
}

// ListSuppressionsQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListSuppressionsQuerySortItem string

// Known values of ListSuppressionsQuerySortItem.
const (
	ListSuppressionsQuerySortItemValue         ListSuppressionsQuerySortItem = "value"
	ListSuppressionsQuerySortItemValueDesc     ListSuppressionsQuerySortItem = "-value"
	ListSuppressionsQuerySortItemCreatedAt     ListSuppressionsQuerySortItem = "created_at"
	ListSuppressionsQuerySortItemCreatedAtDesc ListSuppressionsQuerySortItem = "-created_at"
	ListSuppressionsQuerySortItemReason        ListSuppressionsQuerySortItem = "reason"
	ListSuppressionsQuerySortItemReasonDesc    ListSuppressionsQuerySortItem = "-reason"
)

type ListSuppressionsResponse = CursorPage[SuppressedRecipientData]

// ListTeamInvitesQuery holds the query parameters of GET /team/invites (listTeamInvites).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListTeamInvitesQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor string `query:"page[cursor]"`
}

type ListTeamInvitesResponse = CursorPage[TeamInviteData]

// ListTeamMembersQuery holds the query parameters of GET /team/members (listTeamMembers).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListTeamMembersQuery struct {
	// The number of results that will be returned per page.
	PageSize int `query:"page[size]"`
	// The cursor to start the pagination from.
	PageCursor string `query:"page[cursor]"`
	// Only members who can access this project: members with access to all projects and members selected for it. An unknown project returns an empty list.
	FilterProjectID string `query:"filter[project_id]"`
}

type ListTeamMembersResponse = CursorPage[TeamMemberData]

// ListWebhookDeliveriesQuery holds the query parameters of GET /webhooks/{webhookId}/deliveries (listWebhookDeliveries).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListWebhookDeliveriesQuery struct {
	// Cursor for the next or previous page.
	Cursor string                               `query:"cursor"`
	Sort   []ListWebhookDeliveriesQuerySortItem `query:"sort"`
	// Filter by delivery status
	FilterStatus WebhookDeliveryStatus `query:"filter[status]"`
	// Filter by event type
	FilterEventType string `query:"filter[event_type]"`
	// Filter deliveries from this date (Y-m-d format)
	FilterFromDate string `query:"filter[from_date]"`
	// Filter deliveries to this date (Y-m-d format)
	FilterToDate string `query:"filter[to_date]"`
}

// ListWebhookDeliveriesQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListWebhookDeliveriesQuerySortItem string

// Known values of ListWebhookDeliveriesQuerySortItem.
const (
	ListWebhookDeliveriesQuerySortItemCreatedAt         ListWebhookDeliveriesQuerySortItem = "created_at"
	ListWebhookDeliveriesQuerySortItemCreatedAtDesc     ListWebhookDeliveriesQuerySortItem = "-created_at"
	ListWebhookDeliveriesQuerySortItemAttemptNumber     ListWebhookDeliveriesQuerySortItem = "attempt_number"
	ListWebhookDeliveriesQuerySortItemAttemptNumberDesc ListWebhookDeliveriesQuerySortItem = "-attempt_number"
)

type ListWebhookDeliveriesResponse = CursorPage[WebhookDeliveryListData]

// ListWebhooksQuery holds the query parameters of GET /webhooks (listWebhooks).
// A zero value is not sent; booleans are pointers so that false can be sent.
type ListWebhooksQuery struct {
	PageSize int `query:"page[size]"`
	// Cursor for the next or previous page.
	Cursor string                      `query:"cursor"`
	Sort   []ListWebhooksQuerySortItem `query:"sort"`
	// Filter by project ID
	FilterProject string `query:"filter[project]"`
	// Filter by enabled status
	FilterEnabled *bool `query:"filter[enabled]"`
	// Filter by specific event type
	FilterEvent WebhookEvent `query:"filter[event]"`
	// Filter by route ID
	FilterRouteID string `query:"filter[route_id]"`
	// Filter by webhook scope
	FilterScope WebhookScope `query:"filter[scope]"`
	// Search by webhook name or URL
	FilterSearch string `query:"filter[search]"`
}

// ListWebhooksQuerySortItem is an open enum: values the API adds later decode unchanged.
type ListWebhooksQuerySortItem string

// Known values of ListWebhooksQuerySortItem.
const (
	ListWebhooksQuerySortItemName          ListWebhooksQuerySortItem = "name"
	ListWebhooksQuerySortItemNameDesc      ListWebhooksQuerySortItem = "-name"
	ListWebhooksQuerySortItemURL           ListWebhooksQuerySortItem = "url"
	ListWebhooksQuerySortItemURLDesc       ListWebhooksQuerySortItem = "-url"
	ListWebhooksQuerySortItemCreatedAt     ListWebhooksQuerySortItem = "created_at"
	ListWebhooksQuerySortItemCreatedAtDesc ListWebhooksQuerySortItem = "-created_at"
)

type ListWebhooksResponse = CursorPage[WebhookListData]

type MessageAttachmentData struct {
	Size        int     `json:"size"`
	Filename    string  `json:"filename"`
	ContentID   *string `json:"content_id"`
	ContentType string  `json:"content_type"`
}

// MessageAttachmentInput: A file attached to the message.
type MessageAttachmentInput struct {
	Filename string `json:"filename"`
	Content  string `json:"content"`
	// The MIME type of the attachment. Supports parameters (e.g. `text/calendar; method=REQUEST`).
	// If omitted, detected automatically from content or filename.
	ContentType Nullable[string] `json:"content_type,omitzero"`
	// Content ID for inline attachments, referenced via `cid:` in HTML body.
	// If no `@` is present, `@lm` is appended automatically.
	ContentID Nullable[string] `json:"content_id,omitzero"`
}

type MessageData struct {
	ID              string                  `json:"id"`
	Type            MessageType             `json:"type"`
	Status          MessageStatus           `json:"status"`
	DeliveryMode    DeliveryMode            `json:"delivery_mode"`
	SandboxResult   *SandboxResult          `json:"sandbox_result"`
	StatusChangedAt *string                 `json:"status_changed_at"`
	ScheduledAt     *string                 `json:"scheduled_at"`
	Tag             *string                 `json:"tag"`
	Tags            []MessageTag            `json:"tags"`
	FromEmail       string                  `json:"from_email"`
	FromName        *string                 `json:"from_name"`
	ReplyTo         []string                `json:"reply_to"`
	Subject         *string                 `json:"subject"`
	To              []MessageRecipientData  `json:"to"`
	CC              []MessageRecipientData  `json:"cc"`
	BCC             []MessageRecipientData  `json:"bcc"`
	Attachments     []MessageAttachmentData `json:"attachments"`
	Metadata        map[string]string       `json:"metadata"`
	// Overall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights
	SpamScore Nullable[float64] `json:"spam_score,omitzero"`
	// Detailed rules that contributed to the spam assessment. Available on plans with Spam Insights in individual-message responses
	SpamSymbols []SpamSymbol `json:"spam_symbols,omitzero"`
	RouteID     string       `json:"route_id"`
	CreatedAt   string       `json:"created_at"`
	// The ID of the message this message resent. Null when it is not a resend
	ResentFromMessageID Nullable[string] `json:"resent_from_message_id,omitzero"`
}

type MessageEventData struct {
	MessageID string           `json:"message_id"`
	Event     MessageEventType `json:"event"`
	Tag       *string          `json:"tag"`
	Tags      []MessageTag     `json:"tags"`
	// Event-specific metadata. For `opened` and `clicked` events, `reason_codes` and `engagement.reason_codes` list broad categories behind the bot classification: `privacy_proxy`, `image_proxy`, `link_protection`, `known_bot`, `security_network`, `timing`, `link_pattern`, `request_shape`, `unconfirmed`, `confirmed`, `sandbox` or `other`. New categories can be added. Use `classification` and `counts_for_metrics` for decisions
	Metadata  map[string]any `json:"metadata"`
	Timestamp string         `json:"timestamp"`
}

// MessageEventType is an open enum: values the API adds later decode unchanged.
type MessageEventType string

// Known values of MessageEventType.
const (
	MessageEventTypeScheduled          MessageEventType = "scheduled"
	MessageEventTypeRescheduled        MessageEventType = "rescheduled"
	MessageEventTypeCanceled           MessageEventType = "canceled"
	MessageEventTypeReleased           MessageEventType = "released"
	MessageEventTypeQueued             MessageEventType = "queued"
	MessageEventTypeProcessed          MessageEventType = "processed"
	MessageEventTypeSuppressed         MessageEventType = "suppressed"
	MessageEventTypeDelivered          MessageEventType = "delivered"
	MessageEventTypeAutoReplied        MessageEventType = "auto_replied"
	MessageEventTypeSoftBounced        MessageEventType = "soft_bounced"
	MessageEventTypeHardBounced        MessageEventType = "hard_bounced"
	MessageEventTypeSpamComplaint      MessageEventType = "spam_complaint"
	MessageEventTypeFailed             MessageEventType = "failed"
	MessageEventTypeBlocked            MessageEventType = "blocked"
	MessageEventTypePolicyRejected     MessageEventType = "policy_rejected"
	MessageEventTypeUnsubscribed       MessageEventType = "unsubscribed"
	MessageEventTypeOpened             MessageEventType = "opened"
	MessageEventTypeClicked            MessageEventType = "clicked"
	MessageEventTypeInboundReceived    MessageEventType = "inbound_received"
	MessageEventTypeInboundQueued      MessageEventType = "inbound_queued"
	MessageEventTypeInboundSpamBlocked MessageEventType = "inbound_spam_blocked"
	MessageEventTypeInboundReleased    MessageEventType = "inbound_released"
	MessageEventTypeInboundProcessed   MessageEventType = "inbound_processed"
	MessageEventTypeInboundRetry       MessageEventType = "inbound_retry"
)

type MessageListData struct {
	ID            string         `json:"id"`
	Type          MessageType    `json:"type"`
	Status        MessageStatus  `json:"status"`
	DeliveryMode  DeliveryMode   `json:"delivery_mode"`
	SandboxResult *SandboxResult `json:"sandbox_result"`
	ScheduledAt   *string        `json:"scheduled_at"`
	// Overall spam assessment score. Scores below 5 are clean, 5 through 10 indicate potential spam, scores above 10 and below 15 are likely spam, and 15 or higher is definite spam. Null means no assessment is available. Available on plans with Spam Insights
	SpamScore       Nullable[float64]      `json:"spam_score,omitzero"`
	FromEmail       string                 `json:"from_email"`
	FromName        *string                `json:"from_name"`
	Subject         *string                `json:"subject"`
	To              []MessageRecipientData `json:"to"`
	CC              []MessageRecipientData `json:"cc"`
	BCC             []MessageRecipientData `json:"bcc"`
	ReplyTo         []string               `json:"reply_to"`
	Tag             *string                `json:"tag"`
	Tags            []MessageTag           `json:"tags"`
	StatusChangedAt *string                `json:"status_changed_at"`
	CreatedAt       string                 `json:"created_at"`
}

type MessageRecipientData struct {
	Email string  `json:"email"`
	Name  *string `json:"name"`
	// The simulated result for this recipient in a Sandbox project. Lettermint test addresses override the message result. Null for Live messages
	SandboxResult *SandboxResult `json:"sandbox_result"`
}

// MessageResponse: Confirmation that a request succeeded.
type MessageResponse struct {
	// Human-readable confirmation
	Message string `json:"message"`
}

type MessageStatsData struct {
	MessagesTransactional int     `json:"messages_transactional"`
	MessagesBroadcast     int     `json:"messages_broadcast"`
	MessagesInbound       int     `json:"messages_inbound"`
	Deliverability        float64 `json:"deliverability"`
}

// MessageStatus is an open enum: values the API adds later decode unchanged.
type MessageStatus string

// Known values of MessageStatus.
const (
	MessageStatusScheduled      MessageStatus = "scheduled"
	MessageStatusPending        MessageStatus = "pending"
	MessageStatusQueued         MessageStatus = "queued"
	MessageStatusQuarantined    MessageStatus = "quarantined"
	MessageStatusSuppressed     MessageStatus = "suppressed"
	MessageStatusProcessed      MessageStatus = "processed"
	MessageStatusDelivered      MessageStatus = "delivered"
	MessageStatusOpened         MessageStatus = "opened"
	MessageStatusClicked        MessageStatus = "clicked"
	MessageStatusSoftBounced    MessageStatus = "soft_bounced"
	MessageStatusHardBounced    MessageStatus = "hard_bounced"
	MessageStatusSpamComplaint  MessageStatus = "spam_complaint"
	MessageStatusFailed         MessageStatus = "failed"
	MessageStatusBlocked        MessageStatus = "blocked"
	MessageStatusPolicyRejected MessageStatus = "policy_rejected"
	MessageStatusUnsubscribed   MessageStatus = "unsubscribed"
	MessageStatusCanceled       MessageStatus = "canceled"
)

type MessageTag struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

// MessageTagInput: A reusable exact-match tag with a name and a value.
type MessageTagInput struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

// MessageType is an open enum: values the API adds later decode unchanged.
type MessageType string

// Known values of MessageType.
const (
	MessageTypeInbound  MessageType = "inbound"
	MessageTypeOutbound MessageType = "outbound"
)

// ModelNotFoundException: Not found
type ModelNotFoundException = ErrorMessage

// PendingSendMailResponse: An accepted message that is queued for delivery.
type PendingSendMailResponse struct {
	MessageID string `json:"message_id"`
	Status    string `json:"status"`
	// Present when the project uses Sandbox delivery
	Sandbox *bool `json:"sandbox,omitzero"`
	// The simulated delivery result. Present when the project uses Sandbox delivery
	SandboxResult *SandboxResult `json:"sandbox_result,omitzero"`
}

// Plan is an open enum: values the API adds later decode unchanged.
type Plan string

// Known values of Plan.
const (
	PlanFree    Plan = "free"
	PlanStarter Plan = "starter"
	PlanGrowth  Plan = "growth"
	PlanPro     Plan = "pro"
)

type ProcessInboundMessageConflict struct {
	Error ProcessInboundMessageConflictError `json:"error"`
}

type ProcessInboundMessageConflictError struct {
	Code    ProcessInboundMessageConflictErrorCode `json:"code"`
	Message string                                 `json:"message"`
}

// ProcessInboundMessageConflictErrorCode is an open enum: values the API adds later decode unchanged.
type ProcessInboundMessageConflictErrorCode string

// Known values of ProcessInboundMessageConflictErrorCode.
const (
	ProcessInboundMessageConflictErrorCodeINBOUNDMESSAGENOTQUARANTINED ProcessInboundMessageConflictErrorCode = "INBOUND_MESSAGE_NOT_QUARANTINED"
	ProcessInboundMessageConflictErrorCodeINBOUNDWEBHOOKNOTCONFIGURED  ProcessInboundMessageConflictErrorCode = "INBOUND_WEBHOOK_NOT_CONFIGURED"
	ProcessInboundMessageConflictErrorCodeMESSAGESOURCEUNAVAILABLE     ProcessInboundMessageConflictErrorCode = "MESSAGE_SOURCE_UNAVAILABLE"
)

// ProcessInboundMessageResponse: The queued release of a quarantined inbound message.
type ProcessInboundMessageResponse struct {
	Data ProcessInboundMessageResult `json:"data"`
}

// ProcessInboundMessageResult: A quarantined inbound message that was queued for webhook delivery.
type ProcessInboundMessageResult struct {
	MessageID string `json:"message_id"`
	Status    string `json:"status"`
	// The number of webhooks the message is delivered to
	WebhookTargetCount int `json:"webhook_target_count"`
}

// ProjectAccessScope is an open enum: values the API adds later decode unchanged.
type ProjectAccessScope string

// Known values of ProjectAccessScope.
const (
	ProjectAccessScopeAll      ProjectAccessScope = "all"
	ProjectAccessScopeSelected ProjectAccessScope = "selected"
)

type ProjectCreatedData struct {
	Data     ProjectData `json:"data"`
	Message  string      `json:"message"`
	APIToken *string     `json:"api_token,omitzero"`
}

type ProjectData struct {
	ID                 string                     `json:"id"`
	Name               string                     `json:"name"`
	DeliveryMode       DeliveryMode               `json:"delivery_mode"`
	SMTPEnabled        bool                       `json:"smtp_enabled"`
	RedactEmailContent bool                       `json:"redact_email_content"`
	DefaultRouteID     *string                    `json:"default_route_id"`
	TokenGeneratedAt   *string                    `json:"token_generated_at"`
	TokenLastUsedAt    *string                    `json:"token_last_used_at"`
	TokenLastUsedIP    *string                    `json:"token_last_used_ip"`
	Routes             []RouteData                `json:"routes,omitzero"`
	RoutesCount        *int                       `json:"routes_count,omitzero"`
	Domains            []DomainData               `json:"domains,omitzero"`
	DomainsCount       *int                       `json:"domains_count,omitzero"`
	Last28Days         Nullable[MessageStatsData] `json:"last_28_days,omitzero"`
	CreatedAt          string                     `json:"created_at"`
	UpdatedAt          string                     `json:"updated_at"`
}

type ProjectListData struct {
	ID           string           `json:"id"`
	Name         string           `json:"name"`
	DeliveryMode DeliveryMode     `json:"delivery_mode"`
	SMTPEnabled  bool             `json:"smtp_enabled"`
	RoutesCount  int              `json:"routes_count"`
	DomainsCount int              `json:"domains_count"`
	Last28Days   MessageStatsData `json:"last_28_days"`
	CreatedAt    string           `json:"created_at"`
	UpdatedAt    string           `json:"updated_at"`
}

// ProjectMutationResponse: The project after a change, with a confirmation message.
type ProjectMutationResponse struct {
	Data ProjectData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}

// RbacConflictCode is an open enum: values the API adds later decode unchanged.
type RbacConflictCode string

// Known values of RbacConflictCode.
const (
	RbacConflictCodeStaleResource         RbacConflictCode = "stale_resource"
	RbacConflictCodeOwnerProtected        RbacConflictCode = "owner_protected"
	RbacConflictCodeLastOwner             RbacConflictCode = "last_owner"
	RbacConflictCodeBuiltInRoleImmutable  RbacConflictCode = "built_in_role_immutable"
	RbacConflictCodeCustomRoleRequiresPro RbacConflictCode = "custom_role_requires_pro"
)

// RbacConflictException: Role or project-access state conflict
type RbacConflictException struct {
	Error RbacConflictExceptionError `json:"error"`
}

type RbacConflictExceptionError struct {
	Code    RbacConflictCode `json:"code"`
	Message string           `json:"message"`
}

// RbacPermission is an open enum: values the API adds later decode unchanged.
type RbacPermission string

// Known values of RbacPermission.
const (
	RbacPermissionTeamManage             RbacPermission = "team:manage"
	RbacPermissionBillingManage          RbacPermission = "billing:manage"
	RbacPermissionSecurityManage         RbacPermission = "security:manage"
	RbacPermissionAuditRead              RbacPermission = "audit:read"
	RbacPermissionSupportManage          RbacPermission = "support:manage"
	RbacPermissionMembersRead            RbacPermission = "members:read"
	RbacPermissionMembersManage          RbacPermission = "members:manage"
	RbacPermissionRolesManage            RbacPermission = "roles:manage"
	RbacPermissionTeamTokensRead         RbacPermission = "team_tokens:read"
	RbacPermissionTeamTokensManage       RbacPermission = "team_tokens:manage"
	RbacPermissionTeamTokensRotate       RbacPermission = "team_tokens:rotate"
	RbacPermissionTeamTokensRevoke       RbacPermission = "team_tokens:revoke"
	RbacPermissionProjectsCreate         RbacPermission = "projects:create"
	RbacPermissionTeamSuppressionsRead   RbacPermission = "team_suppressions:read"
	RbacPermissionTeamSuppressionsAdd    RbacPermission = "team_suppressions:add"
	RbacPermissionTeamSuppressionsRemove RbacPermission = "team_suppressions:remove"
	RbacPermissionProjectsRead           RbacPermission = "projects:read"
	RbacPermissionProjectsManage         RbacPermission = "projects:manage"
	RbacPermissionProjectsDelete         RbacPermission = "projects:delete"
	RbacPermissionRoutesRead             RbacPermission = "routes:read"
	RbacPermissionRoutesManage           RbacPermission = "routes:manage"
	RbacPermissionRoutesDelete           RbacPermission = "routes:delete"
	RbacPermissionDomainsRead            RbacPermission = "domains:read"
	RbacPermissionDomainsManage          RbacPermission = "domains:manage"
	RbacPermissionDomainsDelete          RbacPermission = "domains:delete"
	RbacPermissionProjectTokensRead      RbacPermission = "project_tokens:read"
	RbacPermissionProjectTokensManage    RbacPermission = "project_tokens:manage"
	RbacPermissionProjectTokensRotate    RbacPermission = "project_tokens:rotate"
	RbacPermissionProjectTokensRevoke    RbacPermission = "project_tokens:revoke"
	RbacPermissionWebhooksRead           RbacPermission = "webhooks:read"
	RbacPermissionWebhooksManage         RbacPermission = "webhooks:manage"
	RbacPermissionWebhooksDelete         RbacPermission = "webhooks:delete"
	RbacPermissionWebhooksRotateSecret   RbacPermission = "webhooks:rotate_secret"
	RbacPermissionStatsRead              RbacPermission = "stats:read"
	RbacPermissionAnalyticsRead          RbacPermission = "analytics:read"
	RbacPermissionMessagesRead           RbacPermission = "messages:read"
	RbacPermissionMessagesReadContent    RbacPermission = "messages:read_content"
	RbacPermissionMessagesSend           RbacPermission = "messages:send"
	RbacPermissionSuppressionsRead       RbacPermission = "suppressions:read"
	RbacPermissionSuppressionsAdd        RbacPermission = "suppressions:add"
	RbacPermissionSuppressionsRemove     RbacPermission = "suppressions:remove"
)

// RecordType is an open enum: values the API adds later decode unchanged.
type RecordType string

// Known values of RecordType.
const (
	RecordTypeTXT   RecordType = "TXT"
	RecordTypeCNAME RecordType = "CNAME"
	RecordTypeMX    RecordType = "MX"
)

type ReportForwardingRequest struct {
	Destination string `json:"destination"`
}

type ReportForwardingResource struct {
	Destination *string `json:"destination"`
	Verified    bool    `json:"verified"`
	VerifiedAt  *string `json:"verified_at"`
}

type RescheduleMessageRequest struct {
	ScheduledAt string `json:"scheduled_at"`
}

type ResendMessageRequest struct {
	// Recipients of the original message to resend to. Omit to resend to every original recipient.
	Recipients []string `json:"recipients,omitzero"`
}

type ResendReportForwardingCodeResponse struct {
	Data ReportForwardingResource `json:"data"`
}

// RetryWebhookDeliveryResponse: Confirmation that a manual retry of a delivery was queued.
type RetryWebhookDeliveryResponse struct {
	// Human-readable confirmation
	Message string `json:"message"`
	// The ID of the delivery that is retried
	DeliveryID string `json:"delivery_id"`
}

// RotateProjectTokenResponse: The project and its new legacy Project API token.
type RotateProjectTokenResponse struct {
	Data ProjectData `json:"data"`
	// The new Project API token. It is only returned once
	NewToken string `json:"new_token"`
	// Human-readable confirmation
	Message string `json:"message"`
}

type RouteData struct {
	ID        string    `json:"id"`
	ProjectID string    `json:"project_id"`
	Slug      string    `json:"slug"`
	Name      string    `json:"name"`
	RouteType RouteType `json:"route_type"`
	IsDefault bool      `json:"is_default"`
	// Permanent compatibility address for this inbound route (`<route-uuid-without-hyphens>@inbound.lettermint.co`). It keeps working alongside the catch-all route domain
	InboundAddress Nullable[string] `json:"inbound_address,omitzero"`
	// Catch-all receiving domain for this inbound route. Mail to any address at this domain reaches the route. Null for non-inbound routes
	InboundRouteDomain      Nullable[string]    `json:"inbound_route_domain,omitzero"`
	InboundMXHostname       *string             `json:"inbound_mx_hostname,omitzero"`
	InboundDomain           Nullable[string]    `json:"inbound_domain,omitzero"`
	InboundDomainVerifiedAt Nullable[string]    `json:"inbound_domain_verified_at,omitzero"`
	InboundSpamThreshold    Nullable[float64]   `json:"inbound_spam_threshold,omitzero"`
	AttachmentDelivery      *AttachmentDelivery `json:"attachment_delivery,omitzero"`
	// Route settings available for this route type and team feature access
	Settings                  Nullable[RouteDataSettings] `json:"settings,omitzero"`
	Project                   *ProjectData                `json:"project,omitzero"`
	WebhooksCount             *int                        `json:"webhooks_count,omitzero"`
	SuppressedRecipientsCount *int                        `json:"suppressed_recipients_count,omitzero"`
	Statistics                []RouteStatisticData        `json:"statistics,omitzero"`
	CreatedAt                 string                      `json:"created_at"`
	UpdatedAt                 string                      `json:"updated_at"`
}

// RouteDataSettings: Route settings available for this route type and team feature access
type RouteDataSettings struct {
	DisableHostedUnsubscribe     *bool               `json:"disable_hosted_unsubscribe,omitzero"`
	TrackOpens                   *bool               `json:"track_opens,omitzero"`
	TrackClicks                  *bool               `json:"track_clicks,omitzero"`
	GeneratePlaintextFallback    *bool               `json:"generate_plaintext_fallback,omitzero"`
	SuppressAutoResponders       *bool               `json:"suppress_auto_responders,omitzero"`
	SuppressDisposableRecipients *bool               `json:"suppress_disposable_recipients,omitzero"`
	TLS                          *TlsPolicy          `json:"tls,omitzero"`
	RedactEmailContent           *bool               `json:"redact_email_content,omitzero"`
	AttachmentDelivery           *AttachmentDelivery `json:"attachment_delivery,omitzero"`
}

type RouteListData struct {
	ID                        string    `json:"id"`
	Slug                      string    `json:"slug"`
	Name                      string    `json:"name"`
	RouteType                 RouteType `json:"route_type"`
	IsDefault                 bool      `json:"is_default"`
	WebhooksCount             int       `json:"webhooks_count"`
	SuppressedRecipientsCount int       `json:"suppressed_recipients_count"`
	CreatedAt                 string    `json:"created_at"`
	UpdatedAt                 string    `json:"updated_at"`
}

// RouteMutationResponse: The route after it was created or changed, with a confirmation message.
type RouteMutationResponse struct {
	Data RouteData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}

type RouteStatisticData struct {
	Date                 string        `json:"date"`
	SentCount            int           `json:"sent_count"`
	DeliveredCount       int           `json:"delivered_count"`
	OpenedCount          int           `json:"opened_count"`
	ClickedCount         int           `json:"clicked_count"`
	HardBounceCount      int           `json:"hard_bounce_count"`
	SpamComplaintCount   int           `json:"spam_complaint_count"`
	InboundReceivedCount int           `json:"inbound_received_count"`
	ObservedOpenedCount  Nullable[int] `json:"observed_opened_count,omitzero"`
	HumanOpenedCount     Nullable[int] `json:"human_opened_count,omitzero"`
	PrivacyOpenedCount   Nullable[int] `json:"privacy_opened_count,omitzero"`
	EffectiveOpenedCount *int          `json:"effective_opened_count"`
	MachineOpenedCount   *int          `json:"machine_opened_count"`
	MachineClickedCount  *int          `json:"machine_clicked_count"`
}

// RouteType is an open enum: values the API adds later decode unchanged.
type RouteType string

// Known values of RouteType.
const (
	RouteTypeTransactional RouteType = "transactional"
	RouteTypeBroadcast     RouteType = "broadcast"
	RouteTypeInbound       RouteType = "inbound"
)

// SandboxResult is an open enum: values the API adds later decode unchanged.
type SandboxResult string

// Known values of SandboxResult.
const (
	SandboxResultDelivered     SandboxResult = "delivered"
	SandboxResultHardBounced   SandboxResult = "hard_bounced"
	SandboxResultSoftBounced   SandboxResult = "soft_bounced"
	SandboxResultDeferred      SandboxResult = "deferred"
	SandboxResultFailed        SandboxResult = "failed"
	SandboxResultSuppressed    SandboxResult = "suppressed"
	SandboxResultSpamComplaint SandboxResult = "spam_complaint"
	SandboxResultAutoReplied   SandboxResult = "auto_replied"
	SandboxResultOpened        SandboxResult = "opened"
	SandboxResultClicked       SandboxResult = "clicked"
	SandboxResultUnsubscribed  SandboxResult = "unsubscribed"
)

// ScheduledMessage: The schedule state of a message after it was rescheduled or canceled.
type ScheduledMessage struct {
	MessageID string         `json:"message_id"`
	Status    *MessageStatus `json:"status"`
	// The scheduled delivery time in ISO 8601 format
	ScheduledAt *string `json:"scheduled_at"`
}

// ScheduledSendMailResponse: An accepted message that is scheduled for later delivery.
type ScheduledSendMailResponse struct {
	MessageID string `json:"message_id"`
	Status    string `json:"status"`
	// The scheduled delivery time in ISO 8601 format
	ScheduledAt string `json:"scheduled_at"`
	// Present when the project uses Sandbox delivery
	Sandbox *bool `json:"sandbox,omitzero"`
	// The simulated delivery result. Present when the project uses Sandbox delivery
	SandboxResult *SandboxResult `json:"sandbox_result,omitzero"`
}

type SendBatchMailItem struct {
	Route   *string  `json:"route,omitzero"`
	From    string   `json:"from"`
	To      []string `json:"to"`
	CC      []string `json:"cc,omitzero"`
	BCC     []string `json:"bcc,omitzero"`
	ReplyTo []string `json:"reply_to,omitzero"`
	Subject string   `json:"subject"`
	// ISO 8601 or English delivery time. A time without a timezone uses UTC.
	ScheduledAt *string `json:"scheduled_at,omitzero"`
	// The result that a Sandbox project simulates for every recipient.
	SandboxResult *SandboxResult `json:"sandbox_result,omitzero"`
	// Custom headers to include in the email. To preserve a submitted RFC Message-ID,
	// include both Message-ID and X-LM-Preserve-Message-ID with a string value of true or 1.
	// Header names and control values are case-insensitive; false or 0 retains replacement.
	// Send values as plain text: Lettermint encodes non-ASCII characters and repairs small formatting
	// errors, such as line breaks, control characters and missing angle brackets. Header names must
	// be printable ASCII without a colon.
	Headers map[string]string `json:"headers,omitzero"`
	// Metadata to track with the email (not added as email headers).
	Metadata map[string]string `json:"metadata,omitzero"`
	// Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).
	Tag Nullable[string] `json:"tag,omitzero"`
	// Reusable exact-match tags. Names must be unique and are case-sensitive.
	Tags []MessageTagInput `json:"tags,omitzero"`
	// Per-email settings that override the selected route settings for this email only.
	Settings    *SendMailRequestSettings `json:"settings,omitzero"`
	HTML        Nullable[string]         `json:"html,omitzero"`
	Text        Nullable[string]         `json:"text,omitzero"`
	Attachments []MessageAttachmentInput `json:"attachments,omitzero"`
	// Optional key (1-255 characters) that makes this email safe to send again, in this or a later batch. If an email with the same key and content was accepted in the last 24 hours, its original result is returned and it is not sent again. Keys must be unique within a batch. Reusing a key with different content, or while the email with that key is still being processed, rejects the whole batch with `409 Conflict` and sends nothing.
	IdempotencyKey *string `json:"idempotency_key,omitzero"`
}

type SendBatchMailRequest []SendBatchMailItem

type SendBatchMailResponse []SendMailResponse

type SendMailRequest struct {
	Route   *string  `json:"route,omitzero"`
	From    string   `json:"from"`
	To      []string `json:"to"`
	CC      []string `json:"cc,omitzero"`
	BCC     []string `json:"bcc,omitzero"`
	ReplyTo []string `json:"reply_to,omitzero"`
	Subject string   `json:"subject"`
	// ISO 8601 or English delivery time. A time without a timezone uses UTC.
	ScheduledAt *string `json:"scheduled_at,omitzero"`
	// The result that a Sandbox project simulates for every recipient.
	SandboxResult *SandboxResult `json:"sandbox_result,omitzero"`
	// Custom headers to include in the email. To preserve a submitted RFC Message-ID,
	// include both Message-ID and X-LM-Preserve-Message-ID with a string value of true or 1.
	// Header names and control values are case-insensitive; false or 0 retains replacement.
	// Send values as plain text: Lettermint encodes non-ASCII characters and repairs small formatting
	// errors, such as line breaks, control characters and missing angle brackets. Header names must
	// be printable ASCII without a colon.
	Headers map[string]string `json:"headers,omitzero"`
	// Metadata to track with the email (not added as email headers).
	Metadata map[string]string `json:"metadata,omitzero"`
	// Tag to categorize and filter emails (alphanumeric, underscores, hyphens, spaces allowed).
	Tag Nullable[string] `json:"tag,omitzero"`
	// Reusable exact-match tags. Names must be unique and are case-sensitive.
	Tags []MessageTagInput `json:"tags,omitzero"`
	// Per-email settings that override the selected route settings for this email only.
	Settings    *SendMailRequestSettings `json:"settings,omitzero"`
	HTML        Nullable[string]         `json:"html,omitzero"`
	Text        Nullable[string]         `json:"text,omitzero"`
	Attachments []MessageAttachmentInput `json:"attachments,omitzero"`
}

// SendMailRequestSettings: Per-email settings that override the selected route settings for this email only.
type SendMailRequestSettings struct {
	TrackOpens  *bool      `json:"track_opens,omitzero"`
	TrackClicks *bool      `json:"track_clicks,omitzero"`
	TLS         *TlsPolicy `json:"tls,omitzero"`
}

type SendMailResponse struct {
	MessageID string        `json:"message_id"`
	Status    MessageStatus `json:"status"`
	// Present when the project uses Sandbox delivery
	Sandbox *bool `json:"sandbox,omitzero"`
	// The simulated delivery result. Present when the project uses Sandbox delivery
	SandboxResult *SandboxResult `json:"sandbox_result,omitzero"`
	// The scheduled delivery time in ISO 8601 format
	ScheduledAt *string `json:"scheduled_at,omitzero"`
}

type SpamSymbol struct {
	Name        string   `json:"name"`
	Score       float64  `json:"score"`
	Options     []string `json:"options"`
	Description *string  `json:"description"`
}

type StatsDailyData struct {
	Date           string `json:"date"`
	Sent           int    `json:"sent"`
	Delivered      int    `json:"delivered"`
	HardBounced    int    `json:"hard_bounced"`
	SpamComplaints int    `json:"spam_complaints"`
	// Null when tracking is not enabled for this context
	Opened *int `json:"opened"`
	// Null when tracking is not enabled for this context
	Clicked *int             `json:"clicked"`
	Inbound StatsInboundData `json:"inbound"`
	// Null for team-scoped stats (only available when project_id is specified)
	Transactional *StatsTypeData `json:"transactional"`
	// Null for team-scoped stats (only available when project_id is specified)
	Broadcast *StatsTypeData `json:"broadcast"`
	// Human opens plus unresolved privacy-proxy opens
	ObservedOpened  Nullable[int] `json:"observed_opened,omitzero"`
	HumanOpened     Nullable[int] `json:"human_opened,omitzero"`
	PrivacyOpened   Nullable[int] `json:"privacy_opened,omitzero"`
	EffectiveOpened *int          `json:"effective_opened"`
	MachineOpened   *int          `json:"machine_opened"`
	MachineClicked  *int          `json:"machine_clicked"`
}

type StatsData struct {
	From   string           `json:"from"`
	To     string           `json:"to"`
	Totals StatsTotalsData  `json:"totals"`
	Daily  []StatsDailyData `json:"daily"`
}

type StatsInboundData struct {
	Received int `json:"received"`
}

type StatsTotalsData struct {
	Sent           int `json:"sent"`
	Delivered      int `json:"delivered"`
	HardBounced    int `json:"hard_bounced"`
	SpamComplaints int `json:"spam_complaints"`
	// Null when tracking is not enabled for this context
	Opened *int `json:"opened"`
	// Null when tracking is not enabled for this context
	Clicked *int             `json:"clicked"`
	Inbound StatsInboundData `json:"inbound"`
	// Null for team-scoped stats (only available when project_id is specified)
	Transactional *StatsTypeData `json:"transactional"`
	// Null for team-scoped stats (only available when project_id is specified)
	Broadcast *StatsTypeData `json:"broadcast"`
	// Human opens plus unresolved privacy-proxy opens
	ObservedOpened  Nullable[int] `json:"observed_opened,omitzero"`
	HumanOpened     Nullable[int] `json:"human_opened,omitzero"`
	PrivacyOpened   Nullable[int] `json:"privacy_opened,omitzero"`
	EffectiveOpened *int          `json:"effective_opened"`
	MachineOpened   *int          `json:"machine_opened"`
	MachineClicked  *int          `json:"machine_clicked"`
}

type StatsTypeData struct {
	Sent           int `json:"sent"`
	HardBounced    int `json:"hard_bounced"`
	SpamComplaints int `json:"spam_complaints"`
}

type StoreDomainData struct {
	Domain string `json:"domain"`
}

type StoreProjectData struct {
	Name               string         `json:"name"`
	SMTPEnabled        *bool          `json:"smtp_enabled,omitzero"`
	DeliveryMode       *DeliveryMode  `json:"delivery_mode,omitzero"`
	InitialRoutes      *InitialRoutes `json:"initial_routes,omitzero"`
	ShortToken         *bool          `json:"short_token,omitzero"`
	RedactEmailContent *bool          `json:"redact_email_content,omitzero"`
}

type StoreRouteData struct {
	Name                 string                                   `json:"name"`
	RouteType            RouteType                                `json:"route_type"`
	Slug                 Nullable[string]                         `json:"slug,omitzero"`
	Settings             Nullable[UpdateRouteSettingsData]        `json:"settings,omitzero"`
	InboundSettings      Nullable[UpdateRouteInboundSettingsData] `json:"inbound_settings,omitzero"`
	InboundDomain        Nullable[string]                         `json:"inbound_domain,omitzero"`
	InboundSpamThreshold Nullable[float64]                        `json:"inbound_spam_threshold,omitzero"`
	AttachmentDelivery   Nullable[AttachmentDelivery]             `json:"attachment_delivery,omitzero"`
}

type StoreSuppressionData struct {
	Email     Nullable[string]        `json:"email,omitzero"`
	Emails    Nullable[[]string]      `json:"emails,omitzero"`
	Reason    SuppressionCreateReason `json:"reason"`
	Scope     SuppressionCreateScope  `json:"scope"`
	RouteID   Nullable[string]        `json:"route_id,omitzero"`
	ProjectID Nullable[string]        `json:"project_id,omitzero"`
	// Mail category to block. Manual suppressions default to `all`. Use `broadcast` only at team scope, project scope, or on a broadcast route
	AppliesTo Nullable[SuppressionAppliesTo] `json:"applies_to,omitzero"`
}

type StoreWebhookData struct {
	Name                 string                              `json:"name"`
	URL                  string                              `json:"url"`
	Events               []WebhookEvent                      `json:"events"`
	Enabled              Nullable[bool]                      `json:"enabled,omitzero"`
	IncludeMachineEvents Nullable[bool]                      `json:"include_machine_events,omitzero"`
	DeliveryModeFilter   Nullable[WebhookDeliveryModeFilter] `json:"delivery_mode_filter,omitzero"`
	Scope                Nullable[WebhookScope]              `json:"scope,omitzero"`
	ProjectIDs           []string                            `json:"project_ids,omitzero"`
	RouteIDs             []string                            `json:"route_ids,omitzero"`
	RouteID              Nullable[string]                    `json:"route_id,omitzero"`
	// Write-only credentials. Omit to keep credentials. Null removes Basic Auth
	BasicAuth Nullable[WebhookBasicAuthData] `json:"basic_auth,omitzero"`
}

type SuppressedRecipientData struct {
	ID            string                                 `json:"id"`
	Type          SuppressionType                        `json:"type"`
	Value         string                                 `json:"value"`
	Reason        SuppressionReason                      `json:"reason"`
	Scope         SuppressionScope                       `json:"scope"`
	AppliesTo     SuppressionAppliesTo                   `json:"applies_to"`
	ProjectID     *string                                `json:"project_id"`
	RouteID       *string                                `json:"route_id"`
	SourceMessage Nullable[SuppressionSourceMessageData] `json:"source_message,omitzero"`
	CreatedAt     string                                 `json:"created_at"`
}

// SuppressionAppliesTo: Mail category blocked by the suppression. `all` blocks transactional and broadcast mail. `broadcast` blocks broadcast mail only.
//
// SuppressionAppliesTo is an open enum: values the API adds later decode unchanged.
type SuppressionAppliesTo string

// Known values of SuppressionAppliesTo.
const (
	SuppressionAppliesToAll       SuppressionAppliesTo = "all"
	SuppressionAppliesToBroadcast SuppressionAppliesTo = "broadcast"
)

// SuppressionCreateReason: Reason that the recipient is suppressed. The `disposable_email` reason is reserved for route policies.
//
// SuppressionCreateReason is an open enum: values the API adds later decode unchanged.
type SuppressionCreateReason string

// Known values of SuppressionCreateReason.
const (
	SuppressionCreateReasonSpamComplaint SuppressionCreateReason = "spam_complaint"
	SuppressionCreateReasonHardBounce    SuppressionCreateReason = "hard_bounce"
	SuppressionCreateReasonUnsubscribe   SuppressionCreateReason = "unsubscribe"
	SuppressionCreateReasonManual        SuppressionCreateReason = "manual"
)

// SuppressionCreateScope: Where the suppression applies. The `global` and `subscription_group` scopes cannot be created through the API.
//
// SuppressionCreateScope is an open enum: values the API adds later decode unchanged.
type SuppressionCreateScope string

// Known values of SuppressionCreateScope.
const (
	SuppressionCreateScopeTeam    SuppressionCreateScope = "team"
	SuppressionCreateScopeProject SuppressionCreateScope = "project"
	SuppressionCreateScopeRoute   SuppressionCreateScope = "route"
)

// SuppressionDeletedResponse: Confirmation that a suppression was removed.
type SuppressionDeletedResponse struct {
	Success bool   `json:"success"`
	Status  string `json:"status"`
	// Human-readable confirmation
	Message string `json:"message"`
	// Confidence of the automated removal assessment, when one ran
	Confidence *float64 `json:"confidence,omitzero"`
}

// SuppressionReason: Reason that the recipient is suppressed.
//
// SuppressionReason is an open enum: values the API adds later decode unchanged.
type SuppressionReason string

// Known values of SuppressionReason.
const (
	SuppressionReasonSpamComplaint   SuppressionReason = "spam_complaint"
	SuppressionReasonHardBounce      SuppressionReason = "hard_bounce"
	SuppressionReasonUnsubscribe     SuppressionReason = "unsubscribe"
	SuppressionReasonManual          SuppressionReason = "manual"
	SuppressionReasonDisposableEmail SuppressionReason = "disposable_email"
)

// SuppressionReviewResponse: A suppression that stays active while a support ticket reviews its removal.
type SuppressionReviewResponse struct {
	Success bool                            `json:"success"`
	Status  SuppressionReviewResponseStatus `json:"status"`
	// Human-readable confirmation
	Message string `json:"message"`
	// The identifier of the support ticket that reviews the removal
	TicketIdentifier string `json:"ticket_identifier"`
	// Confidence of the automated removal assessment, when one ran
	Confidence *float64 `json:"confidence,omitzero"`
}

// SuppressionReviewResponseStatus is an open enum: values the API adds later decode unchanged.
type SuppressionReviewResponseStatus string

// Known values of SuppressionReviewResponseStatus.
const (
	SuppressionReviewResponseStatusReviewTicketCreated SuppressionReviewResponseStatus = "review_ticket_created"
	SuppressionReviewResponseStatusReviewTicketExists  SuppressionReviewResponseStatus = "review_ticket_exists"
)

// SuppressionScope: Where the suppression applies.
//
// SuppressionScope is an open enum: values the API adds later decode unchanged.
type SuppressionScope string

// Known values of SuppressionScope.
const (
	SuppressionScopeGlobal            SuppressionScope = "global"
	SuppressionScopeTeam              SuppressionScope = "team"
	SuppressionScopeProject           SuppressionScope = "project"
	SuppressionScopeRoute             SuppressionScope = "route"
	SuppressionScopeSubscriptionGroup SuppressionScope = "subscription_group"
)

type SuppressionSourceMessageData struct {
	ID        string  `json:"id"`
	Available bool    `json:"available"`
	Subject   *string `json:"subject"`
	CreatedAt *string `json:"created_at"`
}

// SuppressionStoreResponse: The outcome of adding addresses to the suppression list.
type SuppressionStoreResponse struct {
	// Human-readable summary
	Message string                 `json:"message"`
	Data    SuppressionStoreResult `json:"data"`
}

// SuppressionStoreResult: The addresses that were added and the addresses that were already suppressed.
type SuppressionStoreResult struct {
	Created []string `json:"created"`
	Skipped []string `json:"skipped"`
}

// SuppressionType is an open enum: values the API adds later decode unchanged.
type SuppressionType string

// Known values of SuppressionType.
const (
	SuppressionTypeEmail     SuppressionType = "email"
	SuppressionTypeDomain    SuppressionType = "domain"
	SuppressionTypeExtension SuppressionType = "extension"
)

type TeamAddonData struct {
	Type      *string `json:"type"`
	ExpiresAt *string `json:"expires_at"`
}

type TeamData struct {
	ID   string   `json:"id"`
	Name string   `json:"name"`
	Type TeamType `json:"type"`
	Plan Plan     `json:"plan"`
	// Number of emails included in the team's monthly plan
	IncludedVolume int `json:"included_volume"`
	// Deprecated alias for `included_volume`
	//
	// Deprecated: the API marks this as deprecated.
	Tier          int             `json:"tier"`
	VerifiedAt    *string         `json:"verified_at"`
	Features      []string        `json:"features,omitzero"`
	Addons        []TeamAddonData `json:"addons,omitzero"`
	CreatedAt     string          `json:"created_at"`
	DomainsCount  *int            `json:"domains_count,omitzero"`
	ProjectsCount *int            `json:"projects_count,omitzero"`
	MembersCount  *int            `json:"members_count,omitzero"`
}

type TeamInviteData struct {
	ID            string                      `json:"id"`
	Email         string                      `json:"email"`
	Role          TeamInviteDataRole          `json:"role"`
	ProjectAccess TeamMemberProjectAccessData `json:"project_access"`
	CreatedAt     string                      `json:"created_at"`
}

type TeamInviteDataRole struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type TeamMemberData struct {
	ID            string                      `json:"id"`
	Name          string                      `json:"name"`
	Email         string                      `json:"email"`
	Role          TeamMemberDataRole          `json:"role"`
	ProjectAccess TeamMemberProjectAccessData `json:"project_access"`
	JoinedAt      *string                     `json:"joined_at"`
}

type TeamMemberDataRole struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type TeamMemberProjectAccessData struct {
	Scope    ProjectAccessScope                        `json:"scope"`
	Projects []TeamMemberProjectAccessDataProjectsItem `json:"projects"`
}

type TeamMemberProjectAccessDataProjectsItem struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

// TeamMutationResponse: The team after a settings change, with a confirmation message.
type TeamMutationResponse struct {
	Data TeamData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}

type TeamRoleData struct {
	ID          string           `json:"id"`
	Name        string           `json:"name"`
	Description Nullable[string] `json:"description,omitzero"`
	SystemKey   *BuiltInTeamRole `json:"system_key"`
	Permissions []RbacPermission `json:"permissions"`
	Assignable  bool             `json:"assignable"`
}

// TeamRoleListResponse: The reusable roles of the team.
type TeamRoleListResponse struct {
	Data []TeamRoleData `json:"data"`
}

// TeamType is an open enum: values the API adds later decode unchanged.
type TeamType string

// Known values of TeamType.
const (
	TeamTypePersonal TeamType = "personal"
	TeamTypeBusiness TeamType = "business"
)

type TeamUsageDetailData struct {
	CurrentPeriod   TeamUsagePeriodData   `json:"current_period"`
	HistoricalUsage []TeamUsagePeriodData `json:"historical_usage"`
}

type TeamUsagePeriodData struct {
	Usage             int     `json:"usage"`
	LastIncrementedAt *string `json:"last_incremented_at"`
	PeriodStart       string  `json:"period_start"`
	PeriodEnd         string  `json:"period_end"`
}

// TestWebhookResponse: Confirmation that a test delivery was queued.
type TestWebhookResponse struct {
	// Human-readable confirmation
	Message string `json:"message"`
	// The ID of the queued test delivery
	DeliveryID string `json:"delivery_id"`
}

// TlsPolicy is an open enum: values the API adds later decode unchanged.
type TlsPolicy string

// Known values of TlsPolicy.
const (
	TlsPolicyOpportunistic TlsPolicy = "opportunistic"
	TlsPolicyEnforced      TlsPolicy = "enforced"
)

// TooManyRequests: Too many requests.
type TooManyRequests = ErrorMessage

type UpdateDomainProjectsData struct {
	ProjectIDs []string `json:"project_ids"`
}

type UpdateProjectData struct {
	Name               Nullable[string]       `json:"name,omitzero"`
	SMTPEnabled        Nullable[bool]         `json:"smtp_enabled,omitzero"`
	RedactEmailContent Nullable[bool]         `json:"redact_email_content,omitzero"`
	DeliveryMode       Nullable[DeliveryMode] `json:"delivery_mode,omitzero"`
	DefaultRouteID     Nullable[string]       `json:"default_route_id,omitzero"`
}

type UpdateReportForwardingResponse struct {
	Data ReportForwardingResource `json:"data"`
}

type UpdateRouteData struct {
	Name Nullable[string] `json:"name,omitzero"`
	// Route settings. `track_opens` and `track_clicks` apply to transactional and broadcast routes when email tracking is available. `generate_plaintext_fallback` opts in to generated plaintext fallbacks for HTML-only outbound messages; customer-provided plaintext is always preserved. `suppress_auto_responders` adds outbound headers that suppress auto-responders. `suppress_disposable_recipients` skips matching recipients for each message without adding them to suppression lists. `tls` controls whether TLS is opportunistic or enforced. `disable_hosted_unsubscribe` applies to broadcast routes when enabled for the team. `redact_email_content` requires email redaction access
	Settings Nullable[UpdateRouteSettingsData] `json:"settings,omitzero"`
	// Inbound route settings. Only accepted for inbound routes
	InboundSettings      Nullable[UpdateRouteInboundSettingsData] `json:"inbound_settings,omitzero"`
	InboundDomain        Nullable[string]                         `json:"inbound_domain,omitzero"`
	InboundSpamThreshold Nullable[float64]                        `json:"inbound_spam_threshold,omitzero"`
	AttachmentDelivery   Nullable[AttachmentDelivery]             `json:"attachment_delivery,omitzero"`
}

type UpdateRouteInboundSettingsData struct {
	// Custom receiving domain for inbound routes, such as support.example.com or *.m.example.com. Address patterns such as *@*.m.example.com are normalized
	InboundDomain Nullable[string] `json:"inbound_domain,omitzero"`
	// Inbound spam threshold for inbound routes. Higher values are more permissive
	InboundSpamThreshold Nullable[float64] `json:"inbound_spam_threshold,omitzero"`
	// Inbound attachment delivery mode
	AttachmentDelivery Nullable[AttachmentDelivery] `json:"attachment_delivery,omitzero"`
}

type UpdateRouteSettingsData struct {
	// Enable open tracking for transactional and broadcast routes. Requires email tracking access
	TrackOpens Nullable[bool] `json:"track_opens,omitzero"`
	// Enable click tracking for transactional and broadcast routes. Requires email tracking access
	TrackClicks Nullable[bool] `json:"track_clicks,omitzero"`
	// Opt in to generated plaintext fallbacks for HTML-only outbound messages on transactional and broadcast routes. Customer-provided plaintext is always preserved
	GeneratePlaintextFallback Nullable[bool] `json:"generate_plaintext_fallback,omitzero"`
	// Add outbound headers that suppress auto-responders for transactional and broadcast routes. Customer-provided header values are preserved
	SuppressAutoResponders Nullable[bool] `json:"suppress_auto_responders,omitzero"`
	// Skip disposable email recipients for transactional and broadcast routes. This check applies to each message and does not add recipients to suppression lists
	SuppressDisposableRecipients Nullable[bool] `json:"suppress_disposable_recipients,omitzero"`
	// TLS delivery policy for transactional and broadcast routes
	TLS Nullable[TlsPolicy] `json:"tls,omitzero"`
	// Disable Lettermint-hosted unsubscribe link injection for broadcast routes. Available only when enabled for the team
	DisableHostedUnsubscribe Nullable[bool] `json:"disable_hosted_unsubscribe,omitzero"`
	// Redact email content in the dashboard for this route. Requires email redaction access
	RedactEmailContent Nullable[bool] `json:"redact_email_content,omitzero"`
}

type UpdateTeamData struct {
	Name *string `json:"name,omitzero"`
}

type UpdateTeamInviteData struct {
	Email         string                            `json:"email"`
	RoleID        string                            `json:"role_id"`
	ProjectAccess UpdateTeamInviteDataProjectAccess `json:"project_access"`
}

type UpdateTeamInviteDataProjectAccess struct {
	Scope      ProjectAccessScope `json:"scope"`
	ProjectIDs []string           `json:"project_ids,omitzero"`
}

type UpdateTeamMemberAssignmentData struct {
	RoleID        string                                      `json:"role_id"`
	ProjectAccess UpdateTeamMemberAssignmentDataProjectAccess `json:"project_access"`
}

type UpdateTeamMemberAssignmentDataProjectAccess struct {
	Scope      ProjectAccessScope `json:"scope"`
	ProjectIDs []string           `json:"project_ids,omitzero"`
}

type UpdateTeamRoleData struct {
	Name        string           `json:"name"`
	Description Nullable[string] `json:"description,omitzero"`
	Permissions []RbacPermission `json:"permissions"`
}

type UpdateWebhookData struct {
	Name                 *string                    `json:"name,omitzero"`
	URL                  *string                    `json:"url,omitzero"`
	Events               []WebhookEvent             `json:"events,omitzero"`
	Enabled              *bool                      `json:"enabled,omitzero"`
	IncludeMachineEvents *bool                      `json:"include_machine_events,omitzero"`
	DeliveryModeFilter   *WebhookDeliveryModeFilter `json:"delivery_mode_filter,omitzero"`
	Scope                *WebhookScope              `json:"scope,omitzero"`
	ProjectIDs           []string                   `json:"project_ids,omitzero"`
	RouteIDs             []string                   `json:"route_ids,omitzero"`
	RouteID              Nullable[string]           `json:"route_id,omitzero"`
	// Write-only credentials. Omit to keep credentials. Null removes Basic Auth
	BasicAuth Nullable[WebhookBasicAuthData] `json:"basic_auth,omitzero"`
}

type ValidationErrorBody struct {
	// Errors overview.
	Message string `json:"message"`
	// A detailed description of each field that failed validation.
	Errors map[string][]string `json:"errors"`
}

// ValidationException: Validation error
type ValidationException = ValidationErrorBody

type VerifyReportForwardingRequest struct {
	Code string `json:"code"`
}

type VerifyReportForwardingResponse struct {
	Data ReportForwardingResource `json:"data"`
}

type WebhookBasicAuthData struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type WebhookData struct {
	ID         string       `json:"id"`
	Scope      WebhookScope `json:"scope"`
	ProjectIDs []string     `json:"project_ids"`
	RouteIDs   []string     `json:"route_ids"`
	// Use route_ids.
	//
	// Deprecated: the API marks this as deprecated.
	RouteID              *string                   `json:"route_id"`
	Name                 string                    `json:"name"`
	URL                  string                    `json:"url"`
	HasBasicAuth         bool                      `json:"has_basic_auth"`
	Events               []string                  `json:"events"`
	Enabled              bool                      `json:"enabled"`
	IncludeMachineEvents bool                      `json:"include_machine_events"`
	DeliveryModeFilter   WebhookDeliveryModeFilter `json:"delivery_mode_filter"`
	LastCalledAt         *string                   `json:"last_called_at"`
	CreatedAt            string                    `json:"created_at"`
	UpdatedAt            string                    `json:"updated_at"`
}

type WebhookDeliveryData struct {
	ID              string                `json:"id"`
	WebhookID       string                `json:"webhook_id"`
	EventType       WebhookEvent          `json:"event_type"`
	SourceScope     *string               `json:"source_scope"`
	SourceProjectID *string               `json:"source_project_id"`
	SourceRouteID   *string               `json:"source_route_id"`
	Status          WebhookDeliveryStatus `json:"status"`
	Sandbox         bool                  `json:"sandbox"`
	AttemptNumber   int                   `json:"attempt_number"`
	HTTPStatusCode  *int                  `json:"http_status_code"`
	DurationMs      *int                  `json:"duration_ms"`
	// Omitted when the user cannot view the delivery's content. Always included in requests made with a team API token.
	Payload []string `json:"payload"`
	// Omitted when the user cannot view the delivery's content. Always included in requests made with a team API token.
	ResponseBody *string `json:"response_body"`
	// Omitted when the user cannot view the delivery's content. Always included in requests made with a team API token.
	ResponseHeaders []string `json:"response_headers"`
	// Omitted when the user cannot view the delivery's content. Always included in requests made with a team API token.
	ErrorMessage *string `json:"error_message"`
	DeliveredAt  *string `json:"delivered_at"`
	Timestamp    string  `json:"timestamp"`
	// When the next automatic retry is due. Null when none is scheduled
	NextRetryAt Nullable[string] `json:"next_retry_at,omitzero"`
}

type WebhookDeliveryListData struct {
	ID              string                `json:"id"`
	WebhookID       string                `json:"webhook_id"`
	EventType       WebhookEvent          `json:"event_type"`
	SourceScope     *string               `json:"source_scope"`
	SourceProjectID *string               `json:"source_project_id"`
	SourceRouteID   *string               `json:"source_route_id"`
	Status          WebhookDeliveryStatus `json:"status"`
	Sandbox         bool                  `json:"sandbox"`
	AttemptNumber   int                   `json:"attempt_number"`
	HTTPStatusCode  *int                  `json:"http_status_code"`
	DurationMs      *int                  `json:"duration_ms"`
	DeliveredAt     *string               `json:"delivered_at"`
	CreatedAt       string                `json:"created_at"`
	// When the next automatic retry is due. Null when none is scheduled
	NextRetryAt Nullable[string] `json:"next_retry_at,omitzero"`
}

// WebhookDeliveryModeFilter is an open enum: values the API adds later decode unchanged.
type WebhookDeliveryModeFilter string

// Known values of WebhookDeliveryModeFilter.
const (
	WebhookDeliveryModeFilterLive    WebhookDeliveryModeFilter = "live"
	WebhookDeliveryModeFilterSandbox WebhookDeliveryModeFilter = "sandbox"
	WebhookDeliveryModeFilterBoth    WebhookDeliveryModeFilter = "both"
)

// WebhookDeliveryStatus is an open enum: values the API adds later decode unchanged.
type WebhookDeliveryStatus string

// Known values of WebhookDeliveryStatus.
const (
	WebhookDeliveryStatusPending     WebhookDeliveryStatus = "pending"
	WebhookDeliveryStatusSuccess     WebhookDeliveryStatus = "success"
	WebhookDeliveryStatusFailed      WebhookDeliveryStatus = "failed"
	WebhookDeliveryStatusClientError WebhookDeliveryStatus = "client_error"
	WebhookDeliveryStatusServerError WebhookDeliveryStatus = "server_error"
	WebhookDeliveryStatusTimeout     WebhookDeliveryStatus = "timeout"
)

// WebhookEvent is an open enum: values the API adds later decode unchanged.
type WebhookEvent string

// Known values of WebhookEvent.
const (
	WebhookEventMessageCreated        WebhookEvent = "message.created"
	WebhookEventMessageSent           WebhookEvent = "message.sent"
	WebhookEventMessageDelivered      WebhookEvent = "message.delivered"
	WebhookEventMessageAutoReplied    WebhookEvent = "message.auto_replied"
	WebhookEventMessageHardBounced    WebhookEvent = "message.hard_bounced"
	WebhookEventMessageSoftBounced    WebhookEvent = "message.soft_bounced"
	WebhookEventMessageSpamComplaint  WebhookEvent = "message.spam_complaint"
	WebhookEventMessageFailed         WebhookEvent = "message.failed"
	WebhookEventMessageSuppressed     WebhookEvent = "message.suppressed"
	WebhookEventMessageUnsubscribed   WebhookEvent = "message.unsubscribed"
	WebhookEventMessageOpened         WebhookEvent = "message.opened"
	WebhookEventMessageClicked        WebhookEvent = "message.clicked"
	WebhookEventMessageInbound        WebhookEvent = "message.inbound"
	WebhookEventMessagePolicyRejected WebhookEvent = "message.policy_rejected"
	WebhookEventMessageScheduled      WebhookEvent = "message.scheduled"
	WebhookEventMessageRescheduled    WebhookEvent = "message.rescheduled"
	WebhookEventMessageCanceled       WebhookEvent = "message.canceled"
	WebhookEventMessageReleased       WebhookEvent = "message.released"
	WebhookEventSuppressionAdded      WebhookEvent = "suppression.added"
	WebhookEventSuppressionRemoved    WebhookEvent = "suppression.removed"
	WebhookEventWebhookTest           WebhookEvent = "webhook.test"
)

type WebhookListData struct {
	ID         string       `json:"id"`
	Scope      WebhookScope `json:"scope"`
	ProjectIDs []string     `json:"project_ids"`
	RouteIDs   []string     `json:"route_ids"`
	// Use route_ids.
	//
	// Deprecated: the API marks this as deprecated.
	RouteID            *string                   `json:"route_id"`
	Name               string                    `json:"name"`
	URL                string                    `json:"url"`
	HasBasicAuth       bool                      `json:"has_basic_auth"`
	Events             []string                  `json:"events"`
	Enabled            bool                      `json:"enabled"`
	DeliveryModeFilter WebhookDeliveryModeFilter `json:"delivery_mode_filter"`
	LastCalledAt       *string                   `json:"last_called_at"`
	CreatedAt          string                    `json:"created_at"`
	UpdatedAt          string                    `json:"updated_at"`
}

// WebhookMutationResponse: The webhook after a change, with a confirmation message.
type WebhookMutationResponse struct {
	Data WebhookData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}

// WebhookScope is an open enum: values the API adds later decode unchanged.
type WebhookScope string

// Known values of WebhookScope.
const (
	WebhookScopeTeam    WebhookScope = "team"
	WebhookScopeProject WebhookScope = "project"
	WebhookScopeRoute   WebhookScope = "route"
)

type WebhookSecretData struct {
	ID         string       `json:"id"`
	Scope      WebhookScope `json:"scope"`
	ProjectIDs []string     `json:"project_ids"`
	RouteIDs   []string     `json:"route_ids"`
	// Use route_ids.
	//
	// Deprecated: the API marks this as deprecated.
	RouteID              *string                   `json:"route_id"`
	Name                 string                    `json:"name"`
	URL                  string                    `json:"url"`
	HasBasicAuth         bool                      `json:"has_basic_auth"`
	Events               []string                  `json:"events"`
	Enabled              bool                      `json:"enabled"`
	IncludeMachineEvents bool                      `json:"include_machine_events"`
	DeliveryModeFilter   WebhookDeliveryModeFilter `json:"delivery_mode_filter"`
	Secret               string                    `json:"secret"`
	LastCalledAt         *string                   `json:"last_called_at"`
	CreatedAt            string                    `json:"created_at"`
	UpdatedAt            string                    `json:"updated_at"`
}

// WebhookSecretResponse: The webhook with its signing secret, which is only returned when the secret is created or regenerated.
type WebhookSecretResponse struct {
	Data WebhookSecretData `json:"data"`
	// Human-readable confirmation
	Message string `json:"message"`
}