F

.github/workflows/generate.yml

@@ -0,0 +1,31 @@
+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: |
+          # stream is temporarily excluded as it hangs forever because test does not close connection
+          # @TODO remove "idempotent: true" from stream example
+          O=$(find . -name ".run" | grep -v stream | xargs -n1 dirname | xargs -n1 go run)
+          echo $O
+          if grep -q Detail "$O"; then
+            exit 1
+          fi

address/address.go

@@ -18,8 +18,10 @@ type AddressService struct {
 
 // Lookup a list of UK addresses by postcode
 func (t *AddressService) LookupPostcode(request *LookupPostcodeRequest) (*LookupPostcodeResponse, error) {
+
 	rsp := &LookupPostcodeResponse{}
 	return rsp, t.client.Call("address", "LookupPostcode", request, rsp)
+
 }
 
 type LookupPostcodeRequest struct {

answer/answer.go

@@ -18,8 +18,10 @@ type AnswerService struct {
 
 // Ask a question and receive an instant answer
 func (t *AnswerService) Question(request *QuestionRequest) (*QuestionResponse, error) {
+
 	rsp := &QuestionResponse{}
 	return rsp, t.client.Call("answer", "Question", request, rsp)
+
 }
 
 type QuestionRequest struct {

cache/cache.go

@@ -16,34 +16,44 @@ type CacheService struct {
 	client *client.Client
 }
 
-// Decrement a value (if it's a number)
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
 func (t *CacheService) Decrement(request *DecrementRequest) (*DecrementResponse, error) {
+
 	rsp := &DecrementResponse{}
 	return rsp, t.client.Call("cache", "Decrement", request, rsp)
+
 }
 
-// Delete a value from the cache
+// Delete a value from the cache. If key not found a success response is returned.
 func (t *CacheService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
 	rsp := &DeleteResponse{}
 	return rsp, t.client.Call("cache", "Delete", request, rsp)
+
 }
 
-// Get an item from the cache by key
+// Get an item from the cache by key. If key is not found, an empty response is returned.
 func (t *CacheService) Get(request *GetRequest) (*GetResponse, error) {
+
 	rsp := &GetResponse{}
 	return rsp, t.client.Call("cache", "Get", request, rsp)
+
 }
 
-// Increment a value (if it's a number)
+// Increment a value (if it's a number). If key not found it is equivalent to set.
 func (t *CacheService) Increment(request *IncrementRequest) (*IncrementResponse, error) {
+
 	rsp := &IncrementResponse{}
 	return rsp, t.client.Call("cache", "Increment", request, rsp)
+
 }
 
 // Set an item in the cache. Overwrites any existing value already set.
 func (t *CacheService) Set(request *SetRequest) (*SetResponse, error) {
+
 	rsp := &SetResponse{}
 	return rsp, t.client.Call("cache", "Set", request, rsp)
+
 }
 
 type DecrementRequest struct {

crypto/crypto.go

@@ -18,26 +18,34 @@ type CryptoService struct {
 
 // Returns the history for the previous close
 func (t *CryptoService) History(request *HistoryRequest) (*HistoryResponse, error) {
+
 	rsp := &HistoryResponse{}
 	return rsp, t.client.Call("crypto", "History", request, rsp)
+
 }
 
 // Get news related to a currency
 func (t *CryptoService) News(request *NewsRequest) (*NewsResponse, error) {
+
 	rsp := &NewsResponse{}
 	return rsp, t.client.Call("crypto", "News", request, rsp)
+
 }
 
 // Get the last price for a given crypto ticker
 func (t *CryptoService) Price(request *PriceRequest) (*PriceResponse, error) {
+
 	rsp := &PriceResponse{}
 	return rsp, t.client.Call("crypto", "Price", request, rsp)
+
 }
 
 // Get the last quote for a given crypto ticker
 func (t *CryptoService) Quote(request *QuoteRequest) (*QuoteResponse, error) {
+
 	rsp := &QuoteResponse{}
 	return rsp, t.client.Call("crypto", "Quote", request, rsp)
+
 }
 
 type Article struct {

currency/currency.go

@@ -18,26 +18,34 @@ type CurrencyService struct {
 
 // Codes returns the supported currency codes for the API
 func (t *CurrencyService) Codes(request *CodesRequest) (*CodesResponse, error) {
+
 	rsp := &CodesResponse{}
 	return rsp, t.client.Call("currency", "Codes", request, rsp)
+
 }
 
 // Convert returns the currency conversion rate between two pairs e.g USD/GBP
 func (t *CurrencyService) Convert(request *ConvertRequest) (*ConvertResponse, error) {
+
 	rsp := &ConvertResponse{}
 	return rsp, t.client.Call("currency", "Convert", request, rsp)
+
 }
 
 // Returns the historic rates for a currency on a given date
 func (t *CurrencyService) History(request *HistoryRequest) (*HistoryResponse, error) {
+
 	rsp := &HistoryResponse{}
 	return rsp, t.client.Call("currency", "History", request, rsp)
+
 }
 
 // Rates returns the currency rates for a given code e.g USD
 func (t *CurrencyService) Rates(request *RatesRequest) (*RatesResponse, error) {
+
 	rsp := &RatesResponse{}
 	return rsp, t.client.Call("currency", "Rates", request, rsp)
+
 }
 
 type Code struct {

db/db.go

@@ -18,38 +18,50 @@ type DbService struct {
 
 // Count records in a table
 func (t *DbService) Count(request *CountRequest) (*CountResponse, error) {
+
 	rsp := &CountResponse{}
 	return rsp, t.client.Call("db", "Count", request, rsp)
+
 }
 
 // Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
 func (t *DbService) Create(request *CreateRequest) (*CreateResponse, error) {
+
 	rsp := &CreateResponse{}
 	return rsp, t.client.Call("db", "Create", request, rsp)
+
 }
 
 // Delete a record in the database by id.
 func (t *DbService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
 	rsp := &DeleteResponse{}
 	return rsp, t.client.Call("db", "Delete", request, rsp)
+
 }
 
 // Read data from a table. Lookup can be by ID or via querying any field in the record.
 func (t *DbService) Read(request *ReadRequest) (*ReadResponse, error) {
+
 	rsp := &ReadResponse{}
 	return rsp, t.client.Call("db", "Read", request, rsp)
+
 }
 
 // Truncate the records in a table
 func (t *DbService) Truncate(request *TruncateRequest) (*TruncateResponse, error) {
+
 	rsp := &TruncateResponse{}
 	return rsp, t.client.Call("db", "Truncate", request, rsp)
+
 }
 
 // Update a record in the database. Include an "id" in the record to update.
 func (t *DbService) Update(request *UpdateRequest) (*UpdateResponse, error) {
+
 	rsp := &UpdateResponse{}
 	return rsp, t.client.Call("db", "Update", request, rsp)
+
 }
 
 type CountRequest struct {

email/email.go

@@ -18,8 +18,10 @@ type EmailService struct {
 
 // Send an email by passing in from, to, subject, and a text or html body
 func (t *EmailService) Send(request *SendRequest) (*SendResponse, error) {
+
 	rsp := &SendResponse{}
 	return rsp, t.client.Call("email", "Send", request, rsp)
+
 }
 
 type SendRequest struct {

emoji/emoji.go

@@ -18,27 +18,35 @@ type EmojiService struct {
 
 // Find an emoji by its alias e.g :beer:
 func (t *EmojiService) Find(request *FindRequest) (*FindResponse, error) {
+
 	rsp := &FindResponse{}
 	return rsp, t.client.Call("emoji", "Find", request, rsp)
+
 }
 
 // Get the flag for a country. Requires country code e.g GB for great britain
 func (t *EmojiService) Flag(request *FlagRequest) (*FlagResponse, error) {
+
 	rsp := &FlagResponse{}
 	return rsp, t.client.Call("emoji", "Flag", request, rsp)
+
 }
 
 // Print text and renders the emojis with aliases e.g
 // let's grab a :beer: becomes let's grab a 🍺
 func (t *EmojiService) Print(request *PrintRequest) (*PrintResponse, error) {
+
 	rsp := &PrintResponse{}
 	return rsp, t.client.Call("emoji", "Print", request, rsp)
+
 }
 
 // Send an emoji to anyone via SMS. Messages are sent in the form '<message> Sent from <from>'
 func (t *EmojiService) Send(request *SendRequest) (*SendResponse, error) {
+
 	rsp := &SendResponse{}
 	return rsp, t.client.Call("emoji", "Send", request, rsp)
+
 }
 
 type FindRequest struct {

evchargers/evchargers.go

@@ -18,14 +18,18 @@ type EvchargersService struct {
 
 // Retrieve reference data as used by this API and in conjunction with the Search endpoint
 func (t *EvchargersService) ReferenceData(request *ReferenceDataRequest) (*ReferenceDataResponse, error) {
+
 	rsp := &ReferenceDataResponse{}
 	return rsp, t.client.Call("evchargers", "ReferenceData", request, rsp)
+
 }
 
 // Search by giving a coordinate and a max distance, or bounding box and optional filters
 func (t *EvchargersService) Search(request *SearchRequest) (*SearchResponse, error) {
+
 	rsp := &SearchResponse{}
 	return rsp, t.client.Call("evchargers", "Search", request, rsp)
+
 }
 
 type Address struct {

event/event.go

@@ -0,0 +1,110 @@
+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
+}
+
+// Consume events from a given topic.
+func (t *EventService) Consume(request *ConsumeRequest) (*ConsumeResponseStream, error) {
+	stream, err := t.client.Stream("event", "Consume", request)
+	if err != nil {
+		return nil, err
+	}
+	return &ConsumeResponseStream{
+		stream: stream,
+	}, nil
+
+}
+
+type ConsumeResponseStream struct {
+	stream *client.Stream
+}
+
+func (t *ConsumeResponseStream) Recv() (*ConsumeResponse, error) {
+	var rsp ConsumeResponse
+	if err := t.stream.Recv(&rsp); err != nil {
+		return nil, err
+	}
+	return &rsp, nil
+}
+
+// Publish a event to the event stream.
+func (t *EventService) Publish(request *PublishRequest) (*PublishResponse, error) {
+
+	rsp := &PublishResponse{}
+	return rsp, t.client.Call("event", "Publish", request, rsp)
+
+}
+
+// Read stored events
+func (t *EventService) Read(request *ReadRequest) (*ReadResponse, error) {
+
+	rsp := &ReadResponse{}
+	return rsp, t.client.Call("event", "Read", request, rsp)
+
+}
+
+type ConsumeRequest struct {
+	// Optional group for the subscription
+	Group string `json:"group"`
+	// Optional offset to read from e.g "2006-01-02T15:04:05.999Z07:00"
+	Offset string `json:"offset"`
+	// The topic to subscribe to
+	Topic string `json:"topic"`
+}
+
+type ConsumeResponse struct {
+	// Unique message id
+	Id string `json:"id"`
+	// The next json message on the topic
+	Message map[string]interface{} `json:"message"`
+	// Timestamp of publishing
+	Timestamp string `json:"timestamp"`
+	// The topic subscribed to
+	Topic string `json:"topic"`
+}
+
+type Ev struct {
+	// event id
+	Id string `json:"id"`
+	// event message
+	Message map[string]interface{} `json:"message"`
+	// event timestamp
+	Timestamp string `json:"timestamp"`
+}
+
+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 ReadRequest struct {
+	// number of events to read; default 25
+	Limit int32 `json:"limit"`
+	// offset for the events; default 0
+	Offset int32 `json:"offset"`
+	// topic to read from
+	Topic string `json:"topic"`
+}
+
+type ReadResponse struct {
+	// the events
+	Events []Ev `json:"events"`
+}

examples/address/README.md

@@ -29,5 +29,6 @@ func LookupPostcode() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/address/lookupPostcode/lookupPostcode/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/address"
+)
+
+// Lookup a list of UK addresses by postcode
+func main() {
+	addressService := address.NewAddressService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := addressService.LookupPostcode(&address.LookupPostcodeRequest{
+		Postcode: "SW1A 2AA",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/answer/README.md

@@ -29,5 +29,6 @@ func AskAquestion() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/answer/question/askAQuestion/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/answer"
+)
+
+// Ask a question and receive an instant answer
+func main() {
+	answerService := answer.NewAnswerService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := answerService.Question(&answer.QuestionRequest{
+		Query: "microsoft",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/cache/README.md

@@ -4,6 +4,92 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Cache/api](htt
 
 Endpoints:
 
+## Delete
+
+Delete a value from the cache. If key not found a success response is returned.
+
+
+[https://m3o.com/cache/api#Delete](https://m3o.com/cache/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Delete a value from the cache. If key not found a success response is returned.
+func DeleteAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Delete(&cache.DeleteRequest{
+		Key: "foo",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Increment
+
+Increment a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Increment a value (if it's a number). If key not found it is equivalent to set.
+func IncrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Increment(&cache.IncrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Decrement
+
+Decrement a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
+func DecrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Set
 
 Set an item in the cache. Overwrites any existing value already set.
@@ -30,11 +116,12 @@ Value: "bar",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Get
 
-Get an item from the cache by key
+Get an item from the cache by key. If key is not found, an empty response is returned.
 
 
 [https://m3o.com/cache/api#Get](https://m3o.com/cache/api#Get)
@@ -49,7 +136,7 @@ import(
 	"go.m3o.com/cache"
 )
 
-// Get an item from the cache by key
+// Get an item from the cache by key. If key is not found, an empty response is returned.
 func GetAvalue() {
 	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := cacheService.Get(&cache.GetRequest{
@@ -57,88 +144,6 @@ func GetAvalue() {
 
 	})
 	fmt.Println(rsp, err)
-}
-```
-## Delete
-
-Delete a value from the cache
-
-
-[https://m3o.com/cache/api#Delete](https://m3o.com/cache/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/cache"
-)
-
-// Delete a value from the cache
-func DeleteAvalue() {
-	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cacheService.Delete(&cache.DeleteRequest{
-		Key: "foo",
-
-	})
-	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/cache/decrement/decrementAValue.go

@@ -7,7 +7,7 @@ import (
 	"go.m3o.com/cache"
 )
 
-// Decrement a value (if it's a number)
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
 func DecrementAvalue() {
 	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := cacheService.Decrement(&cache.DecrementRequest{

examples/cache/decrement/decrementAValue/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
+		Key:   "counter",
+		Value: 2,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/cache/delete/deleteAValue.go

@@ -7,7 +7,7 @@ import (
 	"go.m3o.com/cache"
 )
 
-// Delete a value from the cache
+// Delete a value from the cache. If key not found a success response is returned.
 func DeleteAvalue() {
 	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := cacheService.Delete(&cache.DeleteRequest{

examples/cache/delete/deleteAValue/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Delete a value from the cache. If key not found a success response is returned.
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Delete(&cache.DeleteRequest{
+		Key: "foo",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/cache/get/getAValue.go

@@ -7,7 +7,7 @@ import (
 	"go.m3o.com/cache"
 )
 
-// Get an item from the cache by key
+// Get an item from the cache by key. If key is not found, an empty response is returned.
 func GetAvalue() {
 	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := cacheService.Get(&cache.GetRequest{

examples/cache/get/getAValue/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Get an item from the cache by key. If key is not found, an empty response is returned.
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Get(&cache.GetRequest{
+		Key: "foo",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/cache/increment/incrementAValue.go

@@ -7,7 +7,7 @@ import (
 	"go.m3o.com/cache"
 )
 
-// Increment a value (if it's a number)
+// Increment a value (if it's a number). If key not found it is equivalent to set.
 func IncrementAvalue() {
 	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := cacheService.Increment(&cache.IncrementRequest{

examples/cache/increment/incrementAValue/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Increment a value (if it's a number). If key not found it is equivalent to set.
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Increment(&cache.IncrementRequest{
+		Key:   "counter",
+		Value: 2,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/cache/set/setAValue/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Set an item in the cache. Overwrites any existing value already set.
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Set(&cache.SetRequest{
+		Key:   "foo",
+		Value: "bar",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/crypto/README.md

@@ -4,6 +4,34 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Crypto/api](ht
 
 Endpoints:
 
+## History
+
+Returns the history for the previous close
+
+
+[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Returns the history for the previous close
+func GetPreviousClose() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.History(&crypto.HistoryRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## News
 
 Get news related to a currency
@@ -29,6 +57,7 @@ func GetCryptocurrencyNews() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Price
@@ -56,6 +85,7 @@ func GetCryptocurrencyPrice() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Quote
@@ -83,32 +113,6 @@ func GetAcryptocurrencyQuote() {
 
 	})
 	fmt.Println(rsp, err)
-}
-```
-## History
-
-Returns the history for the previous close
-
-
-[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Returns the history for the previous close
-func GetPreviousClose() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.History(&crypto.HistoryRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
+	
 }
 ```

examples/crypto/history/getPreviousClose/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Returns the history for the previous close
+func main() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.History(&crypto.HistoryRequest{
+		Symbol: "BTCUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/crypto/news/getCryptocurrencyNews/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get news related to a currency
+func main() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.News(&crypto.NewsRequest{
+		Symbol: "BTCUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/crypto/price/getCryptocurrencyPrice/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get the last price for a given crypto ticker
+func main() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Price(&crypto.PriceRequest{
+		Symbol: "BTCUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/crypto/quote/getACryptocurrencyQuote/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get the last quote for a given crypto ticker
+func main() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Quote(&crypto.QuoteRequest{
+		Symbol: "BTCUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/currency/README.md

@@ -28,6 +28,7 @@ func GetSupportedCodes() {
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Rates
@@ -55,6 +56,7 @@ func GetRatesForUsd() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Convert
@@ -83,6 +85,7 @@ To: "GBP",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Convert
@@ -112,6 +115,7 @@ To: "GBP",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## History
@@ -140,5 +144,6 @@ Date: "2021-05-30",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/currency/codes/getSupportedCodes/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Codes returns the supported currency codes for the API
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Codes(&currency.CodesRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/currency/convert/convert10UsdToGbp/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Convert returns the currency conversion rate between two pairs e.g USD/GBP
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Convert(&currency.ConvertRequest{
+		Amount: 10,
+		From:   "USD",
+		To:     "GBP",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/currency/convert/convertUsdToGbp/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Convert returns the currency conversion rate between two pairs e.g USD/GBP
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Convert(&currency.ConvertRequest{
+		From: "USD",
+		To:   "GBP",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/currency/history/historicRatesForACurrency/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Returns the historic rates for a currency on a given date
+func main() {
+	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/currency/rates/getRatesForUsd/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Rates returns the currency rates for a given code e.g USD
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Rates(&currency.RatesRequest{
+		Code: "USD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/README.md

@@ -35,6 +35,7 @@ Table: "users",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Update
@@ -59,13 +60,14 @@ 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",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Read
@@ -94,6 +96,7 @@ Table: "users",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Delete
@@ -122,6 +125,7 @@ Table: "users",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Truncate
@@ -149,6 +153,7 @@ func TruncateTable() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Count
@@ -176,5 +181,6 @@ func CountEntriesInAtable() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/db/count/countEntriesInATable/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Count records in a table
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Count(&db.CountRequest{
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/create/createARecord/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
+func main() {
+	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,
+		},
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/delete/deleteARecord/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Delete a record in the database by id.
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Delete(&db.DeleteRequest{
+		Id:    "1",
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/read/readRecords/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Read data from a table. Lookup can be by ID or via querying any field in the record.
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Read(&db.ReadRequest{
+		Query: "age == 43",
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/truncate/truncateTable/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Truncate the records in a table
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Truncate(&db.TruncateRequest{
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/update/updateARecord/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Update a record in the database. Include an "id" in the record to update.
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Update(&db.UpdateRequest{
+		Record: map[string]interface{}{
+			"id":  "1",
+			"age": 43,
+		},
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/email/README.md

@@ -33,5 +33,6 @@ Please verify your email by clicking this link: $micro_verification_link`,
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/email/send/sendEmail/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/email"
+)
+
+// Send an email by passing in from, to, subject, and a text or html body
+func main() {
+	emailService := email.NewEmailService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emailService.Send(&email.SendRequest{
+		From:    "Awesome Dot Com",
+		Subject: "Email verification",
+		TextBody: `Hi there,
+
+Please verify your email by clicking this link: $micro_verification_link`,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/emoji/README.md

@@ -29,6 +29,7 @@ func FindEmoji() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Flag
@@ -55,6 +56,7 @@ func GetFlagByCountryCode() {
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Print
@@ -84,6 +86,7 @@ func PrintTextIncludingEmoji() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Send
@@ -113,5 +116,6 @@ To: "+44782669123",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/emoji/find/findEmoji/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Find an emoji by its alias e.g :beer:
+func main() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Find(&emoji.FindRequest{
+		Alias: ":beer:",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/emoji/flag/getFlagByCountryCode/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Get the flag for a country. Requires country code e.g GB for great britain
+func main() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Flag(&emoji.FlagRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/emoji/print/printTextIncludingEmoji/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Print text and renders the emojis with aliases e.g
+// let's grab a :beer: becomes let's grab a 🍺
+func main() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Print(&emoji.PrintRequest{
+		Text: "let's grab a :beer:",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/emoji/send/sendATextContainingAnEmojiToAnyoneViaSms/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Send an emoji to anyone via SMS. Messages are sent in the form '<message> Sent from <from>'
+func main() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Send(&emoji.SendRequest{
+		From:    "Alice",
+		Message: "let's grab a :beer:",
+		To:      "+44782669123",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/evchargers/README.md

@@ -4,6 +4,33 @@ 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
@@ -33,6 +60,7 @@ Location: &evchargers.Coordinates{
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Search
@@ -61,6 +89,7 @@ func SearchByBoundingBox() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Search
@@ -93,31 +122,6 @@ 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/evchargers/referenceData/getReferenceData/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/evchargers"
+)
+
+// Retrieve reference data as used by this API and in conjunction with the Search endpoint
+func main() {
+	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := evchargersService.ReferenceData(&evchargers.ReferenceDataRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/evchargers/search/searchByBoundingBox/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/evchargers"
+)
+
+// Search by giving a coordinate and a max distance, or bounding box and optional filters
+func main() {
+	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := evchargersService.Search(&evchargers.SearchRequest{
+		Box: &evchargers.BoundingBox{},
+	})
+	fmt.Println(rsp, err)
+
+}

examples/evchargers/search/searchByLocation/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/evchargers"
+)
+
+// Search by giving a coordinate and a max distance, or bounding box and optional filters
+func main() {
+	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := evchargersService.Search(&evchargers.SearchRequest{
+		Distance: 2000,
+		Location: &evchargers.Coordinates{
+			Latitude:  51.53336351319885,
+			Longitude: -0.0252,
+		},
+	})
+	fmt.Println(rsp, err)
+
+}

examples/evchargers/search/searchWithFiltersFastChargersOnly/main.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/evchargers"
+)
+
+// Search by giving a coordinate and a max distance, or bounding box and optional filters
+func main() {
+	evchargersService := evchargers.NewEvchargersService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := evchargersService.Search(&evchargers.SearchRequest{
+		Distance: 2000,
+		Levels:   []string{"3"},
+		Location: &evchargers.Coordinates{
+			Latitude:  51.53336351319885,
+			Longitude: -0.0252,
+		},
+	})
+	fmt.Println(rsp, err)
+
+}

examples/event/README.md

@@ -0,0 +1,108 @@
+# 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 event 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 event to the event stream.
+func PublishAnEvent() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Publish(&event.PublishRequest{
+		Message: map[string]interface{}{
+	"user": "john",
+	"id": "1",
+	"type": "signup",
+},
+Topic: "user",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Consume
+
+Consume events from a given topic.
+
+
+[https://m3o.com/event/api#Consume](https://m3o.com/event/api#Consume)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Consume events from a given topic.
+func ConsumeFromAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	
+	stream, err := eventService.Consume(&event.ConsumeRequest{
+		Topic: "user",
+
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
+}
+```
+## Read
+
+Read stored events
+
+
+[https://m3o.com/event/api#Read](https://m3o.com/event/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Read stored events
+func ReadEventsOnAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Read(&event.ReadRequest{
+		Topic: "user",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/event/consume/consumeFromATopic.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Consume events from a given topic.
+func ConsumeFromAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Consume(&event.ConsumeRequest{
+		Topic: "user",
+	})
+	fmt.Println(rsp, err)
+}

examples/event/consume/consumeFromATopic/main.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Consume events from a given topic.
+func main() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+
+	stream, err := eventService.Consume(&event.ConsumeRequest{
+		Topic: "user",
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+		rsp, err := stream.Recv()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+
+		fmt.Println(rsp)
+	}
+}

examples/event/publish/publishAMessage.go

@@ -0,0 +1,22 @@
+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{}{
+			"id":   "1",
+			"type": "signup",
+			"user": "john",
+		},
+		Topic: "user",
+	})
+	fmt.Println(rsp, err)
+}

examples/event/publish/publishAnEvent.go

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

examples/event/publish/publishAnEvent/main.go

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

examples/event/read/readEventsOnATopic.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Read stored events
+func ReadEventsOnAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Read(&event.ReadRequest{
+		Topic: "user",
+	})
+	fmt.Println(rsp, err)
+}

examples/event/read/readEventsOnATopic/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Read stored events
+func main() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Read(&event.ReadRequest{
+		Topic: "user",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/event/subscribe/subscribeToATopic.go

@@ -0,0 +1,17 @@
+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,34 +4,6 @@ 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
@@ -58,6 +30,7 @@ Project: "examples",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Save
@@ -89,6 +62,7 @@ func SaveFile() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## List
@@ -116,5 +90,35 @@ 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)
+	
 }
 ```

examples/file/delete/deleteFile/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Delete a file by project name/path
+func main() {
+	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)
+
+}

examples/file/list/listFiles/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// List files by their project and optionally a path.
+func main() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.List(&file.ListRequest{
+		Project: "examples",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/file/read/readFile/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Read a file by path
+func main() {
+	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/file/save/saveFile/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Save a file
+func main() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.Save(&file.SaveRequest{
+		File: &file.Record{
+			Content: "file content example",
+			Path:    "/document/text-files/file.txt",
+			Project: "examples",
+		},
+	})
+	fmt.Println(rsp, err)
+
+}

examples/forex/README.md

@@ -29,6 +29,7 @@ func GetAnFxPrice() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Quote
@@ -56,6 +57,7 @@ func GetAfxQuote() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## History
@@ -83,5 +85,6 @@ func GetPreviousClose() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/forex/history/getPreviousClose/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Returns the data for the previous close
+func main() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.History(&forex.HistoryRequest{
+		Symbol: "GBPUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/forex/price/getAnFxPrice/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Get the latest price for a given forex ticker
+func main() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.Price(&forex.PriceRequest{
+		Symbol: "GBPUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/forex/quote/getAFxQuote/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Get the latest quote for the forex
+func main() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.Quote(&forex.QuoteRequest{
+		Symbol: "GBPUSD",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/function/README.md

@@ -4,88 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
-## List
-
-List all the deployed functions
-
-
-[https://m3o.com/function/api#List](https://m3o.com/function/api#List)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// List all the deployed functions
-func ListFunctions() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.List(&function.ListRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Delete
-
-Delete a function by name
-
-
-[https://m3o.com/function/api#Delete](https://m3o.com/function/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Delete a function by name
-func DeleteAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Delete(&function.DeleteRequest{
-		Name: "my-first-func",
-Project: "tests",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Describe
-
-Get the info for a deployed function
-
-
-[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Get the info for a deployed function
-func DescribeFunctionStatus() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Describe(&function.DescribeRequest{
-		Name: "my-first-func",
-Project: "tests",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Deploy
 
 Deploy a group of functions
@@ -115,6 +33,7 @@ Runtime: "nodejs14",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Call
@@ -144,5 +63,91 @@ Request: map[string]interface{}{
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List all the deployed functions
+
+
+[https://m3o.com/function/api#List](https://m3o.com/function/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// List all the deployed functions
+func ListFunctions() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.List(&function.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete a function by name
+
+
+[https://m3o.com/function/api#Delete](https://m3o.com/function/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Delete a function by name
+func DeleteAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Delete(&function.DeleteRequest{
+		Name: "my-first-func",
+Project: "tests",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Describe
+
+Get the info for a deployed function
+
+
+[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Get the info for a deployed function
+func DescribeFunctionStatus() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Describe(&function.DescribeRequest{
+		Name: "my-first-func",
+Project: "tests",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/function/call/callAFunction/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Call a function by name
+func main() {
+	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/function/delete/deleteAFunction/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Delete a function by name
+func main() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Delete(&function.DeleteRequest{
+		Name:    "my-first-func",
+		Project: "tests",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/function/deploy/deployAFunction/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Deploy a group of functions
+func main() {
+	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)
+
+}

examples/function/describe/describeFunctionStatus/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Get the info for a deployed function
+func main() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Describe(&function.DescribeRequest{
+		Name:    "my-first-func",
+		Project: "tests",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/function/list/listFunctions/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// List all the deployed functions
+func main() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.List(&function.ListRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/geocoding/README.md

@@ -32,6 +32,7 @@ Postcode: "wc2b",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Reverse
@@ -60,5 +61,6 @@ Longitude: -0.1216235,
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/geocoding/lookup/geocodeAnAddress/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/geocoding"
+)
+
+// Lookup returns a geocoded address including normalized address and gps coordinates. All fields are optional, provide more to get more accurate results
+func main() {
+	geocodingService := geocoding.NewGeocodingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := geocodingService.Lookup(&geocoding.LookupRequest{
+		Address:  "10 russell st",
+		City:     "london",
+		Country:  "uk",
+		Postcode: "wc2b",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/geocoding/reverse/reverseGeocodeLocation/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/geocoding"
+)
+
+// Reverse lookup an address from gps coordinates
+func main() {
+	geocodingService := geocoding.NewGeocodingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := geocodingService.Reverse(&geocoding.ReverseRequest{
+		Latitude:  51.5123064,
+		Longitude: -0.1216235,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/gifs/README.md

@@ -30,5 +30,6 @@ Query: "dogs",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/gifs/search/search/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/gifs"
+)
+
+// Search for a GIF
+func main() {
+	gifsService := gifs.NewGifsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := gifsService.Search(&gifs.SearchRequest{
+		Limit: 2,
+		Query: "dogs",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/google/README.md

@@ -29,5 +29,6 @@ func SearchForVideos() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/google/search/searchForVideos/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/google"
+)
+
+// Search for videos on Google
+func main() {
+	googleService := google.NewGoogleService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := googleService.Search(&google.SearchRequest{
+		Query: "how to make donuts",
+	})
+	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:
 
-## Stream
-
-Stream returns a stream of "Hello $name" responses
-
-
-[https://m3o.com/helloworld/api#Stream](https://m3o.com/helloworld/api#Stream)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/helloworld"
-)
-
-// Stream returns a stream of "Hello $name" responses
-func StreamsAreCurrentlyTemporarilyNotSupportedInClients() {
-	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := helloworldService.Stream(&helloworld.StreamRequest{
-		Name: "not supported",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Call
 
 Call returns a personalised "Hello $name" response
@@ -56,5 +29,48 @@ func CallTheHelloworldService() {
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Stream
+
+Stream returns a stream of "Hello $name" responses
+
+
+[https://m3o.com/helloworld/api#Stream](https://m3o.com/helloworld/api#Stream)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Stream returns a stream of "Hello $name" responses
+func StreamsResponsesFromTheServerUsingWebsockets() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+	
+	stream, err := helloworldService.Stream(&helloworld.StreamRequest{
+		Messages: 10,
+Name: "John",
+
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
 }
 ```

examples/helloworld/call/callTheHelloworldService/main.go

@@ -0,0 +1,18 @@
+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)
+
+}

examples/helloworld/stream/streamsAreCurrentlyTemporarilyNotSupportedInClients/main.go

@@ -0,0 +1,31 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Stream returns a stream of "Hello $name" responses
+func main() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+
+	stream, err := helloworldService.Stream(&helloworld.StreamRequest{
+		Name: "not supported",
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+		rsp, err := stream.Recv()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+
+		fmt.Println(rsp)
+	}
+}

examples/helloworld/stream/streamsResponsesFromTheServerUsingWebsockets/main.go

@@ -0,0 +1,32 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Stream returns a stream of "Hello $name" responses
+func main() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+
+	stream, err := helloworldService.Stream(&helloworld.StreamRequest{
+		Messages: 10,
+		Name:     "John",
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+		rsp, err := stream.Recv()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+
+		fmt.Println(rsp)
+	}
+}

examples/holidays/README.md

@@ -4,6 +4,33 @@ 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
@@ -29,31 +56,6 @@ 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/holidays/countries/listCountries/main.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/holidays"
+)
+
+// Get the list of countries that are supported by this API
+func main() {
+	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := holidaysService.Countries(&holidays.CountriesRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/holidays/list/getHolidays/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/holidays"
+)
+
+// List the holiday dates for a given country and year
+func main() {
+	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := holidaysService.List(&holidays.ListRequest{
+		Year: 2022,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/id/README.md

@@ -29,6 +29,7 @@ func GenerateAuniqueId() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Generate
@@ -56,6 +57,7 @@ func GenerateAshortId() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Generate
@@ -83,6 +85,7 @@ func GenerateAsnowflakeId() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Generate
@@ -110,6 +113,7 @@ func GenerateAbigflakeId() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Types
@@ -136,5 +140,6 @@ func ListTheTypesOfIdsAvailable() {
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```