Add missing attributes to services and status_pages

Author: FabianDaniel00

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes of the StatusPal Terraform provider will be documented in th
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.6] - 2024-07-10
+
+### Added
+
+- `webhook_monitoring_service`, `webhook_custom_jsonpath_settings`, `inbound_email_address` and `incoming_webhook_url` attributes to the service resource and services data source.
+- `webhook` type to the service `monitoring` attribute
+- `bg_image`, `logo` and `favicon` readonly attributes to the status_page resource and status_pages data source.
+- Validators to the service resource attributes where it was needed.
+
+### Changed
+
+- Polished the documentation.
+
 ## [0.2.5] - 2024-06-14
 
 ### Changed

docs/data-sources/services.md

@@ -49,19 +49,22 @@ Read-Only:
 - `display_response_time_chart` (Boolean) Display response time chart?
 - `display_uptime_graph` (Boolean) Display uptime graph?
 - `id` (String) The ID of the service.
+- `inbound_email_address` (String) This is field is populated from `inbound_email_id`, if the `monitoring` is set to `3rd_party`.
 - `inbound_email_id` (String) The inbound email ID.
 - `incident_type` (String) Enum: `"major"` `"minor"`
   Sets the incident type to this value when an incident is created via monitoring.
   The type of the (current) incident:
   - `minor` - A minor incident is currently taking place.
   - `major` - A major incident is currently taking place.
+- `incoming_webhook_url` (String) This is field is populated from `inbound_email_id`, if the `monitoring` is set to `webhook` and the `webhook_monitoring_service` is set.
 - `inserted_at` (String) Datetime at which the service was inserted.
 - `is_up` (Boolean) Is the monitored service up?
-- `monitoring` (String) Enum: `null` `"internal"` `"3rd_party"`
+- `monitoring` (String) Enum: `""` `"internal"` `"3rd_party"` `"webhook"`
   Monitoring types:
-  - empty - No monitoring.
+  - `""` - No monitoring.
   - `internal` - StatusPal monitoring.
   - `3rd_party` - 3rd Party monitoring.
+  - `webhook` - Incoming webhook monitoring.
 - `name` (String) The name of the service.
 - `order` (Number) Service's position in the service list.
 - `parent_id` (String) The service parent ID.
