Commit from m3o/m3o action

examples/db/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https:
 
 Endpoints:
 
+## ListTables
+
+List tables in the DB
+
+
+[https://m3o.com/db/api#ListTables](https://m3o.com/db/api#ListTables)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// List tables in the DB
+func ListTables() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.ListTables(&db.ListTablesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## RenameTable
 
 Rename a table
@@ -31,6 +58,148 @@ To: "events_backup",
 	})
 	fmt.Println(rsp, err)
 	
+}
+```
+## Delete
+
+Delete a record in the database by id.
+
+
+[https://m3o.com/db/api#Delete](https://m3o.com/db/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Delete a record in the database by id.
+func DeleteArecord() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Delete(&db.DeleteRequest{
+		Id: "1",
+Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Truncate
+
+Truncate the records in a table
+
+
+[https://m3o.com/db/api#Truncate](https://m3o.com/db/api#Truncate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Truncate the records in a table
+func TruncateTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Truncate(&db.TruncateRequest{
+		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)
+	
+}
+```
+## DropTable
+
+Drop a table in the DB
+
+
+[https://m3o.com/db/api#DropTable](https://m3o.com/db/api#DropTable)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Drop a table in the DB
+func DropTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.DropTable(&db.DropTableRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Count
+
+Count records in a table
+
+
+[https://m3o.com/db/api#Count](https://m3o.com/db/api#Count)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Count records in a table
+func CountEntriesInAtable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Count(&db.CountRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```
 ## Create
@@ -99,172 +268,3 @@ Table: "users",
 	
 }
 ```
-## Delete
-
-Delete a record in the database by id.
-
-
-[https://m3o.com/db/api#Delete](https://m3o.com/db/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Delete a record in the database by id.
-func DeleteArecord() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Delete(&db.DeleteRequest{
-		Id: "1",
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Truncate
-
-Truncate the records in a table
-
-
-[https://m3o.com/db/api#Truncate](https://m3o.com/db/api#Truncate)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Truncate the records in a table
-func TruncateTable() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Truncate(&db.TruncateRequest{
-		Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## DropTable
-
-Drop a table in the DB
-
-
-[https://m3o.com/db/api#DropTable](https://m3o.com/db/api#DropTable)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Drop a table in the DB
-func DropTable() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.DropTable(&db.DropTableRequest{
-		Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Count
-
-Count records in a table
-
-
-[https://m3o.com/db/api#Count](https://m3o.com/db/api#Count)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Count records in a table
-func CountEntriesInAtable() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Count(&db.CountRequest{
-		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)
-	
-}
-```
-## ListTables
-
-List tables in the DB
-
-
-[https://m3o.com/db/api#ListTables](https://m3o.com/db/api#ListTables)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// List tables in the DB
-func ListTables() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.ListTables(&db.ListTablesRequest{
-		
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/event/README.md

@@ -4,34 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Event/api](htt
 
 Endpoints:
 
-## Read
-
-Read stored events
-
-
-[https://m3o.com/event/api#Read](https://m3o.com/event/api#Read)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/event"
-)
-
-// Read stored events
-func ReadEventsOnAtopic() {
-	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Read(&event.ReadRequest{
-		Topic: "user",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Publish
 
 Publish a event to the event stream.
@@ -106,3 +78,31 @@ func ConsumeFromAtopic() {
 	}
 }
 ```
+## Read
+
+Read stored events
+
+
+[https://m3o.com/event/api#Read](https://m3o.com/event/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Read stored events
+func ReadEventsOnAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Read(&event.ReadRequest{
+		Topic: "user",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

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/file/README.md

@@ -4,6 +4,64 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/File/api](http
 
 Endpoints:
 
+## Delete
+
+Delete a file by project name/path
+
+
+[https://m3o.com/file/api#Delete](https://m3o.com/file/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Delete a file by project name/path
+func DeleteFile() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.Delete(&file.DeleteRequest{
+		Path: "/document/text-files/file.txt",
+Project: "examples",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Read
+
+Read a file by path
+
+
+[https://m3o.com/file/api#Read](https://m3o.com/file/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Read a file by path
+func ReadFile() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.Read(&file.ReadRequest{
+		Path: "/document/text-files/file.txt",
+Project: "examples",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Save
 
 Save a file
@@ -64,61 +122,3 @@ func ListFiles() {
 	
 }
 ```
-## Delete
-
-Delete a file by project name/path
-
-
-[https://m3o.com/file/api#Delete](https://m3o.com/file/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/file"
-)
-
-// Delete a file by project name/path
-func DeleteFile() {
-	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := fileService.Delete(&file.DeleteRequest{
-		Path: "/document/text-files/file.txt",
-Project: "examples",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Read
-
-Read a file by path
-
-
-[https://m3o.com/file/api#Read](https://m3o.com/file/api#Read)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/file"
-)
-
-// Read a file by path
-func ReadFile() {
-	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := fileService.Read(&file.ReadRequest{
-		Path: "/document/text-files/file.txt",
-Project: "examples",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/forex/README.md

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

examples/function/README.md

@@ -4,6 +4,68 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
+## Deploy
+
+Deploy a group of functions
+
+
+[https://m3o.com/function/api#Deploy](https://m3o.com/function/api#Deploy)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Deploy a group of functions
+func DeployAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Deploy(&function.DeployRequest{
+		Entrypoint: "helloworld",
+Name: "my-first-func",
+Project: "tests",
+Repo: "github.com/m3o/nodejs-function-example",
+Runtime: "nodejs14",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Call
+
+Call a function by name
+
+
+[https://m3o.com/function/api#Call](https://m3o.com/function/api#Call)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Call a function by name
+func CallAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Call(&function.CallRequest{
+		Name: "my-first-func",
+Request: map[string]interface{}{
+},
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## List
 
 List all the deployed functions
@@ -89,65 +151,3 @@ Project: "tests",
 	
 }
 ```
-## Deploy
-
-Deploy a group of functions
-
-
-[https://m3o.com/function/api#Deploy](https://m3o.com/function/api#Deploy)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Deploy a group of functions
-func DeployAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Deploy(&function.DeployRequest{
-		Entrypoint: "helloworld",
-Name: "my-first-func",
-Project: "tests",
-Repo: "github.com/m3o/nodejs-function-example",
-Runtime: "nodejs14",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Call
-
-Call a function by name
-
-
-[https://m3o.com/function/api#Call](https://m3o.com/function/api#Call)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Call a function by name
-func CallAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Call(&function.CallRequest{
-		Name: "my-first-func",
-Request: map[string]interface{}{
-},
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/geocoding/README.md

@@ -4,6 +4,35 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Geocoding/api]
 
 Endpoints:
 
+## Reverse
+
+Reverse lookup an address from gps coordinates
+
+
+[https://m3o.com/geocoding/api#Reverse](https://m3o.com/geocoding/api#Reverse)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/geocoding"
+)
+
+// Reverse lookup an address from gps coordinates
+func ReverseGeocodeLocation() {
+	geocodingService := geocoding.NewGeocodingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := geocodingService.Reverse(&geocoding.ReverseRequest{
+		Latitude: 51.5123064,
+Longitude: -0.1216235,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Lookup
 
 Lookup returns a geocoded address including normalized address and gps coordinates. All fields are optional, provide more to get more accurate results
@@ -35,32 +64,3 @@ Postcode: "wc2b",
 	
 }
 ```
-## Reverse
-
-Reverse lookup an address from gps coordinates
-
-
-[https://m3o.com/geocoding/api#Reverse](https://m3o.com/geocoding/api#Reverse)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/geocoding"
-)
-
-// Reverse lookup an address from gps coordinates
-func ReverseGeocodeLocation() {
-	geocodingService := geocoding.NewGeocodingService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := geocodingService.Reverse(&geocoding.ReverseRequest{
-		Latitude: 51.5123064,
-Longitude: -0.1216235,
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/location/README.md

@@ -4,40 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Location/api](
 
 Endpoints:
 
-## Search
-
-Search for entities in a given radius
-
-
-[https://m3o.com/location/api#Search](https://m3o.com/location/api#Search)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/location"
-)
-
-// Search for entities in a given radius
-func SearchForLocations() {
-	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := locationService.Search(&location.SearchRequest{
-		Center: &location.Point{
-	Latitude: 51.511061,
-	Longitude: -0.120022,
-	},
-NumEntities: 10,
-Radius: 100,
-Type: "bike",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Save
 
 Save an entity's current position
@@ -102,3 +68,37 @@ func GetLocationById() {
 	
 }
 ```
+## Search
+
+Search for entities in a given radius
+
+
+[https://m3o.com/location/api#Search](https://m3o.com/location/api#Search)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/location"
+)
+
+// Search for entities in a given radius
+func SearchForLocations() {
+	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := locationService.Search(&location.SearchRequest{
+		Center: &location.Point{
+	Latitude: 51.511061,
+	Longitude: -0.120022,
+	},
+NumEntities: 10,
+Radius: 100,
+Type: "bike",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/notes/README.md

@@ -4,6 +4,75 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Notes/api](htt
 
 Endpoints:
 
+## Delete
+
+Delete a note
+
+
+[https://m3o.com/notes/api#Delete](https://m3o.com/notes/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Delete a note
+func DeleteAnote() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Delete(&notes.DeleteRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Events
+
+Subscribe to notes events
+
+
+[https://m3o.com/notes/api#Events](https://m3o.com/notes/api#Events)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Subscribe to notes events
+func SubscribeToEvents() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	
+	stream, err := notesService.Events(&notes.EventsRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
+}
+```
 ## Create
 
 Create a new note
@@ -120,72 +189,3 @@ func UpdateAnote() {
 	
 }
 ```
-## Delete
-
-Delete a note
-
-
-[https://m3o.com/notes/api#Delete](https://m3o.com/notes/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Delete a note
-func DeleteAnote() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Delete(&notes.DeleteRequest{
-		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Events
-
-Subscribe to notes events
-
-
-[https://m3o.com/notes/api#Events](https://m3o.com/notes/api#Events)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Subscribe to notes events
-func SubscribeToEvents() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	
-	stream, err := notesService.Events(&notes.EventsRequest{
-		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
-
-	})
-	if err != nil {
-		fmt.Println(err)
-		return
-	}
-
-	for {
-			rsp, err := stream.Recv()
-			if err != nil {
-					fmt.Println(err)
-					return
-			}
-
-			fmt.Println(rsp)
-	}
-}
-```

examples/postcode/README.md

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

examples/quran/README.md

@@ -4,6 +4,34 @@ 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
@@ -92,31 +120,3 @@ 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/sunnah/README.md

@@ -4,6 +4,37 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Sunnah/api](ht
 
 Endpoints:
 
+## Hadiths
+
+Hadiths returns a list of hadiths and their corresponding text for a
+given book within a collection.
+
+
+[https://m3o.com/sunnah/api#Hadiths](https://m3o.com/sunnah/api#Hadiths)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/sunnah"
+)
+
+// Hadiths returns a list of hadiths and their corresponding text for a
+// given book within a collection.
+func ListTheHadithsInAbook() {
+	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := sunnahService.Hadiths(&sunnah.HadithsRequest{
+		Book: 1,
+Collection: "bukhari",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Collections
 
 Get a list of available collections. A collection is
@@ -92,34 +123,3 @@ Collection: "bukhari",
 	
 }
 ```
-## Hadiths
-
-Hadiths returns a list of hadiths and their corresponding text for a
-given book within a collection.
-
-
-[https://m3o.com/sunnah/api#Hadiths](https://m3o.com/sunnah/api#Hadiths)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/sunnah"
-)
-
-// Hadiths returns a list of hadiths and their corresponding text for a
-// given book within a collection.
-func ListTheHadithsInAbook() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := sunnahService.Hadiths(&sunnah.HadithsRequest{
-		Book: 1,
-Collection: "bukhari",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/user/README.md

@@ -4,6 +4,65 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
+## Delete
+
+Delete an account by id
+
+
+[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Delete an account by id
+func DeleteUserAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Delete(&user.DeleteRequest{
+		Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
+
+	})
+	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.
@@ -32,12 +91,13 @@ func ReadAsessionByTheSessionId() {
 	
 }
 ```
-## Create
+## SendPasswordResetEmail
 
-Create a new user account. The email address and username for the account must be unique.
+Send an email with a verification code to reset password.
+Call "ResetPassword" endpoint once user provides the code.
 
 
-[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
+[https://m3o.com/user/api#SendPasswordResetEmail](https://m3o.com/user/api#SendPasswordResetEmail)
 
 ```go
 package example
@@ -49,14 +109,74 @@ import(
 	"go.m3o.com/user"
 )
 
-// Create a new user account. The email address and username for the account must be unique.
+// Send an email with a verification code to reset password.
-func CreateAnAccount() {
+// Call "ResetPassword" endpoint once user provides the code.
+func SendPasswordResetEmail() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Create(&user.CreateRequest{
+	rsp, err := userService.SendPasswordResetEmail(&user.SendPasswordResetEmailRequest{
 		Email: "joe@example.com",
-Id: "usrid-1",
+FromName: "Awesome Dot Com",
-Password: "mySecretPass123",
+Subject: "Password reset",
-Username: "usrname-1",
+TextContent: `Hi there,
+ click here to reset your password: myapp.com/reset/code?=$code`,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## VerifyEmail
+
+Verify the email address of an account from a token sent in an email to the user.
+
+
+[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Verify the email address of an account from a token sent in an email to the user.
+func VerifyEmail() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+		Token: "t2323t232t",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## UpdatePassword
+
+Update the account password
+
+
+[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Update the account password
+func UpdateTheAccountPassword() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
+		ConfirmPassword: "myEvenMoreSecretPass123",
+NewPassword: "myEvenMoreSecretPass123",
+OldPassword: "mySecretPass123",
 
 	})
 	fmt.Println(rsp, err)
@@ -145,188 +265,6 @@ func ReadAccountByEmail() {
 	})
 	fmt.Println(rsp, err)
 	
-}
-```
-## SendPasswordResetEmail
-
-Send an email with a verification code to reset password.
-Call "ResetPassword" endpoint once user provides the code.
-
-
-[https://m3o.com/user/api#SendPasswordResetEmail](https://m3o.com/user/api#SendPasswordResetEmail)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Send an email with a verification code to reset password.
-// Call "ResetPassword" endpoint once user provides the code.
-func SendPasswordResetEmail() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.SendPasswordResetEmail(&user.SendPasswordResetEmailRequest{
-		Email: "joe@example.com",
-FromName: "Awesome Dot Com",
-Subject: "Password reset",
-TextContent: `Hi there,
- click here to reset your password: myapp.com/reset/code?=$code`,
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## ResetPassword
-
-Reset password with the code sent by the "SendPasswordResetEmail" endoint.
-
-
-[https://m3o.com/user/api#ResetPassword](https://m3o.com/user/api#ResetPassword)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Reset password with the code sent by the "SendPasswordResetEmail" endoint.
-func ResetPassword() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ResetPassword(&user.ResetPasswordRequest{
-		Code: "some-code-from-email",
-ConfirmPassword: "newpass123",
-NewPassword: "newpass123",
-
-	})
-	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)
-	
-}
-```
-## 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)
-	
-}
-```
-## 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)
-	
-}
-```
-## UpdatePassword
-
-Update the account password
-
-
-[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Update the account password
-func UpdateTheAccountPassword() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
-		ConfirmPassword: "myEvenMoreSecretPass123",
-NewPassword: "myEvenMoreSecretPass123",
-OldPassword: "mySecretPass123",
-
-	})
-	fmt.Println(rsp, err)
-	
 }
 ```
 ## SendVerificationEmail
@@ -376,12 +314,12 @@ Please verify your email by clicking this link: $micro_verification_link`,
 	
 }
 ```
-## VerifyEmail
+## ResetPassword
 
-Verify the email address of an account from a token sent in an email to the user.
+Reset password with the code sent by the "SendPasswordResetEmail" endoint.
 
 
-[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
+[https://m3o.com/user/api#ResetPassword](https://m3o.com/user/api#ResetPassword)
 
 ```go
 package example
@@ -393,23 +331,25 @@ import(
 	"go.m3o.com/user"
 )
 
-// Verify the email address of an account from a token sent in an email to the user.
+// Reset password with the code sent by the "SendPasswordResetEmail" endoint.
-func VerifyEmail() {
+func ResetPassword() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+	rsp, err := userService.ResetPassword(&user.ResetPasswordRequest{
-		Token: "t2323t232t",
+		Code: "some-code-from-email",
+ConfirmPassword: "newpass123",
+NewPassword: "newpass123",
 
 	})
 	fmt.Println(rsp, err)
 	
 }
 ```
-## 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
@@ -421,11 +361,71 @@ 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",
+		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Create
+
+Create a new user account. The email address and username for the account must be unique.
+
+
+[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Create a new user account. The email address and username for the account must be unique.
+func CreateAnAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Create(&user.CreateRequest{
+		Email: "joe@example.com",
+Id: "usrid-1",
+Password: "mySecretPass123",
+Username: "usrname-1",
+
+	})
+	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)