sharing

type Capability struct{}

type Principal struct {
	// ID is the server-assigned identifier.
	ID jmap.ID `json:"id"`

	// Type is the kind of principal: "individual", "group", "resource",
	// "location", or "other".
	Type string `json:"type"`

	// Name is the display name of the principal.
	Name string `json:"name"`

	// Description is a longer description of the principal.
	Description *string `json:"description,omitempty"`

	// Email is the email address of the principal.
	Email *string `json:"email,omitempty"`

	// TimeZone is the IANA time zone identifier for the principal.
	TimeZone *string `json:"timeZone,omitempty"`

	// Capabilities maps capability URIs to capability-specific data.
	Capabilities map[jmap.URI]any `json:"capabilities,omitempty"`

	// Accounts maps account IDs to their access details.
	Accounts map[jmap.ID]*PrincipalAccountAccess `json:"accounts,omitempty"`
}

type PrincipalAccountAccess struct {
	// AccountID is the ID of the account.
	AccountID jmap.ID `json:"accountId"`

	// IsPersonal indicates whether this is the principal's own account.
	IsPersonal bool `json:"isPersonal"`

	// IsReadOnly indicates whether the principal has read-only access.
	IsReadOnly bool `json:"isReadOnly"`
}

type PrincipalChanges struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// SinceState is the state to compare against.
	SinceState string `json:"sinceState"`

	// MaxChanges is the maximum number of changes to return.
	MaxChanges *uint64 `json:"maxChanges,omitempty"`
}

type PrincipalChangesResponse struct {
	// OldState is the state before the changes.
	OldState string `json:"oldState"`

	// NewState is the state after the changes.
	NewState string `json:"newState"`

	// HasMoreChanges indicates whether there are more changes available.
	HasMoreChanges bool `json:"hasMoreChanges"`

	// Created contains IDs of Principals that were created.
	Created []jmap.ID `json:"created,omitempty"`

	// Updated contains IDs of Principals that were updated.
	Updated []jmap.ID `json:"updated,omitempty"`

	// Destroyed contains IDs of Principals that were destroyed.
	Destroyed []jmap.ID `json:"destroyed,omitempty"`
}

type PrincipalFilter struct {
	// Email filters by the principal's email address.
	Email *string `json:"email,omitempty"`

	// Name filters by the principal's name.
	Name *string `json:"name,omitempty"`

	// Type filters by the principal type.
	Type *string `json:"type,omitempty"`

	// TimeZone filters by the principal's time zone.
	TimeZone *string `json:"timeZone,omitempty"`
}

type PrincipalGet struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// IDs is the list of Principal IDs to retrieve. If nil, all are returned.
	IDs []jmap.ID `json:"ids,omitempty"`

	// Properties lists the properties to return. If nil, all are returned.
	Properties []string `json:"properties,omitempty"`
}

type PrincipalGetResponse struct {
	// State is the current state string for this type.
	State string `json:"state"`

	// List contains the requested Principal objects.
	List []*Principal `json:"list,omitempty"`

	// NotFound contains IDs that were not found.
	NotFound []jmap.ID `json:"notFound,omitempty"`
}

type PrincipalQuery struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// Filter specifies the criteria to filter by.
	Filter *PrincipalFilter `json:"filter,omitempty"`

	// Sort specifies the sort order.
	Sort []*PrincipalSort `json:"sort,omitempty"`

	// Position is the zero-based index of the first result to return.
	Position *int64 `json:"position,omitempty"`

	// Anchor is an ID to use as the position reference.
	Anchor *jmap.ID `json:"anchor,omitempty"`

	// AnchorOffset is the offset from the anchor position.
	AnchorOffset *int64 `json:"anchorOffset,omitempty"`

	// Limit is the maximum number of results to return.
	Limit *uint64 `json:"limit,omitempty"`

	// CalculateTotal requests the server to calculate the total count.
	CalculateTotal *bool `json:"calculateTotal,omitempty"`
}

