Add usage alerts support (#358)

* Add usage alerts support

* Merge

* Update examples to show that zone_names is handles

* Fix indent

* Update comment and examples

* Removing maps because we're still using go 1.19

Author: fformica

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.7.0 (September 5, 2025)
+ENHANCEMENTS
+* Adds support for new Alerts
+* Deprecating the `notify.billing` permission
+
 ## 2.6.5 (June 07, 2025)
 ENHANCEMENTS
 * Adds support for `manage_redirects` permission field

ns1/config.go

@@ -19,7 +19,7 @@ import (
 )
 
 var (
-	clientVersion     = "2.6.5"
+	clientVersion     = "2.7.0"
 	providerUserAgent = "tf-ns1" + "/" + clientVersion
 	defaultRetryMax   = 3
 )

ns1/examples/alert.tf

@@ -1,11 +1,21 @@
-resource "ns1_alert" "example" {
+resource "ns1_alert" "example_zone_alert" {
   #required
-  name               = "Example Alert"
+  name               = "Example Zone Alert"
   type               = "zone"
   subtype            = "transfer_failed"
 
   #optional
   notification_lists = []
-  zone_names = []
+  zone_names = ["a.b.c.com","myzone"]
   record_ids = []
-}
+}
+
+resource "ns1_alert" "example_usage_alert" {
+  #required
+  name               = "Example Usage Alert"
+  type               = "account"
+  subtype            = "record_usage"
+  data {
+    alert_at_percent = 80
+  }
+}

ns1/resource_alert.go

@@ -1,6 +1,7 @@
 package ns1
 
 import (
+	"encoding/json"
 	"log"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -73,6 +74,18 @@ func alertResource() *schema.Resource {
 				},
 				ConflictsWith: []string{"zone_names"},
 			},
+			"data": {
+				Type:     schema.TypeSet,
+				Optional: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"alert_at_percent": {
+							Type:     schema.TypeInt,
+							Optional: true,
+						},
+					},
+				},
+			},
 		},
 		Create:   AlertConfigCreate,
 		Read:     AlertConfigRead,
@@ -94,6 +107,14 @@ func alertToResourceData(d *schema.ResourceData, alert *alerting.Alert) error {
 	d.Set("notification_lists", alert.NotifierListIds)
 	d.Set("zone_names", alert.ZoneNames)
 	d.Set("record_ids", alert.RecordIds)
+	if alert.Data != nil {
+		params := map[string]any{}
+		err := json.Unmarshal(alert.Data, &params)
+		if err != nil {
+			return err
+		}
+		d.Set("data", []any{params})
+	}
 	return nil
 }
 
@@ -158,6 +179,25 @@ func resourceDataToAlert(d *schema.ResourceData) (*alerting.Alert, error) {
 	} else {
 		alert.RecordIds = []string{}
 	}
+	if v, ok := d.GetOk("data"); ok {
+		params := map[string]any{}
+		if data, ok := v.(*schema.Set); ok {
+			for _, p := range data.List() {
+				if setting, ok := p.(map[string]any); ok {
+					for k, v := range setting {
+						params[k] = v
+					}
+				}
+			}
+		}
+		jsonData, err := json.Marshal(params)
+		if err != nil {
+			return nil, err
+		}
+		alert.Data = jsonData
+	} else {
+		alert.Data = []byte("{}")
+	}
 	return &alert, nil
 }
 

ns1/resource_alert_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log"
 	"reflect"
+	"regexp"
 	"sort"
 	"strings"
 	"testing"
@@ -17,6 +18,7 @@ import (
 )
 
 // Creating basic DNS alert
+// NOTE: You would need the `manage_zones` permission to create this alert type. Otherwise this test will fail!
 func TestAccAlert_basic(t *testing.T) {
 	var (
 		alert     = alerting.Alert{}
@@ -45,6 +47,46 @@ func TestAccAlert_basic(t *testing.T) {
 	})
 }
 
