feat: Implement Phone Numbers API

phone_number.go

@@ -0,0 +1,26 @@
+package clerk
+
+type PhoneNumber struct {
+	APIResource
+
+	Object                  string `json:"object"`
+	ID                      string `json:"id"`
+	PhoneNumber             string `json:"phone_number"`
+	ReservedForSecondFactor bool   `json:"reserved_for_second_factor"`
+	DefaultSecondFactor     bool   `json:"default_second_factor"`
+	Reserved                bool   `json:"reserved"`
+
+	Verification *struct {
+		Status   string `json:"status"`
+		Strategy string `json:"strategy"`
+		Attempts int    `json:"attempts"`
+		ExpireAt int    `json:"expire_at"`
+	} `json:"verification"`
+
+	LinkedTo []struct {
+		Type string `json:"type"`
+		ID   string `json:"id"`
+	} `json:"linked_to"`
+
+	BackupCodes []string `json:"backup_codes"`
+}

phonenumber/client.go

@@ -0,0 +1,92 @@
+// Package phonenumber provides the Phone Numbers API.
+//
+// https://clerk.com/docs/reference/backend-api/tag/Phone-Numbers
+package phonenumber
+
+import (
+	"context"
+	"net/http"
+
+	"github.com/clerk/clerk-sdk-go/v2"
+)
+
+//go:generate go run ../cmd/gen/main.go
+
+const path = "/phone_numbers"
+
+// Client is used to invoke the Phone Numbers API.
+type Client struct {
+	Backend clerk.Backend
+}
+
+type ClientConfig struct {
+	clerk.BackendConfig
+}
+
+func NewClient(config *ClientConfig) *Client {
+	return &Client{
+		Backend: clerk.NewBackend(&config.BackendConfig),
+	}
+}
+
+type CreateParams struct {
+	clerk.APIParams
+
+	UserID      *string `json:"user_id,omitempty"`
+	PhoneNumber *string `json:"phone_number,omitempty"`
+	Verified    *bool   `json:"verified,omitempty"`
+	Primary     *bool   `json:"primary,omitempty"`
+}
+
+// Create creates a new phone number.
+func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.PhoneNumber, error) {
+	req := clerk.NewAPIRequest(http.MethodPost, path)
+	req.SetParams(params)
+	template := &clerk.PhoneNumber{}
+	err := c.Backend.Call(ctx, req, template)
+	return template, err
+}
+
+// Get returns details about a phone number.
+func (c *Client) Get(ctx context.Context, id string) (*clerk.PhoneNumber, error) {
+	path, err := clerk.JoinPath(path, id)
+	if err != nil {
+		return nil, err
+	}
+	req := clerk.NewAPIRequest(http.MethodGet, path)
+	template := &clerk.PhoneNumber{}
+	err = c.Backend.Call(ctx, req, template)
+	return template, err
+}
+
+type UpdateParams struct {
+	clerk.APIParams
+
+	Verified *bool `json:"verified,omitempty"`
+	Primary  *bool `json:"primary,omitempty"`
+}
+
+// Update updates the phone number specified by id.
+func (c *Client) Update(ctx context.Context, id string, params *UpdateParams) (*clerk.PhoneNumber, error) {
+	path, err := clerk.JoinPath(path, id)
+	if err != nil {
+		return nil, err
+	}
+	req := clerk.NewAPIRequest(http.MethodPatch, path)
+	req.SetParams(params)
+	template := &clerk.PhoneNumber{}
+	err = c.Backend.Call(ctx, req, template)
+	return template, err
+}
+
+// Delete deletes a phone number.
+func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error) {
+	path, err := clerk.JoinPath(path, id)
+	if err != nil {
+		return nil, err
+	}
+	req := clerk.NewAPIRequest(http.MethodDelete, path)
+	template := &clerk.DeletedResource{}
+	err = c.Backend.Call(ctx, req, template)
+	return template, err
+}

phonenumber/client_test.go

@@ -0,0 +1,48 @@
+package phonenumber
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"testing"
+
+	"github.com/clerk/clerk-sdk-go/v2/clerktest"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPhoneNumberClientCreate(t *testing.T) {
+	t.Parallel()
+
+	id := "idn_123"
+	userID := "usr_123"
+	verified := true
+	phone := "+30210555555"
+
+	config := &ClientConfig{}
+	config.HTTPClient = &http.Client{
+		Transport: &clerktest.RoundTripper{
+			T: t,
+			In: json.RawMessage(fmt.Sprintf(`
+{"phone_number":"+30210555555", "user_id":"%s", "verified": true}
+			`, userID)),
+			Out: json.RawMessage(fmt.Sprintf(`
+{"object": "phone_number", "id":"%s", "phone_number":"%s", "reserved": false, "verification": null}`, id, userID)),
+			Method: http.MethodPost,
+			Path:   "/v1/phone_numbers",
+		},
+	}
+	client := NewClient(config)
+
+	phoneNumber, err := client.Create(context.Background(), &CreateParams{
+		UserID:      &userID,
+		PhoneNumber: &phone,
+		Verified:    &verified,
+	})
+	require.NoError(t, err)
+	assert.Equal(t, id, phoneNumber.ID)
+	assert.Equal(t, "phone_number", phoneNumber.Object)
+	assert.Equal(t, false, phoneNumber.Reserved)
+	assert.Nil(t, phoneNumber.Verification)
+}