totole/m3o-go
1
0
Fork 0
mirror of https://github.com/kevin-DL/m3o-go.git synced 2026-01-20 22:15:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Commit from m3o/m3o action

Browse Source
This commit is contained in:
m3o-actions
2021-10-29 10:44:29 +00:00
parent 4e64b77e47
commit eb73d115f2
212 changed files with 970 additions and 970 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
examples/user/README.md
View File

@@ -4,12 +4,12 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/User/api](http
Endpoints:
## Delete
## Create
Delete an account by id
Create a new user account. The email address and username for the account must be unique.
[https://m3o.com/user/api#Delete](https://m3o.com/user/api#Delete)
[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
```go
package example
@@ -18,68 +18,17 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Delete an account by id
func DeleteUserAccount() {
// 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.Delete(&user.DeleteRequest{
Id: "fdf34f34f34-f34f34-f43f43f34-f4f34f",
})
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"
"github.com/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: "sds34s34s34-s34s34-s43s43s34-s4s34s",
})
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"
"github.com/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",
rsp, err := userService.Create(&user.CreateRequest{
Email: "joe@example.com",
Id: "usrid-1",
Password: "mySecretPass123",
Username: "usrname-1",
})
fmt.Println(rsp, err)
@@ -99,7 +48,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Update the account username or email
@@ -113,35 +62,6 @@ 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"
"github.com/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)
}
```
## Read
Read an account by id, username or email. Only one need to be specified.
@@ -156,7 +76,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.
@@ -183,7 +103,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.
@@ -210,7 +130,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.
@@ -223,6 +143,33 @@ func ReadAccountByEmail() {
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,
@@ -238,7 +185,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Login using username or email. The response will return a new session for successful login,
@@ -253,12 +200,12 @@ Password: "mySecretPass123",
fmt.Println(rsp, err)
}
```
## Create
## Logout
Create a new user account. The email address and username for the account must be unique.
Logout a user account
[https://m3o.com/user/api#Create](https://m3o.com/user/api#Create)
[https://m3o.com/user/api#Logout](https://m3o.com/user/api#Logout)
```go
package example
@@ -267,17 +214,70 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Create a new user account. The email address and username for the account must be unique.
func CreateAnAccount() {
// Logout a user account
func LogAuserOut() {
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",
rsp, err := userService.Logout(&user.LogoutRequest{
SessionId: "sds34s34s34-s34s34-s43s43s34-s4s34s",
})
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)
}
```
## 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)
@@ -303,7 +303,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Send a verification email
@@ -343,7 +343,7 @@ import(
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Verify the email address of an account from a token sent in an email to the user.

2
examples/user/create/createAnAccount.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Create a new user account. The email address and username for the account must be unique.

2
examples/user/delete/deleteUserAccount.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Delete an account by id

2
examples/user/login/logAUserIn.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Login using username or email. The response will return a new session for successful login,

2
examples/user/logout/logAUserOut.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Logout a user account

2
examples/user/read/readAccountByEmail.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.

2
examples/user/read/readAccountByUsernameOrEmail.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.

2
examples/user/read/readAnAccountById.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Read an account by id, username or email. Only one need to be specified.

2
examples/user/readSession/readASessionByTheSessionId.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"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.

2
examples/user/sendVerificationEmail/sendVerificationEmail.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Send a verification email

2
examples/user/update/updateAnAccount.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Update the account username or email

2
examples/user/updatePassword/updateTheAccountPassword.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Update the account password

2
examples/user/verifyEmail/verifyEmail.go
View File

@@ -4,7 +4,7 @@ import (
"fmt"
"os"
"github.com/go.m3o.com/user"
"go.m3o.com/user"
)
// Verify the email address of an account from a token sent in an email to the user.