@novu/api 0.7.0 → 1.0.0

package/src/funcs/notificationsList.ts

@@ -102,6 +102,7 @@ async function $do(
     "search": payload.search,
     "subscriberIds": payload.subscriberIds,
     "templates": payload.templates,
+    "topicKey": payload.topicKey,
     "transactionId": payload.transactionId,
   });
 

package/src/funcs/subscribersCreate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Create subscriber
  *
  * @remarks
- * Create subscriber with the given data
+ * Create subscriber with the given data, if the subscriber already exists, it will be updated
  */
 export function subscribersCreate(
   client: NovuCore,

package/src/funcs/subscribersMessagesMarkAll.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * 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.
+ * Marks all the subscriber messages as read, unread, seen or unseen.
  */
 export function subscribersMessagesMarkAll(
   client: NovuCore,

package/src/funcs/subscribersTopicsList.ts

@@ -0,0 +1,238 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List topics a subscriber is subscribed to
+ *
+ * @remarks
+ * List topic subscriptions for a subscriber with pagination and filtering
+ */
+export function subscribersTopicsList(
+  client: NovuCore,
+  request: operations.SubscribersControllerListSubscriberTopicsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SubscribersControllerListSubscriberTopicsResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  request: operations.SubscribersControllerListSubscriberTopicsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersControllerListSubscriberTopicsResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SubscribersControllerListSubscriberTopicsRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/subscribers/{subscriberId}/subscriptions")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "after": payload.after,
+    "before": payload.before,
+    "includeCursor": payload.includeCursor,
+    "key": payload.key,
+    "limit": payload.limit,
+    "orderBy": payload.orderBy,
+    "orderDirection": payload.orderDirection,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "idempotency-key": encodeSimple(
+      "idempotency-key",
+      payload["idempotency-key"],
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.secretKey);
+  const securityInput = secConfig == null ? {} : { secretKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "SubscribersController_listSubscriberTopics",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.secretKey,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 1000,
+          maxInterval: 30000,
+          exponent: 1.5,
+          maxElapsedTime: 3600000,
+        },
+        retryConnectionErrors: true,
+      }
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["408", "409", "429", "5XX"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "405",
+      "409",
+      "413",
+      "414",
+      "415",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "503",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.SubscribersControllerListSubscriberTopicsResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations
+        .SubscribersControllerListSubscriberTopicsResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(414, errors.ErrorDto$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 405, 409, 413, 415],
+      errors.ErrorDto$inboundSchema,
+      { hdrs: true },
+    ),
+    M.jsonErr(422, errors.ValidationErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(429),
+    M.jsonErr(500, errors.ErrorDto$inboundSchema, { hdrs: true }),
+    M.fail(503),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/topicsCreate.ts

@@ -26,19 +26,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Topic creation
+ * Create or update a topic
  *
  * @remarks
- * Create a topic
+ * Creates a new topic if it does not exist, or updates an existing topic if it already exists
  */
 export function topicsCreate(
   client: NovuCore,
-  createTopicRequestDto: components.CreateTopicRequestDto,
+  createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.TopicsControllerCreateTopicResponse,
+    operations.TopicsControllerUpsertTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -54,7 +54,7 @@ export function topicsCreate(
 > {
   return new APIPromise($do(
     client,
-    createTopicRequestDto,
+    createUpdateTopicRequestDto,
     idempotencyKey,
     options,
   ));
@@ -62,13 +62,13 @@ export function topicsCreate(
 
 async function $do(
   client: NovuCore,
-  createTopicRequestDto: components.CreateTopicRequestDto,
+  createUpdateTopicRequestDto: components.CreateUpdateTopicRequestDto,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.TopicsControllerCreateTopicResponse,
+      operations.TopicsControllerUpsertTopicResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -84,26 +84,26 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.TopicsControllerCreateTopicRequest = {
-    createTopicRequestDto: createTopicRequestDto,
+  const input: operations.TopicsControllerUpsertTopicRequest = {
+    createUpdateTopicRequestDto: createUpdateTopicRequestDto,
     idempotencyKey: idempotencyKey,
   };
 
   const parsed = safeParse(
     input,
     (value) =>
-      operations.TopicsControllerCreateTopicRequest$outboundSchema.parse(value),
+      operations.TopicsControllerUpsertTopicRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.CreateTopicRequestDto, {
+  const body = encodeJSON("body", payload.CreateUpdateTopicRequestDto, {
     explode: true,
   });
 
-  const path = pathToFunc("/v1/topics")();
+  const path = pathToFunc("/v2/topics")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -121,7 +121,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "TopicsController_createTopic",
+    operationID: "TopicsController_upsertTopic",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -189,7 +189,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.TopicsControllerCreateTopicResponse,
+    operations.TopicsControllerUpsertTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -202,10 +202,11 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(201, operations.TopicsControllerCreateTopicResponse$inboundSchema, {
-      hdrs: true,
-      key: "Result",
-    }),
+    M.json(
+      [200, 201],
+      operations.TopicsControllerUpsertTopicResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
       [400, 401, 403, 404, 405, 409, 413, 415],

package/src/funcs/topicsDelete.ts

@@ -25,10 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete topic
- *
- * @remarks
- * Delete a topic by its topic key if it has no subscribers
+ * Delete topic by key
  */
 export function topicsDelete(
   client: NovuCore,
@@ -37,7 +34,7 @@ export function topicsDelete(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.TopicsControllerDeleteTopicResponse | undefined,
+    operations.TopicsControllerDeleteTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -67,7 +64,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.TopicsControllerDeleteTopicResponse | undefined,
+      operations.TopicsControllerDeleteTopicResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -107,7 +104,7 @@ async function $do(
     }),
   };
 
-  const path = pathToFunc("/v1/topics/{topicKey}")(pathParams);
+  const path = pathToFunc("/v2/topics/{topicKey}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -192,7 +189,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.TopicsControllerDeleteTopicResponse | undefined,
+    operations.TopicsControllerDeleteTopicResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -205,11 +202,10 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.nil(
-      204,
-      operations.TopicsControllerDeleteTopicResponse$inboundSchema.optional(),
-      { hdrs: true },
-    ),
+    M.json(200, operations.TopicsControllerDeleteTopicResponse$inboundSchema, {
+      hdrs: true,
+      key: "Result",
+    }),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
       [400, 401, 403, 404, 405, 409, 413, 415],

package/src/funcs/{topicsRetrieve.ts → topicsGet.ts}

@@ -25,12 +25,9 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get topic
- *
- * @remarks
- * Get a topic by its topic key
+ * Get topic by key
  */
-export function topicsRetrieve(
+export function topicsGet(
   client: NovuCore,
   topicKey: string,
   idempotencyKey?: string | undefined,
@@ -107,7 +104,7 @@ async function $do(
     }),
   };
 
-  const path = pathToFunc("/v1/topics/{topicKey}")(pathParams);
+  const path = pathToFunc("/v2/topics/{topicKey}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",

package/src/funcs/topicsList.ts

@@ -25,10 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get topic list filtered
- *
- * @remarks
- * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
+ * Get topics list
  */
 export function topicsList(
   client: NovuCore,
@@ -92,12 +89,17 @@ async function $do(
   const payload = parsed.value;
   const body = null;
 
-  const path = pathToFunc("/v1/topics")();
+  const path = pathToFunc("/v2/topics")();
 
   const query = encodeFormQuery({
+    "after": payload.after,
+    "before": payload.before,
+    "includeCursor": payload.includeCursor,
     "key": payload.key,
-    "page": payload.page,
-    "pageSize": payload.pageSize,
+    "limit": payload.limit,
+    "name": payload.name,
+    "orderBy": payload.orderBy,
+    "orderDirection": payload.orderDirection,
   });
 
   const headers = new Headers(compactMap({

package/src/funcs/topicsSubscribersRetrieve.ts

@@ -38,7 +38,7 @@ export function topicsSubscribersRetrieve(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.TopicsControllerGetTopicSubscriberResponse,
+    operations.TopicsV1ControllerGetTopicSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -70,7 +70,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.TopicsControllerGetTopicSubscriberResponse,
+      operations.TopicsV1ControllerGetTopicSubscriberResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -86,7 +86,7 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.TopicsControllerGetTopicSubscriberRequest = {
+  const input: operations.TopicsV1ControllerGetTopicSubscriberRequest = {
     externalSubscriberId: externalSubscriberId,
     topicKey: topicKey,
     idempotencyKey: idempotencyKey,
@@ -95,9 +95,8 @@ async function $do(
   const parsed = safeParse(
     input,
     (value) =>
-      operations.TopicsControllerGetTopicSubscriberRequest$outboundSchema.parse(
-        value,
-      ),
+      operations.TopicsV1ControllerGetTopicSubscriberRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -137,7 +136,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "TopicsController_getTopicSubscriber",
+    operationID: "TopicsV1Controller_getTopicSubscriber",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -205,7 +204,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.TopicsControllerGetTopicSubscriberResponse,
+    operations.TopicsV1ControllerGetTopicSubscriberResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -220,7 +219,7 @@ async function $do(
   >(
     M.json(
       200,
-      operations.TopicsControllerGetTopicSubscriberResponse$inboundSchema,
+      operations.TopicsV1ControllerGetTopicSubscriberResponse$inboundSchema,
       { hdrs: true, key: "Result" },
     ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),

package/src/funcs/{topicsSubscribersAssign.ts → topicsSubscriptionsCreate.ts}

@@ -26,20 +26,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Subscribers addition
- *
- * @remarks
- * Add subscribers to a topic by key
+ * Create topic subscriptions, if the topic does not exist, it will be created.
  */
-export function topicsSubscribersAssign(
+export function topicsSubscriptionsCreate(
   client: NovuCore,
-  addSubscribersRequestDto: components.AddSubscribersRequestDto,
+  createTopicSubscriptionsRequestDto:
+    components.CreateTopicSubscriptionsRequestDto,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.TopicsControllerAssignResponse,
+    operations.TopicsControllerCreateTopicSubscriptionsResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -55,7 +53,7 @@ export function topicsSubscribersAssign(
 > {
   return new APIPromise($do(
     client,
-    addSubscribersRequestDto,
+    createTopicSubscriptionsRequestDto,
     topicKey,
     idempotencyKey,
     options,
@@ -64,14 +62,15 @@ export function topicsSubscribersAssign(
 
 async function $do(
   client: NovuCore,
-  addSubscribersRequestDto: components.AddSubscribersRequestDto,
+  createTopicSubscriptionsRequestDto:
+    components.CreateTopicSubscriptionsRequestDto,
   topicKey: string,
   idempotencyKey?: string | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.TopicsControllerAssignResponse,
+      operations.TopicsControllerCreateTopicSubscriptionsResponse,
       | errors.ErrorDto
       | errors.ErrorDto
       | errors.ValidationErrorDto
@@ -87,8 +86,8 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.TopicsControllerAssignRequest = {
-    addSubscribersRequestDto: addSubscribersRequestDto,
+  const input: operations.TopicsControllerCreateTopicSubscriptionsRequest = {
+    createTopicSubscriptionsRequestDto: createTopicSubscriptionsRequestDto,
     topicKey: topicKey,
     idempotencyKey: idempotencyKey,
   };
@@ -96,14 +95,15 @@ async function $do(
   const parsed = safeParse(
     input,
     (value) =>
-      operations.TopicsControllerAssignRequest$outboundSchema.parse(value),
+      operations.TopicsControllerCreateTopicSubscriptionsRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = encodeJSON("body", payload.AddSubscribersRequestDto, {
+  const body = encodeJSON("body", payload.CreateTopicSubscriptionsRequestDto, {
     explode: true,
   });
 
@@ -114,7 +114,7 @@ async function $do(
     }),
   };
 
-  const path = pathToFunc("/v1/topics/{topicKey}/subscribers")(pathParams);
+  const path = pathToFunc("/v2/topics/{topicKey}/subscriptions")(pathParams);
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -132,7 +132,7 @@ async function $do(
 
   const context = {
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "TopicsController_assign",
+    operationID: "TopicsController_createTopicSubscriptions",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -200,7 +200,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.TopicsControllerAssignResponse,
+    operations.TopicsControllerCreateTopicSubscriptionsResponse,
     | errors.ErrorDto
     | errors.ErrorDto
     | errors.ValidationErrorDto
@@ -213,10 +213,11 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.TopicsControllerAssignResponse$inboundSchema, {
-      hdrs: true,
-      key: "Result",
-    }),
+    M.json(
+      201,
+      operations.TopicsControllerCreateTopicSubscriptionsResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
     M.jsonErr(414, errors.ErrorDto$inboundSchema),
     M.jsonErr(
       [400, 401, 403, 404, 405, 409, 413, 415],