api

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

type Agg struct {
	Terms *TermsAgg `json:"terms,omitempty"`
	Range *RangeAgg `json:"range,omitempty"`
}

type ApiMock struct {
	// mock.Mock
	Request interface{}
	Result  interface{}
	Errors  error
}

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

type BoolQuery struct {
	Must   []Query `json:"must,omitempty"`
	Should []Query `json:"should,omitempty"`
	Filter []Query `json:"filter,omitempty"`
}

type CategoryResult struct {
	Categories []model.Category `json:"categories"`
	NextPage   string           `json:"next_page"`
}

type CollectionResult struct {
	Collections []model.Collection `json:"collections"`
	NextPage    string             `json:"next_page"`
}

type ContentRequest struct {
	ContentType string `json:"contentType"`
}

type ContentResult struct {
	SignedURL string `json:"signedURL"`
	Key       string `json:"key"`
}

type DisMaxQuery struct {
	Queries []Query `json:"queries,omitempty"`
}

type ESError struct {
	Type   string `json:"string"`
	Reason string `json:"reason"`
}

type ESErrorResponse struct {
	Error ESError `json:"error"`
}

type ESSearchAggregation struct {
	DocCountErrorUpperBound int                         `json:"doc_count_error_upper_bound"`
	SumOtherDocCount        int                         `json:"sum_other_doc_count"`
	Buckets                 []ESSearchAggregationBucket `json:"buckets"`
}

type ESSearchAggregationBucket struct {
	Key      string `json:"key"`
	DocCount int    `json:"doc_count"`
}

type ESSearchHit struct {
	ID      string         `json:"_id"`
	Version int            `json:"_version"` // only in search by id
	Found   bool           `json:"found"`    // only in search by id
	Score   float64        `json:"_score"`   // only in search
	Source  ESSearchSource `json:"_source"`
}

type ESSearchHits struct {
	Total    ESSearchTotal `json:"total"`
	MaxScore float64       `json:"max_score"`
	Hits     []ESSearchHit `json:"hits"`
}

type ESSearchResponse struct {
	Took         int                            `json:"took"`
	TimedOut     bool                           `json:"timed_out"`
	Shards       ESSearchShards                 `json:"_shards"`
	Hits         ESSearchHits                   `json:"hits"`
	Aggregations map[string]ESSearchAggregation `json:"aggregations"`
}

type ESSearchShards struct {
	Total      int `json:"total"`
	Successful int `json:"successful"`
	Skipped    int `json:"skipped"`
	Failed     int `json:"failed"`
}

type ESSearchSource struct {
	SocietyID    uint32 `json:"societyId"`
	CollectionID uint32 `json:"collectionId"`
}

type ESSearchTotal struct {
	Value    int    `json:"value"`
	Relation string `json:"relation"`
}

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

type FuzzyQuery struct {
	Value     string  `json:"value"`
	Fuzziness string  `json:"fuzziness,omitempty"`
	Rewrite   string  `json:"rewrite,omitempty"`
	Boost     float32 `json:"boost,omitempty"`
}

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

type HeaderLabel struct {
	Header string `json:"header"`
	Label  string `json:"label"`
}

type HitData struct {
	ID           string
	SocietyID    uint32
	RecordID     uint32
	Role         model.Role
	CollectionID uint32
}

type ImageMetadata struct {
	URL      string `json:"url"`
	Height   int    `json:"height"`
	Width    int    `json:"width"`
	Private  bool   `json:"private"`
	LoginURL string `json:"loginURL,omitempty"`
}

type IntegerTermQuery struct {
	Value uint32  `json:"value"`
	Boost float32 `json:"boost,omitempty"`
}

type InvitationSocietyName struct {
	model.Invitation
	SocietyName string `json:"societyName"`
}

