feat(domains_v1): add support for new UDM endpoints

fastly/domainsV1.go

@@ -0,0 +1,208 @@
+package fastly
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+	"strconv"
+	"time"
+)
+
+// DomainsV1Response is the API response structure.
+type DomainsV1Response struct {
+	// Data contains the API data.
+	Data []DomainsV1Data `json:"data"`
+	// Meta contains metadata related to paginating the full dataset.
+	Meta DomainsV1Meta `json:"meta"`
+}
+
+// DomainsV1Data is a subset of the API response structure containing the
+// specific API data itself.
+type DomainsV1Data struct {
+	// CreatedAt is the date and time in ISO 8601 format.
+	CreatedAt time.Time `json:"created_at"`
+	// ID is the domain identifier (UUID).
+	DomainID string `json:"id"`
+	// FQDN is the fully-qualified domain name for your domain. Can be created,
+	// but not updated.
+	FQDN string `json:"fqdn"`
+	// ServiceID is the service_id associated with your domain or null if there
+	// is no association.
+	ServiceID *string `json:"service_id"`
+	// UpdatedAt is the date and time in ISO 8601 format.
+	UpdatedAt time.Time `json:"updated_at"`
+}
+
+// DomainsV1Meta is a subset of the API response structure containing metadata
+// related to paginating the full dataset.
+type DomainsV1Meta struct {
+	// Limit is how many results are returned.
+	Limit int `json:"limit"`
+	// NextCursor is the cursor value used to retrieve the next page.
+	NextCursor string `json:"next_cursor"`
+	// Sort is the order in which to list the results.
+	Sort string `json:"sort"`
+	// Total is the total number of results.
+	Total int `json:"total"`
+}
+
+// ListDomainsV1Input is used as input to the ListDomainsV1 function.
+type ListDomainsV1Input struct {
+	// Cursor is the cursor value from the next_cursor field of a previous
+	// response, used to retrieve the next page. To request the first page, this
+	// should be empty (optional).
+	Cursor *string
+	// FQDN filters results by the FQDN using a fuzzy/partial match (optional).
+	FQDN *string
+	// Limit is how many results are returned (optional).
+	Limit *int
+	// ServiceID filter results based on a service_id (optional).
+	ServiceID *string
+	// Sort is the order in which to list the results (optional).
+	Sort *string
+}
+
+// ListDomainsV1 retrieves filtered, paginated domains.
+func (c *Client) ListDomainsV1(i *ListDomainsV1Input) (*DomainsV1Response, error) {
+	ro := &RequestOptions{
+		Params: map[string]string{},
+	}
+	if i.Cursor != nil {
+		ro.Params["cursor"] = *i.Cursor
+	}
+	if i.Limit != nil {
+		ro.Params["limit"] = strconv.Itoa(*i.Limit)
+	}
+	if i.FQDN != nil {
+		ro.Params["fqdn"] = *i.FQDN
+	}
+	if i.ServiceID != nil {
+		ro.Params["service_id"] = *i.ServiceID
+	}
+	if i.Sort != nil {
+		ro.Params["sort"] = *i.Sort
+	}
+
+	resp, err := c.Get("/domains/v1", ro)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var dr *DomainsV1Response
+	if err := json.NewDecoder(resp.Body).Decode(&dr); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return dr, nil
+}
+
+// CreateDomainsV1Input is used as input to the CreateDomainsV1 function.
+type CreateDomainsV1Input struct {
+	// FQDN is the fully-qualified domain name for your domain. Can be created,
+	// but not updated (required).
+	FQDN *string `json:"fqdn"`
+	// ServiceID is the service_id associated with your domain or null if there
+	// is no association (optional)
+	ServiceID *string `json:"service_id"`
+}
+
+// CreateDomainsV1 creates a new domain.
+func (c *Client) CreateDomainsV1(i *CreateDomainsV1Input) (*DomainsV1Data, error) {
+	resp, err := c.PostJSON("/domains/v1", i, nil)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var dd *DomainsV1Data
+	if err := json.NewDecoder(resp.Body).Decode(&dd); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+	return dd, nil
+}
+
+// GetDomainsV1Input is used as input to the GetDomainsV1 function.
+type GetDomainsV1Input struct {
+	// DomainID is the domain identifier (required).
+	DomainID *string
+}
+
+// GetDomainsV1 retrieves a specified domain.
+func (c *Client) GetDomainsV1(i *GetDomainsV1Input) (*DomainsV1Data, error) {
+	if i.DomainID == nil {
+		return nil, ErrMissingDomainID
+	}
+
+	path := ToSafeURL("domains", "v1", *i.DomainID)
+
+	resp, err := c.Get(path, nil)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var dd *DomainsV1Data
+	if err := json.NewDecoder(resp.Body).Decode(&dd); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+
+	return dd, nil
+}
+
+// UpdateDomainsV1Input is used as input to the UpdateDomainsV1 function.
+type UpdateDomainsV1Input struct {
+	// DomainID is the domain identifier (required).
+	DomainID *string `json:"-"`
+	// ServiceID is the service_id associated with your domain or null if there
+	// is no association (optional)
+	ServiceID *string `json:"service_id"`
+}
+
+// UpdateDomainsV1 updates the specified domain.
+func (c *Client) UpdateDomainsV1(i *UpdateDomainsV1Input) (*DomainsV1Data, error) {
+	if i.DomainID == nil {
+		return nil, ErrMissingDomainID
+	}
+
+	path := ToSafeURL("domains", "v1", *i.DomainID)
+
+	resp, err := c.PatchJSON(path, i, nil)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	var dd *DomainsV1Data
+	if err := json.NewDecoder(resp.Body).Decode(&dd); err != nil {
+		return nil, fmt.Errorf("failed to decode json response: %w", err)
+	}
+	return dd, nil
+}
+
+// DeleteDomainsV1Input is used as input to the DeleteDomainsV1 function.
+type DeleteDomainsV1Input struct {
+	// DomainID of definition to delete (required).
+	DomainID *string
+}
+
+// DeleteDomainsV1 deletes the specified domain.
+func (c *Client) DeleteDomainsV1(i *DeleteDomainsV1Input) error {
+	if i.DomainID == nil {
+		return ErrMissingDomainID
+	}
+
+	path := ToSafeURL("domains", "v1", *i.DomainID)
+
+	resp, err := c.Delete(path, nil)
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusNoContent {
+		return NewHTTPError(resp)
+	}
+
+	return nil
+}

