Commit from m3o/m3o action

.github/workflows/generate.yml

@@ -22,5 +22,10 @@ jobs:
         env:
           M3O_API_TOKEN: ${{ secrets.M3O_API_TOKEN }}
         run: |
-          cd examples/helloworld/call/callTheHelloworldService
+          # stream is temporarily excluded as it hangs forever because test does not close connection
-          go run main.go
+          # @TODO remove "idempotent: true" from stream example
+          O=$(find . -name ".run" | grep -v stream | xargs -n1 dirname | xargs -n1 go run)
+          echo $O
+          if grep -q Detail "$O"; then
+            exit 1
+          fi

address/address.go

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

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

cache/cache.go

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

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"),

crypto/crypto.go

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

currency/currency.go

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

db/db.go

@@ -18,38 +18,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 {
@@ -84,6 +120,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 +161,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

@@ -18,21 +18,23 @@ type EmailService struct {
 
 // Send an email by passing in from, to, subject, and a text or html body
 func (t *EmailService) Send(request *SendRequest) (*SendResponse, error) {
+
 	rsp := &SendResponse{}
 	return rsp, t.client.Call("email", "Send", request, rsp)
+
 }
 
 type SendRequest struct {
 	// 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"`
 }

emoji/emoji.go

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

evchargers/evchargers.go

@@ -18,62 +18,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"`
+	AccessComments  string       `json:"access_comments"`
-	AddressLine1    string       `json:"addressLine1"`
+	AddressLine1    string       `json:"address_line_1"`
-	AddressLine2    string       `json:"addressLine2"`
+	AddressLine2    string       `json:"address_line_2"`
 	Country         *Country     `json:"country"`
-	CountryId       string       `json:"countryId"`
+	CountryId       string       `json:"country_id"`
-	LatLng          string       `json:"latLng"`
+	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"`
+	BottomLeft *Coordinates `json:"bottom_left"`
-	TopRight   *Coordinates `json:"topRight"`
+	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"`
+	IsAutomated bool   `json:"is_automated"`
-	IsPositive  bool   `json:"isPositive"`
+	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 +86,10 @@ type Connection struct {
 }
 
 type ConnectionType struct {
-	FormalName     string `json:"formalName"`
+	FormalName     string `json:"formal_name"`
 	Id             string `json:"id"`
-	IsDiscontinued bool   `json:"isDiscontinued"`
+	IsDiscontinued bool   `json:"is_discontinued"`
-	IsObsolete     bool   `json:"isObsolete"`
+	IsObsolete     bool   `json:"is_obsolete"`
 	Title          string `json:"title"`
 }
 
@@ -95,9 +99,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 +113,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 +123,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"`
+	ContactEmail     string `json:"contact_email"`
-	FaultReportEmail string `json:"faultReportEmail"`
+	FaultReportEmail string `json:"fault_report_email"`
 	Id               string `json:"id"`
 	// Is this operator a private individual vs a company
-	IsPrivateIndividual bool   `json:"isPrivateIndividual"`
+	IsPrivateIndividual bool   `json:"is_private_individual"`
-	PhonePrimary        string `json:"phonePrimary"`
+	PhonePrimary        string `json:"phone_primary"`
-	PhoneSecondary      string `json:"phoneSecondary"`
+	PhoneSecondary      string `json:"phone_secondary"`
 	Title               string `json:"title"`
 	Website             string `json:"website"`
 }
@@ -144,19 +148,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 +168,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 +205,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 +220,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"`
+	IsAccessKeyRequired  bool   `json:"is_access_key_required"`
-	IsMembershipRequired bool   `json:"isMembershipRequired"`
+	IsMembershipRequired bool   `json:"is_membership_required"`
-	IsPayAtLocation      bool   `json:"isPayAtLocation"`
+	IsPayAtLocation      bool   `json:"is_pay_at_location"`
 	Title                string `json:"title"`
 }
 

event/event.go

@@ -16,16 +16,73 @@ type EventService struct {
 	client *client.Client
 }
 
