Amend examples (#211)

examples/crypto/news/curl/getCryptocurrencyNews.sh

@@ -1,6 +1,6 @@
-curl "https://api.m3o.com/v1/sunnah/Books" \
+curl "https://api.m3o.com/v1/crypto/News" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $MICRO_API_TOKEN" \
 -d '{
-  "collection": "bukhari"
+  "symbol": "BTCUSD"
 }'

examples/crypto/news/go/getCryptocurrencyNews.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/crypto"
+	"os"
+)
+
+// Get news related to a currency
+func GetCryptocurrencyNews() {
+	cryptoService := crypto.NewCryptoService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := cryptoService.News(&crypto.NewsRequest{
+		Symbol: "BTCUSD",
+	})
+	fmt.Println(rsp, err)
+}

examples/crypto/news/node/getCryptocurrencyNews.js

@@ -0,0 +1,12 @@
+import * as crypto from "m3o/crypto";
+
+// Get news related to a currency
+async function GetCryptocurrencyNews() {
+  let cryptoService = new crypto.CryptoService(process.env.MICRO_API_TOKEN);
+  let rsp = await cryptoService.news({
+    symbol: "BTCUSD",
+  });
+  console.log(rsp);
+}
+
+await GetCryptocurrencyNews();

examples/currency/history/curl/historicRatesForACurrency.sh

@@ -0,0 +1,7 @@
+curl "https://api.m3o.com/v1/currency/History" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "code": "USD",
+  "date": "2021-05-30"
+}'

examples/currency/history/go/historicRatesForACurrency.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/currency"
+	"os"
+)
+
+// Returns the historic rates for a currency on a given date
+func HistoricRatesForAcurrency() {
+	currencyService := currency.NewCurrencyService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := currencyService.History(&currency.HistoryRequest{
+		Code: "USD",
+		Date: "2021-05-30",
+	})
+	fmt.Println(rsp, err)
+}

examples/currency/history/node/historicRatesForACurrency.js

@@ -0,0 +1,15 @@
+import * as currency from "m3o/currency";
+
+// Returns the historic rates for a currency on a given date
+async function HistoricRatesForAcurrency() {
+  let currencyService = new currency.CurrencyService(
+    process.env.MICRO_API_TOKEN
+  );
+  let rsp = await currencyService.history({
+    code: "USD",
+    date: "2021-05-30",
+  });
+  console.log(rsp);
+}
+
+await HistoricRatesForAcurrency();

examples/helloworld/stream/curl/streamsAreCurrentlyTemporarilyNotSupportedInClients.sh

@@ -1,7 +1,6 @@
-curl "https://api.m3o.com/v1/sunnah/Hadiths" \
+curl "https://api.m3o.com/v1/helloworld/Stream" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $MICRO_API_TOKEN" \
 -d '{
-  "book": 1,
-  "collection": "bukhari"
+  "name": "not supported"
 }'

examples/helloworld/stream/go/streamsAreCurrentlyTemporarilyNotSupportedInClients.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/helloworld"
+	"os"
+)
+
+// Stream returns a stream of "Hello $name" responses
+func StreamsAreCurrentlyTemporarilyNotSupportedInClients() {
+	helloworldService := helloworld.NewHelloworldService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := helloworldService.Stream(&helloworld.StreamRequest{
+		Name: "not supported",
+	})
+	fmt.Println(rsp, err)
+}

examples/helloworld/stream/node/streamsAreCurrentlyTemporarilyNotSupportedInClients.js

@@ -0,0 +1,14 @@
+import * as helloworld from "m3o/helloworld";
+
+// Stream returns a stream of "Hello $name" responses
+async function StreamsAreCurrentlyTemporarilyNotSupportedInClients() {
+  let helloworldService = new helloworld.HelloworldService(
+    process.env.MICRO_API_TOKEN
+  );
+  let rsp = await helloworldService.stream({
+    name: "not supported",
+  });
+  console.log(rsp);
+}
+
+await StreamsAreCurrentlyTemporarilyNotSupportedInClients();

examples/id/types/curl/listTheTypesOfIdsAvailable.sh

@@ -1,4 +1,4 @@
-curl "https://api.m3o.com/v1/sunnah/Collections" \
+curl "https://api.m3o.com/v1/id/Types" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $MICRO_API_TOKEN" \
 -d '{}'

examples/id/types/go/listTheTypesOfIdsAvailable.go

@@ -0,0 +1,14 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/id"
+	"os"
+)
+
+// List the types of IDs available. No query params needed.
+func ListTheTypesOfIdsAvailable() {
+	idService := id.NewIdService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := idService.Types(&id.TypesRequest{})
+	fmt.Println(rsp, err)
+}

examples/id/types/node/listTheTypesOfIdsAvailable.js

