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)
+
+
+[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)
+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)
+
+
+[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)
+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)
-
-
-[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)
-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)
-
-
-[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)
-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/currency/README.md

@@ -4,34 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Currency/api](
 
 Endpoints:
 
-## History
-
-Returns the historic rates for a currency on a given date
-
-
-[https://m3o.com/currency/api#History](https://m3o.com/currency/api#History)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/currency"
-)
-
-// Returns the historic rates for a currency on a given date
-func HistoricRatesForAcurrency() {
-	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := currencyService.History(&currency.HistoryRequest{
-		Code: "USD",
-Date: "2021-05-30",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Codes
 
 Codes returns the supported currency codes for the API
@@ -142,3 +114,31 @@ To: "GBP",
 	fmt.Println(rsp, err)
 }
 ```
+## History
+
+Returns the historic rates for a currency on a given date
+
+
+[https://m3o.com/currency/api#History](https://m3o.com/currency/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Returns the historic rates for a currency on a given date
+func HistoricRatesForAcurrency() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.History(&currency.HistoryRequest{
+		Code: "USD",
+Date: "2021-05-30",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/db/README.md

@@ -4,33 +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
@@ -80,10 +53,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 +151,30 @@ 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)
+}
+```

examples/db/create/createARecord.go

@@ -12,10 +12,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",
 		},
 		Table: "users",
 	})

