marketing

type Audience struct {
	// ID is the server-assigned audience id ("aud_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// Name is the audience's label. Required, trimmed, capped at 1024 bytes.
	Name string `json:"name"`
	// Event is the analytics event a member must have fired. EMPTY MEANS NO
	// FILTER: the audience is then every mailable customer in the org, and no
	// warehouse is consulted.
	Event string `json:"event"`
	// WindowDays is how far back the event counts, ending now. 0 means 30 and
	// nothing above 3650 is honoured. Ignored when Event is empty.
	WindowDays int `json:"windowDays"`
	// CreatedAt and UpdatedAt are unix seconds, both server-assigned.
	CreatedAt int64 `json:"createdAt"`
	UpdatedAt int64 `json:"updatedAt"`
}

type AudienceList struct {
	// Data is the page; an empty array when the org has saved no audience.
	Data []Audience `json:"data"`
}

type AudiencePreview struct {
	// Available is false when the roster or the warehouse could not be read; the
	// counts are then zero because nothing was measured, not because the cohort
	// is empty, and Reason says which read failed.
	Available bool   `json:"available"`
	Reason    string `json:"reason,omitempty"`
	// Count is the cohort size: distinct warehouse identifiers for an event
	// audience, mailable customers for an event-less (whole-org) one.
	Count int64 `json:"count"`
	// Deliverable is how many de-duplicated addresses a send would reach, and
	// Unmatched how many cohort identifiers named no customer. Unmatched is
	// reported rather than hidden: it is the honest explanation for a cohort of
	// 500 that mails 3.
	Deliverable int `json:"deliverable"`
	Unmatched   int `json:"unmatched"`
	// Sample is up to 1000 cohort IDENTIFIERS — never addresses, which product
	// analytics does not hold. Empty for an event-less (whole-org) audience.
	Sample []string `json:"sample"`
	// Source names where the cohort was read: the events table for an event
	// audience, "iam:<org>" for the whole-org one.
	Source string `json:"source"`
}

type AudienceRef struct {
	// ID is the audience id from the path, as returned by create.
	ID string `json:"id"`
}

type CalendarPost struct {
	// ID is the server-assigned post id ("cal_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// Title is the post's internal label, capped at 1024 bytes.
	Title string `json:"title"`
	// Body is the post text. Required.
	Body string `json:"body"`
	// Channel is the target network: x, facebook, instagram, linkedin, tiktok,
	// youtube or threads. Required — a post must name where it goes.
	Channel string `json:"channel"`
	// ScheduledAt is the unix publish time; 0 leaves the post a draft, and any
	// value makes it "scheduled" for the durable sweep to pick up.
	ScheduledAt int64 `json:"scheduledAt"`
	// Status is draft, scheduled, published, failed or canceled. Server-owned.
	Status string `json:"status"`
	// PublishedAt is when the publish succeeded; 0 until it does.
	PublishedAt int64 `json:"publishedAt"`
	// Error is the exact reason the last publish attempt failed — the honest
	// record behind a "failed" status, never a faked success.
	Error string `json:"error,omitempty"`
	// CreatedAt and UpdatedAt are unix seconds, both server-assigned.
	CreatedAt int64 `json:"createdAt"`
	UpdatedAt int64 `json:"updatedAt"`
}

type Campaign struct {
	// ID is the server-assigned campaign id ("camp_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// Name is the campaign's label. Required, trimmed, capped at 1024 bytes.
	Name string `json:"name"`
	// Channel is the delivery surface: email, sms, social, meta, google or
	// tiktok. Empty means email.
	Channel string `json:"channel"`
	// Status is the lifecycle: draft, scheduled, active, paused or completed.
	// Empty means draft.
	Status string `json:"status"`
	// Objective is the free-text goal ("signups"), capped at 1024 bytes.
	Objective string `json:"objective"`
	// Budget and Spend are minor units (USD cents), clamped to >= 0.
	Budget int64 `json:"budget"`
	Spend  int64 `json:"spend"`
	// ScheduledAt is the unix send time; 0 means unscheduled. Setting it on a
	// campaign with no explicit status makes that status "scheduled".
	ScheduledAt int64 `json:"scheduledAt"`
	// CreatedAt and UpdatedAt are unix seconds, both server-assigned.
	CreatedAt int64 `json:"createdAt"`
	UpdatedAt int64 `json:"updatedAt"`
}

