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

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 (211) hide show
  1. package/README.md +14 -1
  2. package/docs/sdks/admin/README.md +161 -0
  3. package/docs/sdks/credentials/README.md +27 -39
  4. package/docs/sdks/integrations/README.md +5 -9
  5. package/docs/sdks/messages/README.md +5 -7
  6. package/docs/sdks/novu/README.md +211 -1
  7. package/docs/sdks/novumessages/README.md +16 -24
  8. package/docs/sdks/novusubscribers/README.md +33 -45
  9. package/docs/sdks/preferences/README.md +10 -16
  10. package/docs/sdks/properties/README.md +7 -11
  11. package/docs/sdks/subscribers/README.md +43 -47
  12. package/docs/sdks/topics/README.md +7 -11
  13. package/funcs/adminTestingControllerIdempotency.d.ts +11 -0
  14. package/funcs/adminTestingControllerIdempotency.d.ts.map +1 -0
  15. package/funcs/adminTestingControllerIdempotency.js +115 -0
  16. package/funcs/adminTestingControllerIdempotency.js.map +1 -0
  17. package/funcs/adminTestingControllerIdempotencyGet.d.ts +10 -0
  18. package/funcs/adminTestingControllerIdempotencyGet.d.ts.map +1 -0
  19. package/funcs/adminTestingControllerIdempotencyGet.js +108 -0
  20. package/funcs/adminTestingControllerIdempotencyGet.js.map +1 -0
  21. package/funcs/integrationsUpdate.d.ts +2 -1
  22. package/funcs/integrationsUpdate.d.ts.map +1 -1
  23. package/funcs/integrationsUpdate.js +7 -2
  24. package/funcs/integrationsUpdate.js.map +1 -1
  25. package/funcs/messagesDeleteByTransactionId.d.ts +1 -1
  26. package/funcs/messagesDeleteByTransactionId.d.ts.map +1 -1
  27. package/funcs/messagesDeleteByTransactionId.js +7 -2
  28. package/funcs/messagesDeleteByTransactionId.js.map +1 -1
  29. package/funcs/subscribersCredentialsAppend.d.ts +2 -1
  30. package/funcs/subscribersCredentialsAppend.d.ts.map +1 -1
  31. package/funcs/subscribersCredentialsAppend.js +7 -2
  32. package/funcs/subscribersCredentialsAppend.js.map +1 -1
  33. package/funcs/subscribersCredentialsDelete.d.ts +1 -1
  34. package/funcs/subscribersCredentialsDelete.d.ts.map +1 -1
  35. package/funcs/subscribersCredentialsDelete.js +7 -2
  36. package/funcs/subscribersCredentialsDelete.js.map +1 -1
  37. package/funcs/subscribersCredentialsUpdate.d.ts +2 -1
  38. package/funcs/subscribersCredentialsUpdate.d.ts.map +1 -1
  39. package/funcs/subscribersCredentialsUpdate.js +7 -2
  40. package/funcs/subscribersCredentialsUpdate.js.map +1 -1
  41. package/funcs/subscribersList.d.ts +1 -1
  42. package/funcs/subscribersList.d.ts.map +1 -1
  43. package/funcs/subscribersList.js +12 -10
  44. package/funcs/subscribersList.js.map +1 -1
  45. package/funcs/subscribersMessagesMarkAll.d.ts +2 -1
  46. package/funcs/subscribersMessagesMarkAll.d.ts.map +1 -1
  47. package/funcs/subscribersMessagesMarkAll.js +7 -2
  48. package/funcs/subscribersMessagesMarkAll.js.map +1 -1
  49. package/funcs/subscribersMessagesMarkAllAs.d.ts +2 -1
  50. package/funcs/subscribersMessagesMarkAllAs.d.ts.map +1 -1
  51. package/funcs/subscribersMessagesMarkAllAs.js +7 -2
  52. package/funcs/subscribersMessagesMarkAllAs.js.map +1 -1
  53. package/funcs/subscribersPreferencesList.d.ts +1 -1
  54. package/funcs/subscribersPreferencesList.d.ts.map +1 -1
  55. package/funcs/subscribersPreferencesList.js +7 -2
  56. package/funcs/subscribersPreferencesList.js.map +1 -1
  57. package/funcs/subscribersPreferencesUpdateGlobal.d.ts +2 -1
  58. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +1 -1
  59. package/funcs/subscribersPreferencesUpdateGlobal.js +7 -2
  60. package/funcs/subscribersPreferencesUpdateGlobal.js.map +1 -1
  61. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts +2 -1
  62. package/funcs/subscribersPropertiesUpdateOnlineFlag.d.ts.map +1 -1
  63. package/funcs/subscribersPropertiesUpdateOnlineFlag.js +7 -2
  64. package/funcs/subscribersPropertiesUpdateOnlineFlag.js.map +1 -1
  65. package/funcs/subscribersRetrieve.d.ts +1 -1
  66. package/funcs/subscribersRetrieve.d.ts.map +1 -1
  67. package/funcs/subscribersRetrieve.js +7 -2
  68. package/funcs/subscribersRetrieve.js.map +1 -1
  69. package/funcs/subscribersUpdate.d.ts +2 -1
  70. package/funcs/subscribersUpdate.d.ts.map +1 -1
  71. package/funcs/subscribersUpdate.js +7 -2
  72. package/funcs/subscribersUpdate.js.map +1 -1
  73. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts +8 -0
  74. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.d.ts.map +1 -0
  75. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js +91 -0
  76. package/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.js.map +1 -0
  77. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts +8 -0
  78. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.d.ts.map +1 -0
  79. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js +91 -0
  80. package/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.js.map +1 -0
  81. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts +8 -0
  82. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.d.ts.map +1 -0
  83. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js +91 -0
  84. package/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.js.map +1 -0
  85. package/funcs/topicsRename.d.ts +2 -1
  86. package/funcs/topicsRename.d.ts.map +1 -1
  87. package/funcs/topicsRename.js +7 -2
  88. package/funcs/topicsRename.js.map +1 -1
  89. package/funcs/topicsSubscribersAssign.d.ts +2 -1
  90. package/funcs/topicsSubscribersAssign.d.ts.map +1 -1
  91. package/funcs/topicsSubscribersAssign.js +7 -2
  92. package/funcs/topicsSubscribersAssign.js.map +1 -1
  93. package/funcs/topicsSubscribersRemove.d.ts +2 -1
  94. package/funcs/topicsSubscribersRemove.d.ts.map +1 -1
  95. package/funcs/topicsSubscribersRemove.js +7 -2
  96. package/funcs/topicsSubscribersRemove.js.map +1 -1
  97. package/funcs/topicsSubscribersRetrieve.d.ts +1 -1
  98. package/funcs/topicsSubscribersRetrieve.d.ts.map +1 -1
  99. package/funcs/topicsSubscribersRetrieve.js +7 -2
  100. package/funcs/topicsSubscribersRetrieve.js.map +1 -1
  101. package/lib/config.d.ts +2 -2
  102. package/lib/config.js +2 -2
  103. package/models/components/idempotencybodydto.d.ts +29 -0
  104. package/models/components/idempotencybodydto.d.ts.map +1 -0
  105. package/models/components/idempotencybodydto.js +59 -0
  106. package/models/components/idempotencybodydto.js.map +1 -0
  107. package/models/components/idempotencyresponse.d.ts +25 -0
  108. package/models/components/idempotencyresponse.d.ts.map +1 -0
  109. package/models/components/idempotencyresponse.js +55 -0
  110. package/models/components/idempotencyresponse.js.map +1 -0
  111. package/models/components/index.d.ts +2 -0
  112. package/models/components/index.d.ts.map +1 -1
  113. package/models/components/index.js +2 -0
  114. package/models/components/index.js.map +1 -1
  115. package/models/operations/index.d.ts +2 -0
  116. package/models/operations/index.d.ts.map +1 -1
  117. package/models/operations/index.js +2 -0
  118. package/models/operations/index.js.map +1 -1
  119. package/models/operations/testingcontrolleridempotency.d.ts +66 -0
  120. package/models/operations/testingcontrolleridempotency.d.ts.map +1 -0
  121. package/models/operations/testingcontrolleridempotency.js +112 -0
  122. package/models/operations/testingcontrolleridempotency.js.map +1 -0
  123. package/models/operations/testingcontrolleridempotencyget.d.ts +64 -0
  124. package/models/operations/testingcontrolleridempotencyget.d.ts.map +1 -0
  125. package/models/operations/testingcontrolleridempotencyget.js +108 -0
  126. package/models/operations/testingcontrolleridempotencyget.js.map +1 -0
  127. package/package.json +1 -1
  128. package/sdk/admin.d.ts +8 -0
  129. package/sdk/admin.d.ts.map +1 -0
  130. package/sdk/admin.js +20 -0
  131. package/sdk/admin.js.map +1 -0
  132. package/sdk/credentials.d.ts +4 -3
  133. package/sdk/credentials.d.ts.map +1 -1
  134. package/sdk/credentials.js +6 -6
  135. package/sdk/credentials.js.map +1 -1
  136. package/sdk/integrations.d.ts +1 -1
  137. package/sdk/integrations.d.ts.map +1 -1
  138. package/sdk/integrations.js +2 -2
  139. package/sdk/integrations.js.map +1 -1
  140. package/sdk/messages.d.ts +1 -1
  141. package/sdk/messages.d.ts.map +1 -1
  142. package/sdk/messages.js +2 -2
  143. package/sdk/messages.js.map +1 -1
  144. package/sdk/novumessages.d.ts +3 -2
  145. package/sdk/novumessages.d.ts.map +1 -1
  146. package/sdk/novumessages.js +4 -4
  147. package/sdk/novumessages.js.map +1 -1
  148. package/sdk/novusubscribers.d.ts +4 -3
  149. package/sdk/novusubscribers.d.ts.map +1 -1
  150. package/sdk/novusubscribers.js +6 -6
  151. package/sdk/novusubscribers.js.map +1 -1
  152. package/sdk/preferences.d.ts +3 -2
  153. package/sdk/preferences.d.ts.map +1 -1
  154. package/sdk/preferences.js +4 -4
  155. package/sdk/preferences.js.map +1 -1
  156. package/sdk/properties.d.ts +2 -1
  157. package/sdk/properties.d.ts.map +1 -1
  158. package/sdk/properties.js +2 -2
  159. package/sdk/properties.js.map +1 -1
  160. package/sdk/sdk.d.ts +6 -0
  161. package/sdk/sdk.d.ts.map +1 -1
  162. package/sdk/sdk.js +16 -0
  163. package/sdk/sdk.js.map +1 -1
  164. package/sdk/subscribers.d.ts +3 -3
  165. package/sdk/subscribers.d.ts.map +1 -1
  166. package/sdk/subscribers.js +6 -6
  167. package/sdk/subscribers.js.map +1 -1
  168. package/sdk/topics.d.ts +1 -1
  169. package/sdk/topics.d.ts.map +1 -1
  170. package/sdk/topics.js +2 -2
  171. package/sdk/topics.js.map +1 -1
  172. package/src/funcs/adminTestingControllerIdempotency.ts +160 -0
  173. package/src/funcs/adminTestingControllerIdempotencyGet.ts +155 -0
  174. package/src/funcs/integrationsUpdate.ts +11 -2
  175. package/src/funcs/messagesDeleteByTransactionId.ts +11 -2
  176. package/src/funcs/subscribersCredentialsAppend.ts +13 -2
  177. package/src/funcs/subscribersCredentialsDelete.ts +11 -2
  178. package/src/funcs/subscribersCredentialsUpdate.ts +13 -2
  179. package/src/funcs/subscribersList.ts +17 -10
  180. package/src/funcs/subscribersMessagesMarkAll.ts +11 -2
  181. package/src/funcs/subscribersMessagesMarkAllAs.ts +11 -2
  182. package/src/funcs/subscribersPreferencesList.ts +11 -2
  183. package/src/funcs/subscribersPreferencesUpdateGlobal.ts +14 -3
  184. package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts +14 -2
  185. package/src/funcs/subscribersRetrieve.ts +10 -2
  186. package/src/funcs/subscribersUpdate.ts +11 -2
  187. package/src/funcs/testApiRateLimitBulkControllerGlobalCategoryNoCostOverride.ts +114 -0
  188. package/src/funcs/testApiRateLimitBulkControllerNoCategoryNoCostOverride.ts +114 -0
  189. package/src/funcs/testApiRateLimitBulkControllerNoCategorySingleCostOverride.ts +114 -0
  190. package/src/funcs/topicsRename.ts +11 -2
  191. package/src/funcs/topicsSubscribersAssign.ts +11 -2
  192. package/src/funcs/topicsSubscribersRemove.ts +11 -2
  193. package/src/funcs/topicsSubscribersRetrieve.ts +10 -2
  194. package/src/lib/config.ts +2 -2
  195. package/src/models/components/idempotencybodydto.ts +66 -0
  196. package/src/models/components/idempotencyresponse.ts +58 -0
  197. package/src/models/components/index.ts +2 -0
  198. package/src/models/operations/index.ts +2 -0
  199. package/src/models/operations/testingcontrolleridempotency.ts +167 -0
  200. package/src/models/operations/testingcontrolleridempotencyget.ts +168 -0
  201. package/src/sdk/admin.ts +36 -0
  202. package/src/sdk/credentials.ts +21 -6
  203. package/src/sdk/integrations.ts +6 -2
  204. package/src/sdk/messages.ts +6 -2
  205. package/src/sdk/novumessages.ts +13 -4
  206. package/src/sdk/novusubscribers.ts +19 -6
  207. package/src/sdk/preferences.ts +14 -5
  208. package/src/sdk/properties.ts +8 -2
  209. package/src/sdk/sdk.ts +40 -0
  210. package/src/sdk/subscribers.ts +18 -6
  211. package/src/sdk/topics.ts +6 -2
