user

type DeleteDocumentRequest struct {

	// URI of the document owner. If omitted, defaults to the caller URI (`sub` claim).
	// Can be a user, unit or organization. (e.g., core://user/1234, core://unit/abc, core://org/ab)
	// Only admin users can delete documents owned by a unit or organization.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// Type is the content type of the document.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Unique identifier for the document within the scope of the application and type.
	// Can be a human readable slug or a UUID.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

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

type DeleteInboxMessageRequest struct {

	// ID of the message.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

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

type DeletePropertiesRequest struct {
	Properties []*PropertyDelete `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
	// contains filtered or unexported fields
}

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

type Document struct {

	// URI of the document owner.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// Type is the content type of the document.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Unique identifier for the document within the scope of the application and type.
	// Can be a human readable slug or a UUID.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// Version of the document.
	Version int64 `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	// Semver string indicating the schema version of the payload.
	SchemaVersion string `protobuf:"bytes,6,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// ReadOnly is set to true if the document is shared.
	ReadOnly bool `protobuf:"varint,7,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// Title of the document.
	Title string `protobuf:"bytes,8,opt,name=title,proto3" json:"title,omitempty"`
	// Creation time in RFC3339 format.
	Created string `protobuf:"bytes,9,opt,name=created,proto3" json:"created,omitempty"`
	// Last update time in RFC3339 format.
	Updated string `protobuf:"bytes,10,opt,name=updated,proto3" json:"updated,omitempty"`
	// UpdatedBy is the identity of the party that last updated the document.
	UpdatedBy string `protobuf:"bytes,11,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Payload contains a newsdoc document with actual configuration data.
	Payload *newsdoc.Document `protobuf:"bytes,12,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

type EventLogEntry struct {

	// ID of the event.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the resource owner. Can be a user, unit or organization.
	// (e.g., core://user/1234, core://unit/abc, core://org/ab)
	Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"`
	// The type of change.
	Type EventLogEntryType `protobuf:"varint,3,opt,name=type,proto3,enum=elephant.user.EventLogEntryType" json:"type,omitempty"`
	// Kind of the resource.
	Kind ResourceKind `protobuf:"varint,4,opt,name=kind,proto3,enum=elephant.user.ResourceKind" json:"kind,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,5,opt,name=application,proto3" json:"application,omitempty"`
	// DocumentType is the content type of the document.
	DocumentType string `protobuf:"bytes,6,opt,name=document_type,json=documentType,proto3" json:"document_type,omitempty"`
	// Unique identifier for a resource within the scope of the owner and
	// application (and document type when kind is `RESOURCE_KIND_DOCUMENT`).
	Key string `protobuf:"bytes,7,opt,name=key,proto3" json:"key,omitempty"`
	// Version of the document.
	Version int64 `protobuf:"varint,8,opt,name=version,proto3" json:"version,omitempty"`
	// UpdatedBy is the identity of the party that last updated the resource.
	UpdatedBy string `protobuf:"bytes,9,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// Occurrence time in RFC3339 format.
	Created string `protobuf:"bytes,10,opt,name=created,proto3" json:"created,omitempty"`
	// contains filtered or unexported fields
}

type EventLogEntryType int32

type GetDocumentRequest struct {

	// URI of the document owner. Optional, defaults to the caller URI (`sub` claim).
	// Can be a user, unit or organization. (e.g., core://user/1234, core://unit/abc, core://org/ab)
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// Type is the content type of the document.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Unique identifier for the document within the scope of the application and type.
	// Can be a human readable slug or a UUID.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

type GetDocumentResponse struct {
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

type GetPropertiesRequest struct {

	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	// If empty, returns properties across all applications.
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	// Unique identifier(s) for the property.
	// If provided, filters properties by key.
	// If `application` is empty, returns properties with these keys across all applications.
	Keys []string `protobuf:"bytes,2,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

type GetPropertiesResponse struct {
	Properties []*Property `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
	// contains filtered or unexported fields
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type InboxMessage struct {

	// Recipient of the message (user sub).
	Recipient string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// ID of the message.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Created timestamp is the RFC3339 timestamp
	// for when the message was created.
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// Creator of the message (application sub).
	CreatedBy string `protobuf:"bytes,4,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Updated timestamp is the RFC3339 timestamp
	// for when the message was last updated.
	Updated string `protobuf:"bytes,5,opt,name=updated,proto3" json:"updated,omitempty"`
	// Indicates whether the message has been read.
	IsRead bool `protobuf:"varint,6,opt,name=is_read,json=isRead,proto3" json:"is_read,omitempty"`
	// Payload containing a newsdoc document.
	Payload *newsdoc.Document `protobuf:"bytes,7,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

type ListDocumentsRequest struct {

	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	// If empty, returns documents across all applications.
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	// Type is the content type of the document.
	// If provided, filters documents by type.
	// If `application` is empty, returns documents of this type across all applications.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// If true, include the document payload in the response.
	// If false (default), payload will be omitted.
	IncludePayload bool `protobuf:"varint,3,opt,name=include_payload,json=includePayload,proto3" json:"include_payload,omitempty"`
	// contains filtered or unexported fields
}

type ListDocumentsResponse struct {
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

type ListInboxMessagesRequest struct {

	// ID of the message before which to list messages.
	BeforeId int64 `protobuf:"varint,1,opt,name=before_id,json=beforeId,proto3" json:"before_id,omitempty"`
	// Number of messages to include in the results (defaults to 10).
	Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

type ListInboxMessagesResponse struct {

	// ID of the latest message returned. Useful for subsequent polling requests.
	LatestId int64 `protobuf:"varint,1,opt,name=latest_id,json=latestId,proto3" json:"latest_id,omitempty"`
	// ID of the earliest message returned. Use for paginating backward.
	EarliestId int64 `protobuf:"varint,2,opt,name=earliest_id,json=earliestId,proto3" json:"earliest_id,omitempty"`
	// Messages sorted in descending order by id (newest first).
	Messages []*InboxMessage `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

type Message struct {

	// ID of the message.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Type of message being sent (e.g. "rpc_error").
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Created timestamp is the RFC3339 timestamp
	// for when the message was created.
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// Creator of the message (application sub).
	CreatedBy string `protobuf:"bytes,4,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// Recipient of the message (user sub).
	Recipient string `protobuf:"bytes,5,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// UUID of the associated document, optional.
	DocUuid string `protobuf:"bytes,6,opt,name=doc_uuid,json=docUuid,proto3" json:"doc_uuid,omitempty"`
	// Type of the associated document, optional.
	DocType string `protobuf:"bytes,7,opt,name=doc_type,json=docType,proto3" json:"doc_type,omitempty"`
	// Payload containing a key-value map.
	Payload map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Messages interface {
	// Pushes a new message to a recipient.
	PushMessage(context.Context, *PushMessageRequest) (*PushMessageResponse, error)

	// Pushes a new inbox message to a recipient.
	PushInboxMessage(context.Context, *PushInboxMessageRequest) (*PushInboxMessageResponse, error)

	// Polls for new messages for a recipient.
	PollMessages(context.Context, *PollMessagesRequest) (*PollMessagesResponse, error)

	// Polls for new inbox messages for a recipient.
	PollInboxMessages(context.Context, *PollInboxMessagesRequest) (*PollInboxMessagesResponse, error)

	// Lists all inbox messages for a recipient.
	ListInboxMessages(context.Context, *ListInboxMessagesRequest) (*ListInboxMessagesResponse, error)

	// Updates an existing inbox message.
	UpdateInboxMessage(context.Context, *UpdateInboxMessageRequest) (*UpdateInboxMessageResponse, error)

	// Deletes an inbox message.
	DeleteInboxMessage(context.Context, *DeleteInboxMessageRequest) (*DeleteInboxMessageResponse, error)
}

type PollEventLogRequest struct {

	// ID of the event after which to start returning events.
	// Set to -1 for the initial request.
	AfterId int64 `protobuf:"varint,1,opt,name=after_id,json=afterId,proto3" json:"after_id,omitempty"`
	// contains filtered or unexported fields
}

type PollEventLogResponse struct {

	// ID of the most recent event returned. Use for subsequent polling requests.
	// If no new events are returned, it matches the `after_id` from the request.
	LastId int64 `protobuf:"varint,1,opt,name=last_id,json=lastId,proto3" json:"last_id,omitempty"`
	// Event log items sorted in ascending order by id (oldest first).
	Entries []*EventLogEntry `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

type PollInboxMessagesRequest struct {

	// ID of the message after which to start returning messages.
	// Set to -1 for the initial request.
	AfterId int64 `protobuf:"varint,1,opt,name=after_id,json=afterId,proto3" json:"after_id,omitempty"`
	// contains filtered or unexported fields
}

type PollInboxMessagesResponse struct {

	// ID of the most recent message returned. Use for subsequent polling requests.
	// If no new messages are returned, it matches the `after_id` from the request.
	LastId int64 `protobuf:"varint,1,opt,name=last_id,json=lastId,proto3" json:"last_id,omitempty"`
	// Messages sorted in ascending order by id (oldest first).
	Messages []*InboxMessage `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

type PollMessagesRequest struct {

	// ID of the message after which to start returning messages.
	// Set to -1 for the initial request.
	AfterId int64 `protobuf:"varint,1,opt,name=after_id,json=afterId,proto3" json:"after_id,omitempty"`
	// contains filtered or unexported fields
}

type PollMessagesResponse struct {

	// ID of the most recent message returned. Use for subsequent polling requests.
	// If no new messages are returned, it matches the `after_id` from the request.
	LastId int64 `protobuf:"varint,1,opt,name=last_id,json=lastId,proto3" json:"last_id,omitempty"`
	// Messages sorted in ascending order by id (oldest first).
	Messages []*Message `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

type Property struct {

	// URI of the property owner. Matches the caller `sub` claim.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// Unique identifier for the property within the application.
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// The value serialized as a string.
	Value string `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// Creation time in RFC3339 format.
	Created string `protobuf:"bytes,5,opt,name=created,proto3" json:"created,omitempty"`
	// Last update time in RFC3339 format.
	Updated string `protobuf:"bytes,6,opt,name=updated,proto3" json:"updated,omitempty"`
	// contains filtered or unexported fields
}

type PropertyDelete struct {

	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	// Unique identifier for the property within the application.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

type PropertyUpdate struct {

	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	// Unique identifier for the property within the application.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// The value serialized as a string.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type PushInboxMessageRequest struct {

	// Recipient of the message (user sub).
	Recipient string `protobuf:"bytes,1,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// Payload containing a newsdoc document.
	Payload *newsdoc.Document `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

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

type PushMessageRequest struct {

	// Type of message being sent (e.g. "rpc_error").
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Recipient of the message (user sub).
	Recipient string `protobuf:"bytes,2,opt,name=recipient,proto3" json:"recipient,omitempty"`
	// UUID of the associated document, optional.
	DocUuid string `protobuf:"bytes,3,opt,name=doc_uuid,json=docUuid,proto3" json:"doc_uuid,omitempty"`
	// Type of the associated document, optional.
	DocType string `protobuf:"bytes,4,opt,name=doc_type,json=docType,proto3" json:"doc_type,omitempty"`
	// Payload containing a key-value map.
	Payload map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

type ResourceKind int32

type SetPropertiesRequest struct {
	Properties []*PropertyUpdate `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
	// contains filtered or unexported fields
}

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

type Settings interface {
	// Gets a specific document for the authenticated user.
	GetDocument(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)

	// Lists documents for the authenticated user.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

	// Updates an existing or creates a new document for the authenticated user.
	UpdateDocument(context.Context, *UpdateDocumentRequest) (*UpdateDocumentResponse, error)

	// Deletes a document for the authenticated user.
	DeleteDocument(context.Context, *DeleteDocumentRequest) (*DeleteDocumentResponse, error)

	// Gets properties for the authenticated user.
	GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)

	// Sets or updates properties for the authenticated user.
	SetProperties(context.Context, *SetPropertiesRequest) (*SetPropertiesResponse, error)

	// Deletes properties for the authenticated user.
	DeleteProperties(context.Context, *DeletePropertiesRequest) (*DeletePropertiesResponse, error)

	// Polls for a stream of changes (creates, updates, deletes)
	// for both documents and properties for the authenticated user.
	PollEventLog(context.Context, *PollEventLogRequest) (*PollEventLogResponse, error)
}

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}

type UpdateDocumentRequest struct {

	// URI of the document owner. Optional, defaults to the caller URI (`sub` claim).
	// Can be a user, unit or organization. (e.g., core://user/1234, core://unit/abc, core://org/ab)
	// Only admin users can set it to a unit or organization.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// The unique application identifier in reverse domain notation
	// (e.g., `com.example.assignments` or `com.example.writer`).
	Application string `protobuf:"bytes,2,opt,name=application,proto3" json:"application,omitempty"`
	// Type is the content type of the document.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Unique identifier for the document within the scope of the application and type.
	// Can be a human readable slug or a UUID.
	Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"`
	// Semver string indicating the schema version of the payload.
	SchemaVersion string `protobuf:"bytes,5,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// Payload contains a newsdoc document with actual configuration data.
	Payload *newsdoc.Document `protobuf:"bytes,6,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

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

type UpdateInboxMessageRequest struct {

	// ID of the message.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Sets the message's read status.
	IsRead bool `protobuf:"varint,2,opt,name=is_read,json=isRead,proto3" json:"is_read,omitempty"`
	// contains filtered or unexported fields
}

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