@novu/api 0.0.4 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/README.md +0 -9
  2. package/jsr.json +1 -1
  3. package/lib/config.d.ts +2 -2
  4. package/lib/config.js +2 -2
  5. package/models/components/index.d.ts +0 -3
  6. package/models/components/index.d.ts.map +1 -1
  7. package/models/components/index.js +0 -3
  8. package/models/components/index.js.map +1 -1
  9. package/models/errors/index.d.ts +0 -1
  10. package/models/errors/index.d.ts.map +1 -1
  11. package/models/errors/index.js +0 -1
  12. package/models/errors/index.js.map +1 -1
  13. package/models/operations/index.d.ts +0 -3
  14. package/models/operations/index.d.ts.map +1 -1
  15. package/models/operations/index.js +0 -3
  16. package/models/operations/index.js.map +1 -1
  17. package/package.json +1 -1
  18. package/sdk/sdk.d.ts +0 -3
  19. package/sdk/sdk.d.ts.map +1 -1
  20. package/sdk/sdk.js +0 -4
  21. package/sdk/sdk.js.map +1 -1
  22. package/sources/json-development.json +0 -1170
  23. package/src/lib/config.ts +2 -2
  24. package/src/models/components/index.ts +0 -3
  25. package/src/models/errors/index.ts +0 -1
  26. package/src/models/operations/index.ts +0 -3
  27. package/src/sdk/sdk.ts +0 -6
  28. package/docs/sdks/admin/README.md +0 -234
  29. package/funcs/adminGenerateRandomNumber.d.ts +0 -10
  30. package/funcs/adminGenerateRandomNumber.d.ts.map +0 -1
  31. package/funcs/adminGenerateRandomNumber.js +0 -126
  32. package/funcs/adminGenerateRandomNumber.js.map +0 -1
  33. package/funcs/adminHealthControllerHealthCheck.d.ts +0 -10
  34. package/funcs/adminHealthControllerHealthCheck.d.ts.map +0 -1
  35. package/funcs/adminHealthControllerHealthCheck.js +0 -109
  36. package/funcs/adminHealthControllerHealthCheck.js.map +0 -1
  37. package/funcs/adminTestIdempotency.d.ts +0 -11
  38. package/funcs/adminTestIdempotency.d.ts.map +0 -1
  39. package/funcs/adminTestIdempotency.js +0 -129
  40. package/funcs/adminTestIdempotency.js.map +0 -1
  41. package/models/components/idempotencetestingresponse.d.ts +0 -32
  42. package/models/components/idempotencetestingresponse.d.ts.map +0 -1
  43. package/models/components/idempotencetestingresponse.js +0 -59
  44. package/models/components/idempotencetestingresponse.js.map +0 -1
  45. package/models/components/idempotencybehaviorenum.d.ts +0 -37
  46. package/models/components/idempotencybehaviorenum.d.ts.map +0 -1
  47. package/models/components/idempotencybehaviorenum.js +0 -54
  48. package/models/components/idempotencybehaviorenum.js.map +0 -1
  49. package/models/components/idempotencytestingdto.d.ts +0 -33
  50. package/models/components/idempotencytestingdto.d.ts.map +0 -1
  51. package/models/components/idempotencytestingdto.js +0 -60
  52. package/models/components/idempotencytestingdto.js.map +0 -1
  53. package/models/errors/healthcontrollerhealthcheck.d.ts +0 -153
  54. package/models/errors/healthcontrollerhealthcheck.d.ts.map +0 -1
  55. package/models/errors/healthcontrollerhealthcheck.js +0 -190
  56. package/models/errors/healthcontrollerhealthcheck.js.map +0 -1
  57. package/models/operations/healthcontrollergeneraterandomnumber.d.ts +0 -64
  58. package/models/operations/healthcontrollergeneraterandomnumber.d.ts.map +0 -1
  59. package/models/operations/healthcontrollergeneraterandomnumber.js +0 -108
  60. package/models/operations/healthcontrollergeneraterandomnumber.js.map +0 -1
  61. package/models/operations/healthcontrollerhealthcheck.d.ts +0 -165
  62. package/models/operations/healthcontrollerhealthcheck.d.ts.map +0 -1
  63. package/models/operations/healthcontrollerhealthcheck.js +0 -206
  64. package/models/operations/healthcontrollerhealthcheck.js.map +0 -1
  65. package/models/operations/healthcontrollertestidempotency.d.ts +0 -66
  66. package/models/operations/healthcontrollertestidempotency.d.ts.map +0 -1
  67. package/models/operations/healthcontrollertestidempotency.js +0 -112
  68. package/models/operations/healthcontrollertestidempotency.js.map +0 -1
  69. package/sdk/admin.d.ts +0 -9
  70. package/sdk/admin.d.ts.map +0 -1
  71. package/sdk/admin.js +0 -24
  72. package/sdk/admin.js.map +0 -1
  73. package/src/funcs/adminGenerateRandomNumber.ts +0 -183
  74. package/src/funcs/adminHealthControllerHealthCheck.ts +0 -153
  75. package/src/funcs/adminTestIdempotency.ts +0 -190
  76. package/src/models/components/idempotencetestingresponse.ts +0 -69
  77. package/src/models/components/idempotencybehaviorenum.ts +0 -42
  78. package/src/models/components/idempotencytestingdto.ts +0 -74
  79. package/src/models/errors/healthcontrollerhealthcheck.ts +0 -291
  80. package/src/models/operations/healthcontrollergeneraterandomnumber.ts +0 -177
  81. package/src/models/operations/healthcontrollerhealthcheck.ts +0 -358
  82. package/src/models/operations/healthcontrollertestidempotency.ts +0 -174
  83. package/src/sdk/admin.ts +0 -48
