quran

type Chapter struct {

	// The id of the chapter as a number e.g 1
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The number of verses in the chapter
	Verses int32 `protobuf:"varint,2,opt,name=verses,proto3" json:"verses,omitempty"`
	// The simple name of the chapter
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// The arabic name of the chapter
	ArabicName string `protobuf:"bytes,4,opt,name=arabic_name,json=arabicName,proto3" json:"arabic_name,omitempty"`
	// The complex name of the chapter
	ComplexName string `protobuf:"bytes,5,opt,name=complex_name,json=complexName,proto3" json:"complex_name,omitempty"`
	// The translated name
	TranslatedName string `protobuf:"bytes,6,opt,name=translated_name,json=translatedName,proto3" json:"translated_name,omitempty"`
	// Should the chapter start with bismillah
	PrefixBismillah bool `protobuf:"varint,7,opt,name=prefix_bismillah,json=prefixBismillah,proto3" json:"prefix_bismillah,omitempty"`
	// The place of revelation
	RevelationPlace string `protobuf:"bytes,8,opt,name=revelation_place,json=revelationPlace,proto3" json:"revelation_place,omitempty"`
	// The order in which it was revealed
	RevelationOrder int32 `protobuf:"varint,9,opt,name=revelation_order,json=revelationOrder,proto3" json:"revelation_order,omitempty"`
	// The pages from and to e.g 1, 1
	Pages []int32 `protobuf:"varint,10,rep,packed,name=pages,proto3" json:"pages,omitempty"`
	// contains filtered or unexported fields
}

type ChaptersRequest struct {

	// Specify the language e.g en
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// contains filtered or unexported fields
}

type ChaptersResponse struct {
	Chapters []*Chapter `protobuf:"bytes,1,rep,name=chapters,proto3" json:"chapters,omitempty"`
	// contains filtered or unexported fields
}

