Skip to content

Commit 6b062f1

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit a635872 of spec repo
1 parent 9ec3631 commit 6b062f1

19 files changed

Lines changed: 1477 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 444 additions & 0 deletions
Large diffs are not rendered by default.

docs/datadog_api_client.v2.model.rst

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11477,6 +11477,34 @@ datadog\_api\_client.v2.model.dataset\_create\_request module
1147711477
:members:
1147811478
:show-inheritance:
1147911479

11480+
datadog\_api\_client.v2.model.dataset\_report\_schedule\_list\_response module
11481+
------------------------------------------------------------------------------
11482+
11483+
.. automodule:: datadog_api_client.v2.model.dataset_report_schedule_list_response
11484+
:members:
11485+
:show-inheritance:
11486+
11487+
datadog\_api\_client.v2.model.dataset\_report\_schedule\_resource\_type module
11488+
------------------------------------------------------------------------------
11489+
11490+
.. automodule:: datadog_api_client.v2.model.dataset_report_schedule_resource_type
11491+
:members:
11492+
:show-inheritance:
11493+
11494+
datadog\_api\_client.v2.model.dataset\_report\_schedule\_response\_attributes module
11495+
------------------------------------------------------------------------------------
11496+
11497+
.. automodule:: datadog_api_client.v2.model.dataset_report_schedule_response_attributes
11498+
:members:
11499+
:show-inheritance:
11500+
11501+
datadog\_api\_client.v2.model.dataset\_report\_schedule\_response\_data module
11502+
------------------------------------------------------------------------------
11503+
11504+
.. automodule:: datadog_api_client.v2.model.dataset_report_schedule_response_data
11505+
:members:
11506+
:show-inheritance:
11507+
1148011508
datadog\_api\_client.v2.model.dataset\_request module
1148111509
-----------------------------------------------------
1148211510

@@ -31812,6 +31840,55 @@ datadog\_api\_client.v2.model.preview\_entity\_response\_data module
3181231840
:members:
3181331841
:show-inheritance:
3181431842

