Merge branch 'master' into master

Author: rfeiner

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        go-version: [ 1.14.x, 1.15.x, 1.16.x ]
+        go-version: [ 1.16.x, 1.17.x, 1.18.x ]
 
     name: Go ${{ matrix.go-version }}
 

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2014-2015, MessageBird
+Copyright (c) 2014-2022, MessageBird
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

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) [![PkgGoDev](https://pkg.go.dev/badge/github.com/messagebird/go-rest-api/v7)](https://pkg.go.dev/github.com/messagebird/go-rest-api/v7)
+[![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/v9)](https://pkg.go.dev/github.com/messagebird/go-rest-api/v9)
 
 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/v7
+$ go get github.com/messagebird/go-rest-api/v9
 ```
 
 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/v7"
+import "github.com/messagebird/go-rest-api/v9"
 ```
 
 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/v7"
-import "github.com/messagebird/go-rest-api/v7/sms"
+import "github.com/messagebird/go-rest-api/v9"
+import "github.com/messagebird/go-rest-api/v9/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/v7/voice"
+import "github.com/messagebird/go-rest-api/v9/voice"
 
 // ...
 
@@ -108,14 +108,6 @@ if err != nil {
 }
 ```
 
-Conversations WhatsApp Sandbox
--------------
-To use the whatsapp sandbox you need to enable the `FeatureConversationsAPIWhatsAppSandbox` feature.
-
-```go
-	client.EnableFeatures(messagebird.FeatureConversationsAPIWhatsAppSandbox)
-```
-
 Documentation
 -------------
 Complete documentation, instructions, and examples are available at:
@@ -127,4 +119,4 @@ If you're upgrading from older versions, please read the [Messagebird `go-rest-a
 
 License
 -------
-The MessageBird REST Client for Go is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2014, 2015, MessageBird
+The MessageBird REST Client for Go is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2022 MessageBird

UPGRADING.md

@@ -103,3 +103,23 @@ So all imports of `go-rest-api` are replaced as `go-rest-api/v6`.
 ## `v6.1.0` -> `v7.0.0`
 ### Verify Recipient type
 As v7 introduces support for using the Verify API with email recipients, the `Verify.Recipient` field has been changed from to a string type.
+
+## `v7.1.0` -> `v8.0.0`
+### Update SMS API
+Added [missed fields](https://github.com/messagebird/go-rest-api/pull/119/commits/f9331269238f1518dd35d798a0fbf251bb04bb62) in SMS API.
+Updated `sms.Delete` method so now in return only error or nil as result.
+
+## `v8.0.0` -> `v9.0.0`
+### General
+* New `PaginationRequest` instead of many in APIs.
+* New interface `messagebird.Client` and `messagebird.DefaultClient` instead of old implementation `messagebird.Client` and new `MockClient` for better testing.
+* List structures now have a plural ending instead of using word "List". Example: `ContactList` -> `Contacts`.
+* `conversations.ConversationStatus` replaced by `conversations.Status`.
+* `number.NumberPattern` replaced by `number.SearchPattern`.
+* Added [Partner Accounts API](https://developers.messagebird.com/api/partner/).
+### Conversations API
+* Replaced `conversations.CreateMessage` with `conversations.Reply` which send a new message to an existing conversation.
+* Replaced `conversations.ListMessages` with `conversations.ListConversationMessages` which fetch messages in indicated conversation.
+* Added `conversations.SendMessage` to send a message to a specific recipient in a specific platform.
+* Added `conversations.ListByContact` to retrieves the list of conversation IDs of a specific contact ID.
+* Now `conversations.ListMessages` retrieves a list of messages given a list of message IDs or a timestamp (not both).

api.go

@@ -0,0 +1,33 @@
+package messagebird
+
+import (
+	"net/url"
+	"strconv"
+)
+
+// PaginationRequest can be used to set pagination options in List().
+type PaginationRequest struct {
+	Limit, Offset int
+}
+
+func (cpr *PaginationRequest) QueryParams() string {
+	if cpr == nil {
+		return ""
+	}
+
+	query := url.Values{}
+	if cpr.Limit > 0 {
+		query.Set("limit", strconv.Itoa(cpr.Limit))
+	}
+	if cpr.Offset >= 0 {
+		query.Set("offset", strconv.Itoa(cpr.Offset))
+	}
+
+	return query.Encode()
+}
+
+// DefaultPagination provides reasonable values for List requests.
+var DefaultPagination = &PaginationRequest{
+	Limit:  20,
+	Offset: 0,
+}

balance/balance.go

@@ -3,7 +3,7 @@ package balance
 import (
 	"net/http"
 
-	messagebird "github.com/messagebird/go-rest-api/v7"
+	messagebird "github.com/messagebird/go-rest-api/v9"
 )
 
 // Balance describes your balance information.
@@ -17,7 +17,7 @@ const path = "balance"
 
 // Read returns the balance information for the account that is associated with
 // the access key.
-func Read(c *messagebird.Client) (*Balance, error) {
+func Read(c messagebird.Client) (*Balance, error) {
 	balance := &Balance{}
 	if err := c.Request(balance, http.MethodGet, path, nil); err != nil {
 		return nil, err

balance/balance_test.go

@@ -4,8 +4,8 @@ import (
 	"net/http"
 	"testing"
 
-	messagebird "github.com/messagebird/go-rest-api/v7"
-	"github.com/messagebird/go-rest-api/v7/internal/mbtest"
+	messagebird "github.com/messagebird/go-rest-api/v9"
+	"github.com/messagebird/go-rest-api/v9/internal/mbtest"
 	"github.com/stretchr/testify/assert"
 )
 

client.go

@@ -1,5 +1,5 @@
 //
-// Copyright (c) 2014 MessageBird B.V.
+// Copyright (c) 2022 MessageBird B.V.
 // All rights reserved.
 //
 // Author: Maurice Nonnekes <[email protected]>
@@ -20,45 +20,38 @@ import (
 	"net/url"
 	"runtime"
 	"strings"
-	"sync"
 	"time"
 )
 
 const (
 	// ClientVersion is used in User-Agent request header to provide server with API level.
-	ClientVersion = "7.0.0"
+	ClientVersion = "9.0.0"
 
 	// Endpoint points you to MessageBird REST API.
 	Endpoint = "https://rest.messagebird.com"
 
 	// httpClientTimeout is used to limit http.Client waiting time.
 	httpClientTimeout = 15 * time.Second
-
-	// voiceHost is the host name for the Voice API.
-	voiceHost = "voice.messagebird.com"
 )
 
 var (
 	// ErrUnexpectedResponse is used when there was an internal server error and nothing can be done at this point.
-	ErrUnexpectedResponse = errors.New("The MessageBird API is currently unavailable")
+	ErrUnexpectedResponse = errors.New("the MessageBird API is currently unavailable")
 )
 
 // A Feature can be enabled
 type Feature int
 
-const (
-	// FeatureConversationsAPIWhatsAppSandbox Enables the WhatsApp sandbox for conversations API.
-	FeatureConversationsAPIWhatsAppSandbox Feature = iota
-)
+type Client interface {
+	Request(v interface{}, method, path string, data interface{}) error
+}
 
-// Client is used to access API with a given key.
+// DefaultClient is used to access API with a given key.
 // Uses standard lib HTTP client internally, so should be reused instead of created as needed and it is safe for concurrent use.
-type Client struct {
-	AccessKey     string           // The API access key.
-	HTTPClient    *http.Client     // The HTTP client to send requests on.
-	DebugLog      *log.Logger      // Optional logger for debugging purposes.
-	features      map[Feature]bool // Enabled features.
-	featuresMutex sync.RWMutex     // Mutex for accessing feature map.
+type DefaultClient struct {
+	AccessKey  string       // The API access key.
+	HTTPClient *http.Client // The HTTP client to send requests on.
+	DebugLog   *log.Logger  // Optional logger for debugging purposes.
 }
 
 type contentType string
@@ -72,51 +65,25 @@ const (
 // errorReader reads the provided byte slice into an appropriate error.
 type errorReader func([]byte) error
 
-var voiceErrorReader errorReader
+var customErrorReader errorReader
+
+// SetErrorReader takes an errorReader that must parse raw JSON errors
+func SetErrorReader(r errorReader) {
+	customErrorReader = r
+}
 
 // New creates a new MessageBird client object.
-func New(accessKey string) *Client {
-	return &Client{
+func New(accessKey string) *DefaultClient {
+	return &DefaultClient{
 		AccessKey: accessKey,
 		HTTPClient: &http.Client{
 			Timeout: httpClientTimeout,
 		},
-		features: make(map[Feature]bool),
-	}
-}
-
-// SetVoiceErrorReader takes an errorReader that must parse raw JSON errors
-// returned from the Voice API.
-func SetVoiceErrorReader(r errorReader) {
-	voiceErrorReader = r
-}
-
-// EnableFeatures enables a feature.
-func (c *Client) EnableFeatures(feature Feature) {
-	c.featuresMutex.Lock()
-	defer c.featuresMutex.Unlock()
-	c.features[feature] = true
-}
-
-// DisableFeatures disables a feature.
-func (c *Client) DisableFeatures(feature Feature) {
-	c.featuresMutex.Lock()
-	defer c.featuresMutex.Unlock()
-	c.features[feature] = false
-}
-
-// IsFeatureEnabled checks if a feature is enabled.
-func (c *Client) IsFeatureEnabled(feature Feature) bool {
-	c.featuresMutex.RLock()
-	defer c.featuresMutex.RUnlock()
-	if enabled, ok := c.features[feature]; ok {
-		return enabled
 	}
-	return false
 }
 
 // Request is for internal use only and unstable.
-func (c *Client) Request(v interface{}, method, path string, data interface{}) error {
+func (c *DefaultClient) Request(v interface{}, method, path string, data interface{}) error {
 	if !strings.HasPrefix(path, "https://") && !strings.HasPrefix(path, "http://") {
 		path = fmt.Sprintf("%s/%s", Endpoint, path)
 	}
@@ -167,7 +134,7 @@ func (c *Client) Request(v interface{}, method, path string, data interface{}) e
 	}
 
 	switch response.StatusCode {
-	case http.StatusOK, http.StatusCreated:
+	case http.StatusOK, http.StatusCreated, http.StatusAccepted:
 		// Status codes 200 and 201 are indicative of being able to convert the
 		// response body to the struct that was specified.
 		if err := json.Unmarshal(responseBody, &v); err != nil {
@@ -185,17 +152,22 @@ func (c *Client) Request(v interface{}, method, path string, data interface{}) e
 		return ErrUnexpectedResponse
 	default:
 		// Anything else than a 200/201/204/500 should be a JSON error.
-		if uri.Host == voiceHost && voiceErrorReader != nil {
-			return voiceErrorReader(responseBody)
+		if customErrorReader != nil {
+			return customErrorReader(responseBody)
 		}
 
-		var errorResponse ErrorResponse
-		if err := json.Unmarshal(responseBody, &errorResponse); err != nil {
-			return err
-		}
+		return defaultErrorReader(responseBody)
+	}
+}
 
-		return errorResponse
+func defaultErrorReader(b []byte) error {
+	var errorResponse ErrorResponse
+
+	if err := json.Unmarshal(b, &errorResponse); err != nil {
+		return fmt.Errorf("failed to unmarshal response json %s, error: %v", string(b), err)
 	}
+
+	return errorResponse
 }
 
 // prepareRequestBody takes untyped data and attempts constructing a meaningful