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

package/src/models/operations/topicscontrollerrenametopic.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerRenameTopicRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The topic key
    */
@@ -28,16 +32,19 @@ export const TopicsControllerRenameTopicRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   topicKey: z.string(),
   RenameTopicRequestDto: components.RenameTopicRequestDto$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
     "RenameTopicRequestDto": "renameTopicRequestDto",
   });
 });
 
 /** @internal */
 export type TopicsControllerRenameTopicRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   topicKey: string;
   RenameTopicRequestDto: components.RenameTopicRequestDto$Outbound;
 };
@@ -48,10 +55,12 @@ export const TopicsControllerRenameTopicRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicsControllerRenameTopicRequest
 > = z.object({
+  idempotencyKey: z.string().optional(),
   topicKey: z.string(),
   renameTopicRequestDto: components.RenameTopicRequestDto$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
     renameTopicRequestDto: "RenameTopicRequestDto",
   });
 });

package/src/sdk/credentials.ts

@@ -6,7 +6,6 @@ import { subscribersCredentialsAppend } from "../funcs/subscribersCredentialsApp
 import { subscribersCredentialsDelete } from "../funcs/subscribersCredentialsDelete.js";
 import { subscribersCredentialsUpdate } from "../funcs/subscribersCredentialsUpdate.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";
 
