@novu/api 0.0.1-alpha.155 → 0.0.1-alpha.160

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 (67) hide show
  1. package/README.md +13 -0
  2. package/docs/sdks/admin/README.md +161 -0
  3. package/docs/sdks/novu/README.md +211 -1
  4. package/funcs/adminTestingControllerIdempotency.d.ts +11 -0
  5. package/funcs/adminTestingControllerIdempotency.d.ts.map +1 -0
  6. package/funcs/adminTestingControllerIdempotency.js +112 -0
  7. package/funcs/adminTestingControllerIdempotency.js.map +1 -0
  8. package/funcs/adminTestingControllerIdempotencyGet.d.ts +10 -0
  9. package/funcs/adminTestingControllerIdempotencyGet.d.ts.map +1 -0
  10. package/funcs/adminTestingControllerIdempotencyGet.js +109 -0
  11. package/funcs/adminTestingControllerIdempotencyGet.js.map +1 -0
  12. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts +8 -0
  13. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts.map +1 -0
  14. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js +91 -0
  15. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js.map +1 -0
  16. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts +8 -0
  17. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts.map +1 -0
  18. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js +91 -0
  19. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js.map +1 -0
  20. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts +8 -0
  21. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts.map +1 -0
  22. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js +91 -0
  23. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js.map +1 -0
  24. package/lib/config.d.ts +2 -2
  25. package/lib/config.js +2 -2
  26. package/models/components/idempotencybodydto.d.ts +29 -0
  27. package/models/components/idempotencybodydto.d.ts.map +1 -0
  28. package/models/components/idempotencybodydto.js +59 -0
  29. package/models/components/idempotencybodydto.js.map +1 -0
  30. package/models/components/index.d.ts +1 -0
  31. package/models/components/index.d.ts.map +1 -1
  32. package/models/components/index.js +1 -0
  33. package/models/components/index.js.map +1 -1
  34. package/models/operations/index.d.ts +2 -0
  35. package/models/operations/index.d.ts.map +1 -1
  36. package/models/operations/index.js +2 -0
  37. package/models/operations/index.js.map +1 -1
  38. package/models/operations/testingcontrolleridempotency.d.ts +64 -0
  39. package/models/operations/testingcontrolleridempotency.d.ts.map +1 -0
  40. package/models/operations/testingcontrolleridempotency.js +108 -0
  41. package/models/operations/testingcontrolleridempotency.js.map +1 -0
  42. package/models/operations/testingcontrolleridempotencyget.d.ts +61 -0
  43. package/models/operations/testingcontrolleridempotencyget.d.ts.map +1 -0
  44. package/models/operations/testingcontrolleridempotencyget.js +103 -0
  45. package/models/operations/testingcontrolleridempotencyget.js.map +1 -0
  46. package/package.json +1 -1
  47. package/sdk/admin.d.ts +8 -0
  48. package/sdk/admin.d.ts.map +1 -0
  49. package/sdk/admin.js +20 -0
  50. package/sdk/admin.js.map +1 -0
  51. package/sdk/sdk.d.ts +6 -0
  52. package/sdk/sdk.d.ts.map +1 -1
  53. package/sdk/sdk.js +16 -0
  54. package/sdk/sdk.js.map +1 -1
  55. package/src/funcs/adminTestingControllerIdempotency.ts +160 -0
  56. package/src/funcs/adminTestingControllerIdempotencyGet.ts +155 -0
  57. package/src/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.ts +114 -0
  58. package/src/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.ts +114 -0
  59. package/src/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.ts +114 -0
  60. package/src/lib/config.ts +2 -2
  61. package/src/models/components/idempotencybodydto.ts +66 -0
  62. package/src/models/components/index.ts +1 -0
  63. package/src/models/operations/index.ts +2 -0
  64. package/src/models/operations/testingcontrolleridempotency.ts +161 -0
  65. package/src/models/operations/testingcontrolleridempotencyget.ts +161 -0
  66. package/src/sdk/admin.ts +36 -0
  67. package/src/sdk/sdk.ts +40 -0
package/README.md CHANGED
@@ -218,6 +218,11 @@ run();
218
218
  <details open>
219
219
  <summary>Available methods</summary>
220
220
 
