document

type ActionResult string

type DeleteDocumentByIDRequest struct {
	ID string
}

type DeleteDocumentByIDResponse struct {
	Err error  `json:"err,omitempty"`
	ID  string `json:"id,omitempty"`
}

type DocEntity struct {
	ID            string         `db:"id"`
	Title         string         `db:"title"`
	FileName      string         `db:"filename"`
	AltID         string         `db:"alternativeid"`
	PreviewLink   sql.NullString `db:"previewlink"`
	Amount        float32        `db:"amount"`
	Created       time.Time      `db:"created"`
	Modified      sql.NullTime   `db:"modified"`
	TagList       string         `db:"taglist"`
	SenderList    string         `db:"senderlist"`
	InvoiceNumber sql.NullString `db:"invoicenumber"`
}

type DocSearch struct {
	Title  string
	Tag    string
	Sender string
	From   time.Time
	Until  time.Time
	Limit  int
	Skip   int
}

type Document struct {
	ID            string   `json:"id"`
	Title         string   `json:"title"`
	AltID         string   `json:"alternativeId"`
	Amount        float32  `json:"amount"`
	Created       string   `json:"created"`
	Modified      string   `json:"modified,omitempty"`
	FileName      string   `json:"fileName"`
	PreviewLink   string   `json:"previewLink,omitempty"`
	UploadToken   string   `json:"uploadFileToken,omitempty"`
	Tags          []string `json:"tags"`
	Senders       []string `json:"senders"`
	InvoiceNumber string   `json:"invoiceNumber,omitempty"`
}

type GetDocumentByIDRequest struct {
	ID string
}

type GetDocumentByIDResponse struct {
	Err      error    `json:"err,omitempty"`
	Document Document `json:"document,omitempty"`
}

type IDResult struct {
	Result
	ID string `json:"id,omitempty"`
}

type ListType string

type OrderBy struct {
	Field string
	Order SortDirection
}

type PagedDocResult struct {
	Documents []DocEntity
	Count     int
}

type PagedDocument struct {
	Documents    []Document `json:"documents"`
	TotalEntries int        `json:"totalEntries"`
}

type Repository interface {
	shared.BaseRepository
	Get(id string) (d DocEntity, err error)
	Exists(id string, a persistence.Atomic) (filePath string, err error)
	Save(doc DocEntity, a persistence.Atomic) (d DocEntity, err error)
	Delete(id string, a persistence.Atomic) (err error)
	Search(s DocSearch, order []OrderBy) (PagedDocResult, error)
	SearchLists(s string, st SearchType) ([]string, error)
}

type Result struct {
	Message      string       `json:"message"`
	ActionResult ActionResult `json:"result"`
}

type SaveDocumentRequest struct {
	Document Document
	User     security.User
}

type SaveDocumentResponse struct {
	Err error  `json:"err,omitempty"`
	ID  string `json:"id,omitempty"`
}

type SearchDocumentsRequest struct {
	// Title of the document, search for parts of the field
	Title string
	// Tag of a document, search for parts of the field
	Tag string
	// Sender of a document, search for parts of the field
	Sender string
	// From timestamp to search
	From time.Time
	// Until timestamp to search
	Until time.Time
	// Limit defines the max number of entries to return
	Limit int
	// Skip is used for paged-requests, skip #num entries
	Skip int
}

type SearchDocumentsResponse struct {
	Err    error         `json:"err,omitempty"`
	Result PagedDocument `json:"result"`
}

type SearchListRequest struct {
	Name       string
	SearchType ListType
}

type SearchListResponse struct {
	Err     error    `json:"err,omitempty"`
	Entries []string `json:"entries,omitempty"`
}

type SearchType uint

type Service interface {
	// GetDocumentByID returns a document object specified by the given id
	GetDocumentByID(id string) (d Document, err error)
	// DeleteDocumentByID deletes a document specified by the given id
	DeleteDocumentByID(id string) (err error)
	// SearchDocuments performs a search and returns paginated results
	SearchDocuments(title, tag, sender string, from, until time.Time, limit, skip int) (p PagedDocument, err error)
	// SearchList searches for senders or tags
	SearchList(name string, st SearchType) (l []string, err error)
	// SaveDocument receives a document and stores it
	// either creation a new document or updating an existing
	SaveDocument(doc Document, user security.User) (d Document, err error)
}

type ServiceMiddleware func(Service) Service

type SortDirection uint