type Interpretation struct {

	// The unique id of the interpretation
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The source of the interpretation
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The translated text
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

type QuranHandler interface {
	Chapters(context.Context, *ChaptersRequest, *ChaptersResponse) error
	Summary(context.Context, *SummaryRequest, *SummaryResponse) error
	Verses(context.Context, *VersesRequest, *VersesResponse) error
	Search(context.Context, *SearchRequest, *SearchResponse) error
}

type QuranService interface {
	Chapters(ctx context.Context, in *ChaptersRequest, opts ...client.CallOption) (*ChaptersResponse, error)
	Summary(ctx context.Context, in *SummaryRequest, opts ...client.CallOption) (*SummaryResponse, error)
	Verses(ctx context.Context, in *VersesRequest, opts ...client.CallOption) (*VersesResponse, error)
	Search(ctx context.Context, in *SearchRequest, opts ...client.CallOption) (*SearchResponse, error)
}

type Result struct {

	// The unique verse id across the Quran
	VerseId int32 `protobuf:"varint,1,opt,name=verse_id,json=verseId,proto3" json:"verse_id,omitempty"`
	// The verse key e.g 1:1
	VerseKey string `protobuf:"bytes,2,opt,name=verse_key,json=verseKey,proto3" json:"verse_key,omitempty"`
	// The associated arabic text
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// The related translations to the text
	Translations []*Translation `protobuf:"bytes,4,rep,name=translations,proto3" json:"translations,omitempty"`
	// contains filtered or unexported fields
}

type SearchRequest struct {

	// The query to ask
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// The language for translation
	Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
	// The number of results to return
	Limit int32 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// The pagination number
	Page int32 `protobuf:"varint,4,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

type SearchResponse struct {

	// The question asked
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// The total results returned
	TotalResults int32 `protobuf:"varint,2,opt,name=total_results,json=totalResults,proto3" json:"total_results,omitempty"`
	// The current page
	Page int32 `protobuf:"varint,3,opt,name=page,proto3" json:"page,omitempty"`
	// The total pages
	TotalPages int32 `protobuf:"varint,4,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"`
	// The results for the query
	Results []*Result `protobuf:"bytes,5,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type SummaryRequest struct {

	// The chapter id e.g 1
	Chapter int32 `protobuf:"varint,1,opt,name=chapter,proto3" json:"chapter,omitempty"`
	// Specify the language e.g en
	Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
	// contains filtered or unexported fields
}

type SummaryResponse struct {

	// The chapter id
	Chapter int32 `protobuf:"varint,1,opt,name=chapter,proto3" json:"chapter,omitempty"`
	// The short summary for the chapter
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// The source of the summary
	Source string `protobuf:"bytes,3,opt,name=source,proto3" json:"source,omitempty"`
	// The full description for the chapter
	Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

type Translation struct {

	// The unique id of the translation
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The source of the translation
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The translated text
	Text string `protobuf:"bytes,3,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

type Verse struct {

	// The unique id of the verse in the whole book
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The verse number in this chapter
	Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"`
	// The key of this verse (chapter:verse) e.g 1:1
	Key string `protobuf:"bytes,3,opt,name=key,proto3" json:"key,omitempty"`
	// The page of the Quran this verse is on
	Page int32 `protobuf:"varint,4,opt,name=page,proto3" json:"page,omitempty"`
	// The arabic text for this verse
	Text string `protobuf:"bytes,5,opt,name=text,proto3" json:"text,omitempty"`
	// The phonetic transliteration from arabic
	Transliteration string `protobuf:"bytes,6,opt,name=transliteration,proto3" json:"transliteration,omitempty"`
	// The basic translation of the verse
	TranslatedText string `protobuf:"bytes,7,opt,name=translated_text,json=translatedText,proto3" json:"translated_text,omitempty"`
	// The alternative translations for the verse
	Translations []*Translation `protobuf:"bytes,8,rep,name=translations,proto3" json:"translations,omitempty"`
	// The interpretations of the verse
	Interpretations []*Interpretation `protobuf:"bytes,9,rep,name=interpretations,proto3" json:"interpretations,omitempty"`
	// The individual words within the verse (Ayah)
	Words []*Word `protobuf:"bytes,10,rep,name=words,proto3" json:"words,omitempty"`
	// contains filtered or unexported fields
}

type VersesRequest struct {

	// The chapter id to retrieve
	Chapter int32 `protobuf:"varint,1,opt,name=chapter,proto3" json:"chapter,omitempty"`
	// The language of translation
	Language string `protobuf:"bytes,2,opt,name=language,proto3" json:"language,omitempty"`
	// Return the individual words with the verses
	Words bool `protobuf:"varint,3,opt,name=words,proto3" json:"words,omitempty"`
	// Return the interpretation (tafsir)
	Interpret bool `protobuf:"varint,4,opt,name=interpret,proto3" json:"interpret,omitempty"`
	// Return alternate translations
	Translate bool `protobuf:"varint,5,opt,name=translate,proto3" json:"translate,omitempty"`
	// The page number to request
	Page int32 `protobuf:"varint,6,opt,name=page,proto3" json:"page,omitempty"`
	// The verses per page
	Limit int32 `protobuf:"varint,7,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

type VersesResponse struct {

	// The chapter requested
	Chapter int32 `protobuf:"varint,1,opt,name=chapter,proto3" json:"chapter,omitempty"`
	// The page requested
	Page int32 `protobuf:"varint,2,opt,name=page,proto3" json:"page,omitempty"`
	// The total pages
	TotalPages int32 `protobuf:"varint,3,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"`
	// The verses on the page
	Verses []*Verse `protobuf:"bytes,4,rep,name=verses,proto3" json:"verses,omitempty"`
	// contains filtered or unexported fields
}

type Word struct {

	// The id of the word within the verse
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The position of the word
	Position int32 `protobuf:"varint,2,opt,name=position,proto3" json:"position,omitempty"`
	// The character type e.g word, end
	CharType string `protobuf:"bytes,3,opt,name=char_type,json=charType,proto3" json:"char_type,omitempty"`
	// The page number
	Page int32 `protobuf:"varint,4,opt,name=page,proto3" json:"page,omitempty"`
	// The line number
	Line int32 `protobuf:"varint,5,opt,name=line,proto3" json:"line,omitempty"`
	// The arabic text for this word
	Text string `protobuf:"bytes,6,opt,name=text,proto3" json:"text,omitempty"`
	// The QCF v2 font code
	Code string `protobuf:"bytes,7,opt,name=code,proto3" json:"code,omitempty"`
	// The translated text
	Translation string `protobuf:"bytes,8,opt,name=translation,proto3" json:"translation,omitempty"`
	// The transliteration text
	Transliteration string `protobuf:"bytes,9,opt,name=transliteration,proto3" json:"transliteration,omitempty"`
	// contains filtered or unexported fields
}