Commit from m3o/m3o action

examples/cache/README.md

@@ -4,6 +4,64 @@ 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). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Increment](https://m3o.com/cache/api#Increment)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Increment a value (if it's a number). If key not found it is equivalent to set.
+func IncrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Increment(&cache.IncrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Decrement
+
+Decrement a value (if it's a number). If key not found it is equivalent to set.
+
+
+[https://m3o.com/cache/api#Decrement](https://m3o.com/cache/api#Decrement)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/cache"
+)
+
+// Decrement a value (if it's a number). If key not found it is equivalent to set.
+func DecrementAvalue() {
+	cacheService := cache.NewCacheService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cacheService.Decrement(&cache.DecrementRequest{
+		Key: "counter",
+Value: 2,
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Set
 
 Set an item in the cache. Overwrites any existing value already set.
@@ -89,61 +147,3 @@ func DeleteAvalue() {
 	
 }
 ```
-## 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/db/README.md

@@ -4,12 +4,12 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Db/api](https:
 
 Endpoints:
 
-## ListTables
+## Create
 
-List tables in the DB
+Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
 
 
-[https://m3o.com/db/api#ListTables](https://m3o.com/db/api#ListTables)
+[https://m3o.com/db/api#Create](https://m3o.com/db/api#Create)
 
 ```go
 package example
@@ -21,11 +21,47 @@ import(
 	"go.m3o.com/db"
 )
 
-// List tables in the DB
-func ListTables() {
+// 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.ListTables(&db.ListTablesRequest{
-		
+	rsp, err := dbService.Create(&db.CreateRequest{
+		Record: map[string]interface{}{
+	"id": "1",
+	"name": "Jane",
+	"age": 42,
+	"isActive": true,
+},
+Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete a record in the database by id.
+
+
+[https://m3o.com/db/api#Delete](https://m3o.com/db/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Delete a record in the database by id.
+func DeleteArecord() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Delete(&db.DeleteRequest{
+		Id: "1",
+Table: "users",
+
 	})
 	fmt.Println(rsp, err)
 	
@@ -58,6 +94,33 @@ To: "events_backup",
 	})
 	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)
+	
 }
 ```
 ## Update
@@ -119,6 +182,34 @@ 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
@@ -177,94 +268,3 @@ func CountEntriesInAtable() {
 	
 }
 ```
-## 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{}{
-	"id": "1",
-	"name": "Jane",
-	"age": 42,
-	"isActive": true,
-},
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Delete
-
-Delete a record in the database by id.
-
-
-[https://m3o.com/db/api#Delete](https://m3o.com/db/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/db"
-)
-
-// Delete a record in the database by id.
-func DeleteArecord() {
-	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := dbService.Delete(&db.DeleteRequest{
-		Id: "1",
-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)
-	
-}
-```

examples/db/create/createARecord/main.go

@@ -12,10 +12,10 @@ 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,
+			"id":       "1",
 		},
 		Table: "users",
 	})

examples/emoji/README.md

@@ -4,36 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Emoji/api](htt
 
 Endpoints:
 
-## Send
-
-Send an emoji to anyone via SMS. Messages are sent in the form '<message> Sent from <from>'
-
-
-[https://m3o.com/emoji/api#Send](https://m3o.com/emoji/api#Send)
-
-```go
-package example
-
-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 SendAtextContainingAnEmojiToAnyoneViaSms() {
-	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)
-	
-}
-```
 ## Find
 
 Find an emoji by its alias e.g :beer:
@@ -119,3 +89,33 @@ func PrintTextIncludingEmoji() {
 	
 }
 ```
+## Send
+
+Send an emoji to anyone via SMS. Messages are sent in the form '<message> Sent from <from>'
+
+
+[https://m3o.com/emoji/api#Send](https://m3o.com/emoji/api#Send)
+
+```go
+package example
+
+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 SendAtextContainingAnEmojiToAnyoneViaSms() {
+	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/function/README.md

@@ -4,35 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
-## Describe
-
-Get the info for a deployed function
-
-
-[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Get the info for a deployed function
-func DescribeFunctionStatus() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Describe(&function.DescribeRequest{
-		Name: "my-first-func",
-Project: "tests",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Deploy
 
 Deploy a group of functions
@@ -151,3 +122,32 @@ Project: "tests",
 	
 }
 ```
+## Describe
+
+Get the info for a deployed function
+
+
+[https://m3o.com/function/api#Describe](https://m3o.com/function/api#Describe)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Get the info for a deployed function
+func DescribeFunctionStatus() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Describe(&function.DescribeRequest{
+		Name: "my-first-func",
+Project: "tests",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/helloworld/README.md

@@ -4,34 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Helloworld/api
 
 Endpoints:
 
-## Call
-
-Call returns a personalised "Hello $name" response
-
-
-[https://m3o.com/helloworld/api#Call](https://m3o.com/helloworld/api#Call)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/helloworld"
-)
-
-// Call returns a personalised "Hello $name" response
-func CallTheHelloworldService() {
-	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := helloworldService.Call(&helloworld.CallRequest{
-		Name: "John",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Stream
 
 Stream returns a stream of "Hello $name" responses
@@ -74,3 +46,31 @@ Name: "John",
 	}
 }
 ```
+## Call
+
+Call returns a personalised "Hello $name" response
+
+
+[https://m3o.com/helloworld/api#Call](https://m3o.com/helloworld/api#Call)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/helloworld"
+)
+
+// Call returns a personalised "Hello $name" response
+func CallTheHelloworldService() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := helloworldService.Call(&helloworld.CallRequest{
+		Name: "John",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/notes/README.md

@@ -4,35 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Notes/api](htt
 
 Endpoints:
 
-## Create
-
-Create a new note
-
-
-[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/notes"
-)
-
-// Create a new note
-func CreateAnote() {
-	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := notesService.Create(&notes.CreateRequest{
-		Text: "This is my note",
-Title: "New Note",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Read
 
 Read a note
@@ -189,3 +160,32 @@ func SubscribeToEvents() {
 	}
 }
 ```
+## Create
+
+Create a new note
+
+
+[https://m3o.com/notes/api#Create](https://m3o.com/notes/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/notes"
+)
+
+// Create a new note
+func CreateAnote() {
+	notesService := notes.NewNotesService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := notesService.Create(&notes.CreateRequest{
+		Text: "This is my note",
+Title: "New Note",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/otp/README.md

@@ -4,6 +4,34 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Otp/api](https
 
 Endpoints:
 
+## Generate
+
+Generate an OTP (one time pass) code
+
+
+[https://m3o.com/otp/api#Generate](https://m3o.com/otp/api#Generate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/otp"
+)
+
+// Generate an OTP (one time pass) code
+func GenerateOtp() {
+	otpService := otp.NewOtpService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := otpService.Generate(&otp.GenerateRequest{
+		Id: "asim@example.com",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Validate
 
 Validate the OTP code
@@ -33,31 +61,3 @@ Id: "asim@example.com",
 	
 }
 ```
-## Generate
-
-Generate an OTP (one time pass) code
-
-
-[https://m3o.com/otp/api#Generate](https://m3o.com/otp/api#Generate)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/otp"
-)
-
-// Generate an OTP (one time pass) code
-func GenerateOtp() {
-	otpService := otp.NewOtpService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := otpService.Generate(&otp.GenerateRequest{
-		Id: "asim@example.com",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/rss/README.md

@@ -4,6 +4,36 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Rss/api](https
 
 Endpoints:
 
+## Add
+
+Add a new RSS feed with a name, url, and category
+
+
+[https://m3o.com/rss/api#Add](https://m3o.com/rss/api#Add)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/rss"
+)
+
+// Add a new RSS feed with a name, url, and category
+func AddAnewFeed() {
+	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := rssService.Add(&rss.AddRequest{
+		Category: "news",
+Name: "bbc",
+Url: "http://feeds.bbci.co.uk/news/rss.xml",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Feed
 
 Get an RSS feed by name. If no name is given, all feeds are returned. Default limit is 25 entries.
@@ -87,33 +117,3 @@ func RemoveAfeed() {
 	
 }
 ```
-## Add
-
-Add a new RSS feed with a name, url, and category
-
-
-[https://m3o.com/rss/api#Add](https://m3o.com/rss/api#Add)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/rss"
-)
-
-// Add a new RSS feed with a name, url, and category
-func AddAnewFeed() {
-	rssService := rss.NewRssService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := rssService.Add(&rss.AddRequest{
-		Category: "news",
-Name: "bbc",
-Url: "http://feeds.bbci.co.uk/news/rss.xml",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/sunnah/README.md

@@ -4,37 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Sunnah/api](ht
 
 Endpoints:
 
-## Hadiths
-
-Hadiths returns a list of hadiths and their corresponding text for a
-given book within a collection.
-
-
-[https://m3o.com/sunnah/api#Hadiths](https://m3o.com/sunnah/api#Hadiths)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/sunnah"
-)
-
-// Hadiths returns a list of hadiths and their corresponding text for a
-// given book within a collection.
-func ListTheHadithsInAbook() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := sunnahService.Hadiths(&sunnah.HadithsRequest{
-		Book: 1,
-Collection: "bukhari",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## Collections
 
 Get a list of available collections. A collection is
@@ -123,3 +92,34 @@ Collection: "bukhari",
 	
 }
 ```
+## Hadiths
+
+Hadiths returns a list of hadiths and their corresponding text for a
+given book within a collection.
+
+
+[https://m3o.com/sunnah/api#Hadiths](https://m3o.com/sunnah/api#Hadiths)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/sunnah"
+)
+
+// Hadiths returns a list of hadiths and their corresponding text for a
+// given book within a collection.
+func ListTheHadithsInAbook() {
+	sunnahService := sunnah.NewSunnahService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := sunnahService.Hadiths(&sunnah.HadithsRequest{
+		Book: 1,
+Collection: "bukhari",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/url/README.md

@@ -4,33 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Url/api](https
 
 Endpoints:
 
-## Proxy
-
-Proxy returns the destination URL of a short URL.
-
-
-[https://m3o.com/url/api#Proxy](https://m3o.com/url/api#Proxy)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/url"
-)
-
-// Proxy returns the destination URL of a short URL.
-func ResolveAshortUrlToAlongDestinationUrl() {
-	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := urlService.Proxy(&url.ProxyRequest{
-		
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
 ## List
 
 List information on all the shortened URLs that you have created
@@ -85,3 +58,30 @@ func ShortenAlongUrl() {
 	
 }
 ```
+## Proxy
+
+Proxy returns the destination URL of a short URL.
+
+
+[https://m3o.com/url/api#Proxy](https://m3o.com/url/api#Proxy)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/url"
+)
+
+// Proxy returns the destination URL of a short URL.
+func ResolveAshortUrlToAlongDestinationUrl() {
+	urlService := url.NewUrlService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := urlService.Proxy(&url.ProxyRequest{
+		
+	})
+	fmt.Println(rsp, err)
+	
+}
+```

examples/user/README.md

@@ -4,6 +4,62 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
+## Logout
+
+Logout a user account
+
+
+[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Logout a user account
+func LogAuserOut() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Logout(&user.LogoutRequest{
+		SessionId: "df91a612-5b24-4634-99ff-240220ab8f55",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## ReadSession
+
+Read a session by the session id. In the event it has expired or is not found and error is returned.
+
+
+[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Read a session by the session id. In the event it has expired or is not found and error is returned.
+func ReadAsessionByTheSessionId() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
+		SessionId: "df91a612-5b24-4634-99ff-240220ab8f55",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
 ## Create
 
 Create a new user account. The email address and username for the account must be unique.
@@ -35,18 +91,12 @@ Username: "joe",
 	
 }
 ```
-## SendVerificationEmail
+## Update
 
-Send a verification email
-to the user being signed up. Email from will be from 'noreply@email.m3ocontent.com',
-but you can provide the title and contents.
-The verification link will be injected in to the email as a template variable, $micro_verification_link.
-Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
-The variable will be replaced with an actual url that will look similar to this:
-'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+Update the account username or email
 
 
-[https://m3o.com/user/api#SendVerificationEmail](https://m3o.com/user/api#SendVerificationEmail)
+[https://m3o.com/user/api#Update](https://m3o.com/user/api#Update)
 
 ```go
 package example
@@ -58,24 +108,100 @@ import(
 	"go.m3o.com/user"
 )
 
-// Send a verification email
-// to the user being signed up. Email from will be from 'noreply@email.m3ocontent.com',
-// but you can provide the title and contents.
-// The verification link will be injected in to the email as a template variable, $micro_verification_link.
-// Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
-// The variable will be replaced with an actual url that will look similar to this:
-// 'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
-func SendVerificationEmail() {
+// Update the account username or email
+func UpdateAnAccount() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.SendVerificationEmail(&user.SendVerificationEmailRequest{
-		Email: "joe@example.com",
-FailureRedirectUrl: "https://m3o.com/verification-failed",
-FromName: "Awesome Dot Com",
-RedirectUrl: "https://m3o.com",
-Subject: "Email verification",
-TextContent: `Hi there,
+	rsp, err := userService.Update(&user.UpdateRequest{
+		Email: "joe+2@example.com",
+Id: "user-1",
 
-Please verify your email by clicking this link: $micro_verification_link`,
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## ResetPassword
+
+Reset password with the code sent by the "SendPasswordResetEmail" endoint.
+
+
+[https://m3o.com/user/api#ResetPassword](https://m3o.com/user/api#ResetPassword)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Reset password with the code sent by the "SendPasswordResetEmail" endoint.
+func ResetPassword() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.ResetPassword(&user.ResetPasswordRequest{
+		Code: "012345",
+ConfirmPassword: "NewPassword1",
+Email: "joe@example.com",
+NewPassword: "NewPassword1",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## VerifyEmail
+
+Verify the email address of an account from a token sent in an email to the user.
+
+
+[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Verify the email address of an account from a token sent in an email to the user.
+func VerifyEmail() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+		Email: "joe@example.com",
+Token: "012345",
+
+	})
+	fmt.Println(rsp, err)
+	
+}
+```
+## Delete
+
+Delete an account by id
+
+
+[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Delete an account by id
+func DeleteUserAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Delete(&user.DeleteRequest{
+		Id: "8b98acbe-0b6a-4d66-a414-5ffbf666786f",
 
 	})
 	fmt.Println(rsp, err)
@@ -113,12 +239,12 @@ Password: "Password1",
 	
 }
 ```
-## ReadSession
+## List
 
-Read a session by the session id. In the event it has expired or is not found and error is returned.
+List all users. Returns a paged list of results
 
 
-[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
+[https://m3o.com/user/api#List](https://m3o.com/user/api#List)
 
 ```go
 package example
@@ -130,40 +256,12 @@ import(
 	"go.m3o.com/user"
 )
 
-// Read a session by the session id. In the event it has expired or is not found and error is returned.
-func ReadAsessionByTheSessionId() {
+// List all users. Returns a paged list of results
+func ListAllUsers() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
-		SessionId: "df91a612-5b24-4634-99ff-240220ab8f55",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Update
-
-Update the account username or email
-
-
-[https://m3o.com/user/api#Update](https://m3o.com/user/api#Update)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Update the account username or email
-func UpdateAnAccount() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Update(&user.UpdateRequest{
-		Email: "joe+2@example.com",
-Id: "user-1",
+	rsp, err := userService.List(&user.ListRequest{
+		Limit: 100,
+Offset: 0,
 
 	})
 	fmt.Println(rsp, err)
@@ -282,6 +380,53 @@ func ReadAccountByEmail() {
 	})
 	fmt.Println(rsp, err)
 	
+}
+```
+## SendVerificationEmail
+
+Send a verification email
+to the user being signed up. Email from will be from 'noreply@email.m3ocontent.com',
+but you can provide the title and contents.
+The verification link will be injected in to the email as a template variable, $micro_verification_link.
+Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+The variable will be replaced with an actual url that will look similar to this:
+'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+
+
+[https://m3o.com/user/api#SendVerificationEmail](https://m3o.com/user/api#SendVerificationEmail)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Send a verification email
+// to the user being signed up. Email from will be from 'noreply@email.m3ocontent.com',
+// but you can provide the title and contents.
+// The verification link will be injected in to the email as a template variable, $micro_verification_link.
+// Example: 'Hi there, welcome onboard! Use the link below to verify your email: $micro_verification_link'
+// The variable will be replaced with an actual url that will look similar to this:
+// 'https://user.m3o.com/user/verify?token=a-verification-token&redirectUrl=your-redir-url'
+func SendVerificationEmail() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.SendVerificationEmail(&user.SendVerificationEmailRequest{
+		Email: "joe@example.com",
+FailureRedirectUrl: "https://m3o.com/verification-failed",
+FromName: "Awesome Dot Com",
+RedirectUrl: "https://m3o.com",
+Subject: "Email verification",
+TextContent: `Hi there,
+
+Please verify your email by clicking this link: $micro_verification_link`,
+
+	})
+	fmt.Println(rsp, err)
+	
 }
 ```
 ## SendPasswordResetEmail
@@ -318,119 +463,3 @@ TextContent: `Hi there,
 	
 }
 ```
-## ResetPassword
-
-Reset password with the code sent by the "SendPasswordResetEmail" endoint.
-
-
-[https://m3o.com/user/api#ResetPassword](https://m3o.com/user/api#ResetPassword)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Reset password with the code sent by the "SendPasswordResetEmail" endoint.
-func ResetPassword() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ResetPassword(&user.ResetPasswordRequest{
-		Code: "012345",
-ConfirmPassword: "NewPassword1",
-Email: "joe@example.com",
-NewPassword: "NewPassword1",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## VerifyEmail
-
-Verify the email address of an account from a token sent in an email to the user.
-
-
-[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Verify the email address of an account from a token sent in an email to the user.
-func VerifyEmail() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
-		Email: "joe@example.com",
-Token: "012345",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Delete
-
-Delete an account by id
-
-
-[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Delete an account by id
-func DeleteUserAccount() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Delete(&user.DeleteRequest{
-		Id: "8b98acbe-0b6a-4d66-a414-5ffbf666786f",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```
-## Logout
-
-Logout a user account
-
-
-[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Logout a user account
-func LogAuserOut() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Logout(&user.LogoutRequest{
-		SessionId: "df91a612-5b24-4634-99ff-240220ab8f55",
-
-	})
-	fmt.Println(rsp, err)
-	
-}
-```

examples/user/list/listAllUsers/main.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// List all users. Returns a paged list of results
+func main() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.List(&user.ListRequest{
+		Limit:  100,
+		Offset: 0,
+	})
+	fmt.Println(rsp, err)
+
+}

examples/weather/README.md

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

user/user.go

@@ -32,6 +32,14 @@ func (t *UserService) Delete(request *DeleteRequest) (*DeleteResponse, error) {
 
 }
 
+// List all users. Returns a paged list of results
+func (t *UserService) List(request *ListRequest) (*ListResponse, error) {
+
+	rsp := &ListResponse{}
+	return rsp, t.client.Call("user", "List", request, rsp)
+
+}
+
 // Login using username or email. The response will return a new session for successful login,
 // 401 in the case of login failure and 500 for any other error
 func (t *UserService) Login(request *LoginRequest) (*LoginResponse, error) {
@@ -164,6 +172,17 @@ type DeleteRequest struct {
 type DeleteResponse struct {
 }
 
+type ListRequest struct {
+	// Maximum number of records to return. Default limit is 25.
+	// Maximum limit is 1000. Anything higher will return an error.
+	Limit  int32 `json:"limit"`
+	Offset int32 `json:"offset"`
+}
+
+type ListResponse struct {
+	Users []Account `json:"users"`
+}
+
 type LoginRequest struct {
 	// The email address of the user
 	Email string `json:"email"`