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

package/src/models/operations/topicscontrollercreatetopic.ts

@@ -9,11 +9,90 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type TopicsControllerCreateTopicRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  createTopicRequestDto: components.CreateTopicRequestDto;
+};
+
 export type TopicsControllerCreateTopicResponse = {
   headers: { [k: string]: Array<string> };
   result: components.CreateTopicResponseDto;
 };
 
+/** @internal */
+export const TopicsControllerCreateTopicRequest$inboundSchema: z.ZodType<
+  TopicsControllerCreateTopicRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Idempotency-Key": z.string().optional(),
+  CreateTopicRequestDto: components.CreateTopicRequestDto$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
+    "CreateTopicRequestDto": "createTopicRequestDto",
+  });
+});
+
+/** @internal */
+export type TopicsControllerCreateTopicRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
+  CreateTopicRequestDto: components.CreateTopicRequestDto$Outbound;
+};
+
+/** @internal */
+export const TopicsControllerCreateTopicRequest$outboundSchema: z.ZodType<
+  TopicsControllerCreateTopicRequest$Outbound,
+  z.ZodTypeDef,
+  TopicsControllerCreateTopicRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  createTopicRequestDto: components.CreateTopicRequestDto$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+    createTopicRequestDto: "CreateTopicRequestDto",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TopicsControllerCreateTopicRequest$ {
+  /** @deprecated use `TopicsControllerCreateTopicRequest$inboundSchema` instead. */
+  export const inboundSchema = TopicsControllerCreateTopicRequest$inboundSchema;
+  /** @deprecated use `TopicsControllerCreateTopicRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    TopicsControllerCreateTopicRequest$outboundSchema;
+  /** @deprecated use `TopicsControllerCreateTopicRequest$Outbound` instead. */
+  export type Outbound = TopicsControllerCreateTopicRequest$Outbound;
+}
+
+export function topicsControllerCreateTopicRequestToJSON(
+  topicsControllerCreateTopicRequest: TopicsControllerCreateTopicRequest,
+): string {
+  return JSON.stringify(
+    TopicsControllerCreateTopicRequest$outboundSchema.parse(
+      topicsControllerCreateTopicRequest,
+    ),
+  );
+}
+
+export function topicsControllerCreateTopicRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<TopicsControllerCreateTopicRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TopicsControllerCreateTopicRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TopicsControllerCreateTopicRequest' from JSON`,
+  );
+}
+
 /** @internal */
 export const TopicsControllerCreateTopicResponse$inboundSchema: z.ZodType<
   TopicsControllerCreateTopicResponse,

package/src/models/operations/topicscontrollerdeletetopic.ts

@@ -9,6 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerDeleteTopicRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The topic key
    */
@@ -25,11 +29,17 @@ export const TopicsControllerDeleteTopicRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type TopicsControllerDeleteTopicRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   topicKey: string;
 };
 
@@ -39,7 +49,12 @@ export const TopicsControllerDeleteTopicRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicsControllerDeleteTopicRequest
 > = z.object({
+  idempotencyKey: z.string().optional(),
   topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+  });
 });
 
 /**

package/src/models/operations/topicscontrollergettopic.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerGetTopicRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The topic key
    */
@@ -27,11 +31,17 @@ export const TopicsControllerGetTopicRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type TopicsControllerGetTopicRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   topicKey: string;
 };
 
@@ -41,7 +51,12 @@ export const TopicsControllerGetTopicRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicsControllerGetTopicRequest
 > = z.object({
+  idempotencyKey: z.string().optional(),
   topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+  });
 });
 
 /**

package/src/models/operations/topicscontrollergettopicsubscriber.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerGetTopicSubscriberRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The external subscriber id
    */
@@ -31,12 +35,18 @@ export const TopicsControllerGetTopicSubscriberRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   externalSubscriberId: z.string(),
   topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type TopicsControllerGetTopicSubscriberRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   externalSubscriberId: string;
   topicKey: string;
 };
@@ -48,8 +58,13 @@ export const TopicsControllerGetTopicSubscriberRequest$outboundSchema:
     z.ZodTypeDef,
     TopicsControllerGetTopicSubscriberRequest
   > = z.object({
+    idempotencyKey: z.string().optional(),
     externalSubscriberId: z.string(),
     topicKey: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "Idempotency-Key",
+    });
   });
 
 /**

package/src/models/operations/topicscontrollerlisttopics.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerListTopicsRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The page number to retrieve (starts from 0)
    */
@@ -35,13 +39,19 @@ export const TopicsControllerListTopicsRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   page: z.number().int().default(0),
   pageSize: z.number().int().default(10),
   key: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
+  });
 });
 
 /** @internal */
 export type TopicsControllerListTopicsRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   page: number;
   pageSize: number;
   key?: string | undefined;
@@ -53,9 +63,14 @@ export const TopicsControllerListTopicsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicsControllerListTopicsRequest
 > = z.object({
+  idempotencyKey: z.string().optional(),
   page: z.number().int().default(0),
   pageSize: z.number().int().default(10),
   key: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
+  });
 });
 
 /**

package/src/models/operations/topicscontrollerremovesubscribers.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TopicsControllerRemoveSubscribersRequest = {
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
   /**
    * The topic key
    */
@@ -27,17 +31,20 @@ export const TopicsControllerRemoveSubscribersRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  "Idempotency-Key": z.string().optional(),
   topicKey: z.string(),
   RemoveSubscribersRequestDto:
     components.RemoveSubscribersRequestDto$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
+    "Idempotency-Key": "idempotencyKey",
     "RemoveSubscribersRequestDto": "removeSubscribersRequestDto",
   });
 });
 
 /** @internal */
 export type TopicsControllerRemoveSubscribersRequest$Outbound = {
+  "Idempotency-Key"?: string | undefined;
   topicKey: string;
   RemoveSubscribersRequestDto: components.RemoveSubscribersRequestDto$Outbound;
 };
@@ -48,11 +55,13 @@ export const TopicsControllerRemoveSubscribersRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   TopicsControllerRemoveSubscribersRequest
 > = z.object({
+  idempotencyKey: z.string().optional(),
   topicKey: z.string(),
   removeSubscribersRequestDto:
     components.RemoveSubscribersRequestDto$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
+    idempotencyKey: "Idempotency-Key",
     removeSubscribersRequestDto: "RemoveSubscribersRequestDto",
   });
 });

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