@novu/api 0.0.1 → 0.0.3

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 (48) hide show
  1. package/README.md +2 -0
  2. package/docs/sdks/admin/README.md +75 -0
  3. package/funcs/adminGenerateRandomNumber.d.ts +10 -0
  4. package/funcs/adminGenerateRandomNumber.d.ts.map +1 -0
  5. package/funcs/adminGenerateRandomNumber.js +126 -0
  6. package/funcs/adminGenerateRandomNumber.js.map +1 -0
  7. package/funcs/adminTestIdempotency.d.ts +1 -1
  8. package/funcs/adminTestIdempotency.d.ts.map +1 -1
  9. package/funcs/adminTestIdempotency.js +1 -2
  10. package/funcs/adminTestIdempotency.js.map +1 -1
  11. package/jsr.json +1 -1
  12. package/lib/config.d.ts +2 -2
  13. package/lib/config.js +2 -2
  14. package/models/components/idempotencetestingresponse.d.ts +32 -0
  15. package/models/components/idempotencetestingresponse.d.ts.map +1 -0
  16. package/models/components/idempotencetestingresponse.js +59 -0
  17. package/models/components/idempotencetestingresponse.js.map +1 -0
  18. package/models/components/index.d.ts +1 -0
  19. package/models/components/index.d.ts.map +1 -1
  20. package/models/components/index.js +1 -0
  21. package/models/components/index.js.map +1 -1
  22. package/models/operations/healthcontrollergeneraterandomnumber.d.ts +64 -0
  23. package/models/operations/healthcontrollergeneraterandomnumber.d.ts.map +1 -0
  24. package/models/operations/healthcontrollergeneraterandomnumber.js +108 -0
  25. package/models/operations/healthcontrollergeneraterandomnumber.js.map +1 -0
  26. package/models/operations/healthcontrollertestidempotency.d.ts +2 -0
  27. package/models/operations/healthcontrollertestidempotency.d.ts.map +1 -1
  28. package/models/operations/healthcontrollertestidempotency.js +4 -0
  29. package/models/operations/healthcontrollertestidempotency.js.map +1 -1
  30. package/models/operations/index.d.ts +1 -0
  31. package/models/operations/index.d.ts.map +1 -1
  32. package/models/operations/index.js +1 -0
  33. package/models/operations/index.js.map +1 -1
  34. package/package.json +1 -1
  35. package/sdk/admin.d.ts +2 -1
  36. package/sdk/admin.d.ts.map +1 -1
  37. package/sdk/admin.js +4 -0
  38. package/sdk/admin.js.map +1 -1
  39. package/sources/json-development.json +518 -0
  40. package/src/funcs/adminGenerateRandomNumber.ts +183 -0
  41. package/src/funcs/adminTestIdempotency.ts +7 -7
  42. package/src/lib/config.ts +2 -2
  43. package/src/models/components/idempotencetestingresponse.ts +69 -0
  44. package/src/models/components/index.ts +1 -0
  45. package/src/models/operations/healthcontrollergeneraterandomnumber.ts +177 -0
  46. package/src/models/operations/healthcontrollertestidempotency.ts +6 -0
  47. package/src/models/operations/index.ts +1 -0
  48. package/src/sdk/admin.ts +13 -1
package/sources/json-development.json CHANGED
@@ -205,6 +205,511 @@
205
205
  }
206
206
  },
