feat(tem): add 'email_blocklisted' and 'blocklist_created' to WebhookEventType (scaleway#4330)

scaleway-bot · Laure-di · web-flow · commit 460532294348 · 2024-12-05T10:20:28.000Z
Co-authored-by: Laure-di &lt;62625835+Laure-di@users.noreply.github.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-tem-webhook-create-usage.golden b/cmd/scw/testdata/test-all-usage-tem-webhook-create-usage.golden
@@ -9,7 +9,7 @@ ARGS:
   [domain-id]             ID of the Domain to watch for triggering events
   [project-id]            Project ID to use. If none is passed the default project ID will be used
   [name]                  Name of the Webhook
-  [event-types.{index}]   List of event types that will trigger an event (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found)
+  [event-types.{index}]   List of event types that will trigger an event (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found | email_blocklisted | blocklist_created)
   [sns-arn]               Scaleway SNS ARN topic to push the events to
   [region=fr-par]         Region to target. If none is passed will use default region from the config (fr-par)
 
diff --git a/cmd/scw/testdata/test-all-usage-tem-webhook-list-events-usage.golden b/cmd/scw/testdata/test-all-usage-tem-webhook-list-events-usage.golden
@@ -9,7 +9,7 @@ ARGS:
   [order-by]              (Optional) List Webhook events corresponding to specific criteria (created_at_desc | created_at_asc)
   webhook-id              ID of the Webhook linked to the events
   [email-id]              ID of the email linked to the events
-  [event-types.{index}]   List of event types linked to the events (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found)
+  [event-types.{index}]   List of event types linked to the events (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found | email_blocklisted | blocklist_created)
   [statuses.{index}]      List of event statuses (unknown_status | sending | sent | failed)
   [project-id]            ID of the webhook Project
   [domain-id]             ID of the domain to watch for triggering events
diff --git a/cmd/scw/testdata/test-all-usage-tem-webhook-update-usage.golden b/cmd/scw/testdata/test-all-usage-tem-webhook-update-usage.golden
@@ -8,7 +8,7 @@ USAGE:
 ARGS:
   webhook-id              ID of the Webhook to update
   [name]                  Name of the Webhook to update
-  [event-types.{index}]   List of event types to update (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found)
+  [event-types.{index}]   List of event types to update (unknown_type | email_queued | email_dropped | email_deferred | email_delivered | email_spam | email_mailbox_not_found | email_blocklisted | blocklist_created)
   [sns-arn]               Scaleway SNS ARN topic to update
   [region=fr-par]         Region to target. If none is passed will use default region from the config (fr-par)
 
diff --git a/docs/commands/audit-trail.md b/docs/commands/audit-trail.md
@@ -0,0 +1,69 @@
+<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
+# Documentation for `scw audit-trail`
+This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
+  
+- [Represent an entry in the Audit Trail](#represent-an-entry-in-the-audit-trail)
+  - [List events](#list-events)
+- [Product integrated with Audit Trail](#product-integrated-with-audit-trail)
+  - [Retrieve the list of Scaleway resources for which you have Audit Trail events](#retrieve-the-list-of-scaleway-resources-for-which-you-have-audit-trail-events)
+
+  
+## Represent an entry in the Audit Trail
+
+Represent an entry in the Audit Trail.
+
+
+### List events
+
+Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`.
+
+**Usage:**
+
+```
+scw audit-trail event list [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| project-id |  | (Optional) ID of the Project containing the Audit Trail events |
+| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl` | (Optional) Returns a paginated list of Scaleway resources' features |
+| method-name |  | (Optional) Name of the method or the API call performed |
+| status |  | (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied |
+| recorded-after |  | (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default |
+| recorded-before |  | (Optional) The `recorded_before` parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns `now` by default |
+| order-by | One of: `recorded_at_desc`, `recorded_at_asc` |  |
+| page-size |  |  |
+| page-token |  |  |
+| product-name |  | (Optional) Name of the Scaleway resource in a hyphenated format |
+| organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
+| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config |
+
+
+
+## Product integrated with Audit Trail
+
+Product integrated with Audit Trail.
+
+
+### Retrieve the list of Scaleway resources for which you have Audit Trail events
+
+Retrieve the list of Scaleway resources for which you have Audit Trail events.
+
+**Usage:**
+
+```
+scw audit-trail product list [arg=value ...]
+```
+
+
+**Args:**
+
+| Name |   | Description |
+|------|---|-------------|
+| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams` | Region to target. If none is passed will use default region from the config |
+
+
+
diff --git a/docs/commands/tem.md b/docs/commands/tem.md
@@ -353,7 +353,7 @@ scw tem webhook create [arg=value ...]
 | domain-id |  | ID of the Domain to watch for triggering events |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | name |  | Name of the Webhook |
-| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found` | List of event types that will trigger an event |
+| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found`, `email_blocklisted`, `blocklist_created` | List of event types that will trigger an event |
 | sns-arn |  | Scaleway SNS ARN topic to push the events to |
 | region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
 
@@ -440,7 +440,7 @@ scw tem webhook list-events [arg=value ...]
 | order-by | One of: `created_at_desc`, `created_at_asc` | (Optional) List Webhook events corresponding to specific criteria |
 | webhook-id | Required | ID of the Webhook linked to the events |
 | email-id |  | ID of the email linked to the events |
-| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found` | List of event types linked to the events |
+| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found`, `email_blocklisted`, `blocklist_created` | List of event types linked to the events |
 | statuses.{index} | One of: `unknown_status`, `sending`, `sent`, `failed` | List of event statuses |
 | project-id |  | ID of the webhook Project |
 | domain-id |  | ID of the domain to watch for triggering events |
@@ -466,7 +466,7 @@ scw tem webhook update [arg=value ...]
 |------|---|-------------|
 | webhook-id | Required | ID of the Webhook to update |
 | name |  | Name of the Webhook to update |
-| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found` | List of event types to update |
+| event-types.{index} | One of: `unknown_type`, `email_queued`, `email_dropped`, `email_deferred`, `email_delivered`, `email_spam`, `email_mailbox_not_found`, `email_blocklisted`, `blocklist_created` | List of event types to update |
 | sns-arn |  | Scaleway SNS ARN topic to update |
 | region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
 
diff --git a/go.mod b/go.mod
@@ -26,7 +26,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20
 	github.com/moby/buildkit v0.13.2
 	github.com/opencontainers/go-digest v1.0.0
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203133010-eced26f4687e
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203154910-6e1399167b4e
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5
diff --git a/go.sum b/go.sum
@@ -466,8 +466,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203133010-eced26f4687e h1:53liAlyBY6iZLtDYBbWcuSQnpS6Qhb5t2wCAWM/qcb8=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203133010-eced26f4687e/go.mod h1:kAoejOVBg1E/aVAR6IwKWEmbLCEg2IXklzPAkxzAaXA=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203154910-6e1399167b4e h1:i7eeW9A/r3nGsTr7KMYFDIuzKY45ql9BevxOLUUPajk=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241203154910-6e1399167b4e/go.mod h1:kAoejOVBg1E/aVAR6IwKWEmbLCEg2IXklzPAkxzAaXA=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
 github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=
diff --git a/internal/namespaces/tem/v1alpha1/tem_cli.go b/internal/namespaces/tem/v1alpha1/tem_cli.go
@@ -769,7 +769,7 @@ func temWebhookCreate() *core.Command {
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
-				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found"},
+				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found", "email_blocklisted", "blocklist_created"},
 			},
 			{
 				Name:       "sns-arn",
@@ -912,7 +912,7 @@ func temWebhookUpdate() *core.Command {
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
-				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found"},
+				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found", "email_blocklisted", "blocklist_created"},
 			},
 			{
 				Name:       "sns-arn",
@@ -1008,7 +1008,7 @@ func temWebhookListEvents() *core.Command {
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
-				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found"},
+				EnumValues: []string{"unknown_type", "email_queued", "email_dropped", "email_deferred", "email_delivered", "email_spam", "email_mailbox_not_found", "email_blocklisted", "blocklist_created"},
 			},
 			{
 				Name:       "statuses.{index}",
