Skip to content

Commit 412a0eb

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit af0cd40 of spec repo
1 parent 5b3d5df commit 412a0eb

File tree

12 files changed

+588
-0
lines changed

12 files changed

+588
-0
lines changed

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

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17289,6 +17289,76 @@ 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+
blocked: false
17301+
created_at: '2024-04-16T23:38:50.388642Z'
17302+
formats:
17303+
- html
17304+
modified_at: '2024-04-16T23:38:50.388642Z'
17305+
id: 45cd9fe5-dd96-42ad-83de-2242ea9f6efd
17306+
type: emails
17307+
properties:
17308+
data:
17309+
$ref: '#/components/schemas/EmailData'
17310+
type: object
17311+
EmailAttributes:
17312+
description: Attributes for an on-call email.
17313+
properties:
17314+
active:
17315+
description: Whether the email is currently active.
17316+
type: boolean
17317+
address:
17318+
description: Email address.
17319+
type: string
17320+
alias:
17321+
description: Optional display alias for the email.
17322+
type: string
17323+
blocked:
17324+
description: Whether the email is blocked.
17325+
type: boolean
17326+
created_at:
17327+
description: Creation time of the email resource.
17328+
format: date-time
17329+
type: string
17330+
formats:
17331+
description: Preferred content formats for notifications.
17332+
items:
17333+
type: string
17334+
type: array
17335+
modified_at:
17336+
description: Last modification time of the email resource.
17337+
format: date-time
17338+
type: string
17339+
type: object
17340+
EmailData:
17341+
description: Data for an on-call email resource.
17342+
properties:
17343+
attributes:
17344+
$ref: '#/components/schemas/EmailAttributes'
17345+
id:
17346+
description: The email's unique identifier.
17347+
type: string
17348+
type:
17349+
$ref: '#/components/schemas/EmailType'
17350+
required:
17351+
- type
17352+
type: object
17353+
EmailType:
17354+
default: emails
17355+
description: Indicates that the resource is of type 'emails'.
17356+
enum:
17357+
- emails
17358+
example: emails
17359+
type: string
17360+
x-enum-varnames:
17361+
- EMAILS
1729217362
Enabled:
1729317363
description: Field used to enable or disable the rule.
1729417364
example: true
@@ -70837,6 +70907,48 @@ paths:
7083770907
operator: AND
7083870908
permissions:
7083970909
- on_call_write
70910+
/api/v2/on-call/users/{user_id}/notification-channels/emails:
70911+
post:
70912+
description: Create a new email notification channel for an on-call user
70913+
operationId: CreateUserEmailNotificationChannel
70914+
parameters:
70915+
- description: The user ID
70916+
in: path
70917+
name: user_id
70918+
required: true
70919+
schema:
70920+
example: 00000000-0000-0000-0000-000000000000
70921+
type: string
70922+
requestBody:
70923+
content:
70924+
application/json:
70925+
schema:
70926+
$ref: '#/components/schemas/Email'
70927+
required: true
70928+
responses:
70929+
'201':
70930+
description: Created
70931+
'400':
70932+
$ref: '#/components/responses/BadRequestResponse'
70933+
'401':
70934+
$ref: '#/components/responses/UnauthorizedResponse'
70935+
'403':
70936+
$ref: '#/components/responses/ForbiddenResponse'
70937+
'404':
70938+
$ref: '#/components/responses/NotFoundResponse'
70939+
'429':
70940+
$ref: '#/components/responses/TooManyRequestsResponse'
70941+
security:
70942+
- apiKeyAuth: []
70943+
appKeyAuth: []
70944+
- AuthZ: []
70945+
summary: Create email notification channel for user
70946+
tags:
70947+
- On-Call
70948+
x-permission:
70949+
operator: AND
70950+
permissions:
70951+
- on_call_admin
7084070952
/api/v2/org_configs:
7084170953
get:
7084270954
description: Returns all Org Configs (name, description, and value).

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/**
2+
* Create email notification channel for user returns "Created" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.OnCallApi(configuration);
9+
10+
const params: v2.OnCallApiCreateUserEmailNotificationChannelRequest = {
11+
body: {
12+
data: {
13+
attributes: {
14+
active: true,
15+
address: "[email protected]",
16+
alias: "",
17+
blocked: false,
18+
createdAt: new Date(2024, 4, 16, 23, 38, 50, 388642),
19+
formats: ["html"],
20+
modifiedAt: new Date(2024, 4, 16, 23, 38, 50, 388642),
21+
},
22+
id: "45cd9fe5-dd96-42ad-83de-2242ea9f6efd",
23+
type: "emails",
24+
},
25+
},
26+
userId: "00000000-0000-0000-0000-000000000000",
27+
};
28+
29+
apiInstance
30+
.createUserEmailNotificationChannel(params)
31+
.then((data: any) => {
32+
console.log(
33+
"API called successfully. Returned data: " + JSON.stringify(data)
34+
);
35+
})
36+
.catch((error: any) => console.error(error));

‎features/support/scenarios_model_mapping.ts‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7183,6 +7183,17 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
71837183
},
71847184
"operationResponseType": "TeamRoutingRules",
71857185
},
7186+
"v2.CreateUserEmailNotificationChannel": {
7187+
"userId": {
7188+
"type": "string",
7189+
"format": "",
7190+
},
7191+
"body": {
7192+
"type": "Email",
7193+
"format": "",
7194+
},
7195+
"operationResponseType": "{}",
7196+
},
71867197
"v2.CreateOnCallPage": {
71877198
"body": {
71887199
"type": "CreatePageRequest",

‎features/v2/on-call.feature‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,30 @@ Feature: On-Call
4343
When the request is sent
4444
Then the response status is 201 Created
4545

46+
@generated @skip @team:DataDog/on-call
47+
Scenario: Create email notification channel for user returns "Bad Request" response
48+
Given new "CreateUserEmailNotificationChannel" request
49+
And request contains "user_id" parameter from "REPLACE.ME"
50+
And body with value {"data": {"attributes": {"active": true, "address": "[email protected]", "alias": "", "blocked": false, "created_at": "2024-04-16T23:38:50.388642Z", "formats": ["html"], "modified_at": "2024-04-16T23:38:50.388642Z"}, "id": "45cd9fe5-dd96-42ad-83de-2242ea9f6efd", "type": "emails"}}
51+
When the request is sent
52+
Then the response status is 400 Bad Request
53+
54+
@generated @skip @team:DataDog/on-call
55+
Scenario: Create email notification channel for user returns "Created" response
56+
Given new "CreateUserEmailNotificationChannel" request
57+
And request contains "user_id" parameter from "REPLACE.ME"
58+
And body with value {"data": {"attributes": {"active": true, "address": "[email protected]", "alias": "", "blocked": false, "created_at": "2024-04-16T23:38:50.388642Z", "formats": ["html"], "modified_at": "2024-04-16T23:38:50.388642Z"}, "id": "45cd9fe5-dd96-42ad-83de-2242ea9f6efd", "type": "emails"}}
59+
When the request is sent
60+
Then the response status is 201 Created
61+
62+
@generated @skip @team:DataDog/on-call
63+
Scenario: Create email notification channel for user returns "Not Found" response
64+
Given new "CreateUserEmailNotificationChannel" request
65+
And request contains "user_id" parameter from "REPLACE.ME"
66+
And body with value {"data": {"attributes": {"active": true, "address": "[email protected]", "alias": "", "blocked": false, "created_at": "2024-04-16T23:38:50.388642Z", "formats": ["html"], "modified_at": "2024-04-16T23:38:50.388642Z"}, "id": "45cd9fe5-dd96-42ad-83de-2242ea9f6efd", "type": "emails"}}
67+
When the request is sent
68+
Then the response status is 404 Not Found
69+
4670
@team:DataDog/on-call
4771
Scenario: Delete On-Call escalation policy returns "No Content" response
4872
Given new "DeleteOnCallEscalationPolicy" request

‎features/v2/undo.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2697,6 +2697,14 @@
26972697
"type": "idempotent"
26982698
}
26992699
},
2700+
"CreateUserEmailNotificationChannel": {
2701+
"tag": "On-Call",
2702+
"undo": {
2703+
"operationId": "TODO",
2704+
"parameters": [],
2705+
"type": "unsafe"
2706+
}
2707+
},
27002708
"ListOrgConfigs": {
27012709
"tag": "Organizations",
27022710
"undo": {

0 commit comments

Comments
 (0)