Add pagination and sorting parameters on suppression list (#3080)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -49256,6 +49256,18 @@ components:
         meta:
           $ref: '#/components/schemas/ResponseMetaAttributes'
       type: object
+    SecurityMonitoringPaginatedSuppressionsResponse:
+      description: Response object containing the available suppression rules with
+        pagination metadata.
+      properties:
+        data:
+          description: A list of suppressions objects.
+          items:
+            $ref: '#/components/schemas/SecurityMonitoringSuppression'
+          type: array
+        meta:
+          $ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta'
+      type: object
     SecurityMonitoringReferenceTable:
       description: Reference tables used in the queries.
       properties:
@@ -51405,6 +51417,31 @@ components:
         data:
           $ref: '#/components/schemas/SecurityMonitoringSuppression'
       type: object
+    SecurityMonitoringSuppressionSort:
+      description: The sort parameters used for querying suppression rules.
+      enum:
+      - name
+      - start_date
+      - expiration_date
+      - update_date
+      - enabled
+      - -name
+      - -start_date
+      - -expiration_date
+      - -update_date
+      - -enabled
+      type: string
+      x-enum-varnames:
+      - NAME
+      - START_DATE
+      - EXPIRATION_DATE
+      - UPDATE_DATE
+      - ENABLED
+      - NAME_DESCENDING
+      - START_DATE_DESCENDING
+      - EXPIRATION_DATE_DESCENDING
+      - UPDATE_DATE_DESCENDING
+      - ENABLED_DESCENDING
     SecurityMonitoringSuppressionType:
       default: suppressions
       description: The type of the resource. The value should always be `suppressions`.
@@ -51500,6 +51537,31 @@ components:
       required:
       - data
       type: object
+    SecurityMonitoringSuppressionsMeta:
+      description: Metadata for the suppression list response.
+      properties:
+        page:
+          $ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta'
+      type: object
+    SecurityMonitoringSuppressionsPageMeta:
+      description: Pagination metadata.
+      properties:
+        pageNumber:
+          description: Current page number.
+          example: 0
+          format: int64
+          type: integer
+        pageSize:
+          description: Current page size.
+          example: 2
+          format: int64
+          type: integer
+        totalCount:
+          description: Total count of suppressions.
+          example: 2
+          format: int64
+          type: integer
+      type: object
     SecurityMonitoringSuppressionsResponse:
       description: Response object containing the available suppression rules.
       properties:
@@ -85670,12 +85732,29 @@ paths:
         required: false
         schema:
           type: string
+      - description: Attribute used to sort the list of suppression rules. Prefix
+          with `-` to sort in descending order.
+        in: query
+        name: sort
+        required: false
+        schema:
+          $ref: '#/components/schemas/SecurityMonitoringSuppressionSort'
+      - description: Size for a given page. Use `-1` to return all items.
+        in: query
+        name: page[size]
+        required: false
+        schema:
+          default: -1
+          example: 10
+          format: int64
+          type: integer
+      - $ref: '#/components/parameters/PageNumber'
       responses:
         '200':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
+                $ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse'
           description: OK
         '403':
           $ref: '#/components/responses/NotAuthorizedResponse'

docs/datadog_api_client.v2.model.rst

@@ -21739,6 +21739,13 @@ datadog\_api\_client.v2.model.security\_monitoring\_list\_rules\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.security\_monitoring\_paginated\_suppressions\_response module
+--------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_paginated_suppressions_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.security\_monitoring\_reference\_table module
 ---------------------------------------------------------------------------
 
@@ -22376,6 +22383,13 @@ datadog\_api\_client.v2.model.security\_monitoring\_suppression\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.security\_monitoring\_suppression\_sort module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_suppression_sort
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.security\_monitoring\_suppression\_type module
 ----------------------------------------------------------------------------
 
@@ -22404,6 +22418,20 @@ datadog\_api\_client.v2.model.security\_monitoring\_suppression\_update\_request
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.security\_monitoring\_suppressions\_meta module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_suppressions_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.security\_monitoring\_suppressions\_page\_meta module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.security_monitoring_suppressions_page_meta
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.security\_monitoring\_suppressions\_response module
 ---------------------------------------------------------------------------------
 

examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_1315707136.py

@@ -0,0 +1,24 @@
+"""
+Get all suppression rules returns "OK" response with sort ascending
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.security_monitoring_suppression_sort import SecurityMonitoringSuppressionSort
+
+# there is a valid "suppression" in the system
+SUPPRESSION_DATA_ID = environ["SUPPRESSION_DATA_ID"]
+
+# there is a valid "suppression2" in the system
+SUPPRESSION2_DATA_ID = environ["SUPPRESSION2_DATA_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.list_security_monitoring_suppressions(
+        query="id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0",
+        sort=SecurityMonitoringSuppressionSort.NAME,
+    )
+
+    print(response)

examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_1741429096.py

@@ -0,0 +1,24 @@
+"""
+Get all suppression rules returns "OK" response with sort descending
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+from datadog_api_client.v2.model.security_monitoring_suppression_sort import SecurityMonitoringSuppressionSort
+
+# there is a valid "suppression" in the system
+SUPPRESSION_DATA_ID = environ["SUPPRESSION_DATA_ID"]
+
+# there is a valid "suppression2" in the system
+SUPPRESSION2_DATA_ID = environ["SUPPRESSION2_DATA_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.list_security_monitoring_suppressions(
+        query="id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0",
+        sort=SecurityMonitoringSuppressionSort.NAME_DESCENDING,
+    )
+
+    print(response)

examples/v2/security-monitoring/ListSecurityMonitoringSuppressions_3985905558.py

@@ -0,0 +1,24 @@
+"""
+Get all suppression rules returns "OK" response with pagination
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
+
+# there is a valid "suppression" in the system
+SUPPRESSION_DATA_ID = environ["SUPPRESSION_DATA_ID"]
+
+# there is a valid "suppression2" in the system
+SUPPRESSION2_DATA_ID = environ["SUPPRESSION2_DATA_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SecurityMonitoringApi(api_client)
+    response = api_instance.list_security_monitoring_suppressions(
+        query="id:3dd-0uc-h1s OR id:886e6c3e-e543-049c-ee1b-56a1110295c0",
+        page_size=1,
+        page_number=0,
+    )
+
+    print(response)

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -80,11 +80,15 @@
 from datadog_api_client.v2.model.security_filter_response import SecurityFilterResponse
 from datadog_api_client.v2.model.security_filter_create_request import SecurityFilterCreateRequest
 from datadog_api_client.v2.model.security_filter_update_request import SecurityFilterUpdateRequest
-from datadog_api_client.v2.model.security_monitoring_suppressions_response import SecurityMonitoringSuppressionsResponse
+from datadog_api_client.v2.model.security_monitoring_paginated_suppressions_response import (
+    SecurityMonitoringPaginatedSuppressionsResponse,
+)
+from datadog_api_client.v2.model.security_monitoring_suppression_sort import SecurityMonitoringSuppressionSort
 from datadog_api_client.v2.model.security_monitoring_suppression_response import SecurityMonitoringSuppressionResponse
 from datadog_api_client.v2.model.security_monitoring_suppression_create_request import (
     SecurityMonitoringSuppressionCreateRequest,
 )
+from datadog_api_client.v2.model.security_monitoring_suppressions_response import SecurityMonitoringSuppressionsResponse
 from datadog_api_client.v2.model.security_monitoring_rule_create_payload import SecurityMonitoringRuleCreatePayload
 from datadog_api_client.v2.model.security_monitoring_standard_rule_create_payload import (
     SecurityMonitoringStandardRuleCreatePayload,
@@ -1763,7 +1767,7 @@ def __init__(self, api_client=None):
 
         self._list_security_monitoring_suppressions_endpoint = _Endpoint(
             settings={
-                "response_type": (SecurityMonitoringSuppressionsResponse,),
+                "response_type": (SecurityMonitoringPaginatedSuppressionsResponse,),
                 "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
                 "endpoint_path": "/api/v2/security_monitoring/configuration/suppressions",
                 "operation_id": "list_security_monitoring_suppressions",
@@ -1776,6 +1780,21 @@ def __init__(self, api_client=None):
                     "attribute": "query",
                     "location": "query",
                 },
+                "sort": {
+                    "openapi_types": (SecurityMonitoringSuppressionSort,),
+                    "attribute": "sort",
+                    "location": "query",
+                },
+                "page_size": {
+                    "openapi_types": (int,),
+                    "attribute": "page[size]",
+                    "location": "query",
+                },
+                "page_number": {
+                    "openapi_types": (int,),
+                    "attribute": "page[number]",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -4335,19 +4354,37 @@ def list_security_monitoring_suppressions(
         self,
         *,
         query: Union[str, UnsetType] = unset,
-    ) -> SecurityMonitoringSuppressionsResponse:
+        sort: Union[SecurityMonitoringSuppressionSort, UnsetType] = unset,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
+    ) -> SecurityMonitoringPaginatedSuppressionsResponse:
         """Get all suppression rules.
 
         Get the list of all suppression rules.
 
         :param query: Query string.
         :type query: str, optional
-        :rtype: SecurityMonitoringSuppressionsResponse
+        :param sort: Attribute used to sort the list of suppression rules. Prefix with ``-`` to sort in descending order.
+        :type sort: SecurityMonitoringSuppressionSort, optional
+        :param page_size: Size for a given page. Use ``-1`` to return all items.
+        :type page_size: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
+        :rtype: SecurityMonitoringPaginatedSuppressionsResponse
         """
         kwargs: Dict[str, Any] = {}
         if query is not unset:
             kwargs["query"] = query
 
+        if sort is not unset:
+            kwargs["sort"] = sort
+
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
+
         return self._list_security_monitoring_suppressions_endpoint.call_with_http_info(**kwargs)
 
     def list_threat_hunting_jobs(

src/datadog_api_client/v2/model/security_monitoring_paginated_suppressions_response.py

@@ -0,0 +1,56 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.security_monitoring_suppression import SecurityMonitoringSuppression
+    from datadog_api_client.v2.model.security_monitoring_suppressions_meta import SecurityMonitoringSuppressionsMeta
+
+
+class SecurityMonitoringPaginatedSuppressionsResponse(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.security_monitoring_suppression import SecurityMonitoringSuppression
+        from datadog_api_client.v2.model.security_monitoring_suppressions_meta import SecurityMonitoringSuppressionsMeta
+
+        return {
+            "data": ([SecurityMonitoringSuppression],),
+            "meta": (SecurityMonitoringSuppressionsMeta,),
+        }
+
+    attribute_map = {
+        "data": "data",
+        "meta": "meta",
+    }
+
+    def __init__(
+        self_,
+        data: Union[List[SecurityMonitoringSuppression], UnsetType] = unset,
+        meta: Union[SecurityMonitoringSuppressionsMeta, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Response object containing the available suppression rules with pagination metadata.
+
+        :param data: A list of suppressions objects.
+        :type data: [SecurityMonitoringSuppression], optional
+
+        :param meta: Metadata for the suppression list response.
+        :type meta: SecurityMonitoringSuppressionsMeta, optional
+        """
+        if data is not unset:
+            kwargs["data"] = data
+        if meta is not unset:
+            kwargs["meta"] = meta
+        super().__init__(kwargs)