31843+
datadog\_api\_client.v2.model.print\_report\_request module
31844+
-----------------------------------------------------------
31845+
31846+
.. automodule:: datadog_api_client.v2.model.print_report_request
31847+
:members:
31848+
:show-inheritance:
31849+
31850+
datadog\_api\_client.v2.model.print\_report\_request\_attributes module
31851+
-----------------------------------------------------------------------
31852+
31853+
.. automodule:: datadog_api_client.v2.model.print_report_request_attributes
31854+
:members:
31855+
:show-inheritance:
31856+
31857+
datadog\_api\_client.v2.model.print\_report\_request\_data module
31858+
-----------------------------------------------------------------
31859+
31860+
.. automodule:: datadog_api_client.v2.model.print_report_request_data
31861+
:members:
31862+
:show-inheritance:
31863+
31864+
datadog\_api\_client.v2.model.print\_report\_response module
31865+
------------------------------------------------------------
31866+
31867+
.. automodule:: datadog_api_client.v2.model.print_report_response
31868+
:members:
31869+
:show-inheritance:
31870+
31871+
datadog\_api\_client.v2.model.print\_report\_response\_attributes module
31872+
------------------------------------------------------------------------
31873+
31874+
.. automodule:: datadog_api_client.v2.model.print_report_response_attributes
31875+
:members:
31876+
:show-inheritance:
31877+
31878+
datadog\_api\_client.v2.model.print\_report\_response\_data module
31879+
------------------------------------------------------------------
31880+
31881+
.. automodule:: datadog_api_client.v2.model.print_report_response_data
31882+
:members:
31883+
:show-inheritance:
31884+
31885+
datadog\_api\_client.v2.model.print\_report\_type module
31886+
--------------------------------------------------------
31887+
31888+
.. automodule:: datadog_api_client.v2.model.print_report_type
31889+
:members:
31890+
:show-inheritance:
31891+
3181531892
datadog\_api\_client.v2.model.process\_data\_source module
3181631893
----------------------------------------------------------
3181731894

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
List dataset report schedules returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = ReportSchedulesApi(api_client)
11+
response = api_instance.list_dataset_report_schedules(
12+
dataset_id="dataset_id",
13+
)
14+
15+
print(response)
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
"""
2+
Print a report returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
7+
from datadog_api_client.v2.model.print_report_request import PrintReportRequest
8+
from datadog_api_client.v2.model.print_report_request_attributes import PrintReportRequestAttributes
9+
from datadog_api_client.v2.model.print_report_request_data import PrintReportRequestData
10+
from datadog_api_client.v2.model.print_report_type import PrintReportType
11+
from datadog_api_client.v2.model.report_schedule_resource_type import ReportScheduleResourceType
12+
from datadog_api_client.v2.model.report_schedule_template_variable import ReportScheduleTemplateVariable
13+
14+
body = PrintReportRequest(
15+
data=PrintReportRequestData(
16+
attributes=PrintReportRequestAttributes(
17+
from_ts=1780318800000,
18+
resource_id="abc-def-ghi",
19+
resource_type=ReportScheduleResourceType.DASHBOARD,
20+
template_variables=[
21+
ReportScheduleTemplateVariable(
22+
name="env",
23+
values=[
24+
"prod",
25+
],
26+
),
27+
],
28+
timeframe="1w",
29+
timezone="America/New_York",
30+
to_ts=1780923600000,
31+
),
32+
type=PrintReportType.REPORT,
33+
),
34+
)
35+
36+
configuration = Configuration()
37+
with ApiClient(configuration) as api_client:
38+
api_instance = ReportSchedulesApi(api_client)
39+
response = api_instance.print_report(body=body)
40+
41+
print(response)

src/datadog_api_client/v2/api/report_schedules_api.py

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
unset,
1313
UUID,
1414
)
15+
from datadog_api_client.v2.model.dataset_report_schedule_list_response import DatasetReportScheduleListResponse
16+
from datadog_api_client.v2.model.print_report_response import PrintReportResponse
17+
from datadog_api_client.v2.model.print_report_request import PrintReportRequest
1518
from datadog_api_client.v2.model.report_schedule_response import ReportScheduleResponse
1619
from datadog_api_client.v2.model.report_schedule_create_request import ReportScheduleCreateRequest
1720
from datadog_api_client.v2.model.report_schedule_list_response import ReportScheduleListResponse
@@ -127,6 +130,29 @@ def __init__(self, api_client=None):
127130
api_client=api_client,
128131
)
129132

133+
self._list_dataset_report_schedules_endpoint = _Endpoint(
134+
settings={
135+
"response_type": (DatasetReportScheduleListResponse,),
136+
"auth": ["apiKeyAuth", "appKeyAuth"],
137+
"endpoint_path": "/api/v2/reporting/dataset/{dataset_id}/schedules",
138+
"operation_id": "list_dataset_report_schedules",
139+
"http_method": "GET",
140+
"version": "v2",
141+
},
142+
params_map={
143+
"dataset_id": {
144+
"required": True,
145+
"openapi_types": (str,),
146+
"attribute": "dataset_id",
147+
"location": "path",
148+
},
149+
},
150+
headers_map={
151+
"accept": ["application/json"],
152+
},
153+
api_client=api_client,
154+
)
155+
130156
self._list_report_schedules_endpoint = _Endpoint(
131157
settings={
132158
"response_type": (ReportScheduleListResponse,),
@@ -202,6 +228,26 @@ def __init__(self, api_client=None):
202228
api_client=api_client,
203229
)
204230

231+
self._print_report_endpoint = _Endpoint(
232+
settings={
233+
"response_type": (PrintReportResponse,),
234+
"auth": ["apiKeyAuth", "appKeyAuth"],
235+
"endpoint_path": "/api/v2/reporting/print",
236+
"operation_id": "print_report",
237+
"http_method": "POST",
238+
"version": "v2",
239+
},
240+
params_map={
241+
"body": {
242+
"required": True,
243+
"openapi_types": (PrintReportRequest,),
244+
"location": "body",
245+
},
246+
},
247+
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
248+
api_client=api_client,
249+
)
250+
205251
self._toggle_report_schedule_endpoint = _Endpoint(
206252
settings={
207253
"response_type": (ReportScheduleResponse,),
@@ -306,6 +352,25 @@ def get_report_schedules_for_resource(
306352

307353
return self._get_report_schedules_for_resource_endpoint.call_with_http_info(**kwargs)
308354

355+
def list_dataset_report_schedules(
356+
self,
357+
dataset_id: str,
358+
) -> DatasetReportScheduleListResponse:
359+
"""List dataset report schedules.
360+
361+
Retrieve all report schedules for a given published dataset.
362+
Returns report schedules belonging to the authenticated user's organization that target the specified dataset.
363+
Requires the ``generate_log_reports`` or ``manage_log_reports`` permission.
364+
365+
:param dataset_id: The identifier of the published dataset to retrieve report schedules for.
366+
:type dataset_id: str
367+
:rtype: DatasetReportScheduleListResponse
368+
"""
369+
kwargs: Dict[str, Any] = {}
370+
kwargs["dataset_id"] = dataset_id
371+
372+
return self._list_dataset_report_schedules_endpoint.call_with_http_info(**kwargs)
373+
309374
def list_report_schedules(
310375
self,
311376
*,
@@ -375,6 +440,24 @@ def patch_report_schedule(
375440

376441
return self._patch_report_schedule_endpoint.call_with_http_info(**kwargs)
377442

443+
def print_report(
444+
self,
445+
body: PrintReportRequest,
446+
) -> PrintReportResponse:
447+
"""Print a report.
448+
449+
Initiate a one-off, print-only report for a dashboard or integration dashboard.
450+
The report is rendered as a PDF and made available for download through the URL returned in the response.
451+
Requires a reporting permission appropriate to the targeted resource type.
452+
453+
:type body: PrintReportRequest
454+
:rtype: PrintReportResponse
455+
"""
456+
kwargs: Dict[str, Any] = {}
457+
kwargs["body"] = body
458+
459+
return self._print_report_endpoint.call_with_http_info(**kwargs)
460+
378461
def toggle_report_schedule(
379462
self,
380463
schedule_uuid: UUID,
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import List, Union, TYPE_CHECKING
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
if TYPE_CHECKING:
17+
from datadog_api_client.v2.model.dataset_report_schedule_response_data import DatasetReportScheduleResponseData
18+
from datadog_api_client.v2.model.report_schedule_included_resource import ReportScheduleIncludedResource
19+
from datadog_api_client.v2.model.report_schedule_author import ReportScheduleAuthor
20+
from datadog_api_client.v2.model.report_schedule_resource import ReportScheduleResource
21+
22+
23+
class DatasetReportScheduleListResponse(ModelNormal):
24+
@cached_property
25+
def openapi_types(_):
26+
from datadog_api_client.v2.model.dataset_report_schedule_response_data import DatasetReportScheduleResponseData
27+
from datadog_api_client.v2.model.report_schedule_included_resource import ReportScheduleIncludedResource
28+
29+
return {
30+
"data": ([DatasetReportScheduleResponseData],),
31+
"included": ([ReportScheduleIncludedResource],),
32+
}
33+
34+
attribute_map = {
35+
"data": "data",
36+
"included": "included",
37+
}
38+
39+
def __init__(
40+
self_,
41+
data: List[DatasetReportScheduleResponseData],
42+
included: Union[
43+
List[Union[ReportScheduleIncludedResource, ReportScheduleAuthor, ReportScheduleResource]], UnsetType
44+
] = unset,
45+
**kwargs,
46+
):
47+
"""
48+
Response containing a list of report schedules for a published dataset.
49+
50+
:param data: A list of report schedules for the dataset.
51+
:type data: [DatasetReportScheduleResponseData]
52+
53+
:param included: Related resources included with the report schedules, such as authors.
54+
:type included: [ReportScheduleIncludedResource], optional
55+
"""
56+
if included is not unset:
57+
kwargs["included"] = included
58+
super().__init__(kwargs)
59+
60+
self_.data = data
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelSimple,
9+
cached_property,
10+
)
11+
12+
from typing import ClassVar
13+
14+
15+
class DatasetReportScheduleResourceType(ModelSimple):
16+
"""
17+
The type of resource targeted by a dataset report schedule.
18+
19+
:param value: If omitted defaults to "widget_dataset_list". Must be one of ["widget_dataset_list"].
20+
:type value: str
21+
"""
22+
23+
allowed_values = {
24+
"widget_dataset_list",
25+
}
26+
WIDGET_DATASET_LIST: ClassVar["DatasetReportScheduleResourceType"]
27+
28+
@cached_property
29+
def openapi_types(_):
30+
return {
31+
"value": (str,),
32+
}
33+
34+
35+
DatasetReportScheduleResourceType.WIDGET_DATASET_LIST = DatasetReportScheduleResourceType("widget_dataset_list")

0 commit comments

Comments
 (0)