@novu/api 0.1.6 → 2.6.5

package/src/funcs/subscribersCreate.ts

@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
  * Create subscriber
  *
  * @remarks
- * Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.
+ * Create subscriber with the given data
  */
 export async function subscribersCreate(
   client: NovuCore,
@@ -37,7 +37,7 @@ export async function subscribersCreate(
   options?: RequestOptions,
 ): Promise<
   Result<
-    operations.SubscribersV1ControllerCreateSubscriberResponse,
+    operations.SubscribersControllerCreateSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -51,7 +51,7 @@ export async function subscribersCreate(
     | ConnectionError
   >
 > {
-  const input: operations.SubscribersV1ControllerCreateSubscriberRequest = {
+  const input: operations.SubscribersControllerCreateSubscriberRequest = {
     createSubscriberRequestDto: createSubscriberRequestDto,
     idempotencyKey: idempotencyKey,
   };
@@ -59,7 +59,7 @@ export async function subscribersCreate(
   const parsed = safeParse(
     input,
     (value) =>
-      operations.SubscribersV1ControllerCreateSubscriberRequest$outboundSchema
+      operations.SubscribersControllerCreateSubscriberRequest$outboundSchema
         .parse(value),
     "Input validation failed",
   );
@@ -71,7 +71,7 @@ export async function subscribersCreate(
     explode: true,
   });
 
-  const path = pathToFunc("/v1/subscribers")();
+  const path = pathToFunc("/v2/subscribers")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -83,17 +83,16 @@ export async function subscribersCreate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
-    operationID: "SubscribersV1Controller_createSubscriber",
+    operationID: "SubscribersController_createSubscriber",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {
@@ -156,7 +155,7 @@ export async function subscribersCreate(
   };
 
   const [result] = await M.match<
-    operations.SubscribersV1ControllerCreateSubscriberResponse,
+    operations.SubscribersControllerCreateSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -170,8 +169,8 @@ export async function subscribersCreate(
     | ConnectionError
   >(
     M.json(
-      201,
-      operations.SubscribersV1ControllerCreateSubscriberResponse$inboundSchema,
+      200,
+      operations.SubscribersControllerCreateSubscriberResponse$inboundSchema,
       { hdrs: true, key: "Result" },
     ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),

package/src/funcs/subscribersCreateBulk.ts

@@ -87,8 +87,7 @@ export async function subscribersCreateBulk(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -97,7 +96,7 @@ export async function subscribersCreateBulk(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersCredentialsAppend.ts

@@ -98,8 +98,7 @@ export async function subscribersCredentialsAppend(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -108,7 +107,7 @@ export async function subscribersCredentialsAppend(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersCredentialsDelete.ts

@@ -97,8 +97,7 @@ export async function subscribersCredentialsDelete(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -107,7 +106,7 @@ export async function subscribersCredentialsDelete(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersCredentialsUpdate.ts

@@ -97,8 +97,7 @@ export async function subscribersCredentialsUpdate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -107,7 +106,7 @@ export async function subscribersCredentialsUpdate(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersDelete.ts

@@ -86,8 +86,7 @@ export async function subscribersDelete(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -96,7 +95,7 @@ export async function subscribersDelete(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersList.ts

@@ -96,8 +96,7 @@ export async function subscribersList(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -106,7 +105,7 @@ export async function subscribersList(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersMessagesMarkAll.ts

@@ -93,8 +93,7 @@ export async function subscribersMessagesMarkAll(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -103,7 +102,7 @@ export async function subscribersMessagesMarkAll(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersMessagesMarkAllAs.ts

@@ -91,8 +91,7 @@ export async function subscribersMessagesMarkAllAs(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -101,7 +100,7 @@ export async function subscribersMessagesMarkAllAs(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersMessagesUpdateAsSeen.ts

@@ -90,8 +90,7 @@ export async function subscribersMessagesUpdateAsSeen(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +99,7 @@ export async function subscribersMessagesUpdateAsSeen(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersNotificationsFeed.ts

@@ -88,8 +88,7 @@ export async function subscribersNotificationsFeed(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -98,7 +97,7 @@ export async function subscribersNotificationsFeed(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersNotificationsUnseenCount.ts

@@ -84,8 +84,7 @@ export async function subscribersNotificationsUnseenCount(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -94,7 +93,7 @@ export async function subscribersNotificationsUnseenCount(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersPatch.ts

@@ -92,8 +92,7 @@ export async function subscribersPatch(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -102,7 +101,7 @@ export async function subscribersPatch(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/{subscribersPreferencesRetrieve.ts → subscribersPreferencesList.ts}

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Get subscriber global and workflow specific preferences
  */
-export async function subscribersPreferencesRetrieve(
+export async function subscribersPreferencesList(
   client: NovuCore,
   subscriberId: string,
   idempotencyKey?: string | undefined,
@@ -90,8 +90,7 @@ export async function subscribersPreferencesRetrieve(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +99,7 @@ export async function subscribersPreferencesRetrieve(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersPreferencesUpdate.ts

@@ -96,8 +96,7 @@ export async function subscribersPreferencesUpdate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -106,7 +105,7 @@ export async function subscribersPreferencesUpdate(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersPropertiesUpdateOnlineFlag.ts

@@ -100,8 +100,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -110,7 +109,7 @@ export async function subscribersPropertiesUpdateOnlineFlag(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersRetrieve.ts

@@ -87,8 +87,7 @@ export async function subscribersRetrieve(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -97,7 +96,7 @@ export async function subscribersRetrieve(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/subscribersSearch.ts

@@ -82,8 +82,7 @@ export async function subscribersSearch(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -92,7 +91,7 @@ export async function subscribersSearch(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsCreate.ts

@@ -82,8 +82,7 @@ export async function topicsCreate(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -92,7 +91,7 @@ export async function topicsCreate(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsDelete.ts

@@ -85,8 +85,7 @@ export async function topicsDelete(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -95,7 +94,7 @@ export async function topicsDelete(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsList.ts

@@ -78,8 +78,7 @@ export async function topicsList(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -88,7 +87,7 @@ export async function topicsList(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsRename.ts

@@ -91,8 +91,7 @@ export async function topicsRename(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -101,7 +100,7 @@ export async function topicsRename(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsRetrieve.ts

@@ -85,8 +85,7 @@ export async function topicsRetrieve(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -95,7 +94,7 @@ export async function topicsRetrieve(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsSubscribersAssign.ts

@@ -91,8 +91,7 @@ export async function topicsSubscribersAssign(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -101,7 +100,7 @@ export async function topicsSubscribersAssign(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsSubscribersRemove.ts

@@ -95,8 +95,7 @@ export async function topicsSubscribersRemove(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -105,7 +104,7 @@ export async function topicsSubscribersRemove(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/topicsSubscribersRetrieve.ts

@@ -31,8 +31,8 @@ import { Result } from "../types/fp.js";
  */
 export async function topicsSubscribersRetrieve(
   client: NovuCore,
-  externalSubscriberId: string,
   topicKey: string,
+  externalSubscriberId: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
@@ -52,8 +52,8 @@ export async function topicsSubscribersRetrieve(
   >
 > {
   const input: operations.TopicsControllerGetTopicSubscriberRequest = {
-    externalSubscriberId: externalSubscriberId,
     topicKey: topicKey,
+    externalSubscriberId: externalSubscriberId,
     idempotencyKey: idempotencyKey,
   };
 
@@ -96,8 +96,7 @@ export async function topicsSubscribersRetrieve(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -106,7 +105,7 @@ export async function topicsSubscribersRetrieve(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/trigger.ts

@@ -85,8 +85,7 @@ export async function trigger(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -95,7 +94,7 @@ export async function trigger(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/triggerBroadcast.ts

@@ -84,8 +84,7 @@ export async function triggerBroadcast(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -94,7 +93,7 @@ export async function triggerBroadcast(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {

package/src/funcs/triggerBulk.ts

@@ -84,8 +84,7 @@ export async function triggerBulk(
     ),
   }));
 
-  const secConfig = await extractSecurity(client._options.secretKey);
-  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const securityInput = await extractSecurity(client._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -94,7 +93,7 @@ export async function triggerBulk(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.secretKey,
+    securitySource: client._options.security,
     retryConfig: options?.retries
       || client._options.retryConfig
       || {