@@ -89,6 +92,15 @@ Read-Only:
   ```
 → (see [below for nested schema](#nestedatt--services--translations))
 - `updated_at` (String) Datetime at which the service was last updated.
+- `webhook_custom_jsonpath_settings` (Attributes) The webhook monitoring service custom JSONPath settings.
+  > **Configure this field only if the `webhook_monitoring_service` is set to `custom-jsonpath`.**
+→ (see [below for nested schema](#nestedatt--services--webhook_custom_jsonpath_settings))
+- `webhook_monitoring_service` (String) Enum: `"status-cake"` `"uptime-robot"` `"custom-jsonpath"`
+  > **Configure this field only if the `monitoring` is set to `webhook`.**
+  Webhook Monitoring types:
+  - `status-cake` - StatusCake monitoring service.
+  - `internal` - UptimeRobot monitoring service.
+  - `3rd_party` - Custom JSONPath.
 
 <a id="nestedatt--services--translations"></a>
 ### Nested Schema for `services.translations`
@@ -97,3 +109,12 @@ Read-Only:
 
 - `description` (String) The description of the service.
 - `name` (String) The name of the service.
+
+
+<a id="nestedatt--services--webhook_custom_jsonpath_settings"></a>
+### Nested Schema for `services.webhook_custom_jsonpath_settings`
+
+Read-Only:
+
+- `expected_result` (String) The expected result in the JSON, e.g. `"up"`
+- `jsonpath` (String) The path in the JSON, e.g. `$.status`

docs/data-sources/status_pages.md

@@ -59,6 +59,7 @@ Read-Only:
 - `email_notification_template` (String) Custom email notification template, see the documentation: [Custom email templates](https://docs.statuspal.io/platform/subscriptions-and-notifications/custom-email-templates).
 - `email_templates_enabled` (Boolean) The templates won't be used until this is enabled, but you can send test emails.
 - `enable_auto_translations` (Boolean) Enable auto translations when creating incidents, maintenances and info notices.
+- `favicon` (String) Favicon url of the status page.
 - `feed_enabled` (Boolean) Allow your customers to receive updates as RSS and Atom feeds.
 - `google_calendar_enabled` (Boolean) Allow your customers to import Google Calendar with Status Pages maintenance (business only).
 - `google_chat_notifications_enabled` (Boolean) Allow your customers to receive notifications on Google Chat.
@@ -75,6 +76,7 @@ Read-Only:
 - `inserted_at` (String) Datetime at which the status page was inserted.
 - `link_color` (String) The links color in the status page.
 - `locked_when_maintenance` (Boolean) Lock from adding incidents when under maintenance.
+- `logo` (String) Logo url of the status page.
 - `maintenance_notification_hours` (Number) Long-running incident notification (Maintenance).
 - `major_notification_hours` (Number) Long-running incident notification (Major incident).
 - `mattermost_notifications_enabled` (Boolean) Allow your customers to receive notifications on Mattermost.

docs/index.md

@@ -18,15 +18,15 @@ terraform {
   required_providers {
     statuspal = {
       source  = "statuspal/statuspal"
-      version = "0.2.5"
+      version = "0.2.6"
     }
   }
 }
 
 # Configure the StatusPal provider
 provider "statuspal" {
   api_key = "uk_aERPQU1kUzUrRmplaXJRMlc2TDEwZz09" // your user or organization api key
-  region  = "US"                                  // can be "US" and "EU"
+  region  = "US"                                  // "US" or "EU"
 }
 
 # List all status pages of the organization with ID 1.
@@ -40,7 +40,7 @@ resource "statuspal_status_page" "example" {
   status_page = {
     name      = "Example Terraform Status Page"
     url       = "example.com"
-    time_zone = "Europe/Berlin"
+    time_zone = "America/New_York"
   }
 }
 

docs/resources/service.md

@@ -57,11 +57,12 @@ Optional:
 - `description` (String) The description of the service.
 - `display_response_time_chart` (Boolean) Display response time chart?
 - `display_uptime_graph` (Boolean) Display uptime graph?
-- `monitoring` (String) Enum: `null` `"internal"` `"3rd_party"`
+- `monitoring` (String) Enum: `""` `"internal"` `"3rd_party"` `"webhook"`
   Monitoring types:
-  - empty - No monitoring.
+  - `""` - No monitoring.
   - `internal` - StatusPal monitoring.
   - `3rd_party` - 3rd Party monitoring.
+  - `webhook` - Incoming webhook monitoring.
 - `order` (Number) Service's position in the service list.
 - `parent_id` (String) The service parent ID.
 - `pause_monitoring_during_maintenances` (Boolean) Pause the the service monitoring during maintenances?
@@ -82,26 +83,37 @@ Optional:
 	}
   ```
 → (see [below for nested schema](#nestedatt--service--translations))
+- `webhook_custom_jsonpath_settings` (Attributes) The webhook monitoring service custom JSONPath settings.
+  > **Configure this field only if the `webhook_monitoring_service` is set to `custom-jsonpath`.**
+→ (see [below for nested schema](#nestedatt--service--webhook_custom_jsonpath_settings))
+- `webhook_monitoring_service` (String) Enum: `"status-cake"` `"uptime-robot"` `"custom-jsonpath"`
+  > **Configure this field only if the `monitoring` is set to `webhook`.**
+  Webhook Monitoring types:
+  - `status-cake` - StatusCake monitoring service.
+  - `internal` - UptimeRobot monitoring service.
+  - `3rd_party` - Custom JSONPath.
 
 Read-Only:
 
 - `children_ids` (List of Number) IDs of the service's children.
-- `current_incident_type` (String) Enum: `"major"` `"minor"` `"scheduled"`
+- `current_incident_type` (String) Enum: `"minor"` `"major"` `"scheduled"`
   The service's current incident type.
   The type of the (current) incident:
   - `minor` - A minor incident is currently taking place.
   - `major` - A major incident is currently taking place.
   - `scheduled` - A scheduled maintenance is currently taking place.
 - `id` (String) The ID of the service.
+- `inbound_email_address` (String) This is field is populated from `inbound_email_id`, if the `monitoring` is set to `3rd_party`.
 - `inbound_email_id` (String) The inbound email ID.
-- `incident_type` (String) Enum: `"major"` `"minor"`
+- `incident_type` (String) Enum: `"minor"` `"major"`
   Sets the incident type to this value when an incident is created via monitoring.
   The type of the (current) incident:
   - `minor` - A minor incident is currently taking place.
   - `major` - A major incident is currently taking place.
+- `incoming_webhook_url` (String) This is field is populated from `inbound_email_id`, if the `monitoring` is set to `webhook` and the `webhook_monitoring_service` is set.
 - `inserted_at` (String) Datetime at which the service was inserted.
 - `is_up` (Boolean) Is the monitored service up?
-- `parent_incident_type` (String) Enum: `"major"` `"minor"`
+- `parent_incident_type` (String) Enum: `"minor"` `"major"`
   Sets the parent's service incident type to this value when an incident is created via monitoring.
   The type of the (current) incident:
   - `minor` - A minor incident is currently taking place.
@@ -116,6 +128,15 @@ Required:
 - `description` (String) The description of the service.
 - `name` (String) The name of the service.
 
+
+<a id="nestedatt--service--webhook_custom_jsonpath_settings"></a>
+### Nested Schema for `service.webhook_custom_jsonpath_settings`
+
+Required:
+
+- `expected_result` (String) The expected result in the JSON, e.g. `"up"`
+- `jsonpath` (String) The path in the JSON, e.g. `$.status`
+
 ## Import
 
 Import is supported using the following syntax:

docs/resources/status_page.md

@@ -48,7 +48,6 @@ Required:
 Optional:
 
 - `about` (String) Customize the about information displayed in your status page.
-- `bg_image` (String) Background image url of the status page.
 - `calendar_enabled` (Boolean) Allow your customers to receive updates via iCalendar feed.
 - `captcha_enabled` (Boolean) Enable captchas (this option is only available when the status page is member restricted).
 - `current_incidents_position` (String) The incident position displayed in the status page, it can be "below_services" and "above_services".
@@ -131,7 +130,10 @@ Optional:
 
 Read-Only:
 
+- `bg_image` (String) Background image url of the status page.
+- `favicon` (String) Favicon url of the status page.
 - `inserted_at` (String) Datetime at which the status page was inserted.
+- `logo` (String) Logo url of the status page.
 - `updated_at` (String) Datetime at which the status page was last updated.
 
 <a id="nestedatt--status_page--theme_configs"></a>

examples/provider/provider.tf

@@ -3,15 +3,15 @@ terraform {
   required_providers {
     statuspal = {
       source  = "statuspal/statuspal"
-      version = "0.2.5"
+      version = "0.2.6"
     }
   }
 }
 
 # Configure the StatusPal provider
 provider "statuspal" {
   api_key = "uk_aERPQU1kUzUrRmplaXJRMlc2TDEwZz09" // your user or organization api key
-  region  = "US"                                  // can be "US" and "EU"
+  region  = "US"                                  // "US" or "EU"
 }
 
 # List all status pages of the organization with ID 1.
@@ -25,7 +25,7 @@ resource "statuspal_status_page" "example" {
   status_page = {
     name      = "Example Terraform Status Page"
     url       = "example.com"
-    time_zone = "Europe/Berlin"
+    time_zone = "America/New_York"
   }
 }
 

internal/client/models.go

@@ -36,6 +36,8 @@ type StatusPage struct {
 	HeaderLogoText                 string                 `json:"header_logo_text,omitempty"`
 	PublicCompanyName              string                 `json:"public_company_name,omitempty"`
 	BgImage                        string                 `json:"bg_image,omitempty"`
+	Logo                           string                 `json:"logo,omitempty"`
+	Favicon                        string                 `json:"favicon,omitempty"`
 	DisplayUptimeGraph             bool                   `json:"display_uptime_graph,omitempty"`
 	UptimeGraphDays                int64                  `json:"uptime_graph_days,omitempty"`
 	CurrentIncidentsPosition       string                 `json:"current_incidents_position,omitempty"`
@@ -98,29 +100,38 @@ type StatusPageThemeConfigs struct {
 
 // Service struct.
 type Service struct {
-	ID                                int64               `json:"id,omitempty"`
-	Name                              string              `json:"name,omitempty"`
-	Description                       string              `json:"description,omitempty"`
-	PrivateDescription                string              `json:"private_description,omitempty"`
-	ParentID                          int64               `json:"parent_id,omitempty"`
-	CurrentIncidentType               string              `json:"current_incident_type,omitempty"`
-	Monitoring                        string              `json:"monitoring,omitempty"`
-	PingUrl                           string              `json:"ping_url,omitempty"`
-	IncidentType                      string              `json:"incident_type,omitempty"`
-	ParentIncidentType                string              `json:"parent_incident_type,omitempty"`
-	IsUp                              bool                `json:"is_up,omitempty"`
-	PauseMonitoringDuringMaintenances bool                `json:"pause_monitoring_during_maintenances,omitempty"`
-	InboundEmailID                    string              `json:"inbound_email_id,omitempty"`
-	AutoIncident                      bool                `json:"auto_incident,omitempty"`
-	AutoNotify                        bool                `json:"auto_notify,omitempty"`
-	ChildrenIDs                       []int64             `json:"children_ids,omitempty"`
-	Translations                      ServiceTranslations `json:"translations,omitempty"`
-	Private                           bool                `json:"private,omitempty"`
-	DisplayUptimeGraph                bool                `json:"display_uptime_graph,omitempty"`
-	DisplayResponseTimeChart          bool                `json:"display_response_time_chart,omitempty"`
-	Order                             int64               `json:"order,omitempty"`
-	InsertedAt                        string              `json:"inserted_at,omitempty"`
-	UpdatedAt                         string              `json:"updated_at,omitempty"`
+	ID                                int64                         `json:"id,omitempty"`
+	Name                              string                        `json:"name,omitempty"`
+	Description                       string                        `json:"description,omitempty"`
+	PrivateDescription                string                        `json:"private_description,omitempty"`
+	ParentID                          int64                         `json:"parent_id,omitempty"`
+	CurrentIncidentType               string                        `json:"current_incident_type,omitempty"`
+	Monitoring                        string                        `json:"monitoring"`
+	WebhookMonitoringService          string                        `json:"webhook_monitoring_service,omitempty"`
+	WebhookCustomJsonpathSettings     WebhookCustomJsonpathSettings `json:"webhook_custom_jsonpath_settings,omitempty"`
+	InboundEmailAddress               string                        `json:"inbound_email_address,omitempty"`
+	IncomingWebhookUrl                string                        `json:"incoming_webhook_url,omitempty"`
+	PingUrl                           string                        `json:"ping_url,omitempty"`
+	IncidentType                      string                        `json:"incident_type,omitempty"`
+	ParentIncidentType                string                        `json:"parent_incident_type,omitempty"`
+	IsUp                              bool                          `json:"is_up,omitempty"`
+	PauseMonitoringDuringMaintenances bool                          `json:"pause_monitoring_during_maintenances,omitempty"`
+	InboundEmailID                    string                        `json:"inbound_email_id,omitempty"`
+	AutoIncident                      bool                          `json:"auto_incident,omitempty"`
+	AutoNotify                        bool                          `json:"auto_notify,omitempty"`
+	ChildrenIDs                       []int64                       `json:"children_ids,omitempty"`
+	Translations                      ServiceTranslations           `json:"translations,omitempty"`
+	Private                           bool                          `json:"private,omitempty"`
+	DisplayUptimeGraph                bool                          `json:"display_uptime_graph,omitempty"`
+	DisplayResponseTimeChart          bool                          `json:"display_response_time_chart,omitempty"`
+	Order                             int64                         `json:"order,omitempty"`
+	InsertedAt                        string                        `json:"inserted_at,omitempty"`
+	UpdatedAt                         string                        `json:"updated_at,omitempty"`
+}
+
+type WebhookCustomJsonpathSettings struct {
+	Jsonpath       string `json:"jsonpath,omitempty"`
+	ExpectedResult string `json:"expected_result,omitempty"`
 }
 
 type ServiceTranslations map[string]ServiceTranslation