-
Notifications
You must be signed in to change notification settings - Fork 161
Expand file tree
/
Copy pathnotifications.ts
More file actions
349 lines (318 loc) · 8.83 KB
/
notifications.ts
File metadata and controls
349 lines (318 loc) · 8.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
import type { Client } from 'openapi-fetch'
import type { RequestOptions } from './common.js'
import type {
NotificationChannel,
NotificationRuleCreateRequest,
operations,
paths,
} from './schemas.js'
import { transformResponse } from './utils.js'
/**
* Notifications
* @description Notifications provide automated triggers when specific entitlement balances and usage thresholds are reached, ensuring that your customers and sales teams are always informed. Notify customers and internal teams when specific conditions are met, like reaching 75%, 100%, and 150% of their monthly usage allowance.
*/
export class Notifications {
public channels: NotificationChannels
public rules: NotificationRules
public events: NotificationEvents
constructor(private client: Client<paths, `${string}/${string}`>) {
this.channels = new NotificationChannels(this.client)
this.rules = new NotificationRules(this.client)
this.events = new NotificationEvents(this.client)
}
}
/**
* Notification Channels
* @description Notification channels are the destinations for notifications.
*/
export class NotificationChannels {
constructor(private client: Client<paths, `${string}/${string}`>) {}
/**
* Create a notification channel
* @param notification - The notification to create
* @param signal - An optional abort signal
* @returns The created notification
*/
public async create(
notification: NotificationChannel,
options?: RequestOptions,
) {
const resp = await this.client.POST('/api/v1/notification/channels', {
body: notification,
...options,
})
return transformResponse(resp)
}
/**
* Get a notification channel by ID
* @param id - The ID of the notification channel
* @param signal - An optional abort signal
* @returns The notification channel
*/
public async get(
id: operations['getNotificationChannel']['parameters']['path']['channelId'],
options?: RequestOptions,
) {
const resp = await this.client.GET(
'/api/v1/notification/channels/{channelId}',
{
params: {
path: {
channelId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
/**
* Update a notification channel
* @param id - The ID of the notification channel
* @param notification - The notification to update
* @param signal - An optional abort signal
* @returns The updated notification
*/
public async update(
id: operations['updateNotificationChannel']['parameters']['path']['channelId'],
notification: NotificationChannel,
options?: RequestOptions,
) {
const resp = await this.client.PUT(
'/api/v1/notification/channels/{channelId}',
{
body: notification,
params: {
path: {
channelId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
/**
* List notification channels
* @param query - The query parameters
* @param signal - An optional abort signal
* @returns The list of notification channels
*/
public async list(
query?: operations['listNotificationChannels']['parameters']['query'],
options?: RequestOptions,
) {
const resp = await this.client.GET('/api/v1/notification/channels', {
params: {
query,
},
...options,
})
return transformResponse(resp)
}
/**
* Delete a notification channel
* @param id - The ID of the notification channel
* @param signal - An optional abort signal
* @returns The deleted notification
*/
public async delete(
id: operations['deleteNotificationChannel']['parameters']['path']['channelId'],
options?: RequestOptions,
) {
const resp = await this.client.DELETE(
'/api/v1/notification/channels/{channelId}',
{
params: {
path: {
channelId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
}
/**
* Notification Rules
* @description Notification rules are the conditions that trigger notifications.
*/
export class NotificationRules {
constructor(private client: Client<paths, `${string}/${string}`>) {}
/**
* Create a notification rule
* @param rule - The rule to create
* @param signal - An optional abort signal
* @returns The created rule
*/
public async create(
rule: NotificationRuleCreateRequest,
options?: RequestOptions,
) {
const resp = await this.client.POST('/api/v1/notification/rules', {
body: rule,
...options,
})
return transformResponse(resp)
}
/**
* Get a notification rule by ID
* @param id - The ID of the notification rule
* @param signal - An optional abort signal
* @returns The notification rule
*/
public async get(
id: operations['getNotificationRule']['parameters']['path']['ruleId'],
options?: RequestOptions,
) {
const resp = await this.client.GET('/api/v1/notification/rules/{ruleId}', {
params: {
path: {
ruleId: id,
},
},
...options,
})
return transformResponse(resp)
}
/**
* Update a notification rule
* @param id - The ID of the notification rule
* @param rule - The rule to update
* @param signal - An optional abort signal
* @returns The updated rule
*/
public async update(
id: operations['updateNotificationRule']['parameters']['path']['ruleId'],
rule: NotificationRuleCreateRequest,
options?: RequestOptions,
) {
const resp = await this.client.PUT('/api/v1/notification/rules/{ruleId}', {
body: rule,
params: {
path: {
ruleId: id,
},
},
...options,
})
return transformResponse(resp)
}
/**
* List notification rules
* @param query - The query parameters
* @param signal - An optional abort signal
* @returns The list of notification rules
*/
public async list(
query?: operations['listNotificationRules']['parameters']['query'],
options?: RequestOptions,
) {
const resp = await this.client.GET('/api/v1/notification/rules', {
params: {
query,
},
...options,
})
return transformResponse(resp)
}
/**
* Delete a notification rule
* @param id - The ID of the notification rule
* @param signal - An optional abort signal
* @returns The deleted notification
*/
public async delete(
id: operations['deleteNotificationRule']['parameters']['path']['ruleId'],
options?: RequestOptions,
) {
const resp = await this.client.DELETE(
'/api/v1/notification/rules/{ruleId}',
{
params: {
path: {
ruleId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
}
/**
* Notification Events
* @description Notification events are the events that trigger notifications.
*/
export class NotificationEvents {
constructor(private client: Client<paths, `${string}/${string}`>) {}
/**
* Get a notification event by ID
* @param id - The ID of the notification event
* @param signal - An optional abort signal
* @returns The notification event
*/
public async get(
id: operations['getNotificationEvent']['parameters']['path']['eventId'],
options?: RequestOptions,
) {
const resp = await this.client.GET(
'/api/v1/notification/events/{eventId}',
{
params: {
path: {
eventId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
/**
* List notification events
* @param query - The query parameters
* @param signal - An optional abort signal
* @returns The list of notification events
*/
public async list(
query?: operations['listNotificationEvents']['parameters']['query'],
options?: RequestOptions,
) {
const resp = await this.client.GET('/api/v1/notification/events', {
params: {
query,
},
...options,
})
return transformResponse(resp)
}
/**
* Resend a notification event
* @description Resend a notification event that has already been sent.
* @param id - The ID of the notification event
* @param channels - The channels to resend the notification event to, if not provided it will resend to all channels
* @param signal - An optional abort signal
* @returns The resent notification event
*/
public async resend(
id: operations['resendNotificationEvent']['parameters']['path']['eventId'],
body: operations['resendNotificationEvent']['requestBody']['content']['application/json'] = {},
options?: RequestOptions,
) {
const resp = await this.client.POST(
'/api/v1/notification/events/{eventId}/resend',
{
body,
params: {
path: {
eventId: id,
},
},
...options,
},
)
return transformResponse(resp)
}
}