207
207
  "responses": {
208
+ "201": {
209
+ "headers": {
210
+ "Content-Type": {
211
+ "$ref": "#/components/headers/Content-Type"
212
+ },
213
+ "RateLimit-Limit": {
214
+ "$ref": "#/components/headers/RateLimit-Limit"
215
+ },
216
+ "RateLimit-Remaining": {
217
+ "$ref": "#/components/headers/RateLimit-Remaining"
218
+ },
219
+ "RateLimit-Reset": {
220
+ "$ref": "#/components/headers/RateLimit-Reset"
221
+ },
222
+ "RateLimit-Policy": {
223
+ "$ref": "#/components/headers/RateLimit-Policy"
224
+ },
225
+ "Idempotency-Key": {
226
+ "$ref": "#/components/headers/Idempotency-Key"
227
+ },
228
+ "Idempotency-Replay": {
229
+ "$ref": "#/components/headers/Idempotency-Replay"
230
+ }
231
+ },
232
+ "description": "",
233
+ "content": {
234
+ "application/json": {
235
+ "schema": {
236
+ "$ref": "#/components/schemas/IdempotenceTestingResponse"
237
+ }
238
+ }
239
+ }
240
+ },
241
+ "400": {
242
+ "description": "Bad Request",
243
+ "headers": {
244
+ "Content-Type": {
245
+ "$ref": "#/components/headers/Content-Type"
246
+ },
247
+ "RateLimit-Limit": {
248
+ "$ref": "#/components/headers/RateLimit-Limit"
249
+ },
250
+ "RateLimit-Remaining": {
251
+ "$ref": "#/components/headers/RateLimit-Remaining"
252
+ },
253
+ "RateLimit-Reset": {
254
+ "$ref": "#/components/headers/RateLimit-Reset"
255
+ },
256
+ "RateLimit-Policy": {
257
+ "$ref": "#/components/headers/RateLimit-Policy"
258
+ },
259
+ "Idempotency-Key": {
260
+ "$ref": "#/components/headers/Idempotency-Key"
261
+ },
262
+ "Idempotency-Replay": {
263
+ "$ref": "#/components/headers/Idempotency-Replay"
264
+ }
265
+ },
266
+ "content": {
267
+ "application/json": {
268
+ "schema": {
269
+ "$ref": "#/components/schemas/ErrorDto"
270
+ }
271
+ }
272
+ }
273
+ },
274
+ "401": {
275
+ "description": "Unauthorized",
276
+ "headers": {
277
+ "Content-Type": {
278
+ "$ref": "#/components/headers/Content-Type"
279
+ },
280
+ "RateLimit-Limit": {
281
+ "$ref": "#/components/headers/RateLimit-Limit"
282
+ },
283
+ "RateLimit-Remaining": {
284
+ "$ref": "#/components/headers/RateLimit-Remaining"
285
+ },
286
+ "RateLimit-Reset": {
287
+ "$ref": "#/components/headers/RateLimit-Reset"
288
+ },
289
+ "RateLimit-Policy": {
290
+ "$ref": "#/components/headers/RateLimit-Policy"
291
+ },
292
+ "Idempotency-Key": {
293
+ "$ref": "#/components/headers/Idempotency-Key"
294
+ },
295
+ "Idempotency-Replay": {
296
+ "$ref": "#/components/headers/Idempotency-Replay"
297
+ }
298
+ },
299
+ "content": {
300
+ "application/json": {
301
+ "schema": {
302
+ "$ref": "#/components/schemas/ErrorDto"
303
+ }
304
+ }
305
+ }
306
+ },
307
+ "403": {
308
+ "description": "Forbidden",
309
+ "headers": {
310
+ "Content-Type": {
311
+ "$ref": "#/components/headers/Content-Type"
312
+ },
313
+ "RateLimit-Limit": {
314
+ "$ref": "#/components/headers/RateLimit-Limit"
315
+ },
316
+ "RateLimit-Remaining": {
317
+ "$ref": "#/components/headers/RateLimit-Remaining"
318
+ },
319
+ "RateLimit-Reset": {
320
+ "$ref": "#/components/headers/RateLimit-Reset"
321
+ },
322
+ "RateLimit-Policy": {
323
+ "$ref": "#/components/headers/RateLimit-Policy"
324
+ },
325
+ "Idempotency-Key": {
326
+ "$ref": "#/components/headers/Idempotency-Key"
327
+ },
328
+ "Idempotency-Replay": {
329
+ "$ref": "#/components/headers/Idempotency-Replay"
330
+ }
331
+ },
332
+ "content": {
333
+ "application/json": {
334
+ "schema": {
335
+ "$ref": "#/components/schemas/ErrorDto"
336
+ }
337
+ }
338
+ }
339
+ },
340
+ "404": {
341
+ "description": "Not Found",
342
+ "headers": {
343
+ "Content-Type": {
344
+ "$ref": "#/components/headers/Content-Type"
345
+ },
346
+ "RateLimit-Limit": {
347
+ "$ref": "#/components/headers/RateLimit-Limit"
348
+ },
349
+ "RateLimit-Remaining": {
350
+ "$ref": "#/components/headers/RateLimit-Remaining"
351
+ },
352
+ "RateLimit-Reset": {
353
+ "$ref": "#/components/headers/RateLimit-Reset"
354
+ },
355
+ "RateLimit-Policy": {
356
+ "$ref": "#/components/headers/RateLimit-Policy"
357
+ },
358
+ "Idempotency-Key": {
359
+ "$ref": "#/components/headers/Idempotency-Key"
360
+ },
361
+ "Idempotency-Replay": {
362
+ "$ref": "#/components/headers/Idempotency-Replay"
363
+ }
364
+ },
365
+ "content": {
366
+ "application/json": {
367
+ "schema": {
368
+ "$ref": "#/components/schemas/ErrorDto"
369
+ }
370
+ }
371
+ }
372
+ },
373
+ "405": {
374
+ "description": "Method Not Allowed",
375
+ "headers": {
376
+ "Content-Type": {
377
+ "$ref": "#/components/headers/Content-Type"
378
+ },
379
+ "RateLimit-Limit": {
380
+ "$ref": "#/components/headers/RateLimit-Limit"
381
+ },
382
+ "RateLimit-Remaining": {
383
+ "$ref": "#/components/headers/RateLimit-Remaining"
384
+ },
385
+ "RateLimit-Reset": {
386
+ "$ref": "#/components/headers/RateLimit-Reset"
387
+ },
388
+ "RateLimit-Policy": {
389
+ "$ref": "#/components/headers/RateLimit-Policy"
390
+ },
391
+ "Idempotency-Key": {
392
+ "$ref": "#/components/headers/Idempotency-Key"
393
+ },
394
+ "Idempotency-Replay": {
395
+ "$ref": "#/components/headers/Idempotency-Replay"
396
+ }
397
+ },
398
+ "content": {
399
+ "application/json": {
400
+ "schema": {
401
+ "$ref": "#/components/schemas/ErrorDto"
402
+ }
403
+ }
404
+ }
405
+ },
406
+ "409": {
407
+ "description": "Conflict",
408
+ "headers": {
409
+ "Content-Type": {
410
+ "$ref": "#/components/headers/Content-Type"
411
+ },
412
+ "RateLimit-Limit": {
413
+ "$ref": "#/components/headers/RateLimit-Limit"
414
+ },
415
+ "RateLimit-Remaining": {
416
+ "$ref": "#/components/headers/RateLimit-Remaining"
417
+ },
418
+ "RateLimit-Reset": {
419
+ "$ref": "#/components/headers/RateLimit-Reset"
420
+ },
421
+ "RateLimit-Policy": {
422
+ "$ref": "#/components/headers/RateLimit-Policy"
423
+ },
424
+ "Idempotency-Key": {
425
+ "$ref": "#/components/headers/Idempotency-Key"
426
+ },
427
+ "Idempotency-Replay": {
428
+ "$ref": "#/components/headers/Idempotency-Replay"
429
+ }
430
+ },
431
+ "content": {
432
+ "application/json": {
433
+ "schema": {
434
+ "$ref": "#/components/schemas/ErrorDto"
435
+ }
436
+ }
437
+ }
438
+ },
439
+ "413": {
440
+ "description": "Payload Too Large",
441
+ "headers": {
442
+ "Content-Type": {
443
+ "$ref": "#/components/headers/Content-Type"
444
+ },
445
+ "RateLimit-Limit": {
446
+ "$ref": "#/components/headers/RateLimit-Limit"
447
+ },
448
+ "RateLimit-Remaining": {
449
+ "$ref": "#/components/headers/RateLimit-Remaining"
450
+ },
451
+ "RateLimit-Reset": {
452
+ "$ref": "#/components/headers/RateLimit-Reset"
453
+ },
454
+ "RateLimit-Policy": {
455
+ "$ref": "#/components/headers/RateLimit-Policy"
456
+ },
457
+ "Idempotency-Key": {
458
+ "$ref": "#/components/headers/Idempotency-Key"
459
+ },
460
+ "Idempotency-Replay": {
461
+ "$ref": "#/components/headers/Idempotency-Replay"
462
+ }
463
+ },
464
+ "content": {
465
+ "application/json": {
466
+ "schema": {
467
+ "$ref": "#/components/schemas/ErrorDto"
468
+ }
469
+ }
470
+ }
471
+ },
472
+ "414": {
473
+ "description": "URI Too Long",
474
+ "content": {
475
+ "application/json": {
476
+ "schema": {
477
+ "$ref": "#/components/schemas/ErrorDto"
478
+ }
479
+ }
480
+ }
481
+ },
482
+ "415": {
483
+ "description": "Unsupported Media Type",
484
+ "headers": {
485
+ "Content-Type": {
486
+ "$ref": "#/components/headers/Content-Type"
487
+ },
488
+ "RateLimit-Limit": {
489
+ "$ref": "#/components/headers/RateLimit-Limit"
490
+ },
491
+ "RateLimit-Remaining": {
492
+ "$ref": "#/components/headers/RateLimit-Remaining"
493
+ },
494
+ "RateLimit-Reset": {
495
+ "$ref": "#/components/headers/RateLimit-Reset"
496
+ },
497
+ "RateLimit-Policy": {
498
+ "$ref": "#/components/headers/RateLimit-Policy"
499
+ },
500
+ "Idempotency-Key": {
501
+ "$ref": "#/components/headers/Idempotency-Key"
502
+ },
503
+ "Idempotency-Replay": {
504
+ "$ref": "#/components/headers/Idempotency-Replay"
505
+ }
506
+ },
507
+ "content": {
508
+ "application/json": {
509
+ "schema": {
510
+ "$ref": "#/components/schemas/ErrorDto"
511
+ }
512
+ }
513
+ }
514
+ },
515
+ "422": {
516
+ "description": "Unprocessable Entity",
517
+ "headers": {
518
+ "Content-Type": {
519
+ "$ref": "#/components/headers/Content-Type"
520
+ },
521
+ "RateLimit-Limit": {
522
+ "$ref": "#/components/headers/RateLimit-Limit"
523
+ },
524
+ "RateLimit-Remaining": {
525
+ "$ref": "#/components/headers/RateLimit-Remaining"
526
+ },
527
+ "RateLimit-Reset": {
528
+ "$ref": "#/components/headers/RateLimit-Reset"
529
+ },
530
+ "RateLimit-Policy": {
531
+ "$ref": "#/components/headers/RateLimit-Policy"
532
+ },
533
+ "Idempotency-Key": {
534
+ "$ref": "#/components/headers/Idempotency-Key"
535
+ },
536
+ "Idempotency-Replay": {
537
+ "$ref": "#/components/headers/Idempotency-Replay"
538
+ }
539
+ },
540
+ "content": {
541
+ "application/json": {
542
+ "schema": {
543
+ "$ref": "#/components/schemas/ValidationErrorDto"
544
+ }
545
+ }
546
+ }
547
+ },
548
+ "429": {
549
+ "description": "The client has sent too many requests in a given amount of time. ",
550
+ "headers": {
551
+ "Content-Type": {
552
+ "$ref": "#/components/headers/Content-Type"
553
+ },
554
+ "RateLimit-Limit": {
555
+ "$ref": "#/components/headers/RateLimit-Limit"
556
+ },
557
+ "RateLimit-Remaining": {
558
+ "$ref": "#/components/headers/RateLimit-Remaining"
559
+ },
560
+ "RateLimit-Reset": {
561
+ "$ref": "#/components/headers/RateLimit-Reset"
562
+ },
563
+ "RateLimit-Policy": {
564
+ "$ref": "#/components/headers/RateLimit-Policy"
565
+ },
566
+ "Idempotency-Key": {
567
+ "$ref": "#/components/headers/Idempotency-Key"
568
+ },
569
+ "Idempotency-Replay": {
570
+ "$ref": "#/components/headers/Idempotency-Replay"
571
+ },
572
+ "Retry-After": {
573
+ "$ref": "#/components/headers/Retry-After"
574
+ }
575
+ },
576
+ "content": {
577
+ "application/json": {
578
+ "schema": {
579
+ "type": "string",
580
+ "example": "API rate limit exceeded"
581
+ }
582
+ }
583
+ }
584
+ },
585
+ "500": {
586
+ "description": "Internal Server Error",
587
+ "headers": {
588
+ "Content-Type": {
589
+ "$ref": "#/components/headers/Content-Type"
590
+ },
591
+ "RateLimit-Limit": {
592
+ "$ref": "#/components/headers/RateLimit-Limit"
593
+ },
594
+ "RateLimit-Remaining": {
595
+ "$ref": "#/components/headers/RateLimit-Remaining"
596
+ },
597
+ "RateLimit-Reset": {
598
+ "$ref": "#/components/headers/RateLimit-Reset"
599
+ },
600
+ "RateLimit-Policy": {
601
+ "$ref": "#/components/headers/RateLimit-Policy"
602
+ },
603
+ "Idempotency-Key": {
604
+ "$ref": "#/components/headers/Idempotency-Key"
605
+ },
606
+ "Idempotency-Replay": {
607
+ "$ref": "#/components/headers/Idempotency-Replay"
608
+ }
609
+ },
610
+ "content": {
611
+ "application/json": {
612
+ "schema": {
613
+ "$ref": "#/components/schemas/ErrorDto"
614
+ }
615
+ }
616
+ }
617
+ },
618
+ "503": {
619
+ "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.",
620
+ "headers": {
621
+ "Content-Type": {
622
+ "$ref": "#/components/headers/Content-Type"
623
+ },
624
+ "RateLimit-Limit": {
625
+ "$ref": "#/components/headers/RateLimit-Limit"
626
+ },
627
+ "RateLimit-Remaining": {
628
+ "$ref": "#/components/headers/RateLimit-Remaining"
629
+ },
630
+ "RateLimit-Reset": {
631
+ "$ref": "#/components/headers/RateLimit-Reset"
632
+ },
633
+ "RateLimit-Policy": {
634
+ "$ref": "#/components/headers/RateLimit-Policy"
635
+ },
636
+ "Idempotency-Key": {
637
+ "$ref": "#/components/headers/Idempotency-Key"
638
+ },
639
+ "Idempotency-Replay": {
640
+ "$ref": "#/components/headers/Idempotency-Replay"
641
+ },
642
+ "Retry-After": {
643
+ "$ref": "#/components/headers/Retry-After"
644
+ }
645
+ },
646
+ "content": {
647
+ "application/json": {
648
+ "schema": {
649
+ "type": "string",
650
+ "example": "Please wait some time, then try again."
651
+ }
652
+ }
653
+ }
654
+ }
655
+ },
656
+ "tags": [
657
+ "Admin"
658
+ ],
659
+ "security": [
660
+ {
661
+ "api-key": []
662
+ }
663
+ ]
664
+ },
665
+ "get": {
666
+ "operationId": "HealthController_generateRandomNumber",
667
+ "x-speakeasy-name-override": "generateRandomNumber",
668
+ "parameters": [
669
+ {
670
+ "name": "idempotency-key",
671
+ "in": "header",
672
+ "description": "A header for idempotency purposes",
673
+ "required": false,
674
+ "schema": {
675
+ "type": "string"
676
+ }
677
+ }
678
+ ],
679
+ "responses": {
680
+ "201": {
681
+ "headers": {
682
+ "Content-Type": {
683
+ "$ref": "#/components/headers/Content-Type"
684
+ },
685
+ "RateLimit-Limit": {
686
+ "$ref": "#/components/headers/RateLimit-Limit"
687
+ },
688
+ "RateLimit-Remaining": {
689
+ "$ref": "#/components/headers/RateLimit-Remaining"
690
+ },
691
+ "RateLimit-Reset": {
692
+ "$ref": "#/components/headers/RateLimit-Reset"
693
+ },
694
+ "RateLimit-Policy": {
695
+ "$ref": "#/components/headers/RateLimit-Policy"
696
+ },
697
+ "Idempotency-Key": {
698
+ "$ref": "#/components/headers/Idempotency-Key"
699
+ },
700
+ "Idempotency-Replay": {
701
+ "$ref": "#/components/headers/Idempotency-Replay"
702
+ }
703
+ },
704
+ "description": "",
705
+ "content": {
706
+ "application/json": {
707
+ "schema": {
708
+ "$ref": "#/components/schemas/IdempotenceTestingResponse"
709
+ }
710
+ }
711
+ }
712
+ },
208
713
  "400": {
209
714
  "description": "Bad Request",
210
715
  "headers": {
@@ -24282,6 +24787,19 @@
24282
24787
  "expectedBehavior"
24283
24788
  ]
24284
24789
  },
24790
+ "IdempotenceTestingResponse": {
24791
+ "type": "object",
24792
+ "properties": {
24793
+ "number": {
24794
+ "type": "number",
24795
+ "description": "A unique number representing the idempotency response",
24796
+ "example": 1
24797
+ }
24798
+ },
24799
+ "required": [
24800
+ "number"
24801
+ ]
24802
+ },
24285
24803
  "TriggerEventResponseDto": {
24286
24804
  "type": "object",
24287
24805
  "properties": {