type PrincipalQueryChanges struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// Filter specifies the criteria used in the original query.
	Filter *PrincipalFilter `json:"filter,omitempty"`

	// Sort specifies the sort order used in the original query.
	Sort []*PrincipalSort `json:"sort,omitempty"`

	// SinceQueryState is the query state to compare against.
	SinceQueryState string `json:"sinceQueryState"`

	// MaxChanges is the maximum number of changes to return.
	MaxChanges *uint64 `json:"maxChanges,omitempty"`

	// UpToID limits results to changes up to this ID.
	UpToID *jmap.ID `json:"upToId,omitempty"`

	// CalculateTotal requests the server to calculate the total count.
	CalculateTotal *bool `json:"calculateTotal,omitempty"`
}

type PrincipalQueryChangesResponse struct {
	// OldQueryState is the previous query state.
	OldQueryState string `json:"oldQueryState"`

	// NewQueryState is the new query state.
	NewQueryState string `json:"newQueryState"`

	// Removed contains IDs removed from the query results.
	Removed []jmap.ID `json:"removed,omitempty"`

	// Added contains items added to the query results.
	Added []jmap.AddedItem `json:"added,omitempty"`

	// Total is the total number of results, if calculated.
	Total *uint64 `json:"total,omitempty"`
}

type PrincipalQueryResponse struct {
	// QueryState is the current query state.
	QueryState string `json:"queryState"`

	// CanCalculateChanges indicates whether the server supports
	// Principal/queryChanges for this query.
	CanCalculateChanges bool `json:"canCalculateChanges"`

	// Position is the zero-based index of the first result.
	Position uint64 `json:"position"`

	// IDs contains the matching Principal IDs.
	IDs []jmap.ID `json:"ids,omitempty"`

	// Total is the total number of matching results, if calculated.
	Total *uint64 `json:"total,omitempty"`

	// Limit is the limit applied to the query.
	Limit *uint64 `json:"limit,omitempty"`
}

type PrincipalSet struct {
	// AccountID is the account to modify.
	AccountID jmap.ID `json:"accountId"`

	// IfInState only applies changes if the current state matches.
	IfInState *string `json:"ifInState,omitempty"`

	// Create maps creation IDs to Principal objects to create.
	Create map[jmap.ID]*Principal `json:"create,omitempty"`

	// Update maps Principal IDs to patch objects.
	Update map[jmap.ID]*jmap.Patch `json:"update,omitempty"`

	// Destroy is a list of Principal IDs to destroy.
	Destroy []jmap.ID `json:"destroy,omitempty"`
}

type PrincipalSetResponse struct {
	// OldState is the state before the changes.
	OldState string `json:"oldState"`

	// NewState is the state after the changes.
	NewState string `json:"newState"`

	// Created maps creation IDs to created Principal objects.
	Created map[jmap.ID]*Principal `json:"created,omitempty"`

	// Updated maps Principal IDs to updated Principal objects.
	Updated map[jmap.ID]*Principal `json:"updated,omitempty"`

	// Destroyed contains IDs of destroyed Principals.
	Destroyed []jmap.ID `json:"destroyed,omitempty"`

	// NotCreated maps creation IDs to errors.
	NotCreated map[jmap.ID]*jmap.SetError `json:"notCreated,omitempty"`

	// NotUpdated maps Principal IDs to errors.
	NotUpdated map[jmap.ID]*jmap.SetError `json:"notUpdated,omitempty"`

	// NotDestroyed maps Principal IDs to errors.
	NotDestroyed map[jmap.ID]*jmap.SetError `json:"notDestroyed,omitempty"`
}

type PrincipalSort struct {
	// Property is the property name to sort by.
	Property string `json:"property"`

	// IsAscending determines the sort direction. Default is true.
	IsAscending *bool `json:"isAscending,omitempty"`
}