type LocalAPI interface {
	GetCategories(context.Context) (*CategoryResult, error)
	GetCategoriesByID(ctx context.Context, ids []uint32) ([]model.Category, error)
	GetCategory(ctx context.Context, id uint32) (*model.Category, error)
	AddCategory(ctx context.Context, in model.CategoryIn) (*model.Category, error)
	UpdateCategory(ctx context.Context, id uint32, in model.Category) (*model.Category, error)
	DeleteCategory(ctx context.Context, id uint32) error
	GetCollections(ctx context.Context) (*CollectionResult, error)
	GetCollectionsByID(ctx context.Context, ids []uint32, enforceContextSocietyMatch bool) ([]model.Collection, error)
	GetCollection(ctx context.Context, id uint32) (*model.Collection, error)
	AddCollection(ctx context.Context, in model.CollectionIn) (*model.Collection, error)
	UpdateCollection(ctx context.Context, id uint32, in model.Collection) (*model.Collection, error)
	DeleteCollection(ctx context.Context, id uint32) error
	GetPosts(ctx context.Context) (*PostResult, error)
	GetPost(ctx context.Context, id uint32) (*model.Post, error)
	GetPostImage(ctx context.Context, id uint32, filePath string, thumbnail bool, expireSeconds int) (*ImageMetadata, error)
	AddPost(ctx context.Context, in model.PostIn) (*model.Post, error)
	UpdatePost(ctx context.Context, id uint32, in model.Post) (*model.Post, error)
	DeletePost(ctx context.Context, id uint32) error
	PostContentRequest(ctx context.Context, contentRequest ContentRequest) (*ContentResult, error)
	GetContent(ctx context.Context, key string) ([]byte, error)
	GetContentRequest(ctx context.Context, key string) (*ContentResult, error)
	RetrieveUser(ctx context.Context, provider OIDCProvider, token *oidc.IDToken, rawToken string) (*model.User, bool, error)
	GetRecordsForPost(ctx context.Context, postid uint32, limit int) (*RecordsResult, error)
	GetRecordsByID(ctx context.Context, ids []uint32, enforceContextSocietyMatch bool) ([]model.Record, error)
	GetRecord(ctx context.Context, includeDetails bool, id uint32) (*RecordDetail, error)
	AddRecord(ctx context.Context, in model.RecordIn) (*model.Record, error)
	UpdateRecord(ctx context.Context, id uint32, in model.Record) (*model.Record, error)
	DeleteRecord(ctx context.Context, id uint32) error
	DeleteRecordsForPost(ctx context.Context, postID uint32) error
	GetRecordHouseholdsForPost(ctx context.Context, postid uint32) ([]model.RecordHousehold, error)
	GetRecordHousehold(ctx context.Context, postID uint32, householdID string) (*model.RecordHousehold, error)
	AddRecordHousehold(ctx context.Context, in model.RecordHouseholdIn) (*model.RecordHousehold, error)
	DeleteRecordHouseholdsForPost(ctx context.Context, postID uint32) error
	Search(ctx context.Context, req *SearchRequest) (*model.SearchResult, error)
	SearchByID(ctx context.Context, id string, req *SearchByIDRequest) (*model.SearchHit, error)
	SearchImage(ctx context.Context, societyID, id uint32, filePath string, thumbnail bool, expireSeconds int) (*ImageMetadata, error)
	SearchDeleteByID(ctx context.Context, id string) error
	StandardizePlace(ctx context.Context, text, defaultContainingPlace string) (*model.Place, error)
	GetPlacesByPrefix(ctx context.Context, prefix string, count int) ([]model.Place, error)
	GetNameVariants(ctx context.Context, nameType model.NameType, name string) (*model.NameVariants, error)
	GetSocietySummariesForCurrentUser(ctx context.Context) ([]model.SocietySummary, error)
	GetSocietySummary(ctx context.Context) (*model.SocietySummary, error)
	GetSociety(ctx context.Context, id uint32) (*model.Society, error)
	AddSociety(ctx context.Context, in model.SocietyIn) (*model.Society, error)
	UpdateSociety(ctx context.Context, in model.Society) (*model.Society, error)
	DeleteSociety(ctx context.Context) error
	GetSocietyUserNames(ctx context.Context) ([]SocietyUserEmail, error)
	UpdateSocietyUserEmail(ctx context.Context, id uint32, in SocietyUserEmail) (*SocietyUserEmail, error)
	GetSocietyUserByUser(ctx context.Context, userID uint32) (*model.SocietyUser, error)
	AddSocietyUser(ctx context.Context, body model.SocietyUserBody) (*model.SocietyUser, error)
	DeleteSocietyUser(ctx context.Context, id uint32) error
	GetInvitations(ctx context.Context) ([]model.Invitation, error)
	AddInvitation(ctx context.Context, body model.InvitationBody) (*model.Invitation, error)
	DeleteInvitation(ctx context.Context, id uint32) error
	GetInvitationSocietyName(ctx context.Context, code string) (*InvitationSocietyName, error)
	AcceptInvitation(ctx context.Context, code string) (*model.SocietyUser, error)
}

type MatchQuery struct {
	Query    string  `json:"query"`
	Operator string  `json:"operator,omitempty"`
	Boost    float32 `json:"boost,omitempty"`
}

type OIDCProvider interface {
	UserInfo(ctx context.Context, tokenSource oauth2.TokenSource) (*oidc.UserInfo, error)
}

type PostResult struct {
	Posts    []model.Post `json:"posts"`
	NextPage string       `json:"next_page"`
}

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

type Query struct {
	Bool     *BoolQuery            `json:"bool,omitempty"`
	DisMax   *DisMaxQuery          `json:"dis_max,omitempty"`
	Fuzzy    map[string]FuzzyQuery `json:"fuzzy,omitempty"`
	Match    map[string]MatchQuery `json:"match,omitempty"`
	Range    map[string]RangeQuery `json:"range,omitempty"`
	Term     map[string]TermQuery  `json:"term,omitempty"`
	Wildcard map[string]TermQuery  `json:"wildcard,omitempty"`
}

type RangeAgg struct {
	Field  string          `json:"field"`
	Keyed  bool            `json:"keyed,omitempty"`
	Ranges []RangeAggRange `json:"ranges"`
}

type RangeAggRange struct {
	Key  string `json:"key"`
	From int    `json:"from,omitempty'"`
	To   int    `json:"to,omitempty'"`
}