type CampaignList struct {
	// Data is the page; an empty array when the org has no matching campaign.
	Data []Campaign `json:"data"`
}

type CampaignQuery struct {
	// Status keeps only campaigns in that lifecycle state (draft, scheduled,
	// active, paused, completed). Empty means every campaign.
	Status string `json:"status"`
	// Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.
	Limit int `json:"limit"`
}

type CampaignRef struct {
	// ID is the campaign id from the path, as returned by create.
	ID string `json:"id"`
}

type EnrollInput struct {
	// ID is the sequence id from the path.
	ID string `json:"id"`
	// Address is a single recipient, normalized (lower-cased, trimmed) before
	// use. Give this OR audienceId, never both and never neither.
	Address string `json:"address"`
	// AudienceID fans the sequence out over a saved audience, resolved live to
	// the org's mailable customers. Email only.
	AudienceID string `json:"audienceId"`
	// Channel is the delivery surface; empty means email. An audience resolves
	// mailboxes, so an audience enroll must be email.
	Channel string `json:"channel"`
}

type EnrollResult struct {
	// Resolved is how many addresses the request named — 1 for an address, the
	// audience's deliverable count for an audience.
	Resolved int `json:"resolved"`
	// Enrolled is how many started a walk on this call.
	Enrolled int `json:"enrolled"`
	// AlreadyEnrolled is how many this sequence had already taken and were left
	// alone.
	AlreadyEnrolled int `json:"alreadyEnrolled"`
	// EnrollmentID names the walk, and is present ONLY for a single-address
	// enroll — a fan-out has many, and reporting one of them would be a lie.
	EnrollmentID string `json:"enrollmentId,omitempty"`
}

type Enrollment struct {
	// ID is the server-assigned enrollment id ("enr_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// SequenceID is the sequence being walked.
	SequenceID string `json:"sequenceId"`
	// Address is the normalized (lower-cased, trimmed) recipient.
	Address string `json:"address"`
	// Channel is the delivery surface the steps go out on.
	Channel string `json:"channel"`
	// CurrentStep is the index of the step that sends next.
	CurrentStep int `json:"currentStep"`
	// Status is active, completed or canceled.
	Status string `json:"status"`
	// NextRunAt is the unix time the current step comes due; 0 once the walk has
	// ended. It IS the schedule — durable in SQLite, so it survives restarts.
	NextRunAt int64 `json:"nextRunAt"`
	// EnrolledAt and UpdatedAt are unix seconds.
	EnrolledAt int64 `json:"enrolledAt"`
	UpdatedAt  int64 `json:"updatedAt"`
}

type EnrollmentList struct {
	Data []Enrollment `json:"data"`
}

type EnrollmentQuery struct {
	// ID is the sequence id from the path.
	ID string `json:"id"`
	// Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.
	Limit int `json:"limit"`
}

type EnrollmentRef struct {
	// ID is the sequence id from the path.
	ID string `json:"id"`
	// EID is the enrollment id from the path, as returned by a single-address
	// enroll.
	EID string `json:"eid"`
}

type Page struct {
	// Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.
	Limit int `json:"limit"`
}

type PostList struct {
	Data []CalendarPost `json:"data"`
}

type PostQuery struct {
	// Status keeps only posts in that state (draft, scheduled, published,
	// failed, canceled). Empty means every post.
	Status string `json:"status"`
	// Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured.
	Limit int `json:"limit"`
}

type PostRef struct {
	// ID is the post id from the path, as returned by create.
	ID string `json:"id"`
}

type Promo struct {
	// Code is the promo id, e.g. "first1000".
	Code string `json:"code"`
	// Description is the human-readable offer.
	Description string `json:"description"`
	// PercentOff is the discount applied to ONE month's list price.
	PercentOff int `json:"percentOff"`
	// MaxRedemptions is the hard fleet-wide cap; the redemption past it is
	// declined.
	MaxRedemptions int `json:"maxRedemptions"`
	// TeamSeatCap is how many Team seats bill at the promo rate; seats beyond it
	// bill at list.
	TeamSeatCap int `json:"teamSeatCap"`
	// Plans is the csv of eligible plan ids ("pro,max,team").
	Plans string `json:"plans"`
	// Active is false for a promo that is no longer offered; an inactive promo
	// quotes as ineligible and refuses to redeem.
	Active bool `json:"active"`
	// CreatedAt is unix seconds.
	CreatedAt int64 `json:"createdAt"`
}

