builder

type AppPayload struct {
	Platform       string `json:"platform"`
	IOSID          string `json:"ios_id"`
	AndroidPackage string `json:"android_package"`
}

type BookmarkPayload struct {
	Title string `json:"title"`
	URL   string `json:"url"`
}

type Builder interface {
	// Name is the registry key.
	Name() string
	// Build renders the payload as the raw string to encode.
	Build(payload any) (string, error)
	// Parse recovers a payload from a raw string. ok is false when the string
	// is not of this builder's form.
	Parse(raw string) (payload any, ok bool)
	// Fields describes the accepted payload fields, for /v1/build docs and
	// validation.
	Fields() []Field
}

type CryptoPayload struct {
	Coin    string  `json:"coin"`
	Address string  `json:"address"`
	Amount  float64 `json:"amount"`
	Label   string  `json:"label"`
	Message string  `json:"message"`
}

type Describer interface {
	// Describe reports what the builder made of the payload. The map is
	// serialised straight to JSON, so its keys are part of the API.
	Describe(payload any) (map[string]any, error)
}

type EPCPayload struct {
	BIC         string  `json:"bic"`
	Name        string  `json:"name"`
	IBAN        string  `json:"iban"`
	Amount      float64 `json:"amount"`
	Purpose     string  `json:"purpose"`
	Reference   string  `json:"reference"`
	Remittance  string  `json:"remittance"`
	Information string  `json:"information"`
}

type EmailPayload struct {
	Email   string `json:"email"`
	Subject string `json:"subject"`
	Body    string `json:"body"`
}

type EventPayload struct {
	Summary     string `json:"summary"`
	Start       string `json:"start"`
	End         string `json:"end"`
	Location    string `json:"location"`
	Description string `json:"description"`
}

type Field struct {
	// Name is the payload key, snake_case to match both JSON bodies and
	// query parameters.
	Name string `json:"name"`
	// Type is the accepted value type: string, bool, or number. Query
	// parameters arrive as strings and are coerced, so "bool" also accepts
	// "true"/"false".
	Type string `json:"type"`
	// Description is one line of prose for the API docs.
	Description string `json:"description"`
	// Required reports whether Build fails without this field.
	Required bool `json:"required"`
	// Example is a value that is valid on its own and valid alongside every
	// other field's Example. It is empty for a field that conflicts with
	// another field's example, which is why the docs carry the sample in the
	// description instead.
	Example string `json:"example,omitempty"`
}

type GeoPayload struct {
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
	Altitude  float64 `json:"altitude"`
	Query     string  `json:"query"`
}

type LocationPayload struct {
	Location string `json:"location"`
	Origin   string `json:"origin"`
	Mode     string `json:"mode"`
	Zoom     int    `json:"zoom"`
	Language string `json:"language"`
	Region   string `json:"region"`
}

type MeCardPayload struct {
	FirstName   string `json:"first_name"`
	LastName    string `json:"last_name"`
	Phone       string `json:"phone"`
	PhoneRegion string `json:"phone_region"`
	Email       string `json:"email"`
	URL         string `json:"url"`
	Address     string `json:"address"`
	Note        string `json:"note"`
}

type OTPPayload struct {
	Type      string  `json:"type"`
	Issuer    string  `json:"issuer"`
	Account   string  `json:"account"`
	Secret    string  `json:"secret"`
	Algorithm string  `json:"algorithm"`
	Digits    float64 `json:"digits"`
	Period    float64 `json:"period"`
	Counter   float64 `json:"counter"`
}

type RawPayload struct {
	Data string `json:"data"`
}

type SMSPayload struct {
	Phone   string `json:"phone"`
	Message string `json:"message"`
}

type TelPayload struct {
	Phone       string `json:"phone"`
	PhoneRegion string `json:"phone_region"`
}

type TextPayload struct {
	Text string `json:"text"`
}

type URLPayload struct {
	URL      string `json:"url"`
	AllowAny bool   `json:"allow_any"`
}

type VCardPayload struct {
	FirstName   string `json:"first_name"`
	LastName    string `json:"last_name"`
	Org         string `json:"org"`
	Title       string `json:"title"`
	Phone       string `json:"phone"`
	PhoneRegion string `json:"phone_region"`
	Mobile      string `json:"mobile"`
	Email       string `json:"email"`
	URL         string `json:"url"`
	Street      string `json:"street"`
	City        string `json:"city"`
	Region      string `json:"region"`
	PostalCode  string `json:"postal_code"`
	Country     string `json:"country"`
	Note        string `json:"note"`
}

type WhatsAppPayload struct {
	Phone       string `json:"phone"`
	PhoneRegion string `json:"phone_region"`
	Message     string `json:"message"`
}

type WiFiPayload struct {
	SSID     string `json:"ssid"`
	Password string `json:"password"`
	Auth     string `json:"auth"`
	Hidden   bool   `json:"hidden"`
}