package/sources/json-development.json CHANGED
@@ -1,1143 +1,6 @@
1
1
  {
2
2
  "openapi": "3.0.0",
3
3
  "paths": {
4
- "/v1/health-check": {
5
- "get": {
6
- "operationId": "HealthController_healthCheck",
7
- "x-ignore": true,
8
- "parameters": [
9
- {
10
- "name": "idempotency-key",
11
- "in": "header",
12
- "description": "A header for idempotency purposes",
13
- "required": false,
14
- "schema": {
15
- "type": "string"
16
- }
17
- }
18
- ],
19
- "responses": {
20
- "200": {
21
- "description": "The Health Check is successful",
22
- "content": {
23
- "application/json": {
24
- "schema": {
25
- "type": "object",
26
- "properties": {
27
- "status": {
28
- "type": "string",
29
- "example": "ok"
30
- },
31
- "info": {
32
- "type": "object",
33
- "example": {
34
- "database": {
35
- "status": "up"
36
- }
37
- },
38
- "additionalProperties": {
39
- "type": "object",
40
- "required": [
41
- "status"
42
- ],
43
- "properties": {
44
- "status": {
45
- "type": "string"
46
- }
47
- },
48
- "additionalProperties": true
49
- },
50
- "nullable": true
51
- },
52
- "error": {
53
- "type": "object",
54
- "example": {},
55
- "additionalProperties": {
56
- "type": "object",
57
- "required": [
58
- "status"
59
- ],
60
- "properties": {
61
- "status": {
62
- "type": "string"
63
- }
64
- },
65
- "additionalProperties": true
66
- },
67
- "nullable": true
68
- },
69
- "details": {
70
- "type": "object",
71
- "example": {
72
- "database": {
73
- "status": "up"
74
- }
75
- },
76
- "additionalProperties": {
77
- "type": "object",
78
- "required": [
79
- "status"
80
- ],
81
- "properties": {
82
- "status": {
83
- "type": "string"
84
- }
85
- },
86
- "additionalProperties": true
87
- }
88
- }
89
- }
90
- }
91
- }
92
- }
93
- },
94
- "503": {
95
- "description": "The Health Check is not successful",
96
- "content": {
97
- "application/json": {
98
- "schema": {
99
- "type": "object",
100
- "properties": {
101
- "status": {
102
- "type": "string",
103
- "example": "error"
104
- },
105
- "info": {
106
- "type": "object",
107
- "example": {
108
- "database": {
109
- "status": "up"
110
- }
111
- },
112
- "additionalProperties": {
113
- "type": "object",
114
- "required": [
115
- "status"
116
- ],
117
- "properties": {
118
- "status": {
119
- "type": "string"
120
- }
121
- },
122
- "additionalProperties": true
123
- },
124
- "nullable": true
125
- },
126
- "error": {
127
- "type": "object",
128
- "example": {
129
- "redis": {
130
- "status": "down",
131
- "message": "Could not connect"
132
- }
133
- },
134
- "additionalProperties": {
135
- "type": "object",
136
- "required": [
137
- "status"
138
- ],
139
- "properties": {
140
- "status": {
141
- "type": "string"
142
- }
143
- },
144
- "additionalProperties": true
145
- },
146
- "nullable": true
147
- },
148
- "details": {
149
- "type": "object",
150
- "example": {
151
- "database": {
152
- "status": "up"
153
- },
154
- "redis": {
155
- "status": "down",
156
- "message": "Could not connect"
157
- }
158
- },
159
- "additionalProperties": {
160
- "type": "object",
161
- "required": [
162
- "status"
163
- ],
164
- "properties": {
165
- "status": {
166
- "type": "string"
167
- }
168
- },
169
- "additionalProperties": true
170
- }
171
- }
172
- }
173
- }
174
- }
175
- }
176
- }
177
- },
178
- "tags": [
179
- "Admin"
180
- ]
181
- }
182
- },
183
- "/v1/health-check/test-idempotency": {
184
- "post": {
185
- "operationId": "HealthController_testIdempotency",
186
- "x-speakeasy-name-override": "testIdempotency",
187
- "x-ignore": true,
188
- "parameters": [
189
- {
190
- "name": "idempotency-key",
191
- "in": "header",
192
- "description": "A header for idempotency purposes",
193
- "required": false,
194
- "schema": {
195
- "type": "string"
196
- }
197
- }
198
- ],
199
- "requestBody": {
200
- "required": true,
201
- "content": {
202
- "application/json": {
203
- "schema": {
204
- "$ref": "#/components/schemas/IdempotencyTestingDto"
205
- }
206
- }
207
- }
208
- },
209
- "responses": {
210
- "201": {
211
- "headers": {
212
- "Content-Type": {
213
- "$ref": "#/components/headers/Content-Type"
214
- },
215
- "RateLimit-Limit": {
216
- "$ref": "#/components/headers/RateLimit-Limit"
217
- },
218
- "RateLimit-Remaining": {
219
- "$ref": "#/components/headers/RateLimit-Remaining"
220
- },
221
- "RateLimit-Reset": {
222
- "$ref": "#/components/headers/RateLimit-Reset"
223
- },
224
- "RateLimit-Policy": {
225
- "$ref": "#/components/headers/RateLimit-Policy"
226
- },
227
- "Idempotency-Key": {
228
- "$ref": "#/components/headers/Idempotency-Key"
229
- },
230
- "Idempotency-Replay": {
231
- "$ref": "#/components/headers/Idempotency-Replay"
232
- }
233
- },
234
- "description": "",
235
- "content": {
236
- "application/json": {
237
- "schema": {
238
- "$ref": "#/components/schemas/IdempotenceTestingResponse"
239
- }
240
- }
241
- }
242
- },
243
- "400": {
244
- "description": "Bad Request",
245
- "headers": {
246
- "Content-Type": {
247
- "$ref": "#/components/headers/Content-Type"
248
- },
249
- "RateLimit-Limit": {
250
- "$ref": "#/components/headers/RateLimit-Limit"
251
- },
252
- "RateLimit-Remaining": {
253
- "$ref": "#/components/headers/RateLimit-Remaining"
254
- },
255
- "RateLimit-Reset": {
256
- "$ref": "#/components/headers/RateLimit-Reset"
257
- },
258
- "RateLimit-Policy": {
259
- "$ref": "#/components/headers/RateLimit-Policy"
260
- },
261
- "Idempotency-Key": {
262
- "$ref": "#/components/headers/Idempotency-Key"
263
- },
264
- "Idempotency-Replay": {
265
- "$ref": "#/components/headers/Idempotency-Replay"
266
- }
267
- },
268
- "content": {
269
- "application/json": {
270
- "schema": {
271
- "$ref": "#/components/schemas/ErrorDto"
272
- }
273
- }
274
- }
275
- },
276
- "401": {
277
- "description": "Unauthorized",
278
- "headers": {
279
- "Content-Type": {
280
- "$ref": "#/components/headers/Content-Type"
281
- },
282
- "RateLimit-Limit": {
283
- "$ref": "#/components/headers/RateLimit-Limit"
284
- },
285
- "RateLimit-Remaining": {
286
- "$ref": "#/components/headers/RateLimit-Remaining"
287
- },
288
- "RateLimit-Reset": {
289
- "$ref": "#/components/headers/RateLimit-Reset"
290
- },
291
- "RateLimit-Policy": {
292
- "$ref": "#/components/headers/RateLimit-Policy"
293
- },
294
- "Idempotency-Key": {
295
- "$ref": "#/components/headers/Idempotency-Key"
296
- },
297
- "Idempotency-Replay": {
298
- "$ref": "#/components/headers/Idempotency-Replay"
299
- }
300
- },
301
- "content": {
302
- "application/json": {
303
- "schema": {
304
- "$ref": "#/components/schemas/ErrorDto"
305
- }
306
- }
307
- }
308
- },
309
- "403": {
310
- "description": "Forbidden",
311
- "headers": {
312
- "Content-Type": {
313
- "$ref": "#/components/headers/Content-Type"
314
- },
315
- "RateLimit-Limit": {
316
- "$ref": "#/components/headers/RateLimit-Limit"
317
- },
318
- "RateLimit-Remaining": {
319
- "$ref": "#/components/headers/RateLimit-Remaining"
320
- },
321
- "RateLimit-Reset": {
322
- "$ref": "#/components/headers/RateLimit-Reset"
323
- },
324
- "RateLimit-Policy": {
325
- "$ref": "#/components/headers/RateLimit-Policy"
326
- },
327
- "Idempotency-Key": {
328
- "$ref": "#/components/headers/Idempotency-Key"
329
- },
330
- "Idempotency-Replay": {
331
- "$ref": "#/components/headers/Idempotency-Replay"
332
- }
333
- },
334
- "content": {
335
- "application/json": {
336
- "schema": {
337
- "$ref": "#/components/schemas/ErrorDto"
338
- }
339
- }
340
- }
341
- },
342
- "404": {
343
- "description": "Not Found",
344
- "headers": {
345
- "Content-Type": {
346
- "$ref": "#/components/headers/Content-Type"
347
- },
348
- "RateLimit-Limit": {
349
- "$ref": "#/components/headers/RateLimit-Limit"
350
- },
351
- "RateLimit-Remaining": {
352
- "$ref": "#/components/headers/RateLimit-Remaining"
353
- },
354
- "RateLimit-Reset": {
355
- "$ref": "#/components/headers/RateLimit-Reset"
356
- },
357
- "RateLimit-Policy": {
358
- "$ref": "#/components/headers/RateLimit-Policy"
359
- },
360
- "Idempotency-Key": {
361
- "$ref": "#/components/headers/Idempotency-Key"
362
- },
363
- "Idempotency-Replay": {
364
- "$ref": "#/components/headers/Idempotency-Replay"
365
- }
366
- },
367
- "content": {
368
- "application/json": {
369
- "schema": {
370
- "$ref": "#/components/schemas/ErrorDto"
371
- }
372
- }
373
- }
374
- },
375
- "405": {
376
- "description": "Method Not Allowed",
377
- "headers": {
378
- "Content-Type": {
379
- "$ref": "#/components/headers/Content-Type"
380
- },
381
- "RateLimit-Limit": {
382
- "$ref": "#/components/headers/RateLimit-Limit"
383
- },
384
- "RateLimit-Remaining": {
385
- "$ref": "#/components/headers/RateLimit-Remaining"
386
- },
387
- "RateLimit-Reset": {
388
- "$ref": "#/components/headers/RateLimit-Reset"
389
- },
390
- "RateLimit-Policy": {
391
- "$ref": "#/components/headers/RateLimit-Policy"
392
- },
393
- "Idempotency-Key": {
394
- "$ref": "#/components/headers/Idempotency-Key"
395
- },
396
- "Idempotency-Replay": {
397
- "$ref": "#/components/headers/Idempotency-Replay"
398
- }
399
- },
400
- "content": {
401
- "application/json": {
402
- "schema": {
403
- "$ref": "#/components/schemas/ErrorDto"
404
- }
405
- }
406
- }
407
- },
408
- "409": {
409
- "description": "Conflict",
410
- "headers": {
411
- "Content-Type": {
412
- "$ref": "#/components/headers/Content-Type"
413
- },
414
- "RateLimit-Limit": {
415
- "$ref": "#/components/headers/RateLimit-Limit"
416
- },
417
- "RateLimit-Remaining": {
418
- "$ref": "#/components/headers/RateLimit-Remaining"
419
- },
420
- "RateLimit-Reset": {
421
- "$ref": "#/components/headers/RateLimit-Reset"
422
- },
423
- "RateLimit-Policy": {
424
- "$ref": "#/components/headers/RateLimit-Policy"
425
- },
426
- "Idempotency-Key": {
427
- "$ref": "#/components/headers/Idempotency-Key"
428
- },
429
- "Idempotency-Replay": {
430
- "$ref": "#/components/headers/Idempotency-Replay"
431
- }
432
- },
433
- "content": {
434
- "application/json": {
435
- "schema": {
436
- "$ref": "#/components/schemas/ErrorDto"
437
- }
438
- }
439
- }
440
- },
441
- "413": {
442
- "description": "Payload Too Large",
443
- "headers": {
444
- "Content-Type": {
445
- "$ref": "#/components/headers/Content-Type"
446
- },
447
- "RateLimit-Limit": {
448
- "$ref": "#/components/headers/RateLimit-Limit"
449
- },
450
- "RateLimit-Remaining": {
451
- "$ref": "#/components/headers/RateLimit-Remaining"
452
- },
453
- "RateLimit-Reset": {
454
- "$ref": "#/components/headers/RateLimit-Reset"
455
- },
456
- "RateLimit-Policy": {
457
- "$ref": "#/components/headers/RateLimit-Policy"
458
- },
459
- "Idempotency-Key": {
460
- "$ref": "#/components/headers/Idempotency-Key"
461
- },
462
- "Idempotency-Replay": {
463
- "$ref": "#/components/headers/Idempotency-Replay"
464
- }
465
- },
466
- "content": {
467
- "application/json": {
468
- "schema": {
469
- "$ref": "#/components/schemas/ErrorDto"
470
- }
471
- }
472
- }
473
- },
474
- "414": {
475
- "description": "URI Too Long",
476
- "content": {
477
- "application/json": {
478
- "schema": {
479
- "$ref": "#/components/schemas/ErrorDto"
480
- }
481
- }
482
- }
483
- },
484
- "415": {
485
- "description": "Unsupported Media Type",
486
- "headers": {
487
- "Content-Type": {
488
- "$ref": "#/components/headers/Content-Type"
489
- },
490
- "RateLimit-Limit": {
491
- "$ref": "#/components/headers/RateLimit-Limit"
492
- },
493
- "RateLimit-Remaining": {
494
- "$ref": "#/components/headers/RateLimit-Remaining"
495
- },
496
- "RateLimit-Reset": {
497
- "$ref": "#/components/headers/RateLimit-Reset"
498
- },
499
- "RateLimit-Policy": {
500
- "$ref": "#/components/headers/RateLimit-Policy"
501
- },
502
- "Idempotency-Key": {
503
- "$ref": "#/components/headers/Idempotency-Key"
504
- },
505
- "Idempotency-Replay": {
506
- "$ref": "#/components/headers/Idempotency-Replay"
507
- }
508
- },
509
- "content": {
510
- "application/json": {
511
- "schema": {
512
- "$ref": "#/components/schemas/ErrorDto"
513
- }
514
- }
515
- }
516
- },
517
- "422": {
518
- "description": "Unprocessable Entity",
519
- "headers": {
520
- "Content-Type": {
521
- "$ref": "#/components/headers/Content-Type"
522
- },
523
- "RateLimit-Limit": {
524
- "$ref": "#/components/headers/RateLimit-Limit"
525
- },
526
- "RateLimit-Remaining": {
527
- "$ref": "#/components/headers/RateLimit-Remaining"
528
- },
529
- "RateLimit-Reset": {
530
- "$ref": "#/components/headers/RateLimit-Reset"
531
- },
532
- "RateLimit-Policy": {
533
- "$ref": "#/components/headers/RateLimit-Policy"
534
- },
535
- "Idempotency-Key": {
536
- "$ref": "#/components/headers/Idempotency-Key"
537
- },
538
- "Idempotency-Replay": {
539
- "$ref": "#/components/headers/Idempotency-Replay"
540
- }
541
- },
542
- "content": {
543
- "application/json": {
544
- "schema": {
545
- "$ref": "#/components/schemas/ValidationErrorDto"
546
- }
547
- }
548
- }
549
- },
550
- "429": {
551
- "description": "The client has sent too many requests in a given amount of time. ",
552
- "headers": {
553
- "Content-Type": {
554
- "$ref": "#/components/headers/Content-Type"
555
- },
556
- "RateLimit-Limit": {
557
- "$ref": "#/components/headers/RateLimit-Limit"
558
- },
559
- "RateLimit-Remaining": {
560
- "$ref": "#/components/headers/RateLimit-Remaining"
561
- },
562
- "RateLimit-Reset": {
563
- "$ref": "#/components/headers/RateLimit-Reset"
564
- },
565
- "RateLimit-Policy": {
566
- "$ref": "#/components/headers/RateLimit-Policy"
567
- },
568
- "Idempotency-Key": {
569
- "$ref": "#/components/headers/Idempotency-Key"
570
- },
571
- "Idempotency-Replay": {
572
- "$ref": "#/components/headers/Idempotency-Replay"
573
- },
574
- "Retry-After": {
575
- "$ref": "#/components/headers/Retry-After"
576
- }
577
- },
578
- "content": {
579
- "application/json": {
580
- "schema": {
581
- "type": "string",
582
- "example": "API rate limit exceeded"
583
- }
584
- }
585
- }
586
- },
587
- "500": {
588
- "description": "Internal Server Error",
589
- "headers": {
590
- "Content-Type": {
591
- "$ref": "#/components/headers/Content-Type"
592
- },
593
- "RateLimit-Limit": {
594
- "$ref": "#/components/headers/RateLimit-Limit"
595
- },
596
- "RateLimit-Remaining": {
597
- "$ref": "#/components/headers/RateLimit-Remaining"
598
- },
599
- "RateLimit-Reset": {
600
- "$ref": "#/components/headers/RateLimit-Reset"
601
- },
602
- "RateLimit-Policy": {
603
- "$ref": "#/components/headers/RateLimit-Policy"
604
- },
605
- "Idempotency-Key": {
606
- "$ref": "#/components/headers/Idempotency-Key"
607
- },
608
- "Idempotency-Replay": {
609
- "$ref": "#/components/headers/Idempotency-Replay"
610
- }
611
- },
612
- "content": {
613
- "application/json": {
614
- "schema": {
615
- "$ref": "#/components/schemas/ErrorDto"
616
- }
617
- }
618
- }
619
- },
620
- "503": {
621
- "description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
622
- "headers": {
623
- "Content-Type": {
624
- "$ref": "#/components/headers/Content-Type"
625
- },
626
- "RateLimit-Limit": {
627
- "$ref": "#/components/headers/RateLimit-Limit"
628
- },
629
- "RateLimit-Remaining": {
630
- "$ref": "#/components/headers/RateLimit-Remaining"
631
- },
632
- "RateLimit-Reset": {
633
- "$ref": "#/components/headers/RateLimit-Reset"
634
- },
635
- "RateLimit-Policy": {
636
- "$ref": "#/components/headers/RateLimit-Policy"
637
- },
638
- "Idempotency-Key": {
639
- "$ref": "#/components/headers/Idempotency-Key"
640
- },
641
- "Idempotency-Replay": {
642
- "$ref": "#/components/headers/Idempotency-Replay"
643
- },
644
- "Retry-After": {
645
- "$ref": "#/components/headers/Retry-After"
646
- }
647
- },
648
- "content": {
649
- "application/json": {
650
- "schema": {
651
- "type": "string",
652
- "example": "Please wait some time, then try again."
653
- }
654
- }
655
- }
656
- }
657
- },
658
- "tags": [
659
- "Admin"
660
- ],
661
- "security": [
662
- {
663
- "api-key": []
664
- }
665
- ]
666
- },
667
- "get": {
668
- "operationId": "HealthController_generateRandomNumber",
669
- "x-speakeasy-name-override": "generateRandomNumber",
670
- "x-ignore": true,
671
- "parameters": [
672
- {
673
- "name": "idempotency-key",
674
- "in": "header",
675
- "description": "A header for idempotency purposes",
676
- "required": false,
677
- "schema": {
678
- "type": "string"
679
- }
680
- }
681
- ],
682
- "responses": {
683
- "201": {
684
- "headers": {
685
- "Content-Type": {
686
- "$ref": "#/components/headers/Content-Type"
687
- },
688
- "RateLimit-Limit": {
689
- "$ref": "#/components/headers/RateLimit-Limit"
690
- },
691
- "RateLimit-Remaining": {
692
- "$ref": "#/components/headers/RateLimit-Remaining"
693
- },
694
- "RateLimit-Reset": {
695
- "$ref": "#/components/headers/RateLimit-Reset"
696
- },
697
- "RateLimit-Policy": {
698
- "$ref": "#/components/headers/RateLimit-Policy"
699
- },
700
- "Idempotency-Key": {
701
- "$ref": "#/components/headers/Idempotency-Key"
702
- },
703
- "Idempotency-Replay": {
704
- "$ref": "#/components/headers/Idempotency-Replay"
705
- }
706
- },
707
- "description": "",
708
- "content": {
709
- "application/json": {
710
- "schema": {
711
- "$ref": "#/components/schemas/IdempotenceTestingResponse"
712
- }
713
- }
714
- }
715
- },
716
- "400": {
717
- "description": "Bad Request",
718
- "headers": {
719
- "Content-Type": {
720
- "$ref": "#/components/headers/Content-Type"
721
- },
722
- "RateLimit-Limit": {
723
- "$ref": "#/components/headers/RateLimit-Limit"
724
- },
725
- "RateLimit-Remaining": {
726
- "$ref": "#/components/headers/RateLimit-Remaining"
727
- },
728
- "RateLimit-Reset": {
729
- "$ref": "#/components/headers/RateLimit-Reset"
730
- },
731
- "RateLimit-Policy": {
732
- "$ref": "#/components/headers/RateLimit-Policy"
733
- },
734
- "Idempotency-Key": {
735
- "$ref": "#/components/headers/Idempotency-Key"
736
- },
737
- "Idempotency-Replay": {
738
- "$ref": "#/components/headers/Idempotency-Replay"
739
- }
740
- },
741
- "content": {
742
- "application/json": {
743
- "schema": {
744
- "$ref": "#/components/schemas/ErrorDto"
745
- }
746
- }
747
- }
748
- },
749
- "401": {
750
- "description": "Unauthorized",
751
- "headers": {
752
- "Content-Type": {
753
- "$ref": "#/components/headers/Content-Type"
754
- },
755
- "RateLimit-Limit": {
756
- "$ref": "#/components/headers/RateLimit-Limit"
757
- },
758
- "RateLimit-Remaining": {
759
- "$ref": "#/components/headers/RateLimit-Remaining"
760
- },
761
- "RateLimit-Reset": {
762
- "$ref": "#/components/headers/RateLimit-Reset"
763
- },
764
- "RateLimit-Policy": {
765
- "$ref": "#/components/headers/RateLimit-Policy"
766
- },
767
- "Idempotency-Key": {
768
- "$ref": "#/components/headers/Idempotency-Key"
769
- },
770
- "Idempotency-Replay": {
771
- "$ref": "#/components/headers/Idempotency-Replay"
772
- }
773
- },
774
- "content": {
775
- "application/json": {
776
- "schema": {
777
- "$ref": "#/components/schemas/ErrorDto"
778
- }
779
- }
780
- }
781
- },
782
- "403": {
783
- "description": "Forbidden",
784
- "headers": {
785
- "Content-Type": {
786
- "$ref": "#/components/headers/Content-Type"
787
- },
788
- "RateLimit-Limit": {
789
- "$ref": "#/components/headers/RateLimit-Limit"
790
- },
791
- "RateLimit-Remaining": {
792
- "$ref": "#/components/headers/RateLimit-Remaining"
793
- },
794
- "RateLimit-Reset": {
795
- "$ref": "#/components/headers/RateLimit-Reset"
796
- },
797
- "RateLimit-Policy": {
798
- "$ref": "#/components/headers/RateLimit-Policy"
799
- },
800
- "Idempotency-Key": {
801
- "$ref": "#/components/headers/Idempotency-Key"
802
- },
803
- "Idempotency-Replay": {
804
- "$ref": "#/components/headers/Idempotency-Replay"
805
- }
806
- },
807
- "content": {
808
- "application/json": {
809
- "schema": {
810
- "$ref": "#/components/schemas/ErrorDto"
811
- }
812
- }
813
- }
814
- },
815
- "404": {
816
- "description": "Not Found",
817
- "headers": {
818
- "Content-Type": {
819
- "$ref": "#/components/headers/Content-Type"
820
- },
821
- "RateLimit-Limit": {
822
- "$ref": "#/components/headers/RateLimit-Limit"
823
- },
824
- "RateLimit-Remaining": {
825
- "$ref": "#/components/headers/RateLimit-Remaining"
826
- },
827
- "RateLimit-Reset": {
828
- "$ref": "#/components/headers/RateLimit-Reset"
829
- },
830
- "RateLimit-Policy": {
831
- "$ref": "#/components/headers/RateLimit-Policy"
832
- },
833
- "Idempotency-Key": {
834
- "$ref": "#/components/headers/Idempotency-Key"
835
- },
836
- "Idempotency-Replay": {
837
- "$ref": "#/components/headers/Idempotency-Replay"
838
- }
839
- },
840
- "content": {
841
- "application/json": {
842
- "schema": {
843
- "$ref": "#/components/schemas/ErrorDto"
844
- }
845
- }
846
- }
847
- },
848
- "405": {
849
- "description": "Method Not Allowed",
850
- "headers": {
851
- "Content-Type": {
852
- "$ref": "#/components/headers/Content-Type"
853
- },
854
- "RateLimit-Limit": {
855
- "$ref": "#/components/headers/RateLimit-Limit"
856
- },
857
- "RateLimit-Remaining": {
858
- "$ref": "#/components/headers/RateLimit-Remaining"
859
- },
860
- "RateLimit-Reset": {
861
- "$ref": "#/components/headers/RateLimit-Reset"
862
- },
863
- "RateLimit-Policy": {
864
- "$ref": "#/components/headers/RateLimit-Policy"
865
- },
866
- "Idempotency-Key": {
867
- "$ref": "#/components/headers/Idempotency-Key"
868
- },
869
- "Idempotency-Replay": {
870
- "$ref": "#/components/headers/Idempotency-Replay"
871
- }
872
- },
873
- "content": {
874
- "application/json": {
875
- "schema": {
876
- "$ref": "#/components/schemas/ErrorDto"
877
- }
878
- }
879
- }
880
- },
881
- "409": {
882
- "description": "Conflict",
883
- "headers": {
884
- "Content-Type": {
885
- "$ref": "#/components/headers/Content-Type"
886
- },
887
- "RateLimit-Limit": {
888
- "$ref": "#/components/headers/RateLimit-Limit"
889
- },
890
- "RateLimit-Remaining": {
891
- "$ref": "#/components/headers/RateLimit-Remaining"
892
- },
893
- "RateLimit-Reset": {
894
- "$ref": "#/components/headers/RateLimit-Reset"
895
- },
896
- "RateLimit-Policy": {
897
- "$ref": "#/components/headers/RateLimit-Policy"
898
- },
899
- "Idempotency-Key": {
900
- "$ref": "#/components/headers/Idempotency-Key"
901
- },
902
- "Idempotency-Replay": {
903
- "$ref": "#/components/headers/Idempotency-Replay"
904
- }
905
- },
906
- "content": {
907
- "application/json": {
908
- "schema": {
909
- "$ref": "#/components/schemas/ErrorDto"
910
- }
911
- }
912
- }
913
- },
914
- "413": {
915
- "description": "Payload Too Large",
916
- "headers": {
917
- "Content-Type": {
918
- "$ref": "#/components/headers/Content-Type"
919
- },
920
- "RateLimit-Limit": {
921
- "$ref": "#/components/headers/RateLimit-Limit"
922
- },
923
- "RateLimit-Remaining": {
924
- "$ref": "#/components/headers/RateLimit-Remaining"
925
- },
926
- "RateLimit-Reset": {
927
- "$ref": "#/components/headers/RateLimit-Reset"
928
- },
929
- "RateLimit-Policy": {
930
- "$ref": "#/components/headers/RateLimit-Policy"
931
- },
932
- "Idempotency-Key": {
933
- "$ref": "#/components/headers/Idempotency-Key"
934
- },
935
- "Idempotency-Replay": {
936
- "$ref": "#/components/headers/Idempotency-Replay"
937
- }
938
- },
939
- "content": {
940
- "application/json": {
941
- "schema": {
942
- "$ref": "#/components/schemas/ErrorDto"
943
- }
944
- }
945
- }
946
- },
947
- "414": {
948
- "description": "URI Too Long",
949
- "content": {
950
- "application/json": {
951
- "schema": {
952
- "$ref": "#/components/schemas/ErrorDto"
953
- }
954
- }
955
- }
956
- },
957
- "415": {
958
- "description": "Unsupported Media Type",
959
- "headers": {
960
- "Content-Type": {
961
- "$ref": "#/components/headers/Content-Type"
962
- },
963
- "RateLimit-Limit": {
964
- "$ref": "#/components/headers/RateLimit-Limit"
965
- },
966
- "RateLimit-Remaining": {
967
- "$ref": "#/components/headers/RateLimit-Remaining"
968
- },
969
- "RateLimit-Reset": {
970
- "$ref": "#/components/headers/RateLimit-Reset"
971
- },
972
- "RateLimit-Policy": {
973
- "$ref": "#/components/headers/RateLimit-Policy"
974
- },
975
- "Idempotency-Key": {
976
- "$ref": "#/components/headers/Idempotency-Key"
977
- },
978
- "Idempotency-Replay": {
979
- "$ref": "#/components/headers/Idempotency-Replay"
980
- }
981
- },
982
- "content": {
983
- "application/json": {
984
- "schema": {
985
- "$ref": "#/components/schemas/ErrorDto"
986
- }
987
- }
988
- }
989
- },
990
- "422": {
991
- "description": "Unprocessable Entity",
992
- "headers": {
993
- "Content-Type": {
994
- "$ref": "#/components/headers/Content-Type"
995
- },
996
- "RateLimit-Limit": {
997
- "$ref": "#/components/headers/RateLimit-Limit"
998
- },
999
- "RateLimit-Remaining": {
1000
- "$ref": "#/components/headers/RateLimit-Remaining"
1001
- },
1002
- "RateLimit-Reset": {
1003
- "$ref": "#/components/headers/RateLimit-Reset"
1004
- },
1005
- "RateLimit-Policy": {
1006
- "$ref": "#/components/headers/RateLimit-Policy"
1007
- },
1008
- "Idempotency-Key": {
1009
- "$ref": "#/components/headers/Idempotency-Key"
1010
- },
1011
- "Idempotency-Replay": {
1012
- "$ref": "#/components/headers/Idempotency-Replay"
1013
- }
1014
- },
1015
- "content": {
1016
- "application/json": {
1017
- "schema": {
1018
- "$ref": "#/components/schemas/ValidationErrorDto"
1019
- }
1020
- }
1021
- }
1022
- },
1023
- "429": {
1024
- "description": "The client has sent too many requests in a given amount of time. ",
1025
- "headers": {
1026
- "Content-Type": {
1027
- "$ref": "#/components/headers/Content-Type"
1028
- },
1029
- "RateLimit-Limit": {
1030
- "$ref": "#/components/headers/RateLimit-Limit"
1031
- },
1032
- "RateLimit-Remaining": {
1033
- "$ref": "#/components/headers/RateLimit-Remaining"
1034
- },
1035
- "RateLimit-Reset": {
1036
- "$ref": "#/components/headers/RateLimit-Reset"
1037
- },
1038
- "RateLimit-Policy": {
1039
- "$ref": "#/components/headers/RateLimit-Policy"
1040
- },
1041
- "Idempotency-Key": {
1042
- "$ref": "#/components/headers/Idempotency-Key"
1043
- },
1044
- "Idempotency-Replay": {
1045
- "$ref": "#/components/headers/Idempotency-Replay"
1046
- },
1047
- "Retry-After": {
1048
- "$ref": "#/components/headers/Retry-After"
1049
- }
1050
- },
1051
- "content": {
1052
- "application/json": {
1053
- "schema": {
1054
- "type": "string",
1055
- "example": "API rate limit exceeded"
1056
- }
1057
- }
1058
- }
1059
- },
1060
- "500": {
1061
- "description": "Internal Server Error",
1062
- "headers": {
1063
- "Content-Type": {
1064
- "$ref": "#/components/headers/Content-Type"
1065
- },
1066
- "RateLimit-Limit": {
1067
- "$ref": "#/components/headers/RateLimit-Limit"
1068
- },
1069
- "RateLimit-Remaining": {
1070
- "$ref": "#/components/headers/RateLimit-Remaining"
1071
- },
1072
- "RateLimit-Reset": {
1073
- "$ref": "#/components/headers/RateLimit-Reset"
1074
- },
1075
- "RateLimit-Policy": {
1076
- "$ref": "#/components/headers/RateLimit-Policy"
1077
- },
1078
- "Idempotency-Key": {
1079
- "$ref": "#/components/headers/Idempotency-Key"
1080
- },
1081
- "Idempotency-Replay": {
1082
- "$ref": "#/components/headers/Idempotency-Replay"
1083
- }
1084
- },
1085
- "content": {
1086
- "application/json": {
1087
- "schema": {
1088
- "$ref": "#/components/schemas/ErrorDto"
1089
- }
1090
- }
1091
- }
1092
- },
1093
- "503": {
1094
- "description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
1095
- "headers": {
1096
- "Content-Type": {
1097
- "$ref": "#/components/headers/Content-Type"
1098
- },
1099
- "RateLimit-Limit": {
1100
- "$ref": "#/components/headers/RateLimit-Limit"
1101
- },
1102
- "RateLimit-Remaining": {
1103
- "$ref": "#/components/headers/RateLimit-Remaining"
1104
- },
1105
- "RateLimit-Reset": {
1106
- "$ref": "#/components/headers/RateLimit-Reset"
1107
- },
1108
- "RateLimit-Policy": {
1109
- "$ref": "#/components/headers/RateLimit-Policy"
1110
- },
1111
- "Idempotency-Key": {
1112
- "$ref": "#/components/headers/Idempotency-Key"
1113
- },
1114
- "Idempotency-Replay": {
1115
- "$ref": "#/components/headers/Idempotency-Replay"
1116
- },
1117
- "Retry-After": {
1118
- "$ref": "#/components/headers/Retry-After"
1119
- }
1120
- },
1121
- "content": {
1122
- "application/json": {
1123
- "schema": {
1124
- "type": "string",
1125
- "example": "Please wait some time, then try again."
1126
- }
1127
- }
1128
- }
1129
- }
1130
- },
1131
- "tags": [
1132
- "Admin"
1133
- ],
1134
- "security": [
1135
- {
1136
- "api-key": []
1137
- }
1138
- ]
1139
- }
1140
- },
1141
4
  "/v1/events/trigger": {
1142
5
  "post": {
1143
6
  "operationId": "EventsController_trigger",
@@ -24770,39 +23633,6 @@
24770
23633
  "errors"
24771
23634
  ]
24772
23635
  },
24773
- "IdempotencyBehaviorEnum": {
24774
- "type": "string",
24775
- "description": "The expected behavior of the idempotency request",
24776
- "enum": [
24777
- "IMMEDIATE_RESPONSE",
24778
- "IMMEDIATE_EXCEPTION",
24779
- "DELAYED_RESPONSE"
24780
- ]
24781
- },
24782
- "IdempotencyTestingDto": {
24783
- "type": "object",
24784
- "properties": {
24785
- "expectedBehavior": {
24786
- "$ref": "#/components/schemas/IdempotencyBehaviorEnum"
24787
- }
24788
- },
24789
- "required": [
24790
- "expectedBehavior"
24791
- ]
24792
- },
24793
- "IdempotenceTestingResponse": {
24794
- "type": "object",
24795
- "properties": {
24796
- "number": {
24797
- "type": "number",
24798
- "description": "A unique number representing the idempotency response",
24799
- "example": 1
24800
- }
24801
- },
24802
- "required": [
24803
- "number"
24804
- ]
24805
- },
24806
23636
  "TriggerEventResponseDto": {
24807
23637
  "type": "object",
24808
23638
  "properties": {