add notes example

.github/workflows/generate.yml

@@ -1,26 +0,0 @@
-name: Test Clients
-on:
-  push:
-    branches:
-      - main
-      - beta
-      - ci
-
-jobs:
-  generate:
-    name: Test Clients
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@v2
-        with:
-          path: clients
-          #ref: main
-
-      - name: Test
-        working-directory: clients
-        env:
-          M3O_API_TOKEN: ${{ secrets.M3O_API_TOKEN }}
-        run: |
-          cd examples/helloworld/call/callTheHelloworldService
-          go run main.go

event/event.go

@@ -1,53 +0,0 @@
-package event
-
-import (
-	"go.m3o.com/client"
-)
-
-func NewEventService(token string) *EventService {
-	return &EventService{
-		client: client.NewClient(&client.Options{
-			Token: token,
-		}),
-	}
-}
-
-type EventService struct {
-	client *client.Client
-}
-
-// Publish a message to the event stream.
-func (t *EventService) Publish(request *PublishRequest) (*PublishResponse, error) {
-	rsp := &PublishResponse{}
-	return rsp, t.client.Call("event", "Publish", request, rsp)
-}
-
-// Subscribe to messages for a given topic.
-func (t *EventService) Subscribe(request *SubscribeRequest) (*SubscribeResponse, error) {
-	rsp := &SubscribeResponse{}
-	return rsp, t.client.Call("event", "Subscribe", request, rsp)
-}
-
-type PublishRequest struct {
-	// The json message to publish
-	Message map[string]interface{} `json:"message"`
-	// The topic to publish to
-	Topic string `json:"topic"`
-}
-
-type PublishResponse struct {
-}
-
-type SubscribeRequest struct {
-	// Optional group for the subscription
-	Group string `json:"group"`
-	// The topic to subscribe to
-	Topic string `json:"topic"`
-}
-
-type SubscribeResponse struct {
-	// The next json message on the topic
-	Message map[string]interface{} `json:"message"`
-	// The topic subscribed to
-	Topic string `json:"topic"`
-}

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/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

@@ -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",
 },
 Table: "users",
 
@@ -113,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",
 
@@ -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/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{}{
-			"isActive": true,
 			"id":       "1",
 			"name":     "Jane",
 			"age":      42,
+			"isActive": true,
 		},
 		Table: "users",
 	})

examples/db/update/updateARecord.go

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

examples/event/README.md

