@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/operations/subscriberscontrollergetnotificationsfeed.ts

@@ -19,6 +19,10 @@ export type SubscribersControllerGetNotificationsFeedRequest = {
    * Base64 encoded string of the partial payload JSON object
    */
   payload?: string | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerGetNotificationsFeedResponse = {
@@ -39,6 +43,11 @@ export const SubscribersControllerGetNotificationsFeedRequest$inboundSchema:
     read: z.boolean().optional(),
     seen: z.boolean().optional(),
     payload: z.string().optional(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
   });
 
 /** @internal */
@@ -49,6 +58,7 @@ export type SubscribersControllerGetNotificationsFeedRequest$Outbound = {
   read?: boolean | undefined;
   seen?: boolean | undefined;
   payload?: string | undefined;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -64,6 +74,11 @@ export const SubscribersControllerGetNotificationsFeedRequest$outboundSchema:
     read: z.boolean().optional(),
     seen: z.boolean().optional(),
     payload: z.string().optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollergetsubscriber.ts

@@ -15,6 +15,10 @@ export type SubscribersControllerGetSubscriberRequest = {
    * Includes the topics associated with the subscriber
    */
   includeTopics?: boolean | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerGetSubscriberResponse = {
@@ -30,12 +34,18 @@ export const SubscribersControllerGetSubscriberRequest$inboundSchema: z.ZodType<
 > = z.object({
   subscriberId: z.string(),
   includeTopics: z.boolean().optional(),
+  "idempotency-key": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type SubscribersControllerGetSubscriberRequest$Outbound = {
   subscriberId: string;
   includeTopics?: boolean | undefined;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -47,6 +57,11 @@ export const SubscribersControllerGetSubscriberRequest$outboundSchema:
   > = z.object({
     subscriberId: z.string(),
     includeTopics: z.boolean().optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollergetsubscriberpreferencebylevel.ts

@@ -30,8 +30,12 @@ export type SubscribersControllerGetSubscriberPreferenceByLevelRequest = {
   /**
    * the preferences level to be retrieved (template / global)
    */
-  parameter: Parameter;
+  preferenceLevel: Parameter;
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerGetSubscriberPreferenceByLevelResponse = {
@@ -66,16 +70,22 @@ export const SubscribersControllerGetSubscriberPreferenceByLevelRequest$inboundS
     unknown
   > = z.object({
     includeInactiveChannels: z.boolean().optional(),
-    parameter: Parameter$inboundSchema,
+    preferenceLevel: Parameter$inboundSchema,
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
   });
 
 /** @internal */
 export type SubscribersControllerGetSubscriberPreferenceByLevelRequest$Outbound =
   {
     includeInactiveChannels?: boolean | undefined;
-    parameter: string;
+    preferenceLevel: string;
     subscriberId: string;
+    "idempotency-key"?: string | undefined;
   };
 
 /** @internal */
@@ -86,8 +96,13 @@ export const SubscribersControllerGetSubscriberPreferenceByLevelRequest$outbound
     SubscribersControllerGetSubscriberPreferenceByLevelRequest
   > = z.object({
     includeInactiveChannels: z.boolean().optional(),
-    parameter: Parameter$outboundSchema,
+    preferenceLevel: Parameter$outboundSchema,
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollergetunseencount.ts

@@ -10,9 +10,19 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerGetUnseenCountRequest = {
-  seen: boolean;
   subscriberId: string;
-  limit: number;
+  /**
+   * Indicates whether to count seen notifications.
+   */
+  seen?: boolean | undefined;
+  /**
+   * The maximum number of notifications to return.
+   */
+  limit?: number | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerGetUnseenCountResponse = {
@@ -24,16 +34,22 @@ export type SubscribersControllerGetUnseenCountResponse = {
 export const SubscribersControllerGetUnseenCountRequest$inboundSchema:
   z.ZodType<SubscribersControllerGetUnseenCountRequest, z.ZodTypeDef, unknown> =
     z.object({
-      seen: z.boolean(),
       subscriberId: z.string(),
-      limit: z.number(),
+      seen: z.boolean().default(false),
+      limit: z.number().default(100),
+      "idempotency-key": z.string().optional(),
+    }).transform((v) => {
+      return remap$(v, {
+        "idempotency-key": "idempotencyKey",
+      });
     });
 
 /** @internal */
 export type SubscribersControllerGetUnseenCountRequest$Outbound = {
-  seen: boolean;
   subscriberId: string;
+  seen: boolean;
   limit: number;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -43,9 +59,14 @@ export const SubscribersControllerGetUnseenCountRequest$outboundSchema:
     z.ZodTypeDef,
     SubscribersControllerGetUnseenCountRequest
   > = z.object({
-    seen: z.boolean(),
     subscriberId: z.string(),
-    limit: z.number(),
+    seen: z.boolean().default(false),
+    limit: z.number().default(100),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollerlistsubscriberpreferences.ts

@@ -15,6 +15,10 @@ export type SubscribersControllerListSubscriberPreferencesRequest = {
    * A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true
    */
   includeInactiveChannels?: boolean | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerListSubscriberPreferencesResponse = {
@@ -31,12 +35,18 @@ export const SubscribersControllerListSubscriberPreferencesRequest$inboundSchema
   > = z.object({
     subscriberId: z.string(),
     includeInactiveChannels: z.boolean().optional(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
   });
 
 /** @internal */
 export type SubscribersControllerListSubscriberPreferencesRequest$Outbound = {
   subscriberId: string;
   includeInactiveChannels?: boolean | undefined;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -48,6 +58,11 @@ export const SubscribersControllerListSubscriberPreferencesRequest$outboundSchem
   > = z.object({
     subscriberId: z.string(),
     includeInactiveChannels: z.boolean().optional(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollerlistsubscribers.ts

@@ -12,6 +12,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type SubscribersControllerListSubscribersRequest = {
   page?: number | undefined;
   limit?: number | undefined;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerListSubscribersResponseBody = {
@@ -44,12 +48,18 @@ export const SubscribersControllerListSubscribersRequest$inboundSchema:
   > = z.object({
     page: z.number().optional(),
     limit: z.number().default(10),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
   });
 
 /** @internal */
 export type SubscribersControllerListSubscribersRequest$Outbound = {
   page?: number | undefined;
   limit: number;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -61,6 +71,11 @@ export const SubscribersControllerListSubscribersRequest$outboundSchema:
   > = z.object({
     page: z.number().optional(),
     limit: z.number().default(10),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollermarkactionasseen.ts

@@ -13,6 +13,10 @@ export type SubscribersControllerMarkActionAsSeenRequest = {
   messageId: string;
   type?: any | undefined;
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   markMessageActionAsSeenDto: components.MarkMessageActionAsSeenDto;
 };
 
@@ -31,10 +35,12 @@ export const SubscribersControllerMarkActionAsSeenRequest$inboundSchema:
     messageId: z.string(),
     type: z.any().optional(),
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
     MarkMessageActionAsSeenDto:
       components.MarkMessageActionAsSeenDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      "idempotency-key": "idempotencyKey",
       "MarkMessageActionAsSeenDto": "markMessageActionAsSeenDto",
     });
   });
@@ -44,6 +50,7 @@ export type SubscribersControllerMarkActionAsSeenRequest$Outbound = {
   messageId: string;
   type?: any | undefined;
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   MarkMessageActionAsSeenDto: components.MarkMessageActionAsSeenDto$Outbound;
 };
 
@@ -57,10 +64,12 @@ export const SubscribersControllerMarkActionAsSeenRequest$outboundSchema:
     messageId: z.string(),
     type: z.any().optional(),
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     markMessageActionAsSeenDto:
       components.MarkMessageActionAsSeenDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       markMessageActionAsSeenDto: "MarkMessageActionAsSeenDto",
     });
   });

package/src/models/operations/subscriberscontrollermarkallunreadasread.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerMarkAllUnreadAsReadRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   markAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto;
 };
 
@@ -27,10 +31,12 @@ export const SubscribersControllerMarkAllUnreadAsReadRequest$inboundSchema:
     unknown
   > = z.object({
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
     MarkAllMessageAsRequestDto:
       components.MarkAllMessageAsRequestDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      "idempotency-key": "idempotencyKey",
       "MarkAllMessageAsRequestDto": "markAllMessageAsRequestDto",
     });
   });
@@ -38,6 +44,7 @@ export const SubscribersControllerMarkAllUnreadAsReadRequest$inboundSchema:
 /** @internal */
 export type SubscribersControllerMarkAllUnreadAsReadRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   MarkAllMessageAsRequestDto: components.MarkAllMessageAsRequestDto$Outbound;
 };
 
@@ -49,10 +56,12 @@ export const SubscribersControllerMarkAllUnreadAsReadRequest$outboundSchema:
     SubscribersControllerMarkAllUnreadAsReadRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     markAllMessageAsRequestDto:
       components.MarkAllMessageAsRequestDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       markAllMessageAsRequestDto: "MarkAllMessageAsRequestDto",
     });
   });

package/src/models/operations/subscriberscontrollermarkmessagesas.ts

@@ -11,12 +11,16 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerMarkMessagesAsRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   messageMarkAsRequestDto: components.MessageMarkAsRequestDto;
 };
 
 export type SubscribersControllerMarkMessagesAsResponse = {
   headers: { [k: string]: Array<string> };
-  result: Array<components.MessageEntity>;
+  result: Array<components.MessageResponseDto>;
 };
 
 /** @internal */
@@ -24,9 +28,11 @@ export const SubscribersControllerMarkMessagesAsRequest$inboundSchema:
   z.ZodType<SubscribersControllerMarkMessagesAsRequest, z.ZodTypeDef, unknown> =
     z.object({
       subscriberId: z.string(),
+      "idempotency-key": z.string().optional(),
       MessageMarkAsRequestDto: components.MessageMarkAsRequestDto$inboundSchema,
     }).transform((v) => {
       return remap$(v, {
+        "idempotency-key": "idempotencyKey",
         "MessageMarkAsRequestDto": "messageMarkAsRequestDto",
       });
     });
@@ -34,6 +40,7 @@ export const SubscribersControllerMarkMessagesAsRequest$inboundSchema:
 /** @internal */
 export type SubscribersControllerMarkMessagesAsRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   MessageMarkAsRequestDto: components.MessageMarkAsRequestDto$Outbound;
 };
 
@@ -45,9 +52,11 @@ export const SubscribersControllerMarkMessagesAsRequest$outboundSchema:
     SubscribersControllerMarkMessagesAsRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     messageMarkAsRequestDto: components.MessageMarkAsRequestDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       messageMarkAsRequestDto: "MessageMarkAsRequestDto",
     });
   });
@@ -102,7 +111,7 @@ export const SubscribersControllerMarkMessagesAsResponse$inboundSchema:
     unknown
   > = z.object({
     Headers: z.record(z.array(z.string())),
-    Result: z.array(components.MessageEntity$inboundSchema),
+    Result: z.array(components.MessageResponseDto$inboundSchema),
   }).transform((v) => {
     return remap$(v, {
       "Headers": "headers",
@@ -113,7 +122,7 @@ export const SubscribersControllerMarkMessagesAsResponse$inboundSchema:
 /** @internal */
 export type SubscribersControllerMarkMessagesAsResponse$Outbound = {
   Headers: { [k: string]: Array<string> };
-  Result: Array<components.MessageEntity$Outbound>;
+  Result: Array<components.MessageResponseDto$Outbound>;
 };
 
 /** @internal */
@@ -124,7 +133,7 @@ export const SubscribersControllerMarkMessagesAsResponse$outboundSchema:
     SubscribersControllerMarkMessagesAsResponse
   > = z.object({
     headers: z.record(z.array(z.string())),
-    result: z.array(components.MessageEntity$outboundSchema),
+    result: z.array(components.MessageResponseDto$outboundSchema),
   }).transform((v) => {
     return remap$(v, {
       headers: "Headers",

package/src/models/operations/subscriberscontrollermodifysubscriberchannel.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerModifySubscriberChannelRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   updateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto;
 };
@@ -28,10 +32,12 @@ export const SubscribersControllerModifySubscriberChannelRequest$inboundSchema:
     unknown
   > = z.object({
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
     UpdateSubscriberChannelRequestDto:
       components.UpdateSubscriberChannelRequestDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      "idempotency-key": "idempotencyKey",
       "UpdateSubscriberChannelRequestDto": "updateSubscriberChannelRequestDto",
     });
   });
@@ -39,6 +45,7 @@ export const SubscribersControllerModifySubscriberChannelRequest$inboundSchema:
 /** @internal */
 export type SubscribersControllerModifySubscriberChannelRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   UpdateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto$Outbound;
 };
@@ -51,10 +58,12 @@ export const SubscribersControllerModifySubscriberChannelRequest$outboundSchema:
     SubscribersControllerModifySubscriberChannelRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     updateSubscriberChannelRequestDto:
       components.UpdateSubscriberChannelRequestDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       updateSubscriberChannelRequestDto: "UpdateSubscriberChannelRequestDto",
     });
   });

package/src/models/operations/subscriberscontrollerremovesubscriber.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerRemoveSubscriberRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
 };
 
 export type SubscribersControllerRemoveSubscriberResponse = {
@@ -26,11 +30,17 @@ export const SubscribersControllerRemoveSubscriberRequest$inboundSchema:
     unknown
   > = z.object({
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "idempotency-key": "idempotencyKey",
+    });
   });
 
 /** @internal */
 export type SubscribersControllerRemoveSubscriberRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
 };
 
 /** @internal */
@@ -41,6 +51,11 @@ export const SubscribersControllerRemoveSubscriberRequest$outboundSchema:
     SubscribersControllerRemoveSubscriberRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+    });
   });
 
 /**

package/src/models/operations/subscriberscontrollerupdatesubscriber.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerUpdateSubscriberRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   updateSubscriberRequestDto: components.UpdateSubscriberRequestDto;
 };
 
@@ -27,10 +31,12 @@ export const SubscribersControllerUpdateSubscriberRequest$inboundSchema:
     unknown
   > = z.object({
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
     UpdateSubscriberRequestDto:
       components.UpdateSubscriberRequestDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      "idempotency-key": "idempotencyKey",
       "UpdateSubscriberRequestDto": "updateSubscriberRequestDto",
     });
   });
@@ -38,6 +44,7 @@ export const SubscribersControllerUpdateSubscriberRequest$inboundSchema:
 /** @internal */
 export type SubscribersControllerUpdateSubscriberRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   UpdateSubscriberRequestDto: components.UpdateSubscriberRequestDto$Outbound;
 };
 
@@ -49,10 +56,12 @@ export const SubscribersControllerUpdateSubscriberRequest$outboundSchema:
     SubscribersControllerUpdateSubscriberRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     updateSubscriberRequestDto:
       components.UpdateSubscriberRequestDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       updateSubscriberRequestDto: "UpdateSubscriberRequestDto",
     });
   });

