move to v6 respecting go modules release guidelines (#91)

* move to v6 respecting go modules release guidelines

* Update UPGRADING.md

* set ClientVersion to 6.0.0

* update badge

Co-authored-by: Sarath Pillai <[email protected]>

Author: sarathsp06

.travis.yml

@@ -1,8 +1,8 @@
 language: go
-go_import_path: github.com/messagebird/go-rest-api
+go_import_path: github.com/messagebird/go-rest-api/v6
 go:
-  - "1.13"
   - "1.14"
+  - "1.15"
   - stable
   - master
 matrix:

README.md

@@ -2,7 +2,7 @@ MessageBird's REST API for Go
 =============================
 This repository contains the open source Go client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com.
 
-[![Build Status](https://travis-ci.org/messagebird/go-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/go-rest-api) [![GoDoc](https://godoc.org/github.com/messagebird/go-rest-api?status.svg)](https://godoc.org/github.com/messagebird/go-rest-api)
+[![Build Status](https://travis-ci.org/messagebird/go-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/go-rest-api) [![PkgGoDev](https://pkg.go.dev/badge/github.com/messagebird/go-rest-api)](https://pkg.go.dev/github.com/messagebird/go-rest-api)
 
 Requirements
 ------------
@@ -15,15 +15,15 @@ Installation
 The easiest way to use the MessageBird API in your Go project is to install it using *go get*:
 
 ```
-$ go get github.com/messagebird/go-rest-api
+$ go get github.com/messagebird/go-rest-api/v6
 ```
 
 Examples
 --------
 Here is a quick example on how to get started. Assuming the **go get** installation worked, you can import the messagebird package like this:
 
 ```go
-import "github.com/messagebird/go-rest-api"
+import "github.com/messagebird/go-rest-api/v6"
 ```
 
 Then, create an instance of **messagebird.Client**. It can be used to access the MessageBird APIs.
@@ -69,8 +69,8 @@ For this reason, errors returned by the `voice` package are of type `voice.Error
 An example of "simple" error handling is shown in the example above. Let's look how we can gain more in-depth insight in what exactly went wrong:
 
 ```go
-import "github.com/messagebird/go-rest-api"
-import "github.com/messagebird/go-rest-api/sms"
+import "github.com/messagebird/go-rest-api/v6"
+import "github.com/messagebird/go-rest-api/v6/sms"
 
 // ...
 
@@ -91,7 +91,7 @@ if err != nil {
 `voice.ErrorResponse` is very similar, except that it holds `voice.Error` structs - those contain only `Code` and `Message` (not description!) fields:
 
 ```go
-import "github.com/messagebird/go-rest-api/voice"
+import "github.com/messagebird/go-rest-api/v6/voice"
 
 // ...
 

UPGRADING.md

@@ -92,3 +92,12 @@ if err != nil {
 
 ### Other improvements
 Although those are all breaking changes, it's worth mentioning this new version brings a number of other improvements. An example is that the client now supports contacts and groups - enjoy!
+
+
+## `v5.5.0` -> `v6.0.0`
+### Version suffix
+To preserve import compatibility, the go command requires that modules with major version v2 or later use a module path with that major version as the final element. 
+
+So all imports of `go-rest-api` are replaced as `go-rest-api/v6`. 
+
+

balance/balance.go

@@ -3,7 +3,7 @@ package balance
 import (
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Balance describes your balance information.

balance/balance_test.go

@@ -4,8 +4,8 @@ import (
 	"net/http"
 	"testing"
 
-	messagebird "github.com/messagebird/go-rest-api"
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	messagebird "github.com/messagebird/go-rest-api/v6"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 const Epsilon float32 = 0.001

client.go

@@ -26,7 +26,7 @@ import (
 
 const (
 	// ClientVersion is used in User-Agent request header to provide server with API level.
-	ClientVersion = "5.5.0"
+	ClientVersion = "6.0.0"
 
 	// Endpoint points you to MessageBird REST API.
 	Endpoint = "https://rest.messagebird.com"

contact/contact.go

@@ -8,7 +8,7 @@ import (
 	"strconv"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // Contact gets returned by the API.

contact/contact_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/messagebird/go-rest-api/internal/mbtest"
+	"github.com/messagebird/go-rest-api/v6/internal/mbtest"
 )
 
 func TestMain(m *testing.M) {

conversation/api.go

@@ -7,7 +7,7 @@ import (
 	"strconv"
 	"time"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 const (

conversation/conversation.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api"
+	messagebird "github.com/messagebird/go-rest-api/v6"
 )
 
 // ListOptions can be used to set pagination options in List().