RUM - Add OpenAPI spec for hardcoded retention filters

docs/datadog_api_client.v2.api.rst

@@ -662,6 +662,13 @@ datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.rum\_retention\_filters\_hardcoded\_api module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.rum_retention_filters_hardcoded_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.salesforce\_integration\_api module
 ---------------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -31322,6 +31322,104 @@ datadog\_api\_client.v2.model.rum\_group\_by\_total module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_cross_product_sampling
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling\_editability module
+------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_cross_product_sampling_editability
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_cross\_product\_sampling\_update module
+-------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_cross_product_sampling_update
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_attributes module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_data module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_event\_type module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_event_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_meta module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_meta\_source module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_meta_source
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_response module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_type module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_attributes module
+------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_data module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filter\_update\_request module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.rum\_hardcoded\_retention\_filters\_response module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rum_hardcoded_retention_filters_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.rum\_metric\_compute module
 ---------------------------------------------------------
 

examples/v2/rum-retention-filters-hardcoded/GetHardcodedRetentionFilter.py

@@ -0,0 +1,16 @@
+"""
+Get a hardcoded retention filter returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_retention_filters_hardcoded_api import RUMRetentionFiltersHardcodedApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RUMRetentionFiltersHardcodedApi(api_client)
+    response = api_instance.get_hardcoded_retention_filter(
+        app_id="Example-RUM-Retention-Filters-Hardcoded",
+        rf_id="Example-RUM-Retention-Filters-Hardcoded",
+    )
+
+    print(response)

examples/v2/rum-retention-filters-hardcoded/ListHardcodedRetentionFilters.py

@@ -0,0 +1,15 @@
+"""
+Get all hardcoded retention filters returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_retention_filters_hardcoded_api import RUMRetentionFiltersHardcodedApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RUMRetentionFiltersHardcodedApi(api_client)
+    response = api_instance.list_hardcoded_retention_filters(
+        app_id="Example-RUM-Retention-Filters-Hardcoded",
+    )
+
+    print(response)

examples/v2/rum-retention-filters-hardcoded/UpdateHardcodedRetentionFilter.py

