Regenerate client from commit 65514d8 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v2/openapi.yaml

@@ -23464,6 +23464,8 @@ components:
           $ref: "#/components/schemas/Enabled"
         name:
           $ref: "#/components/schemas/RuleName"
+        routing:
+          $ref: "#/components/schemas/NotificationRuleRouting"
         selectors:
           $ref: "#/components/schemas/Selectors"
         targets:
@@ -58623,6 +58625,76 @@ components:
         - targets
         - version
       type: object
+    NotificationRulePreviewNotificationStatus:
+      description: The notification status for the given rule type. `SUCCESS` means a matching event was found and the notification was sent successfully. `DEFAULT` means no matching event was found and a default placeholder notification was sent instead. `ERROR` means an error occurred while sending the notification.
+      enum:
+        - SUCCESS
+        - DEFAULT
+        - ERROR
+      example: SUCCESS
+      type: string
+      x-enum-varnames:
+        - SUCCESS
+        - DEFAULT
+        - ERROR
+    NotificationRulePreviewResponse:
+      description: Response from the notification preview request.
+      properties:
+        data:
+          $ref: "#/components/schemas/NotificationRulePreviewResponseData"
+      required:
+        - data
+      type: object
+    NotificationRulePreviewResponseAttributes:
+      description: Attributes of the notification preview response.
+      properties:
+        preview_results:
+          $ref: "#/components/schemas/NotificationRulePreviewResults"
+      required:
+        - preview_results
+      type: object
+    NotificationRulePreviewResponseData:
+      description: The notification preview response data.
+      properties:
+        attributes:
+          $ref: "#/components/schemas/NotificationRulePreviewResponseAttributes"
+        id:
+          description: The ID of the notification preview response.
+          example: rka-loa-zwu
+          type: string
+        type:
+          $ref: "#/components/schemas/NotificationRulePreviewResponseType"
+      required:
+        - type
+        - attributes
+      type: object
+    NotificationRulePreviewResponseType:
+      description: The type of the notification preview response.
+      enum:
+        - notification_preview_response
+      example: notification_preview_response
+      type: string
+      x-enum-varnames:
+        - NOTIFICATION_PREVIEW_RESPONSE
+    NotificationRulePreviewResult:
+      description: The preview result for a single rule type.
+      properties:
+        notification_status:
+          $ref: "#/components/schemas/NotificationRulePreviewNotificationStatus"
+        rule_type:
+          $ref: "#/components/schemas/RuleTypesItems"
+      required:
+        - rule_type
+        - notification_status
+      type: object
+    NotificationRulePreviewResults:
+      description: List of preview results for each rule type matched by the notification rule.
+      example:
+        - notification_status: DEFAULT
+          rule_type: log_detection
+      items:
+        $ref: "#/components/schemas/NotificationRulePreviewResult"
+      type: array
     NotificationRuleQuery:
       description: The query is composed of one or several key:value pairs, which can be used to filter security issues on tags and attributes.
       example: (source:production_service OR env:prod)
@@ -58633,6 +58705,22 @@ components:
         data:
           $ref: "#/components/schemas/NotificationRule"
       type: object
+    NotificationRuleRouting:
+      description: Routing configuration for the notification rule.
+      properties:
+        mode:
+          $ref: "#/components/schemas/NotificationRuleRoutingMode"
+      required:
+        - mode
+      type: object
+    NotificationRuleRoutingMode:
+      description: The routing mode for the notification rule. `manual` sends notifications to the configured targets.
+      enum:
+        - manual
+      example: manual
+      type: string
+      x-enum-varnames:
+        - MANUAL
     NotificationRulesListResponse:
       description: The list of notification rules.
       properties:
@@ -68437,6 +68525,8 @@ components:
           $ref: "#/components/schemas/Enabled"
         name:
           $ref: "#/components/schemas/RuleName"
+        routing:
+          $ref: "#/components/schemas/NotificationRuleRouting"
         selectors:
           $ref: "#/components/schemas/Selectors"
         targets:
@@ -74747,6 +74837,7 @@ components:
         - iac_misconfiguration
         - sast_vulnerability
         - secret_vulnerability
+      example: log_detection
       type: string
       x-enum-varnames:
         - APPLICATION_SECURITY
@@ -163272,6 +163363,73 @@ paths:
       x-unstable: |-
         **Note**: This endpoint is in preview and is subject to change.
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
+  /api/v2/security_monitoring/configuration/notification_rules/send_notification_preview:
+    post:
+      description: Send a notification preview to test that a notification rule's targets are properly configured.
+      operationId: SendSecurityMonitoringNotificationPreview
+      requestBody:
+        content:
+          application/json:
+            examples:
+              default:
+                value:
+                  data:
+                    attributes:
+                      enabled: true
+                      name: Rule 1
+                      selectors:
+                        query: env:prod
+                        rule_types:
+                          - log_detection
+                        severities:
+                          - critical
+                        trigger_source: security_signals
+                      targets:
+                        - "@john.doe@email.com"
+                    type: notification_rules
+            schema:
+              $ref: "#/components/schemas/CreateNotificationRuleParameters"
+        required: true
+      responses:
+        "200":
+          content:
+            application/json:
+              examples:
+                default:
+                  value:
+                    data:
+                      attributes:
+                        preview_results:
+                          - notification_status: DEFAULT
+                            rule_type: log_detection
+                      id: rka-loa-zwu
+                      type: notification_preview_response
+              schema:
+                $ref: "#/components/schemas/NotificationRulePreviewResponse"
+          description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Bad Request
+        "403":
+          $ref: "#/components/responses/NotAuthorizedResponse"
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      security:
+        - apiKeyAuth: []
+          appKeyAuth: []
+        - AuthZ:
+            - security_monitoring_notification_profiles_read
+      summary: Test a notification rule
+      tags:
+        - Security Monitoring
+      x-codegen-request-body-name: body
+      "x-permission":
+        operator: OR
+        permissions:
+          - security_monitoring_notification_profiles_read
   /api/v2/security_monitoring/configuration/security_filters:
     get:
       description: Get the list of configured security filters with their definitions.