type ShareNotification struct {
	// ID is the server-assigned identifier.
	ID jmap.ID `json:"id"`

	// Type is always "ShareNotification".
	Type string `json:"@type"`

	// Created is the UTC date the notification was created.
	Created string `json:"created"`

	// ChangedBy identifies who made the sharing change.
	ChangedBy *ShareNotificationSender `json:"changedBy,omitempty"`

	// ObjectType is the data type of the shared object.
	ObjectType string `json:"objectType"`

	// ObjectAccountID is the account ID containing the shared object.
	ObjectAccountID jmap.ID `json:"objectAccountId"`

	// ObjectID is the ID of the shared object.
	ObjectID jmap.ID `json:"objectId"`

	// Name is the name of the shared object.
	Name string `json:"name"`

	// OldRights maps right names to their previous boolean values.
	OldRights map[string]bool `json:"oldRights,omitempty"`

	// NewRights maps right names to their new boolean values.
	NewRights map[string]bool `json:"newRights,omitempty"`
}

type ShareNotificationCapability struct{}

type ShareNotificationChanges struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// SinceState is the state to compare against.
	SinceState string `json:"sinceState"`

	// MaxChanges is the maximum number of changes to return.
	MaxChanges *uint64 `json:"maxChanges,omitempty"`
}

type ShareNotificationChangesResponse struct {
	// OldState is the state before the changes.
	OldState string `json:"oldState"`

	// NewState is the state after the changes.
	NewState string `json:"newState"`

	// HasMoreChanges indicates whether there are more changes available.
	HasMoreChanges bool `json:"hasMoreChanges"`

	// Created contains IDs of ShareNotifications that were created.
	Created []jmap.ID `json:"created,omitempty"`

	// Updated contains IDs of ShareNotifications that were updated.
	Updated []jmap.ID `json:"updated,omitempty"`

	// Destroyed contains IDs of ShareNotifications that were destroyed.
	Destroyed []jmap.ID `json:"destroyed,omitempty"`
}

type ShareNotificationGet struct {
	// AccountID is the account to query.
	AccountID jmap.ID `json:"accountId"`

	// IDs is the list of ShareNotification IDs to retrieve.
	// If nil, all are returned.
	IDs []jmap.ID `json:"ids,omitempty"`

	// Properties lists the properties to return. If nil, all are returned.
	Properties []string `json:"properties,omitempty"`
}

type ShareNotificationGetResponse struct {
	// State is the current state string for this type.
	State string `json:"state"`

	// List contains the requested ShareNotification objects.
	List []*ShareNotification `json:"list,omitempty"`

	// NotFound contains IDs that were not found.
	NotFound []jmap.ID `json:"notFound,omitempty"`
}

type ShareNotificationSender struct {
	// Name is the display name of the sender.
	Name string `json:"name"`

	// Email is the email address of the sender.
	Email *string `json:"email,omitempty"`

	// PrincipalID is the principal ID of the sender.
	PrincipalID *jmap.ID `json:"principalId,omitempty"`
}

type ShareNotificationSet struct {
	// AccountID is the account to modify.
	AccountID jmap.ID `json:"accountId"`

	// IfInState only applies changes if the current state matches.
	IfInState *string `json:"ifInState,omitempty"`

	// Destroy is a list of ShareNotification IDs to destroy.
	Destroy []jmap.ID `json:"destroy,omitempty"`
}

type ShareNotificationSetResponse struct {
	// OldState is the state before the changes.
	OldState string `json:"oldState"`

	// NewState is the state after the changes.
	NewState string `json:"newState"`

	// Destroyed contains IDs of destroyed ShareNotifications.
	Destroyed []jmap.ID `json:"destroyed,omitempty"`

	// NotDestroyed maps ShareNotification IDs to errors.
	NotDestroyed map[jmap.ID]*jmap.SetError `json:"notDestroyed,omitempty"`
}