+func TestAccAlert_RecordUsage(t *testing.T) {
+	var (
+		alert     = alerting.Alert{}
+		alertName = fmt.Sprintf("terraform-test-alert-%s", acctest.RandStringFromCharSet(15, acctest.CharSetAlphaNum))
+	)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckAlertDestroy,
+		Steps: []resource.TestStep{
+			{Config: testRecordUsageAlert(alertName, 10),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckAlertExists("ns1_alert.it", &alert),
+					testAccCheckAlertName(&alert, alertName),
+					testAccCheckAlertType(&alert, "account"),
+					testAccCheckAlertSubtype(&alert, "record_usage"),
+					testAccCheckAlertData(&alert, `{"alert_at_percent":10}`),
+				)},
+			{Config: testRecordUsageAlert(alertName, 101),
+				ExpectError:        regexp.MustCompile("Please correct the following field: data.alert_at_percent"),
+				ExpectNonEmptyPlan: true,
+			},
+			{Config: testRecordUsageAlert(alertName, 50),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckAlertExists("ns1_alert.it", &alert),
+					testAccCheckAlertName(&alert, alertName),
+					testAccCheckAlertType(&alert, "account"),
+					testAccCheckAlertSubtype(&alert, "record_usage"),
+					testAccCheckAlertData(&alert, `{"alert_at_percent":50}`),
+				)},
+			{
+				ResourceName:      "ns1_alert.it",
+				ImportState:       true,
+				ImportStateVerify: true,
+			},
+		},
+	})
+}
+
 func TestAccAlert_links(t *testing.T) {
 	var (
 		alert     = alerting.Alert{}
@@ -184,6 +226,18 @@ func TestAccAlert_ManualDelete(t *testing.T) {
 	})
 }
 
+func testRecordUsageAlert(alertName string, threshold int) string {
+	return fmt.Sprintf(`resource "ns1_alert" "it" {
+	name               = "%s"
+	type               = "account"
+	subtype            = "record_usage"
+	notification_lists = []
+	data {
+		alert_at_percent = %d
+	}
+}`, alertName, threshold)
+}
+
 func testAccAlertBasic(alertName string) string {
 	return fmt.Sprintf(`resource "ns1_alert" "it" {
 	name               = "%s"
@@ -306,6 +360,16 @@ func testAccCheckAlertSubtype(alert *alerting.Alert, expected string) resource.T
 	}
 }
 
+func testAccCheckAlertData(alert *alerting.Alert, expected string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		data := string(alert.Data)
+		if data != expected {
+			return fmt.Errorf("alert.Data: got: %s want: %s", data, expected)
+		}
+		return nil
+	}
+}
+
 func testAccCheckAlertZoneNames(alert *alerting.Alert, expected []string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		actualSorted := alert.ZoneNames

website/docs/r/alert.html.markdown

@@ -13,17 +13,27 @@ Provides a NS1 Alert resource. This can be used to create, modify, and delete al
 ## Example Usage
 
 ```hcl
-resource "ns1_alert" "example" {
+resource "ns1_alert" "example_zone_alert" {
   #required
-  name               = "Example Alert"
+  name               = "Example Zone Alert"
   type               = "zone"
   subtype            = "transfer_failed"
 
   #optional
   notification_lists = []
-  zone_names = []
+  zone_names = ["a.b.c.com","myzone"]
   record_ids = []
 }
+
+resource "ns1_alert" "example_usage_alert" {
+  #required
+  name               = "Example Usage Alert"
+  type               = "account"
+  subtype            = "record_usage"
+  data {
+    alert_at_percent = 80
+  }
+}
 ```
 
 ## Argument Reference
@@ -36,6 +46,8 @@ The following arguments are supported:
 * `notification_lists` - (Optional) A list of id's for notification lists whose notifiers will be triggered by the alert.
 * `zone_names` - (Optional) A list of zones this alert applies to.
 * `record_ids` - (Optional) A list of record id's this alert applies to.
+* `data` - (Optional) A resource block with additional settings: the name and type of them vary based on the alert type.
+  * `alert_at_percent` - required by the account/usage alerts, with a value between 1 and 100
 
 ## Attributes Reference