@@ -0,0 +1,10 @@
+import * as id from "m3o/id";
+
+// List the types of IDs available. No query params needed.
+async function ListTheTypesOfIdsAvailable() {
+  let idService = new id.IdService(process.env.MICRO_API_TOKEN);
+  let rsp = await idService.types({});
+  console.log(rsp);
+}
+
+await ListTheTypesOfIdsAvailable();

examples/sunnah/books/go/getTheBooksWithinACollection.go

@@ -1,17 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"github.com/micro/services/clients/go/sunnah"
-	"os"
-)
-
-// Get a list of books from within a collection. A book can contain many chapters
-// each with its own hadiths.
-func GetTheBooksWithinAcollection() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("MICRO_API_TOKEN"))
-	rsp, err := sunnahService.Books(&sunnah.BooksRequest{
-		Collection: "bukhari",
-	})
-	fmt.Println(rsp, err)
-}

examples/sunnah/books/node/getTheBooksWithinACollection.js

@@ -1,13 +0,0 @@
-import * as sunnah from "m3o/sunnah";
-
-// Get a list of books from within a collection. A book can contain many chapters
-// each with its own hadiths.
-async function GetTheBooksWithinAcollection() {
-  let sunnahService = new sunnah.SunnahService(process.env.MICRO_API_TOKEN);
-  let rsp = await sunnahService.books({
-    collection: "bukhari",
-  });
-  console.log(rsp);
-}
-
-await GetTheBooksWithinAcollection();

examples/sunnah/chapters/go/listTheChaptersInABook.go

@@ -1,17 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"github.com/micro/services/clients/go/sunnah"
-	"os"
-)
-
-// Get all the chapters of a given book within a collection.
-func ListTheChaptersInAbook() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("MICRO_API_TOKEN"))
-	rsp, err := sunnahService.Chapters(&sunnah.ChaptersRequest{
-		Book:       1,
-		Collection: "bukhari",
-	})
-	fmt.Println(rsp, err)
-}

examples/sunnah/chapters/node/listTheChaptersInABook.js

@@ -1,13 +0,0 @@
-import * as sunnah from "m3o/sunnah";
-
-// Get all the chapters of a given book within a collection.
-async function ListTheChaptersInAbook() {
-  let sunnahService = new sunnah.SunnahService(process.env.MICRO_API_TOKEN);
-  let rsp = await sunnahService.chapters({
-    book: 1,
-    collection: "bukhari",
-  });
-  console.log(rsp);
-}
-
-await ListTheChaptersInAbook();

examples/sunnah/collections/go/listAvailableCollections.go

@@ -1,15 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"github.com/micro/services/clients/go/sunnah"
-	"os"
-)
-
-// Get a list of available collections. A collection is
-// a compilation of hadiths collected and written by an author.
-func ListAvailableCollections() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("MICRO_API_TOKEN"))
-	rsp, err := sunnahService.Collections(&sunnah.CollectionsRequest{})
-	fmt.Println(rsp, err)
-}

examples/sunnah/collections/node/listAvailableCollections.js

@@ -1,11 +0,0 @@
-import * as sunnah from "m3o/sunnah";
-
-// Get a list of available collections. A collection is
-// a compilation of hadiths collected and written by an author.
-async function ListAvailableCollections() {
-  let sunnahService = new sunnah.SunnahService(process.env.MICRO_API_TOKEN);
-  let rsp = await sunnahService.collections({});
-  console.log(rsp);
-}
-
-await ListAvailableCollections();

examples/sunnah/hadiths/go/listTheHadithsInABook.go

@@ -1,18 +0,0 @@
-package example
-
-import (
-	"fmt"
-	"github.com/micro/services/clients/go/sunnah"
-	"os"
-)
-
-// Hadiths returns a list of hadiths and their corresponding text for a
-// given book within a collection.
-func ListTheHadithsInAbook() {
-	sunnahService := sunnah.NewSunnahService(os.Getenv("MICRO_API_TOKEN"))
-	rsp, err := sunnahService.Hadiths(&sunnah.HadithsRequest{
-		Book:       1,
-		Collection: "bukhari",
-	})
-	fmt.Println(rsp, err)
-}

examples/sunnah/hadiths/node/listTheHadithsInABook.js

@@ -1,14 +0,0 @@
-import * as sunnah from "m3o/sunnah";
-
-// Hadiths returns a list of hadiths and their corresponding text for a
-// given book within a collection.
-async function ListTheHadithsInAbook() {
-  let sunnahService = new sunnah.SunnahService(process.env.MICRO_API_TOKEN);
-  let rsp = await sunnahService.hadiths({
-    book: 1,
-    collection: "bukhari",
-  });
-  console.log(rsp);
-}
-
-await ListTheHadithsInAbook();

