Commit from m3o/m3o action

Add Discord banner to README

.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

README.md

@@ -1,9 +1,21 @@
+<p align="center">
+	<a href="https://discord.gg/TBR9bRjd6Z">
+		<img src="https://discordapp.com/api/guilds/861917584437805127/widget.png?style=banner2" alt="Discord Banner"/>
+	</a>
+</p>
+
+---
+
 # M3O Go Client [![godoc](https://godoc.org/github.com/m3o/m3o-go?status.svg)](https://godoc.org/github.com/m3o/m3o-go) [![Go Report Card](https://goreportcard.com/badge/github.com/m3o/m3o-go)](https://goreportcard.com/report/github.com/m3o/m3o-go) [![Apache 2.0 License](https://img.shields.io/github/license/m3o/m3o-go)](https://github.com/m3o/m3o-go/blob/master/LICENSE)
 
 This is the Go client to access APIs on the M3O Platform
 
 ## Usage
 
+Call a service using the generated client. Populate the `M3O_API_TOKEN` environment variable. 
+
+Import the package and initialise the service with your API token.
+
 ```go
 package main
 
@@ -11,7 +23,32 @@ import (
         "fmt"
         "os"
 
-    "github.com/m3o/m3o-go/client"
+        "go.m3o.com/helloworld"
+)
+
+// Call returns a personalised "Hello $name" response
+func main() {
+        helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+        rsp, err := helloworldService.Call(&helloworld.CallRequest{
+                Name: "John",
+
+        })
+        fmt.Println(rsp, err)
+}
+```
+
+## Generic Client
+
+The generic client enables you to call any endpoint by name with freeform request/response types.
+
+```go
+package main
+
+import (
+    "fmt"
+    "os"
+
+    "go.m3o.com/client"
 )
 
 type Request struct {
@@ -49,7 +86,7 @@ func main() {
 
 ## Streaming
 
-The client supports streaming
+The client supports streaming but is not yet code generated. Use the following for streaming endpoints.
  
 ```go
 package main
