events

type BackchannelLogout struct {
	Executant *user.UserId
	SessionId string
	Timestamp *types.Timestamp
}

type BytesReceived struct {
	UploadID          string
	SpaceOwner        *user.UserId
	ExecutingUser     *user.User
	ResourceID        *provider.ResourceId
	Filename          string
	Filesize          uint64
	URL               string
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type Consumer interface {
	Consume(string, ...events.ConsumeOption) (<-chan events.Event, error)
}

type ContainerCreated struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type Event struct {
	Type        string
	ID          string
	TraceParent string
	InitiatorID string
	Event       interface{}
}

type FileDownloaded struct {
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type FileLocked struct {
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type FileTouched struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	Ref               *provider.Reference
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type FileUnlocked struct {
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type FileUploaded struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type FileVersionRestored struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	Key               string
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type GroupCreated struct {
	Executant *user.UserId
	GroupID   string
	Timestamp *types.Timestamp
}

type GroupDeleted struct {
	Executant *user.UserId
	GroupID   string
	Timestamp *types.Timestamp
}

type GroupFeature struct {
	Name      string
	Value     string
	Timestamp *types.Timestamp
}

type GroupFeatureChanged struct {
	Executant *user.UserId
	GroupID   string
	Features  []GroupFeature
	Timestamp *types.Timestamp
}

type GroupMemberAdded struct {
	Executant *user.UserId
	GroupID   string
	UserID    string
	Timestamp *types.Timestamp
}

type GroupMemberRemoved struct {
	Executant *user.UserId
	GroupID   string
	UserID    string
	Timestamp *types.Timestamp
}

type ItemMoved struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	Ref               *provider.Reference
	Owner             *user.UserId
	OldReference      *provider.Reference
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type ItemPurged struct {
	Executant         *user.UserId
	ID                *provider.ResourceId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type ItemRestored struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	ID                *provider.ResourceId
	Ref               *provider.Reference
	Owner             *user.UserId
	OldReference      *provider.Reference
	Key               string
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type ItemTrashed struct {
	SpaceOwner        *user.UserId
	Executant         *user.UserId
	ID                *provider.ResourceId
	Ref               *provider.Reference
	Owner             *user.UserId
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type LinkAccessFailed struct {
	Executant *user.UserId
	ShareID   *link.PublicShareId
	Token     string
	Status    rpc.Code
	Message   string
	Timestamp *types.Timestamp
}

type LinkAccessed struct {
	Executant         *user.UserId
	ShareID           *link.PublicShareId
	Sharer            *user.UserId
	ItemID            *provider.ResourceId
	Path              string
	Permissions       *link.PublicSharePermissions
	DisplayName       string
	Expiration        *types.Timestamp
	PasswordProtected bool
	CTime             *types.Timestamp
	Token             string
}

type LinkCreated struct {
	Executant         *user.UserId
	ShareID           *link.PublicShareId
	Sharer            *user.UserId
	ItemID            *provider.ResourceId
	ResourceName      string
	Permissions       *link.PublicSharePermissions
	DisplayName       string
	Expiration        *types.Timestamp
	PasswordProtected bool
	CTime             *types.Timestamp
	Token             string
}

type LinkRemoved struct {
	Executant *user.UserId
	// split protobuf Ref
	ShareID      *link.PublicShareId
	ShareToken   string
	Timestamp    *types.Timestamp
	ItemID       *provider.ResourceId
	ResourceName string
}

type LinkUpdated struct {
	Executant         *user.UserId
	ShareID           *link.PublicShareId
	Sharer            *user.UserId
	ItemID            *provider.ResourceId
	ResourceName      string
	Permissions       *link.PublicSharePermissions
	DisplayName       string
	Expiration        *types.Timestamp
	PasswordProtected bool
	MTime             *types.Timestamp
	Token             string

	FieldUpdated string
}

type OCMCoreShareCreated struct {
	ShareID       string
	Executant     *user.UserId
	Sharer        *user.UserId
	GranteeUserID *user.UserId
	ItemID        string
	ResourceName  string
	Permissions   *provider.ResourcePermissions
	CTime         *types.Timestamp
}

type PersonalDataExtracted struct {
	Executant *user.UserId
	Timestamp *types.Timestamp
	ErrorMsg  string
}

type PostprocessingFinished struct {
	UploadID          string
	Filename          string
	SpaceOwner        *user.UserId
	ExecutingUser     *user.User
	Result            map[Postprocessingstep]interface{} // it is a map[step]Event
	Outcome           PostprocessingOutcome
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type PostprocessingOutcome string

type PostprocessingRetry struct {
	UploadID        string
	Filename        string
	ExecutingUser   *user.User
	Failures        int
	BackoffDuration time.Duration
}

type PostprocessingStepFinished struct {
	UploadID      string
	ExecutingUser *user.User
	Filename      string

	FinishedStep Postprocessingstep    // name of the step
	Result       interface{}           // result information see VirusscanResult for example
	Error        error                 // possible error of the step
	Outcome      PostprocessingOutcome // some services may cause postprocessing to stop
	Timestamp    *types.Timestamp
}

type Postprocessingstep string

type Publisher interface {
	Publish(string, interface{}, ...events.PublishOption) error
}

type ReceivedShareUpdated struct {
	Executant      *user.UserId
	ShareID        *collaboration.ShareId
	ItemID         *provider.ResourceId
	Path           string
	Permissions    *collaboration.SharePermissions
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	Sharer         *user.UserId
	MTime          *types.Timestamp

	State string
}

type RestartPostprocessing struct {
	UploadID  string
	Timestamp *types.Timestamp
}

type ResumePostprocessing struct {
	UploadID  string
	Step      Postprocessingstep
	Timestamp *types.Timestamp
}

type ScienceMeshInviteTokenGenerated struct {
	Sharer        *user.UserId
	RecipientMail string
	Token         string
	Description   string
	Expiration    uint64
	InviteLink    string
	Timestamp     *types.Timestamp
}

type SendEmailsEvent struct {
	Interval string
}

type SendSSE struct {
	UserIDs []string
	Type    string
	Message []byte
}

type ShareCreated struct {
	ShareID   *collaboration.ShareId
	Executant *user.UserId
	Sharer    *user.UserId
	// split the protobuf Grantee oneof so we can use stdlib encoding/json
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	Sharee         *provider.Grantee
	ItemID         *provider.ResourceId
	ResourceName   string
	Permissions    *collaboration.SharePermissions
	CTime          *types.Timestamp
}

type ShareExpired struct {
	ShareID    *collaboration.ShareId
	ShareOwner *user.UserId
	ItemID     *provider.ResourceId
	Path       string
	ExpiredAt  time.Time
	// split the protobuf Grantee oneof so we can use stdlib encoding/json
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
}

type ShareRemoved struct {
	Executant *user.UserId
	// split protobuf Spec
	ShareID  *collaboration.ShareId
	ShareKey *collaboration.ShareKey
	// split the protobuf Grantee oneof so we can use stdlib encoding/json
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId

	ItemID       *provider.ResourceId
	ResourceName string
	Timestamp    time.Time
}

type ShareUpdated struct {
	Executant      *user.UserId
	ShareID        *collaboration.ShareId
	ItemID         *provider.ResourceId
	ResourceName   string
	Permissions    *collaboration.SharePermissions
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	Sharer         *user.UserId
	MTime          *types.Timestamp

	Updated string // Deprecated
	// indicates what was updated
	UpdateMask []string
}

type SpaceCreated struct {
	Executant *user.UserId
	ID        *provider.StorageSpaceId
	Owner     *user.UserId
	Root      *provider.ResourceId
	Name      string
	Type      string
	Quota     *provider.Quota
	MTime     *types.Timestamp
}

type SpaceDeleted struct {
	Executant    *user.UserId
	ID           *provider.StorageSpaceId
	SpaceName    string
	FinalMembers map[string]provider.ResourcePermissions
	Timestamp    time.Time
}

type SpaceDisabled struct {
	Executant *user.UserId
	ID        *provider.StorageSpaceId
	Timestamp time.Time
}

type SpaceEnabled struct {
	Executant *user.UserId
	ID        *provider.StorageSpaceId
	Owner     *user.UserId
	Timestamp *types.Timestamp
}

type SpaceMembershipExpired struct {
	SpaceOwner *user.UserId
	SpaceID    *provider.StorageSpaceId
	SpaceName  string
	ExpiredAt  time.Time
	// split the protobuf Grantee oneof so we can use stdlib encoding/json
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	Timestamp      *types.Timestamp
}

type SpaceRenamed struct {
	Executant *user.UserId
	ID        *provider.StorageSpaceId
	Owner     *user.UserId
	Name      string
	Timestamp *types.Timestamp
}

type SpaceShareUpdated struct {
	Executant      *user.UserId
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	ID             *provider.StorageSpaceId
	Timestamp      time.Time
}

type SpaceShared struct {
	Executant      *user.UserId
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	Creator        *user.UserId
	ID             *provider.StorageSpaceId
	Timestamp      time.Time
}

type SpaceUnshared struct {
	Executant      *user.UserId
	GranteeUserID  *user.UserId
	GranteeGroupID *group.GroupId
	ID             *provider.StorageSpaceId
	Timestamp      time.Time
}

type SpaceUpdated struct {
	Executant *user.UserId
	ID        *provider.StorageSpaceId
	Space     *provider.StorageSpace
	Timestamp *types.Timestamp
}

type StartPostprocessingStep struct {
	UploadID      string
	URL           string
	ExecutingUser *user.User
	Filename      string
	Filesize      uint64
	Token         string               // for file retrieval in after upload case
	ResourceID    *provider.ResourceId // for file retrieval in after upload case
	RevaToken     string               // for file retrieval in after upload case

	StepToStart       Postprocessingstep
	Timestamp         *types.Timestamp
	ImpersonatingUser *user.User
}

type Stream interface {
	Publish(string, interface{}, ...events.PublishOption) error
	Consume(string, ...events.ConsumeOption) (<-chan events.Event, error)
}

type TagsAdded struct {
	SpaceOwner *user.UserId
	Tags       string
	Ref        *provider.Reference
	Executant  *user.UserId
	Timestamp  *types.Timestamp
}

type TagsRemoved struct {
	SpaceOwner *user.UserId
	Tags       string
	Ref        *provider.Reference
	Executant  *user.UserId
	Timestamp  *types.Timestamp
}

type Unmarshaller interface {
	Unmarshal([]byte) (interface{}, error)
}

type UploadReady struct {
	UploadID          string
	Filename          string
	SpaceOwner        *user.UserId
	ExecutingUser     *user.User
	ImpersonatingUser *user.User
	FileRef           *provider.Reference
	Timestamp         *types.Timestamp
	Failed            bool
	IsVersion         bool
}

type UserCreated struct {
	Executant *user.UserId
	UserID    string
	Timestamp *types.Timestamp
}

type UserDeleted struct {
	Executant *user.UserId
	UserID    string
	Timestamp *types.Timestamp
}

type UserFeature struct {
	Name     string
	Value    string
	OldValue *string
}

type UserFeatureChanged struct {
	Executant *user.UserId
	UserID    string
	Features  []UserFeature
	Timestamp *types.Timestamp
}

type UserSignedIn struct {
	Executant *user.UserId
	Timestamp *types.Timestamp
}

type VirusscanResult struct {
	Infected    bool
	Description string
	Scandate    time.Time
	ResourceID  *provider.ResourceId
	ErrorMsg    string // empty when no error
	Timestamp   *types.Timestamp
}