-// Publish a message to the event stream.
+// Consume events from a given topic.
-func (t *EventService) Publish(request *PublishRequest) (*PublishResponse, error) {
+func (t *EventService) Consume(request *ConsumeRequest) (*ConsumeResponseStream, error) {
-	rsp := &PublishResponse{}
+	stream, err := t.client.Stream("event", "Consume", request)
-	return rsp, t.client.Call("event", "Publish", request, rsp)
+	if err != nil {
+		return nil, err
+	}
+	return &ConsumeResponseStream{
+		stream: stream,
+	}, nil
+
 }
 
-// Subscribe to messages for a given topic.
+type ConsumeResponseStream struct {
-func (t *EventService) Subscribe(request *SubscribeRequest) (*SubscribeResponse, error) {
+	stream *client.Stream
-	rsp := &SubscribeResponse{}
+}
-	return rsp, t.client.Call("event", "Subscribe", request, rsp)
+
+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 {
@@ -38,16 +95,16 @@ type PublishRequest struct {
 type PublishResponse struct {
 }
 
-type SubscribeRequest struct {
+type ReadRequest struct {
-	// Optional group for the subscription
+	// number of events to read; default 25
-	Group string `json:"group"`
+	Limit int32 `json:"limit"`
-	// The topic to subscribe to
+	// offset for the events; default 0
+	Offset int32 `json:"offset"`
+	// topic to read from
 	Topic string `json:"topic"`
 }
 
-type SubscribeResponse struct {
+type ReadResponse struct {
-	// The next json message on the topic
+	// the events
-	Message map[string]interface{} `json:"message"`
+	Events []Ev `json:"events"`
-	// The topic subscribed to
-	Topic string `json:"topic"`
 }

examples/address/README.md

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

examples/address/lookupPostcode/lookupPostcode/main.go

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

examples/answer/README.md

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

examples/answer/question/askAQuestion/main.go

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

examples/cache/README.md

@@ -4,62 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Cache/api](htt
 
 Endpoints:
 
-## Increment
-
-Increment a value (if it's a number)
-
-
-[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/cache"
-)
-
-// Increment a value (if it's a number)
-func IncrementAvalue() {
-	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cacheService.Increment(&cache.IncrementRequest{
-		Key: "counter",
-Value: 2,
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Decrement
-
-Decrement a value (if it's a number)
-
-
-[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/cache"
-)
-
-// Decrement a value (if it's a number)
-func DecrementAvalue() {
-	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
-		Key: "counter",
-Value: 2,
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Set
 
 Set an item in the cache. Overwrites any existing value already set.
@@ -86,11 +30,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 +50,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 +58,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 +78,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 +86,64 @@ 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)
+	
+}
+```
+## Decrement
+
+Decrement a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
+func DecrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/cache/decrement/decrementAValue.go

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

examples/cache/decrement/decrementAValue/main.go

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

examples/cache/delete/deleteAValue.go

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

examples/cache/delete/deleteAValue/main.go

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

examples/cache/get/getAValue.go

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

examples/cache/get/getAValue/main.go

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

examples/cache/increment/incrementAValue.go

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

examples/cache/increment/incrementAValue/main.go

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

examples/cache/set/setAValue/main.go

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

examples/crypto/README.md

@@ -4,60 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Crypto/api](ht
 
 Endpoints:
 
-## News
-
-Get news related to a currency
-
-
-[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Get news related to a currency
-func GetCryptocurrencyNews() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.News(&crypto.NewsRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Price
-
-Get the last price for a given crypto ticker
-
-
-[https://m3o.com/crypto/api#Price](https://m3o.com/crypto/api#Price)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Get the last price for a given crypto ticker
-func GetCryptocurrencyPrice() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.Price(&crypto.PriceRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Quote
 
 Get the last quote for a given crypto ticker
@@ -83,6 +29,7 @@ func GetAcryptocurrencyQuote() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## History
@@ -110,5 +57,62 @@ func GetPreviousClose() {
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## News
+
+Get news related to a currency
+
+
+[https://m3o.com/crypto/api#News](https://m3o.com/crypto/api#News)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get news related to a currency
+func GetCryptocurrencyNews() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.News(&crypto.NewsRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Price
+
+Get the last price for a given crypto ticker
+
+
+[https://m3o.com/crypto/api#Price](https://m3o.com/crypto/api#Price)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get the last price for a given crypto ticker
+func GetCryptocurrencyPrice() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Price(&crypto.PriceRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/crypto/history/getPreviousClose/main.go

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

examples/crypto/news/getCryptocurrencyNews/main.go

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

examples/crypto/price/getCryptocurrencyPrice/main.go

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

examples/crypto/quote/getACryptocurrencyQuote/main.go

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

examples/currency/README.md

@@ -4,6 +4,61 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Currency/api](
 
 Endpoints:
 
+## Codes
+
+Codes returns the supported currency codes for the API
+
+
+[https://m3o.com/currency/api#Codes](https://m3o.com/currency/api#Codes)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Codes returns the supported currency codes for the API
+func GetSupportedCodes() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Codes(&currency.CodesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Rates
+
+Rates returns the currency rates for a given code e.g USD
+
+
+[https://m3o.com/currency/api#Rates](https://m3o.com/currency/api#Rates)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Rates returns the currency rates for a given code e.g USD
+func GetRatesForUsd() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Rates(&currency.RatesRequest{
+		Code: "USD",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Convert
 
 Convert returns the currency conversion rate between two pairs e.g USD/GBP
@@ -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,16 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Codes returns the supported currency codes for the API
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Codes(&currency.CodesRequest{})
+	fmt.Println(rsp, err)
+
+}

examples/currency/convert/convert10UsdToGbp/main.go

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

examples/currency/convert/convertUsdToGbp/main.go

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

examples/currency/history/historicRatesForACurrency/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Returns the historic rates for a currency on a given date
+func main() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.History(&currency.HistoryRequest{
+		Code: "USD",
+		Date: "2021-05-30",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/currency/rates/getRatesForUsd/main.go

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

examples/db/README.md

@@ -4,93 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https:
 
 Endpoints:
 
-## Truncate
-
-Truncate the records in a table
-
-
-[https://m3o.com/db/api#Truncate](https://m3o.com/db/api#Truncate)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Truncate the records in a table
-func TruncateTable() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Truncate(&db.TruncateRequest{
-		Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Count
-
-Count records in a table
-
-
-[https://m3o.com/db/api#Count](https://m3o.com/db/api#Count)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Count records in a table
-func CountEntriesInAtable() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Count(&db.CountRequest{
-		Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Create
-
-Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
-
-
-[https://m3o.com/db/api#Create](https://m3o.com/db/api#Create)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
-func CreateArecord() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Create(&db.CreateRequest{
-		Record: map[string]interface{}{
-	"name": "Jane",
-	"age": 42,
-	"isActive": true,
-	"id": "1",
-},
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Update
 
 Update a record in the database. Include an "id" in the record to update.
@@ -120,6 +33,70 @@ Table: "users",
 
 	})
 	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: "events",
+To: "events_backup",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Create
+
+Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
+
+
+[https://m3o.com/db/api#Create](https://m3o.com/db/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
+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,
+},
+Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```
 ## Read
@@ -148,6 +125,7 @@ Table: "users",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Delete
@@ -176,5 +154,117 @@ Table: "users",
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Truncate
+
+Truncate the records in a table
+
+
+[https://m3o.com/db/api#Truncate](https://m3o.com/db/api#Truncate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Truncate the records in a table
+func TruncateTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Truncate(&db.TruncateRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## 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: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Count
+
+Count records in a table
+
+
+[https://m3o.com/db/api#Count](https://m3o.com/db/api#Count)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Count records in a table
+func CountEntriesInAtable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Count(&db.CountRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## 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)
+	
 }
 ```

examples/db/count/countEntriesInATable/main.go

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

examples/db/create/createARecord.go

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

examples/db/create/createARecord/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
+func main() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Create(&db.CreateRequest{
+		Record: map[string]interface{}{
+			"id":       "1",
+			"name":     "Jane",
+			"age":      42,
+			"isActive": true,
+		},
+		Table: "users",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/delete/deleteARecord/main.go

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

examples/db/dropTable/dropTable/main.go

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

examples/db/listTables/listTables/main.go

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

examples/db/renameTable/renameTable/main.go

@@ -0,0 +1,19 @@
+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: "events",
+		To:   "events_backup",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/db/truncate/truncateTable/main.go

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

examples/db/update/updateARecord.go

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

examples/db/update/updateARecord/main.go

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

examples/email/README.md

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

examples/email/send/sendEmail/main.go

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

examples/emoji/README.md

@@ -4,59 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Emoji/api](htt
 
 Endpoints:
 
-## Find
-
-Find an emoji by its alias e.g :beer:
-
-
-[https://m3o.com/emoji/api#Find](https://m3o.com/emoji/api#Find)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/emoji"
-)
-
-// Find an emoji by its alias e.g :beer:
-func FindEmoji() {
-	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := emojiService.Find(&emoji.FindRequest{
-		Alias: ":beer:",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Flag
-
-Get the flag for a country. Requires country code e.g GB for great britain
-
-
-[https://m3o.com/emoji/api#Flag](https://m3o.com/emoji/api#Flag)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/emoji"
-)
-
-// Get the flag for a country. Requires country code e.g GB for great britain
-func GetFlagByCountryCode() {
-	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := emojiService.Flag(&emoji.FlagRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Print
 
 Print text and renders the emojis with aliases e.g
@@ -84,6 +31,7 @@ func PrintTextIncludingEmoji() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Send
@@ -113,5 +61,61 @@ To: "+44782669123",
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Find
+
+Find an emoji by its alias e.g :beer:
+
+
+[https://m3o.com/emoji/api#Find](https://m3o.com/emoji/api#Find)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Find an emoji by its alias e.g :beer:
+func FindEmoji() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Find(&emoji.FindRequest{
+		Alias: ":beer:",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Flag
+
+Get the flag for a country. Requires country code e.g GB for great britain
+
+
+[https://m3o.com/emoji/api#Flag](https://m3o.com/emoji/api#Flag)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/emoji"
+)
+
+// Get the flag for a country. Requires country code e.g GB for great britain
+func GetFlagByCountryCode() {
+	emojiService := emoji.NewEmojiService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := emojiService.Flag(&emoji.FlagRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/emoji/find/findEmoji/main.go

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

examples/emoji/flag/getFlagByCountryCode/main.go

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

examples/emoji/print/printTextIncludingEmoji/main.go

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

examples/emoji/send/sendATextContainingAnEmojiToAnyoneViaSms/main.go

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

examples/evchargers/README.md

@@ -33,6 +33,7 @@ Location: &evchargers.Coordinates{
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Search
@@ -61,6 +62,7 @@ func SearchByBoundingBox() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Search
@@ -93,6 +95,7 @@ Location: &evchargers.Coordinates{
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## ReferenceData
@@ -119,5 +122,6 @@ func GetReferenceData() {
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/evchargers/referenceData/getReferenceData/main.go

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

examples/evchargers/search/searchByBoundingBox/main.go

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

examples/evchargers/search/searchByLocation/main.go

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

examples/evchargers/search/searchWithFiltersFastChargersOnly/main.go

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

examples/event/README.md

@@ -6,7 +6,7 @@ Endpoints:
 
 ## Publish
 
-Publish a message to the event stream.
+Publish a event to the event stream.
 
 
 [https://m3o.com/event/api#Publish](https://m3o.com/event/api#Publish)
@@ -21,27 +21,28 @@ import(
 	"go.m3o.com/event"
 )
 
-// Publish a message to the event stream.
+// Publish a event to the event stream.
-func PublishAmessage() {
+func PublishAnEvent() {
 	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
 	rsp, err := eventService.Publish(&event.PublishRequest{
 		Message: map[string]interface{}{
-	"user": "john",
 	"id": "1",
 	"type": "signup",
+	"user": "john",
 },
 Topic: "user",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
-## Subscribe
+## Consume
 
-Subscribe to messages for a given topic.
+Consume events from a given topic.
 
 
-[https://m3o.com/event/api#Subscribe](https://m3o.com/event/api#Subscribe)
+[https://m3o.com/event/api#Consume](https://m3o.com/event/api#Consume)
 
 ```go
 package example
@@ -53,13 +54,55 @@ import(
 	"go.m3o.com/event"
 )
 
-// Subscribe to messages for a given topic.
+// Consume events from a given topic.
-func SubscribeToAtopic() {
+func ConsumeFromAtopic() {
 	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Subscribe(&event.SubscribeRequest{
+	
+	stream, err := eventService.Consume(&event.ConsumeRequest{
+		Topic: "user",
+
+	})
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
+}
+```
+## Read
+
+Read stored events
+
+
+[https://m3o.com/event/api#Read](https://m3o.com/event/api#Read)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/event"
+)
+
+// Read stored events
+func ReadEventsOnAtopic() {
+	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := eventService.Read(&event.ReadRequest{
 		Topic: "user",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/event/consume/consumeFromATopic.go

@@ -7,10 +7,10 @@ import (
 	"go.m3o.com/event"
 )
 
-// Subscribe to messages for a given topic.
+// Consume events from a given topic.
-func SubscribeToAtopic() {
+func ConsumeFromAtopic() {
 	eventService := event.NewEventService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := eventService.Subscribe(&event.SubscribeRequest{
+	rsp, err := eventService.Consume(&event.ConsumeRequest{
 		Topic: "user",
 	})
 	fmt.Println(rsp, err)

examples/event/consume/consumeFromATopic/main.go

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

examples/event/publish/publishAMessage.go

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

examples/event/publish/publishAnEvent.go

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

examples/event/publish/publishAnEvent/main.go

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

examples/event/read/readEventsOnATopic.go

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

examples/event/read/readEventsOnATopic/main.go

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

examples/file/README.md

@@ -33,6 +33,7 @@ func SaveFile() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## List
@@ -60,6 +61,7 @@ func ListFiles() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Delete
@@ -88,6 +90,7 @@ Project: "examples",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Read
@@ -116,5 +119,6 @@ Project: "examples",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/file/delete/deleteFile/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Delete a file by project name/path
+func main() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.Delete(&file.DeleteRequest{
+		Path:    "/document/text-files/file.txt",
+		Project: "examples",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/file/list/listFiles/main.go

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

examples/file/read/readFile/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/file"
+)
+
+// Read a file by path
+func main() {
+	fileService := file.NewFileService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := fileService.Read(&file.ReadRequest{
+		Path:    "/document/text-files/file.txt",
+		Project: "examples",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/file/save/saveFile/main.go

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

examples/forex/README.md

@@ -4,33 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Forex/api](htt
 
 Endpoints:
 
-## Quote
-
-Get the latest quote for the forex
-
-
-[https://m3o.com/forex/api#Quote](https://m3o.com/forex/api#Quote)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/forex"
-)
-
-// Get the latest quote for the forex
-func GetAfxQuote() {
-	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := forexService.Quote(&forex.QuoteRequest{
-		Symbol: "GBPUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## History
 
 Returns the data for the previous close
@@ -56,6 +29,7 @@ func GetPreviousClose() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Price
@@ -83,5 +57,34 @@ func GetAnFxPrice() {
 
 	})
 	fmt.Println(rsp, err)
+	
+}
+```
+## Quote
+
+Get the latest quote for the forex
+
+
+[https://m3o.com/forex/api#Quote](https://m3o.com/forex/api#Quote)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/forex"
+)
+
+// Get the latest quote for the forex
+func GetAfxQuote() {
+	forexService := forex.NewForexService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := forexService.Quote(&forex.QuoteRequest{
+		Symbol: "GBPUSD",
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```

examples/forex/history/getPreviousClose/main.go

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

examples/forex/price/getAnFxPrice/main.go

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

examples/forex/quote/getAFxQuote/main.go

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

examples/function/README.md

@@ -33,6 +33,7 @@ Runtime: "nodejs14",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Call
@@ -62,6 +63,7 @@ Request: map[string]interface{}{
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## List
@@ -88,6 +90,7 @@ func ListFunctions() {
 		
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Delete
@@ -116,6 +119,7 @@ Project: "tests",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Describe
@@ -144,5 +148,6 @@ Project: "tests",
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```

examples/function/call/callAFunction/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Call a function by name
+func main() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Call(&function.CallRequest{
+		Name:    "my-first-func",
+		Request: map[string]interface{}{},
+	})
+	fmt.Println(rsp, err)
+
+}

examples/function/delete/deleteAFunction/main.go

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

examples/function/deploy/deployAFunction/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Deploy a group of functions
+func main() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Deploy(&function.DeployRequest{
+		Entrypoint: "helloworld",
+		Name:       "my-first-func",
+		Project:    "tests",
+		Repo:       "github.com/m3o/nodejs-function-example",
+		Runtime:    "nodejs14",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/function/describe/describeFunctionStatus/main.go

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

examples/function/list/listFunctions/main.go

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

examples/geocoding/README.md

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

examples/geocoding/lookup/geocodeAnAddress/main.go

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

examples/geocoding/reverse/reverseGeocodeLocation/main.go

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

examples/gifs/README.md

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

examples/gifs/search/search/main.go

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

examples/google/README.md

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

examples/google/search/searchForVideos/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/google"
+)
+
+// Search for videos on Google
+func main() {
+	googleService := google.NewGoogleService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := googleService.Search(&google.SearchRequest{
+		Query: "how to make donuts",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/helloworld/README.md

@@ -29,6 +29,7 @@ func CallTheHelloworldService() {
 
 	})
 	fmt.Println(rsp, err)
+	
 }
 ```
 ## Stream
@@ -49,12 +50,27 @@ import(
 )
 
 // Stream returns a stream of "Hello $name" responses
-func StreamsAreCurrentlyTemporarilyNotSupportedInClients() {
+func StreamsResponsesFromTheServerUsingWebsockets() {
 	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := helloworldService.Stream(&helloworld.StreamRequest{
+	
-		Name: "not supported",
+	stream, err := helloworldService.Stream(&helloworld.StreamRequest{
+		Messages: 10,
+Name: "John",
 
 	})
-	fmt.Println(rsp, err)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+	for {
+			rsp, err := stream.Recv()
+			if err != nil {
+					fmt.Println(err)
+					return
+			}
+
+			fmt.Println(rsp)
+	}
 }
 ```

examples/helloworld/call/callTheHelloworldService/main.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Call returns a personalised "Hello $name" response
+func main() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := helloworldService.Call(&helloworld.CallRequest{
+		Name: "John",
+	})
+	fmt.Println(rsp, err)
+
+}

examples/helloworld/stream/streamsAreCurrentlyTemporarilyNotSupportedInClients/main.go

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