api

type AdminAddUserRequest struct {
	UserName      string `json:"user_name" valid:"username"`
	Email         string `json:"email" valid:"email,optional"`
	Password      string `json:"password" valid:"required"`
	Active        bool   `json:"is_active" valid:"optional"`
	Administrator bool   `json:"is_admin" valid:"optional"`
}

type AdminUpdateUserRequest struct {
	Email         string `json:"email" valid:"optional,email"`
	Password      string `json:"password" valid:"optional"`
	Active        bool   `json:"is_active" valid:"optional"`
	Administrator bool   `json:"is_admin" valid:"optional"`
}

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

type AuthConfirmationRequest struct {
	Password string `json:"password" valid:"stringlength(8|150)"`
}

type BulkEditDocumentsRequest struct {
	Documents      []string              `json:"documents" valid:"required"`
	AddMetadata    MetadataUpdateRequest `json:"add_metadata" valid:"-"`
	RemoveMetadata MetadataUpdateRequest `json:"remove_metadata" valid:"-"`
	Lang           string                `json:"lang" valid:"language, optional"`
	Date           int64                 `json:"date" valid:"optional,range(0|4106139691000)"` // year 2200 in ms
}

type Context struct {
	echo.Context
	// contains filtered or unexported fields
}

type DocumentExistsResponse struct {
	Error string `json:"error"`
	Id    string `json:"id"`
	Name  string `json:"name"`
}

type DocumentFilter struct {
	Query    string `json:"q" valid:"-"`
	Tag      string `json:"tag" valid:"-"`
	After    int64  `json:"after" valid:"-"`
	Before   int64  `json:"before" valid:"-"`
	Metadata string `json:"metadata" valid:"-"`
}

type DocumentProcessStep struct {
	DocumentId string `json:"id"`
	Step       string `json:"step"`
}

type DocumentUpdateRequest struct {
	Name        string            `json:"name" valid:"required,stringlength(1|200)"`
	Description string            `json:"description" valid:"maxstringlength(1000),optional"`
	Filename    string            `json:"filename" valid:"optional"`
	Date        int64             `json:"date" valid:"optional,range(0|4106139691000)"` // year 2200 in ms
	Metadata    []MetadataRequest `json:"metadata" valid:"-"`
	Lang        string            `json:"lang" valid:"language, optional"`
	Favorite    bool              `json:"favorite" valid:"-"`
}

type ForceDocumentProcessingRequest struct {
	UserId     int    `json:"user_id" valid:"-"`
	DocumentId string `json:"document_id" valid:"-"`
	FromStep   string `json:"from_step" valid:"process_step~invalid process step"`
}

type ForgottenPasswordRequest struct {
	Email string `json:"email" valid:"email"`
}

type LoginRequest struct {
	Username string `valid:"username,required"`
	Password string `valid:"required"`
}

type LoginResponse struct {
	UserId int
	Token  string
}

type MetadataKeyRequest struct {
	Key     string `json:"key" valid:"required,metadata,stringlength(1|30)"`
	Comment string `json:"comment" valid:"maxstringlength(1000),optional"`
	Icon    string `json:"icon" valid:"optional"`
	Style   string `json:"style" valid:"json,optional"`
}

type MetadataRequest struct {
	KeyId   int `valid:"required" json:"key_id"`
	ValueId int `valid:"required" json:"value_id"`
}

type MetadataUpdateRequest struct {
	Metadata []MetadataRequest `valid:"required" json:"metadata"`
}

type MetadataValueRequest struct {
	// Value of new metadata
	Value string `json:"value" valid:"required,metadata,stringlength(1|30)"`
	// Optional comment
	Comment string `json:"comment" valid:"maxstringlength(1000),optional"`
	// MatchDocuments instructs to try to match documents for this value.
	MatchDocuments bool `json:"match_documents" valid:"-"`
	// validate MatchType when creating, allowing default to be empty string
	MatchType   string `json:"match_type" valid:"in(regex|exact),optional"`
	MatchFilter string `json:"match_filter" valid:"maxstringlength(100),optional"`
}

type MimeTypesSupportedResponse struct {
	Names     []string `json:"names"`
	Mimetypes []string `json:"mimetypes"`
}

type PrettyTime time.Time

type ReorderRulesRequest struct {
	Ids []int `json:"ids" valid:"-"`
}

type ReqUserPreferences struct {
	Email string `json:"email" valid:"email,optional"`
}

type ResetPasswordRequest struct {
	Token    string `json:"token" valid:"minstringlength(4)"`
	Id       int    `json:"id" valid:"required"`
	Password string `json:"password" valid:"required"`
}

type Rule struct {
	Id          int                     `json:"id" valid:"-"`
	Name        string                  `json:"name" valid:"-"`
	Description string                  `json:"description" valid:"-"`
	Enabled     bool                    `json:"enabled" valid:"-"`
	Order       int                     `json:"order" valid:"-"`
	Mode        string                  `json:"mode" valid:"-"`
	CreatedAt   int64                   `json:"created_at" valid:"-"`
	UpdatedAt   int64                   `json:"updated_at" valid:"-"`
	Triggers    models.RuleTriggerArray `json:"triggers" valid:"rule_trigger_type"`

	Conditions []RuleCondition `json:"conditions" valid:"-"`
	Actions    []RuleAction    `json:"actions" valid:"-"`
}

type RuleAction struct {
	Id          int             `json:"id" valid:"-"`
	RuleId      int             `json:"rule_id" valid:"-"`
	Enabled     bool            `json:"enabled" valid:"-"`
	OnCondition bool            `json:"on_condition" valid:"-"`
	Action      string          `json:"action" valid:"-"`
	Value       string          `json:"value" valid:"-"`
	Metadata    models.Metadata `json:"metadata" valid:"-"`
}

type RuleCondition struct {
	Id              int             `json:"id" valid:"-"`
	RuleId          int             `json:"rule_id" valid:"-"`
	Enabled         bool            `json:"enabled" valid:"-"`
	CaseInsensitive bool            `json:"case_insensitive" valid:"-"`
	Inverted        bool            `json:"inverted_match" valid:"-"`
	ConditionType   string          `json:"condition_type" valid:"-"`
	IsRegex         bool            `json:"is_regex" valid:"-"`
	Value           string          `json:"value" valid:"-"`
	DateFmt         string          `json:"date_fmt" valid:"-"`
	Metadata        models.Metadata `json:"metadata" valid:"-"`
}

type RuleTest struct {
	DocumentId string `json:"document_id" valid:"required"`
}

type SearchSuggestRequest struct {
	Filter string `json:"filter" valid:"-"`
}

type SearchSuggestResponse struct {
	Suggestions []string `json:"suggestions"`
	Prefix      string   `json:"prefix"`
}

type SortKey struct {
	Key             string
	Order           bool
	CaseInsensitive bool
}

type SortKeys []SortKey

type UserContext struct {
	Context
	Admin    bool
	UserId   int
	User     *models.User
	TokenKey string
}

type UserPreferences struct {
	// user
	Id                  int    `json:"user_id"`
	Name                string `json:"user_name"`
	Email               string `json:"email"`
	UpdatedAt           int64  `json:"updated_at"`
	CreatedAt           int64  `json:"created_at"`
	DocumentsCount      int64  `json:"documents_count"`
	DocumentsSize       int64  `json:"documents_size"`
	DocumentsSizeString string `json:"documents_size_string"`
	IsAdmin             bool   `json:"is_admin"`
}

type VersionResponse struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	Commit  string `json:"commit"`
}