fastly/domainsV1_test.go

@@ -0,0 +1,124 @@
+package fastly
+
+import (
+	"errors"
+	"testing"
+)
+
+func TestClient_DomainsV1(t *testing.T) {
+	t.Parallel()
+
+	var err error
+	fqdn := "fastly-sdk-gofastly-testing.com"
+
+	// Create
+	var dd *DomainsV1Data
+	Record(t, "domains_v1/create_domain", func(c *Client) {
+		dd, err = c.CreateDomainsV1(&CreateDomainsV1Input{
+			FQDN: ToPointer(fqdn),
+		})
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	// Ensure deleted
+	defer func() {
+		Record(t, "domains_v1/cleanup_domains", func(c *Client) {
+			err = c.DeleteDomainsV1(&DeleteDomainsV1Input{
+				DomainID: &dd.DomainID,
+			})
+		})
+	}()
+
+	if dd.FQDN != fqdn {
+		t.Errorf("bad fqdn: %v", dd.FQDN)
+	}
+	if dd.ServiceID != nil {
+		t.Errorf("bad service_id: %v", dd.ServiceID)
+	}
+
+	// List Definitions
+	var ldr *DomainsV1Response
+	Record(t, "domains_v1/list_domains", func(c *Client) {
+		ldr, err = c.ListDomainsV1(&ListDomainsV1Input{
+			// Cursor: ToPointer(""),
+			Limit: ToPointer(10),
+			FQDN:  ToPointer(dd.FQDN),
+			Sort:  ToPointer("fqdn"),
+		})
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(ldr.Data) < 1 {
+		t.Errorf("bad domains list: %v", ldr)
+	}
+
+	// Get
+	var gdd *DomainsV1Data
+	Record(t, "domains_v1/get_domain", func(c *Client) {
+		gdd, err = c.GetDomainsV1(&GetDomainsV1Input{
+			DomainID: &dd.DomainID,
+		})
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if dd.FQDN != gdd.FQDN {
+		t.Errorf("bad fqdn: %q (%q)", dd.FQDN, gdd.FQDN)
+	}
+
+	// Update
+	var udd *DomainsV1Data
+	Record(t, "domains_v1/update_domain", func(c *Client) {
+		udd, err = c.UpdateDomainsV1(&UpdateDomainsV1Input{
+			DomainID:  ToPointer(dd.DomainID),
+			ServiceID: ToPointer(defaultDeliveryTestServiceID),
+		})
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+	if udd.ServiceID == nil || *udd.ServiceID != defaultDeliveryTestServiceID {
+		t.Errorf("bad service id: %v", udd.ServiceID)
+	}
+
+	// Delete
+	Record(t, "domains_v1/delete_domain", func(c *Client) {
+		err = c.DeleteDomainsV1(&DeleteDomainsV1Input{
+			DomainID: &dd.DomainID,
+		})
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestClient_GetDomainsV1_validation(t *testing.T) {
+	var err error
+	_, err = TestClient.GetDomainsV1(&GetDomainsV1Input{
+		DomainID: nil,
+	})
+	if !errors.Is(err, ErrMissingDomainID) {
+		t.Errorf("bad error: %s", err)
+	}
+}
+
+func TestClient_UpdateDomainsV1_validation(t *testing.T) {
+	var err error
+	_, err = TestClient.UpdateDomainsV1(&UpdateDomainsV1Input{
+		DomainID: nil,
+	})
+	if !errors.Is(err, ErrMissingDomainID) {
+		t.Errorf("bad error: %s", err)
+	}
+}
+
+func TestClient_DeleteDomainsV1_validation(t *testing.T) {
+	err := TestClient.DeleteDomainsV1(&DeleteDomainsV1Input{
+		DomainID: nil,
+	})
+	if !errors.Is(err, ErrMissingDomainID) {
+		t.Errorf("bad error: %s", err)
+	}
+}

fastly/errors.go

@@ -125,6 +125,10 @@ var ErrMissingTokenID = errors.New("missing required field 'TokenID'")
 // requires a "ID" key, but one was not set.
 var ErrMissingID = NewFieldError("ID")
 
+// ErrMissingDomainID is an error that is returned when an input struct
+// requires a "DomainID" key, but one was not set.
+var ErrMissingDomainID = NewFieldError("DomainID")
+
 // ErrMissingEntryID is an error that is returned when an input struct
 // requires a "EntryID" key, but one was not set.
 var ErrMissingEntryID = NewFieldError("EntryID")

fastly/fixtures/domains_v1/cleanup_domains.yaml

@@ -0,0 +1,46 @@
+---
+version: 1
+interactions:
+- request:
+    body: ""
+    form: {}
+    headers:
+      User-Agent:
+      - FastlyGo/9.11.0 (+github.com/fastly/go-fastly; go1.20.14)
+    url: https://api.fastly.com/domains/v1/hbRABkI8yvSnUbCLRiqUbQ
+    method: DELETE
+  response:
+    body: '{"errors":[{"title":"Not found","detail":"The domain you requested was
+      not found"}]}'
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - "84"
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 14 Jan 2025 14:21:10 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - fastly control-gateway
+      Strict-Transport-Security:
+      - max-age=31536000
+      Via:
+      - 1.1 varnish, 1.1 varnish
+      X-Cache:
+      - MISS, MISS
+      X-Cache-Hits:
+      - 0, 0
+      X-Content-Type-Options:
+      - nosniff
+      X-Served-By:
+      - cache-chi-kigq8000030-CHI, cache-lon420121-LON
+      X-Timer:
+      - S1736864470.058911,VS0,VE170
+    status: 404 Not Found
+    code: 404
+    duration: ""