Commit from m3o/m3o action

examples/cache/README.md

@@ -4,6 +4,62 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Cache/api](htt
 
 Endpoints:
 
+## Increment
+
+Increment a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Increment a value (if it's a number). If key not found it is equivalent to set.
+func IncrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Increment(&cache.IncrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## 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.
@@ -86,59 +142,3 @@ func DeleteAvalue() {
 	fmt.Println(rsp, err)
 }
 ```
-## Increment
-
-Increment a value (if it's a number). If key not found it is equivalent to set.
-
-
-[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/cache"
-)
-
-// Increment a value (if it's a number). If key not found it is equivalent to set.
-func IncrementAvalue() {
-	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cacheService.Increment(&cache.IncrementRequest{
-		Key: "counter",
-Value: 2,
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## 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/crypto/README.md

@@ -4,60 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Crypto/api](ht
 
 Endpoints:
 
-## Quote
-
-Get the last quote for a given crypto ticker
-
-
-[https://m3o.com/crypto/api#Quote](https://m3o.com/crypto/api#Quote)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Get the last quote for a given crypto ticker
-func GetAcryptocurrencyQuote() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.Quote(&crypto.QuoteRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## History
-
-Returns the history for the previous close
-
-
-[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Returns the history for the previous close
-func GetPreviousClose() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.History(&crypto.HistoryRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## News
 
 Get news related to a currency
@@ -112,3 +58,57 @@ func GetCryptocurrencyPrice() {
 	fmt.Println(rsp, err)
 }
 ```
+## Quote
+
+Get the last quote for a given crypto ticker
+
+
+[https://m3o.com/crypto/api#Quote](https://m3o.com/crypto/api#Quote)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get the last quote for a given crypto ticker
+func GetAcryptocurrencyQuote() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Quote(&crypto.QuoteRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## History
+
+Returns the history for the previous close
+
+
+[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Returns the history for the previous close
+func GetPreviousClose() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.History(&crypto.HistoryRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/currency/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Currency/api](
 
 Endpoints:
 
+## Rates
+
+Rates returns the currency rates for a given code e.g USD
+
+
+[https://m3o.com/currency/api#Rates](https://m3o.com/currency/api#Rates)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Rates returns the currency rates for a given code e.g USD
+func GetRatesForUsd() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Rates(&currency.RatesRequest{
+		Code: "USD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Convert
 
 Convert returns the currency conversion rate between two pairs e.g USD/GBP
@@ -115,30 +142,3 @@ func GetSupportedCodes() {
 	fmt.Println(rsp, err)
 }
 ```
-## Rates
-
-Rates returns the currency rates for a given code e.g USD
-
-
-[https://m3o.com/currency/api#Rates](https://m3o.com/currency/api#Rates)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/currency"
-)
-
-// Rates returns the currency rates for a given code e.g USD
-func GetRatesForUsd() {
-	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := currencyService.Rates(&currency.RatesRequest{
-		Code: "USD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/db/README.md

@@ -4,60 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https:
 
 Endpoints:
 
-## 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)
-}
-```
-## 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
 
 Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
@@ -80,10 +26,10 @@ func CreateArecord() {
 	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",
+	"name": "Jane",
 },
 Table: "users",
 
@@ -178,3 +124,57 @@ 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)
+}
+```
+## 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)
+}
+```

examples/event/README.md

@@ -4,6 +4,33 @@ 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.
@@ -26,9 +53,9 @@ func PublishAnEvent() {
 	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",
 
@@ -63,30 +90,3 @@ func ConsumeFromAtopic() {
 	fmt.Println(rsp, err)
 }
 ```
-## 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/forex/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Forex/api](htt
 
 Endpoints:
 
+## Price
+
+Get the latest price for a given forex ticker
+
+
+[https://m3o.com/forex/api#Price](https://m3o.com/forex/api#Price)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Get the latest price for a given forex ticker
+func GetAnFxPrice() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.Price(&forex.PriceRequest{
+		Symbol: "GBPUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Quote
 
 Get the latest quote for the forex
@@ -58,30 +85,3 @@ func GetPreviousClose() {
 	fmt.Println(rsp, err)
 }
 ```
-## Price
-
-Get the latest price for a given forex ticker
-
-
-[https://m3o.com/forex/api#Price](https://m3o.com/forex/api#Price)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/forex"
-)
-
-// Get the latest price for a given forex ticker
-func GetAnFxPrice() {
-	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := forexService.Price(&forex.PriceRequest{
-		Symbol: "GBPUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/function/README.md

@@ -4,34 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
-## 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
@@ -146,3 +118,31 @@ 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/location/README.md

@@ -4,6 +4,41 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Location/api](
 
 Endpoints:
 
+## Save
+
+Save an entity's current position
+
+
+[https://m3o.com/location/api#Save](https://m3o.com/location/api#Save)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/location"
+)
+
+// Save an entity's current position
+func SaveAnEntity() {
+	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := locationService.Save(&location.SaveRequest{
+		Entity: &location.Entity{
+	Id: "1",
+	Location: &location.Point{
+		Latitude: 51.511061,
+		Longitude: -0.120022,
+		Timestamp: 1622802761,
+},
+	Type: "bike",
+},
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Read
 
 Read an entity by its ID
@@ -64,38 +99,3 @@ Type: "bike",
 	fmt.Println(rsp, err)
 }
 ```
-## Save
-
-Save an entity's current position
-
-
-[https://m3o.com/location/api#Save](https://m3o.com/location/api#Save)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/location"
-)
-
-// Save an entity's current position
-func SaveAnEntity() {
-	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := locationService.Save(&location.SaveRequest{
-		Entity: &location.Entity{
-	Id: "1",
-	Location: &location.Point{
-		Latitude: 51.511061,
-		Longitude: -0.120022,
-		Timestamp: 1622802761,
-},
-	Type: "bike",
-},
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/mq/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Mq/api](https:
 
 Endpoints:
 
+## Subscribe
+
+Subscribe to messages for a given topic.
+
+
+[https://m3o.com/mq/api#Subscribe](https://m3o.com/mq/api#Subscribe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/mq"
+)
+
+// Subscribe to messages for a given topic.
+func SubscribeToAtopic() {
+	mqService := mq.NewMqService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := mqService.Subscribe(&mq.SubscribeRequest{
+		Topic: "events",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Publish
 
 Publish a message. Specify a topic to group messages for a specific topic.
@@ -36,30 +63,3 @@ Topic: "events",
 	fmt.Println(rsp, err)
 }
 ```
-## Subscribe
-
-Subscribe to messages for a given topic.
-
-
-[https://m3o.com/mq/api#Subscribe](https://m3o.com/mq/api#Subscribe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/mq"
-)
-
-// Subscribe to messages for a given topic.
-func SubscribeToAtopic() {
-	mqService := mq.NewMqService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := mqService.Subscribe(&mq.SubscribeRequest{
-		Topic: "events",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/mq/publish/publishAMessage/main.go

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

examples/notes/README.md

@@ -4,6 +4,64 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Notes/api](htt
 
 Endpoints:
 
+## Update
+
+Update a note
+
+
+[https://m3o.com/notes/api#Update](https://m3o.com/notes/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Update a note
+func UpdateAnote() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Update(&notes.UpdateRequest{
+		Note: &notes.Note{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	Text: "Updated note text",
+	Title: "Update Note",
+	},
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## 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
@@ -112,61 +170,3 @@ func ListAllNotes() {
 	fmt.Println(rsp, err)
 }
 ```
-## Update
-
-Update a note
-
-
-[https://m3o.com/notes/api#Update](https://m3o.com/notes/api#Update)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Update a note
-func UpdateAnote() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Update(&notes.UpdateRequest{
-		Note: &notes.Note{
-		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
-	Text: "Updated note text",
-	Title: "Update Note",
-	},
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## 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)
-}
-```

examples/quran/README.md

@@ -4,37 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Quran/api](htt
 
 Endpoints:
 
-## Verses
-
-Lookup the verses (ayahs) for a chapter including
-translation, interpretation and breakdown by individual
-words.
-
-
-[https://m3o.com/quran/api#Verses](https://m3o.com/quran/api#Verses)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/quran"
-)
-
-// Lookup the verses (ayahs) for a chapter including
-// translation, interpretation and breakdown by individual
-// words.
-func GetVersesOfAchapter() {
-	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := quranService.Verses(&quran.VersesRequest{
-		Chapter: 1,
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Search
 
 Search the Quran for any form of query or questions
@@ -116,3 +85,34 @@ func GetChapterSummary() {
 	fmt.Println(rsp, err)
 }
 ```
+## Verses
+
+Lookup the verses (ayahs) for a chapter including
+translation, interpretation and breakdown by individual
+words.
+
+
+[https://m3o.com/quran/api#Verses](https://m3o.com/quran/api#Verses)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/quran"
+)
+
+// Lookup the verses (ayahs) for a chapter including
+// translation, interpretation and breakdown by individual
+// words.
+func GetVersesOfAchapter() {
+	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := quranService.Verses(&quran.VersesRequest{
+		Chapter: 1,
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/routing/README.md

@@ -4,40 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Routing/api](h
 
 Endpoints:
 
-## Route
-
-Retrieve a route as a simple list of gps points along with total distance and estimated duration
-
-
-[https://m3o.com/routing/api#Route](https://m3o.com/routing/api#Route)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/routing"
-)
-
-// Retrieve a route as a simple list of gps points along with total distance and estimated duration
-func GpsPointsForAroute() {
-	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := routingService.Route(&routing.RouteRequest{
-		Destination: &routing.Point{
-	Latitude: 52.529407,
-	Longitude: 13.397634,
-},
-Origin: &routing.Point{
-	Latitude: 52.517037,
-	Longitude: 13.38886,
-},
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Eta
 
 Get the eta for a route from origin to destination. The eta is an estimated time based on car routes
@@ -106,3 +72,37 @@ Origin: &routing.Point{
 	fmt.Println(rsp, err)
 }
 ```
+## Route
+
+Retrieve a route as a simple list of gps points along with total distance and estimated duration
+
+
+[https://m3o.com/routing/api#Route](https://m3o.com/routing/api#Route)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/routing"
+)
+
+// Retrieve a route as a simple list of gps points along with total distance and estimated duration
+func GpsPointsForAroute() {
+	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := routingService.Route(&routing.RouteRequest{
+		Destination: &routing.Point{
+	Latitude: 52.529407,
+	Longitude: 13.397634,
+},
+Origin: &routing.Point{
+	Latitude: 52.517037,
+	Longitude: 13.38886,
+},
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/rss/README.md

@@ -4,6 +4,35 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Rss/api](https
 
 Endpoints:
 
+## Add
+
+Add a new RSS feed with a name, url, and category
+
+
+[https://m3o.com/rss/api#Add](https://m3o.com/rss/api#Add)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/rss"
+)
+
+// Add a new RSS feed with a name, url, and category
+func AddAnewFeed() {
+	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := rssService.Add(&rss.AddRequest{
+		Category: "news",
+Name: "bbc",
+Url: "http://feeds.bbci.co.uk/news/rss.xml",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Feed
 
 Get an RSS feed by name. If no name is given, all feeds are returned. Default limit is 25 entries.
@@ -84,32 +113,3 @@ func RemoveAfeed() {
 	fmt.Println(rsp, err)
 }
 ```
-## Add
-
-Add a new RSS feed with a name, url, and category
-
-
-[https://m3o.com/rss/api#Add](https://m3o.com/rss/api#Add)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/rss"
-)
-
-// Add a new RSS feed with a name, url, and category
-func AddAnewFeed() {
-	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := rssService.Add(&rss.AddRequest{
-		Category: "news",
-Name: "bbc",
-Url: "http://feeds.bbci.co.uk/news/rss.xml",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/stock/README.md

@@ -4,6 +4,60 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Stock/api](htt
 
 Endpoints:
 
+## Price
+
+Get the last price for a given stock ticker
+
+
+[https://m3o.com/stock/api#Price](https://m3o.com/stock/api#Price)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/stock"
+)
+
+// Get the last price for a given stock ticker
+func GetAstockPrice() {
+	stockService := stock.NewStockService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := stockService.Price(&stock.PriceRequest{
+		Symbol: "AAPL",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Quote
+
+Get the last quote for the stock
+
+
+[https://m3o.com/stock/api#Quote](https://m3o.com/stock/api#Quote)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/stock"
+)
+
+// Get the last quote for the stock
+func GetAstockQuote() {
+	stockService := stock.NewStockService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := stockService.Quote(&stock.QuoteRequest{
+		Symbol: "AAPL",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## History
 
 Get the historic open-close for a given day
@@ -63,57 +117,3 @@ Stock: "AAPL",
 	fmt.Println(rsp, err)
 }
 ```
-## Price
-
-Get the last price for a given stock ticker
-
-
-[https://m3o.com/stock/api#Price](https://m3o.com/stock/api#Price)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/stock"
-)
-
-// Get the last price for a given stock ticker
-func GetAstockPrice() {
-	stockService := stock.NewStockService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := stockService.Price(&stock.PriceRequest{
-		Symbol: "AAPL",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Quote
-
-Get the last quote for the stock
-
-
-[https://m3o.com/stock/api#Quote](https://m3o.com/stock/api#Quote)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/stock"
-)
-
-// Get the last quote for the stock
-func GetAstockQuote() {
-	stockService := stock.NewStockService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := stockService.Quote(&stock.QuoteRequest{
-		Symbol: "AAPL",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/stream/README.md

@@ -4,6 +4,36 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Stream/api](ht
 
 Endpoints:
 
+## CreateChannel
+
+Create a channel with a given name and description. Channels are created automatically but
+this allows you to specify a description that's persisted for the lifetime of the channel.
+
+
+[https://m3o.com/stream/api#CreateChannel](https://m3o.com/stream/api#CreateChannel)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/stream"
+)
+
+// Create a channel with a given name and description. Channels are created automatically but
+// this allows you to specify a description that's persisted for the lifetime of the channel.
+func CreateChannel() {
+	streamService := stream.NewStreamService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := streamService.CreateChannel(&stream.CreateChannelRequest{
+		Description: "The channel for all things",
+Name: "general",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## SendMessage
 
 Send a message to the stream.
@@ -85,33 +115,3 @@ func ListChannels() {
 	fmt.Println(rsp, err)
 }
 ```
-## CreateChannel
-
-Create a channel with a given name and description. Channels are created automatically but
-this allows you to specify a description that's persisted for the lifetime of the channel.
-
-
-[https://m3o.com/stream/api#CreateChannel](https://m3o.com/stream/api#CreateChannel)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/stream"
-)
-
-// Create a channel with a given name and description. Channels are created automatically but
-// this allows you to specify a description that's persisted for the lifetime of the channel.
-func CreateChannel() {
-	streamService := stream.NewStreamService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := streamService.CreateChannel(&stream.CreateChannelRequest{
-		Description: "The channel for all things",
-Name: "general",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/url/README.md

@@ -4,6 +4,32 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Url/api](https
 
 Endpoints:
 
+## Shorten
+
+Shortens a destination URL and returns a full short URL.
+
+
+[https://m3o.com/url/api#Shorten](https://m3o.com/url/api#Shorten)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/url"
+)
+
+// Shortens a destination URL and returns a full short URL.
+func ShortenAlongUrl() {
+	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := urlService.Shorten(&url.ShortenRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Proxy
 
 Proxy returns the destination URL of a short URL.
@@ -56,29 +82,3 @@ func ListYourShortenedUrls() {
 	fmt.Println(rsp, err)
 }
 ```
-## Shorten
-
-Shortens a destination URL and returns a full short URL.
-
-
-[https://m3o.com/url/api#Shorten](https://m3o.com/url/api#Shorten)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/url"
-)
-
-// Shortens a destination URL and returns a full short URL.
-func ShortenAlongUrl() {
-	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := urlService.Shorten(&url.ShortenRequest{
-		
-	})
-	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:
 
-## Create
+## Update
 
-Create a new user account. The email address and username for the account must be unique.
+Update the account username or email
 
 
-[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
+[https://m3o.com/user/api#Update](https://m3o.com/user/api#Update)
 
 ```go
 package example
@@ -21,14 +21,12 @@ import(
 	"go.m3o.com/user"
 )
 
-// Create a new user account. The email address and username for the account must be unique.
+// Update the account username or email
-func CreateAnAccount() {
+func UpdateAnAccount() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Create(&user.CreateRequest{
+	rsp, err := userService.Update(&user.UpdateRequest{
-		Email: "joe@example.com",
+		Email: "joeotheremail@example.com",
 Id: "usrid-1",
-Password: "mySecretPass123",
-Username: "usrname-1",
 
 	})
 	fmt.Println(rsp, err)
@@ -63,61 +61,6 @@ OldPassword: "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)
-}
-```
 ## Read
 
 Read an account by id, username or email. Only one need to be specified.
@@ -199,79 +142,6 @@ func ReadAccountByEmail() {
 	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)
-}
-```
-## 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)
-}
-```
 ## Delete
 
 Delete an account by id
@@ -356,3 +226,133 @@ func ReadAsessionByTheSessionId() {
 	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)
+}
+```
+## 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)
+}
+```
+## 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)
+}
+```
+## 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)
+}
+```