spell

type Check interface {
	// Text spellchecks a text and returns the misspelled words or phrases.
	Text(context.Context, *TextRequest) (*TextResponse, error)

	// Suggestions returns suggestions for a word or phrase.
	Suggestions(context.Context, *SuggestionsRequest) (*SuggestionsResponse, error)
}

type CorrectionLevel int32

type CustomDictionary struct {

	// Language the dictionary is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// EntryCount for the dictionary.
	EntryCount int64 `protobuf:"varint,2,opt,name=entry_count,json=entryCount,proto3" json:"entry_count,omitempty"`
	// PendingCount is the number of entries awaiting moderation.
	PendingCount int64 `protobuf:"varint,3,opt,name=pending_count,json=pendingCount,proto3" json:"pending_count,omitempty"`
	// RuleCount is the number of pattern rules for the language.
	RuleCount int64 `protobuf:"varint,4,opt,name=rule_count,json=ruleCount,proto3" json:"rule_count,omitempty"`
	// RulePendingCount is the number of rules awaiting moderation.
	RulePendingCount int64 `protobuf:"varint,5,opt,name=rule_pending_count,json=rulePendingCount,proto3" json:"rule_pending_count,omitempty"`
	// contains filtered or unexported fields
}

type CustomEntry struct {

	// Language the entry is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Text is the word (or phrase) itself.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// Status of the entry, this is used for moderation.
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// Description of the entry.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// CommonMistakes are misspellings or alternative spellings that should be
	// flagged and corrected to the entry text. Supports {A|B} expansion.
	CommonMistakes []string `protobuf:"bytes,5,rep,name=common_mistakes,json=commonMistakes,proto3" json:"common_mistakes,omitempty"`
	// Level to use when offering corrections based on this entry. Optional,
	// defaults to LEVEL_ERROR.
	Level CorrectionLevel `protobuf:"varint,6,opt,name=level,proto3,enum=elephant.spell.CorrectionLevel" json:"level,omitempty"`
	// Forms is an alternative to the common mistakes -> text pairing and allows
	// the mapping of different forms of the word or phrase to specific
	// replacements.
	Forms map[string]string `` /* 137-byte string literal not displayed */
	// Updated is the last update time in RFC3339 format.
	Updated string `protobuf:"bytes,8,opt,name=updated,proto3" json:"updated,omitempty"`
	// UpdatedBy is the identity of the party that last updated the entry.
	UpdatedBy string `protobuf:"bytes,9,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// CaseSensitive controls whether the entry matches only with the exact casing
	// of its text and common mistakes. Defaults to false (case-insensitive
	// matching), which suits ordinary words. Enable it for proper nouns; a
	// case-sensitive entry additionally flags leading-letter miscasings of its
	// text and common mistakes (e.g. "mexico city") and suggests the exact
	// casing.
	CaseSensitive bool `protobuf:"varint,10,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// Before, when set, only flags a match when immediately preceded by one of
	// these words.
	Before []string `protobuf:"bytes,11,rep,name=before,proto3" json:"before,omitempty"`
	// After, when set, only flags a match when immediately followed by one of
	// these words.
	After []string `protobuf:"bytes,12,rep,name=after,proto3" json:"after,omitempty"`
	// NotBefore suppresses the match when preceded by one of these words.
	NotBefore []string `protobuf:"bytes,13,rep,name=not_before,json=notBefore,proto3" json:"not_before,omitempty"`
	// NotAfter suppresses the match when followed by one of these words.
	NotAfter []string `protobuf:"bytes,14,rep,name=not_after,json=notAfter,proto3" json:"not_after,omitempty"`
	// contains filtered or unexported fields
}

