Skip to content

Commit 9fa4783

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add routes for managing On-Call user notification channels (#3004)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 541ea5f commit 9fa4783

File tree

38 files changed

+2294
-0
lines changed

38 files changed

+2294
-0
lines changed

‎.generator/schemas/v2/openapi.yaml‎

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

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5268,6 +5268,13 @@ datadog\_api\_client.v2.model.create\_deployment\_rule\_params\_data\_attributes
52685268
:members:
52695269
:show-inheritance:
52705270

5271+
datadog\_api\_client.v2.model.create\_email\_notification\_channel\_config module
5272+
---------------------------------------------------------------------------------
5273+
5274+
.. automodule:: datadog_api_client.v2.model.create_email_notification_channel_config
5275+
:members:
5276+
:show-inheritance:
5277+
52715278
datadog\_api\_client.v2.model.create\_incident\_notification\_rule\_request module
52725279
----------------------------------------------------------------------------------
52735280

@@ -5310,6 +5317,27 @@ datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships
53105317
:members:
53115318
:show-inheritance:
53125319

5320+
datadog\_api\_client.v2.model.create\_notification\_channel\_attributes module
5321+
------------------------------------------------------------------------------
5322+
5323+
.. automodule:: datadog_api_client.v2.model.create_notification_channel_attributes
5324+
:members:
5325+
:show-inheritance:
5326+
5327+
datadog\_api\_client.v2.model.create\_notification\_channel\_config module
5328+
--------------------------------------------------------------------------
5329+
5330+
.. automodule:: datadog_api_client.v2.model.create_notification_channel_config
5331+
:members:
5332+
:show-inheritance:
5333+
5334+
datadog\_api\_client.v2.model.create\_notification\_channel\_data module
5335+
------------------------------------------------------------------------
5336+
5337+
.. automodule:: datadog_api_client.v2.model.create_notification_channel_data
5338+
:members:
5339+
:show-inheritance:
5340+
53135341
datadog\_api\_client.v2.model.create\_notification\_rule\_parameters module
53145342
---------------------------------------------------------------------------
53155343

@@ -5408,6 +5436,13 @@ datadog\_api\_client.v2.model.create\_page\_response\_data\_type module
54085436
:members:
54095437
:show-inheritance:
54105438

5439+
datadog\_api\_client.v2.model.create\_phone\_notification\_channel\_config module
5440+
---------------------------------------------------------------------------------
5441+
5442+
.. automodule:: datadog_api_client.v2.model.create_phone_notification_channel_config
5443+
:members:
5444+
:show-inheritance:
5445+
54115446
datadog\_api\_client.v2.model.create\_rule\_request module
54125447
----------------------------------------------------------
54135448

@@ -5653,6 +5688,13 @@ datadog\_api\_client.v2.model.create\_upload\_response\_data\_type module
56535688
:members:
56545689
:show-inheritance:
56555690

5691+
datadog\_api\_client.v2.model.create\_user\_notification\_channel\_request module
5692+
---------------------------------------------------------------------------------
5693+
5694+
.. automodule:: datadog_api_client.v2.model.create_user_notification_channel_request
5695+
:members:
5696+
:show-inheritance:
5697+
56565698
datadog\_api\_client.v2.model.create\_workflow\_request module
56575699
--------------------------------------------------------------
56585700

@@ -13045,6 +13087,13 @@ datadog\_api\_client.v2.model.list\_kind\_catalog\_response module
1304513087
:members:
1304613088
:show-inheritance:
1304713089

13090+
datadog\_api\_client.v2.model.list\_notification\_channels\_response module
13091+
---------------------------------------------------------------------------
13092+
13093+
.. automodule:: datadog_api_client.v2.model.list_notification_channels_response
13094+
:members:
13095+
:show-inheritance:
13096+
1304813097
datadog\_api\_client.v2.model.list\_pipelines\_response module
1304913098
--------------------------------------------------------------
1305013099

@@ -15075,6 +15124,90 @@ datadog\_api\_client.v2.model.notebook\_trigger\_wrapper module
1507515124
:members:
1507615125
:show-inheritance:
1507715126

15127+
datadog\_api\_client.v2.model.notification\_channel module
15128+
----------------------------------------------------------
15129+
15130+
.. automodule:: datadog_api_client.v2.model.notification_channel
15131+
:members:
15132+
:show-inheritance:
15133+
15134+
datadog\_api\_client.v2.model.notification\_channel\_attributes module
15135+
----------------------------------------------------------------------
15136+
15137+
.. automodule:: datadog_api_client.v2.model.notification_channel_attributes
15138+
:members:
15139+
:show-inheritance:
15140+
15141+
datadog\_api\_client.v2.model.notification\_channel\_config module
15142+
------------------------------------------------------------------
15143+
15144+
.. automodule:: datadog_api_client.v2.model.notification_channel_config
15145+
:members:
15146+
:show-inheritance:
15147+
15148+
datadog\_api\_client.v2.model.notification\_channel\_data module
15149+
----------------------------------------------------------------
15150+
15151+
.. automodule:: datadog_api_client.v2.model.notification_channel_data
15152+
:members:
15153+
:show-inheritance:
15154+
15155+
datadog\_api\_client.v2.model.notification\_channel\_email\_config module
15156+
-------------------------------------------------------------------------
15157+
15158+
.. automodule:: datadog_api_client.v2.model.notification_channel_email_config
15159+
:members:
15160+
:show-inheritance:
15161+
15162+
datadog\_api\_client.v2.model.notification\_channel\_email\_config\_type module
15163+
-------------------------------------------------------------------------------
15164+
15165+
.. automodule:: datadog_api_client.v2.model.notification_channel_email_config_type
15166+
:members:
15167+
:show-inheritance:
15168+
15169+
datadog\_api\_client.v2.model.notification\_channel\_email\_format\_type module
15170+
-------------------------------------------------------------------------------
15171+
15172+
.. automodule:: datadog_api_client.v2.model.notification_channel_email_format_type
15173+
:members:
15174+
:show-inheritance:
15175+
15176+
datadog\_api\_client.v2.model.notification\_channel\_phone\_config module
15177+
-------------------------------------------------------------------------
15178+
15179+
.. automodule:: datadog_api_client.v2.model.notification_channel_phone_config
15180+
:members:
15181+
:show-inheritance:
15182+
15183+
datadog\_api\_client.v2.model.notification\_channel\_phone\_config\_type module
15184+
-------------------------------------------------------------------------------
15185+
15186+
.. automodule:: datadog_api_client.v2.model.notification_channel_phone_config_type
15187+
:members:
15188+
:show-inheritance:
15189+
15190+
datadog\_api\_client.v2.model.notification\_channel\_push\_config module
15191+
------------------------------------------------------------------------
15192+
15193+
.. automodule:: datadog_api_client.v2.model.notification_channel_push_config
15194+
:members:
15195+
:show-inheritance:
15196+
15197+
datadog\_api\_client.v2.model.notification\_channel\_push\_config\_type module
15198+
------------------------------------------------------------------------------
15199+
15200+
.. automodule:: datadog_api_client.v2.model.notification_channel_push_config_type
15201+
:members:
15202+
:show-inheritance:
15203+
15204+
datadog\_api\_client.v2.model.notification\_channel\_type module
15205+
----------------------------------------------------------------
15206+
15207+
.. automodule:: datadog_api_client.v2.model.notification_channel_type
15208+
:members:
15209+
:show-inheritance:
15210+
1507815211
datadog\_api\_client.v2.model.notification\_rule module
1507915212
-------------------------------------------------------
1508015213

‎examples/v2/on-call/CreateUserNotificationChannel.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
"""
2+
Create an On-Call notification channel for a user returns "Created" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.on_call_api import OnCallApi
8+
from datadog_api_client.v2.model.create_email_notification_channel_config import CreateEmailNotificationChannelConfig
9+
from datadog_api_client.v2.model.create_notification_channel_attributes import CreateNotificationChannelAttributes
10+
from datadog_api_client.v2.model.create_notification_channel_data import CreateNotificationChannelData
11+
from datadog_api_client.v2.model.create_user_notification_channel_request import CreateUserNotificationChannelRequest
12+
from datadog_api_client.v2.model.notification_channel_email_config_type import NotificationChannelEmailConfigType
13+
from datadog_api_client.v2.model.notification_channel_email_format_type import NotificationChannelEmailFormatType
14+
from datadog_api_client.v2.model.notification_channel_type import NotificationChannelType
15+
16+
# there is a valid "user" in the system
17+
USER_DATA_ID = environ["USER_DATA_ID"]
18+
19+
body = CreateUserNotificationChannelRequest(
20+
data=CreateNotificationChannelData(
21+
attributes=CreateNotificationChannelAttributes(
22+
config=CreateEmailNotificationChannelConfig(
23+
address="foo@bar.com",
24+
formats=[
25+
NotificationChannelEmailFormatType.HTML,
26+
],
27+
type=NotificationChannelEmailConfigType.EMAIL,
28+
),
29+
),
30+
type=NotificationChannelType.NOTIFICATION_CHANNELS,
31+
),
32+
)
33+
34+
configuration = Configuration()
35+
with ApiClient(configuration) as api_client:
36+
api_instance = OnCallApi(api_client)
37+
response = api_instance.create_user_notification_channel(user_id=USER_DATA_ID, body=body)
38+
39+
print(response)

‎examples/v2/on-call/DeleteUserNotificationChannel.py‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
"""
2+
Delete an On-Call notification channel for a user returns "No Content" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.on_call_api import OnCallApi
8+
9+
# there is a valid "user" in the system
10+
USER_DATA_ID = environ["USER_DATA_ID"]
11+
12+
# there is a valid "oncall_email_notification_channel" in the system
13+
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]
14+
15+
configuration = Configuration()
16+
with ApiClient(configuration) as api_client:
17+
api_instance = OnCallApi(api_client)
18+
api_instance.delete_user_notification_channel(
19+
user_id=USER_DATA_ID,
20+
channel_id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
21+
)

