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

package/src/sdk/preferences.ts

@@ -7,7 +7,6 @@ import { subscribersPreferencesRetrieveByLevel } from "../funcs/subscribersPrefe
 import { subscribersPreferencesUpdate } from "../funcs/subscribersPreferencesUpdate.js";
 import { subscribersPreferencesUpdateGlobal } from "../funcs/subscribersPreferencesUpdateGlobal.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
@@ -16,16 +15,14 @@ export class Preferences extends ClientSDK {
    * Get subscriber preferences
    */
   async list(
-    subscriberId: string,
-    includeInactiveChannels?: boolean | undefined,
+    request: operations.SubscribersControllerListSubscriberPreferencesRequest,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerListSubscriberPreferencesResponse
   > {
     return unwrapAsync(subscribersPreferencesList(
       this,
-      subscriberId,
-      includeInactiveChannels,
+      request,
       options,
     ));
   }
@@ -34,17 +31,15 @@ export class Preferences extends ClientSDK {
    * Update subscriber global preferences
    */
   async updateGlobal(
-    updateSubscriberGlobalPreferencesRequestDto:
-      components.UpdateSubscriberGlobalPreferencesRequestDto,
-    subscriberId: string,
+    request:
+      operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerUpdateSubscriberGlobalPreferencesResponse
   > {
     return unwrapAsync(subscribersPreferencesUpdateGlobal(
       this,
-      updateSubscriberGlobalPreferencesRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }

package/src/sdk/properties.ts

@@ -4,7 +4,6 @@
 
 import { subscribersPropertiesUpdateOnlineFlag } from "../funcs/subscribersPropertiesUpdateOnlineFlag.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
@@ -16,17 +15,14 @@ export class Properties extends ClientSDK {
    * Used to update the subscriber isOnline flag.
    */
   async updateOnlineFlag(
-    updateSubscriberOnlineFlagRequestDto:
-      components.UpdateSubscriberOnlineFlagRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerUpdateSubscriberOnlineFlagResponse
   > {
     return unwrapAsync(subscribersPropertiesUpdateOnlineFlag(
       this,
-      updateSubscriberOnlineFlagRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }

package/src/sdk/sdk.ts

@@ -52,12 +52,14 @@ export class Novu extends ClientSDK {
    *     Additional information can be passed according the body interface below.
    */
   async trigger(
-    request: components.TriggerEventRequestDto,
+    triggerEventRequestDto: components.TriggerEventRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.EventsControllerTriggerResponse> {
     return unwrapAsync(trigger(
       this,
-      request,
+      triggerEventRequestDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -71,12 +73,14 @@ export class Novu extends ClientSDK {
    *       The bulk API is limited to 100 events per request.
    */
   async triggerBulk(
-    request: components.BulkTriggerEventDto,
+    bulkTriggerEventDto: components.BulkTriggerEventDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.EventsControllerTriggerBulkResponse> {
     return unwrapAsync(triggerBulk(
       this,
-      request,
+      bulkTriggerEventDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -90,12 +94,14 @@ export class Novu extends ClientSDK {
    *       In the future could be used to trigger events to a subset of subscribers based on defined filters.
    */
   async triggerBroadcast(
-    request: components.TriggerEventToAllRequestDto,
+    triggerEventToAllRequestDto: components.TriggerEventToAllRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.EventsControllerBroadcastEventToAllResponse> {
     return unwrapAsync(triggerBroadcast(
       this,
-      request,
+      triggerEventToAllRequestDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -110,11 +116,13 @@ export class Novu extends ClientSDK {
    */
   async cancel(
     transactionId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.EventsControllerCancelResponse> {
     return unwrapAsync(cancel(
       this,
       transactionId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/stats.ts

@@ -13,10 +13,12 @@ export class Stats extends ClientSDK {
    * Get notification statistics
    */
   async retrieve(
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.NotificationsControllerGetActivityStatsResponse> {
     return unwrapAsync(notificationsStatsRetrieve(
       this,
+      idempotencyKey,
       options,
     ));
   }
@@ -25,11 +27,13 @@ export class Stats extends ClientSDK {
    * Get notification graph statistics
    */
   async graph(
+    idempotencyKey?: string | undefined,
     days?: number | undefined,
     options?: RequestOptions,
   ): Promise<operations.NotificationsControllerGetActivityGraphStatsResponse> {
     return unwrapAsync(notificationsStatsGraph(
       this,
+      idempotencyKey,
       days,
       options,
     ));

package/src/sdk/subscribers.ts

@@ -58,8 +58,7 @@ export class Subscribers extends ClientSDK {
    * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
    */
   async list(
-    page?: number | undefined,
-    limit?: number | undefined,
+    request: operations.SubscribersControllerListSubscribersRequest,
     options?: RequestOptions,
   ): Promise<
     PageIterator<
@@ -69,8 +68,7 @@ export class Subscribers extends ClientSDK {
   > {
     return unwrapResultIterator(subscribersList(
       this,
-      page,
-      limit,
+      request,
       options,
     ));
   }
@@ -82,12 +80,14 @@ export class Subscribers extends ClientSDK {
    * 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.
    */
   async create(
-    request: components.CreateSubscriberRequestDto,
+    createSubscriberRequestDto: components.CreateSubscriberRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerCreateSubscriberResponse> {
     return unwrapAsync(subscribersCreate(
       this,
-      request,
+      createSubscriberRequestDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -99,14 +99,12 @@ export class Subscribers extends ClientSDK {
    * Get subscriber by your internal id used to identify the subscriber
    */
   async retrieve(
-    subscriberId: string,
-    includeTopics?: boolean | undefined,
+    request: operations.SubscribersControllerGetSubscriberRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerGetSubscriberResponse> {
     return unwrapAsync(subscribersRetrieve(
       this,
-      subscriberId,
-      includeTopics,
+      request,
       options,
     ));
   }
@@ -118,14 +116,12 @@ export class Subscribers extends ClientSDK {
    * Used to update the subscriber entity with new information
    */
   async update(
-    updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerUpdateSubscriberRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerUpdateSubscriberResponse> {
     return unwrapAsync(subscribersUpdate(
       this,
-      updateSubscriberRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }
@@ -138,11 +134,13 @@ export class Subscribers extends ClientSDK {
    */
   async delete(
     subscriberId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerRemoveSubscriberResponse> {
     return unwrapAsync(subscribersDelete(
       this,
       subscriberId,
+      idempotencyKey,
       options,
     ));
   }
@@ -156,12 +154,14 @@ export class Subscribers extends ClientSDK {
    *       The bulk API is limited to 500 subscribers per request.
    */
   async createBulk(
-    request: components.BulkSubscriberCreateDto,
+    bulkSubscriberCreateDto: components.BulkSubscriberCreateDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerBulkCreateSubscribersResponse> {
     return unwrapAsync(subscribersCreateBulk(
       this,
-      request,
+      bulkSubscriberCreateDto,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/topics.ts

@@ -26,12 +26,14 @@ export class Topics extends ClientSDK {
    * Create a topic
    */
   async create(
-    request: components.CreateTopicRequestDto,
+    createTopicRequestDto: components.CreateTopicRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerCreateTopicResponse> {
     return unwrapAsync(topicsCreate(
       this,
-      request,
+      createTopicRequestDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -61,11 +63,13 @@ export class Topics extends ClientSDK {
    */
   async delete(
     topicKey: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerDeleteTopicResponse | undefined> {
     return unwrapAsync(topicsDelete(
       this,
       topicKey,
+      idempotencyKey,
       options,
     ));
   }
@@ -78,11 +82,13 @@ export class Topics extends ClientSDK {
    */
   async retrieve(
     topicKey: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerGetTopicResponse> {
     return unwrapAsync(topicsRetrieve(
       this,
       topicKey,
+      idempotencyKey,
       options,
     ));
   }
@@ -94,14 +100,12 @@ export class Topics extends ClientSDK {
    * Rename a topic by providing a new name
    */
   async rename(
-    renameTopicRequestDto: components.RenameTopicRequestDto,
-    topicKey: string,
+    request: operations.TopicsControllerRenameTopicRequest,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerRenameTopicResponse> {
     return unwrapAsync(topicsRename(
       this,
-      renameTopicRequestDto,
-      topicKey,
+      request,
       options,
     ));
   }

package/src/sdk/webhooks.ts

@@ -16,11 +16,13 @@ export class Webhooks extends ClientSDK {
    */
   async retrieve(
     providerOrIntegrationId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerGetWebhookSupportStatusResponse> {
     return unwrapAsync(integrationsWebhooksRetrieve(
       this,
       providerOrIntegrationId,
+      idempotencyKey,
       options,
     ));
   }