type RangeQuery struct {
	GTE   int     `json:"gte,omitempty"`
	LTE   int     `json:"lte,omitempty"`
	Boost float32 `json:"boost,omitempty"`
}

type RecordDetail struct {
	model.Record
	Labels    []HeaderLabel  `json:"labels"`
	Citation  string         `json:"citation"`
	Household []model.Record `json:"household"`
	ImagePath string         `json:"imagePath"`
}

type RecordsResult struct {
	Records  []model.Record `json:"records"`
	NextPage string         `json:"next_page"`
}

type Search struct {
	Query  Query          `json:"query,omitempty"`
	Aggs   map[string]Agg `json:"aggs,omitempty"`
	Source []string       `json:"_source,omitempty"`
	From   int            `json:"from,omitempty"`
	Size   int            `json:"size"`
}

type SearchByIDRequest struct {
	SurnameFirst bool `schema:"surnameFirst"`
}

type SearchRequest struct {
	SocietyID uint32 `schema:"societyId"`
	// name
	Given            string `schema:"given"`
	GivenFuzziness   int    `schema:"givenFuzziness"`
	Surname          string `schema:"surname"`
	SurnameFuzziness int    `schema:"surnameFuzziness"`
	// relatives
	FatherGiven            string `schema:"fatherGiven"`
	FatherGivenFuzziness   int    `schema:"fatherGivenFuzziness"`
	FatherSurname          string `schema:"fatherSurname"`
	FatherSurnameFuzziness int    `schema:"fatherSurnameFuzziness"`
	MotherGiven            string `schema:"motherGiven"`
	MotherGivenFuzziness   int    `schema:"motherGivenFuzziness"`
	MotherSurname          string `schema:"motherSurname"`
	MotherSurnameFuzziness int    `schema:"motherSurnameFuzziness"`
	SpouseGiven            string `schema:"spouseGiven"`
	SpouseGivenFuzziness   int    `schema:"spouseGivenFuzziness"`
	SpouseSurname          string `schema:"spouseSurname"`
	SpouseSurnameFuzziness int    `schema:"spouseSurnameFuzziness"`
	OtherGiven             string `schema:"otherGiven"`
	OtherGivenFuzziness    int    `schema:"otherGivenFuzziness"`
	OtherSurname           string `schema:"otherSurname"`
	OtherSurnameFuzziness  int    `schema:"otherSurnameFuzziness"`
	// events
	BirthDate               string `schema:"birthDate"`
	BirthDateFuzziness      int    `schema:"birthDateFuzziness"`
	BirthPlace              string `schema:"birthPlace"`
	BirthPlaceFuzziness     int    `schema:"birthPlaceFuzziness"`
	MarriageDate            string `schema:"marriageDate"`
	MarriageDateFuzziness   int    `schema:"marriageDateFuzziness"`
	MarriagePlace           string `schema:"marriagePlace"`
	MarriagePlaceFuzziness  int    `schema:"marriagePlaceFuzziness"`
	ResidenceDate           string `schema:"residenceDate"`
	ResidenceDateFuzziness  int    `schema:"residenceDateFuzziness"`
	ResidencePlace          string `schema:"residencePlace"`
	ResidencePlaceFuzziness int    `schema:"residencePlaceFuzziness"`
	DeathDate               string `schema:"deathDate"`
	DeathDateFuzziness      int    `schema:"deathDateFuzziness"`
	DeathPlace              string `schema:"deathPlace"`
	DeathPlaceFuzziness     int    `schema:"deathPlaceFuzziness"`
	AnyDate                 string `schema:"anyDate"` // match on any date
	AnyDateFuzziness        int    `schema:"anyDateFuzziness"`
	AnyPlace                string `schema:"anyPlace"` // match on any place
	AnyPlaceFuzziness       int    `schema:"anyPlaceFuzziness"`
	// other
	Keywords string `schema:"keywords"`
	Title    string `schema:"title"`
	Author   string `schema:"author"`
	// facets and filters
	CollectionPlace1Facet bool   `schema:"collectionPlace1Facet"`
	CollectionPlace1      string `schema:"collectionPlace1"`
	CollectionPlace2Facet bool   `schema:"collectionPlace2Facet"`
	CollectionPlace2      string `schema:"collectionPlace2"`
	CollectionPlace3Facet bool   `schema:"collectionPlace3Facet"`
	CollectionPlace3      string `schema:"collectionPlace3"`
	CategoryFacet         bool   `schema:"categoryFacet"`
	Category              string `schema:"category"`
	CollectionFacet       bool   `schema:"collectionFacet"`
	Collection            string `schema:"collection"`
	// from and size and surname first (vs last)
	From         int  `schema:"from"`
	Size         int  `schema:"size"`
	SurnameFirst bool `schema:"surnameFirst"`
}

type SocietyUserEmail struct {
	model.SocietyUser
	UserEmail string `json:"email"`
}

type TermQuery struct {
	Value interface{} `json:"value"`
	Boost float32     `json:"boost,omitempty"`
}

type TermsAgg struct {
	Field string `json:"field"`
	Size  int    `json:"size,omitempty"`
}