fix: custom headers, cleanup docs, regenerate with the latest specs (#59

)

* fix: fix header support and some cleanup

client/base_client.go

@@ -5,9 +5,8 @@ import (
 	"net/url"
 )
 
-// BaseClient is the interface that wraps the Get/Post/Delete calls.
 type BaseClient interface {
-	Post(path string, bodyData url.Values, headers interface{}) (*http.Response, error)
-	Get(path string, queryData interface{}, headers interface{}) (*http.Response, error)
-	Delete(path string, nothing interface{}, headers interface{}) (*http.Response, error)
+	Post(path string, bodyData url.Values, headers map[string]interface{}) (*http.Response, error)
+	Get(path string, queryData interface{}, headers map[string]interface{}) (*http.Response, error)
+	Delete(path string, nothing interface{}, headers map[string]interface{}) (*http.Response, error)
 }

client/client.go

@@ -3,6 +3,7 @@ package client
 
 import (
 	"encoding/json"
+	"fmt"
 	"net/http"
 	"net/url"
 	"regexp"
@@ -78,7 +79,8 @@ func (c *Client) doWithErr(req *http.Request) (*http.Response, error) {
 }
 
 // SendRequest verifies, constructs, and authorizes an HTTP request.
-func (c Client) SendRequest(method string, rawURL string, queryParams interface{}, formData url.Values) (*http.Response, error) {
+func (c Client) SendRequest(method string, rawURL string, queryParams interface{}, formData url.Values,
+	headers map[string]interface{}) (*http.Response, error) {
 	u, err := url.Parse(rawURL)
 	if err != nil {
 		return nil, err
@@ -109,23 +111,27 @@ func (c Client) SendRequest(method string, rawURL string, queryParams interface{
 		req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
 	}
 
+	for k, v := range headers {
+		req.Header.Add(k, fmt.Sprint(v))
+	}
+
 	return c.doWithErr(req)
 }
 
 // Post performs a POST request on the object at the provided URI in the context of the Request's BaseURL
 // with the provided data as parameters.
-func (c Client) Post(path string, bodyData url.Values, headers interface{}) (*http.Response, error) {
-	return c.SendRequest(http.MethodPost, path, nil, bodyData)
+func (c Client) Post(path string, bodyData url.Values, headers map[string]interface{}) (*http.Response, error) {
+	return c.SendRequest(http.MethodPost, path, nil, bodyData, headers)
 }
 
 // Get performs a GET request on the object at the provided URI in the context of the Request's BaseURL
 // with the provided data as parameters.
-func (c Client) Get(path string, queryData interface{}, headers interface{}) (*http.Response, error) {
-	return c.SendRequest(http.MethodGet, path, queryData, nil)
+func (c Client) Get(path string, queryData interface{}, headers map[string]interface{}) (*http.Response, error) {
+	return c.SendRequest(http.MethodGet, path, queryData, nil, headers)
 }
 
 // Delete performs a DELETE request on the object at the provided URI in the context of the Request's BaseURL
 // with the provided data as parameters.
-func (c Client) Delete(path string, nothing interface{}, headers interface{}) (*http.Response, error) {
-	return c.SendRequest(http.MethodDelete, path, nil, nil)
+func (c Client) Delete(path string, nothing interface{}, headers map[string]interface{}) (*http.Response, error) {
+	return c.SendRequest(http.MethodDelete, path, nil, nil, headers)
 }

client/client_test.go

@@ -40,7 +40,7 @@ func TestClient_SendRequestError(t *testing.T) {
 	defer mockServer.Close()
 
 	client := NewClient("user", "pass")
-	resp, err := client.SendRequest("get", mockServer.URL, nil, nil)
+	resp, err := client.SendRequest("get", mockServer.URL, nil, nil, nil) //nolint:bodyclose
 	twilioError := err.(*error.TwilioRestError)
 	assert.Nil(t, resp)
 	assert.Equal(t, 400, twilioError.Status)
@@ -68,7 +68,7 @@ func TestClient_SendRequestErrorWithDetails(t *testing.T) {
 	defer mockServer.Close()
 
 	client := NewClient("user", "pass")
-	resp, err := client.SendRequest("get", mockServer.URL, nil, nil)
+	resp, err := client.SendRequest("get", mockServer.URL, nil, nil, nil) //nolint:bodyclose
 	twilioError := err.(*error.TwilioRestError)
 	details := make(map[string]interface{})
 	details["foo"] = "bar"
@@ -89,7 +89,7 @@ func TestClient_SendRequestWithRedirect(t *testing.T) {
 	defer mockServer.Close()
 
 	client := NewClient("user", "pass")
-	resp, _ := client.SendRequest("get", mockServer.URL, nil, nil)
+	resp, _ := client.SendRequest("get", mockServer.URL, nil, nil, nil) //nolint:bodyclose
 	assert.Equal(t, 307, resp.StatusCode)
 }
 
@@ -112,7 +112,7 @@ func TestClient_SetTimeoutTimesOut(t *testing.T) {
 
 	client := NewClient("user", "pass")
 	client.SetTimeout(10 * time.Microsecond)
-	_, err := client.SendRequest("get", mockServer.URL, nil, nil)
+	_, err := client.SendRequest("get", mockServer.URL, nil, nil, nil) //nolint:bodyclose
 	assert.Error(t, err)
 }
 
@@ -135,7 +135,7 @@ func TestClient_SetTimeoutSucceeds(t *testing.T) {
 
 	client := NewClient("user", "pass")
 	client.SetTimeout(10 * time.Second)
-	resp, err := client.SendRequest("get", mockServer.URL, nil, nil)
+	resp, err := client.SendRequest("get", mockServer.URL, nil, nil, nil) //nolint:bodyclose
 	assert.NoError(t, err)
 	assert.Equal(t, 200, resp.StatusCode)
 }