notifications

type AccountMessage func(n contracts.AccountNotification) string

type AccountOption func(*accountConfig)

type AccountTemplates struct {
	// RegistrationSuccess welcomes a user after successful registration.
	RegistrationSuccess AccountMessage
	// RegistrationFailed reports that registration could not be completed.
	RegistrationFailed AccountMessage
	// WrongAttempt alerts on an incorrect PIN entry and counts down to lockout.
	WrongAttempt AccountMessage
	// AccountLocked is the security alert sent once repeated failures lock the
	// account.
	AccountLocked AccountMessage
	// PINChanged confirms a successful PIN change.
	PINChanged AccountMessage
	// PINChangeFailed alerts on an unsuccessful PIN change.
	PINChangeFailed AccountMessage
	// PINReset confirms a successful reset through the recovery flow.
	PINReset AccountMessage
	// PINResetFailed alerts on an unsuccessful reset.
	PINResetFailed AccountMessage
}

type LanguageResolver func(ctx context.Context, phoneNumber string) string

type LoanMessage func(n contracts.LoanNotification) string

type LoanOption func(*loanConfig)

type LoanTemplates struct {
	Approved LoanMessage
	Rejected LoanMessage
	// Disbursed announces that fiat has been pushed to the borrower.
	Disbursed LoanMessage
	// Failed is the credit-default notice.
	Failed LoanMessage
	// OffRampFailed is sent when vault borrow succeeded but the off-ramp could
	// not be initiated or completed and the USDC has been returned to the
	// vault. The borrower owes nothing — distinct from the credit-default
	// Failed.
	OffRampFailed LoanMessage
	// CashPickupApproved replaces Approved for cash-pickup loans, whose
	// generic wording implies a push disbursement. A second SMS with the
	// MoneyGram interactive URL follows once the off-ramp is initiated (see
	// CashPickupInitiated).
	CashPickupApproved LoanMessage
	// Repaid confirms the treasury-to-vault leg confirmed and the loan is
	// closed — the terminal notification, sent once, distinct from
	// RepaymentReceived which fires earlier (cash on the treasury, vault leg
	// not yet confirmed).
	Repaid            LoanMessage
	RepaymentReceived LoanMessage
	// RepaymentOverdue, RepaymentSoon and RepaymentUpcoming are selected by
	// [SMSLoanNotifier.NotifyRepaymentReminder] from the days remaining; use
	// [DaysUntilDue] to render that count.
	RepaymentOverdue  LoanMessage
	RepaymentSoon     LoanMessage
	RepaymentUpcoming LoanMessage
	// RepaymentInitiated carries the MoneyGram interactive URL for a
	// borrower-initiated cash repayment. The USSD session ends before the
	// borrower can act on it, so this SMS is the only delivery. The copy must
	// make clear the borrower is paying, not collecting — the cash-pickup SMS
	// carries a superficially similar link with the opposite meaning.
	RepaymentInitiated LoanMessage
	// RepaymentFailed reports that a deposit could not be opened. Nothing was
	// paid and the loan is untouched, so the copy must not read as a default
	// notice — it asks the borrower to try again.
	RepaymentFailed LoanMessage
	// RepaymentReference carries the code the borrower quotes at the agent
	// counter to pay in. Read from CashPickupRef.
	RepaymentReference LoanMessage
	// RepaymentMoreInfo carries MoneyGram's transaction page, sent when no
	// reference has been issued. Read from InteractiveURL.
	RepaymentMoreInfo LoanMessage
	// RepaymentPaybill carries the M-Pesa paybill instructions for a
	// mobile-money repayment. Read from PaybillNumber, LoanReference, and
	// DisplayAmount/DisplayCurrency.
	RepaymentPaybill LoanMessage
	// RepaymentWindowExpiring warns that an opened deposit is about to lapse.
	// Use [ExpiresInText] for the remaining time.
	RepaymentWindowExpiring LoanMessage
	// RepaymentExpired reports that an opened deposit lapsed unused. Nothing
	// was paid and the loan is untouched, so the copy must not read as a
	// default notice.
	RepaymentExpired LoanMessage
	// CashPickupInitiated carries the MoneyGram interactive URL. The URL is
	// single-use and the payout amount is not yet locked, so the copy must say
	// the final amount appears in the link.
	CashPickupInitiated LoanMessage
	// CashPickupReady carries the reference the borrower quotes at the agent.
	// Runs to two SMS segments; the support link is worth the second. Unlike
	// InteractiveURL, CashPickupInfoURL stays valid after settlement.
	CashPickupReady LoanMessage
	// Statement answers a user-initiated "My Loans" request with one loan's
	// reference, amount and due date. Use [DueDateText] for the date — a loan
	// may have none.
	Statement LoanMessage
	// CashPickupCancelled is sent when MoneyGram refunds a cash-pickup loan,
	// which usually means the borrower cancelled in MoneyGram's own app —
	// sometimes by mistake. The wording has to reassure rather than alarm:
	// nothing is owed and they can simply request again.
	CashPickupCancelled LoanMessage
}

type NoOpAccountNotifier struct{}

type NoOpLoanNotifier struct{}

type NoOpNotifier struct{}

type Notifier interface {
	Send(ctx context.Context, to string, message string) error
}

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

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

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