ixapi

type CsvItem struct {
	Name     string `json:"name"`
	Date     string `json:"date"`
	Bucket   string `json:"bucket"`
	Media    string `json:"media"`
	Content  string `json:"content"`
	Type     string `json:"type"`
	Size     int64  `json:"size"`
	SystemID string `json:"system id"`
}

type IntelligenceXAPI struct {
	URL string    // The API URL. Always ending with slash.
	Key uuid.UUID // The API key assigned by Intelligence X. Contact the company to receive one.

	// additional input. Set before calling Init
	ProxyURL string // Proxy to use
	BindToIP string // Bind to a specific IPv4 or IPv6

	// one client for the session
	Client              http.Client
	RetryAttempts       int // in case of underlying transport failure
	UserAgent           string
	HTTPMaxResponseSize int64

	HTTPTimeout time.Duration

	WriteCounter *WriteCounter
}

type IntelligentSearchRequest struct {
	Term        string        `json:"term"`       // Search term submitted by the user, e.g. "Document 1.docx" or "email@example.com"
	Buckets     []string      `json:"buckets"`    // Bucket identifiers
	Timeout     time.Duration `json:"timeout"`    // Timeout in seconds. May be limited by API config. 0 means default.
	MaxResults  int           `json:"maxresults"` // Total number of max results per bucket. May be limited by API config. 0 means default.
	DateFrom    string        `json:"datefrom"`   // Date from, both from/to are required if set, format "2006-01-02 15:04"
	DateTo      string        `json:"dateto"`     // Date to, both from/to are required if set, format "2006-01-02 15:04"
	Sort        int           `json:"sort"`       // Sort order: 0 = no sorting, 1 = X-Score ASC, 2 = X-Score DESC, 3 = Date ASC, 4 = Date DESC
	Media       int           `json:"media"`      // Media: 0 = not defined, otherwise MediaX as defined in ixservice
	TerminateID []uuid.UUID   `json:"terminate"`  // Optional: Previous search IDs to terminate (normal search or Phonebook). This is if the user makes a new search from the same tab. Same as first calling /intelligent/search/terminate.
}

type IntelligentSearchResponse struct {
	ID                  uuid.UUID `json:"id"`                  // id of the search job. This is used to get the results.
	SoftSelectorWarning bool      `json:"softselectorwarning"` // Warning of soft selectors, typically garbage in which results into garbage out
	Status              int       `json:"status"`              // Status of the search: 0 = Success (ID valid), 1 = Invalid Term, 2 = Error Max Concurrent Searches
}

type IntelligentSearchResult struct {
	Records []SearchResult `json:"records"` // The result records
	Status  int            `json:"status"`  // Status: 0 = Success with results, 1 = No more results available, 2 = Search ID not found, 3 = No results yet available keep trying
}

type Item struct {
	ID          uint      `json:"id" gorm:"primarykey"`
	SystemID    string    `gorm:"column:system_id;index:,unique;" json:"systemid"` // System identifier uniquely identifying the item
	StorageID   string    `json:"storageid"`                                       // Storage identifier, empty if not stored/available, otherwise a 64-byte blake2b hash hex-encoded
	InStore     bool      `json:"instore"`                                         // Whether the data of the item is in store and the storage id is valid. Also used to indicate update when false but storage id is set.
	Size        int64     `json:"size"`                                            // Size in bytes of the item data
	AccessLevel int       `json:"accesslevel"`                                     // Native access level of the item (0 = Public..)
	Type        int       `json:"type"`                                            // Low-level content type (0 = Binary..)
	Media       int       `json:"media"`                                           // High-level media type (User, Paste, Tweet, Forum Post..)
	Added       time.Time `json:"added"`                                           // When the item was added to the system
	Date        time.Time `json:"date"`                                            // Full time stamp item when it was discovered or created
	Name        string    `json:"name"`                                            // Name or title
	Description string    `json:"description"`                                     // Full description, text only
	XScore      int       `json:"xscore"`                                          // X-Score, ranking its relevancy. 0-100, default 50
	Simhash     uint64    `json:"simhash"`                                         // Simhash, depending on content type. Use hamming distance to compare equality of items data.
	Bucket      string    `json:"bucket"`                                          // Bucket
	Filename    string    `json:"filename"`                                        // FileName
	Downloaded  bool      `json:"downloaded"`                                      // If file already downloaded

	// Tags are meta-data tags helping in classification of the items data. They reveal for example the language or a topic. Different to key-values they have hard-coded classes that
	// allow anyone to take action on them.
	Tags []Tag `json:"tags"`

	// Relations lists all related items.
	Relations []Relationship `json:"relations"`
}

type PanelSearchResultTag struct {
	ID             uint   `json:"id" gorm:"primarykey"`
	SearchResultID uint   `json:"search_result_id"`
	Class          int16  `json:"class"`  // Class of tag
	ClassH         string `json:"classh"` // Class of tag, human friendly
	Value          string `json:"value"`  // The value
	ValueH         string `json:"valueh"` // Value, human friendly
}

type Relationship struct {
	ID       uint   `json:"id" gorm:"primarykey"`
	ItemID   uint   `json:"item_id";gorm:"uniqueIndex:idx_relation_target_r"`
	Target   string `json:"target";gorm:"uniqueIndex:idx_relation_target_r"`   // Target item systemid
	Relation int    `json:"relation";gorm:"uniqueIndex:idx_relation_target_r"` // The relationship, see RelationX
}

type SearchResult struct {
	Item
	AccessLevelH string                 `json:"accesslevelh"` // Human friendly access level info
	MediaH       string                 `json:"mediah"`       // Human friendly media type info
	SimhashH     string                 `json:"simhashh"`     // Human friendly simhash
	TypeH        string                 `json:"typeh"`        // Human friendly content type info
	TagsH        []PanelSearchResultTag `json:"tagsh"`        // Human friendly tags
	RandomID     string                 `json:"randomid"`     // Random ID
	BucketH      string                 `json:"bucketh"`      // Human friendly bucket name
	Group        string                 `json:"group"`        // File Group
	IndexFile    string                 `json:"indexfile"`    // Index file ID
}

type Tag struct {
	ID     uint   `json:"id" gorm:"primarykey"`
	ItemID uint   `json:"item_id";gorm:"uniqueIndex:idx_tag_class_v"`
	Class  int16  `json:"class";gorm:"uniqueIndex:idx_tag_class_v"` // Class of tag
	Value  string `json:"value";gorm:"uniqueIndex:idx_tag_class_v"` // The value
}

type WriteCounter struct {
	Total uint64
}