Commit from m3o/m3o action

examples/cache/README.md

@@ -4,35 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Cache/api](htt
 
 Endpoints:
 
-## Decrement
-
-Decrement a value (if it's a number). If key not found it is equivalent to set.
-
-
-[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/cache"
-)
-
-// Decrement a value (if it's a number). If key not found it is equivalent to set.
-func DecrementAvalue() {
-	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
-		Key: "counter",
-Value: 2,
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Set
 
 Set an item in the cache. Overwrites any existing value already set.
@@ -147,3 +118,32 @@ Value: 2,
 	
 }
 ```
+## Decrement
+
+Decrement a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
+func DecrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/db/README.md

@@ -4,6 +4,67 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https:
 
 Endpoints:
 
+## Update
+
+Update a record in the database. Include an "id" in the record to update.
+
+
+[https://m3o.com/db/api#Update](https://m3o.com/db/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Update a record in the database. Include an "id" in the record to update.
+func UpdateArecord() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Update(&db.UpdateRequest{
+		Record: map[string]interface{}{
+	"id": "1",
+	"age": 43,
+},
+Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Read
+
+Read data from a table. Lookup can be by ID or via querying any field in the record.
+
+
+[https://m3o.com/db/api#Read](https://m3o.com/db/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Read data from a table. Lookup can be by ID or via querying any field in the record.
+func ReadRecords() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Read(&db.ReadRequest{
+		Query: "age == 43",
+Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Delete
 
 Delete a record in the database by id.
@@ -111,10 +172,10 @@ func CreateArecord() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Create(&db.CreateRequest{
 		Record: map[string]interface{}{
-	"name": "Jane",
 	"age": 42,
 	"isActive": true,
 	"id": "1",
+	"name": "Jane",
 },
 Table: "users",
 
@@ -123,64 +184,3 @@ Table: "users",
 	
 }
 ```
-## Update
-
-Update a record in the database. Include an "id" in the record to update.
-
-
-[https://m3o.com/db/api#Update](https://m3o.com/db/api#Update)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Update a record in the database. Include an "id" in the record to update.
-func UpdateArecord() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Update(&db.UpdateRequest{
-		Record: map[string]interface{}{
-	"id": "1",
-	"age": 43,
-},
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Read
-
-Read data from a table. Lookup can be by ID or via querying any field in the record.
-
-
-[https://m3o.com/db/api#Read](https://m3o.com/db/api#Read)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Read data from a table. Lookup can be by ID or via querying any field in the record.
-func ReadRecords() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Read(&db.ReadRequest{
-		Query: "age == 43",
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/db/create/createARecord/main.go

@@ -12,10 +12,10 @@ func main() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Create(&db.CreateRequest{
 		Record: map[string]interface{}{
+			"id":       "1",
 			"name":     "Jane",
 			"age":      42,
 			"isActive": true,
-			"id":       "1",
 		},
 		Table: "users",
 	})

examples/db/update/updateARecord/main.go

@@ -12,8 +12,8 @@ func main() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Update(&db.UpdateRequest{
 		Record: map[string]interface{}{
-			"age": 43,
 			"id":  "1",
+			"age": 43,
 		},
 		Table: "users",
 	})

examples/event/publish/publishAnEvent/main.go

@@ -12,9 +12,9 @@ func main() {
 	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := eventService.Publish(&event.PublishRequest{
 		Message: map[string]interface{}{
-			"user": "john",
 			"id":   "1",
 			"type": "signup",
+			"user": "john",
 		},
 		Topic: "user",
 	})

examples/forex/README.md

@@ -4,6 +4,34 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Forex/api](htt
 
 Endpoints:
 
+## History
+
+Returns the data for the previous close
+
+
+[https://m3o.com/forex/api#History](https://m3o.com/forex/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Returns the data for the previous close
+func GetPreviousClose() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.History(&forex.HistoryRequest{
+		Symbol: "GBPUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Price
 
 Get the latest price for a given forex ticker
@@ -60,31 +88,3 @@ func GetAfxQuote() {
 	
 }
 ```
-## History
-
-Returns the data for the previous close
-
-
-[https://m3o.com/forex/api#History](https://m3o.com/forex/api#History)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/forex"
-)
-
-// Returns the data for the previous close
-func GetPreviousClose() {
-	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := forexService.History(&forex.HistoryRequest{
-		Symbol: "GBPUSD",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/function/README.md

@@ -4,6 +4,64 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
+## Delete
+
+Delete a function by name
+
+
+[https://m3o.com/function/api#Delete](https://m3o.com/function/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Delete a function by name
+func DeleteAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Delete(&function.DeleteRequest{
+		Name: "my-first-func",
+Project: "tests",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Describe
+
+Get the info for a deployed function
+
+
+[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Get the info for a deployed function
+func DescribeFunctionStatus() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Describe(&function.DescribeRequest{
+		Name: "my-first-func",
+Project: "tests",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Deploy
 
 Deploy a group of functions
@@ -93,61 +151,3 @@ func ListFunctions() {
 	
 }
 ```
-## Delete
-
-Delete a function by name
-
-
-[https://m3o.com/function/api#Delete](https://m3o.com/function/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Delete a function by name
-func DeleteAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Delete(&function.DeleteRequest{
-		Name: "my-first-func",
-Project: "tests",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Describe
-
-Get the info for a deployed function
-
-
-[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Get the info for a deployed function
-func DescribeFunctionStatus() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Describe(&function.DescribeRequest{
-		Name: "my-first-func",
-Project: "tests",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/image/README.md

@@ -4,6 +4,104 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Image/api](htt
 
 Endpoints:
 
+## Upload
+
+Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+To resize an image before uploading, see the Resize endpoint.
+To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
+with each parameter as a form field.
+
+
+[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+// To resize an image before uploading, see the Resize endpoint.
+// To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
+// with each parameter as a form field.
+func UploadAbase64imageToMicrosCdn() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Upload(&image.UploadRequest{
+		Base64: "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAx0lEQVR4nOzaMaoDMQyE4ZHj+x82vVdhwQoTkzKQEcwP5r0ihT7sbjUTeAJ4HCegXQJYfOYefOyjDuBiz3yjwJBoCIl6QZOeUjTC1Ix1IxEJXF9+0KWsf2bD4bn37OO/c/wuQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9Sa/NG94Tf3j4WBdaxudMEkn4IM2rZBA0wBrvo7aOcpj2emXvLeVt0IGm0GVXUj91mvAAAA//+V2CZl+4AKXwAAAABJRU5ErkJggg==",
+Name: "cat.jpeg",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Upload
+
+Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+To resize an image before uploading, see the Resize endpoint.
+To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
+with each parameter as a form field.
+
+
+[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+// To resize an image before uploading, see the Resize endpoint.
+// To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
+// with each parameter as a form field.
+func UploadAnImageFromAurlToMicrosCdn() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Upload(&image.UploadRequest{
+		Name: "cat.jpeg",
+Url: "somewebsite.com/cat.png",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete an image previously uploaded.
+
+
+[https://m3o.com/image/api#Delete](https://m3o.com/image/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Delete an image previously uploaded.
+func DeleteAnUploadedImage() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Delete(&image.DeleteRequest{
+		Url: "https://cdn.m3ocontent.com/micro/images/micro/41e23b39-48dd-42b6-9738-79a313414bb8/cat.png",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Resize
 
 Resize an image on the fly without storing it (by sending and receiving a base64 encoded image), or resize and upload depending on parameters.
@@ -158,101 +256,3 @@ Url: "somewebsite.com/cat.png",
 	
 }
 ```
-## Upload
-
-Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-To resize an image before uploading, see the Resize endpoint.
-To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
-with each parameter as a form field.
-
-
-[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-// To resize an image before uploading, see the Resize endpoint.
-// To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
-// with each parameter as a form field.
-func UploadAbase64imageToMicrosCdn() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Upload(&image.UploadRequest{
-		Base64: "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAx0lEQVR4nOzaMaoDMQyE4ZHj+x82vVdhwQoTkzKQEcwP5r0ihT7sbjUTeAJ4HCegXQJYfOYefOyjDuBiz3yjwJBoCIl6QZOeUjTC1Ix1IxEJXF9+0KWsf2bD4bn37OO/c/wuQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9Sa/NG94Tf3j4WBdaxudMEkn4IM2rZBA0wBrvo7aOcpj2emXvLeVt0IGm0GVXUj91mvAAAA//+V2CZl+4AKXwAAAABJRU5ErkJggg==",
-Name: "cat.jpeg",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Upload
-
-Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-To resize an image before uploading, see the Resize endpoint.
-To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
-with each parameter as a form field.
-
-
-[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-// To resize an image before uploading, see the Resize endpoint.
-// To use the file parameter you need to send the request as a multipart/form-data rather than the usual application/json
-// with each parameter as a form field.
-func UploadAnImageFromAurlToMicrosCdn() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Upload(&image.UploadRequest{
-		Name: "cat.jpeg",
-Url: "somewebsite.com/cat.png",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Delete
-
-Delete an image previously uploaded.
-
-
-[https://m3o.com/image/api#Delete](https://m3o.com/image/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Delete an image previously uploaded.
-func DeleteAnUploadedImage() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Delete(&image.DeleteRequest{
-		Url: "https://cdn.m3ocontent.com/micro/images/micro/41e23b39-48dd-42b6-9738-79a313414bb8/cat.png",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/mq/README.md

@@ -4,39 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Mq/api](https:
 
 Endpoints:
 
-## Publish
-
-Publish a message. Specify a topic to group messages for a specific topic.
-
-
-[https://m3o.com/mq/api#Publish](https://m3o.com/mq/api#Publish)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/mq"
-)
-
-// Publish a message. Specify a topic to group messages for a specific topic.
-func PublishAmessage() {
-	mqService := mq.NewMqService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := mqService.Publish(&mq.PublishRequest{
-		Message: map[string]interface{}{
-	"id": "1",
-	"type": "signup",
-	"user": "john",
-},
-Topic: "events",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Subscribe
 
 Subscribe to messages for a given topic.
@@ -78,3 +45,36 @@ func SubscribeToAtopic() {
 	}
 }
 ```
+## Publish
+
+Publish a message. Specify a topic to group messages for a specific topic.
+
+
+[https://m3o.com/mq/api#Publish](https://m3o.com/mq/api#Publish)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/mq"
+)
+
+// Publish a message. Specify a topic to group messages for a specific topic.
+func PublishAmessage() {
+	mqService := mq.NewMqService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := mqService.Publish(&mq.PublishRequest{
+		Message: map[string]interface{}{
+	"id": "1",
+	"type": "signup",
+	"user": "john",
+},
+Topic: "events",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/notes/README.md

@@ -4,6 +4,35 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Notes/api](htt
 
 Endpoints:
 
+## Create
+
+Create a new note
+
+
+[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Create a new note
+func CreateAnote() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Create(&notes.CreateRequest{
+		Text: "This is my note",
+Title: "New Note",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Read
 
 Read a note
@@ -160,32 +189,3 @@ func SubscribeToEvents() {
 	}
 }
 ```
-## Create
-
-Create a new note
-
-
-[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Create a new note
-func CreateAnote() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Create(&notes.CreateRequest{
-		Text: "This is my note",
-Title: "New Note",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/postcode/README.md

@@ -4,6 +4,34 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Postcode/api](
 
 Endpoints:
 
+## Lookup
+
+Lookup a postcode to retrieve the related region, county, etc
+
+
+[https://m3o.com/postcode/api#Lookup](https://m3o.com/postcode/api#Lookup)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/postcode"
+)
+
+// Lookup a postcode to retrieve the related region, county, etc
+func LookupPostcode() {
+	postcodeService := postcode.NewPostcodeService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := postcodeService.Lookup(&postcode.LookupRequest{
+		Postcode: "SW1A 2AA",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Random
 
 Return a random postcode and its related info
@@ -59,31 +87,3 @@ func ReturnArandomPostcodeAndItsInformation() {
 	
 }
 ```
-## Lookup
-
-Lookup a postcode to retrieve the related region, county, etc
-
-
-[https://m3o.com/postcode/api#Lookup](https://m3o.com/postcode/api#Lookup)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/postcode"
-)
-
-// Lookup a postcode to retrieve the related region, county, etc
-func LookupPostcode() {
-	postcodeService := postcode.NewPostcodeService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := postcodeService.Lookup(&postcode.LookupRequest{
-		Postcode: "SW1A 2AA",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/quran/README.md

@@ -4,34 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Quran/api](htt
 
 Endpoints:
 
-## Search
-
-Search the Quran for any form of query or questions
-
-
-[https://m3o.com/quran/api#Search](https://m3o.com/quran/api#Search)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/quran"
-)
-
-// Search the Quran for any form of query or questions
-func SearchTheQuran() {
-	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := quranService.Search(&quran.SearchRequest{
-		Query: "messenger",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Chapters
 
 List the Chapters (surahs) of the Quran
@@ -120,3 +92,31 @@ func GetVersesOfAchapter() {
 	
 }
 ```
+## Search
+
+Search the Quran for any form of query or questions
+
+
+[https://m3o.com/quran/api#Search](https://m3o.com/quran/api#Search)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/quran"
+)
+
+// Search the Quran for any form of query or questions
+func SearchTheQuran() {
+	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := quranService.Search(&quran.SearchRequest{
+		Query: "messenger",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/rss/README.md

@@ -4,6 +4,61 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Rss/api](https
 
 Endpoints:
 
+## List
+
+List the saved RSS fields
+
+
+[https://m3o.com/rss/api#List](https://m3o.com/rss/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/rss"
+)
+
+// List the saved RSS fields
+func ListRssFeeds() {
+	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := rssService.List(&rss.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Remove
+
+Remove an RSS feed by name
+
+
+[https://m3o.com/rss/api#Remove](https://m3o.com/rss/api#Remove)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/rss"
+)
+
+// Remove an RSS feed by name
+func RemoveAfeed() {
+	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := rssService.Remove(&rss.RemoveRequest{
+		Name: "bbc",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Add
 
 Add a new RSS feed with a name, url, and category
@@ -62,58 +117,3 @@ func ReadAfeed() {
 	
 }
 ```
-## List
-
-List the saved RSS fields
-
-
-[https://m3o.com/rss/api#List](https://m3o.com/rss/api#List)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/rss"
-)
-
-// List the saved RSS fields
-func ListRssFeeds() {
-	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := rssService.List(&rss.ListRequest{
-		
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Remove
-
-Remove an RSS feed by name
-
-
-[https://m3o.com/rss/api#Remove](https://m3o.com/rss/api#Remove)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/rss"
-)
-
-// Remove an RSS feed by name
-func RemoveAfeed() {
-	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := rssService.Remove(&rss.RemoveRequest{
-		Name: "bbc",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/sunnah/README.md

@@ -4,6 +4,65 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Sunnah/api](ht
 
 Endpoints:
 
+## Collections
+
+Get a list of available collections. A collection is
+a compilation of hadiths collected and written by an author.
+
+
+[https://m3o.com/sunnah/api#Collections](https://m3o.com/sunnah/api#Collections)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/sunnah"
+)
+
+// Get a list of available collections. A collection is
+// a compilation of hadiths collected and written by an author.
+func ListAvailableCollections() {
+	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := sunnahService.Collections(&sunnah.CollectionsRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Books
+
+Get a list of books from within a collection. A book can contain many chapters
+each with its own hadiths.
+
+
+[https://m3o.com/sunnah/api#Books](https://m3o.com/sunnah/api#Books)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/sunnah"
+)
+
+// Get a list of books from within a collection. A book can contain many chapters
+// each with its own hadiths.
+func GetTheBooksWithinAcollection() {
+	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := sunnahService.Books(&sunnah.BooksRequest{
+		Collection: "bukhari",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Chapters
 
 Get all the chapters of a given book within a collection.
@@ -64,62 +123,3 @@ Collection: "bukhari",
 	
 }
 ```
-## Collections
-
-Get a list of available collections. A collection is
-a compilation of hadiths collected and written by an author.
-
-
-[https://m3o.com/sunnah/api#Collections](https://m3o.com/sunnah/api#Collections)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/sunnah"
-)
-
-// Get a list of available collections. A collection is
-// a compilation of hadiths collected and written by an author.
-func ListAvailableCollections() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := sunnahService.Collections(&sunnah.CollectionsRequest{
-		
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Books
-
-Get a list of books from within a collection. A book can contain many chapters
-each with its own hadiths.
-
-
-[https://m3o.com/sunnah/api#Books](https://m3o.com/sunnah/api#Books)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/sunnah"
-)
-
-// Get a list of books from within a collection. A book can contain many chapters
-// each with its own hadiths.
-func GetTheBooksWithinAcollection() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := sunnahService.Books(&sunnah.BooksRequest{
-		Collection: "bukhari",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/twitter/README.md

@@ -4,6 +4,61 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Twitter/api](h
 
 Endpoints:
 
+## Trends
+
+Get the current global trending topics
+
+
+[https://m3o.com/twitter/api#Trends](https://m3o.com/twitter/api#Trends)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/twitter"
+)
+
+// Get the current global trending topics
+func GetTheCurrentGlobalTrendingTopics() {
+	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := twitterService.Trends(&twitter.TrendsRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## User
+
+Get a user's twitter profile
+
+
+[https://m3o.com/twitter/api#User](https://m3o.com/twitter/api#User)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/twitter"
+)
+
+// Get a user's twitter profile
+func GetAusersTwitterProfile() {
+	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := twitterService.User(&twitter.UserRequest{
+		Username: "crufter",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Timeline
 
 Get the timeline for a given user
@@ -61,58 +116,3 @@ func SearchForTweets() {
 	
 }
 ```
-## Trends
-
-Get the current global trending topics
-
-
-[https://m3o.com/twitter/api#Trends](https://m3o.com/twitter/api#Trends)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/twitter"
-)
-
-// Get the current global trending topics
-func GetTheCurrentGlobalTrendingTopics() {
-	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := twitterService.Trends(&twitter.TrendsRequest{
-		
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## User
-
-Get a user's twitter profile
-
-
-[https://m3o.com/twitter/api#User](https://m3o.com/twitter/api#User)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/twitter"
-)
-
-// Get a user's twitter profile
-func GetAusersTwitterProfile() {
-	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := twitterService.User(&twitter.UserRequest{
-		Username: "crufter",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/user/README.md

@@ -4,12 +4,12 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
-## Delete
+## Logout
 
-Delete an account by id
+Logout a user account
 
 
-[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
+[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
 
 ```go
 package example
@@ -21,38 +21,10 @@ import(
 	"go.m3o.com/user"
 )
 
-// Delete an account by id
+// Logout a user account
-func DeleteUserAccount() {
+func LogAuserOut() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Delete(&user.DeleteRequest{
+	rsp, err := userService.Logout(&user.LogoutRequest{
-		Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## ReadSession
-
-Read a session by the session id. In the event it has expired or is not found and error is returned.
-
-
-[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Read a session by the session id. In the event it has expired or is not found and error is returned.
-func ReadAsessionByTheSessionId() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
 		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
 
 	})
@@ -91,12 +63,12 @@ Username: "usrname-1",
 	
 }
 ```
-## Update
+## UpdatePassword
 
-Update the account username or email
+Update the account password
 
 
-[https://m3o.com/user/api#Update](https://m3o.com/user/api#Update)
+[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
 
 ```go
 package example
@@ -108,59 +80,13 @@ import(
 	"go.m3o.com/user"
 )
 
-// Update the account username or email
+// Update the account password
-func UpdateAnAccount() {
+func UpdateTheAccountPassword() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Update(&user.UpdateRequest{
+	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
-		Email: "joeotheremail@example.com",
+		ConfirmPassword: "myEvenMoreSecretPass123",
-Id: "usrid-1",
+NewPassword: "myEvenMoreSecretPass123",
-
+OldPassword: "mySecretPass123",
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## SendVerificationEmail
-
-Send a verification email
-to the user being signed up. Email from will be from 'support@m3o.com',
-but you can provide the title and contents.
-The verification link will be injected in to the email as a template variable, $micro_verification_link.
-Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
-The variable will be replaced with an actual url that will look similar to this:
-'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
-
-
-[https://m3o.com/user/api#SendVerificationEmail](https://m3o.com/user/api#SendVerificationEmail)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Send a verification email
-// to the user being signed up. Email from will be from 'support@m3o.com',
-// but you can provide the title and contents.
-// The verification link will be injected in to the email as a template variable, $micro_verification_link.
-// Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
-// The variable will be replaced with an actual url that will look similar to this:
-// 'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
-func SendVerificationEmail() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.SendVerificationEmail(&user.SendVerificationEmailRequest{
-		Email: "joe@example.com",
-FailureRedirectUrl: "https://m3o.com/verification-failed",
-FromName: "Awesome Dot Com",
-RedirectUrl: "https://m3o.com",
-Subject: "Email verification",
-TextContent: `Hi there,
-
-Please verify your email by clicking this link: $micro_verification_link`,
 
 	})
 	fmt.Println(rsp, err)
@@ -195,12 +121,12 @@ func VerifyEmail() {
 	
 }
 ```
-## UpdatePassword
+## Delete
 
-Update the account password
+Delete an account by id
 
 
-[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
+[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
 
 ```go
 package example
@@ -212,13 +138,99 @@ import(
 	"go.m3o.com/user"
 )
 
-// Update the account password
+// Delete an account by id
-func UpdateTheAccountPassword() {
+func DeleteUserAccount() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
+	rsp, err := userService.Delete(&user.DeleteRequest{
-		ConfirmPassword: "myEvenMoreSecretPass123",
+		Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
-NewPassword: "myEvenMoreSecretPass123",
+
-OldPassword: "mySecretPass123",
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Login
+
+Login using username or email. The response will return a new session for successful login,
+401 in the case of login failure and 500 for any other error
+
+
+[https://m3o.com/user/api#Login](https://m3o.com/user/api#Login)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Login using username or email. The response will return a new session for successful login,
+// 401 in the case of login failure and 500 for any other error
+func LogAuserIn() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Login(&user.LoginRequest{
+		Email: "joe@example.com",
+Password: "mySecretPass123",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## ReadSession
+
+Read a session by the session id. In the event it has expired or is not found and error is returned.
+
+
+[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Read a session by the session id. In the event it has expired or is not found and error is returned.
+func ReadAsessionByTheSessionId() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
+		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Update
+
+Update the account username or email
+
+
+[https://m3o.com/user/api#Update](https://m3o.com/user/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Update the account username or email
+func UpdateAnAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Update(&user.UpdateRequest{
+		Email: "joeotheremail@example.com",
+Id: "usrid-1",
 
 	})
 	fmt.Println(rsp, err)
@@ -309,13 +321,18 @@ func ReadAccountByEmail() {
 	
 }
 ```
-## Login
+## SendVerificationEmail
 
-Login using username or email. The response will return a new session for successful login,
+Send a verification email
-401 in the case of login failure and 500 for any other error
+to the user being signed up. Email from will be from 'support@m3o.com',
+but you can provide the title and contents.
+The verification link will be injected in to the email as a template variable, $micro_verification_link.
+Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+The variable will be replaced with an actual url that will look similar to this:
+'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
 
 
-[https://m3o.com/user/api#Login](https://m3o.com/user/api#Login)
+[https://m3o.com/user/api#SendVerificationEmail](https://m3o.com/user/api#SendVerificationEmail)
 
 ```go
 package example
@@ -327,41 +344,24 @@ import(
 	"go.m3o.com/user"
 )
 
-// Login using username or email. The response will return a new session for successful login,
+// Send a verification email
-// 401 in the case of login failure and 500 for any other error
+// to the user being signed up. Email from will be from 'support@m3o.com',
-func LogAuserIn() {
+// but you can provide the title and contents.
+// The verification link will be injected in to the email as a template variable, $micro_verification_link.
+// Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+// The variable will be replaced with an actual url that will look similar to this:
+// 'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+func SendVerificationEmail() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Login(&user.LoginRequest{
+	rsp, err := userService.SendVerificationEmail(&user.SendVerificationEmailRequest{
 		Email: "joe@example.com",
-Password: "mySecretPass123",
+FailureRedirectUrl: "https://m3o.com/verification-failed",
-
+FromName: "Awesome Dot Com",
-	})
+RedirectUrl: "https://m3o.com",
-	fmt.Println(rsp, err)
+Subject: "Email verification",
-	
+TextContent: `Hi there,
-}
+
-```
+Please verify your email by clicking this link: $micro_verification_link`,
-## Logout
-
-Logout a user account
-
-
-[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Logout a user account
-func LogAuserOut() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Logout(&user.LogoutRequest{
-		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
 
 	})
 	fmt.Println(rsp, err)