@novu/api 0.0.1-alpha.160 → 0.0.1-alpha.161

package/src/models/components/index.ts

@@ -51,6 +51,7 @@ export * from "./filtertopicsresponsedto.js";
 export * from "./getsubscriberpreferencesresponsedto.js";
 export * from "./gettopicresponsedto.js";
 export * from "./idempotencybodydto.js";
+export * from "./idempotencyresponse.js";
 export * from "./integrationresponsedto.js";
 export * from "./markallmessageasrequestdto.js";
 export * from "./markmessageactionasseendto.js";

package/src/models/operations/testingcontrolleridempotency.ts

@@ -19,6 +19,7 @@ export type TestingControllerIdempotencyRequest = {
 
 export type TestingControllerIdempotencyResponse = {
   headers: { [k: string]: Array<string> };
+  result: components.IdempotencyResponse;
 };
 
 /** @internal */
@@ -100,15 +101,18 @@ export const TestingControllerIdempotencyResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   Headers: z.record(z.array(z.string())),
+  Result: components.IdempotencyResponse$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "Headers": "headers",
+    "Result": "result",
   });
 });
 
 /** @internal */
 export type TestingControllerIdempotencyResponse$Outbound = {
   Headers: { [k: string]: Array<string> };
+  Result: components.IdempotencyResponse$Outbound;
 };
 
 /** @internal */
@@ -118,9 +122,11 @@ export const TestingControllerIdempotencyResponse$outboundSchema: z.ZodType<
   TestingControllerIdempotencyResponse
 > = z.object({
   headers: z.record(z.array(z.string())),
+  result: components.IdempotencyResponse$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     headers: "Headers",
+    result: "Result",
   });
 });
 

package/src/models/operations/testingcontrolleridempotencyget.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type TestingControllerIdempotencyGetRequest = {
@@ -17,6 +18,7 @@ export type TestingControllerIdempotencyGetRequest = {
 
 export type TestingControllerIdempotencyGetResponse = {
   headers: { [k: string]: Array<string> };
+  result: components.IdempotencyResponse;
 };
 
 /** @internal */
@@ -94,15 +96,18 @@ export const TestingControllerIdempotencyGetResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   Headers: z.record(z.array(z.string())),
+  Result: components.IdempotencyResponse$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "Headers": "headers",
+    "Result": "result",
   });
 });
 
 /** @internal */
 export type TestingControllerIdempotencyGetResponse$Outbound = {
   Headers: { [k: string]: Array<string> };
+  Result: components.IdempotencyResponse$Outbound;
 };
 
 /** @internal */
@@ -112,9 +117,11 @@ export const TestingControllerIdempotencyGetResponse$outboundSchema: z.ZodType<
   TestingControllerIdempotencyGetResponse
 > = z.object({
   headers: z.record(z.array(z.string())),
+  result: components.IdempotencyResponse$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     headers: "Headers",
+    result: "Result",
   });
 });
 

package/src/sdk/admin.ts

