add notes example

README.md

@@ -4,6 +4,35 @@ This is the Go client to access APIs on the M3O Platform
 
 ## Usage
 
+Call a service using the generated client. Populate the `M3O_API_TOKEN` environment variable. 
+
+Import the package and initialise the service with your API token.
+
+```go
+package main
+
+import(
+        "fmt"
+        "os"
+
+        "go.m3o.com/helloworld"
+)
+
+// Call returns a personalised "Hello $name" response
+func main() {
+        helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+        rsp, err := helloworldService.Call(&helloworld.CallRequest{
+                Name: "John",
+
+        })
+        fmt.Println(rsp, err)
+}
+```
+
+## Generic Client
+
+The generic client enables you to call any endpoint by name with freeform request/response types.
+
 ```go
 package main
 
@@ -11,7 +40,7 @@ import (
     "fmt"
     "os"
 
-    "github.com/m3o/m3o-go/client"
+    "go.m3o.com/client"
 )
 
 type Request struct {
@@ -49,15 +78,15 @@ func main() {
 
 ## Streaming
 
-The client supports streaming
-
+The client supports streaming but is not yet code generated. Use the following for streaming endpoints.
+ 
 ```go
 package main
 
 import (
 	"fmt"
 
-	"github.com/m3o/m3o-go/client"
+	"go.m3o.com/client"
 )
 
 type Request struct {

examples/cache/README.md

@@ -4,62 +4,6 @@ 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.
@@ -142,3 +86,59 @@ 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/crypto/README.md

@@ -4,6 +4,33 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Crypto/api](ht
 
 Endpoints:
 
+## News
+
+Get news related to a currency
+
+
+[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get news related to a currency
+func GetCryptocurrencyNews() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.News(&crypto.NewsRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Price
 
 Get the last price for a given crypto ticker
@@ -85,30 +112,3 @@ func GetPreviousClose() {
 	fmt.Println(rsp, err)
 }
 ```
-## News
-
-Get news related to a currency
-
-
-[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Get news related to a currency
-func GetCryptocurrencyNews() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.News(&crypto.NewsRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/currency/README.md

@@ -4,6 +4,59 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Currency/api](
 
 Endpoints:
 
+## Codes
+
+Codes returns the supported currency codes for the API
+
+
+[https://m3o.com/currency/api#Codes](https://m3o.com/currency/api#Codes)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Codes returns the supported currency codes for the API
+func GetSupportedCodes() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Codes(&currency.CodesRequest{
+		
+	})
+	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)
+}
+```
 ## Convert
 
 Convert returns the currency conversion rate between two pairs e.g USD/GBP
@@ -89,56 +142,3 @@ Date: "2021-05-30",
 	fmt.Println(rsp, err)
 }
 ```
-## Codes
-
-Codes returns the supported currency codes for the API
-
-
-[https://m3o.com/currency/api#Codes](https://m3o.com/currency/api#Codes)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/currency"
-)
-
-// Codes returns the supported currency codes for the API
-func GetSupportedCodes() {
-	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := currencyService.Codes(&currency.CodesRequest{
-		
-	})
-	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

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

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

@@ -4,32 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Evchargers/api
 
 Endpoints:
 
-## ReferenceData
-
-Retrieve reference data as used by this API and in conjunction with the Search endpoint
-
-
-[https://m3o.com/evchargers/api#ReferenceData](https://m3o.com/evchargers/api#ReferenceData)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/evchargers"
-)
-
-// Retrieve reference data as used by this API and in conjunction with the Search endpoint
-func GetReferenceData() {
-	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := evchargersService.ReferenceData(&evchargers.ReferenceDataRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Search
 
 Search by giving a coordinate and a max distance, or bounding box and optional filters
@@ -121,3 +95,29 @@ Location: &evchargers.Coordinates{
 	fmt.Println(rsp, err)
 }
 ```
+## ReferenceData
+
+Retrieve reference data as used by this API and in conjunction with the Search endpoint
+
+
+[https://m3o.com/evchargers/api#ReferenceData](https://m3o.com/evchargers/api#ReferenceData)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/evchargers"
+)
+
+// Retrieve reference data as used by this API and in conjunction with the Search endpoint
+func GetReferenceData() {
+	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := evchargersService.ReferenceData(&evchargers.ReferenceDataRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/file/README.md

@@ -4,6 +4,62 @@ 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
@@ -62,59 +118,3 @@ func ListFiles() {
 	fmt.Println(rsp, err)
 }
 ```
-## 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/function/README.md

@@ -4,66 +4,6 @@ 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
@@ -146,3 +86,63 @@ Project: "tests",
 	fmt.Println(rsp, err)
 }
 ```
+## 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/holidays/README.md

@@ -4,32 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Holidays/api](
 
 Endpoints:
 
-## Countries
-
-Get the list of countries that are supported by this API
-
-
-[https://m3o.com/holidays/api#Countries](https://m3o.com/holidays/api#Countries)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/holidays"
-)
-
-// Get the list of countries that are supported by this API
-func ListCountries() {
-	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := holidaysService.Countries(&holidays.CountriesRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## List
 
 List the holiday dates for a given country and year
@@ -57,3 +31,29 @@ func GetHolidays() {
 	fmt.Println(rsp, err)
 }
 ```
+## Countries
+
+Get the list of countries that are supported by this API
+
+
+[https://m3o.com/holidays/api#Countries](https://m3o.com/holidays/api#Countries)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/holidays"
+)
+
+// Get the list of countries that are supported by this API
+func ListCountries() {
+	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := holidaysService.Countries(&holidays.CountriesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/image/README.md

@@ -4,6 +4,66 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Image/api](htt
 
 Endpoints:
 
+## Upload
+
+Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+To resize an image before uploading, see the Resize endpoint.
+
+
+[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+// To resize an image before uploading, see the Resize endpoint.
+func UploadAbase64imageToMicrosCdn() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Upload(&image.UploadRequest{
+		Base64: "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAx0lEQVR4nOzaMaoDMQyE4ZHj+x82vVdhwQoTkzKQEcwP5r0ihT7sbjUTeAJ4HCegXQJYfOYefOyjDuBiz3yjwJBoCIl6QZOeUjTC1Ix1IxEJXF9+0KWsf2bD4bn37OO/c/wuQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9Sa/NG94Tf3j4WBdaxudMEkn4IM2rZBA0wBrvo7aOcpj2emXvLeVt0IGm0GVXUj91mvAAAA//+V2CZl+4AKXwAAAABJRU5ErkJggg==",
+Name: "cat.jpeg",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Upload
+
+Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+To resize an image before uploading, see the Resize endpoint.
+
+
+[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
+// To resize an image before uploading, see the Resize endpoint.
+func UploadAnImageFromAurlToMicrosCdn() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Upload(&image.UploadRequest{
+		Name: "cat.jpeg",
+Url: "somewebsite.com/cat.png",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Resize
 
 Resize an image on the fly without storing it (by sending and receiving a base64 encoded image), or resize and upload depending on parameters.
@@ -138,63 +198,3 @@ Url: "somewebsite.com/cat.png",
 	fmt.Println(rsp, err)
 }
 ```
-## Upload
-
-Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-To resize an image before uploading, see the Resize endpoint.
-
-
-[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-// To resize an image before uploading, see the Resize endpoint.
-func UploadAbase64imageToMicrosCdn() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Upload(&image.UploadRequest{
-		Base64: "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAx0lEQVR4nOzaMaoDMQyE4ZHj+x82vVdhwQoTkzKQEcwP5r0ihT7sbjUTeAJ4HCegXQJYfOYefOyjDuBiz3yjwJBoCIl6QZOeUjTC1Ix1IxEJXF9+0KWsf2bD4bn37OO/c/wuQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9QyRC1D1DJELUPUMkQtQ9Sa/NG94Tf3j4WBdaxudMEkn4IM2rZBA0wBrvo7aOcpj2emXvLeVt0IGm0GVXUj91mvAAAA//+V2CZl+4AKXwAAAABJRU5ErkJggg==",
-Name: "cat.jpeg",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Upload
-
-Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-To resize an image before uploading, see the Resize endpoint.
-
-
-[https://m3o.com/image/api#Upload](https://m3o.com/image/api#Upload)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Upload an image by either sending a base64 encoded image to this endpoint or a URL.
-// To resize an image before uploading, see the Resize endpoint.
-func UploadAnImageFromAurlToMicrosCdn() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Upload(&image.UploadRequest{
-		Name: "cat.jpeg",
-Url: "somewebsite.com/cat.png",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/notes/README.md

@@ -4,6 +4,88 @@ 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)
+}
+```
+## Subscribe
+
+Specify the note to events
+
+
+[https://m3o.com/notes/api#Subscribe](https://m3o.com/notes/api#Subscribe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Specify the note to events
+func SubscribeToEvents() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Subscribe(&notes.SubscribeRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Create
+
+Create a new note
+
+
+[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Create a new note
+func CreateAnote() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Create(&notes.CreateRequest{
+		Text: "This is my note",
+Title: "New Note",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Read
 
 Read a note
@@ -88,58 +170,3 @@ func UpdateAnote() {
 	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)
-}
-```
-## Create
-
-Create a new note
-
-
-[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Create a new note
-func CreateAnote() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Create(&notes.CreateRequest{
-		Text: "This is my note",
-Title: "New Note",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/notes/events/subscribeToEvents.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Subscribe to notes events
+func SubscribeToEvents() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Events(&notes.EventsRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	})
+	fmt.Println(rsp, err)
+}

examples/notes/subscribe/subscribeToEvents.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Specify the note to events
+func SubscribeToEvents() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Subscribe(&notes.SubscribeRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	})
+	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/stream/README.md

@@ -26,9 +26,9 @@ func PublishAmessage() {
 	streamService := stream.NewStreamService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := streamService.Publish(&stream.PublishRequest{
 		Message: map[string]interface{}{
+	"id": "1",
 	"type": "signup",
 	"user": "john",
-	"id": "1",
 },
 Topic: "events",
 

examples/stream/publish/publishAMessage.go

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

examples/sunnah/README.md

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

examples/twitter/README.md

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

examples/user/README.md

@@ -62,6 +62,35 @@ 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)
+}
+```
 ## Read
 
 Read an account by id, username or email. Only one need to be specified.
@@ -143,6 +172,33 @@ func ReadAccountByEmail() {
 	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
@@ -200,6 +256,52 @@ Password: "mySecretPass123",
 	fmt.Println(rsp, err)
 }
 ```
+## SendVerificationEmail
+
+Send a verification email
+to the user being signed up. Email from will be from 'support@m3o.com',
+but you can provide the title and contents.
+The verification link will be injected in to the email as a template variable, $micro_verification_link.
+Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+The variable will be replaced with an actual url that will look similar to this:
+'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+
+
+[https://m3o.com/user/api#SendVerificationEmail](https://m3o.com/user/api#SendVerificationEmail)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Send a verification email
+// to the user being signed up. Email from will be from 'support@m3o.com',
+// but you can provide the title and contents.
+// The verification link will be injected in to the email as a template variable, $micro_verification_link.
+// Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+// The variable will be replaced with an actual url that will look similar to this:
+// 'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+func SendVerificationEmail() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.SendVerificationEmail(&user.SendVerificationEmailRequest{
+		Email: "joe@example.com",
+FailureRedirectUrl: "https://m3o.com/verification-failed",
+FromName: "Awesome Dot Com",
+RedirectUrl: "https://m3o.com",
+Subject: "Email verification",
+TextContent: `Hi there,
+
+Please verify your email by clicking this link: $micro_verification_link`,
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Logout
 
 Logout a user account
@@ -254,105 +356,3 @@ func ReadAsessionByTheSessionId() {
 	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
-
-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)
-}
-```

examples/weather/README.md

@@ -4,33 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Weather/api](h
 
 Endpoints:
 
-## Now
-
-Get the current weather report for a location by postcode, city, zip code, ip address
-
-
-[https://m3o.com/weather/api#Now](https://m3o.com/weather/api#Now)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/weather"
-)
-
-// Get the current weather report for a location by postcode, city, zip code, ip address
-func GetCurrentWeather() {
-	weatherService := weather.NewWeatherService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := weatherService.Now(&weather.NowRequest{
-		Location: "london",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Forecast
 
 Get the weather forecast for the next 1-10 days
@@ -59,3 +32,30 @@ Location: "London",
 	fmt.Println(rsp, err)
 }
 ```
+## Now
+
+Get the current weather report for a location by postcode, city, zip code, ip address
+
+
+[https://m3o.com/weather/api#Now](https://m3o.com/weather/api#Now)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/weather"
+)
+
+// Get the current weather report for a location by postcode, city, zip code, ip address
+func GetCurrentWeather() {
+	weatherService := weather.NewWeatherService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := weatherService.Now(&weather.NowRequest{
+		Location: "london",
+
+	})
+	fmt.Println(rsp, err)
+}
+```