‎examples/v2/on-call/GetUserNotificationChannel.py‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
"""
2+
Get an On-Call notification channel for a user returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.on_call_api import OnCallApi
8+
9+
# there is a valid "user" in the system
10+
USER_DATA_ID = environ["USER_DATA_ID"]
11+
12+
# there is a valid "oncall_email_notification_channel" in the system
13+
ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID = environ["ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID"]
14+
15+
configuration = Configuration()
16+
with ApiClient(configuration) as api_client:
17+
api_instance = OnCallApi(api_client)
18+
response = api_instance.get_user_notification_channel(
19+
user_id=USER_DATA_ID,
20+
channel_id=ONCALL_EMAIL_NOTIFICATION_CHANNEL_DATA_ID,
21+
)
22+
23+
print(response)

‎examples/v2/on-call/ListUserNotificationChannels.py‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
"""
2+
List On-Call notification channels for a user returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.on_call_api import OnCallApi
8+
9+
# there is a valid "user" in the system
10+
USER_DATA_ID = environ["USER_DATA_ID"]
11+
12+
configuration = Configuration()
13+
with ApiClient(configuration) as api_client:
14+
api_instance = OnCallApi(api_client)
15+
response = api_instance.list_user_notification_channels(
16+
user_id=USER_DATA_ID,
17+
)
18+
19+
print(response)

0 commit comments

Comments
 (0)