@@ -0,0 +1,39 @@
+"""
+Update a hardcoded retention filter returns "Updated" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_retention_filters_hardcoded_api import RUMRetentionFiltersHardcodedApi
+from datadog_api_client.v2.model.rum_hardcoded_cross_product_sampling_update import (
+    RumHardcodedCrossProductSamplingUpdate,
+)
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_type import RumHardcodedRetentionFilterType
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_attributes import (
+    RumHardcodedRetentionFilterUpdateAttributes,
+)
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_data import RumHardcodedRetentionFilterUpdateData
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_request import (
+    RumHardcodedRetentionFilterUpdateRequest,
+)
+
+body = RumHardcodedRetentionFilterUpdateRequest(
+    data=RumHardcodedRetentionFilterUpdateData(
+        id="REPLACE.ME",
+        type=RumHardcodedRetentionFilterType.HARDCODED_RETENTION_FILTERS,
+        attributes=RumHardcodedRetentionFilterUpdateAttributes(
+            cross_product_sampling=RumHardcodedCrossProductSamplingUpdate(
+                session_replay_sample_rate=50.0,
+                session_replay_enabled=True,
+            ),
+        ),
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RUMRetentionFiltersHardcodedApi(api_client)
+    response = api_instance.update_hardcoded_retention_filter(
+        app_id="Example-RUM-Retention-Filters-Hardcoded", rf_id="Example-RUM-Retention-Filters-Hardcoded", body=body
+    )
+
+    print(response)

src/datadog_api_client/v2/api/rum_retention_filters_hardcoded_api.py

@@ -0,0 +1,178 @@
+# 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 Any, Dict
+
+from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
+from datadog_api_client.configuration import Configuration
+from datadog_api_client.v2.model.rum_hardcoded_retention_filters_response import RumHardcodedRetentionFiltersResponse
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_response import RumHardcodedRetentionFilterResponse
+from datadog_api_client.v2.model.rum_hardcoded_retention_filter_update_request import (
+    RumHardcodedRetentionFilterUpdateRequest,
+)
+
+
+class RUMRetentionFiltersHardcodedApi:
+    """
+    Manage hardcoded retention filters through `Manage Applications <https://app.datadoghq.com/rum/list>`_ in RUM.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient(Configuration())
+        self.api_client = api_client
+
+        self._get_hardcoded_retention_filter_endpoint = _Endpoint(
+            settings={
+                "response_type": (RumHardcodedRetentionFilterResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/rum/applications/{app_id}/hardcoded_retention_filters/{rf_id}",
+                "operation_id": "get_hardcoded_retention_filter",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "app_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "app_id",
+                    "location": "path",
+                },
+                "rf_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "rf_id",
+                    "location": "path",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
+        self._list_hardcoded_retention_filters_endpoint = _Endpoint(
+            settings={
+                "response_type": (RumHardcodedRetentionFiltersResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/rum/applications/{app_id}/hardcoded_retention_filters",
+                "operation_id": "list_hardcoded_retention_filters",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "app_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "app_id",
+                    "location": "path",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
+        self._update_hardcoded_retention_filter_endpoint = _Endpoint(
+            settings={
+                "response_type": (RumHardcodedRetentionFilterResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/rum/applications/{app_id}/hardcoded_retention_filters/{rf_id}",
+                "operation_id": "update_hardcoded_retention_filter",
+                "http_method": "PATCH",
+                "version": "v2",
+            },
+            params_map={
+                "app_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "app_id",
+                    "location": "path",
+                },
+                "rf_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "rf_id",
+                    "location": "path",
+                },
+                "body": {
+                    "required": True,
+                    "openapi_types": (RumHardcodedRetentionFilterUpdateRequest,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
+    def get_hardcoded_retention_filter(
+        self,
+        app_id: str,
+        rf_id: str,
+    ) -> RumHardcodedRetentionFilterResponse:
+        """Get a hardcoded retention filter.
+
+        Get a single hardcoded retention filter for a RUM application.
+
+        :param app_id: RUM application ID.
+        :type app_id: str
+        :param rf_id: Hardcoded retention filter ID.
+        :type rf_id: str
+        :rtype: RumHardcodedRetentionFilterResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["app_id"] = app_id
+
+        kwargs["rf_id"] = rf_id
+
+        return self._get_hardcoded_retention_filter_endpoint.call_with_http_info(**kwargs)
+
+    def list_hardcoded_retention_filters(
+        self,
+        app_id: str,
+    ) -> RumHardcodedRetentionFiltersResponse:
+        """Get all hardcoded retention filters.
+
+        Get the list of hardcoded retention filters for a RUM application.
+
+        :param app_id: RUM application ID.
+        :type app_id: str
+        :rtype: RumHardcodedRetentionFiltersResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["app_id"] = app_id
+
+        return self._list_hardcoded_retention_filters_endpoint.call_with_http_info(**kwargs)
+
+    def update_hardcoded_retention_filter(
+        self,
+        app_id: str,
+        rf_id: str,
+        body: RumHardcodedRetentionFilterUpdateRequest,
+    ) -> RumHardcodedRetentionFilterResponse:
+        """Update a hardcoded retention filter.
+
+        Update the cross-product sample rates of a hardcoded retention filter for a RUM application.
+        Only fields whose matching flag in ``cross_product_sampling_editability`` is ``true`` can be updated.
+        Any other field is read-only and cannot be sent in the payload.
+        Returns the updated hardcoded retention filter when the request is successful.
+
+        :param app_id: RUM application ID.
+        :type app_id: str
+        :param rf_id: Hardcoded retention filter ID.
+        :type rf_id: str
+        :param body: New cross-product sample rates for the hardcoded retention filter.
+        :type body: RumHardcodedRetentionFilterUpdateRequest
+        :rtype: RumHardcodedRetentionFilterResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["app_id"] = app_id
+
+        kwargs["rf_id"] = rf_id
+
+        kwargs["body"] = body
+
+        return self._update_hardcoded_retention_filter_endpoint.call_with_http_info(**kwargs)

src/datadog_api_client/v2/apis/__init__.py

@@ -82,6 +82,7 @@
 from datadog_api_client.v2.api.product_analytics_api import ProductAnalyticsApi
 from datadog_api_client.v2.api.rum_api import RUMApi
 from datadog_api_client.v2.api.rum_insights_api import RUMInsightsApi
+from datadog_api_client.v2.api.rum_retention_filters_hardcoded_api import RUMRetentionFiltersHardcodedApi
 from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
 from datadog_api_client.v2.api.restriction_policies_api import RestrictionPoliciesApi
 from datadog_api_client.v2.api.roles_api import RolesApi
@@ -205,6 +206,7 @@
     "ProductAnalyticsApi",
     "RUMApi",
     "RUMInsightsApi",
+    "RUMRetentionFiltersHardcodedApi",
     "ReferenceTablesApi",
     "RestrictionPoliciesApi",
     "RolesApi",