examples/twitter/search/curl/searchForTweets.sh

@@ -1,7 +1,6 @@
-curl "https://api.m3o.com/v1/sunnah/Chapters" \
+curl "https://api.m3o.com/v1/twitter/Search" \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer $MICRO_API_TOKEN" \
 -d '{
-  "book": 1,
-  "collection": "bukhari"
+  "query": "cats"
 }'

examples/twitter/search/go/searchForTweets.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/twitter"
+	"os"
+)
+
+// Search for tweets with a simple query
+func SearchForTweets() {
+	twitterService := twitter.NewTwitterService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := twitterService.Search(&twitter.SearchRequest{
+		Query: "cats",
+	})
+	fmt.Println(rsp, err)
+}

examples/twitter/search/node/searchForTweets.js

@@ -0,0 +1,12 @@
+import * as twitter from "m3o/twitter";
+
+// Search for tweets with a simple query
+async function SearchForTweets() {
+  let twitterService = new twitter.TwitterService(process.env.MICRO_API_TOKEN);
+  let rsp = await twitterService.search({
+    query: "cats",
+  });
+  console.log(rsp);
+}
+
+await SearchForTweets();

examples/twitter/trends/curl/getTheCurrentGlobalTrendingTopics.sh

@@ -0,0 +1,4 @@
+curl "https://api.m3o.com/v1/twitter/Trends" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{}'

examples/twitter/trends/go/getTheCurrentGlobalTrendingTopics.go

@@ -0,0 +1,14 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/twitter"
+	"os"
+)
+
+// Get the current global trending topics
+func GetTheCurrentGlobalTrendingTopics() {
+	twitterService := twitter.NewTwitterService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := twitterService.Trends(&twitter.TrendsRequest{})
+	fmt.Println(rsp, err)
+}

examples/twitter/trends/node/getTheCurrentGlobalTrendingTopics.js

@@ -0,0 +1,10 @@
+import * as twitter from "m3o/twitter";
+
+// Get the current global trending topics
+async function GetTheCurrentGlobalTrendingTopics() {
+  let twitterService = new twitter.TwitterService(process.env.MICRO_API_TOKEN);
+  let rsp = await twitterService.trends({});
+  console.log(rsp);
+}
+
+await GetTheCurrentGlobalTrendingTopics();

examples/twitter/user/curl/getAUsersTwitterProfile.sh

@@ -0,0 +1,6 @@
+curl "https://api.m3o.com/v1/twitter/User" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "username": "crufter"
+}'

examples/twitter/user/go/getAUsersTwitterProfile.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/twitter"
+	"os"
+)
+
+// Get a user's twitter profile
+func GetAusersTwitterProfile() {
+	twitterService := twitter.NewTwitterService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := twitterService.User(&twitter.UserRequest{
+		Username: "crufter",
+	})
+	fmt.Println(rsp, err)
+}

examples/twitter/user/node/getAUsersTwitterProfile.js

@@ -0,0 +1,12 @@
+import * as twitter from "m3o/twitter";
+
+// Get a user's twitter profile
+async function GetAusersTwitterProfile() {
+  let twitterService = new twitter.TwitterService(process.env.MICRO_API_TOKEN);
+  let rsp = await twitterService.user({
+    username: "crufter",
+  });
+  console.log(rsp);
+}
+
+await GetAusersTwitterProfile();

examples/user/readSession/curl/readASessionByTheSessionId.sh

@@ -0,0 +1,6 @@
+curl "https://api.m3o.com/v1/user/ReadSession" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "sessionId": "sds34s34s34-s34s34-s43s43s34-s4s34s"
+}'

examples/user/readSession/go/readASessionByTheSessionId.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/user"
+	"os"
+)
+
+// 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("MICRO_API_TOKEN"))
+	rsp, err := userService.ReadSession(&user.ReadSessionRequest{
+		SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
+	})
+	fmt.Println(rsp, err)
+}

examples/user/readSession/node/readASessionByTheSessionId.js

@@ -0,0 +1,12 @@
+import * as user from "m3o/user";
+
+// Read a session by the session id. In the event it has expired or is not found and error is returned.
+async function ReadAsessionByTheSessionId() {
+  let userService = new user.UserService(process.env.MICRO_API_TOKEN);
+  let rsp = await userService.readSession({
+    sessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
+  });
+  console.log(rsp);
+}
+
+await ReadAsessionByTheSessionId();

examples/user/update/curl/updateAnAccount.sh

@@ -0,0 +1,7 @@
+curl "https://api.m3o.com/v1/user/Update" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "email": "joeotheremail@example.com",
+  "id": "usrid-1"
+}'