type DeleteEntryRequest struct {

	// Language the entry is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Text is the word or phrase to delete.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

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

type DeleteRuleRequest struct {

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

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

type Dictionaries interface {
	// SupportedLanguages returns a list of supported languages.
	SupportedLanguages(context.Context, *SupportedLanguagesRequest) (*SupportedLanguagesResponse, error)

	// ListDictionaries lists the currently available custom dictionaries.
	ListDictionaries(context.Context, *ListDictionariesRequest) (*ListDictionariesResponse, error)

	// ListEntries lists entries in the custom dictionaries.
	ListEntries(context.Context, *ListEntriesRequest) (*ListEntriesResponse, error)

	// GetEntry returns the details of a custom word or phrase.
	GetEntry(context.Context, *GetEntryRequest) (*GetEntryResponse, error)

	// SetEntry is used to add or update custom dictionary entries.
	SetEntry(context.Context, *SetEntryRequest) (*SetEntryResponse, error)

	// SetEntryStatus updates only the moderation status of an entry. It is a
	// lightweight alternative to SetEntry for accept/reject workflows that don't
	// need to round-trip the whole entry.
	SetEntryStatus(context.Context, *SetEntryStatusRequest) (*SetEntryStatusResponse, error)

	// DeleteEntry is used to remove an entry.
	DeleteEntry(context.Context, *DeleteEntryRequest) (*DeleteEntryResponse, error)

	// RenameEntry changes the text of a custom dictionary entry, keeping the rest
	// of its data. The text is the entry's identity, so renaming is a dedicated
	// operation rather than a SetEntry.
	RenameEntry(context.Context, *RenameEntryRequest) (*RenameEntryResponse, error)
}

type GetEntryRequest struct {

	// Language the entry is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Text is the word or phrase to get the entry for.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

type GetEntryResponse struct {

	// Entry information.
	Entry *CustomEntry `protobuf:"bytes,1,opt,name=entry,proto3" json:"entry,omitempty"`
	// contains filtered or unexported fields
}

type GetRuleRequest struct {

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

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

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

type Language struct {

	// Code for the language.
	Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

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

type ListDictionariesResponse struct {
	Dictionaries []*CustomDictionary `protobuf:"bytes,1,rep,name=dictionaries,proto3" json:"dictionaries,omitempty"`
	// contains filtered or unexported fields
}

type ListEntriesRequest struct {

	// Language to list entries for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Page to return.
	Page int64 `protobuf:"varint,2,opt,name=page,proto3" json:"page,omitempty"`
	// Query filters entries by a free-text substring, matched against the entry
	// text, its description, and its common mistakes.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// Status to filter entries by
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// PageSize is the number of entries to return per page. Optional, defaults to
	// 100 when zero.
	PageSize int64 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

type ListEntriesResponse struct {
	Entries []*CustomEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

type ListRulesRequest struct {

	// Language to list rules for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Page to return.
	Page int64 `protobuf:"varint,2,opt,name=page,proto3" json:"page,omitempty"`
	// Query filters rules by a free-text substring, matched against the name,
	// description, pattern and replacement.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// Status to filter rules by.
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// PageSize is the number of rules per page. Optional, defaults to 100.
	PageSize int64 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// contains filtered or unexported fields
}

type ListRulesResponse struct {
	Rules []*Rule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

type Misspelled struct {
	Entries []*MisspelledEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

type MisspelledEntry struct {

	// Text that was used in the source text.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Suggestions for replacements.
	Suggestions []*Suggestion `protobuf:"bytes,2,rep,name=suggestions,proto3" json:"suggestions,omitempty"`
	// Level is the level of the correction.
	Level CorrectionLevel `protobuf:"varint,3,opt,name=level,proto3,enum=elephant.spell.CorrectionLevel" json:"level,omitempty"`
	// Status of the custom entry the correction is based on, e.g. "accepted" or
	// "pending". Empty for corrections that don't originate from a custom entry
	// (such as plain hunspell results). Clients can use this to indicate that a
	// correction comes from an unreviewed (pending) entry.
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// Spans are the character ranges in the source text where this specific
	// correction applies. The same text can occur several times with different
	// outcomes (e.g. only one occurrence is corrected), so clients should act on
	// these ranges rather than searching for the text. Empty for corrections that
	// apply wherever the text appears, such as plain hunspell results.
	Spans []*TextSpan `protobuf:"bytes,5,rep,name=spans,proto3" json:"spans,omitempty"`
	// contains filtered or unexported fields
}

type RenameEntryRequest struct {

	// Language the entry is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Text is the current entry text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// NewText is the text to rename the entry to.
	NewText string `protobuf:"bytes,3,opt,name=new_text,json=newText,proto3" json:"new_text,omitempty"`
	// contains filtered or unexported fields
}

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

type Rule struct {

	// ID is the sequential primary key of the rule. Zero when creating a new
	// rule; the server assigns it.
	Id int64 `protobuf:"varint,14,opt,name=id,proto3" json:"id,omitempty"`
	// Language the rule is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Name is a human-readable label for the rule. It is not unique.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Status of the rule, used for moderation.
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// Description shown to editors as context for the correction.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Level to use when offering corrections. Optional, defaults to LEVEL_ERROR.
	Level CorrectionLevel `protobuf:"varint,5,opt,name=level,proto3,enum=elephant.spell.CorrectionLevel" json:"level,omitempty"`
	// Pattern to match, in the rule DSL (see the message documentation).
	Pattern string `protobuf:"bytes,6,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// Replacement template for the suggestion, referencing captures as {1}, {2}, …
	Replacement string `protobuf:"bytes,7,opt,name=replacement,proto3" json:"replacement,omitempty"`
	// Before, when set, only matches when immediately preceded by one of these
	// words.
	Before []string `protobuf:"bytes,8,rep,name=before,proto3" json:"before,omitempty"`
	// After, when set, only matches when immediately followed by one of these
	// words.
	After []string `protobuf:"bytes,9,rep,name=after,proto3" json:"after,omitempty"`
	// NotBefore suppresses the match when preceded by one of these words.
	NotBefore []string `protobuf:"bytes,10,rep,name=not_before,json=notBefore,proto3" json:"not_before,omitempty"`
	// NotAfter suppresses the match when followed by one of these words.
	NotAfter []string `protobuf:"bytes,11,rep,name=not_after,json=notAfter,proto3" json:"not_after,omitempty"`
	// Updated is the last update time in RFC3339 format.
	Updated string `protobuf:"bytes,12,opt,name=updated,proto3" json:"updated,omitempty"`
	// UpdatedBy is the identity of the party that last updated the rule.
	UpdatedBy string `protobuf:"bytes,13,opt,name=updated_by,json=updatedBy,proto3" json:"updated_by,omitempty"`
	// CaseSensitive matches the pattern and guards with their exact casing when
	// set. Defaults to case-insensitive matching.
	CaseSensitive bool `protobuf:"varint,15,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
	// contains filtered or unexported fields
}

type Rules interface {
	// ListRules lists pattern rules.
	ListRules(context.Context, *ListRulesRequest) (*ListRulesResponse, error)

	// GetRule returns the details of a single rule.
	GetRule(context.Context, *GetRuleRequest) (*GetRuleResponse, error)

	// SetRule adds or updates a rule.
	SetRule(context.Context, *SetRuleRequest) (*SetRuleResponse, error)

	// SetRuleStatus updates only the moderation status of a rule.
	SetRuleStatus(context.Context, *SetRuleStatusRequest) (*SetRuleStatusResponse, error)

	// DeleteRule removes a rule.
	DeleteRule(context.Context, *DeleteRuleRequest) (*DeleteRuleResponse, error)
}

type SetEntryRequest struct {

	// Entry to set.
	Entry *CustomEntry `protobuf:"bytes,1,opt,name=entry,proto3" json:"entry,omitempty"`
	// contains filtered or unexported fields
}

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

type SetEntryStatusRequest struct {

	// Language the entry is for.
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// Text is the word or phrase to update.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// Status to set, e.g. "accepted" or "pending".
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

type SetRuleRequest struct {

	// Rule to set. A zero id creates a new rule; a non-zero id updates the
	// existing rule with that id.
	Rule *Rule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"`
	// contains filtered or unexported fields
}

type SetRuleResponse struct {

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

type SetRuleStatusRequest struct {

	// ID of the rule to update.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Status to set, e.g. "accepted" or "pending".
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

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

type Suggestion struct {
	Text        string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

type SuggestionsRequest struct {

	// Text is the word or phrase to get suggestions for.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Language to get suggestions in.
	Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
	// CustomOnly limits suggestions to the custom dictionary and rules, skipping
	// the hunspell pass.
	CustomOnly bool `protobuf:"varint,3,opt,name=custom_only,json=customOnly,proto3" json:"custom_only,omitempty"`
	// contains filtered or unexported fields
}

type SuggestionsResponse struct {

	// Suggestions for replacements.
	Suggestions []*Suggestion `protobuf:"bytes,1,rep,name=suggestions,proto3" json:"suggestions,omitempty"`
	// contains filtered or unexported fields
}

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

type SupportedLanguagesResponse struct {

	// Languages that can be used for spellchecking.
	Languages []*Language `protobuf:"bytes,1,rep,name=languages,proto3" json:"languages,omitempty"`
	// contains filtered or unexported fields
}

type TextRequest struct {

	// Text to spellcheck.
	Text []string `protobuf:"bytes,1,rep,name=text,proto3" json:"text,omitempty"`
	// Language to check the text for.
	Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
	// Suggestions enables generation of suggestions for misspelled words. In
	// interactive applications this should normally be done by calling the
	// Suggestions method on demand.
	Suggestions bool `protobuf:"varint,3,opt,name=suggestions,proto3" json:"suggestions,omitempty"`
	// CustomOnly limits checks to the custom dictionary and rules, skipping the
	// hunspell pass. Useful when you only want to surface custom corrections
	// without the noise of hunspell results.
	CustomOnly bool `protobuf:"varint,4,opt,name=custom_only,json=customOnly,proto3" json:"custom_only,omitempty"`
	// contains filtered or unexported fields
}

type TextResponse struct {
	Misspelled []*Misspelled `protobuf:"bytes,1,rep,name=misspelled,proto3" json:"misspelled,omitempty"`
	// contains filtered or unexported fields
}

type TextSpan struct {

	// Start is the character offset of the match in the source text.
	Start int64 `protobuf:"varint,1,opt,name=start,proto3" json:"start,omitempty"`
	// End is the character offset just past the match.
	End int64 `protobuf:"varint,2,opt,name=end,proto3" json:"end,omitempty"`
	// contains filtered or unexported fields
}

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
}