docs/datadog_api_client.v2.model.rst

@@ -24686,13 +24686,69 @@ datadog\_api\_client.v2.model.notification\_rule\_attributes module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.notification\_rule\_preview\_notification\_status module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_notification_status
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_preview\_response module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_preview\_response\_attributes module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_preview\_response\_data module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_preview\_response\_type module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_response_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_preview\_result module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_preview_result
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.notification\_rule\_response module
 -----------------------------------------------------------------
 
 .. automodule:: datadog_api_client.v2.model.notification_rule_response
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.notification\_rule\_routing module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_routing
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notification\_rule\_routing\_mode module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notification_rule_routing_mode
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.notification\_rules\_list\_response module
 ------------------------------------------------------------------------
 

examples/v2/security-monitoring/SendSecurityMonitoringNotificationPreview.py

@@ -0,0 +1,46 @@
+"""
+Test a notification rule returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.create_notification_rule_parameters import CreateNotificationRuleParameters
+from datadog_api_client.v2.model.create_notification_rule_parameters_data import CreateNotificationRuleParametersData
+from datadog_api_client.v2.model.create_notification_rule_parameters_data_attributes import (
+    CreateNotificationRuleParametersDataAttributes,
+)
+from datadog_api_client.v2.model.notification_rules_type import NotificationRulesType
+from datadog_api_client.v2.model.rule_severity import RuleSeverity
+from datadog_api_client.v2.model.rule_types_items import RuleTypesItems
+from datadog_api_client.v2.model.selectors import Selectors
+from datadog_api_client.v2.model.trigger_source import TriggerSource
+
+body = CreateNotificationRuleParameters(
+    data=CreateNotificationRuleParametersData(
+        attributes=CreateNotificationRuleParametersDataAttributes(
+            enabled=True,
+            name="Rule 1",
+            selectors=Selectors(
+                query="env:prod",
+                rule_types=[
+                    RuleTypesItems.LOG_DETECTION,
+                ],
+                severities=[
+                    RuleSeverity.CRITICAL,
+                ],
+                trigger_source=TriggerSource.SECURITY_SIGNALS,
+            ),
+            targets=[
+                "@john.doe@email.com",
+            ],
+        ),
+        type=NotificationRulesType.NOTIFICATION_RULES,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.send_security_monitoring_notification_preview(body=body)
+
+    print(response)

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -103,6 +103,7 @@
 from datadog_api_client.v2.model.security_monitoring_integration_config_update_request import (
     SecurityMonitoringIntegrationConfigUpdateRequest,
 )
+from datadog_api_client.v2.model.notification_rule_preview_response import NotificationRulePreviewResponse
 from datadog_api_client.v2.model.security_filters_response import SecurityFiltersResponse
 from datadog_api_client.v2.model.security_filter_response import SecurityFilterResponse
 from datadog_api_client.v2.model.security_filter_create_request import SecurityFilterCreateRequest
@@ -3548,6 +3549,26 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._send_security_monitoring_notification_preview_endpoint = _Endpoint(
+            settings={
+                "response_type": (NotificationRulePreviewResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/security_monitoring/configuration/notification_rules/send_notification_preview",
+                "operation_id": "send_security_monitoring_notification_preview",
+                "http_method": "POST",
+                "version": "v2",
+            },
+            params_map={
+                "body": {
+                    "required": True,
+                    "openapi_types": (CreateNotificationRuleParameters,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
         self._test_existing_security_monitoring_rule_endpoint = _Endpoint(
             settings={
                 "response_type": (SecurityMonitoringRuleTestResponse,),
@@ -7403,6 +7424,22 @@ def search_security_monitoring_signals_with_pagination(
         }
         return endpoint.call_with_http_info_paginated(pagination)
 
+    def send_security_monitoring_notification_preview(
+        self,
+        body: CreateNotificationRuleParameters,
+    ) -> NotificationRulePreviewResponse:
+        """Test a notification rule.
+
+        Send a notification preview to test that a notification rule's targets are properly configured.
+
+        :type body: CreateNotificationRuleParameters
+        :rtype: NotificationRulePreviewResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["body"] = body
+
+        return self._send_security_monitoring_notification_preview_endpoint.call_with_http_info(**kwargs)
+
     def test_existing_security_monitoring_rule(
         self,
         rule_id: str,