@@ -0,0 +1,167 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type TestingControllerIdempotencyRequest = {
13
+ /**
14
+ * A header for idempotency purposes
15
+ */
16
+ idempotencyKey?: string | undefined;
17
+ idempotencyBodyDto: components.IdempotencyBodyDto;
18
+ };
19
+
20
+ export type TestingControllerIdempotencyResponse = {
21
+ headers: { [k: string]: Array<string> };
22
+ result: components.IdempotencyResponse;
23
+ };
24
+
25
+ /** @internal */
26
+ export const TestingControllerIdempotencyRequest$inboundSchema: z.ZodType<
27
+ TestingControllerIdempotencyRequest,
28
+ z.ZodTypeDef,
29
+ unknown
30
+ > = z.object({
31
+ "Idempotency-Key": z.string().optional(),
32
+ IdempotencyBodyDto: components.IdempotencyBodyDto$inboundSchema,
33
+ }).transform((v) => {
34
+ return remap$(v, {
35
+ "Idempotency-Key": "idempotencyKey",
36
+ "IdempotencyBodyDto": "idempotencyBodyDto",
37
+ });
38
+ });
39
+
40
+ /** @internal */
41
+ export type TestingControllerIdempotencyRequest$Outbound = {
42
+ "Idempotency-Key"?: string | undefined;
43
+ IdempotencyBodyDto: components.IdempotencyBodyDto$Outbound;
44
+ };
45
+
46
+ /** @internal */
47
+ export const TestingControllerIdempotencyRequest$outboundSchema: z.ZodType<
48
+ TestingControllerIdempotencyRequest$Outbound,
49
+ z.ZodTypeDef,
50
+ TestingControllerIdempotencyRequest
51
+ > = z.object({
52
+ idempotencyKey: z.string().optional(),
53
+ idempotencyBodyDto: components.IdempotencyBodyDto$outboundSchema,
54
+ }).transform((v) => {
55
+ return remap$(v, {
56
+ idempotencyKey: "Idempotency-Key",
57
+ idempotencyBodyDto: "IdempotencyBodyDto",
58
+ });
59
+ });
60
+
61
+ /**
62
+ * @internal
63
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
64
+ */
65
+ export namespace TestingControllerIdempotencyRequest$ {
66
+ /** @deprecated use `TestingControllerIdempotencyRequest$inboundSchema` instead. */
67
+ export const inboundSchema =
68
+ TestingControllerIdempotencyRequest$inboundSchema;
69
+ /** @deprecated use `TestingControllerIdempotencyRequest$outboundSchema` instead. */
70
+ export const outboundSchema =
71
+ TestingControllerIdempotencyRequest$outboundSchema;
72
+ /** @deprecated use `TestingControllerIdempotencyRequest$Outbound` instead. */
73
+ export type Outbound = TestingControllerIdempotencyRequest$Outbound;
74
+ }
75
+
76
+ export function testingControllerIdempotencyRequestToJSON(
77
+ testingControllerIdempotencyRequest: TestingControllerIdempotencyRequest,
78
+ ): string {
79
+ return JSON.stringify(
80
+ TestingControllerIdempotencyRequest$outboundSchema.parse(
81
+ testingControllerIdempotencyRequest,
82
+ ),
83
+ );
84
+ }
85
+
86
+ export function testingControllerIdempotencyRequestFromJSON(
87
+ jsonString: string,
88
+ ): SafeParseResult<TestingControllerIdempotencyRequest, SDKValidationError> {
89
+ return safeParse(
90
+ jsonString,
91
+ (x) =>
92
+ TestingControllerIdempotencyRequest$inboundSchema.parse(JSON.parse(x)),
93
+ `Failed to parse 'TestingControllerIdempotencyRequest' from JSON`,
94
+ );
95
+ }
96
+
97
+ /** @internal */
98
+ export const TestingControllerIdempotencyResponse$inboundSchema: z.ZodType<
99
+ TestingControllerIdempotencyResponse,
100
+ z.ZodTypeDef,
101
+ unknown
102
+ > = z.object({
103
+ Headers: z.record(z.array(z.string())),
104
+ Result: components.IdempotencyResponse$inboundSchema,
105
+ }).transform((v) => {
106
+ return remap$(v, {
107
+ "Headers": "headers",
108
+ "Result": "result",
109
+ });
110
+ });
111
+
112
+ /** @internal */
113
+ export type TestingControllerIdempotencyResponse$Outbound = {
114
+ Headers: { [k: string]: Array<string> };
115
+ Result: components.IdempotencyResponse$Outbound;
116
+ };
117
+
118
+ /** @internal */
119
+ export const TestingControllerIdempotencyResponse$outboundSchema: z.ZodType<
120
+ TestingControllerIdempotencyResponse$Outbound,
121
+ z.ZodTypeDef,
122
+ TestingControllerIdempotencyResponse
123
+ > = z.object({
124
+ headers: z.record(z.array(z.string())),
125
+ result: components.IdempotencyResponse$outboundSchema,
126
+ }).transform((v) => {
127
+ return remap$(v, {
128
+ headers: "Headers",
129
+ result: "Result",
130
+ });
131
+ });
132
+
133
+ /**
134
+ * @internal
135
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
136
+ */
137
+ export namespace TestingControllerIdempotencyResponse$ {
138
+ /** @deprecated use `TestingControllerIdempotencyResponse$inboundSchema` instead. */
139
+ export const inboundSchema =
140
+ TestingControllerIdempotencyResponse$inboundSchema;
141
+ /** @deprecated use `TestingControllerIdempotencyResponse$outboundSchema` instead. */
142
+ export const outboundSchema =
143
+ TestingControllerIdempotencyResponse$outboundSchema;
144
+ /** @deprecated use `TestingControllerIdempotencyResponse$Outbound` instead. */
145
+ export type Outbound = TestingControllerIdempotencyResponse$Outbound;
146
+ }
147
+
148
+ export function testingControllerIdempotencyResponseToJSON(
149
+ testingControllerIdempotencyResponse: TestingControllerIdempotencyResponse,
150
+ ): string {
151
+ return JSON.stringify(
152
+ TestingControllerIdempotencyResponse$outboundSchema.parse(
153
+ testingControllerIdempotencyResponse,
154
+ ),
155
+ );
156
+ }
157
+
158
+ export function testingControllerIdempotencyResponseFromJSON(
159
+ jsonString: string,
160
+ ): SafeParseResult<TestingControllerIdempotencyResponse, SDKValidationError> {
161
+ return safeParse(
162
+ jsonString,
163
+ (x) =>
164
+ TestingControllerIdempotencyResponse$inboundSchema.parse(JSON.parse(x)),
165
+ `Failed to parse 'TestingControllerIdempotencyResponse' from JSON`,
166
+ );
167
+ }
@@ -0,0 +1,168 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type TestingControllerIdempotencyGetRequest = {
13
+ /**
14
+ * A header for idempotency purposes
15
+ */
16
+ idempotencyKey?: string | undefined;
17
+ };
18
+
19
+ export type TestingControllerIdempotencyGetResponse = {
20
+ headers: { [k: string]: Array<string> };
21
+ result: components.IdempotencyResponse;
22
+ };
23
+
24
+ /** @internal */
25
+ export const TestingControllerIdempotencyGetRequest$inboundSchema: z.ZodType<
26
+ TestingControllerIdempotencyGetRequest,
27
+ z.ZodTypeDef,
28
+ unknown
29
+ > = z.object({
30
+ "Idempotency-Key": z.string().optional(),
31
+ }).transform((v) => {
32
+ return remap$(v, {
33
+ "Idempotency-Key": "idempotencyKey",
34
+ });
35
+ });
36
+
37
+ /** @internal */
38
+ export type TestingControllerIdempotencyGetRequest$Outbound = {
39
+ "Idempotency-Key"?: string | undefined;
40
+ };
41
+
42
+ /** @internal */
43
+ export const TestingControllerIdempotencyGetRequest$outboundSchema: z.ZodType<
44
+ TestingControllerIdempotencyGetRequest$Outbound,
45
+ z.ZodTypeDef,
46
+ TestingControllerIdempotencyGetRequest
47
+ > = z.object({
48
+ idempotencyKey: z.string().optional(),
49
+ }).transform((v) => {
50
+ return remap$(v, {
51
+ idempotencyKey: "Idempotency-Key",
52
+ });
53
+ });
54
+
55
+ /**
56
+ * @internal
57
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
58
+ */
59
+ export namespace TestingControllerIdempotencyGetRequest$ {
60
+ /** @deprecated use `TestingControllerIdempotencyGetRequest$inboundSchema` instead. */
61
+ export const inboundSchema =
62
+ TestingControllerIdempotencyGetRequest$inboundSchema;
63
+ /** @deprecated use `TestingControllerIdempotencyGetRequest$outboundSchema` instead. */
64
+ export const outboundSchema =
65
+ TestingControllerIdempotencyGetRequest$outboundSchema;
66
+ /** @deprecated use `TestingControllerIdempotencyGetRequest$Outbound` instead. */
67
+ export type Outbound = TestingControllerIdempotencyGetRequest$Outbound;
68
+ }
69
+
70
+ export function testingControllerIdempotencyGetRequestToJSON(
71
+ testingControllerIdempotencyGetRequest:
72
+ TestingControllerIdempotencyGetRequest,
73
+ ): string {
74
+ return JSON.stringify(
75
+ TestingControllerIdempotencyGetRequest$outboundSchema.parse(
76
+ testingControllerIdempotencyGetRequest,
77
+ ),
78
+ );
79
+ }
80
+
81
+ export function testingControllerIdempotencyGetRequestFromJSON(
82
+ jsonString: string,
83
+ ): SafeParseResult<TestingControllerIdempotencyGetRequest, SDKValidationError> {
84
+ return safeParse(
85
+ jsonString,
86
+ (x) =>
87
+ TestingControllerIdempotencyGetRequest$inboundSchema.parse(JSON.parse(x)),
88
+ `Failed to parse 'TestingControllerIdempotencyGetRequest' from JSON`,
89
+ );
90
+ }
91
+
92
+ /** @internal */
93
+ export const TestingControllerIdempotencyGetResponse$inboundSchema: z.ZodType<
94
+ TestingControllerIdempotencyGetResponse,
95
+ z.ZodTypeDef,
96
+ unknown
97
+ > = z.object({
98
+ Headers: z.record(z.array(z.string())),
99
+ Result: components.IdempotencyResponse$inboundSchema,
100
+ }).transform((v) => {
101
+ return remap$(v, {
102
+ "Headers": "headers",
103
+ "Result": "result",
104
+ });
105
+ });
106
+
107
+ /** @internal */
108
+ export type TestingControllerIdempotencyGetResponse$Outbound = {
109
+ Headers: { [k: string]: Array<string> };
110
+ Result: components.IdempotencyResponse$Outbound;
111
+ };
112
+
113
+ /** @internal */
114
+ export const TestingControllerIdempotencyGetResponse$outboundSchema: z.ZodType<
115
+ TestingControllerIdempotencyGetResponse$Outbound,
116
+ z.ZodTypeDef,
117
+ TestingControllerIdempotencyGetResponse
118
+ > = z.object({
119
+ headers: z.record(z.array(z.string())),
120
+ result: components.IdempotencyResponse$outboundSchema,
121
+ }).transform((v) => {
122
+ return remap$(v, {
123
+ headers: "Headers",
124
+ result: "Result",
125
+ });
126
+ });
127
+
128
+ /**
129
+ * @internal
130
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
131
+ */
132
+ export namespace TestingControllerIdempotencyGetResponse$ {
133
+ /** @deprecated use `TestingControllerIdempotencyGetResponse$inboundSchema` instead. */
134
+ export const inboundSchema =
135
+ TestingControllerIdempotencyGetResponse$inboundSchema;
136
+ /** @deprecated use `TestingControllerIdempotencyGetResponse$outboundSchema` instead. */
137
+ export const outboundSchema =
138
+ TestingControllerIdempotencyGetResponse$outboundSchema;
139
+ /** @deprecated use `TestingControllerIdempotencyGetResponse$Outbound` instead. */
140
+ export type Outbound = TestingControllerIdempotencyGetResponse$Outbound;
141
+ }
142
+
143
+ export function testingControllerIdempotencyGetResponseToJSON(
144
+ testingControllerIdempotencyGetResponse:
145
+ TestingControllerIdempotencyGetResponse,
146
+ ): string {
147
+ return JSON.stringify(
148
+ TestingControllerIdempotencyGetResponse$outboundSchema.parse(
149
+ testingControllerIdempotencyGetResponse,
150
+ ),
151
+ );
152
+ }
153
+
154
+ export function testingControllerIdempotencyGetResponseFromJSON(
155
+ jsonString: string,
156
+ ): SafeParseResult<
157
+ TestingControllerIdempotencyGetResponse,
158
+ SDKValidationError
159
+ > {
160
+ return safeParse(
161
+ jsonString,
162
+ (x) =>
163
+ TestingControllerIdempotencyGetResponse$inboundSchema.parse(
164
+ JSON.parse(x),
165
+ ),
166
+ `Failed to parse 'TestingControllerIdempotencyGetResponse' from JSON`,
167
+ );
168
+ }
@@ -0,0 +1,36 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { adminTestingControllerIdempotency } from "../funcs/adminTestingControllerIdempotency.js";
6
+ import { adminTestingControllerIdempotencyGet } from "../funcs/adminTestingControllerIdempotencyGet.js";
7
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
8
+ import * as components from "../models/components/index.js";
9
+ import * as operations from "../models/operations/index.js";
10
+ import { unwrapAsync } from "../types/fp.js";
11
+
12
+ export class Admin extends ClientSDK {
13
+ async testingControllerIdempotency(
14
+ idempotencyBodyDto: components.IdempotencyBodyDto,
15
+ idempotencyKey?: string | undefined,
16
+ options?: RequestOptions,
17
+ ): Promise<operations.TestingControllerIdempotencyResponse> {
18
+ return unwrapAsync(adminTestingControllerIdempotency(
19
+ this,
20
+ idempotencyBodyDto,
21
+ idempotencyKey,
22
+ options,
23
+ ));
24
+ }
25
+
26
+ async testingControllerIdempotencyGet(
27
+ idempotencyKey?: string | undefined,
28
+ options?: RequestOptions,
29
+ ): Promise<operations.TestingControllerIdempotencyGetResponse> {
30
+ return unwrapAsync(adminTestingControllerIdempotencyGet(
31
+ this,
32
+ idempotencyKey,
33
+ options,
34
+ ));
35
+ }
36
+ }
@@ -6,6 +6,7 @@ import { subscribersCredentialsAppend } from "../funcs/subscribersCredentialsApp
6
6
  import { subscribersCredentialsDelete } from "../funcs/subscribersCredentialsDelete.js";
