internal

type BuildOptions struct {
	*ParseOptions
}

type BuildRequest struct {
	Template []byte `json:"template"`
	Data     []byte `json:"data"`
	DocType  string `json:"type"`
	Envelop  bool   `json:"envelop"`
}

type BulkOptions struct {
	// In is the input stream of requests
	In io.Reader
	// DefaultPrivateKey is the default private key to use with sign requests
	DefaultPrivateKey *dsig.PrivateKey
}

type BulkRequest struct {
	// Action is the action to perform on the payload.
	Action string `json:"action"`
	// ReqID is an opaque request ID, which is returned with the associated
	// response.
	ReqID string `json:"req_id"`
	// Payload is the payload upon which to perform the action.
	Payload json.RawMessage `json:"payload"`
	// When true, responses are indented for easier human consumption
	Indent bool `json:"indent"`
}

type BulkResponse struct {
	// ReqID is an exact copy of the value provided in the request, if any.
	ReqID string `json:"req_id,omitempty"`
	// SeqID is the sequence ID of the request this response correspond to,
	// starting at 1.
	SeqID int64 `json:"seq_id"`
	// Payload is the response payload.
	Payload json.RawMessage `json:"payload,omitempty"`
	// Error represents an error processing a request item.
	Error *Error `json:"error"`
	// IsFinal will be true once the end of the request input stream has been
	// reached, or an unrecoverable error has occurred.
	IsFinal bool `json:"is_final"`
}

type CorrectOptions struct {
	// we don't need all of the parse options
	*ParseOptions
	OptionsSchema bool
	Credit        bool
	Debit         bool
	Date          cal.Date
	Data          []byte // raw json of correction options
}

type CorrectRequest struct {
	Data    []byte `json:"data"`
	Options []byte `json:"options"`
	Schema  bool   `json:"schema"`
}

type Error struct {
	Code    int              `json:"code"`             // HTTP status code
	Key     cbc.Key          `json:"key,omitempty"`    // For GOBL errors
	Fields  gobl.FieldErrors `json:"fields,omitempty"` // Structured error messages for fields
	Message string           `json:"message,omitempty"`
}

type KeygenResponse struct {
	Private *dsig.PrivateKey `json:"private"`
	Public  *dsig.PublicKey  `json:"public"`
}

type ParseOptions struct {
	Template  io.Reader
	Input     io.Reader
	DocType   string
	SetYAML   map[string]string
	SetString map[string]string
	SetFile   map[string]string

	// When set to `true`, the parsed data is wrapped in an envelope (if needed).
	Envelop bool
}

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

type SchemaRequest struct {
	Path string `json:"path"`
}

type SignOptions struct {
	*ParseOptions
	PrivateKey *dsig.PrivateKey
}

type SignRequest struct {
	Template   []byte           `json:"template"`
	Data       []byte           `json:"data"`
	PrivateKey *dsig.PrivateKey `json:"privatekey"`
	DocType    string           `json:"type"`
	Envelop    bool             `json:"envelop"`
}

type ValidateRequest struct {
	Data []byte `json:"data"`
}

type ValidateResponse struct {
	OK bool `json:"ok"`
}

type VerifyRequest struct {
	Data      []byte          `json:"data"`
	PublicKey *dsig.PublicKey `json:"publickey"`
}

type VerifyResponse struct {
	OK bool `json:"ok"`
}