Skip to content

Commit d472bb4

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

File tree

15 files changed

+1391
-0
lines changed

15 files changed

+1391
-0
lines changed

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

Lines changed: 253 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,189 @@ 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
70952+
/api/v2/on-call/users/{user_id}/notification-channels/emails/{email_id}:
70953+
delete:
70954+
description: Delete an email notification channel for an on-call user
70955+
operationId: DeleteUserEmailNotificationChannel
70956+
parameters:
70957+
- description: The user ID
70958+
in: path
70959+
name: user_id
70960+
required: true
70961+
schema:
70962+
example: 00000000-0000-0000-0000-000000000000
70963+
type: string
70964+
- description: The email ID
70965+
in: path
70966+
name: email_id
70967+
required: true
70968+
schema:
70969+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
70970+
type: string
70971+
responses:
70972+
'204':
70973+
description: No Content
70974+
'400':
70975+
$ref: '#/components/responses/BadRequestResponse'
70976+
'401':
70977+
$ref: '#/components/responses/UnauthorizedResponse'
70978+
'403':
70979+
$ref: '#/components/responses/ForbiddenResponse'
70980+
'404':
70981+
$ref: '#/components/responses/NotFoundResponse'
70982+
'429':
70983+
$ref: '#/components/responses/TooManyRequestsResponse'
70984+
security:
70985+
- apiKeyAuth: []
70986+
appKeyAuth: []
70987+
- AuthZ: []
70988+
summary: Delete email notification channel
70989+
tags:
70990+
- On-Call
70991+
x-permission:
70992+
operator: AND
70993+
permissions:
70994+
- on_call_admin
70995+
get:
70996+
description: Get an email notification channel for an on-call user
70997+
operationId: GetUserEmailNotificationChannel
70998+
parameters:
70999+
- description: The user ID
71000+
in: path
71001+
name: user_id
71002+
required: true
71003+
schema:
71004+
example: 00000000-0000-0000-0000-000000000000
71005+
type: string
71006+
- description: The email ID
71007+
in: path
71008+
name: email_id
71009+
required: true
71010+
schema:
71011+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
71012+
type: string
71013+
responses:
71014+
'200':
71015+
content:
71016+
application/json:
71017+
schema:
71018+
$ref: '#/components/schemas/Email'
71019+
description: OK
71020+
'400':
71021+
$ref: '#/components/responses/BadRequestResponse'
71022+
'401':
71023+
$ref: '#/components/responses/UnauthorizedResponse'
71024+
'403':
71025+
$ref: '#/components/responses/ForbiddenResponse'
71026+
'404':
71027+
$ref: '#/components/responses/NotFoundResponse'
71028+
'429':
71029+
$ref: '#/components/responses/TooManyRequestsResponse'
71030+
security:
71031+
- apiKeyAuth: []
71032+
appKeyAuth: []
71033+
- AuthZ: []
71034+
summary: Get email notification channel
71035+
tags:
71036+
- On-Call
71037+
x-permission:
71038+
operator: AND
71039+
permissions:
71040+
- on_call_admin
71041+
put:
71042+
description: Update an email notification channel for an on-call user
71043+
operationId: UpdateUserEmailNotificationChannel
71044+
parameters:
71045+
- description: The user ID
71046+
in: path
71047+
name: user_id
71048+
required: true
71049+
schema:
71050+
example: 00000000-0000-0000-0000-000000000000
71051+
type: string
71052+
- description: The email ID
71053+
in: path
71054+
name: email_id
71055+
required: true
71056+
schema:
71057+
example: 45bb8fe5-dd96-42ad-83de-2241ea9f6ffc
71058+
type: string
71059+
requestBody:
71060+
content:
71061+
application/json:
71062+
schema:
71063+
$ref: '#/components/schemas/Email'
71064+
required: true
71065+
responses:
71066+
'200':
71067+
content:
71068+
application/json:
71069+
schema:
71070+
$ref: '#/components/schemas/Email'
71071+
description: OK
71072+
'400':
71073+
$ref: '#/components/responses/BadRequestResponse'
71074+
'401':
71075+
$ref: '#/components/responses/UnauthorizedResponse'
71076+
'403':
71077+
$ref: '#/components/responses/ForbiddenResponse'
71078+
'404':
71079+
$ref: '#/components/responses/NotFoundResponse'
71080+
'429':
71081+
$ref: '#/components/responses/TooManyRequestsResponse'
71082+
security:
71083+
- apiKeyAuth: []
71084+
appKeyAuth: []
71085+
- AuthZ: []
71086+
summary: Update email notification channel
71087+
tags:
71088+
- On-Call
71089+
x-permission:
71090+
operator: AND
71091+
permissions:
71092+
- on_call_admin
7084071093
/api/v2/org_configs:
7084171094
get:
7084271095
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));

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/**
2+
* Delete email notification channel returns "No Content" 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.OnCallApiDeleteUserEmailNotificationChannelRequest = {
11+
userId: "00000000-0000-0000-0000-000000000000",
12+
emailId: "45bb8fe5-dd96-42ad-83de-2241ea9f6ffc",
13+
};
14+
15+
apiInstance
16+
.deleteUserEmailNotificationChannel(params)
17+
.then((data: any) => {
18+
console.log(
19+
"API called successfully. Returned data: " + JSON.stringify(data)
20+
);
21+
})
22+
.catch((error: any) => console.error(error));

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/**
2+
* Get email notification channel returns "OK" 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.OnCallApiGetUserEmailNotificationChannelRequest = {
11+
userId: "00000000-0000-0000-0000-000000000000",
12+
emailId: "45bb8fe5-dd96-42ad-83de-2241ea9f6ffc",
13+
};
14+
15+
apiInstance
16+
.getUserEmailNotificationChannel(params)
17+
.then((data: v2.Email) => {
18+
console.log(
19+
"API called successfully. Returned data: " + JSON.stringify(data)
20+
);
21+
})
22+
.catch((error: any) => console.error(error));

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/**
2+
* Update email notification channel returns "OK" 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.OnCallApiUpdateUserEmailNotificationChannelRequest = {
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+
emailId: "45bb8fe5-dd96-42ad-83de-2241ea9f6ffc",
28+
};
29+
30+
apiInstance
31+
.updateUserEmailNotificationChannel(params)
32+
.then((data: v2.Email) => {
33+
console.log(
34+
"API called successfully. Returned data: " + JSON.stringify(data)
35+
);
36+
})
37+
.catch((error: any) => console.error(error));

0 commit comments

Comments
 (0)