update number

Author: vallerion

number/backorder.go

@@ -0,0 +1,118 @@
+package number
+
+import (
+	"fmt"
+	messagebird "github.com/messagebird/go-rest-api/v9"
+	"net/http"
+)
+
+type BackOrderID string
+
+type Backorder struct {
+	ID          string
+	ProductID   int
+	Country     string
+	Prefix      string
+	Status      string
+	ReasonCodes []string
+}
+
+type BackorderDocument struct {
+	ID          int
+	Name        string
+	Description string
+	Status      string
+}
+
+type BackorderDocuments struct {
+	Limit, Count int
+	Items        []*BackorderDocument
+}
+
+type EndUserDetail struct {
+	ID    string
+	Label string
+}
+
+type EndUserDetails struct {
+	Items []*EndUserDetail
+}
+
+type PlaceBackorderRequest struct {
+	ProductID int    `json:"productID"`
+	Prefix    string `json:"prefix"`
+	Quantity  int    `json:"quantity"`
+}
+
+type CreateBackorderDocumentRequest struct {
+	ID       int    `json:"id"`
+	Name     string `json:"name"`
+	MimeType string `json:"mimeType"`
+	Content  string `json:"content"`
+}
+
+type CreateBackorderEndUserDetailRequest struct {
+	CompanyName  string
+	Street       string
+	StreetNumber string
+	ZipCode      string
+	City         string
+	Country      string
+}
+
+func PlaceBackorder(c messagebird.MessageBirdClient, req *PlaceBackorderRequest) (BackOrderID, error) {
+	resp := &struct {
+		Id string `json:"id"`
+	}{}
+
+	if err := request(c, resp, http.MethodPost, pathBackorders, req); err != nil {
+		return "", err
+	}
+
+	return BackOrderID(resp.Id), nil
+}
+
+func ReadBackorder(c messagebird.MessageBirdClient, backOrderID string) (*Backorder, error) {
+	uri := fmt.Sprintf("%s/%s", pathBackorders, backOrderID)
+
+	bo := &Backorder{}
+	if err := request(c, bo, http.MethodGet, uri, nil); err != nil {
+		return nil, err
+	}
+
+	return bo, nil
+}
+
+func ListBackorderDocuments(c messagebird.MessageBirdClient, backOrderID string) (*BackorderDocuments, error) {
+	uri := fmt.Sprintf("%s/%s/%s", pathBackorders, backOrderID, pathDocuments)
+
+	bd := &BackorderDocuments{}
+	if err := request(c, bd, http.MethodGet, uri, nil); err != nil {
+		return nil, err
+	}
+
+	return bd, nil
+}
+
+func CreateBackorderDocument(c messagebird.MessageBirdClient, backOrderID string, req *CreateBackorderDocumentRequest) error {
+	uri := fmt.Sprintf("%s/%s/%s", pathBackorders, backOrderID, pathDocuments)
+
+	return request(c, nil, http.MethodPost, uri, req)
+}
+
+func ListBackorderEndUserDetails(c messagebird.MessageBirdClient, backOrderID string) (*EndUserDetails, error) {
+	uri := fmt.Sprintf("%s/%s/%s", pathBackorders, backOrderID, pathEndUserDetails)
+
+	eud := &EndUserDetails{}
+	if err := request(c, eud, http.MethodGet, uri, nil); err != nil {
+		return nil, err
+	}
+
+	return eud, nil
+}
+
+func CreateBackorderEndUserDetail(c messagebird.MessageBirdClient, backOrderID string, req *CreateBackorderEndUserDetailRequest) error {
+	uri := fmt.Sprintf("%s/%s/%s", pathBackorders, backOrderID, pathEndUserDetails)
+
+	return request(c, nil, http.MethodPost, uri, req)
+}

number/backorder_test.go

