Sync rum-replay endpoints with backend for public documentation (#3151)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.generator/schemas/v2/openapi.yaml

@@ -501,6 +501,34 @@ datadog\_api\_client.v2.api.rum\_metrics\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.rum\_replay\_heatmaps\_api module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.rum_replay_heatmaps_api
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.api.rum\_replay\_playlists\_api module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.rum_replay_playlists_api
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.api.rum\_replay\_sessions\_api module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.rum_replay_sessions_api
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.api.rum\_replay\_viewership\_api module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.rum_replay_viewership_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
 ---------------------------------------------------------------
 

docs/datadog_api_client.v2.api.rst

@@ -19478,6 +19478,76 @@ datadog\_api\_client.v2.model.permissions\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.playlist module
+---------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlist\_array module
+----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlist\_data module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlist\_data\_attributes module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlist\_data\_attributes\_created\_by module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist_data_attributes_created_by
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlist\_data\_type module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlist_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlists\_session module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlists_session
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlists\_session\_array module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlists_session_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlists\_session\_data module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlists_session_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.playlists\_session\_data\_attributes module
+-------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.playlists_session_data_attributes
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.postmortem\_attachment\_request module
 --------------------------------------------------------------------
 
@@ -25092,6 +25162,20 @@ datadog\_api\_client.v2.model.service\_now\_users\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.session\_id\_array module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.session_id_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.session\_id\_data module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.session_id_data
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.shift module
 ------------------------------------------
 
@@ -25351,6 +25435,83 @@ datadog\_api\_client.v2.model.slo\_status\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.snapshot module
+---------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_array module
+----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_create\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_create_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_create\_request\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_create_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_create\_request\_data\_attributes module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_create_request_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_data module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_data\_attributes module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_update\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_update_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_update\_request\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_update_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_update\_request\_data\_attributes module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_update_request_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.snapshot\_update\_request\_data\_type module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.snapshot_update_request_data_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.software\_catalog\_trigger\_wrapper module
 ------------------------------------------------------------------------
 
@@ -28788,6 +28949,34 @@ datadog\_api\_client.v2.model.version\_history\_update\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.viewership\_history\_session\_array module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.viewership_history_session_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.viewership\_history\_session\_data module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.viewership_history_session_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.viewership\_history\_session\_data\_attributes module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.viewership_history_session_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.viewership\_history\_session\_data\_type module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.viewership_history_session_data_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.virus\_total\_api\_key module
 -----------------------------------------------------------
 
@@ -28949,6 +29138,62 @@ datadog\_api\_client.v2.model.vulnerability\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.watch module
+------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watch
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watch\_data module
+------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watch_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watch\_data\_attributes module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watch_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watch\_data\_type module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watch_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watcher\_array module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watcher_array
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watcher\_data module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watcher_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watcher\_data\_attributes module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watcher_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.watcher\_data\_type module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.watcher_data_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.weekday module
 --------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -0,0 +1,32 @@
+"""
+Create replay heatmap snapshot returns "Created" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_replay_heatmaps_api import RumReplayHeatmapsApi
+from datadog_api_client.v2.model.snapshot_create_request import SnapshotCreateRequest
+from datadog_api_client.v2.model.snapshot_create_request_data import SnapshotCreateRequestData
+from datadog_api_client.v2.model.snapshot_create_request_data_attributes import SnapshotCreateRequestDataAttributes
+from datadog_api_client.v2.model.snapshot_update_request_data_type import SnapshotUpdateRequestDataType
+
+body = SnapshotCreateRequest(
+    data=SnapshotCreateRequestData(
+        attributes=SnapshotCreateRequestDataAttributes(
+            application_id="aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb",
+            device_type="desktop",
+            event_id="11111111-2222-3333-4444-555555555555",
+            is_device_type_selected_by_user=False,
+            snapshot_name="My Snapshot",
+            start=0,
+            view_name="/home",
+        ),
+        type=SnapshotUpdateRequestDataType.SNAPSHOTS,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RumReplayHeatmapsApi(api_client)
+    response = api_instance.create_replay_heatmap_snapshot(body=body)
+
+    print(response)

examples/v2/rum-replay-heatmaps/CreateReplayHeatmapSnapshot.py

@@ -0,0 +1,13 @@
+"""
+Delete replay heatmap snapshot returns "No Content" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_replay_heatmaps_api import RumReplayHeatmapsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RumReplayHeatmapsApi(api_client)
+    api_instance.delete_replay_heatmap_snapshot(
+        snapshot_id="00000000-0000-0000-0000-000000000001",
+    )

examples/v2/rum-replay-heatmaps/DeleteReplayHeatmapSnapshot.py

@@ -0,0 +1,15 @@
+"""
+List replay heatmap snapshots returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.rum_replay_heatmaps_api import RumReplayHeatmapsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = RumReplayHeatmapsApi(api_client)
+    response = api_instance.list_replay_heatmap_snapshots(
+        filter_view_name="/home",
+    )
+
+    print(response)