@@ -14,7 +14,7 @@ export class Admin extends ClientSDK {
     idempotencyBodyDto: components.IdempotencyBodyDto,
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TestingControllerIdempotencyResponse | undefined> {
+  ): Promise<operations.TestingControllerIdempotencyResponse> {
     return unwrapAsync(adminTestingControllerIdempotency(
       this,
       idempotencyBodyDto,
@@ -26,7 +26,7 @@ export class Admin extends ClientSDK {
   async testingControllerIdempotencyGet(
     idempotencyKey?: string | undefined,
     options?: RequestOptions,
-  ): Promise<operations.TestingControllerIdempotencyGetResponse | undefined> {
+  ): Promise<operations.TestingControllerIdempotencyGetResponse> {
     return unwrapAsync(adminTestingControllerIdempotencyGet(
       this,
       idempotencyKey,

package/src/sdk/credentials.ts

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

package/src/sdk/integrations.ts

@@ -77,12 +77,16 @@ export class Integrations extends ClientSDK {
    * Update integration
    */
   async update(
-    request: operations.IntegrationsControllerUpdateIntegrationByIdRequest,
+    updateIntegrationRequestDto: components.UpdateIntegrationRequestDto,
+    integrationId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.IntegrationsControllerUpdateIntegrationByIdResponse> {
     return unwrapAsync(integrationsUpdate(
       this,
-      request,
+      updateIntegrationRequestDto,
+      integrationId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/messages.ts

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

package/src/sdk/novumessages.ts

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

package/src/sdk/novusubscribers.ts

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

package/src/sdk/preferences.ts

@@ -7,6 +7,7 @@ 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";
 
@@ -15,14 +16,18 @@ export class Preferences extends ClientSDK {
    * Get subscriber preferences
    */
   async list(
-    request: operations.SubscribersControllerListSubscriberPreferencesRequest,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    includeInactiveChannels?: boolean | undefined,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerListSubscriberPreferencesResponse
   > {
     return unwrapAsync(subscribersPreferencesList(
       this,
-      request,
+      subscriberId,
+      idempotencyKey,
+      includeInactiveChannels,
       options,
     ));
   }
@@ -31,15 +36,19 @@ export class Preferences extends ClientSDK {
    * Update subscriber global preferences
    */
   async updateGlobal(
-    request:
-      operations.SubscribersControllerUpdateSubscriberGlobalPreferencesRequest,
+    updateSubscriberGlobalPreferencesRequestDto:
+      components.UpdateSubscriberGlobalPreferencesRequestDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerUpdateSubscriberGlobalPreferencesResponse
   > {
     return unwrapAsync(subscribersPreferencesUpdateGlobal(
       this,
-      request,
+      updateSubscriberGlobalPreferencesRequestDto,
+      subscriberId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/properties.ts

@@ -4,6 +4,7 @@
 
 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";
 
@@ -15,14 +16,19 @@ export class Properties extends ClientSDK {
    * Used to update the subscriber isOnline flag.
    */
   async updateOnlineFlag(
-    request: operations.SubscribersControllerUpdateSubscriberOnlineFlagRequest,
+    updateSubscriberOnlineFlagRequestDto:
+      components.UpdateSubscriberOnlineFlagRequestDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<
     operations.SubscribersControllerUpdateSubscriberOnlineFlagResponse
   > {
     return unwrapAsync(subscribersPropertiesUpdateOnlineFlag(
       this,
-      request,
+      updateSubscriberOnlineFlagRequestDto,
+      subscriberId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/subscribers.ts

@@ -58,7 +58,9 @@ export class Subscribers extends ClientSDK {
    * Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
    */
   async list(
-    request: operations.SubscribersControllerListSubscribersRequest,
+    idempotencyKey?: string | undefined,
+    page?: number | undefined,
+    limit?: number | undefined,
     options?: RequestOptions,
   ): Promise<
     PageIterator<
@@ -68,7 +70,9 @@ export class Subscribers extends ClientSDK {
   > {
     return unwrapResultIterator(subscribersList(
       this,
-      request,
+      idempotencyKey,
+      page,
+      limit,
       options,
     ));
   }
@@ -99,12 +103,16 @@ export class Subscribers extends ClientSDK {
    * Get subscriber by your internal id used to identify the subscriber
    */
   async retrieve(
-    request: operations.SubscribersControllerGetSubscriberRequest,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    includeTopics?: boolean | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerGetSubscriberResponse> {
     return unwrapAsync(subscribersRetrieve(
       this,
-      request,
+      subscriberId,
+      idempotencyKey,
+      includeTopics,
       options,
     ));
   }
@@ -116,12 +124,16 @@ export class Subscribers extends ClientSDK {
    * Used to update the subscriber entity with new information
    */
   async update(
-    request: operations.SubscribersControllerUpdateSubscriberRequest,
+    updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.SubscribersControllerUpdateSubscriberResponse> {
     return unwrapAsync(subscribersUpdate(
       this,
-      request,
+      updateSubscriberRequestDto,
+      subscriberId,
+      idempotencyKey,
       options,
     ));
   }

package/src/sdk/topics.ts

@@ -100,12 +100,16 @@ export class Topics extends ClientSDK {
    * Rename a topic by providing a new name
    */
   async rename(
-    request: operations.TopicsControllerRenameTopicRequest,
+    renameTopicRequestDto: components.RenameTopicRequestDto,
+    topicKey: string,
+    idempotencyKey?: string | undefined,
     options?: RequestOptions,
   ): Promise<operations.TopicsControllerRenameTopicResponse> {
     return unwrapAsync(topicsRename(
       this,
-      request,
+      renameTopicRequestDto,
+      topicKey,
+      idempotencyKey,
       options,
     ));
   }