Commit from GitHub Actions (Publish APIs & Clients)

clients/go/m3o.go

@@ -27,6 +27,7 @@ import (
 	"github.com/micro/services/clients/go/sms"
 	"github.com/micro/services/clients/go/stock"
 	"github.com/micro/services/clients/go/stream"
+	"github.com/micro/services/clients/go/sunnah"
 	"github.com/micro/services/clients/go/thumbnail"
 	"github.com/micro/services/clients/go/time"
 	"github.com/micro/services/clients/go/twitter"
@@ -65,6 +66,7 @@ func NewClient(token string) *Client {
 		SmsService:        sms.NewSmsService(token),
 		StockService:      stock.NewStockService(token),
 		StreamService:     stream.NewStreamService(token),
+		SunnahService:     sunnah.NewSunnahService(token),
 		ThumbnailService:  thumbnail.NewThumbnailService(token),
 		TimeService:       time.NewTimeService(token),
 		TwitterService:    twitter.NewTwitterService(token),
@@ -103,6 +105,7 @@ type Client struct {
 	SmsService        *sms.SmsService
 	StockService      *stock.StockService
 	StreamService     *stream.StreamService
+	SunnahService     *sunnah.SunnahService
 	ThumbnailService  *thumbnail.ThumbnailService
 	TimeService       *time.TimeService
 	TwitterService    *twitter.TwitterService

clients/go/quran/quran.go

@@ -87,7 +87,7 @@ type Result struct {
 	// The associated arabic text
 	Text string `json:"text"`
 	// The related translations to the text
-	Translations []Interpretation `json:"translations"`
+	Translations []Translation `json:"translations"`
 	// The unique verse id across the Quran
 	VerseId int32 `json:"verseId"`
 	// The verse key e.g 1:1
@@ -149,7 +149,7 @@ type Verse struct {
 	// The unique id of the verse in the whole book
 	Id int32 `json:"id"`
 	// The interpretations of the verse
-	Interpretations []Interpretation `json:"interpretations"`
+	Interpretations []Translation `json:"interpretations"`
 	// The key of this verse (chapter:verse) e.g 1:1
 	Key string `json:"key"`
 	// The verse number in this chapter
@@ -161,7 +161,7 @@ type Verse struct {
 	// The basic translation of the verse
 	TranslatedText string `json:"translatedText"`
 	// The alternative translations for the verse
-	Translations []Interpretation `json:"translations"`
+	Translations []Translation `json:"translations"`
 	// The phonetic transliteration from arabic
 	Transliteration string `json:"transliteration"`
 	// The individual words within the verse (Ayah)

clients/go/sunnah/sunnah.go

@@ -0,0 +1,183 @@
+package sunnah
+
+import (
+	"github.com/m3o/m3o-go/client"
+)
+
+func NewSunnahService(token string) *SunnahService {
+	return &SunnahService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type SunnahService struct {
+	client *client.Client
+}
+
+// Get a list of books from within a collection. A book can contain many chapters
+// each with its own hadiths.
+func (t *SunnahService) Books(request *BooksRequest) (*BooksResponse, error) {
+	rsp := &BooksResponse{}
+	return rsp, t.client.Call("sunnah", "Books", request, rsp)
+}
+
+// Get all the chapters of a given book within a collection.
+func (t *SunnahService) Chapters(request *ChaptersRequest) (*ChaptersResponse, error) {
+	rsp := &ChaptersResponse{}
+	return rsp, t.client.Call("sunnah", "Chapters", request, rsp)
+}
+
+// Get a list of available collections. A collection is
+// a compilation of hadiths collected and written by an author.
+func (t *SunnahService) Collections(request *CollectionsRequest) (*CollectionsResponse, error) {
+	rsp := &CollectionsResponse{}
+	return rsp, t.client.Call("sunnah", "Collections", request, rsp)
+}
+
+// Hadiths returns a list of hadiths and their corresponding text for a
+// given book within a collection.
+func (t *SunnahService) Hadiths(request *HadithsRequest) (*HadithsResponse, error) {
+	rsp := &HadithsResponse{}
+	return rsp, t.client.Call("sunnah", "Hadiths", request, rsp)
+}
+
+type Book struct {
+	// arabic name of the book
+	ArabicName string `json:"arabicName"`
+	// number of hadiths in the book
+	Hadiths int32 `json:"hadiths"`
+	// number of the book e.g 1
+	Id int32 `json:"id"`
+	// name of the book
+	Name string `json:"name"`
+}
+
+type BooksRequest struct {
+	// Name of the collection
+	Collection string `json:"collection"`
+	// Limit the number of books returned
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+}
+
+type BooksResponse struct {
+	// A list of books
+	Books []Book `json:"books"`
+	// Name of the collection
+	Collection string `json:"collection"`
+	// The limit specified
+	Limit int32 `json:"limit"`
+	// The page requested
+	Page int32 `json:"page"`
+	// The total overall books
+	Total int32 `json:"total"`
+}
+
+type Chapter struct {
+	// arabic title
+	ArabicTitle string `json:"arabicTitle"`
+	// the book number
+	Book int32 `json:"book"`
+	// the chapter id e.g 1
+	Id int32 `json:"id"`
+	// the chapter key e.g 1.00
+	Key string `json:"key"`
+	// title of the chapter
+	Title string `json:"title"`
+}
+
+type ChaptersRequest struct {
+	// number of the book
+	Book int32 `json:"book"`
+	// name of the collection
+	Collection string `json:"collection"`
+	// Limit the number of chapters returned
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+}
+
+type ChaptersResponse struct {
+	// number of the book
+	Book int32 `json:"book"`
+	// The chapters of the book
+	Chapters []Chapter `json:"chapters"`
+	// name of the collection
+	Collection string `json:"collection"`
+	// Limit the number of chapters returned
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+	// Total chapters in the book
+	Total int32 `json:"total"`
+}
+
+type Collection struct {
+	// Arabic title if available
+	ArabicTitle string `json:"arabicTitle"`
+	// Total hadiths in the collection
+	Hadiths int32 `json:"hadiths"`
+	// Name of the collection e.g bukhari
+	Name string `json:"name"`
+	// An introduction explaining the collection
+	Summary string `json:"summary"`
+	// Title of the collection e.g Sahih al-Bukhari
+	Title string `json:"title"`
+}
+
+type CollectionsRequest struct {
+	// Number of collections to limit to
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+}
+
+type CollectionsResponse struct {
+	Collections []Collection `json:"collections"`
+}
+
+type Hadith struct {
+	// the arabic chapter title
+	ArabicChapterTitle string `json:"arabicChapterTitle"`
+	// the arabic text
+	ArabicText string `json:"arabicText"`
+	// the chapter id
+	Chapter int32 `json:"chapter"`
+	// the chapter key
+	ChapterKey string `json:"chapterKey"`
+	// the chapter title
+	ChapterTitle string `json:"chapterTitle"`
+	// hadith id
+	Id int32 `json:"id"`
+	// hadith text
+	Text string `json:"text"`
+}
+
+type HadithsRequest struct {
+	// number of the book
+	Book int32 `json:"book"`
+	// name of the collection
+	Collection string `json:"collection"`
+	// Limit the number of hadiths
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+}
+
+type HadithsResponse struct {
+	// number of the book
+	Book int32 `json:"book"`
+	// name of the collection
+	Collection string `json:"collection"`
+	// The hadiths of the book
+	Hadiths []Hadith `json:"hadiths"`
+	// Limit the number of hadiths returned
+	Limit int32 `json:"limit"`
+	// The page in the pagination
+	Page int32 `json:"page"`
+	// Total hadiths in the  book
+	Total int32 `json:"total"`
+}