7
7
  import { subscribersCredentialsUpdate } from "../funcs/subscribersCredentialsUpdate.js";
8
8
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
9
+ import * as components from "../models/components/index.js";
9
10
  import * as operations from "../models/operations/index.js";
10
11
  import { unwrapAsync } from "../types/fp.js";
11
12
 
@@ -17,12 +18,17 @@ export class Credentials extends ClientSDK {
17
18
  * Subscriber credentials associated to the delivery methods such as slack and push tokens.
18
19
  */
19
20
  async update(
20
- request: operations.SubscribersControllerUpdateSubscriberChannelRequest,
21
+ updateSubscriberChannelRequestDto:
22
+ components.UpdateSubscriberChannelRequestDto,
23
+ subscriberId: string,
24
+ idempotencyKey?: string | undefined,
21
25
  options?: RequestOptions,
22
26
  ): Promise<operations.SubscribersControllerUpdateSubscriberChannelResponse> {
23
27
  return unwrapAsync(subscribersCredentialsUpdate(
24
28
  this,
25
- request,
29
+ updateSubscriberChannelRequestDto,
30
+ subscriberId,
31
+ idempotencyKey,
26
32
  options,
27
33
  ));
28
34
  }
@@ -36,12 +42,17 @@ export class Credentials extends ClientSDK {
36
42
  * This endpoint appends provided credentials and deviceTokens to the existing ones.
37
43
  */
38
44
  async append(
39
- request: operations.SubscribersControllerModifySubscriberChannelRequest,
45
+ updateSubscriberChannelRequestDto:
46
+ components.UpdateSubscriberChannelRequestDto,
47
+ subscriberId: string,
48
+ idempotencyKey?: string | undefined,
40
49
  options?: RequestOptions,
41
50
  ): Promise<operations.SubscribersControllerModifySubscriberChannelResponse> {
42
51
  return unwrapAsync(subscribersCredentialsAppend(
43
52
  this,
44
- request,
53
+ updateSubscriberChannelRequestDto,
54
+ subscriberId,
55
+ idempotencyKey,
45
56
  options,
46
57
  ));
47
58
  }
@@ -53,7 +64,9 @@ export class Credentials extends ClientSDK {
53
64
  * Delete subscriber credentials such as slack and expo tokens.
54
65
  */
55
66
  async delete(
56
- request: operations.SubscribersControllerDeleteSubscriberCredentialsRequest,
67
+ subscriberId: string,
68
+ providerId: string,
69
+ idempotencyKey?: string | undefined,
57
70
  options?: RequestOptions,
58
71
  ): Promise<
59
72
  | operations.SubscribersControllerDeleteSubscriberCredentialsResponse
@@ -61,7 +74,9 @@ export class Credentials extends ClientSDK {
61
74
  > {
62
75
  return unwrapAsync(subscribersCredentialsDelete(
63
76
  this,
64
- request,
77
+ subscriberId,
78
+ providerId,
79
+ idempotencyKey,
65
80
  options,
66
81
  ));
67
82
  }
@@ -77,12 +77,16 @@ export class Integrations extends ClientSDK {
77
77
  * Update integration
78
78
  */
79
79
  async update(
80
- request: operations.IntegrationsControllerUpdateIntegrationByIdRequest,
80
+ updateIntegrationRequestDto: components.UpdateIntegrationRequestDto,
81
+ integrationId: string,
82
+ idempotencyKey?: string | undefined,
81
83
  options?: RequestOptions,
82
84
  ): Promise<operations.IntegrationsControllerUpdateIntegrationByIdResponse> {
83
85
  return unwrapAsync(integrationsUpdate(
84
86
  this,
85
- request,
87
+ updateIntegrationRequestDto,
88
+ integrationId,
89
+ idempotencyKey,
86
90
  options,
87
91
  ));
88
92
  }
@@ -53,7 +53,9 @@ export class Messages extends ClientSDK {
53
53
  * Deletes messages entity from the Novu platform using TransactionId of message
54
54
  */
55
55
  async deleteByTransactionId(
56
- request: operations.MessagesControllerDeleteMessagesByTransactionIdRequest,
56
+ transactionId: string,
57
+ idempotencyKey?: string | undefined,
58
+ channel?: operations.Channel | undefined,
57
59
  options?: RequestOptions,
58
60
  ): Promise<
59
61
  | operations.MessagesControllerDeleteMessagesByTransactionIdResponse
@@ -61,7 +63,9 @@ export class Messages extends ClientSDK {
61
63
  > {
62
64
  return unwrapAsync(messagesDeleteByTransactionId(
63
65
  this,
64
- request,
66
+ transactionId,
67
+ idempotencyKey,
68
+ channel,
65
69
  options,
66
70
  ));
67
71
  }
@@ -6,6 +6,7 @@ import { subscribersMessagesMarkAll } from "../funcs/subscribersMessagesMarkAll.
6
6
  import { subscribersMessagesMarkAllAs } from "../funcs/subscribersMessagesMarkAllAs.js";
7
7
  import { subscribersMessagesUpdateAsSeen } from "../funcs/subscribersMessagesUpdateAsSeen.js";
8
8
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
9
+ import * as components from "../models/components/index.js";
9
10
  import * as operations from "../models/operations/index.js";
10
11
  import { unwrapAsync } from "../types/fp.js";
11
12
 
@@ -14,12 +15,16 @@ export class NovuMessages extends ClientSDK {
14
15
  * Mark a subscriber messages as seen, read, unseen or unread
15
16
  */
16
17
  async markAllAs(
17
- request: operations.SubscribersControllerMarkMessagesAsRequest,
18
+ messageMarkAsRequestDto: components.MessageMarkAsRequestDto,
19
+ subscriberId: string,
20
+ idempotencyKey?: string | undefined,
18
21
  options?: RequestOptions,
19
22
  ): Promise<operations.SubscribersControllerMarkMessagesAsResponse> {
20
23
  return unwrapAsync(subscribersMessagesMarkAllAs(
21
24
  this,
22
- request,
25
+ messageMarkAsRequestDto,
26
+ subscriberId,
27
+ idempotencyKey,
23
28
  options,
24
29
  ));
25
30
  }
@@ -28,12 +33,16 @@ export class NovuMessages extends ClientSDK {
28
33
  * Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
29
34
  */
30
35
  async markAll(
31
- request: operations.SubscribersControllerMarkAllUnreadAsReadRequest,
36
+ markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto,
37
+ subscriberId: string,
38
+ idempotencyKey?: string | undefined,
32
39
  options?: RequestOptions,
33
40
  ): Promise<operations.SubscribersControllerMarkAllUnreadAsReadResponse> {
34
41
  return unwrapAsync(subscribersMessagesMarkAll(
35
42
  this,
36
- request,
43
+ markAllMessageAsRequestDto,
44
+ subscriberId,
45
+ idempotencyKey,
37
46
  options,
38
47
  ));
39
48
  }
@@ -6,6 +6,7 @@ import { topicsSubscribersAssign } from "../funcs/topicsSubscribersAssign.js";
6
6
  import { topicsSubscribersRemove } from "../funcs/topicsSubscribersRemove.js";
7
7
  import { topicsSubscribersRetrieve } from "../funcs/topicsSubscribersRetrieve.js";
8
8
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
9
+ import * as components from "../models/components/index.js";
9
10
  import * as operations from "../models/operations/index.js";
10
11
  import { unwrapAsync } from "../types/fp.js";
11
12
 
@@ -17,12 +18,16 @@ export class NovuSubscribers extends ClientSDK {
17
18
  * Add subscribers to a topic by key
18
19
  */
19
20
  async assign(
20
- request: operations.TopicsControllerAssignRequest,
21
+ addSubscribersRequestDto: components.AddSubscribersRequestDto,
22
+ topicKey: string,
23
+ idempotencyKey?: string | undefined,
21
24
  options?: RequestOptions,
22
25
  ): Promise<operations.TopicsControllerAssignResponse> {
23
26
  return unwrapAsync(topicsSubscribersAssign(
24
27
  this,
25
- request,
28
+ addSubscribersRequestDto,
29
+ topicKey,
30
+ idempotencyKey,
26
31
  options,
27
32
  ));
28
33
  }
@@ -34,12 +39,16 @@ export class NovuSubscribers extends ClientSDK {
34
39
  * Check if a subscriber belongs to a certain topic
35
40
  */
36
41
  async retrieve(
37
- request: operations.TopicsControllerGetTopicSubscriberRequest,
42
+ externalSubscriberId: string,
43
+ topicKey: string,
44
+ idempotencyKey?: string | undefined,
38
45
  options?: RequestOptions,
39
46
  ): Promise<operations.TopicsControllerGetTopicSubscriberResponse> {
40
47
  return unwrapAsync(topicsSubscribersRetrieve(
41
48
  this,
42
- request,
49
+ externalSubscriberId,
50
+ topicKey,
51
+ idempotencyKey,
43
52
  options,
44
53
  ));
45
54
  }
@@ -51,12 +60,16 @@ export class NovuSubscribers extends ClientSDK {
51
60
  * Remove subscribers from a topic
52
61
  */
53
62
  async remove(
54
- request: operations.TopicsControllerRemoveSubscribersRequest,
63
+ removeSubscribersRequestDto: components.RemoveSubscribersRequestDto,
64
+ topicKey: string,
65
+ idempotencyKey?: string | undefined,
55
66
  options?: RequestOptions,
56
67
  ): Promise<operations.TopicsControllerRemoveSubscribersResponse | undefined> {
57
68
  return unwrapAsync(topicsSubscribersRemove(
58
69
  this,
59
- request,
70
+ removeSubscribersRequestDto,
71
+ topicKey,
72
+ idempotencyKey,
60
73
  options,
61
74
  ));
62
75
  }
@@ -7,6 +7,7 @@ import { subscribersPreferencesRetrieveByLevel } from "../funcs/subscribersPrefe
7
7
  import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
8
8
  import { subscribersPreferencesUpdateGlobal } from "../funcs/subscribersPreferencesUpdateGlobal.js";
9
9
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
10
+ import * as components from "../models/components/index.js";
10
11
  import * as operations from "../models/operations/index.js";
11
12
  import { unwrapAsync } from "../types/fp.js";
12
13
 
@@ -15,14 +16,18 @@ export class Preferences extends ClientSDK {
15
16
  * Get subscriber preferences
16
17
  */
17
18
  async list(
18
- request: operations.SubscribersControllerListSubscriberPreferencesRequest,
19
+ subscriberId: string,
20
+ idempotencyKey?: string | undefined,
21
+ includeInactiveChannels?: boolean | undefined,
19
22
  options?: RequestOptions,
20
23
  ): Promise<
21
24
  operations.SubscribersControllerListSubscriberPreferencesResponse
22
25
  > {
23
26
  return unwrapAsync(subscribersPreferencesList(
24
27
  this,
25
- request,
28
+ subscriberId,
29
+ idempotencyKey,
30
+ includeInactiveChannels,
26
31
  options,
27
32
  ));
28
33
  }
@@ -31,15 +36,19 @@ export class Preferences extends ClientSDK {
31
36
  * Update subscriber global preferences
32
37
  */
33
38
  async updateGlobal(
34
- request:
35
- operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest,
39
+ updateSubscriberGlobalPreferencesRequestDto:
40
+ components.UpdateSubscriberGlobalPreferencesRequestDto,
41
+ subscriberId: string,
42
+ idempotencyKey?: string | undefined,
36
43
  options?: RequestOptions,
37
44
  ): Promise<
38
45
  operations.SubscribersControllerUpdateSubscriberGlobalPreferencesResponse
39
46
  > {
40
47
  return unwrapAsync(subscribersPreferencesUpdateGlobal(
41
48
  this,
42
- request,
49
+ updateSubscriberGlobalPreferencesRequestDto,
50
+ subscriberId,
51
+ idempotencyKey,
43
52
  options,
44
53
  ));
45
54
  }
@@ -4,6 +4,7 @@
4
4
 
5
5
  import { subscribersPropertiesUpdateOnlineFlag } from "../funcs/subscribersPropertiesUpdateOnlineFlag.js";
6
6
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
7
+ import * as components from "../models/components/index.js";
7
8
  import * as operations from "../models/operations/index.js";
8
9
  import { unwrapAsync } from "../types/fp.js";
9
10
 
@@ -15,14 +16,19 @@ export class Properties extends ClientSDK {
15
16
  * Used to update the subscriber isOnline flag.
16
17
  */
17
18
  async updateOnlineFlag(
18
- request: operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest,
19
+ updateSubscriberOnlineFlagRequestDto:
20
+ components.UpdateSubscriberOnlineFlagRequestDto,
21
+ subscriberId: string,
22
+ idempotencyKey?: string | undefined,
19
23
  options?: RequestOptions,
20
24
  ): Promise<
21
25
  operations.SubscribersControllerUpdateSubscriberOnlineFlagResponse
22
26
  > {
23
27
  return unwrapAsync(subscribersPropertiesUpdateOnlineFlag(
24
28
  this,
25
- request,
29
+ updateSubscriberOnlineFlagRequestDto,
30
+ subscriberId,
31
+ idempotencyKey,
26
32
  options,
27
33
  ));
28
34
  }