type PromoList struct {
	Data []PromoStatus `json:"data"`
}

type PromoRef struct {
	// Code is the promo code from the path, e.g. "first1000".
	Code string `json:"code"`
}

type PromoStatus struct {
	Promo Promo `json:"promo"`
	// Redeemed is how many orgs have taken it, Remaining how many are left under
	// the fleet-wide cap.
	Redeemed  int `json:"redeemed"`
	Remaining int `json:"remaining"`
}

type Quote struct {
	// Code, Plan and Seats echo what was quoted.
	Code  string `json:"code"`
	Plan  string `json:"plan"`
	Seats int    `json:"seats"`
	// Eligible says whether a redeem would be accepted right now; Reason says
	// why not when it would not.
	Eligible bool   `json:"eligible"`
	Reason   string `json:"reason,omitempty"`
	// ListCents is the undiscounted month price, ChargeCents what would be
	// charged, DiscountCents the difference — all in USD cents.
	ListCents     int64 `json:"listCents"`
	ChargeCents   int64 `json:"chargeCents"`
	DiscountCents int64 `json:"discountCents"`
	// Remaining is how many redemptions are left under the fleet-wide cap.
	Remaining int `json:"remaining"`
}

type QuoteQuery struct {
	// Code is the promo code from the path.
	Code string `json:"code"`
	// Plan is the plan being priced: pro, max or team. Anything else (including
	// the free Developer plan) has no list price and so nothing to discount.
	Plan string `json:"plan"`
	// Seats is the Team seat count; 0 means 1, and it is ignored for the
	// single-seat plans.
	Seats int `json:"seats"`
}

type RedeemInput struct {
	// Code is the promo code from the path.
	Code string `json:"code"`
	// Instrument identifies the payment method. It is the anti-farming key: one
	// redemption per instrument, fleet-wide, and it is REQUIRED — an absent
	// instrument is refused, never waved through.
	Instrument string `json:"instrument"`
}

type RedeemResult struct {
	Redemption Redemption `json:"redemption"`
	// ChargeCents is what month one costs after the discount, DiscountCents the
	// discount that produced it. Both are quoted figures against the org's
	// derived plan — NOTHING WAS CREDITED and no wallet moved.
	ChargeCents   int64 `json:"chargeCents"`
	DiscountCents int64 `json:"discountCents"`
	// AlreadyRedeemed is true when this org had already taken the promo and the
	// call was an idempotent replay.
	AlreadyRedeemed bool `json:"alreadyRedeemed"`
}

type Redemption struct {
	// Code is the promo redeemed.
	Code       string `json:"code"`
	Org        string `json:"-"`
	Instrument string `json:"-"`
	// Plan and Seats are what was redeemed against. Both are DERIVED server-side
	// — Plan from the org's live paid subscription, Seats from claimSeats — and
	// neither is ever read from the request.
	Plan  string `json:"plan"`
	Seats int    `json:"seats"`
	// DiscountCents is the month-one discount this redemption CLAIMS, in USD
	// cents. It is a recorded figure, NOT a balance: nothing was credited and no
	// wallet moved. An admin granting against this claim is what would make it
	// money, and that decision happens on the admin surface, not here.
	DiscountCents int64 `json:"discountCents"`
	// RedeemedAt is unix seconds.
	RedeemedAt int64 `json:"redeemedAt"`
}

type ScheduleInput struct {
	// ID is the campaign id from the path.
	ID string `json:"id"`
	// ScheduledAt is the unix send time. 0 clears the schedule.
	ScheduledAt int64 `json:"scheduledAt"`
}