@@ -18,15 +17,12 @@ export class Credentials extends ClientSDK {
    * Subscriber credentials associated to the delivery methods such as slack and push tokens.
    */
   async update(
-    updateSubscriberChannelRequestDto:
-      components.UpdateSubscriberChannelRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerUpdateSubscriberChannelRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerUpdateSubscriberChannelResponse> {
     return unwrapAsync(subscribersCredentialsUpdate(
       this,
-      updateSubscriberChannelRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }
@@ -40,15 +36,12 @@ export class Credentials extends ClientSDK {
    *     This endpoint appends provided credentials and deviceTokens to the existing ones.
    */
   async append(
-    updateSubscriberChannelRequestDto:
-      components.UpdateSubscriberChannelRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerModifySubscriberChannelRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerModifySubscriberChannelResponse> {
     return unwrapAsync(subscribersCredentialsAppend(
       this,
-      updateSubscriberChannelRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }
@@ -60,8 +53,7 @@ export class Credentials extends ClientSDK {
    * Delete subscriber credentials such as slack and expo tokens.
    */
   async delete(
-    subscriberId: string,
-    providerId: string,
+    request: operations.SubscribersControllerDeleteSubscriberCredentialsRequest,
     options?: RequestOptions,
   ): Promise<
     | operations.SubscribersControllerDeleteSubscriberCredentialsResponse
@@ -69,8 +61,7 @@ export class Credentials extends ClientSDK {
   > {
     return unwrapAsync(subscribersCredentialsDelete(
       this,
-      subscriberId,
-      providerId,
+      request,
       options,
     ));
   }

package/src/sdk/integrations.ts

@@ -27,10 +27,12 @@ export class Integrations extends ClientSDK {
    * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
    */
   async list(
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerListIntegrationsResponse> {
     return unwrapAsync(integrationsList(
       this,
+      idempotencyKey,
       options,
     ));
   }
@@ -42,12 +44,14 @@ export class Integrations extends ClientSDK {
    * Create an integration for the current environment the user is based on the API key provided
    */
   async create(
-    request: components.CreateIntegrationRequestDto,
+    createIntegrationRequestDto: components.CreateIntegrationRequestDto,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerCreateIntegrationResponse> {
     return unwrapAsync(integrationsCreate(
       this,
-      request,
+      createIntegrationRequestDto,
+      idempotencyKey,
       options,
     ));
   }
@@ -59,10 +63,12 @@ export class Integrations extends ClientSDK {
    * Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
    */
   async listActive(
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerGetActiveIntegrationsResponse> {
     return unwrapAsync(integrationsListActive(
       this,
+      idempotencyKey,
       options,
     ));
   }
@@ -71,14 +77,12 @@ export class Integrations extends ClientSDK {
    * Update integration
    */
   async update(
-    updateIntegrationRequestDto: components.UpdateIntegrationRequestDto,
-    integrationId: string,
+    request: operations.IntegrationsControllerUpdateIntegrationByIdRequest,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerUpdateIntegrationByIdResponse> {
     return unwrapAsync(integrationsUpdate(
       this,
-      updateIntegrationRequestDto,
-      integrationId,
+      request,
       options,
     ));
   }
@@ -88,11 +92,13 @@ export class Integrations extends ClientSDK {
    */
   async delete(
     integrationId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerRemoveIntegrationResponse> {
     return unwrapAsync(integrationsDelete(
       this,
       integrationId,
+      idempotencyKey,
       options,
     ));
   }
@@ -102,11 +108,13 @@ export class Integrations extends ClientSDK {
    */
   async setAsPrimary(
     integrationId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerSetIntegrationAsPrimaryResponse> {
     return unwrapAsync(integrationsSetAsPrimary(
       this,
       integrationId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/messages.ts

@@ -35,11 +35,13 @@ export class Messages extends ClientSDK {
    */
   async delete(
     messageId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.MessagesControllerDeleteMessageResponse> {
     return unwrapAsync(messagesDelete(
       this,
       messageId,
+      idempotencyKey,
       options,
     ));
   }
@@ -51,8 +53,7 @@ export class Messages extends ClientSDK {
    * Deletes messages entity from the Novu platform using TransactionId of message
    */
   async deleteByTransactionId(
-    transactionId: string,
-    channel?: operations.Channel | undefined,
+    request: operations.MessagesControllerDeleteMessagesByTransactionIdRequest,
     options?: RequestOptions,
   ): Promise<
     | operations.MessagesControllerDeleteMessagesByTransactionIdResponse
@@ -60,8 +61,7 @@ export class Messages extends ClientSDK {
   > {
     return unwrapAsync(messagesDeleteByTransactionId(
       this,
-      transactionId,
-      channel,
+      request,
       options,
     ));
   }

package/src/sdk/notifications.ts

@@ -34,11 +34,13 @@ export class Notifications extends ClientSDK {
    */
   async retrieve(
     notificationId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.NotificationsControllerGetNotificationResponse> {
     return unwrapAsync(notificationsRetrieve(
       this,
       notificationId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/novumessages.ts

@@ -6,7 +6,6 @@ import { subscribersMessagesMarkAll } from "../funcs/subscribersMessagesMarkAll.
 import { subscribersMessagesMarkAllAs } from "../funcs/subscribersMessagesMarkAllAs.js";
 import { subscribersMessagesUpdateAsSeen } from "../funcs/subscribersMessagesUpdateAsSeen.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";
 
@@ -15,14 +14,12 @@ export class NovuMessages extends ClientSDK {
    * Mark a subscriber messages as seen, read, unseen or unread
    */
   async markAllAs(
-    messageMarkAsRequestDto: components.MessageMarkAsRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerMarkMessagesAsRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerMarkMessagesAsResponse> {
     return unwrapAsync(subscribersMessagesMarkAllAs(
       this,
-      messageMarkAsRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }
@@ -31,14 +28,12 @@ export class NovuMessages extends ClientSDK {
    * 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.
    */
   async markAll(
-    markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto,
-    subscriberId: string,
+    request: operations.SubscribersControllerMarkAllUnreadAsReadRequest,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerMarkAllUnreadAsReadResponse> {
     return unwrapAsync(subscribersMessagesMarkAll(
       this,
-      markAllMessageAsRequestDto,
-      subscriberId,
+      request,
       options,
     ));
   }

package/src/sdk/novusubscribers.ts

@@ -6,7 +6,6 @@ import { topicsSubscribersAssign } from "../funcs/topicsSubscribersAssign.js";
 import { topicsSubscribersRemove } from "../funcs/topicsSubscribersRemove.js";
 import { topicsSubscribersRetrieve } from "../funcs/topicsSubscribersRetrieve.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";
 
@@ -18,14 +17,12 @@ export class NovuSubscribers extends ClientSDK {
    * Add subscribers to a topic by key
    */
   async assign(
-    addSubscribersRequestDto: components.AddSubscribersRequestDto,
-    topicKey: string,
+    request: operations.TopicsControllerAssignRequest,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerAssignResponse> {
     return unwrapAsync(topicsSubscribersAssign(
       this,
-      addSubscribersRequestDto,
-      topicKey,
+      request,
       options,
     ));
   }
@@ -37,14 +34,12 @@ export class NovuSubscribers extends ClientSDK {
    * Check if a subscriber belongs to a certain topic
    */
   async retrieve(
-    externalSubscriberId: string,
-    topicKey: string,
+    request: operations.TopicsControllerGetTopicSubscriberRequest,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerGetTopicSubscriberResponse> {
     return unwrapAsync(topicsSubscribersRetrieve(
       this,
-      externalSubscriberId,
-      topicKey,
+      request,
       options,
     ));
   }
@@ -56,14 +51,12 @@ export class NovuSubscribers extends ClientSDK {
    * Remove subscribers from a topic
    */
   async remove(
-    removeSubscribersRequestDto: components.RemoveSubscribersRequestDto,
-    topicKey: string,
+    request: operations.TopicsControllerRemoveSubscribersRequest,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerRemoveSubscribersResponse | undefined> {
     return unwrapAsync(topicsSubscribersRemove(
       this,
-      removeSubscribersRequestDto,
-      topicKey,
+      request,
       options,
     ));
   }

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,
     ));
   }