examples/user/update/go/updateAnAccount.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/user"
+	"os"
+)
+
+// Update the account username or email
+func UpdateAnAccount() {
+	userService := user.NewUserService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := userService.Update(&user.UpdateRequest{
+		Email: "joeotheremail@example.com",
+		Id:    "usrid-1",
+	})
+	fmt.Println(rsp, err)
+}

examples/user/update/node/updateAnAccount.js

@@ -0,0 +1,13 @@
+import * as user from "m3o/user";
+
+// Update the account username or email
+async function UpdateAnAccount() {
+  let userService = new user.UserService(process.env.MICRO_API_TOKEN);
+  let rsp = await userService.update({
+    email: "joeotheremail@example.com",
+    id: "usrid-1",
+  });
+  console.log(rsp);
+}
+
+await UpdateAnAccount();

examples/user/updatePassword/curl/updateTheAccountPassword.sh

@@ -0,0 +1,9 @@
+curl "https://api.m3o.com/v1/user/UpdatePassword" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "confirmPassword": "myEvenMoreSecretPass123",
+  "id": "usrid-1",
+  "newPassword": "myEvenMoreSecretPass123",
+  "oldPassword": "mySecretPass123"
+}'

examples/user/updatePassword/go/updateTheAccountPassword.go

@@ -0,0 +1,18 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/user"
+	"os"
+)
+
+// Update the account password
+func UpdateTheAccountPassword() {
+	userService := user.NewUserService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := userService.UpdatePassword(&user.UpdatePasswordRequest{
+		ConfirmPassword: "myEvenMoreSecretPass123",
+		NewPassword:     "myEvenMoreSecretPass123",
+		OldPassword:     "mySecretPass123",
+	})
+	fmt.Println(rsp, err)
+}

examples/user/updatePassword/node/updateTheAccountPassword.js

@@ -0,0 +1,15 @@
+import * as user from "m3o/user";
+
+// Update the account password
+async function UpdateTheAccountPassword() {
+  let userService = new user.UserService(process.env.MICRO_API_TOKEN);
+  let rsp = await userService.updatePassword({
+    confirmPassword: "myEvenMoreSecretPass123",
+    id: "usrid-1",
+    newPassword: "myEvenMoreSecretPass123",
+    oldPassword: "mySecretPass123",
+  });
+  console.log(rsp);
+}
+
+await UpdateTheAccountPassword();

examples/user/verifyEmail/curl/verifyEmail.sh

@@ -0,0 +1,6 @@
+curl "https://api.m3o.com/v1/user/VerifyEmail" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "token": "t2323t232t"
+}'

examples/user/verifyEmail/go/verifyEmail.go

@@ -0,0 +1,16 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/user"
+	"os"
+)
+
+// Verify the email address of an account from a token sent in an email to the user.
+func VerifyEmail() {
+	userService := user.NewUserService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := userService.VerifyEmail(&user.VerifyEmailRequest{
+		Token: "t2323t232t",
+	})
+	fmt.Println(rsp, err)
+}

examples/user/verifyEmail/node/verifyEmail.js

@@ -0,0 +1,12 @@
+import * as user from "m3o/user";
+
+// Verify the email address of an account from a token sent in an email to the user.
+async function VerifyEmail() {
+  let userService = new user.UserService(process.env.MICRO_API_TOKEN);
+  let rsp = await userService.verifyEmail({
+    token: "t2323t232t",
+  });
+  console.log(rsp);
+}
+
+await VerifyEmail();

examples/weather/forecast/curl/forecaseWeather.sh

@@ -0,0 +1,7 @@
+curl "https://api.m3o.com/v1/weather/Forecast" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $MICRO_API_TOKEN" \
+-d '{
+  "days": 2,
+  "location": "London"
+}'

examples/weather/forecast/go/forecaseWeather.go

@@ -0,0 +1,17 @@
+package example
+
+import (
+	"fmt"
+	"github.com/micro/services/clients/go/weather"
+	"os"
+)
+
+// Get the weather forecast for the next 1-10 days
+func ForecaseWeather() {
+	weatherService := weather.NewWeatherService(os.Getenv("MICRO_API_TOKEN"))
+	rsp, err := weatherService.Forecast(&weather.ForecastRequest{
+		Days:     2,
+		Location: "London",
+	})
+	fmt.Println(rsp, err)
+}

examples/weather/forecast/node/forecaseWeather.js

@@ -0,0 +1,13 @@
+import * as weather from "m3o/weather";
+
+// Get the weather forecast for the next 1-10 days
+async function ForecaseWeather() {
+  let weatherService = new weather.WeatherService(process.env.MICRO_API_TOKEN);
+  let rsp = await weatherService.forecast({
+    days: 2,
+    location: "London",
+  });
+  console.log(rsp);
+}
+
+await ForecaseWeather();