221
+ ### [admin](docs/sdks/admin/README.md)
222
+
223
+ * [testingControllerIdempotency](docs/sdks/admin/README.md#testingcontrolleridempotency)
224
+ * [testingControllerIdempotencyGet](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
225
+
221
226
  ### [integrations](docs/sdks/integrations/README.md)
222
227
 
223
228
  * [list](docs/sdks/integrations/README.md#list) - Get integrations
@@ -253,6 +258,9 @@ run();
253
258
  * [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
254
259
  * [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
255
260
  * [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
261
+ * [testApiRateLimitBulkControllerNoCategoryNoCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorynocostoverride)
262
+ * [testApiRateLimitBulkControllerNoCategorySingleCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorysinglecostoverride)
263
+ * [testApiRateLimitBulkControllerGlobalCategoryNoCostOverride](docs/sdks/novu/README.md#testapiratelimitbulkcontrollerglobalcategorynocostoverride)
256
264
 
257
265
  ### [subscribers](docs/sdks/subscribers/README.md)
258
266
 
@@ -328,6 +336,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
328
336
 
329
337
  <summary>Available standalone functions</summary>
330
338
 
339
+ - [`adminTestingControllerIdempotency`](docs/sdks/admin/README.md#testingcontrolleridempotency)
340
+ - [`adminTestingControllerIdempotencyGet`](docs/sdks/admin/README.md#testingcontrolleridempotencyget)
331
341
  - [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
332
342
  - [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create integration
333
343
  - [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete integration
@@ -364,6 +374,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
364
374
  - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
365
375
  - [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
366
376
  - [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
377
+ - [`testApiRateLimitBulkControllerGlobalCategoryNoCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollerglobalcategorynocostoverride)
378
+ - [`testApiRateLimitBulkControllerNoCategoryNoCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorynocostoverride)
379
+ - [`testApiRateLimitBulkControllerNoCategorySingleCostOverride`](docs/sdks/novu/README.md#testapiratelimitbulkcontrollernocategorysinglecostoverride)
367
380
  - [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
368
381
  - [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
369
382
  - [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered
@@ -0,0 +1,161 @@
1
+ # Admin
2
+ (*admin*)
3
+
4
+ ## Overview
5
+
6
+ testing
7
+ <https://docs.novu.co/platform/organizations>
8
+
9
+ ### Available Operations
10
+
11
+ * [testingControllerIdempotency](#testingcontrolleridempotency)
12
+ * [testingControllerIdempotencyGet](#testingcontrolleridempotencyget)
13
+
14
+ ## testingControllerIdempotency
15
+
16
+ ### Example Usage
17
+
18
+ ```typescript
19
+ import { Novu } from "@novu/api";
20
+
21
+ const novu = new Novu({
22
+ apiKey: "<YOUR_API_KEY_HERE>",
23
+ });
24
+
25
+ async function run() {
26
+ const result = await novu.admin.testingControllerIdempotency({
27
+ data: 6704.42,
28
+ });
29
+
30
+ // Handle the result
31
+ console.log(result);
32
+ }
33
+
34
+ run();
35
+ ```
36
+
37
+ ### Standalone function
38
+
39
+ The standalone function version of this method:
40
+
41
+ ```typescript
42
+ import { NovuCore } from "@novu/api/core.js";
43
+ import { adminTestingControllerIdempotency } from "@novu/api/funcs/adminTestingControllerIdempotency.js";
44
+
45
+ // Use `NovuCore` for best tree-shaking performance.
46
+ // You can create one instance of it to use across an application.
47
+ const novu = new NovuCore({
48
+ apiKey: "<YOUR_API_KEY_HERE>",
49
+ });
50
+
51
+ async function run() {
52
+ const res = await adminTestingControllerIdempotency(novu, {
53
+ data: 6704.42,
54
+ });
55
+
56
+ if (!res.ok) {
57
+ throw res.error;
58
+ }
59
+
60
+ const { value: result } = res;
61
+
62
+ // Handle the result
63
+ console.log(result);
64
+ }
65
+
66
+ run();
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Parameter | Type | Required | Description |
72
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
+ | `idempotencyBodyDto` | [components.IdempotencyBodyDto](../../models/components/idempotencybodydto.md) | :heavy_check_mark: | N/A |
74
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
75
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
76
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
77
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
78
+
79
+ ### Response
80
+
81
+ **Promise\<[operations.TestingControllerIdempotencyResponse](../../models/operations/testingcontrolleridempotencyresponse.md)\>**
82
+
83
+ ### Errors
84
+
85
+ | Error Type | Status Code | Content Type |
86
+ | ------------------------- | ------------------------- | ------------------------- |
87
+ | errors.ErrorDto | 400, 404, 409 | application/json |
88
+ | errors.ValidationErrorDto | 422 | application/json |
89
+ | errors.SDKError | 4XX, 5XX | \*/\* |
90
+
91
+ ## testingControllerIdempotencyGet
92
+
93
+ ### Example Usage
94
+
95
+ ```typescript
96
+ import { Novu } from "@novu/api";
97
+
98
+ const novu = new Novu({
99
+ apiKey: "<YOUR_API_KEY_HERE>",
100
+ });
101
+
102
+ async function run() {
103
+ const result = await novu.admin.testingControllerIdempotencyGet();
104
+
105
+ // Handle the result
106
+ console.log(result);
107
+ }
108
+
109
+ run();
110
+ ```
111
+
112
+ ### Standalone function
113
+
114
+ The standalone function version of this method:
115
+
116
+ ```typescript
117
+ import { NovuCore } from "@novu/api/core.js";
118
+ import { adminTestingControllerIdempotencyGet } from "@novu/api/funcs/adminTestingControllerIdempotencyGet.js";
119
+
120
+ // Use `NovuCore` for best tree-shaking performance.
121
+ // You can create one instance of it to use across an application.
122
+ const novu = new NovuCore({
123
+ apiKey: "<YOUR_API_KEY_HERE>",
124
+ });
125
+
126
+ async function run() {
127
+ const res = await adminTestingControllerIdempotencyGet(novu);
128
+
129
+ if (!res.ok) {
130
+ throw res.error;
131
+ }
132
+
133
+ const { value: result } = res;
134
+
135
+ // Handle the result
136
+ console.log(result);
137
+ }
138
+
139
+ run();
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ | Parameter | Type | Required | Description |
145
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
146
+ | `idempotencyKey` | *string* | :heavy_minus_sign: | A header for idempotency purposes |
147
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
148
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
149
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
150
+
151
+ ### Response
152
+
153
+ **Promise\<[operations.TestingControllerIdempotencyGetResponse](../../models/operations/testingcontrolleridempotencygetresponse.md)\>**
154
+
155
+ ### Errors
156
+
157
+ | Error Type | Status Code | Content Type |
158
+ | ------------------------- | ------------------------- | ------------------------- |
159
+ | errors.ErrorDto | 400, 404, 409 | application/json |
160
+ | errors.ValidationErrorDto | 422 | application/json |
161
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -13,6 +13,9 @@ Novu Documentation
13
13
  * [triggerBulk](#triggerbulk) - Bulk trigger event
14
14
  * [triggerBroadcast](#triggerbroadcast) - Broadcast event to all
15
15
  * [cancel](#cancel) - Cancel triggered event
16
+ * [testApiRateLimitBulkControllerNoCategoryNoCostOverride](#testapiratelimitbulkcontrollernocategorynocostoverride)
17
+ * [testApiRateLimitBulkControllerNoCategorySingleCostOverride](#testapiratelimitbulkcontrollernocategorysinglecostoverride)
18
+ * [testApiRateLimitBulkControllerGlobalCategoryNoCostOverride](#testapiratelimitbulkcontrollerglobalcategorynocostoverride)
16
19
 
17
20
  ## trigger
18
21
 
@@ -432,4 +435,211 @@ run();
432
435
  | ------------------------- | ------------------------- | ------------------------- |
433
436
  | errors.ErrorDto | 400, 404, 409 | application/json |
434
437
  | errors.ValidationErrorDto | 422 | application/json |
435
- | errors.SDKError | 4XX, 5XX | \*/\* |
438
+ | errors.SDKError | 4XX, 5XX | \*/\* |
439
+
440
+ ## testApiRateLimitBulkControllerNoCategoryNoCostOverride
441
+
442
+ ### Example Usage
443
+
444
+ ```typescript
445
+ import { Novu } from "@novu/api";
446
+
447
+ const novu = new Novu({
448
+ apiKey: "<YOUR_API_KEY_HERE>",
449
+ });
450
+
451
+ async function run() {
452
+ const result = await novu.testApiRateLimitBulkControllerNoCategoryNoCostOverride();
453
+
454
+ // Handle the result
455
+ console.log(result);
456
+ }
457
+
458
+ run();
459
+ ```
460
+
461
+ ### Standalone function
462
+
463
+ The standalone function version of this method:
464
+
465
+ ```typescript
466
+ import { NovuCore } from "@novu/api/core.js";
467
+ import { testApiRateLimitBulkControllerNoCategoryNoCostOverride } from "@novu/api/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js";
468
+
469
+ // Use `NovuCore` for best tree-shaking performance.
470
+ // You can create one instance of it to use across an application.
471
+ const novu = new NovuCore({
472
+ apiKey: "<YOUR_API_KEY_HERE>",
473
+ });
474
+
475
+ async function run() {
476
+ const res = await testApiRateLimitBulkControllerNoCategoryNoCostOverride(novu);
477
+
478
+ if (!res.ok) {
479
+ throw res.error;
480
+ }
481
+
482
+ const { value: result } = res;
483
+
484
+ // Handle the result
485
+ console.log(result);
486
+ }
487
+
488
+ run();
489
+ ```
490
+
491
+ ### Parameters
492
+
493
+ | Parameter | Type | Required | Description |
494
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
495
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
496
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
497
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
498
+
499
+ ### Response
500
+
501
+ **Promise\<[boolean](../../models/.md)\>**
502
+
503
+ ### Errors
504
+
505
+ | Error Type | Status Code | Content Type |
506
+ | --------------- | --------------- | --------------- |
507
+ | errors.SDKError | 4XX, 5XX | \*/\* |
508
+
509
+ ## testApiRateLimitBulkControllerNoCategorySingleCostOverride
510
+
511
+ ### Example Usage
512
+
513
+ ```typescript
514
+ import { Novu } from "@novu/api";
515
+
516
+ const novu = new Novu({
517
+ apiKey: "<YOUR_API_KEY_HERE>",
518
+ });
519
+
520
+ async function run() {
521
+ const result = await novu.testApiRateLimitBulkControllerNoCategorySingleCostOverride();
522
+
523
+ // Handle the result
524
+ console.log(result);
525
+ }
526
+
527
+ run();
528
+ ```
529
+
530
+ ### Standalone function
531
+
532
+ The standalone function version of this method:
533
+
534
+ ```typescript
535
+ import { NovuCore } from "@novu/api/core.js";
536
+ import { testApiRateLimitBulkControllerNoCategorySingleCostOverride } from "@novu/api/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js";
537
+
538
+ // Use `NovuCore` for best tree-shaking performance.
539
+ // You can create one instance of it to use across an application.
540
+ const novu = new NovuCore({
541
+ apiKey: "<YOUR_API_KEY_HERE>",
542
+ });
543
+
544
+ async function run() {
545
+ const res = await testApiRateLimitBulkControllerNoCategorySingleCostOverride(novu);
546
+
547
+ if (!res.ok) {
548
+ throw res.error;
549
+ }
550
+
551
+ const { value: result } = res;
552
+
553
+ // Handle the result
554
+ console.log(result);
555
+ }
556
+
557
+ run();
558
+ ```
559
+
560
+ ### Parameters
561
+
562
+ | Parameter | Type | Required | Description |
563
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
564
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
565
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
566
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
567
+
568
+ ### Response
569
+
570
+ **Promise\<[boolean](../../models/.md)\>**
571
+
572
+ ### Errors
573
+
574
+ | Error Type | Status Code | Content Type |
575
+ | --------------- | --------------- | --------------- |
576
+ | errors.SDKError | 4XX, 5XX | \*/\* |
577
+
578
+ ## testApiRateLimitBulkControllerGlobalCategoryNoCostOverride
579
+
580
+ ### Example Usage
581
+
582
+ ```typescript
583
+ import { Novu } from "@novu/api";
584
+
585
+ const novu = new Novu({
586
+ apiKey: "<YOUR_API_KEY_HERE>",
587
+ });
588
+
589
+ async function run() {
590
+ const result = await novu.testApiRateLimitBulkControllerGlobalCategoryNoCostOverride();
591
+
592
+ // Handle the result
593
+ console.log(result);
594
+ }
595
+
596
+ run();
597
+ ```
598
+
599
+ ### Standalone function
600
+
601
+ The standalone function version of this method:
602
+
603
+ ```typescript
604
+ import { NovuCore } from "@novu/api/core.js";
605
+ import { testApiRateLimitBulkControllerGlobalCategoryNoCostOverride } from "@novu/api/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js";
606
+
607
+ // Use `NovuCore` for best tree-shaking performance.
608
+ // You can create one instance of it to use across an application.
609
+ const novu = new NovuCore({
610
+ apiKey: "<YOUR_API_KEY_HERE>",
611
+ });
612
+
613
+ async function run() {
614
+ const res = await testApiRateLimitBulkControllerGlobalCategoryNoCostOverride(novu);
615
+
616
+ if (!res.ok) {
617
+ throw res.error;
618
+ }
619
+
620
+ const { value: result } = res;
621
+
622
+ // Handle the result
623
+ console.log(result);
624
+ }
625
+
626
+ run();
627
+ ```
628
+
629
+ ### Parameters
630
+
631
+ | Parameter | Type | Required | Description |
632
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
633
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
634
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
635
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
636
+
637
+ ### Response
638
+
639
+ **Promise\<[boolean](../../models/.md)\>**
640
+
641
+ ### Errors
642
+
643
+ | Error Type | Status Code | Content Type |
644
+ | --------------- | --------------- | --------------- |
645
+ | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,11 @@
1
+ import { NovuCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { Result } from "../types/fp.js";
10
+ export declare function adminTestingControllerIdempotency(client: NovuCore, idempotencyBodyDto: components.IdempotencyBodyDto, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<Result<operations.TestingControllerIdempotencyResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
11
+ //# sourceMappingURL=adminTestingControllerIdempotency.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adminTestingControllerIdempotency.d.ts","sourceRoot":"","sources":["../src/funcs/adminTestingControllerIdempotency.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAsB,iCAAiC,CACrD,MAAM,EAAE,QAAQ,EAChB,kBAAkB,EAAE,UAAU,CAAC,kBAAkB,EACjD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,oCAAoC,GAAG,SAAS,EACzD,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAoHA"}
@@ -0,0 +1,112 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.adminTestingControllerIdempotency = void 0;
30
+ const encodings_js_1 = require("../lib/encodings.js");
31
+ const M = __importStar(require("../lib/matchers.js"));
32
+ const schemas_js_1 = require("../lib/schemas.js");
33
+ const security_js_1 = require("../lib/security.js");
34
+ const url_js_1 = require("../lib/url.js");
35
+ const errors = __importStar(require("../models/errors/index.js"));
36
+ const operations = __importStar(require("../models/operations/index.js"));
37
+ async function adminTestingControllerIdempotency(client, idempotencyBodyDto, idempotencyKey, options) {
38
+ const input = {
39
+ idempotencyBodyDto: idempotencyBodyDto,
40
+ idempotencyKey: idempotencyKey,
41
+ };
42
+ const parsed = (0, schemas_js_1.safeParse)(input, (value) => operations.TestingControllerIdempotencyRequest$outboundSchema.parse(value), "Input validation failed");
43
+ if (!parsed.ok) {
44
+ return parsed;
45
+ }
46
+ const payload = parsed.value;
47
+ const body = (0, encodings_js_1.encodeJSON)("body", payload.IdempotencyBodyDto, {
48
+ explode: true,
49
+ });
50
+ const path = (0, url_js_1.pathToFunc)("/v1/testing/idempotency")();
51
+ const headers = new Headers({
52
+ "Content-Type": "application/json",
53
+ Accept: "application/json",
54
+ "Idempotency-Key": (0, encodings_js_1.encodeSimple)("Idempotency-Key", payload["Idempotency-Key"], { explode: false, charEncoding: "none" }),
55
+ });
56
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey);
57
+ const securityInput = secConfig == null ? {} : { apiKey: secConfig };
58
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
59
+ const context = {
60
+ operationID: "TestingController_idempotency",
61
+ oAuth2Scopes: [],
62
+ resolvedSecurity: requestSecurity,
63
+ securitySource: client._options.apiKey,
64
+ retryConfig: options?.retries
65
+ || client._options.retryConfig
66
+ || {
67
+ strategy: "backoff",
68
+ backoff: {
69
+ initialInterval: 1000,
70
+ maxInterval: 30000,
71
+ exponent: 1.5,
72
+ maxElapsedTime: 3600000,
73
+ },
74
+ retryConnectionErrors: true,
75
+ }
76
+ || { strategy: "none" },
77
+ retryCodes: options?.retryCodes || ["408", "422", "429", "5XX"],
78
+ };
79
+ const requestRes = client._createRequest(context, {
80
+ security: requestSecurity,
81
+ method: "POST",
82
+ baseURL: options?.serverURL,
83
+ path: path,
84
+ headers: headers,
85
+ body: body,
86
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
87
+ }, options);
88
+ if (!requestRes.ok) {
89
+ return requestRes;
90
+ }
91
+ const req = requestRes.value;
92
+ const doResult = await client._do(req, {
93
+ context,
94
+ errorCodes: ["400", "404", "409", "422", "429", "4XX", "503", "5XX"],
95
+ retryConfig: context.retryConfig,
96
+ retryCodes: context.retryCodes,
97
+ });
98
+ if (!doResult.ok) {
99
+ return doResult;
100
+ }
101
+ const response = doResult.value;
102
+ const responseFields = {
103
+ HttpMeta: { Response: response, Request: req },
104
+ };
105
+ const [result] = await M.match(M.nil(201, operations.TestingControllerIdempotencyResponse$inboundSchema.optional()), M.jsonErr([400, 404, 409], errors.ErrorDto$inboundSchema, { hdrs: true }), M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }), M.fail([429, 503]), M.fail(["4XX", "5XX"]))(response, { extraFields: responseFields });
106
+ if (!result.ok) {
107
+ return result;
108
+ }
109
+ return result;
110
+ }
111
+ exports.adminTestingControllerIdempotency = adminTestingControllerIdempotency;
112
+ //# sourceMappingURL=adminTestingControllerIdempotency.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adminTestingControllerIdempotency.js","sourceRoot":"","sources":["../src/funcs/adminTestingControllerIdempotency.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAA+D;AAC/D,sDAAwC;AACxC,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,kEAAoD;AAGpD,0EAA4D;AAGrD,KAAK,UAAU,iCAAiC,CACrD,MAAgB,EAChB,kBAAiD,EACjD,cAAmC,EACnC,OAAwB;IAexB,MAAM,KAAK,GAAmD;QAC5D,kBAAkB,EAAE,kBAAkB;QACtC,cAAc,EAAE,cAAc;KAC/B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,kDAAkD,CAAC,KAAK,CACjE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,EAAE;QAC1D,OAAO,EAAE,IAAI;KACd,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,yBAAyB,CAAC,EAAE,CAAC;IAErD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC;QAC1B,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,IAAA,2BAAY,EAC7B,iBAAiB,EACjB,OAAO,CAAC,iBAAiB,CAAC,EAC1B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,+BAA+B;QAC5C,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B;gBACD,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE;oBACP,eAAe,EAAE,IAAI;oBACrB,WAAW,EAAE,KAAK;oBAClB,QAAQ,EAAE,GAAG;oBACb,cAAc,EAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE,IAAI;aAC5B;eACE,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KAChE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACpE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,GAAG,CACH,GAAG,EACH,UAAU,CAAC,kDAAkD,CAAC,QAAQ,EAAE,CACzE,EACD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,sBAAsB,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACzE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,gCAAgC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EACvE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,EAClB,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CACvB,CAAC,QAAQ,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAC7C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAtID,8EAsIC"}
@@ -0,0 +1,10 @@
1
+ import { NovuCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
+ import * as errors from "../models/errors/index.js";
5
+ import { SDKError } from "../models/errors/sdkerror.js";
6
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
+ import * as operations from "../models/operations/index.js";
8
+ import { Result } from "../types/fp.js";
9
+ export declare function adminTestingControllerIdempotencyGet(client: NovuCore, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<Result<operations.TestingControllerIdempotencyGetResponse | undefined, errors.ErrorDto | errors.ValidationErrorDto | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
10
+ //# sourceMappingURL=adminTestingControllerIdempotencyGet.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adminTestingControllerIdempotencyGet.d.ts","sourceRoot":"","sources":["../src/funcs/adminTestingControllerIdempotencyGet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAsB,oCAAoC,CACxD,MAAM,EAAE,QAAQ,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,uCAAuC,GAAG,SAAS,EAC5D,MAAM,CAAC,QAAQ,GACf,MAAM,CAAC,kBAAkB,GACzB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAiHA"}