domain

type AltPrice struct {
	Price money.Money `json:"price"`
	// Unit is the period the price covers: month or year (every 1 unit).
	Unit engine.Unit `json:"unit" enum:"month,year"`
}

type Category struct {
	ID          string `json:"id"`
	HouseholdID string `json:"householdId"`
	Name        string `json:"name"`
	Color       string `json:"color,omitempty"`
}

type Charge struct {
	ID             string       `json:"id"`
	SubscriptionID string       `json:"subscriptionId"`
	OriginalDate   engine.Date  `json:"originalDate"`
	DueDate        engine.Date  `json:"dueDate"`
	Amount         money.Money  `json:"amount"`
	ChargedAmount  money.Money  `json:"chargedAmount,omitzero"` // what the bank actually took, any currency
	Status         ChargeStatus `json:"status"`
	ResolvedAt     *time.Time   `json:"resolvedAt,omitempty"`
	Note           string       `json:"note,omitempty"`
	// Decision records that the member chose to keep this renewal ("keep"),
	// so Exhale stops asking before the cancellation deadline.
	Decision  string    `json:"decision,omitempty"`
	UpdatedAt time.Time `json:"updatedAt"`
	Version   int       `json:"version"`
}

type ChargeStatus string

type Details struct {
	// StartedOn is when the member first subscribed (may be long before the
	// first charge Exhale knows about).
	StartedOn engine.Date `json:"startedOn,omitzero"`
	// TrialEndsOn is the day a free trial turns into the first paid charge.
	TrialEndsOn engine.Date `json:"trialEndsOn,omitzero"`
	// NoticeDays is how many days before a renewal the provider must be told
	// to cancel (0: cancel any time before the charge).
	NoticeDays int     `json:"noticeDays,omitempty"`
	Renewal    Renewal `json:"renewal,omitempty"`
	// CancelURL is where the subscription is cancelled or managed.
	CancelURL string `json:"cancelUrl,omitempty"`
	// Account is the login the subscription lives under ("ana@work.com").
	Account string `json:"account,omitempty"`
	// Shares split the cost between members; empty means the payer carries it.
	Shares []Share `json:"shares,omitempty"`
	// NextPrice is a scheduled price change.
	NextPrice *PriceChange `json:"nextPrice,omitempty"`
	Usage     *Usage       `json:"usage,omitempty"`
	// Tags are free labels (tags.go).
	Tags []string `json:"tags,omitempty"`
	// AltPrice is another price the provider offers, e.g. yearly (tags.go).
	AltPrice *AltPrice `json:"altPrice,omitempty"`
}

type EditScope string

type Error struct {
	Kind error
	Text Text
	// contains filtered or unexported fields
}

type Field string

type Household struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Currency string `json:"currency"` // main currency, ISO 4217
	Timezone string `json:"timezone"` // IANA name, e.g. "Europe/Madrid"
	Locale   string `json:"locale"`   // e.g. "es", "en"
	// Default time of day for reminders, in Timezone (09:00 by default).
	ReminderHour   int `json:"reminderHour"`
	ReminderMinute int `json:"reminderMinute"`
	// Payday is the day of the month the household gets paid (0: not set;
	// 31 means the last day of shorter months).
	Payday int `json:"payday,omitempty"`
	// An unanswered "was it charged?" is asked ConfirmTimes times in all,
	// every ConfirmEveryDays days. New subscriptions copy it.
	ConfirmTimes     int `json:"confirmTimes"`
	ConfirmEveryDays int `json:"confirmEveryDays"`
}

type Member struct {
	ID          string `json:"id"`
	HouseholdID string `json:"householdId"`
	Name        string `json:"name"`
	Email       string `json:"email,omitempty"`
	Role        Role   `json:"role"`
	// Locale is the language this person chose; empty: the household's.
	Locale string `json:"locale,omitempty"`
}

type PaymentMethod struct {
	ID          string            `json:"id"`
	HouseholdID string            `json:"householdId"`
	Name        string            `json:"name"` // "Revolut", "Visa"
	Kind        PaymentMethodKind `json:"kind"`
	Last4       string            `json:"last4,omitempty"`
	ExpiresOn   engine.Date       `json:"expiresOn,omitzero"` // last valid day
	OwnerID     string            `json:"ownerId,omitempty"`
}

type PaymentMethodKind string

type PriceChange struct {
	From  engine.Date `json:"from"`
	Price money.Money `json:"price"`
}

type ReminderPolicy struct {
	DaysBefore []int `json:"daysBefore"` // e.g. [3, 0]: three days before and on the day
	Hour       int   `json:"hour"`       // local time of day in the household zone
	Minute     int   `json:"minute"`
	// ConfirmAfterDays asks "was it charged?" this many days after the due
	// date; < 0 disables the question.
	ConfirmAfterDays int `json:"confirmAfterDays"`
	// ConfirmTimes is how many times "was it charged?" is asked while nobody
	// answers (1: once), ConfirmEveryDays the days between two asks.
	ConfirmTimes     int `json:"confirmTimes"`
	ConfirmEveryDays int `json:"confirmEveryDays"`
}

type Renewal string

type Role string

type Saved struct {
	F string     `json:"f"`
	A []savedArg `json:"a,omitempty"`
}

type Share struct {
	MemberID string `json:"memberId"`
	// Weight is relative: two members with weight 1 pay half each; weights 2
	// and 1 split two thirds and one third.
	Weight int `json:"weight"`
}

type Subscription struct {
	ID              string             `json:"id"`
	HouseholdID     string             `json:"householdId"`
	Name            string             `json:"name"`
	Price           money.Money        `json:"price"`
	Schedule        engine.Schedule    `json:"schedule"`
	CategoryID      string             `json:"categoryId,omitempty"`
	PaymentMethodID string             `json:"paymentMethodId,omitempty"`
	PayerID         string             `json:"payerId,omitempty"`
	Visibility      Visibility         `json:"visibility"`
	Status          SubscriptionStatus `json:"status"`
	URL             string             `json:"url,omitempty"`
	Notes           string             `json:"notes,omitempty"`
	AutoConfirm     bool               `json:"autoConfirm"` // mark charges paid automatically on the due date
	Reminders       ReminderPolicy     `json:"reminders"`
	Details
	CreatedBy string    `json:"createdBy,omitempty"`
	CreatedAt time.Time `json:"createdAt"`
	UpdatedAt time.Time `json:"updatedAt"`
	Version   int       `json:"version"` // optimistic locking
}

type SubscriptionStatus string

type Text struct {
	Format string
	Args   []any
}

type Usage struct {
	Using bool      `json:"using"`
	At    time.Time `json:"at"`
}

type Visibility string

type Wire struct {
	Key  string `json:"key"`
	Args []any  `json:"args"`
}

type Word string