Skip to content

Commit fb101f4

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit b9c6ded of spec repo
1 parent 9346373 commit fb101f4

16 files changed

+1048
-0
lines changed

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

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17289,6 +17289,92 @@ components:
1728917289
- score
1729017290
- severity
1729117291
type: object
17292+
Email:
17293+
description: On-Call User Email.
17294+
example:
17295+
data:
17296+
attributes:
17297+
active: true
17298+
address: [email protected]
17299+
alias: ''
17300+
formats:
17301+
- html
17302+
id: 45cd9fe5-dd96-42ad-83de-2242ea9f6efd
17303+
type: emails
17304+
properties:
17305+
data:
17306+
$ref: '#/components/schemas/EmailData'
17307+
type: object
17308+
EmailAttributes:
17309+
description: Attributes for an on-call email.
17310+
properties:
17311+
active:
17312+
description: Whether the email is currently active.
17313+
type: boolean
17314+
address:
17315+
description: Email address.
17316+
type: string
17317+
alias:
17318+
description: Optional display alias for the email.
17319+
type: string
17320+
formats:
17321+
description: Preferred content formats for notifications.
17322+
items:
17323+
type: string
17324+
type: array
17325+
type: object
17326+
EmailCreateRequest:
17327+
description: Request body for creating an On-Call email notification channel.
17328+
example:
17329+
data:
17330+
attributes:
17331+
active: true
17332+
address: [email protected]
17333+
alias: ''
17334+
formats:
17335+
- html
17336+
type: emails
17337+
properties:
17338+
data:
17339+
$ref: '#/components/schemas/EmailData'
17340+
type: object
17341+
EmailData:
17342+
description: Data for an on-call email resource.
17343+
properties:
17344+
attributes:
17345+
$ref: '#/components/schemas/EmailAttributes'
17346+
id:
17347+
description: The email's unique identifier.
17348+
type: string
17349+
type:
17350+
$ref: '#/components/schemas/EmailType'
17351+
required:
17352+
- type
17353+
type: object
17354+
EmailType:
17355+
default: emails
17356+
description: Indicates that the resource is of type 'emails'.
17357+
enum:
17358+
- emails
17359+
example: emails
17360+
type: string
17361+
x-enum-varnames:
17362+
- EMAILS
17363+
EmailUpdateRequest:
17364+
description: Request body for updating an On-Call email notification channel.
17365+
example:
17366+
data:
17367+
attributes:
17368+
active: true
17369+
address: [email protected]
17370+
alias: ''
17371+
formats:
17372+
- html
17373+
type: emails
17374+
properties:
17375+
data:
17376+
$ref: '#/components/schemas/EmailData'
17377+
type: object
1729217378
Enabled:
1729317379
description: Field used to enable or disable the rule.
1729417380
example: true
@@ -71866,6 +71952,189 @@ paths:
7186671952
operator: AND
7186771953
permissions:
7186871954
- on_call_write
71955+
/api/v2/on-call/users/{user_id}/notification-channels/emails:
71956+
post:
71957+
description: Create a new email notification channel for an on-call user
71958+
operationId: CreateUserEmailNotificationChannel
71959+
parameters:
71960+
- description: The user ID
71961+
in: path
71962+
name: user_id
71963+
required: true
71964+
schema:
71965+
example: 00000000-0000-0000-0000-000000000000
71966+
type: string
71967+
requestBody:
71968+
content:
71969+
application/json:
71970+
schema:
71971+
$ref: '#/components/schemas/EmailCreateRequest'
71972+
required: true
71973+
responses:
71974+
'201':
71975+
description: Created
71976+
'400':
71977+
$ref: '#/components/responses/BadRequestResponse'
71978+
'401':
71979+
$ref: '#/components/responses/UnauthorizedResponse'
71980+
'403':
71981+
$ref: '#/components/responses/ForbiddenResponse'
71982+
'404':
71983+
$ref: '#/components/responses/NotFoundResponse'
71984+
'429':
71985+
$ref: '#/components/responses/TooManyRequestsResponse'
71986+
security:
71987+
- apiKeyAuth: []
71988+
appKeyAuth: []
71989+
- AuthZ: []
71990+
summary: Create an On-Call email for a user
71991+
tags:
71992+
- On-Call
71993+
x-permission:
71994+
operator: AND
71995+
permissions:
71996+
- on_call_admin
71997+
/api/v2/on-call/users/{user_id}/notification-channels/emails/{email_id}:
71998+
delete:
71999+
description: Delete an email notification channel for an on-call user
72000+
operationId: DeleteUserEmailNotificationChannel
72001+
parameters:
72002+
- description: The user ID
72003+
in: path
72004+
name: user_id
72005+
required: true
72006+
schema:
72007+
example: 00000000-0000-0000-0000-000000000000
72008+
type: string
72009+
- description: The email ID
72010+
in: path
72011+
name: email_id
72012+
required: true
72013+
schema:
72014+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72015+
type: string
72016+
responses:
72017+
'204':
72018+
description: No Content
72019+
'400':
72020+
$ref: '#/components/responses/BadRequestResponse'
72021+
'401':
72022+
$ref: '#/components/responses/UnauthorizedResponse'
72023+
'403':
72024+
$ref: '#/components/responses/ForbiddenResponse'
72025+
'404':
72026+
$ref: '#/components/responses/NotFoundResponse'
72027+
'429':
72028+
$ref: '#/components/responses/TooManyRequestsResponse'
72029+
security:
72030+
- apiKeyAuth: []
72031+
appKeyAuth: []
72032+
- AuthZ: []
72033+
summary: Delete an On-Call email for a user
72034+
tags:
72035+
- On-Call
72036+
x-permission:
72037+
operator: AND
72038+
permissions:
72039+
- on_call_admin
72040+
get:
72041+
description: Get an email notification channel for an on-call user
72042+
operationId: GetUserEmailNotificationChannel
72043+
parameters:
72044+
- description: The user ID
72045+
in: path
72046+
name: user_id
72047+
required: true
72048+
schema:
72049+
example: 00000000-0000-0000-0000-000000000000
72050+
type: string
72051+
- description: The email ID
72052+
in: path
72053+
name: email_id
72054+
required: true
72055+
schema:
72056+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72057+
type: string
72058+
responses:
72059+
'200':
72060+
content:
72061+
application/json:
72062+
schema:
72063+
$ref: '#/components/schemas/Email'
72064+
description: OK
72065+
'400':
72066+
$ref: '#/components/responses/BadRequestResponse'
72067+
'401':
72068+
$ref: '#/components/responses/UnauthorizedResponse'
72069+
'403':
72070+
$ref: '#/components/responses/ForbiddenResponse'
72071+
'404':
72072+
$ref: '#/components/responses/NotFoundResponse'
72073+
'429':
72074+
$ref: '#/components/responses/TooManyRequestsResponse'
72075+
security:
72076+
- apiKeyAuth: []
72077+
appKeyAuth: []
72078+
- AuthZ: []
72079+
summary: Get an On-Call email for a user
72080+
tags:
72081+
- On-Call
72082+
x-permission:
72083+
operator: AND
72084+
permissions:
72085+
- on_call_admin
72086+
put:
72087+
description: Update an email notification channel for an on-call user
72088+
operationId: UpdateUserEmailNotificationChannel
72089+
parameters:
72090+
- description: The user ID
72091+
in: path
72092+
name: user_id
72093+
required: true
72094+
schema:
72095+
example: 00000000-0000-0000-0000-000000000000
72096+
type: string
72097+
- description: The email ID
72098+
in: path
72099+
name: email_id
72100+
required: true
72101+
schema:
72102+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
72103+
type: string
72104+
requestBody:
72105+
content:
72106+
application/json:
72107+
schema:
72108+
$ref: '#/components/schemas/EmailUpdateRequest'
72109+
required: true
72110+
responses:
72111+
'200':
72112+
content:
72113+
application/json:
72114+
schema:
72115+
$ref: '#/components/schemas/Email'
72116+
description: OK
72117+
'400':
72118+
$ref: '#/components/responses/BadRequestResponse'
72119+
'401':
72120+
$ref: '#/components/responses/UnauthorizedResponse'
72121+
'403':
72122+
$ref: '#/components/responses/ForbiddenResponse'
72123+
'404':
72124+
$ref: '#/components/responses/NotFoundResponse'
72125+
'429':
72126+
$ref: '#/components/responses/TooManyRequestsResponse'
72127+
security:
72128+
- apiKeyAuth: []
72129+
appKeyAuth: []
72130+
- AuthZ: []
72131+
summary: Update an On-Call email for a user
72132+
tags:
72133+
- On-Call
72134+
x-permission:
72135+
operator: AND
72136+
permissions:
72137+
- on_call_admin
7186972138
/api/v2/org_configs:
7187072139
get:
7187172140
description: Returns all Org Configs (name, description, and value).

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7039,6 +7039,48 @@ datadog\_api\_client.v2.model.downtime\_update\_request\_data module
70397039
:members:
70407040
:show-inheritance:
70417041