@@ -57,7 +94,7 @@ package main
 import (
 	"fmt"
 
-	"github.com/m3o/m3o-go/client"
+	"go.m3o.com/client"
 )
 
 type Request struct {

address/address.go

@@ -4,6 +4,10 @@ import (
 	"go.m3o.com/client"
 )
 
+type Address interface {
+	LookupPostcode(*LookupPostcodeRequest) (*LookupPostcodeResponse, error)
+}
+
 func NewAddressService(token string) *AddressService {
 	return &AddressService{
 		client: client.NewClient(&client.Options{
@@ -18,8 +22,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 {
@@ -33,13 +39,13 @@ type LookupPostcodeResponse struct {
 
 type Record struct {
 	// building name
-	BuildingName string `json:"buildingName"`
+	BuildingName string `json:"building_name"`
 	// the county
 	County string `json:"county"`
 	// line one of address
-	LineOne string `json:"lineOne"`
+	LineOne string `json:"line_one"`
 	// line two of address
-	LineTwo string `json:"lineTwo"`
+	LineTwo string `json:"line_two"`
 	// dependent locality
 	Locality string `json:"locality"`
 	// organisation if present

answer/answer.go

@@ -4,6 +4,10 @@ import (
 	"go.m3o.com/client"
 )
 
+type Answer interface {
+	Question(*QuestionRequest) (*QuestionResponse, error)
+}
+
 func NewAnswerService(token string) *AnswerService {
 	return &AnswerService{
 		client: client.NewClient(&client.Options{
@@ -18,8 +22,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 {

app/app.go

@@ -0,0 +1,215 @@
+package app
+
+import (
+	"go.m3o.com/client"
+)
+
+type App interface {
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	List(*ListRequest) (*ListResponse, error)
+	Regions(*RegionsRequest) (*RegionsResponse, error)
+	Reserve(*ReserveRequest) (*ReserveResponse, error)
+	Resolve(*ResolveRequest) (*ResolveResponse, error)
+	Run(*RunRequest) (*RunResponse, error)
+	Status(*StatusRequest) (*StatusResponse, error)
+	Update(*UpdateRequest) (*UpdateResponse, error)
+}
+
+func NewAppService(token string) *AppService {
+	return &AppService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type AppService struct {
+	client *client.Client
+}
+
+// Delete an app
+func (t *AppService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
+	rsp := &DeleteResponse{}
+	return rsp, t.client.Call("app", "Delete", request, rsp)
+
+}
+
+// List all the apps
+func (t *AppService) List(request *ListRequest) (*ListResponse, error) {
+
+	rsp := &ListResponse{}
+	return rsp, t.client.Call("app", "List", request, rsp)
+
+}
+
+// Return the support regions
+func (t *AppService) Regions(request *RegionsRequest) (*RegionsResponse, error) {
+
+	rsp := &RegionsResponse{}
+	return rsp, t.client.Call("app", "Regions", request, rsp)
+
+}
+
+// Reserve apps beyond the free quota. Call Run after.
+func (t *AppService) Reserve(request *ReserveRequest) (*ReserveResponse, error) {
+
+	rsp := &ReserveResponse{}
+	return rsp, t.client.Call("app", "Reserve", request, rsp)
+
+}
+
+// Resolve an app by id to its raw backend endpoint
+func (t *AppService) Resolve(request *ResolveRequest) (*ResolveResponse, error) {
+
+	rsp := &ResolveResponse{}
+	return rsp, t.client.Call("app", "Resolve", request, rsp)
+
+}
+
+// Run an app from source
+func (t *AppService) Run(request *RunRequest) (*RunResponse, error) {
+
+	rsp := &RunResponse{}
+	return rsp, t.client.Call("app", "Run", request, rsp)
+
+}
+
+// Get the status of an app
+func (t *AppService) Status(request *StatusRequest) (*StatusResponse, error) {
+
+	rsp := &StatusResponse{}
+	return rsp, t.client.Call("app", "Status", request, rsp)
+
+}
+
+// Update the app. The latest source code will be downloaded, built and deployed.
+func (t *AppService) Update(request *UpdateRequest) (*UpdateResponse, error) {
+
+	rsp := &UpdateResponse{}
+	return rsp, t.client.Call("app", "Update", request, rsp)
+
+}
+
+type DeleteRequest struct {
+	// name of the app
+	Name string `json:"name"`
+}
+
+type DeleteResponse struct {
+}
+
+type ListRequest struct {
+}
+
+type ListResponse struct {
+	// all the apps
+	Services []Service `json:"services"`
+}
+
+type RegionsRequest struct {
+}
+
+type RegionsResponse struct {
+	Regions []string `json:"regions"`
+}
+
+type Reservation struct {
+	// time of reservation
+	Created string `json:"created"`
+	// time reservation expires
+	Expires string `json:"expires"`
+	// name of the app
+	Name string `json:"name"`
+	// owner id
+	Owner string `json:"owner"`
+	// associated token
+	Token string `json:"token"`
+}
+
+type ReserveRequest struct {
+	// name of your app e.g helloworld
+	Name string `json:"name"`
+}
+
+type ReserveResponse struct {
+	// The app reservation
+	Reservation *Reservation `json:"reservation"`
+}
+
+type ResolveRequest struct {
+	// the service id
+	Id string `json:"id"`
+}
+
+type ResolveResponse struct {
+	// the end provider url
+	Url string `json:"url"`
+}
+
+type RunRequest struct {
+	// branch. defaults to master
+	Branch string `json:"branch"`
+	// associated env vars to pass in
+	EnvVars map[string]string `json:"env_vars"`
+	// name of the app
+	Name string `json:"name"`
+	// port to run on
+	Port int32 `json:"port"`
+	// region to run in
+	Region string `json:"region"`
+	// source repository
+	Repo string `json:"repo"`
+}
+
+type RunResponse struct {
+	// The running service
+	Service *Service `json:"service"`
+}
+
+type Service struct {
+	// branch of code
+	Branch string `json:"branch"`
+	// time of creation
+	Created string `json:"created"`
+	// custom domains
+	CustomDomains string `json:"custom_domains"`
+	// associated env vars
+	EnvVars map[string]string `json:"env_vars"`
+	// unique id
+	Id string `json:"id"`
+	// name of the app
+	Name string `json:"name"`
+	// port running on
+	Port int32 `json:"port"`
+	// region running in
+	Region string `json:"region"`
+	// source repository
+	Repo string `json:"repo"`
+	// status of the app
+	Status string `json:"status"`
+	// last updated
+	Updated string `json:"updated"`
+	// app url
+	Url string `json:"url"`
+}
+
+type StatusRequest struct {
+	// name of the app
+	Name string `json:"name"`
+}
+
+type StatusResponse struct {
+	// running service info
+	Service *Service `json:"service"`
+}
+
+type UpdateRequest struct {
+	// Additional env vars to update
+	EnvVars map[string]string `json:"env_vars"`
+	// name of the app
+	Name string `json:"name"`
+}
+
+type UpdateResponse struct {
+}

avatar/avatar.go

@@ -0,0 +1,49 @@
+package avatar
+
+import (
+	"go.m3o.com/client"
+)
+
+type Avatar interface {
+	Generate(*GenerateRequest) (*GenerateResponse, error)
+}
+
+func NewAvatarService(token string) *AvatarService {
+	return &AvatarService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type AvatarService struct {
+	client *client.Client
+}
+
+// Generate an unique avatar
+func (t *AvatarService) Generate(request *GenerateRequest) (*GenerateResponse, error) {
+
+	rsp := &GenerateResponse{}
+	return rsp, t.client.Call("avatar", "Generate", request, rsp)
+
+}
+
+type GenerateRequest struct {
+	// encode format of avatar image: `png` or `jpeg`; default is `jpeg`
+	Format string `json:"format"`
+	// avatar's gender: `male` or `female`; default is `male`
+	Gender string `json:"gender"`
+	// set to true to upload to the M3O CDN and receive the url
+	Upload bool `json:"upload"`
+	// avatar's username, unique username will generate the unique avatar;
+	// if empty, every request generates a random avatar;
+	// if upload == true, username will be the CDN filename rather than a random uuid string
+	Username string `json:"username"`
+}
+
+type GenerateResponse struct {
+	// base64 encoded string of the avatar image
+	Base64 string `json:"base64"`
+	// M3O's CDN url of the avatar image
+	Url string `json:"url"`
+}

cache/cache.go

@@ -4,6 +4,15 @@ import (
 	"go.m3o.com/client"
 )
 
+type Cache interface {
+	Decrement(*DecrementRequest) (*DecrementResponse, error)
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	Get(*GetRequest) (*GetResponse, error)
+	Increment(*IncrementRequest) (*IncrementResponse, error)
+	ListKeys(*ListKeysRequest) (*ListKeysResponse, error)
+	Set(*SetRequest) (*SetResponse, error)
+}
+
 func NewCacheService(token string) *CacheService {
 	return &CacheService{
 		client: client.NewClient(&client.Options{
@@ -16,34 +25,52 @@ 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)
+
+}
+
+// List all the available keys
+func (t *CacheService) ListKeys(request *ListKeysRequest) (*ListKeysResponse, error) {
+
+	rsp := &ListKeysResponse{}
+	return rsp, t.client.Call("cache", "ListKeys", 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 {
@@ -98,6 +125,13 @@ type IncrementResponse struct {
 	Value int64 `json:"value,string"`
 }
 
+type ListKeysRequest struct {
+}
+
+type ListKeysResponse struct {
+	Keys []string `json:"keys"`
+}
+
 type SetRequest struct {
 	// The key to update
 	Key string `json:"key"`

carbon/carbon.go

@@ -0,0 +1,52 @@
+package carbon
+
+import (
+	"go.m3o.com/client"
+)
+
+type Carbon interface {
+	Offset(*OffsetRequest) (*OffsetResponse, error)
+}
+
+func NewCarbonService(token string) *CarbonService {
+	return &CarbonService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type CarbonService struct {
+	client *client.Client
+}
+
+// Purchase 1KG (0.001 tonne) of carbon offsets in a single request
+func (t *CarbonService) Offset(request *OffsetRequest) (*OffsetResponse, error) {
+
+	rsp := &OffsetResponse{}
+	return rsp, t.client.Call("carbon", "Offset", request, rsp)
+
+}
+
+type OffsetRequest struct {
+}
+
+type OffsetResponse struct {
+	// the metric used e.g KG or Tonnes
+	Metric string `json:"metric"`
+	// projects it was allocated to
+	Projects []Project `json:"projects"`
+	// number of tonnes
+	Tonnes float64 `json:"tonnes"`
+	// number of units purchased
+	Units int32 `json:"units"`
+}
+
+type Project struct {
+	// name of the project
+	Name string `json:"name"`
+	// percentage that went to this
+	Percentage float64 `json:"percentage"`
+	// amount in tonnes
+	Tonnes float64 `json:"tonnes"`
+}

chat/chat.go

@@ -0,0 +1,256 @@
+package chat
+
+import (
+	"go.m3o.com/client"
+)
+
+type Chat interface {
+	Create(*CreateRequest) (*CreateResponse, error)
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	History(*HistoryRequest) (*HistoryResponse, error)
+	Invite(*InviteRequest) (*InviteResponse, error)
+	Join(*JoinRequest) (*JoinResponseStream, error)
+	Kick(*KickRequest) (*KickResponse, error)
+	Leave(*LeaveRequest) (*LeaveResponse, error)
+	List(*ListRequest) (*ListResponse, error)
+	Send(*SendRequest) (*SendResponse, error)
+}
+
+func NewChatService(token string) *ChatService {
+	return &ChatService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type ChatService struct {
+	client *client.Client
+}
+
+// Create a new chat room
+func (t *ChatService) Create(request *CreateRequest) (*CreateResponse, error) {
+
+	rsp := &CreateResponse{}
+	return rsp, t.client.Call("chat", "Create", request, rsp)
+
+}
+
+// Delete a chat room
+func (t *ChatService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
+	rsp := &DeleteResponse{}
+	return rsp, t.client.Call("chat", "Delete", request, rsp)
+
+}
+
+// List the messages in a chat
+func (t *ChatService) History(request *HistoryRequest) (*HistoryResponse, error) {
+
+	rsp := &HistoryResponse{}
+	return rsp, t.client.Call("chat", "History", request, rsp)
+
+}
+
+// Invite a user to a chat room
+func (t *ChatService) Invite(request *InviteRequest) (*InviteResponse, error) {
+
+	rsp := &InviteResponse{}
+	return rsp, t.client.Call("chat", "Invite", request, rsp)
+
+}
+
+// Join a chat room
+func (t *ChatService) Join(request *JoinRequest) (*JoinResponseStream, error) {
+	stream, err := t.client.Stream("chat", "Join", request)
+	if err != nil {
+		return nil, err
+	}
+	return &JoinResponseStream{
+		stream: stream,
+	}, nil
+
+}
+
+type JoinResponseStream struct {
+	stream *client.Stream
+}
+
+func (t *JoinResponseStream) Recv() (*JoinResponse, error) {
+	var rsp JoinResponse
+	if err := t.stream.Recv(&rsp); err != nil {
+		return nil, err
+	}
+	return &rsp, nil
+}
+
+// Kick a user from a chat room
+func (t *ChatService) Kick(request *KickRequest) (*KickResponse, error) {
+
+	rsp := &KickResponse{}
+	return rsp, t.client.Call("chat", "Kick", request, rsp)
+
+}
+
+// Leave a chat room
+func (t *ChatService) Leave(request *LeaveRequest) (*LeaveResponse, error) {
+
+	rsp := &LeaveResponse{}
+	return rsp, t.client.Call("chat", "Leave", request, rsp)
+
+}
+
+// List available chats
+func (t *ChatService) List(request *ListRequest) (*ListResponse, error) {
+
+	rsp := &ListResponse{}
+	return rsp, t.client.Call("chat", "List", request, rsp)
+
+}
+
+// Connect to a chat to receive a stream of messages
+// Send a message to a chat
+func (t *ChatService) Send(request *SendRequest) (*SendResponse, error) {
+
+	rsp := &SendResponse{}
+	return rsp, t.client.Call("chat", "Send", request, rsp)
+
+}
+
+type CreateRequest struct {
+	// chat description
+	Description string `json:"description"`
+	// name of the room
+	Name string `json:"name"`
+	// whether its a private room
+	Private bool `json:"private"`
+	// optional list of user ids
+	UserIds string `json:"user_ids"`
+}
+
+type CreateResponse struct {
+	// the unique chat room
+	Room *Room `json:"room"`
+}
+
+type DeleteRequest struct {
+	// the chat room id to delete
+	RoomId string `json:"room_id"`
+}
+
+type DeleteResponse struct {
+	Room *Room `json:"room"`
+}
+
+type HistoryRequest struct {
+	// the chat room id to get
+	RoomId string `json:"room_id"`
+}
+
+type HistoryResponse struct {
+	// messages in the chat room
+	Messages []Message `json:"messages"`
+}
+
+type InviteRequest struct {
+	// the room id
+	RoomId string `json:"room_id"`
+	// the user id
+	UserId string `json:"user_id"`
+}
+
+type InviteResponse struct {
+	Room *Room `json:"room"`
+}
+
+type JoinRequest struct {
+	// chat room to join
+	RoomId string `json:"room_id"`
+	// user id joining
+	UserId string `json:"user_id"`
+}
+
+type JoinResponse struct {
+	Message *Message `json:"message"`
+}
+
+type KickRequest struct {
+	// the chat room id
+	RoomId string `json:"room_id"`
+	// the user id
+	UserId string `json:"user_id"`
+}
+
+type KickResponse struct {
+	Room *Room `json:"room"`
+}
+
+type LeaveRequest struct {
+	// the chat room id
+	RoomId string `json:"room_id"`
+	// the user id
+	UserId string `json:"user_id"`
+}
+
+type LeaveResponse struct {
+	Room *Room `json:"room"`
+}
+
+type ListRequest struct {
+	// optional user id to filter by
+	UserId string `json:"user_id"`
+}
+
+type ListResponse struct {
+	Rooms []Room `json:"rooms"`
+}
+
+type Message struct {
+	// a client side id, should be validated by the server to make the request retry safe
+	Client string `json:"client"`
+	// id of the message, allocated by the server
+	Id string `json:"id"`
+	// id of the chat the message is being sent to / from
+	RoomId string `json:"room_id"`
+	// time the message was sent in RFC3339 format
+	SentAt string `json:"sent_at"`
+	// subject of the message
+	Subject string `json:"subject"`
+	// text of the message
+	Text string `json:"text"`
+	// id of the user who sent the message
+	UserId string `json:"user_id"`
+}
+
+type Room struct {
+	// time of creation
+	CreatedAt string `json:"created_at"`
+	// description of the that
+	Description string `json:"description"`
+	// unique room id
+	Id string `json:"id"`
+	// name of the chat
+	Name string `json:"name"`
+	// whether its a private room
+	Private bool `json:"private"`
+	// list of users
+	UserIds string `json:"user_ids"`
+}
+
+type SendRequest struct {
+	// a client side id, should be validated by the server to make the request retry safe
+	Client string `json:"client"`
+	// id of the chat room the message is being sent to / from
+	RoomId string `json:"room_id"`
+	// subject of the message
+	Subject string `json:"subject"`
+	// text of the message
+	Text string `json:"text"`
+	// id of the user who sent the message
+	UserId string `json:"user_id"`
+}
+
+type SendResponse struct {
+	// the message which was created
+	Message *Message `json:"message"`
+}

client/client_test.go

@@ -6,6 +6,10 @@ import (
 )
 
 func TestBasicCall(t *testing.T) {
+	if v := os.Getenv("IN_TRAVIS"); v == "yes" {
+		return
+	}
+
 	response := map[string]interface{}{}
 	if err := NewClient(&Options{
 		Token: os.Getenv("TOKEN"),

comments/comments.go

@@ -0,0 +1,162 @@
+package comments
+
+import (
+	"go.m3o.com/client"
+)
+
+type Comments interface {
+	Create(*CreateRequest) (*CreateResponse, error)
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	Events(*EventsRequest) (*EventsResponseStream, error)
+	List(*ListRequest) (*ListResponse, error)
+	Read(*ReadRequest) (*ReadResponse, error)
+	Update(*UpdateRequest) (*UpdateResponse, error)
+}
+
+func NewCommentsService(token string) *CommentsService {
+	return &CommentsService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type CommentsService struct {
+	client *client.Client
+}
+
+// Create a new comment
+func (t *CommentsService) Create(request *CreateRequest) (*CreateResponse, error) {
+
+	rsp := &CreateResponse{}
+	return rsp, t.client.Call("comments", "Create", request, rsp)
+
+}
+
+// Delete a comment
+func (t *CommentsService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
+	rsp := &DeleteResponse{}
+	return rsp, t.client.Call("comments", "Delete", request, rsp)
+
+}
+
+// Subscribe to comments events
+func (t *CommentsService) Events(request *EventsRequest) (*EventsResponseStream, error) {
+	stream, err := t.client.Stream("comments", "Events", request)
+	if err != nil {
+		return nil, err
+	}
+	return &EventsResponseStream{
+		stream: stream,
+	}, nil
+
+}
+
+type EventsResponseStream struct {
+	stream *client.Stream
+}
+
+func (t *EventsResponseStream) Recv() (*EventsResponse, error) {
+	var rsp EventsResponse
+	if err := t.stream.Recv(&rsp); err != nil {
+		return nil, err
+	}
+	return &rsp, nil
+}
+
+// List all the comments
+func (t *CommentsService) List(request *ListRequest) (*ListResponse, error) {
+
+	rsp := &ListResponse{}
+	return rsp, t.client.Call("comments", "List", request, rsp)
+
+}
+
+// Read a comment
+func (t *CommentsService) Read(request *ReadRequest) (*ReadResponse, error) {
+
+	rsp := &ReadResponse{}
+	return rsp, t.client.Call("comments", "Read", request, rsp)
+
+}
+
+// Update a comment
+func (t *CommentsService) Update(request *UpdateRequest) (*UpdateResponse, error) {
+
+	rsp := &UpdateResponse{}
+	return rsp, t.client.Call("comments", "Update", request, rsp)
+
+}
+
+type Comment struct {
+	// time at which the comment was created
+	Created string `json:"created"`
+	// unique id for the comment, generated if not specified
+	Id string `json:"id"`
+	// subject of the comment
+	Subject string `json:"subject"`
+	// text of the comment
+	Text string `json:"text"`
+	// time at which the comment was updated
+	Updated string `json:"updated"`
+}
+
+type CreateRequest struct {
+	// comment subject
+	Subject string `json:"subject"`
+	// comment items
+	Text string `json:"text"`
+}
+
+type CreateResponse struct {
+	// The created comment
+	Comment *Comment `json:"comment"`
+}
+
+type DeleteRequest struct {
+	// specify the id of the comment
+	Id string `json:"id"`
+}
+
+type DeleteResponse struct {
+	Comment *Comment `json:"comment"`
+}
+
+type EventsRequest struct {
+	// optionally specify a comment id
+	Id string `json:"id"`
+}
+
+type EventsResponse struct {
+	// the comment which the operation occured on
+	Comment *Comment `json:"comment"`
+	// the event which occured; create, delete, update
+	Event string `json:"event"`
+}
+
+type ListRequest struct {
+}
+
+type ListResponse struct {
+	// the comment of comments
+	Comments []Comment `json:"comments"`
+}
+
+type ReadRequest struct {
+	// the comment id
+	Id string `json:"id"`
+}
+
+type ReadResponse struct {
+	// The comment
+	Comment *Comment `json:"comment"`
+}
+
+type UpdateRequest struct {
+	Comment *Comment `json:"comment"`
+}
+
+type UpdateResponse struct {
+	Comment *Comment `json:"comment"`
+}

contact/contact.go

@@ -0,0 +1,200 @@
+package contact
+
+import (
+	"go.m3o.com/client"
+)
+
+type Contact interface {
+	Create(*CreateRequest) (*CreateResponse, error)
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	List(*ListRequest) (*ListResponse, error)
+	Read(*ReadRequest) (*ReadResponse, error)
+	Update(*UpdateRequest) (*UpdateResponse, error)
+}
+
+func NewContactService(token string) *ContactService {
+	return &ContactService{
+		client: client.NewClient(&client.Options{
+			Token: token,
+		}),
+	}
+}
+
+type ContactService struct {
+	client *client.Client
+}
+
+// Create a contact
+func (t *ContactService) Create(request *CreateRequest) (*CreateResponse, error) {
+
+	rsp := &CreateResponse{}
+	return rsp, t.client.Call("contact", "Create", request, rsp)
+
+}
+
+// Delete a contact
+func (t *ContactService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
+
+	rsp := &DeleteResponse{}
+	return rsp, t.client.Call("contact", "Delete", request, rsp)
+
+}
+
+// List contacts
+func (t *ContactService) List(request *ListRequest) (*ListResponse, error) {
+
+	rsp := &ListResponse{}
+	return rsp, t.client.Call("contact", "List", request, rsp)
+
+}
+
+// Read contact details
+func (t *ContactService) Read(request *ReadRequest) (*ReadResponse, error) {
+
+	rsp := &ReadResponse{}
+	return rsp, t.client.Call("contact", "Read", request, rsp)
+
+}
+
+// Update a contact
+func (t *ContactService) Update(request *UpdateRequest) (*UpdateResponse, error) {
+
+	rsp := &UpdateResponse{}
+	return rsp, t.client.Call("contact", "Update", request, rsp)
+
+}
+
+type Address struct {
+	// the label of the address
+	Label string `json:"label"`
+	// the address location
+	Location string `json:"location"`
+}
+
+type ContactInfo struct {
+	// the address
+	Addresses []Address `json:"addresses"`
+	// the birthday
+	Birthday string `json:"birthday"`
+	// create date string in RFC3339
+	CreatedAt string `json:"created_at"`
+	// the emails
+	Emails []Email `json:"emails"`
+	// contact id
+	Id string `json:"id"`
+	// the contact links
+	Links []Link `json:"links"`
+	// the contact name
+	Name string `json:"name"`
+	// note of the contact
+	Note string `json:"note"`
+	// the phone numbers
+	Phones []Phone `json:"phones"`
+	// the social media username
+	SocialMedias *SocialMedia `json:"social_medias"`
+	// update date string in RFC3339
+	UpdatedAt string `json:"updated_at"`
+}
+
+type CreateRequest struct {
+	// optional, location
+	Addresses []Address `json:"addresses"`
+	// optional, birthday
+	Birthday string `json:"birthday"`
+	// optional, emails
+	Emails []Email `json:"emails"`
+	// optional, links
+	Links []Link `json:"links"`
+	// required, the name of the contact
+	Name string `json:"name"`
+	// optional, note of the contact
+	Note string `json:"note"`
+	// optional, phone numbers
+	Phones []Phone `json:"phones"`
+	// optional, social media
+	SocialMedias *SocialMedia `json:"social_medias"`
+}
+
+type CreateResponse struct {
+	Contact *ContactInfo `json:"contact"`
+}
+
+type DeleteRequest struct {
+	// the id of the contact
+	Id string `json:"id"`
+}
+
+type DeleteResponse struct {
+}
+
+type Email struct {
+	// the email address
+	Address string `json:"address"`
+	// the label of the email
+	Label string `json:"label"`
+}
+
+type Link struct {
+	// the label of the link
+	Label string `json:"label"`
+	// the url of the contact
+	Url string `json:"url"`
+}
+
+type ListRequest struct {
+	// optional, default is 30
+	Limit int32 `json:"limit"`
+	// optional
+	Offset int32 `json:"offset"`
+}
+
+type ListResponse struct {
+	Contacts []ContactInfo `json:"contacts"`
+}
+
+type Phone struct {
+	// the label of the phone number
+	Label string `json:"label"`
+	// phone number
+	Number string `json:"number"`
+}
+
+type ReadRequest struct {
+	Id string `json:"id"`
+}
+
+type ReadResponse struct {
+	Contact *ContactInfo `json:"contact"`
+}
+
+type SocialMedia struct {
+	// the label of the social
+	Label string `json:"label"`
+	// the username of social media
+	Username string `json:"username"`
+}
+
+type UpdateRequest struct {
+	// optional, addresses
+	Addresses []Address `json:"addresses"`
+	// optional, birthday
+	Birthday string `json:"birthday"`
+	// optional, emails
+	Emails []Email `json:"emails"`
+	// required, the contact id
+	Id string `json:"id"`
+	// optional, links
+	Links []Link `json:"links"`
+	// required, the name
+	Name string `json:"name"`
+	// optional, note
+	Note string `json:"note"`
+	// optional, phone number
+	Phones []Phone `json:"phones"`
+	// optional, social media
+	SocialMedias *SocialMedia `json:"social_medias"`
+}
+
+type UpdateResponse struct {
+	Contact *ContactInfo `json:"contact"`
+}

crypto/crypto.go

@@ -4,6 +4,14 @@ import (
 	"go.m3o.com/client"
 )
 
+type Crypto interface {
+	History(*HistoryRequest) (*HistoryResponse, error)
+	News(*NewsRequest) (*NewsResponse, error)
+	Price(*PriceRequest) (*PriceResponse, error)
+	Quote(*QuoteRequest) (*QuoteResponse, error)
+	Symbols(*SymbolsRequest) (*SymbolsResponse, error)
+}
+
 func NewCryptoService(token string) *CryptoService {
 	return &CryptoService{
 		client: client.NewClient(&client.Options{
@@ -18,26 +26,42 @@ 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)
+
+}
+
+// Returns the full list of supported symbols
+func (t *CryptoService) Symbols(request *SymbolsRequest) (*SymbolsResponse, error) {
+
+	rsp := &SymbolsResponse{}
+	return rsp, t.client.Call("crypto", "Symbols", request, rsp)
+
 }
 
 type Article struct {
@@ -106,15 +130,27 @@ type QuoteRequest struct {
 
 type QuoteResponse struct {
 	// the asking price
-	AskPrice float64 `json:"askPrice"`
+	AskPrice float64 `json:"ask_price"`
 	// the ask size
-	AskSize float64 `json:"askSize"`
+	AskSize float64 `json:"ask_size"`
 	// the bidding price
-	BidPrice float64 `json:"bidPrice"`
+	BidPrice float64 `json:"bid_price"`
 	// the bid size
-	BidSize float64 `json:"bidSize"`
+	BidSize float64 `json:"bid_size"`
 	// the crypto symbol
 	Symbol string `json:"symbol"`
 	// the UTC timestamp of the quote
 	Timestamp string `json:"timestamp"`
 }
+
+type Symbol struct {
+	Name   string `json:"name"`
+	Symbol string `json:"symbol"`
+}
+
+type SymbolsRequest struct {
+}
+
+type SymbolsResponse struct {
+	Symbols []Symbol `json:"symbols"`
+}

currency/currency.go

@@ -4,6 +4,13 @@ import (
 	"go.m3o.com/client"
 )
 
+type Currency interface {
+	Codes(*CodesRequest) (*CodesResponse, error)
+	Convert(*ConvertRequest) (*ConvertResponse, error)
+	History(*HistoryRequest) (*HistoryResponse, error)
+	Rates(*RatesRequest) (*RatesResponse, error)
+}
+
 func NewCurrencyService(token string) *CurrencyService {
 	return &CurrencyService{
 		client: client.NewClient(&client.Options{
@@ -18,26 +25,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

@@ -4,6 +4,18 @@ import (
 	"go.m3o.com/client"
 )
 
+type Db interface {
+	Count(*CountRequest) (*CountResponse, error)
+	Create(*CreateRequest) (*CreateResponse, error)
+	Delete(*DeleteRequest) (*DeleteResponse, error)
+	DropTable(*DropTableRequest) (*DropTableResponse, error)
+	ListTables(*ListTablesRequest) (*ListTablesResponse, error)
+	Read(*ReadRequest) (*ReadResponse, error)
+	RenameTable(*RenameTableRequest) (*RenameTableResponse, error)
+	Truncate(*TruncateRequest) (*TruncateResponse, error)
+	Update(*UpdateRequest) (*UpdateResponse, error)
+}
+
 func NewDbService(token string) *DbService {
 	return &DbService{
 		client: client.NewClient(&client.Options{
@@ -18,38 +30,74 @@ 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)
+
+}
+
+// Drop a table in the DB
+func (t *DbService) DropTable(request *DropTableRequest) (*DropTableResponse, error) {
+
+	rsp := &DropTableResponse{}
+	return rsp, t.client.Call("db", "DropTable", request, rsp)
+
+}
+
+// List tables in the DB
+func (t *DbService) ListTables(request *ListTablesRequest) (*ListTablesResponse, error) {
+
+	rsp := &ListTablesResponse{}
+	return rsp, t.client.Call("db", "ListTables", 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)
+
+}
+
+// Rename a table
+func (t *DbService) RenameTable(request *RenameTableRequest) (*RenameTableResponse, error) {
+
+	rsp := &RenameTableResponse{}
+	return rsp, t.client.Call("db", "RenameTable", 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 {
@@ -63,6 +111,8 @@ type CountResponse struct {
 }
 
 type CreateRequest struct {
+	// optional record id to use
+	Id string `json:"id"`
 	// JSON encoded record or records (can be array or object)
 	Record map[string]interface{} `json:"record"`
 	// Optional table name. Defaults to 'default'
@@ -84,6 +134,21 @@ type DeleteRequest struct {
 type DeleteResponse struct {
 }
 
+type DropTableRequest struct {
+	Table string `json:"table"`
+}
+
+type DropTableResponse struct {
+}
+
+type ListTablesRequest struct {
+}
+
+type ListTablesResponse struct {
+	// list of tables
+	Tables []string `json:"tables"`
+}
+
 type ReadRequest struct {
 	// Read by id. Equivalent to 'id == "your-id"'
 	Id string `json:"id"`
@@ -110,14 +175,21 @@ type ReadResponse struct {
 	Records []map[string]interface{} `json:"records"`
 }
 
+type RenameTableRequest struct {
+	// current table name
+	From string `json:"from"`
+	// new table name
+	To string `json:"to"`
+}
+
+type RenameTableResponse struct {
+}
+
 type TruncateRequest struct {
-	// Optional table name. Defaults to 'default'
 	Table string `json:"table"`
 }
 
 type TruncateResponse struct {
-	// The table truncated
-	Table string `json:"table"`
 }
 
 type UpdateRequest struct {

email/email.go

@@ -4,6 +4,12 @@ import (
 	"go.m3o.com/client"
 )
 
+type Email interface {
+	Parse(*ParseRequest) (*ParseResponse, error)
+	Send(*SendRequest) (*SendResponse, error)
+	Validate(*ValidateRequest) (*ValidateResponse, error)
+}
+
 func NewEmailService(token string) *EmailService {
 	return &EmailService{
 		client: client.NewClient(&client.Options{
@@ -16,26 +22,64 @@ type EmailService struct {
 	client *client.Client
 }
 
+// Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
+func (t *EmailService) Parse(request *ParseRequest) (*ParseResponse, error) {
+
+	rsp := &ParseResponse{}
+	return rsp, t.client.Call("email", "Parse", request, rsp)
+
+}
+
 // 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)
+
+}
+
+// Validate an email address format
+func (t *EmailService) Validate(request *ValidateRequest) (*ValidateResponse, error) {
+
+	rsp := &ValidateResponse{}
+	return rsp, t.client.Call("email", "Validate", request, rsp)
+
+}
+
+type ParseRequest struct {
+	// The address to parse. Can be of the format "Joe Blogs <joe@example.com>" or "joe@example.com"
+	Address string `json:"address"`
+}
+
+type ParseResponse struct {
+	// the email address
+	Address string `json:"address"`
+	// associated name e.g Joe Blogs
+	Name string `json:"name"`
 }
 
 type SendRequest struct {
 	// the display name of the sender
 	From string `json:"from"`
 	// the html body
-	HtmlBody string `json:"htmlBody"`
+	HtmlBody string `json:"html_body"`
 	// an optional reply to email address
-	ReplyTo string `json:"replyTo"`
+	ReplyTo string `json:"reply_to"`
 	// the email subject
 	Subject string `json:"subject"`
 	// the text body
-	TextBody string `json:"textBody"`
+	TextBody string `json:"text_body"`
 	// the email address of the recipient
 	To string `json:"to"`
 }
 
 type SendResponse struct {
 }
+
+type ValidateRequest struct {
+	Address string `json:"address"`
+}
+
+type ValidateResponse struct {
+	IsValid bool `json:"is_valid"`
+}

emoji/emoji.go

@@ -4,6 +4,12 @@ import (
 	"go.m3o.com/client"
 )
 
+type Emoji interface {
+	Find(*FindRequest) (*FindResponse, error)
+	Flag(*FlagRequest) (*FlagResponse, error)
+	Print(*PrintRequest) (*PrintResponse, error)
+}
+
 func NewEmojiService(token string) *EmojiService {
 	return &EmojiService{
 		client: client.NewClient(&client.Options{
@@ -18,27 +24,27 @@ 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 {
@@ -70,17 +76,3 @@ type PrintResponse struct {
 	// text with rendered emojis
 	Text string `json:"text"`
 }
-
-type SendRequest struct {
-	// the name of the sender from e.g Alice
-	From string `json:"from"`
-	// message to send including emoji aliases
-	Message string `json:"message"`
-	// phone number to send to (including international dialing code)
-	To string `json:"to"`
-}
-
-type SendResponse struct {
-	// whether or not it succeeded
-	Success bool `json:"success"`
-}

evchargers/evchargers.go

@@ -4,6 +4,11 @@ import (
 	"go.m3o.com/client"
 )
 
+type Evchargers interface {
+	ReferenceData(*ReferenceDataRequest) (*ReferenceDataResponse, error)
+	Search(*SearchRequest) (*SearchResponse, error)
+}
+
 func NewEvchargersService(token string) *EvchargersService {
 	return &EvchargersService{
 		client: client.NewClient(&client.Options{
@@ -18,62 +23,66 @@ 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 {
 	// Any comments about how to access the charger
-	AccessComments  string       `json:"accessComments"`
-	AddressLine1    string       `json:"addressLine1"`
-	AddressLine2    string       `json:"addressLine2"`
+	AccessComments  string       `json:"access_comments"`
+	AddressLine1    string       `json:"address_line_1"`
+	AddressLine2    string       `json:"address_line_2"`
 	Country         *Country     `json:"country"`
-	CountryId       string       `json:"countryId"`
-	LatLng          string       `json:"latLng"`
+	CountryId       string       `json:"country_id"`
+	LatLng          string       `json:"lat_lng"`
 	Location        *Coordinates `json:"location"`
 	Postcode        string       `json:"postcode"`
-	StateOrProvince string       `json:"stateOrProvince"`
+	StateOrProvince string       `json:"state_or_province"`
 	Title           string       `json:"title"`
 	Town            string       `json:"town"`
 }
 
 type BoundingBox struct {
-	BottomLeft *Coordinates `json:"bottomLeft"`
-	TopRight   *Coordinates `json:"topRight"`
+	BottomLeft *Coordinates `json:"bottom_left"`
+	TopRight   *Coordinates `json:"top_right"`
 }
 
 type ChargerType struct {
 	Comments string `json:"comments"`
 	Id       string `json:"id"`
 	// Is this 40KW+
-	IsFastChargeCapable bool   `json:"isFastChargeCapable"`
+	IsFastChargeCapable bool   `json:"is_fast_charge_capable"`
 	Title               string `json:"title"`
 }
 
 type CheckinStatusType struct {
 	Id          string `json:"id"`
-	IsAutomated bool   `json:"isAutomated"`
-	IsPositive  bool   `json:"isPositive"`
+	IsAutomated bool   `json:"is_automated"`
+	IsPositive  bool   `json:"is_positive"`
 	Title       string `json:"title"`
 }
 
 type Connection struct {
 	// The amps offered
 	Amps           float64         `json:"amps"`
-	ConnectionType *ConnectionType `json:"connectionType"`
+	ConnectionType *ConnectionType `json:"connection_type"`
 	// The ID of the connection type
-	ConnectionTypeId string `json:"connectionTypeId"`
+	ConnectionTypeId string `json:"connection_type_id"`
 	// The current
 	Current string       `json:"current"`
 	Level   *ChargerType `json:"level"`
 	// The level of charging power available
-	LevelId string `json:"levelId"`
+	LevelId string `json:"level_id"`
 	// The power in KW
 	Power     float64 `json:"power"`
 	Reference string  `json:"reference"`
@@ -82,10 +91,10 @@ type Connection struct {
 }
 
 type ConnectionType struct {
-	FormalName     string `json:"formalName"`
+	FormalName     string `json:"formal_name"`
 	Id             string `json:"id"`
-	IsDiscontinued bool   `json:"isDiscontinued"`
-	IsObsolete     bool   `json:"isObsolete"`
+	IsDiscontinued bool   `json:"is_discontinued"`
+	IsObsolete     bool   `json:"is_obsolete"`
 	Title          string `json:"title"`
 }
 
@@ -95,9 +104,9 @@ type Coordinates struct {
 }
 
 type Country struct {
-	ContinentCode string `json:"continentCode"`
+	ContinentCode string `json:"continent_code"`
 	Id            string `json:"id"`
-	IsoCode       string `json:"isoCode"`
+	IsoCode       string `json:"iso_code"`
 	Title         string `json:"title"`
 }
 
@@ -109,7 +118,7 @@ type CurrentType struct {
 
 type DataProvider struct {
 	Comments               string                  `json:"comments"`
-	DataProviderStatusType *DataProviderStatusType `json:"dataProviderStatusType"`
+	DataProviderStatusType *DataProviderStatusType `json:"data_provider_status_type"`
 	Id                     string                  `json:"id"`
 	// How is this data licensed
 	License string `json:"license"`
@@ -119,19 +128,19 @@ type DataProvider struct {
 
 type DataProviderStatusType struct {
 	Id                string `json:"id"`
-	IsProviderEnabled bool   `json:"isProviderEnabled"`
+	IsProviderEnabled bool   `json:"is_provider_enabled"`
 	Title             string `json:"title"`
 }
 
 type Operator struct {
 	Comments         string `json:"comments"`
-	ContactEmail     string `json:"contactEmail"`
-	FaultReportEmail string `json:"faultReportEmail"`
+	ContactEmail     string `json:"contact_email"`
+	FaultReportEmail string `json:"fault_report_email"`
 	Id               string `json:"id"`
 	// Is this operator a private individual vs a company
-	IsPrivateIndividual bool   `json:"isPrivateIndividual"`
-	PhonePrimary        string `json:"phonePrimary"`
-	PhoneSecondary      string `json:"phoneSecondary"`
+	IsPrivateIndividual bool   `json:"is_private_individual"`
+	PhonePrimary        string `json:"phone_primary"`
+	PhoneSecondary      string `json:"phone_secondary"`
 	Title               string `json:"title"`
 	Website             string `json:"website"`
 }
@@ -144,19 +153,19 @@ type Poi struct {
 	// The cost of charging
 	Cost string `json:"cost"`
 	// The ID of the data provider
-	DataProviderId string `json:"dataProviderId"`
+	DataProviderId string `json:"data_provider_id"`
 	// The ID of the charger
 	Id string `json:"id"`
 	// The number of charging points
-	NumPoints int64 `json:"numPoints,string"`
+	NumPoints int64 `json:"num_points,string"`
 	// The operator
 	Operator *Operator `json:"operator"`
 	// The ID of the operator of the charger
-	OperatorId string `json:"operatorId"`
+	OperatorId string `json:"operator_id"`
 	// The type of usage
-	UsageType *UsageType `json:"usageType"`
+	UsageType *UsageType `json:"usage_type"`
 	// The type of usage for this charger point (is it public, membership required, etc)
-	UsageTypeId string `json:"usageTypeId"`
+	UsageTypeId string `json:"usage_type_id"`
 }
 
 type ReferenceDataRequest struct {
@@ -164,36 +173,36 @@ type ReferenceDataRequest struct {
 
 type ReferenceDataResponse struct {
 	// The types of charger
-	ChargerTypes *ChargerType `json:"chargerTypes"`
+	ChargerTypes *ChargerType `json:"charger_types"`
 	// The types of checkin status
-	CheckinStatusTypes *CheckinStatusType `json:"checkinStatusTypes"`
+	CheckinStatusTypes *CheckinStatusType `json:"checkin_status_types"`
 	// The types of connection
-	ConnectionTypes *ConnectionType `json:"connectionTypes"`
+	ConnectionTypes *ConnectionType `json:"connection_types"`
 	// The countries
 	Countries []Country `json:"countries"`
 	// The types of current
-	CurrentTypes *CurrentType `json:"currentTypes"`
+	CurrentTypes *CurrentType `json:"current_types"`
 	// The providers of the charger data
-	DataProviders *DataProvider `json:"dataProviders"`
+	DataProviders *DataProvider `json:"data_providers"`
 	// The companies operating the chargers
 	Operators []Operator `json:"operators"`
 	// The status of the charger
-	StatusTypes *StatusType `json:"statusTypes"`
+	StatusTypes *StatusType `json:"status_types"`
 	// The status of a submission
-	SubmissionStatusTypes *SubmissionStatusType `json:"submissionStatusTypes"`
+	SubmissionStatusTypes *SubmissionStatusType `json:"submission_status_types"`
 	// The different types of usage
-	UsageTypes *UsageType `json:"usageTypes"`
+	UsageTypes *UsageType `json:"usage_types"`
 	// The types of user comment
-	UserCommentTypes *UserCommentType `json:"userCommentTypes"`
+	UserCommentTypes *UserCommentType `json:"user_comment_types"`
 }
 
 type SearchRequest struct {
 	// Bounding box to search within (top left and bottom right coordinates)
 	Box *BoundingBox `json:"box"`
 	// IDs of the connection type
-	ConnectionTypes string `json:"connectionTypes"`
+	ConnectionTypes string `json:"connection_types"`
 	// Country ID
-	CountryId string `json:"countryId"`
+	CountryId string `json:"country_id"`
 	// Search distance from point in metres, defaults to 5000m
 	Distance int64 `json:"distance,string"`
 	// Supported charging levels
@@ -201,13 +210,13 @@ type SearchRequest struct {
 	// Coordinates from which to begin search
 	Location *Coordinates `json:"location"`
 	// Maximum number of results to return, defaults to 100
-	MaxResults int64 `json:"maxResults,string"`
+	MaxResults int64 `json:"max_results,string"`
 	// Minimum power in KW. Note: data not available for many chargers
-	MinPower int64 `json:"minPower,string"`
+	MinPower int64 `json:"min_power,string"`
 	// IDs of the the EV charger operator
 	Operators []string `json:"operators"`
 	// Usage of the charge point (is it public, membership required, etc)
-	UsageTypes string `json:"usageTypes"`
+	UsageTypes string `json:"usage_types"`
 }
 
 type SearchResponse struct {
@@ -216,21 +225,21 @@ type SearchResponse struct {
 
 type StatusType struct {
 	Id            string `json:"id"`
-	IsOperational bool   `json:"isOperational"`
+	IsOperational bool   `json:"is_operational"`
 	Title         string `json:"title"`
 }
 
 type SubmissionStatusType struct {
 	Id     string `json:"id"`
-	IsLive bool   `json:"isLive"`
+	IsLive bool   `json:"is_live"`
 	Title  string `json:"title"`
 }
 
 type UsageType struct {
 	Id                   string `json:"id"`
-	IsAccessKeyRequired  bool   `json:"isAccessKeyRequired"`
-	IsMembershipRequired bool   `json:"isMembershipRequired"`
-	IsPayAtLocation      bool   `json:"isPayAtLocation"`
+	IsAccessKeyRequired  bool   `json:"is_access_key_required"`
+	IsMembershipRequired bool   `json:"is_membership_required"`
+	IsPayAtLocation      bool   `json:"is_pay_at_location"`
 	Title                string `json:"title"`
 }
 

event/event.go

@@ -0,0 +1,116 @@
+package event
+
+import (
+	"go.m3o.com/client"
+)
+
+type Event interface {
+	Consume(*ConsumeRequest) (*ConsumeResponseStream, error)
+	Publish(*PublishRequest) (*PublishResponse, error)
+	Read(*ReadRequest) (*ReadResponse, error)
+}
+
+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

@@ -1,6 +1,6 @@
 # Address
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Address/api](https://m3o.com/Address/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/address/api](https://m3o.com/address/api).
 
 Endpoints:
 
@@ -29,5 +29,6 @@ func LookupPostcode() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/address/lookupPostcode/lookupPostcode/main.go

@@ -0,0 +1,17 @@
+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

@@ -1,6 +1,6 @@
 # Answer
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Answer/api](https://m3o.com/Answer/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/answer/api](https://m3o.com/answer/api).
 
 Endpoints:
 
@@ -29,5 +29,6 @@ func AskAquestion() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/answer/question/askAQuestion/main.go

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

@@ -0,0 +1,232 @@
+# App
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/app/api](https://m3o.com/app/api).
+
+Endpoints:
+
+## Resolve
+
+Resolve an app by id to its raw backend endpoint
+
+
+[https://m3o.com/app/api#Resolve](https://m3o.com/app/api#Resolve)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Resolve an app by id to its raw backend endpoint
+func ResolveAppById() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Resolve(&app.ResolveRequest{
+		Id: "helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Update
+
+Update the app. The latest source code will be downloaded, built and deployed.
+
+
+[https://m3o.com/app/api#Update](https://m3o.com/app/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Update the app. The latest source code will be downloaded, built and deployed.
+func UpdateAnApp() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Update(&app.UpdateRequest{
+		Name: "helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete an app
+
+
+[https://m3o.com/app/api#Delete](https://m3o.com/app/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Delete an app
+func DeleteAnApp() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Delete(&app.DeleteRequest{
+		Name: "helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Reserve
+
+Reserve apps beyond the free quota. Call Run after.
+
+
+[https://m3o.com/app/api#Reserve](https://m3o.com/app/api#Reserve)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Reserve apps beyond the free quota. Call Run after.
+func ReserveAppName() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Reserve(&app.ReserveRequest{
+		Name: "helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List all the apps
+
+
+[https://m3o.com/app/api#List](https://m3o.com/app/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// List all the apps
+func ListTheApps() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.List(&app.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Run
+
+Run an app from source
+
+
+[https://m3o.com/app/api#Run](https://m3o.com/app/api#Run)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Run an app from source
+func RunAnApp() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Run(&app.RunRequest{
+		Branch: "master",
+Name: "helloworld",
+Port: 8080,
+Region: "europe-west1",
+Repo: "github.com/asim/helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Regions
+
+Return the support regions
+
+
+[https://m3o.com/app/api#Regions](https://m3o.com/app/api#Regions)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Return the support regions
+func ListRegions() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Regions(&app.RegionsRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Status
+
+Get the status of an app
+
+
+[https://m3o.com/app/api#Status](https://m3o.com/app/api#Status)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Get the status of an app
+func GetTheStatusOfAnApp() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Status(&app.StatusRequest{
+		Name: "helloworld",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/app/delete/deleteAnApp/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Delete an app
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Delete(&app.DeleteRequest{
+		Name: "helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/app/list/listTheApps/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// List all the apps
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.List(&app.ListRequest{})
+	fmt.Println(rsp, err)
+}

examples/app/regions/listRegions/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Return the support regions
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Regions(&app.RegionsRequest{})
+	fmt.Println(rsp, err)
+}

examples/app/reserve/reserveAppName/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Reserve apps beyond the free quota. Call Run after.
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Reserve(&app.ReserveRequest{
+		Name: "helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/app/resolve/resolveAppById/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Resolve an app by id to its raw backend endpoint
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Resolve(&app.ResolveRequest{
+		Id: "helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/app/run/runAnApp/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Run an app from source
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Run(&app.RunRequest{
+		Branch: "master",
+		Name:   "helloworld",
+		Port:   8080,
+		Region: "europe-west1",
+		Repo:   "github.com/asim/helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/app/status/getTheStatusOfAnApp/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Get the status of an app
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Status(&app.StatusRequest{
+		Name: "helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/app/update/updateAnApp/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/app"
+)
+
+// Update the app. The latest source code will be downloaded, built and deployed.
+func main() {
+	appService := app.NewAppService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := appService.Update(&app.UpdateRequest{
+		Name: "helloworld",
+	})
+	fmt.Println(rsp, err)
+}

examples/avatar/README.md

@@ -0,0 +1,68 @@
+# Avatar
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/avatar/api](https://m3o.com/avatar/api).
+
+Endpoints:
+
+## Generate
+
+Generate an unique avatar
+
+
+[https://m3o.com/avatar/api#Generate](https://m3o.com/avatar/api#Generate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/avatar"
+)
+
+// Generate an unique avatar
+func GenerateAvatarAndReturnBase64stringOfTheAvatar() {
+	avatarService := avatar.NewAvatarService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := avatarService.Generate(&avatar.GenerateRequest{
+		Format: "jpeg",
+Gender: "female",
+Upload: false,
+Username: "",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Generate
+
+Generate an unique avatar
+
+
+[https://m3o.com/avatar/api#Generate](https://m3o.com/avatar/api#Generate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/avatar"
+)
+
+// Generate an unique avatar
+func GenerateAnAvatarAndUploadTheAvatarToMicrosCdn() {
+	avatarService := avatar.NewAvatarService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := avatarService.Generate(&avatar.GenerateRequest{
+		Format: "png",
+Gender: "female",
+Upload: true,
+Username: "",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/avatar/generate/generateAnAvatarAndUploadTheAvatarToMicrosCdn/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/avatar"
+)
+
+// Generate an unique avatar
+func main() {
+	avatarService := avatar.NewAvatarService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := avatarService.Generate(&avatar.GenerateRequest{
+		Format:   "png",
+		Gender:   "female",
+		Upload:   true,
+		Username: "",
+	})
+	fmt.Println(rsp, err)
+}

examples/avatar/generate/generateAvatarAndReturnBase64stringOfTheAvatar/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/avatar"
+)
+
+// Generate an unique avatar
+func main() {
+	avatarService := avatar.NewAvatarService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := avatarService.Generate(&avatar.GenerateRequest{
+		Format:   "jpeg",
+		Gender:   "female",
+		Upload:   false,
+		Username: "",
+	})
+	fmt.Println(rsp, err)
+}

examples/cache/README.md

@@ -1,40 +1,12 @@
 # Cache
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Cache/api](https://m3o.com/Cache/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/cache/api](https://m3o.com/cache/api).
 
 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)
+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)
@@ -49,7 +21,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{
@@ -58,6 +30,34 @@ Value: 2,
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## ListKeys
+
+List all the available keys
+
+
+[https://m3o.com/cache/api#ListKeys](https://m3o.com/cache/api#ListKeys)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// List all the available keys
+func ListTheKeys() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.ListKeys(&cache.ListKeysRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```
 ## Set
@@ -86,11 +86,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)
@@ -105,7 +106,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{
@@ -113,11 +114,12 @@ func GetAvalue() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Delete
 
-Delete a value from the cache
+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)
@@ -132,7 +134,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{
@@ -140,5 +142,35 @@ func DeleteAvalue() {
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Increment
+
+Increment a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Increment a value (if it's a number). If key not found it is equivalent to set.
+func IncrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Increment(&cache.IncrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

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,18 @@
+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,17 @@
+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,17 @@
+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,18 @@
+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/listKeys/listTheKeys/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// List all the available keys
+func main() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.ListKeys(&cache.ListKeysRequest{})
+	fmt.Println(rsp, err)
+}

examples/cache/set/setAValue/main.go

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

@@ -0,0 +1,33 @@
+# Carbon
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/carbon/api](https://m3o.com/carbon/api).
+
+Endpoints:
+
+## Offset
+
+Purchase 1KG (0.001 tonne) of carbon offsets in a single request
+
+
+[https://m3o.com/carbon/api#Offset](https://m3o.com/carbon/api#Offset)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/carbon"
+)
+
+// Purchase 1KG (0.001 tonne) of carbon offsets in a single request
+func OffsetCarbon() {
+	carbonService := carbon.NewCarbonService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := carbonService.Offset(&carbon.OffsetRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/carbon/offset/offsetCarbon/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/carbon"
+)
+
+// Purchase 1KG (0.001 tonne) of carbon offsets in a single request
+func main() {
+	carbonService := carbon.NewCarbonService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := carbonService.Offset(&carbon.OffsetRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/README.md

@@ -0,0 +1,269 @@
+# Chat
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/chat/api](https://m3o.com/chat/api).
+
+Endpoints:
+
+## Create
+
+Create a new chat room
+
+
+[https://m3o.com/chat/api#Create](https://m3o.com/chat/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Create a new chat room
+func CreateAnewChat() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Create(&chat.CreateRequest{
+		Description: "The general chat room",
+Name: "general",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Invite
+
+Invite a user to a chat room
+
+
+[https://m3o.com/chat/api#Invite](https://m3o.com/chat/api#Invite)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Invite a user to a chat room
+func InviteAuser() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Invite(&chat.InviteRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Send
+
+Connect to a chat to receive a stream of messages
+Send a message to a chat
+
+
+[https://m3o.com/chat/api#Send](https://m3o.com/chat/api#Send)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Connect to a chat to receive a stream of messages
+// Send a message to a chat
+func SendAmessage() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Send(&chat.SendRequest{
+		Client: "web",
+Subject: "Random",
+Text: "Hey whats up?",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## History
+
+List the messages in a chat
+
+
+[https://m3o.com/chat/api#History](https://m3o.com/chat/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// List the messages in a chat
+func GetChatHistory() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.History(&chat.HistoryRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Join
+
+Join a chat room
+
+
+[https://m3o.com/chat/api#Join](https://m3o.com/chat/api#Join)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Join a chat room
+func JoinAroom() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	
+	stream, err := chatService.Join(&chat.JoinRequest{
+		
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
+}
+```
+## Kick
+
+Kick a user from a chat room
+
+
+[https://m3o.com/chat/api#Kick](https://m3o.com/chat/api#Kick)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Kick a user from a chat room
+func KickAuserFromAroom() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Kick(&chat.KickRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Leave
+
+Leave a chat room
+
+
+[https://m3o.com/chat/api#Leave](https://m3o.com/chat/api#Leave)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Leave a chat room
+func LeaveAroom() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Leave(&chat.LeaveRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List available chats
+
+
+[https://m3o.com/chat/api#List](https://m3o.com/chat/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// List available chats
+func ListChatRooms() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.List(&chat.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete a chat room
+
+
+[https://m3o.com/chat/api#Delete](https://m3o.com/chat/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Delete a chat room
+func DeleteAchat() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Delete(&chat.DeleteRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/chat/create/createANewChat/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Create a new chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Create(&chat.CreateRequest{
+		Description: "The general chat room",
+		Name:        "general",
+	})
+	fmt.Println(rsp, err)
+}

examples/chat/delete/deleteAChat/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Delete a chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Delete(&chat.DeleteRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/history/getChatHistory/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// List the messages in a chat
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.History(&chat.HistoryRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/invite/inviteAUser/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Invite a user to a chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Invite(&chat.InviteRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/join/joinARoom/main.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Join a chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	stream, err := chatService.Join(&chat.JoinRequest{})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+		rsp, err := stream.Recv()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+
+		fmt.Println(rsp)
+	}
+}

examples/chat/kick/kickAUserFromARoom/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Kick a user from a chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Kick(&chat.KickRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/leave/leaveARoom/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Leave a chat room
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Leave(&chat.LeaveRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/list/listChatRooms/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// List available chats
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.List(&chat.ListRequest{})
+	fmt.Println(rsp, err)
+}

examples/chat/send/sendAMessage/main.go

@@ -0,0 +1,20 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/chat"
+)
+
+// Connect to a chat to receive a stream of messages
+// Send a message to a chat
+func main() {
+	chatService := chat.NewChatService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := chatService.Send(&chat.SendRequest{
+		Client:  "web",
+		Subject: "Random",
+		Text:    "Hey whats up?",
+	})
+	fmt.Println(rsp, err)
+}

examples/comments/README.md

@@ -0,0 +1,190 @@
+# Comments
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/comments/api](https://m3o.com/comments/api).
+
+Endpoints:
+
+## Create
+
+Create a new comment
+
+
+[https://m3o.com/comments/api#Create](https://m3o.com/comments/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Create a new comment
+func CreateAcomment() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Create(&comments.CreateRequest{
+		Text: "This is my comment",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Read
+
+Read a comment
+
+
+[https://m3o.com/comments/api#Read](https://m3o.com/comments/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Read a comment
+func ReadAcomment() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Read(&comments.ReadRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List all the comments
+
+
+[https://m3o.com/comments/api#List](https://m3o.com/comments/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// List all the comments
+func ListAllComments() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.List(&comments.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Update
+
+Update a comment
+
+
+[https://m3o.com/comments/api#Update](https://m3o.com/comments/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Update a comment
+func UpdateAcomment() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Update(&comments.UpdateRequest{
+		Comment: &comments.Comment{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	Subject: "Update Comment",
+	Text: "Updated comment text",
+	},
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete a comment
+
+
+[https://m3o.com/comments/api#Delete](https://m3o.com/comments/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Delete a comment
+func DeleteAcomment() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Delete(&comments.DeleteRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Events
+
+Subscribe to comments events
+
+
+[https://m3o.com/comments/api#Events](https://m3o.com/comments/api#Events)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Subscribe to comments events
+func SubscribeToEvents() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	
+	stream, err := commentsService.Events(&comments.EventsRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
+}
+```

examples/comments/create/createAComment/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Create a new comment
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Create(&comments.CreateRequest{
+		Text: "This is my comment",
+	})
+	fmt.Println(rsp, err)
+}

examples/comments/delete/deleteAComment/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Delete a comment
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Delete(&comments.DeleteRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	})
+	fmt.Println(rsp, err)
+}

examples/comments/events/subscribeToEvents/main.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Subscribe to comments events
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	stream, err := commentsService.Events(&comments.EventsRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+		rsp, err := stream.Recv()
+		if err != nil {
+			fmt.Println(err)
+			return
+		}
+
+		fmt.Println(rsp)
+	}
+}

examples/comments/list/listAllComments/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// List all the comments
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.List(&comments.ListRequest{})
+	fmt.Println(rsp, err)
+}

examples/comments/read/readAComment/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Read a comment
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Read(&comments.ReadRequest{
+		Id: "63c0cdf8-2121-11ec-a881-0242e36f037a",
+	})
+	fmt.Println(rsp, err)
+}

examples/comments/update/updateAComment/main.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/comments"
+)
+
+// Update a comment
+func main() {
+	commentsService := comments.NewCommentsService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := commentsService.Update(&comments.UpdateRequest{
+		Comment: &comments.Comment{
+			Id:      "63c0cdf8-2121-11ec-a881-0242e36f037a",
+			Subject: "Update Comment",
+			Text:    "Updated comment text",
+		},
+	})
+	fmt.Println(rsp, err)
+}

examples/contact/README.md

@@ -0,0 +1,219 @@
+# Contact
+
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/contact/api](https://m3o.com/contact/api).
+
+Endpoints:
+
+## Delete
+
+Delete a contact
+
+
+[https://m3o.com/contact/api#Delete](https://m3o.com/contact/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Delete a contact
+func DeleteAcontact() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Delete(&contact.DeleteRequest{
+		Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List contacts
+
+
+[https://m3o.com/contact/api#List](https://m3o.com/contact/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// List contacts
+func ListContactsWithDefaultOffsetAndLimitDefaultLimitIs20() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.List(&contact.ListRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## List
+
+List contacts
+
+
+[https://m3o.com/contact/api#List](https://m3o.com/contact/api#List)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// List contacts
+func ListContactsWithSpecificOffsetAndLimit() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.List(&contact.ListRequest{
+		Limit: 1,
+Offset: 1,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Create
+
+Create a contact
+
+
+[https://m3o.com/contact/api#Create](https://m3o.com/contact/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Create a contact
+func CreateAcontact() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Create(&contact.CreateRequest{
+		Addresses: []contact.Address{
+contact.Address{
+		Label: "company address",
+		Location: "123 street address",
+}},
+Birthday: "1995-01-01",
+Emails: []contact.Email{
+contact.Email{
+		Address: "home@example.com",
+		Label: "home",
+}},
+Links: []contact.Link{
+contact.Link{
+		Label: "blog",
+		Url: "https://blog.joe.me",
+}},
+Name: "joe",
+Note: "this person is very important",
+Phones: []contact.Phone{
+contact.Phone{
+		Label: "home",
+		Number: "010-12345678",
+}},
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Update
+
+Update a contact
+
+
+[https://m3o.com/contact/api#Update](https://m3o.com/contact/api#Update)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Update a contact
+func UpdateAcontact() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Update(&contact.UpdateRequest{
+		Addresses: []contact.Address{
+contact.Address{
+		Label: "company address",
+		Location: "123 street address",
+}},
+Birthday: "1995-01-01",
+Emails: []contact.Email{
+contact.Email{
+		Address: "home@example.com",
+		Label: "home",
+}},
+Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+Links: []contact.Link{
+contact.Link{
+		Label: "blog",
+		Url: "https://blog.joe.me",
+}},
+Name: "joe",
+Note: "this person is very important",
+Phones: []contact.Phone{
+contact.Phone{
+		Label: "home",
+		Number: "010-12345678",
+}},
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Read
+
+Read contact details
+
+
+[https://m3o.com/contact/api#Read](https://m3o.com/contact/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Read contact details
+func GetAcontact() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Read(&contact.ReadRequest{
+		Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/contact/create/createAContact/main.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Create a contact
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Create(&contact.CreateRequest{
+		Addresses: []contact.Address{
+			contact.Address{
+				Label:    "company address",
+				Location: "123 street address",
+			}},
+		Birthday: "1995-01-01",
+		Emails: []contact.Email{
+			contact.Email{
+				Address: "home@example.com",
+				Label:   "home",
+			}},
+		Links: []contact.Link{
+			contact.Link{
+				Label: "blog",
+				Url:   "https://blog.joe.me",
+			}},
+		Name: "joe",
+		Note: "this person is very important",
+		Phones: []contact.Phone{
+			contact.Phone{
+				Label:  "home",
+				Number: "010-12345678",
+			}},
+	})
+	fmt.Println(rsp, err)
+}

examples/contact/delete/deleteAContact/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Delete a contact
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Delete(&contact.DeleteRequest{
+		Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+	})
+	fmt.Println(rsp, err)
+}

examples/contact/list/listContactsWithDefaultOffsetAndLimitDefaultLimitIs20/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// List contacts
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.List(&contact.ListRequest{})
+	fmt.Println(rsp, err)
+}

examples/contact/list/listContactsWithSpecificOffsetAndLimit/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// List contacts
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.List(&contact.ListRequest{
+		Limit:  1,
+		Offset: 1,
+	})
+	fmt.Println(rsp, err)
+}

examples/contact/read/getAContact/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Read contact details
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Read(&contact.ReadRequest{
+		Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+	})
+	fmt.Println(rsp, err)
+}

examples/contact/update/updateAContact/main.go

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/contact"
+)
+
+// Update a contact
+func main() {
+	contactService := contact.NewContactService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := contactService.Update(&contact.UpdateRequest{
+		Addresses: []contact.Address{
+			contact.Address{
+				Label:    "company address",
+				Location: "123 street address",
+			}},
+		Birthday: "1995-01-01",
+		Emails: []contact.Email{
+			contact.Email{
+				Address: "home@example.com",
+				Label:   "home",
+			}},
+		Id: "42e48a3c-6221-11ec-96d2-acde48001122",
+		Links: []contact.Link{
+			contact.Link{
+				Label: "blog",
+				Url:   "https://blog.joe.me",
+			}},
+		Name: "joe",
+		Note: "this person is very important",
+		Phones: []contact.Phone{
+			contact.Phone{
+				Label:  "home",
+				Number: "010-12345678",
+			}},
+	})
+	fmt.Println(rsp, err)
+}

examples/crypto/README.md

@@ -1,9 +1,37 @@
 # Crypto
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Crypto/api](https://m3o.com/Crypto/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/crypto/api](https://m3o.com/crypto/api).
 
 Endpoints:
 
+## News
+
+Get news related to a currency
+
+
+[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get news related to a currency
+func GetCryptocurrencyNews() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.News(&crypto.NewsRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Price
 
 Get the last price for a given crypto ticker
@@ -29,6 +57,7 @@ func GetCryptocurrencyPrice() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Quote
@@ -56,6 +85,7 @@ func GetAcryptocurrencyQuote() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## History
@@ -83,14 +113,15 @@ func GetPreviousClose() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
-## News
+## Symbols
 
-Get news related to a currency
+Returns the full list of supported symbols
 
 
-[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
+[https://m3o.com/crypto/api#Symbols](https://m3o.com/crypto/api#Symbols)
 
 ```go
 package example
@@ -102,13 +133,13 @@ import(
 	"go.m3o.com/crypto"
 )
 
-// Get news related to a currency
-func GetCryptocurrencyNews() {
+// Returns the full list of supported symbols
+func GetListOfAllSupportedSymbols() {
 	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.News(&crypto.NewsRequest{
-		Symbol: "BTCUSD",
+	rsp, err := cryptoService.Symbols(&crypto.SymbolsRequest{
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/crypto/history/getPreviousClose/main.go

@@ -0,0 +1,17 @@
+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,17 @@
+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,17 @@
+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,17 @@
+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/crypto/symbols/getListOfAllSupportedSymbols/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Returns the full list of supported symbols
+func main() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Symbols(&crypto.SymbolsRequest{})
+	fmt.Println(rsp, err)
+}

examples/currency/README.md

@@ -1,9 +1,64 @@
 # Currency
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Currency/api](https://m3o.com/Currency/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/currency/api](https://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
@@ -30,6 +85,7 @@ To: "GBP",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Convert
@@ -59,6 +115,7 @@ To: "GBP",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## History
@@ -87,58 +144,6 @@ 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/currency/codes/getSupportedCodes/main.go

@@ -0,0 +1,15 @@
+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,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{
+		Amount: 10,
+		From:   "USD",
+		To:     "GBP",
+	})
+	fmt.Println(rsp, err)
+}

examples/currency/convert/convertUsdToGbp/main.go

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

@@ -1,6 +1,6 @@
 # Db
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https://m3o.com/Db/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/db/api](https://m3o.com/db/api).
 
 Endpoints:
 
@@ -26,15 +26,16 @@ 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",
+Table: "example",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Update
@@ -62,38 +63,11 @@ func UpdateArecord() {
 	"id": "1",
 	"age": 43,
 },
-Table: "users",
+Table: "example",
 
 	})
 	fmt.Println(rsp, err)
-}
-```
-## Read
 	
-Read data from a table. Lookup can be by ID or via querying any field in the record.
-
-
-[https://m3o.com/db/api#Read](https://m3o.com/db/api#Read)
-
-```go
-package example
-
-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 ReadRecords() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Read(&db.ReadRequest{
-		Query: "age == 43",
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
 }
 ```
 ## Delete
@@ -118,37 +92,11 @@ func DeleteArecord() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Delete(&db.DeleteRequest{
 		Id: "1",
-Table: "users",
+Table: "example",
 
 	})
 	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
@@ -172,9 +120,151 @@ import(
 func CountEntriesInAtable() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Count(&db.CountRequest{
-		Table: "users",
+		Table: "example",
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Read
+
+Read data from a table. Lookup can be by ID or via querying any field in the record.
+
+
+[https://m3o.com/db/api#Read](https://m3o.com/db/api#Read)
+
+```go
+package example
+
+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 ReadRecords() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Read(&db.ReadRequest{
+		Query: "age == 43",
+Table: "example",
+
+	})
+	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: "example",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## DropTable
+
+Drop a table in the DB
+
+
+[https://m3o.com/db/api#DropTable](https://m3o.com/db/api#DropTable)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Drop a table in the DB
+func DropTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.DropTable(&db.DropTableRequest{
+		Table: "example",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## ListTables
+
+List tables in the DB
+
+
+[https://m3o.com/db/api#ListTables](https://m3o.com/db/api#ListTables)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// List tables in the DB
+func ListTables() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.ListTables(&db.ListTablesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## RenameTable
+
+Rename a table
+
+
+[https://m3o.com/db/api#RenameTable](https://m3o.com/db/api#RenameTable)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Rename a table
+func RenameTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.RenameTable(&db.RenameTableRequest{
+		From: "examples2",
+To: "examples3",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/db/count/countEntriesInATable/main.go

@@ -0,0 +1,17 @@
+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: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/create/createARecord.go

@@ -12,10 +12,10 @@ func CreateArecord() {
 	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := dbService.Create(&db.CreateRequest{
 		Record: map[string]interface{}{
+			"id":       "1",
 			"name":     "Jane",
 			"age":      42,
 			"isActive": true,
-			"id":       "1",
 		},
 		Table: "users",
 	})

examples/db/create/createARecord/main.go

@@ -0,0 +1,23 @@
+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: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/delete/deleteARecord/main.go

@@ -0,0 +1,18 @@
+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: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/dropTable/dropTable/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Drop a table in the DB
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.DropTable(&db.DropTableRequest{
+		Table: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/listTables/listTables/main.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// List tables in the DB
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.ListTables(&db.ListTablesRequest{})
+	fmt.Println(rsp, err)
+}

examples/db/read/readRecords/main.go

@@ -0,0 +1,18 @@
+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: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/renameTable/renameTable/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Rename a table
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.RenameTable(&db.RenameTableRequest{
+		From: "examples2",
+		To:   "examples3",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/truncate/truncateTable/main.go

@@ -0,0 +1,17 @@
+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: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/db/update/updateARecord/main.go

@@ -0,0 +1,21 @@
+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{}{
+			"age": 43,
+			"id":  "1",
+		},
+		Table: "example",
+	})
+	fmt.Println(rsp, err)
+}

examples/email/README.md

@@ -1,6 +1,6 @@
 # Email
 
-An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Email/api](https://m3o.com/Email/api).
+An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/email/api](https://m3o.com/email/api).
 
 Endpoints:
 
@@ -33,5 +33,62 @@ Please verify your email by clicking this link: $micro_verification_link`,
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Parse
+
+Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
+
+
+[https://m3o.com/email/api#Parse](https://m3o.com/email/api#Parse)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/email"
+)
+
+// Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
+func ParseEmail() {
+	emailService := email.NewEmailService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emailService.Parse(&email.ParseRequest{
+		Address: "Joe Blogs <joe@example.com>",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Validate
+
+Validate an email address format
+
+
+[https://m3o.com/email/api#Validate](https://m3o.com/email/api#Validate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/email"
+)
+
+// Validate an email address format
+func ValidateEmail() {
+	emailService := email.NewEmailService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emailService.Validate(&email.ValidateRequest{
+		Address: "joe@example.com",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/email/parse/parseEmail/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/email"
+)
+
+// Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
+func main() {
+	emailService := email.NewEmailService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emailService.Parse(&email.ParseRequest{
+		Address: "Joe Blogs <joe@example.com>",
+	})
+	fmt.Println(rsp, err)
+}