type Sequence struct {
	// ID is the server-assigned sequence id ("seq_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// Name is the sequence's label. Required, trimmed, capped at 1024 bytes.
	Name string `json:"name"`
	// Status is the lifecycle: draft, active or archived. Empty means draft, and
	// ONLY an active sequence accepts enrollments.
	Status string `json:"status"`
	// CreatedAt and UpdatedAt are unix seconds, both server-assigned.
	CreatedAt int64 `json:"createdAt"`
	UpdatedAt int64 `json:"updatedAt"`
}

type SequenceList struct {
	// Data is the page; an empty array when the org has no sequence.
	Data []Sequence `json:"data"`
}

type SequenceRef struct {
	// ID is the sequence id from the path, as returned by create.
	ID string `json:"id"`
}

type SequenceStatus struct {
	// ID is the sequence id from the path.
	ID string `json:"id"`
	// Status is draft, active or archived. Required; there is no default here,
	// unlike on create. Only an active sequence accepts enrollments.
	Status string `json:"status"`
}

type SequenceView struct {
	Sequence Sequence `json:"sequence"`
	// Steps are in send order (idx ascending); empty for a sequence with no
	// messages yet, which enrolls fine and completes immediately.
	Steps []Step `json:"steps"`
}

type Step struct {
	// ID is the server-assigned step id ("step_" + 128 random bits).
	ID  string `json:"id"`
	Org string `json:"-"`
	// SequenceID is the sequence this step belongs to.
	SequenceID string `json:"sequenceId"`
	// Idx is the step's 0-based position, assigned by appending: a new step
	// always lands after the last one.
	Idx int `json:"idx"`
	// DelaySeconds is how long after the previous step this one sends (after
	// enrollment, for step 0).
	DelaySeconds int64 `json:"delaySeconds"`
	// Subject is the email subject line, capped at 1024 bytes.
	Subject string `json:"subject"`
	// Body is the message text. Required. The signed one-click unsubscribe link
	// is appended to it at send time.
	Body string `json:"body"`
	// CreatedAt is unix seconds, server-assigned.
	CreatedAt int64 `json:"createdAt"`
}

type StepInput struct {
	// SequenceID is the sequence id from the path (the route's :id).
	SequenceID string `json:"id"`
	// DelaySeconds is how long after the previous step this one sends (after
	// enrollment, for the first step). Must be >= 0.
	DelaySeconds int64 `json:"delaySeconds"`
	// Subject is the email subject line, capped at 1024 bytes.
	Subject string `json:"subject"`
	// Body is the message text. Required.
	Body string `json:"body"`
}

type StepList struct {
	Data []Step `json:"data"`
}

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

type Summary struct {
	// Campaigns is how many campaigns the org has, Active how many are running.
	Campaigns int `json:"campaigns"`
	Active    int `json:"active"`
	// Budget and Spend are the summed campaign budget and spend, in cents.
	Budget int64 `json:"budget"`
	Spend  int64 `json:"spend"`
}

type Suppression struct {
	Org string `json:"-"`
	// Channel is the surface opted out of: email, sms, social, meta, google or
	// tiktok. Empty means email. Opting out of one leaves the others reachable.
	Channel string `json:"channel"`
	// Address is the recipient, normalized (lower-cased, trimmed) so an opt-out
	// cannot be slipped past on a case or whitespace difference. Required.
	Address string `json:"address"`
	// Reason is a free-text note, capped at 1024 bytes. The public one-click
	// endpoint records "one-click unsubscribe".
	Reason string `json:"reason"`
	// CreatedAt is unix seconds, server-assigned.
	CreatedAt int64 `json:"createdAt"`
}

type SuppressionList struct {
	Data []Suppression `json:"data"`
}

type SweepResult struct {
	Advanced  int `json:"advanced"`  // drip steps advanced
	Published int `json:"published"` // calendar posts published
}

type UnsubscribeInput struct {
	// Org is the org the link was minted for.
	Org string `json:"org"`
	// Channel is the surface to opt out of.
	Channel string `json:"channel"`
	// Address is the recipient to opt out.
	Address string `json:"address"`
	// Token is the HMAC over (org, channel, address). It is the ONLY authority
	// here — there is no principal — so it binds the request to one tuple and
	// nothing else.
	Token string `json:"token"`
}

type Unsubscribed struct {
	Unsubscribed bool   `json:"unsubscribed"`
	Address      string `json:"address"`
	Channel      string `json:"channel"`
}