Commit from m3o/m3o action

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:
 
-## Quote
-
-Get the last quote for a given crypto ticker
-
-
-[https://m3o.com/crypto/api#Quote](https://m3o.com/crypto/api#Quote)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Get the last quote for a given crypto ticker
-func GetAcryptocurrencyQuote() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.Quote(&crypto.QuoteRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## History
-
-Returns the history for the previous close
-
-
-[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/crypto"
-)
-
-// Returns the history for the previous close
-func GetPreviousClose() {
-	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := cryptoService.History(&crypto.HistoryRequest{
-		Symbol: "BTCUSD",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## News
 
 Get news related to a currency
@@ -112,3 +58,57 @@ func GetCryptocurrencyPrice() {
 	fmt.Println(rsp, err)
 }
 ```
+## Quote
+
+Get the last quote for a given crypto ticker
+
+
+[https://m3o.com/crypto/api#Quote](https://m3o.com/crypto/api#Quote)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Get the last quote for a given crypto ticker
+func GetAcryptocurrencyQuote() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.Quote(&crypto.QuoteRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## History
+
+Returns the history for the previous close
+
+
+[https://m3o.com/crypto/api#History](https://m3o.com/crypto/api#History)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/crypto"
+)
+
+// Returns the history for the previous close
+func GetPreviousClose() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := cryptoService.History(&crypto.HistoryRequest{
+		Symbol: "BTCUSD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/currency/README.md

@@ -4,59 +4,6 @@ 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
@@ -142,3 +89,56 @@ Date: "2021-05-30",
 	fmt.Println(rsp, err)
 }
 ```
+## Codes
+
+Codes returns the supported currency codes for the API
+
+
+[https://m3o.com/currency/api#Codes](https://m3o.com/currency/api#Codes)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Codes returns the supported currency codes for the API
+func GetSupportedCodes() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Codes(&currency.CodesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Rates
+
+Rates returns the currency rates for a given code e.g USD
+
+
+[https://m3o.com/currency/api#Rates](https://m3o.com/currency/api#Rates)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/currency"
+)
+
+// Rates returns the currency rates for a given code e.g USD
+func GetRatesForUsd() {
+	currencyService := currency.NewCurrencyService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := currencyService.Rates(&currency.RatesRequest{
+		Code: "USD",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/db/README.md

@@ -4,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{}{
-	"id": "1",
-	"name": "Jane",
-	"age": 42,
-	"isActive": true,
-},
-Table: "users",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Update
 
 Update a record in the database. Include an "id" in the record to update.
@@ -178,3 +91,90 @@ Table: "users",
 	fmt.Println(rsp, err)
 }
 ```
+## Truncate
+
+Truncate the records in a table
+
+
+[https://m3o.com/db/api#Truncate](https://m3o.com/db/api#Truncate)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Truncate the records in a table
+func TruncateTable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Truncate(&db.TruncateRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Count
+
+Count records in a table
+
+
+[https://m3o.com/db/api#Count](https://m3o.com/db/api#Count)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/db"
+)
+
+// Count records in a table
+func CountEntriesInAtable() {
+	dbService := db.NewDbService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := dbService.Count(&db.CountRequest{
+		Table: "users",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## 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{}{
+	"age": 42,
+	"isActive": true,
+	"id": "1",
+	"name": "Jane",
+},
+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{}{
-			"id":       "1",
 			"name":     "Jane",
 			"age":      42,
 			"isActive": true,
+			"id":       "1",
 		},
 		Table: "users",
 	})

examples/emoji/README.md

@@ -4,6 +4,33 @@ 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
@@ -88,30 +115,3 @@ 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)
-}
-```

examples/function/README.md

@@ -4,6 +4,66 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Function/api](
 
 Endpoints:
 
+## Deploy
+
+Deploy a group of functions
+
+
+[https://m3o.com/function/api#Deploy](https://m3o.com/function/api#Deploy)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Deploy a group of functions
+func DeployAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Deploy(&function.DeployRequest{
+		Entrypoint: "helloworld",
+Name: "my-first-func",
+Project: "tests",
+Repo: "github.com/m3o/nodejs-function-example",
+Runtime: "nodejs14",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Call
+
+Call a function by name
+
+
+[https://m3o.com/function/api#Call](https://m3o.com/function/api#Call)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/function"
+)
+
+// Call a function by name
+func CallAfunction() {
+	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := functionService.Call(&function.CallRequest{
+		Name: "my-first-func",
+Request: map[string]interface{}{
+},
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## List
 
 List all the deployed functions
@@ -86,63 +146,3 @@ Project: "tests",
 	fmt.Println(rsp, err)
 }
 ```
-## Deploy
-
-Deploy a group of functions
-
-
-[https://m3o.com/function/api#Deploy](https://m3o.com/function/api#Deploy)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Deploy a group of functions
-func DeployAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Deploy(&function.DeployRequest{
-		Entrypoint: "helloworld",
-Name: "my-first-func",
-Project: "tests",
-Repo: "github.com/m3o/nodejs-function-example",
-Runtime: "nodejs14",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Call
-
-Call a function by name
-
-
-[https://m3o.com/function/api#Call](https://m3o.com/function/api#Call)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/function"
-)
-
-// Call a function by name
-func CallAfunction() {
-	functionService := function.NewFunctionService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := functionService.Call(&function.CallRequest{
-		Name: "my-first-func",
-Request: map[string]interface{}{
-},
-
-	})
-	fmt.Println(rsp, err)
-}
-```

examples/holidays/README.md

@@ -4,32 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Holidays/api](
 
 Endpoints:
 
-## Countries
-
-Get the list of countries that are supported by this API
-
-
-[https://m3o.com/holidays/api#Countries](https://m3o.com/holidays/api#Countries)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/holidays"
-)
-
-// Get the list of countries that are supported by this API
-func ListCountries() {
-	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := holidaysService.Countries(&holidays.CountriesRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## List
 
 List the holiday dates for a given country and year
@@ -57,3 +31,29 @@ func GetHolidays() {
 	fmt.Println(rsp, err)
 }
 ```
+## Countries
+
+Get the list of countries that are supported by this API
+
+
+[https://m3o.com/holidays/api#Countries](https://m3o.com/holidays/api#Countries)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/holidays"
+)
+
+// Get the list of countries that are supported by this API
+func ListCountries() {
+	holidaysService := holidays.NewHolidaysService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := holidaysService.Countries(&holidays.CountriesRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/location/README.md

@@ -4,39 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Location/api](
 
 Endpoints:
 
-## Search
-
-Search for entities in a given radius
-
-
-[https://m3o.com/location/api#Search](https://m3o.com/location/api#Search)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/location"
-)
-
-// Search for entities in a given radius
-func SearchForLocations() {
-	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := locationService.Search(&location.SearchRequest{
-		Center: &location.Point{
-	Latitude: 51.511061,
-	Longitude: -0.120022,
-	},
-NumEntities: 10,
-Radius: 100,
-Type: "bike",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Save
 
 Save an entity's current position
@@ -99,3 +66,36 @@ func GetLocationById() {
 	fmt.Println(rsp, err)
 }
 ```
+## Search
+
+Search for entities in a given radius
+
+
+[https://m3o.com/location/api#Search](https://m3o.com/location/api#Search)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/location"
+)
+
+// Search for entities in a given radius
+func SearchForLocations() {
+	locationService := location.NewLocationService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := locationService.Search(&location.SearchRequest{
+		Center: &location.Point{
+	Latitude: 51.511061,
+	Longitude: -0.120022,
+	},
+NumEntities: 10,
+Radius: 100,
+Type: "bike",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/notes/README.md

@@ -4,34 +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
@@ -170,3 +142,31 @@ func SubscribeToEvents() {
 	fmt.Println(rsp, err)
 }
 ```
+## 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/routing/README.md

@@ -4,40 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Routing/api](h
 
 Endpoints:
 
-## Route
-
-Retrieve a route as a simple list of gps points along with total distance and estimated duration
-
-
-[https://m3o.com/routing/api#Route](https://m3o.com/routing/api#Route)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/routing"
-)
-
-// Retrieve a route as a simple list of gps points along with total distance and estimated duration
-func GpsPointsForAroute() {
-	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := routingService.Route(&routing.RouteRequest{
-		Destination: &routing.Point{
-	Latitude: 52.529407,
-	Longitude: 13.397634,
-},
-Origin: &routing.Point{
-	Latitude: 52.517037,
-	Longitude: 13.38886,
-},
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Eta
 
 Get the eta for a route from origin to destination. The eta is an estimated time based on car routes
@@ -106,3 +72,37 @@ Origin: &routing.Point{
 	fmt.Println(rsp, err)
 }
 ```
+## Route
+
+Retrieve a route as a simple list of gps points along with total distance and estimated duration
+
+
+[https://m3o.com/routing/api#Route](https://m3o.com/routing/api#Route)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/routing"
+)
+
+// Retrieve a route as a simple list of gps points along with total distance and estimated duration
+func GpsPointsForAroute() {
+	routingService := routing.NewRoutingService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := routingService.Route(&routing.RouteRequest{
+		Destination: &routing.Point{
+	Latitude: 52.529407,
+	Longitude: 13.397634,
+},
+Origin: &routing.Point{
+	Latitude: 52.517037,
+	Longitude: 13.38886,
+},
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/twitter/README.md

@@ -4,59 +4,6 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/Twitter/api](h
 
 Endpoints:
 
-## Trends
-
-Get the current global trending topics
-
-
-[https://m3o.com/twitter/api#Trends](https://m3o.com/twitter/api#Trends)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/twitter"
-)
-
-// Get the current global trending topics
-func GetTheCurrentGlobalTrendingTopics() {
-	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := twitterService.Trends(&twitter.TrendsRequest{
-		
-	})
-	fmt.Println(rsp, err)
-}
-```
-## User
-
-Get a user's twitter profile
-
-
-[https://m3o.com/twitter/api#User](https://m3o.com/twitter/api#User)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/twitter"
-)
-
-// Get a user's twitter profile
-func GetAusersTwitterProfile() {
-	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := twitterService.User(&twitter.UserRequest{
-		Username: "crufter",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
 ## Timeline
 
 Get the timeline for a given user
@@ -112,3 +59,56 @@ func SearchForTweets() {
 	fmt.Println(rsp, err)
 }
 ```
+## Trends
+
+Get the current global trending topics
+
+
+[https://m3o.com/twitter/api#Trends](https://m3o.com/twitter/api#Trends)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/twitter"
+)
+
+// Get the current global trending topics
+func GetTheCurrentGlobalTrendingTopics() {
+	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := twitterService.Trends(&twitter.TrendsRequest{
+		
+	})
+	fmt.Println(rsp, err)
+}
+```
+## User
+
+Get a user's twitter profile
+
+
+[https://m3o.com/twitter/api#User](https://m3o.com/twitter/api#User)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/twitter"
+)
+
+// Get a user's twitter profile
+func GetAusersTwitterProfile() {
+	twitterService := twitter.NewTwitterService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := twitterService.User(&twitter.UserRequest{
+		Username: "crufter",
+
+	})
+	fmt.Println(rsp, err)
+}
+```

examples/user/README.md

@@ -4,12 +4,12 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
 
 Endpoints:
 
-## Logout
+## UpdatePassword
 
-Logout a user account
+Update the account password
 
 
-[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
+[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
 
 ```go
 package example
@@ -21,16 +21,187 @@ import(
 	"go.m3o.com/user"
 )
 
-// Logout a user account
+// Update the account password
-func LogAuserOut() {
+func UpdateTheAccountPassword() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Logout(&user.LogoutRequest{
+	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
+		ConfirmPassword: "myEvenMoreSecretPass123",
+NewPassword: "myEvenMoreSecretPass123",
+OldPassword: "mySecretPass123",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## VerifyEmail
+
+Verify the email address of an account from a token sent in an email to the user.
+
+
+[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Verify the email address of an account from a token sent in an email to the user.
+func VerifyEmail() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+		Token: "t2323t232t",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Delete
+
+Delete an account by id
+
+
+[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Delete an account by id
+func DeleteUserAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Delete(&user.DeleteRequest{
+		Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## Login
+
+Login using username or email. The response will return a new session for successful login,
+401 in the case of login failure and 500 for any other error
+
+
+[https://m3o.com/user/api#Login](https://m3o.com/user/api#Login)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Login using username or email. The response will return a new session for successful login,
+// 401 in the case of login failure and 500 for any other error
+func LogAuserIn() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Login(&user.LoginRequest{
+		Email: "joe@example.com",
+Password: "mySecretPass123",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
+## ReadSession
+
+Read a session by the session id. In the event it has expired or is not found and error is returned.
+
+
+[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Read a session by the session id. In the event it has expired or is not found and error is returned.
+func ReadAsessionByTheSessionId() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
 		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
 
 	})
 	fmt.Println(rsp, err)
 }
 ```
+## Create
+
+Create a new user account. The email address and username for the account must be unique.
+
+
+[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
+
+```go
+package example
+
+import(
+	"fmt"
+	"os"
+
+	"go.m3o.com/user"
+)
+
+// Create a new user account. The email address and username for the account must be unique.
+func CreateAnAccount() {
+	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
+	rsp, err := userService.Create(&user.CreateRequest{
+		Email: "joe@example.com",
+Id: "usrid-1",
+Password: "mySecretPass123",
+Username: "usrname-1",
+
+	})
+	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: "joeotheremail@example.com",
+Id: "usrid-1",
+
+	})
+	fmt.Println(rsp, err)
+}
+```
 ## Read
 
 Read an account by id, username or email. Only one need to be specified.
@@ -158,12 +329,12 @@ Please verify your email by clicking this link: $micro_verification_link`,
 	fmt.Println(rsp, err)
 }
 ```
-## VerifyEmail
+## Logout
 
-Verify the email address of an account from a token sent in an email to the user.
+Logout a user account
 
 
-[https://m3o.com/user/api#VerifyEmail](https://m3o.com/user/api#VerifyEmail)
+[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
 
 ```go
 package example
@@ -175,181 +346,10 @@ import(
 	"go.m3o.com/user"
 )
 
-// Verify the email address of an account from a token sent in an email to the user.
+// Logout a user account
-func VerifyEmail() {
+func LogAuserOut() {
 	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+	rsp, err := userService.Logout(&user.LogoutRequest{
-		Token: "t2323t232t",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Delete
-
-Delete an account by id
-
-
-[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Delete an account by id
-func DeleteUserAccount() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Delete(&user.DeleteRequest{
-		Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Login
-
-Login using username or email. The response will return a new session for successful login,
-401 in the case of login failure and 500 for any other error
-
-
-[https://m3o.com/user/api#Login](https://m3o.com/user/api#Login)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Login using username or email. The response will return a new session for successful login,
-// 401 in the case of login failure and 500 for any other error
-func LogAuserIn() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Login(&user.LoginRequest{
-		Email: "joe@example.com",
-Password: "mySecretPass123",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## Create
-
-Create a new user account. The email address and username for the account must be unique.
-
-
-[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Create a new user account. The email address and username for the account must be unique.
-func CreateAnAccount() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.Create(&user.CreateRequest{
-		Email: "joe@example.com",
-Id: "usrid-1",
-Password: "mySecretPass123",
-Username: "usrname-1",
-
-	})
-	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: "joeotheremail@example.com",
-Id: "usrid-1",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## UpdatePassword
-
-Update the account password
-
-
-[https://m3o.com/user/api#UpdatePassword](https://m3o.com/user/api#UpdatePassword)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Update the account password
-func UpdateTheAccountPassword() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
-		ConfirmPassword: "myEvenMoreSecretPass123",
-NewPassword: "myEvenMoreSecretPass123",
-OldPassword: "mySecretPass123",
-
-	})
-	fmt.Println(rsp, err)
-}
-```
-## ReadSession
-
-Read a session by the session id. In the event it has expired or is not found and error is returned.
-
-
-[https://m3o.com/user/api#ReadSession](https://m3o.com/user/api#ReadSession)
-
-```go
-package example
-
-import(
-	"fmt"
-	"os"
-
-	"go.m3o.com/user"
-)
-
-// Read a session by the session id. In the event it has expired or is not found and error is returned.
-func ReadAsessionByTheSessionId() {
-	userService := user.NewUserService(os.Getenv("M3O_API_TOKEN"))
-	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
 		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
 
 	})