package/src/models/operations/subscriberscontrollerupdatesubscriberchannel.ts

@@ -11,6 +11,10 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SubscribersControllerUpdateSubscriberChannelRequest = {
   subscriberId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   updateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto;
 };
@@ -28,10 +32,12 @@ export const SubscribersControllerUpdateSubscriberChannelRequest$inboundSchema:
     unknown
   > = z.object({
     subscriberId: z.string(),
+    "idempotency-key": z.string().optional(),
     UpdateSubscriberChannelRequestDto:
       components.UpdateSubscriberChannelRequestDto$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      "idempotency-key": "idempotencyKey",
       "UpdateSubscriberChannelRequestDto": "updateSubscriberChannelRequestDto",
     });
   });
@@ -39,6 +45,7 @@ export const SubscribersControllerUpdateSubscriberChannelRequest$inboundSchema:
 /** @internal */
 export type SubscribersControllerUpdateSubscriberChannelRequest$Outbound = {
   subscriberId: string;
+  "idempotency-key"?: string | undefined;
   UpdateSubscriberChannelRequestDto:
     components.UpdateSubscriberChannelRequestDto$Outbound;
 };
@@ -51,10 +58,12 @@ export const SubscribersControllerUpdateSubscriberChannelRequest$outboundSchema:
     SubscribersControllerUpdateSubscriberChannelRequest
   > = z.object({
     subscriberId: z.string(),
+    idempotencyKey: z.string().optional(),
     updateSubscriberChannelRequestDto:
       components.UpdateSubscriberChannelRequestDto$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
+      idempotencyKey: "idempotency-key",
       updateSubscriberChannelRequestDto: "UpdateSubscriberChannelRequestDto",
     });
   });