@@ -1,65 +0,0 @@
-# Event
-
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Event/api](https://m3o.com/Event/api).
-
-Endpoints:
-
-## Publish
-
-Publish a message to the event stream.
-
-
-[https://m3o.com/event/api#Publish](https://m3o.com/event/api#Publish)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/event"
-)
-
-// Publish a message to the event stream.
-func PublishAmessage() {
-	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Publish(&event.PublishRequest{
-		Message: map[string]interface{}{
-	"user": "john",
-	"id": "1",
-	"type": "signup",
-},
-Topic: "user",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Subscribe
-
-Subscribe to messages for a given topic.
-
-
-[https://m3o.com/event/api#Subscribe](https://m3o.com/event/api#Subscribe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/event"
-)
-
-// Subscribe to messages for a given topic.
-func SubscribeToAtopic() {
-	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Subscribe(&event.SubscribeRequest{
-		Topic: "user",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/event/publish/publishAMessage.go

@@ -1,22 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"os"
-
-	"go.m3o.com/event"
-)
-
-// Publish a message to the event stream.
-func PublishAmessage() {
-	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Publish(&event.PublishRequest{
-		Message: map[string]interface{}{
-			"user": "john",
-			"id":   "1",
-			"type": "signup",
-		},
-		Topic: "user",
-	})
-	fmt.Println(rsp, err)
-}

examples/event/subscribe/subscribeToATopic.go

@@ -1,17 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"os"
-
-	"go.m3o.com/event"
-)
-
-// Subscribe to messages for a given topic.
-func SubscribeToAtopic() {
-	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Subscribe(&event.SubscribeRequest{
-		Topic: "user",
-	})
-	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/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,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/helloworld/README.md

@@ -4,33 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Helloworld/api
 
 Endpoints:
 
-## Call
-
-Call returns a personalised "Hello $name" response
-
-
-[https://m3o.com/helloworld/api#Call](https://m3o.com/helloworld/api#Call)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/helloworld"
-)
-
-// Call returns a personalised "Hello $name" response
-func CallTheHelloworldService() {
-	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := helloworldService.Call(&helloworld.CallRequest{
-		Name: "John",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Stream
 
 Stream returns a stream of "Hello $name" responses
@@ -58,3 +31,30 @@ func StreamsAreCurrentlyTemporarilyNotSupportedInClients() {
 	fmt.Println(rsp, err)
 }
 ```
+## Call
+
+Call returns a personalised "Hello $name" response
+
+
+[https://m3o.com/helloworld/api#Call](https://m3o.com/helloworld/api#Call)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Call returns a personalised "Hello $name" response
+func CallTheHelloworldService() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := helloworldService.Call(&helloworld.CallRequest{
+		Name: "John",
+
+	})
+	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,36 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Image/api](htt
 
 Endpoints:
 
-## Convert
-
-Convert an image from one format (jpeg, png etc.) to an other either on the fly (from base64 to base64),
-or by uploading the conversion result.
-
-
-[https://m3o.com/image/api#Convert](https://m3o.com/image/api#Convert)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/image"
-)
-
-// Convert an image from one format (jpeg, png etc.) to an other either on the fly (from base64 to base64),
-// or by uploading the conversion result.
-func ConvertApngImageToAjpegTakenFromAurlAndSavedToAurlOnMicrosCdn() {
-	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := imageService.Convert(&image.ConvertRequest{
-		Name: "cat.jpeg",
-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.
@@ -198,3 +168,33 @@ Width: 100,
 	fmt.Println(rsp, err)
 }
 ```
+## Convert
+
+Convert an image from one format (jpeg, png etc.) to an other either on the fly (from base64 to base64),
+or by uploading the conversion result.
+
+
+[https://m3o.com/image/api#Convert](https://m3o.com/image/api#Convert)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/image"
+)
+
+// Convert an image from one format (jpeg, png etc.) to an other either on the fly (from base64 to base64),
+// or by uploading the conversion result.
+func ConvertApngImageToAjpegTakenFromAurlAndSavedToAurlOnMicrosCdn() {
+	imageService := image.NewImageService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := imageService.Convert(&image.ConvertRequest{
+		Name: "cat.jpeg",
+Url: "somewebsite.com/cat.png",
+
+	})
+	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

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

@@ -1,22 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"os"
-
-	"go.m3o.com/mq"
-)
-
-// Publish a message. Specify a topic to group messages for a specific topic.
-func PublishAmessage() {
-	mqService := mq.NewMqService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := mqService.Publish(&mq.PublishRequest{
-		Message: map[string]interface{}{
-			"user": "john",
-			"id":   "1",
-			"type": "signup",
-		},
-		Topic: "events",
-	})
-	fmt.Println(rsp, err)
-}

examples/mq/subscribe/subscribeToATopic.go

@@ -1,17 +0,0 @@
-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/notes/README.md

@@ -4,6 +4,60 @@ 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
@@ -116,57 +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)
-}
-```
-## Events
-
-Subscribe to notes events
-
-
-[https://m3o.com/notes/api#Events](https://m3o.com/notes/api#Events)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Subscribe to notes events
-func SubscribeToEvents() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Events(&notes.EventsRequest{
-		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/quran/README.md

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

examples/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/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

@@ -4,109 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
-## 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)
-}
-```
-## Login
-
-Login using username or email. The response will return a new session for successful login,
-401 in the case of login failure and 500 for any other error
-
-
-[https://m3o.com/user/api#Login](https://m3o.com/user/api#Login)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Login using username or email. The response will return a new session for successful login,
-// 401 in the case of login failure and 500 for any other error
-func LogAuserIn() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Login(&user.LoginRequest{
-		Email: "joe@example.com",
-Password: "mySecretPass123",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## ReadSession
-
-Read a session by the session id. In the event it has expired or is not found and error is returned.
-
-
-[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Read a session by the session id. In the event it has expired or is not found and error is returned.
-func ReadAsessionByTheSessionId() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
-		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Create
 
 Create a new user account. The email address and username for the account must be unique.
@@ -165,87 +62,6 @@ Id: "usrid-1",
 	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)
-}
-```
 ## UpdatePassword
 
 Update the account password
@@ -356,3 +172,187 @@ 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
+
+
+[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)
+}
+```
+## 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
+
+
+[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)
+}
+```

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)
+}
+```

m3o.go

@@ -10,7 +10,6 @@ import (
 	"go.m3o.com/email"
 	"go.m3o.com/emoji"
 	"go.m3o.com/evchargers"
-	"go.m3o.com/event"
 	"go.m3o.com/file"
 	"go.m3o.com/forex"
 	"go.m3o.com/function"
@@ -23,7 +22,6 @@ import (
 	"go.m3o.com/image"
 	"go.m3o.com/ip"
 	"go.m3o.com/location"
-	"go.m3o.com/mq"
 	"go.m3o.com/notes"
 	"go.m3o.com/otp"
 	"go.m3o.com/postcode"
@@ -35,6 +33,7 @@ import (
 	"go.m3o.com/sentiment"
 	"go.m3o.com/sms"
 	"go.m3o.com/stock"
+	"go.m3o.com/stream"
 	"go.m3o.com/sunnah"
 	"go.m3o.com/thumbnail"
 	"go.m3o.com/time"
@@ -59,7 +58,6 @@ func NewClient(token string) *Client {
 		EmailService:      email.NewEmailService(token),
 		EmojiService:      emoji.NewEmojiService(token),
 		EvchargersService: evchargers.NewEvchargersService(token),
-		EventService:      event.NewEventService(token),
 		FileService:       file.NewFileService(token),
 		ForexService:      forex.NewForexService(token),
 		FunctionService:   function.NewFunctionService(token),
@@ -72,7 +70,6 @@ func NewClient(token string) *Client {
 		ImageService:      image.NewImageService(token),
 		IpService:         ip.NewIpService(token),
 		LocationService:   location.NewLocationService(token),
-		MqService:         mq.NewMqService(token),
 		NotesService:      notes.NewNotesService(token),
 		OtpService:        otp.NewOtpService(token),
 		PostcodeService:   postcode.NewPostcodeService(token),
@@ -84,6 +81,7 @@ func NewClient(token string) *Client {
 		SentimentService:  sentiment.NewSentimentService(token),
 		SmsService:        sms.NewSmsService(token),
 		StockService:      stock.NewStockService(token),
+		StreamService:     stream.NewStreamService(token),
 		SunnahService:     sunnah.NewSunnahService(token),
 		ThumbnailService:  thumbnail.NewThumbnailService(token),
 		TimeService:       time.NewTimeService(token),
@@ -108,7 +106,6 @@ type Client struct {
 	EmailService      *email.EmailService
 	EmojiService      *emoji.EmojiService
 	EvchargersService *evchargers.EvchargersService
-	EventService      *event.EventService
 	FileService       *file.FileService
 	ForexService      *forex.ForexService
 	FunctionService   *function.FunctionService
@@ -121,7 +118,6 @@ type Client struct {
 	ImageService      *image.ImageService
 	IpService         *ip.IpService
 	LocationService   *location.LocationService
-	MqService         *mq.MqService
 	NotesService      *notes.NotesService
 	OtpService        *otp.OtpService
 	PostcodeService   *postcode.PostcodeService
@@ -133,6 +129,7 @@ type Client struct {
 	SentimentService  *sentiment.SentimentService
 	SmsService        *sms.SmsService
 	StockService      *stock.StockService
+	StreamService     *stream.StreamService
 	SunnahService     *sunnah.SunnahService
 	ThumbnailService  *thumbnail.ThumbnailService
 	TimeService       *time.TimeService

mq/mq.go

@@ -1,51 +0,0 @@
-package mq
-
-import (
-	"go.m3o.com/client"
-)
-
-func NewMqService(token string) *MqService {
-	return &MqService{
-		client: client.NewClient(&client.Options{
-			Token: token,
-		}),
-	}
-}
-
-type MqService struct {
-	client *client.Client
-}
-
-// Publish a message. Specify a topic to group messages for a specific topic.
-func (t *MqService) Publish(request *PublishRequest) (*PublishResponse, error) {
-	rsp := &PublishResponse{}
-	return rsp, t.client.Call("mq", "Publish", request, rsp)
-}
-
-// Subscribe to messages for a given topic.
-func (t *MqService) Subscribe(request *SubscribeRequest) (*SubscribeResponse, error) {
-	rsp := &SubscribeResponse{}
-	return rsp, t.client.Call("mq", "Subscribe", request, rsp)
-}
-
-type PublishRequest struct {
-	// The json message to publish
-	Message map[string]interface{} `json:"message"`
-	// The topic to publish to
-	Topic string `json:"topic"`
-}
-
-type PublishResponse struct {
-}
-
-type SubscribeRequest struct {
-	// The topic to subscribe to
-	Topic string `json:"topic"`
-}
-
-type SubscribeResponse struct {
-	// The next json message on the topic
-	Message map[string]interface{} `json:"message"`
-	// The topic subscribed to
-	Topic string `json:"topic"`
-}

notes/notes.go

@@ -28,12 +28,6 @@ func (t *NotesService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
 	return rsp, t.client.Call("notes", "Delete", request, rsp)
 }
 
-// Subscribe to notes events
-func (t *NotesService) Events(request *EventsRequest) (*EventsResponse, error) {
-	rsp := &EventsResponse{}
-	return rsp, t.client.Call("notes", "Events", request, rsp)
-}
-
 // List all the notes
 func (t *NotesService) List(request *ListRequest) (*ListResponse, error) {
 	rsp := &ListResponse{}
@@ -46,6 +40,12 @@ func (t *NotesService) Read(request *ReadRequest) (*ReadResponse, error) {
 	return rsp, t.client.Call("notes", "Read", request, rsp)
 }
 
+// Specify the note to events
+func (t *NotesService) Subscribe(request *SubscribeRequest) (*SubscribeResponse, error) {
+	rsp := &SubscribeResponse{}
+	return rsp, t.client.Call("notes", "Subscribe", request, rsp)
+}
+
 // Update a note
 func (t *NotesService) Update(request *UpdateRequest) (*UpdateResponse, error) {
 	rsp := &UpdateResponse{}
@@ -73,18 +73,6 @@ type DeleteResponse struct {
 	Note *Note `json:"note"`
 }
 
-type EventsRequest struct {
-	// optionally specify a note id
-	Id string `json:"id"`
-}
-
-type EventsResponse struct {
-	// the event which occured; create, delete, update
-	Event string `json:"event"`
-	// the note which the operation occured on
-	Note *Note `json:"note"`
-}
-
 type ListRequest struct {
 }
 
@@ -116,6 +104,18 @@ type ReadResponse struct {
 	Note *Note `json:"note"`
 }
 
+type SubscribeRequest struct {
+	// optionally specify a note id
+	Id string `json:"id"`
+}
+
+type SubscribeResponse struct {
+	// the event which occured; created, deleted, updated
+	Event string `json:"event"`
+	// the note which the operation occured on
+	Note *Note `json:"note"`
+}
+
 type UpdateRequest struct {
 	Note *Note `json:"note"`
 }