7042+
datadog\_api\_client.v2.model.email module
7043+
------------------------------------------
7044+
7045+
.. automodule:: datadog_api_client.v2.model.email
7046+
:members:
7047+
:show-inheritance:
7048+
7049+
datadog\_api\_client.v2.model.email\_attributes module
7050+
------------------------------------------------------
7051+
7052+
.. automodule:: datadog_api_client.v2.model.email_attributes
7053+
:members:
7054+
:show-inheritance:
7055+
7056+
datadog\_api\_client.v2.model.email\_create\_request module
7057+
-----------------------------------------------------------
7058+
7059+
.. automodule:: datadog_api_client.v2.model.email_create_request
7060+
:members:
7061+
:show-inheritance:
7062+
7063+
datadog\_api\_client.v2.model.email\_data module
7064+
------------------------------------------------
7065+
7066+
.. automodule:: datadog_api_client.v2.model.email_data
7067+
:members:
7068+
:show-inheritance:
7069+
7070+
datadog\_api\_client.v2.model.email\_type module
7071+
------------------------------------------------
7072+
7073+
.. automodule:: datadog_api_client.v2.model.email_type
7074+
:members:
7075+
:show-inheritance:
7076+
7077+
datadog\_api\_client.v2.model.email\_update\_request module
7078+
-----------------------------------------------------------
7079+
7080+
.. automodule:: datadog_api_client.v2.model.email_update_request
7081+
:members:
7082+
:show-inheritance:
7083+
70427084
datadog\_api\_client.v2.model.entity\_attributes module
70437085
-------------------------------------------------------
70447086

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
"""
2+
Create an On-Call email for a user returns "Created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.on_call_api import OnCallApi
7+
from datadog_api_client.v2.model.email_attributes import EmailAttributes
8+
from datadog_api_client.v2.model.email_create_request import EmailCreateRequest
9+
from datadog_api_client.v2.model.email_data import EmailData
10+
from datadog_api_client.v2.model.email_type import EmailType
11+
12+
body = EmailCreateRequest(
13+
data=EmailData(
14+
attributes=EmailAttributes(
15+
active=True,
16+
address="[email protected]",
17+
alias="",
18+
formats=[
19+
"html",
20+
],
21+
),
22+
type=EmailType.EMAILS,
23+
),
24+
)
25+
26+
configuration = Configuration()
27+
with ApiClient(configuration) as api_client:
28+
api_instance = OnCallApi(api_client)
29+
api_instance.create_user_email_notification_channel(user_id="00000000-0000-0000-0000-000000000000", body=body)

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Delete an On-Call email for a user returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.on_call_api import OnCallApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = OnCallApi(api_client)
11+
api_instance.delete_user_email_notification_channel(
12+
user_id="00000000-0000-0000-0000-000000000000",
13+
email_id="45bb8fe5-dd96-42ad-83de-2241ea9f6ffc",
14+
)

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Get an On-Call email for a user returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.on_call_api import OnCallApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = OnCallApi(api_client)
11+
response = api_instance.get_user_email_notification_channel(
12+
user_id="00000000-0000-0000-0000-000000000000",
13+
email_id="45bb8fe5-dd96-42ad-83de-2241ea9f6ffc",
14+
)
15+
16+
print(response)

0 commit comments

Comments
 (0)