examples/emoji/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Emoji/api](htt
 
 Endpoints:
 
+## Find
+
+Find an emoji by its alias e.g :beer:
+
+
+[https://m3o.com/emoji/api#Find](https://m3o.com/emoji/api#Find)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Find an emoji by its alias e.g :beer:
+func FindEmoji() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Find(&emoji.FindRequest{
+		Alias: ":beer:",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Flag
 
 Get the flag for a country. Requires country code e.g GB for great britain
@@ -88,30 +115,3 @@ To: "+44782669123",
 	fmt.Println(rsp, err)
 }
 ```
-## Find
-
-Find an emoji by its alias e.g :beer:
-
-
-[https://m3o.com/emoji/api#Find](https://m3o.com/emoji/api#Find)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/emoji"
-)
-
-// Find an emoji by its alias e.g :beer:
-func FindEmoji() {
-	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := emojiService.Find(&emoji.FindRequest{
-		Alias: ":beer:",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/file/README.md

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

@@ -4,6 +4,32 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Id/api](https:
 
 Endpoints:
 
+## Types
+
+List the types of IDs available. No query params needed.
+
+
+[https://m3o.com/id/api#Types](https://m3o.com/id/api#Types)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/id"
+)
+
+// List the types of IDs available. No query params needed.
+func ListTheTypesOfIdsAvailable() {
+	idService := id.NewIdService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := idService.Types(&id.TypesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Generate
 
 Generate a unique ID. Defaults to uuid.
@@ -112,29 +138,3 @@ func GenerateAbigflakeId() {
 	fmt.Println(rsp, err)
 }
 ```
-## Types
-
-List the types of IDs available. No query params needed.
-
-
-[https://m3o.com/id/api#Types](https://m3o.com/id/api#Types)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/id"
-)
-
-// List the types of IDs available. No query params needed.
-func ListTheTypesOfIdsAvailable() {
-	idService := id.NewIdService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := idService.Types(&id.TypesRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/notes/README.md

@@ -4,63 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Notes/api](htt
 
 Endpoints:
 
-## List
-
-List all the notes
-
-
-[https://m3o.com/notes/api#List](https://m3o.com/notes/api#List)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// List all the notes
-func ListAllNotes() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.List(&notes.ListRequest{
-		
-	})
-	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
@@ -170,3 +113,60 @@ func ReadAnote() {
 	fmt.Println(rsp, err)
 }
 ```
+## List
+
+List all the notes
+
+
+[https://m3o.com/notes/api#List](https://m3o.com/notes/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// List all the notes
+func ListAllNotes() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.List(&notes.ListRequest{
+		
+	})
+	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)
+}
+```

examples/quran/README.md

@@ -4,60 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Quran/api](htt
 
 Endpoints:
 
-## Chapters
-
-List the Chapters (surahs) of the Quran
-
-
-[https://m3o.com/quran/api#Chapters](https://m3o.com/quran/api#Chapters)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/quran"
-)
-
-// List the Chapters (surahs) of the Quran
-func ListChapters() {
-	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := quranService.Chapters(&quran.ChaptersRequest{
-		Language: "en",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Summary
-
-Get a summary for a given chapter (surah)
-
-
-[https://m3o.com/quran/api#Summary](https://m3o.com/quran/api#Summary)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/quran"
-)
-
-// Get a summary for a given chapter (surah)
-func GetChapterSummary() {
-	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := quranService.Summary(&quran.SummaryRequest{
-		Chapter: 1,
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Verses
 
 Lookup the verses (ayahs) for a chapter including
@@ -116,3 +62,57 @@ func SearchTheQuran() {
 	fmt.Println(rsp, err)
 }
 ```
+## Chapters
+
+List the Chapters (surahs) of the Quran
+
+
+[https://m3o.com/quran/api#Chapters](https://m3o.com/quran/api#Chapters)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/quran"
+)
+
+// List the Chapters (surahs) of the Quran
+func ListChapters() {
+	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := quranService.Chapters(&quran.ChaptersRequest{
+		Language: "en",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Summary
+
+Get a summary for a given chapter (surah)
+
+
+[https://m3o.com/quran/api#Summary](https://m3o.com/quran/api#Summary)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/quran"
+)
+
+// Get a summary for a given chapter (surah)
+func GetChapterSummary() {
+	quranService := quran.NewQuranService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := quranService.Summary(&quran.SummaryRequest{
+		Chapter: 1,
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/routing/README.md

@@ -4,6 +4,40 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Routing/api](h
 
 Endpoints:
 
+## Eta
+
+Get the eta for a route from origin to destination. The eta is an estimated time based on car routes
+
+
+[https://m3o.com/routing/api#Eta](https://m3o.com/routing/api#Eta)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/routing"
+)
+
+// Get the eta for a route from origin to destination. The eta is an estimated time based on car routes
+func EtaFromPointAtoPointB() {
+	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := routingService.Eta(&routing.EtaRequest{
+		Destination: &routing.Point{
+	Latitude: 52.529407,
+	Longitude: 13.397634,
+},
+Origin: &routing.Point{
+	Latitude: 52.517037,
+	Longitude: 13.38886,
+},
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Directions
 
 Turn by turn directions from a start point to an end point including maneuvers and bearings
@@ -72,37 +106,3 @@ Origin: &routing.Point{
 	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
-
-
-[https://m3o.com/routing/api#Eta](https://m3o.com/routing/api#Eta)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/routing"
-)
-
-// Get the eta for a route from origin to destination. The eta is an estimated time based on car routes
-func EtaFromPointAtoPointB() {
-	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := routingService.Eta(&routing.EtaRequest{
-		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,59 @@ 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
@@ -60,56 +113,3 @@ func ReadAfeed() {
 	fmt.Println(rsp, err)
 }
 ```
-## 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/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,33 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Stream/api](ht
 
 Endpoints:
 
-## Subscribe
-
-Subscribe to messages for a given topic.
-
-
-[https://m3o.com/stream/api#Subscribe](https://m3o.com/stream/api#Subscribe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/stream"
-)
-
-// Subscribe to messages for a given topic.
-func SubscribeToAtopic() {
-	streamService := stream.NewStreamService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := streamService.Subscribe(&stream.SubscribeRequest{
-		Topic: "events",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Publish
 
 Publish a message to the stream. Specify a topic to group messages for a specific topic.
@@ -63,3 +36,30 @@ Topic: "events",
 	fmt.Println(rsp, err)
 }
 ```
+## Subscribe
+
+Subscribe to messages for a given topic.
+
+
+[https://m3o.com/stream/api#Subscribe](https://m3o.com/stream/api#Subscribe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/stream"
+)
+
+// Subscribe to messages for a given topic.
+func SubscribeToAtopic() {
+	streamService := stream.NewStreamService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := streamService.Subscribe(&stream.SubscribeRequest{
+		Topic: "events",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/sunnah/README.md

@@ -4,6 +4,36 @@ 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
@@ -89,33 +119,3 @@ Collection: "bukhari",
 	fmt.Println(rsp, err)
 }
 ```
-## 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/time/README.md

@@ -4,32 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Time/api](http
 
 Endpoints:
 
-## Now
-
-Get the current time
-
-
-[https://m3o.com/time/api#Now](https://m3o.com/time/api#Now)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/time"
-)
-
-// Get the current time
-func ReturnsCurrentTimeOptionallyWithLocation() {
-	timeService := time.NewTimeService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := timeService.Now(&time.NowRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Zone
 
 Get the timezone info for a specific location
@@ -57,3 +31,29 @@ func GetTheTimezoneInfoForAspecificLocation() {
 	fmt.Println(rsp, err)
 }
 ```
+## Now
+
+Get the current time
+
+
+[https://m3o.com/time/api#Now](https://m3o.com/time/api#Now)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/time"
+)
+
+// Get the current time
+func ReturnsCurrentTimeOptionallyWithLocation() {
+	timeService := time.NewTimeService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := timeService.Now(&time.NowRequest{
+		
+	})
+	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:
 
+## List
+
+List information on all the shortened URLs that you have created
+
+
+[https://m3o.com/url/api#List](https://m3o.com/url/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/url"
+)
+
+// List information on all the shortened URLs that you have created
+func ListYourShortenedUrls() {
+	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := urlService.List(&url.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Shorten
 
 Shortens a destination URL and returns a full short URL.
@@ -56,29 +82,3 @@ func ResolveAshortUrlToAlongDestinationUrl() {
 	fmt.Println(rsp, err)
 }
 ```
-## List
-
-List information on all the shortened URLs that you have created
-
-
-[https://m3o.com/url/api#List](https://m3o.com/url/api#List)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/url"
-)
-
-// List information on all the shortened URLs that you have created
-func ListYourShortenedUrls() {
-	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := urlService.List(&url.ListRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/user/README.md

@@ -4,6 +4,231 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
+## 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)
+}
+```
+## 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
+
+
+[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)
+}
+```
+## 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)
+}
+```
+## 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)
+}
+```
+## 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)
+}
+```
+## 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)
+}
+```
 ## Read
 
 Read an account by id, username or email. Only one need to be specified.
@@ -131,228 +356,3 @@ 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)
-}
-```
-## 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)
-}
-```
-## 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)
-}
-```
-## 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)
-}
-```
-## 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)
-}
-```
-## 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)
-}
-```

notes/notes.go

@@ -110,7 +110,7 @@ type SubscribeRequest struct {
 }
 
 type SubscribeResponse struct {
-	// the event which occured; created, deleted, updated
+	// the event which occured; create, delete, update
 	Event string `json:"event"`
 	// the note which the operation occured on
 	Note *Note `json:"note"`