@@ -0,0 +1,120 @@
+package number
+
+import (
+	"github.com/messagebird/go-rest-api/v9/internal/mbtest"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"testing"
+)
+
+func TestPlaceBackorder(t *testing.T) {
+	mbtest.WillReturnTestdata(t, "placeBackorder.json", http.StatusOK)
+	client := mbtest.Client(t)
+
+	backorderID, err := PlaceBackorder(client, &PlaceBackorderRequest{
+		ProductID: 1993,
+		Prefix:    "31114",
+		Quantity:  3,
+	})
+	assert.NoError(t, err)
+	assert.Equal(t, "48f6057c21de42d4bbf73fb86caaf361", string(backorderID))
+
+	mbtest.AssertEndpointCalled(t, http.MethodPost, "/v1/backorders")
+}
+
+func TestReadBackorder(t *testing.T) {
+	mbtest.WillReturnTestdata(t, "readBackorder.json", http.StatusOK)
+	client := mbtest.Client(t)
+
+	backorder, err := ReadBackorder(client, "vn4oor3c21de42d4bbf73fb86caaf361")
+	assert.NoError(t, err)
+	assert.Equal(t, "48f6057c21de42d4bbf73fb86caaf361", backorder.ID)
+	assert.Equal(t, 1993, backorder.ProductID)
+	assert.Equal(t, "GB", backorder.Country)
+	assert.Equal(t, "44113", backorder.Prefix)
+	assert.Equal(t, "blocked", backorder.Status)
+	assert.Equal(t, []string{"MISSING_KYC", "MISSING_EUD"}, backorder.ReasonCodes)
+
+	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361")
+}
+
+func TestListBackorderDocuments(t *testing.T) {
+	mbtest.WillReturnTestdata(t, "listBackorderDocuments.json", http.StatusOK)
+	client := mbtest.Client(t)
+
+	list, err := ListBackorderDocuments(client, "vn4oor3c21de42d4bbf73fb86caaf361")
+	assert.NoError(t, err)
+	assert.Equal(t, 20, list.Limit)
+	assert.Equal(t, 1, list.Count)
+	assert.Len(t, list.Items, 1)
+	assert.Equal(t, 62, list.Items[0].ID)
+	assert.Equal(t, "Proof of in region address (max 3 months old)", list.Items[0].Name)
+	assert.Equal(t, "The number-user must provide proof that he has an address within the region of the prefix.", list.Items[0].Description)
+	assert.Equal(t, "missing", list.Items[0].Status)
+
+	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361/documents")
+}
+
+func TestCreateBackorderDocument(t *testing.T) {
+	mbtest.WillReturnOnlyStatus(http.StatusNoContent)
+	client := mbtest.Client(t)
+
+	err := CreateBackorderDocument(client, "vn4oor3c21de42d4bbf73fb86caaf361", &CreateBackorderDocumentRequest{
+		ID:       62,
+		Name:     "messagebird-kyc-upload-test.txt",
+		MimeType: "text/plain",
+		Content:  "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==",
+	})
+	assert.NoError(t, err)
+	mbtest.AssertEndpointCalled(t, http.MethodPost, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361/documents")
+}
+
+func TestCreateBackorderDocumentError(t *testing.T) {
+	mbtest.WillReturnOnlyStatus(http.StatusNotAcceptable)
+	client := mbtest.Client(t)
+
+	err := CreateBackorderDocument(client, "vn4oor3c21de42d4bbf73fb86caaf361", &CreateBackorderDocumentRequest{
+		ID:       62,
+		Name:     "messagebird-kyc-upload-test.txt",
+		MimeType: "text/plain",
+		Content:  "aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==",
+	})
+	assert.Error(t, err)
+	mbtest.AssertEndpointCalled(t, http.MethodPost, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361/documents")
+}
+
+func TestListBackorderEndUserDetails(t *testing.T) {
+	mbtest.WillReturnTestdata(t, "listBackorderEndUserDetails.json", http.StatusOK)
+	client := mbtest.Client(t)
+
+	eud, err := ListBackorderEndUserDetails(client, "vn4oor3c21de42d4bbf73fb86caaf361")
+	assert.NoError(t, err)
+	assert.Len(t, eud.Items, 6)
+	assert.Equal(t, []*EndUserDetail{
+		{"CompanyName", "Company name"},
+		{"Street", "Street"},
+		{"StreetNumber", "Street number"},
+		{"ZipCode", "Zip code"},
+		{"City", "City"},
+		{"Country", "Country"},
+	}, eud.Items)
+
+	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361/end-user-details")
+}
+
+func TestCreateBackorderEndUserDetail(t *testing.T) {
+	mbtest.WillReturnOnlyStatus(http.StatusNoContent)
+	client := mbtest.Client(t)
+
+	err := CreateBackorderEndUserDetail(client, "vn4oor3c21de42d4bbf73fb86caaf361", &CreateBackorderEndUserDetailRequest{
+		CompanyName:  "Messagebird",
+		Street:       "Burgwal",
+		StreetNumber: "35",
+		ZipCode:      "2011",
+		City:         "Amsterdam",
+		Country:      "Netherlands",
+	})
+	assert.NoError(t, err)
+
+	mbtest.AssertEndpointCalled(t, http.MethodPost, "/v1/backorders/vn4oor3c21de42d4bbf73fb86caaf361/end-user-details")
+}