@novu/api 0.6.0 → 0.6.2

package/src/funcs/subscribersSearch.ts

@@ -96,6 +96,7 @@ async function $do(
     "after": payload.after,
     "before": payload.before,
     "email": payload.email,
+    "includeCursor": payload.includeCursor,
     "limit": payload.limit,
     "name": payload.name,
     "orderBy": payload.orderBy,

package/src/funcs/subscribersUpsert.ts

@@ -0,0 +1,240 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { encodeJSON, 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 * as components from "../models/components/index.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";
+
+/**
+ * Upsert subscriber
+ *
+ * @remarks
+ * Used to upsert the subscriber entity with new information
+ */
+export function subscribersUpsert(
+  client: NovuCore,
+  updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SubscribersV1ControllerUpdateSubscriberResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    updateSubscriberRequestDto,
+    subscriberId,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  updateSubscriberRequestDto: components.UpdateSubscriberRequestDto,
+  subscriberId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SubscribersV1ControllerUpdateSubscriberResponse,
+      | errors.ErrorDto
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | errors.ErrorDto
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.SubscribersV1ControllerUpdateSubscriberRequest = {
+    updateSubscriberRequestDto: updateSubscriberRequestDto,
+    subscriberId: subscriberId,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.SubscribersV1ControllerUpdateSubscriberRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.UpdateSubscriberRequestDto, {
+    explode: true,
+  });
+
+  const pathParams = {
+    subscriberId: encodeSimple("subscriberId", payload.subscriberId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/subscribers/{subscriberId}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "SubscribersV1Controller_updateSubscriber",
+    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: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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.SubscribersV1ControllerUpdateSubscriberResponse,
+    | errors.ErrorDto
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | errors.ErrorDto
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations.SubscribersV1ControllerUpdateSubscriberResponse$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/hooks/types.ts

@@ -9,7 +9,7 @@ import { SecurityState } from "../lib/security.js";
 export type HookContext = {
   baseURL: string | URL;
   operationID: string;
-  oAuth2Scopes?: string[];
+  oAuth2Scopes: string[] | null;
   securitySource?: any | (() => Promise<any>);
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;

package/src/lib/config.ts

@@ -55,7 +55,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "0.6.0",
-  genVersion: "2.558.2",
-  userAgent: "speakeasy-sdk/typescript 0.6.0 2.558.2 1.0 @novu/api",
+  sdkVersion: "0.6.2",
+  genVersion: "2.563.1",
+  userAgent: "speakeasy-sdk/typescript 0.6.2 2.563.1 1.0 @novu/api",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.6.0",
+    currentVersion: "0.6.2",
   },
 });
 

package/src/mcp-server/server.ts

@@ -48,6 +48,7 @@ import { tool$subscribersPreferencesUpdate } from "./tools/subscribersPreference
 import { tool$subscribersPropertiesUpdateOnlineFlag } from "./tools/subscribersPropertiesUpdateOnlineFlag.js";
 import { tool$subscribersRetrieve } from "./tools/subscribersRetrieve.js";
 import { tool$subscribersSearch } from "./tools/subscribersSearch.js";
+import { tool$subscribersUpsert } from "./tools/subscribersUpsert.js";
 import { tool$topicsCreate } from "./tools/topicsCreate.js";
 import { tool$topicsDelete } from "./tools/topicsDelete.js";
 import { tool$topicsList } from "./tools/topicsList.js";
@@ -70,7 +71,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "0.6.0",
+    version: "0.6.2",
   });
 
   const client = new NovuCore({
@@ -110,6 +111,7 @@ export function createMCPServer(deps: {
   tool(tool$subscribersPatch);
   tool(tool$subscribersDelete);
   tool(tool$subscribersList);
+  tool(tool$subscribersUpsert);
   tool(tool$subscribersCreateBulk);
   tool(tool$integrationsList);
   tool(tool$integrationsCreate);

package/src/mcp-server/tools/subscribersUpsert.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersUpsert } from "../../funcs/subscribersUpsert.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateSubscriberRequestDto:
+    components.UpdateSubscriberRequestDto$inboundSchema,
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersUpsert: ToolDefinition<typeof args> = {
+  name: "subscribers-upsert",
+  description: `Upsert subscriber
+
+Used to upsert the subscriber entity with new information`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersUpsert(
+      client,
+      args.updateSubscriberRequestDto,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/index.ts

@@ -111,6 +111,7 @@ export * from "./updatedsubscriberdto.js";
 export * from "./updateintegrationrequestdto.js";
 export * from "./updatesubscriberchannelrequestdto.js";
 export * from "./updatesubscriberonlineflagrequestdto.js";
+export * from "./updatesubscriberrequestdto.js";
 export * from "./workflowinfodto.js";
 export * from "./workfloworiginenum.js";
 export * from "./workflowpreferencedto.js";

package/src/models/components/updatesubscriberrequestdto.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SubscriberChannelDto,
+  SubscriberChannelDto$inboundSchema,
+  SubscriberChannelDto$Outbound,
+  SubscriberChannelDto$outboundSchema,
+} from "./subscriberchanneldto.js";
+
+export type UpdateSubscriberRequestDto = {
+  /**
+   * The email address of the subscriber.
+   */
+  email?: string | undefined;
+  /**
+   * The first name of the subscriber.
+   */
+  firstName?: string | undefined;
+  /**
+   * The last name of the subscriber.
+   */
+  lastName?: string | undefined;
+  /**
+   * The phone number of the subscriber.
+   */
+  phone?: string | undefined;
+  /**
+   * The avatar URL of the subscriber.
+   */
+  avatar?: string | undefined;
+  /**
+   * The locale of the subscriber, for example "en-US".
+   */
+  locale?: string | undefined;
+  /**
+   * Custom data associated with the subscriber. Can contain any additional properties.
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * An array of communication channels for the subscriber.
+   */
+  channels?: Array<SubscriberChannelDto> | undefined;
+};
+
+/** @internal */
+export const UpdateSubscriberRequestDto$inboundSchema: z.ZodType<
+  UpdateSubscriberRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string().optional(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  phone: z.string().optional(),
+  avatar: z.string().optional(),
+  locale: z.string().optional(),
+  data: z.record(z.any()).optional(),
+  channels: z.array(SubscriberChannelDto$inboundSchema).optional(),
+});
+
+/** @internal */
+export type UpdateSubscriberRequestDto$Outbound = {
+  email?: string | undefined;
+  firstName?: string | undefined;
+  lastName?: string | undefined;
+  phone?: string | undefined;
+  avatar?: string | undefined;
+  locale?: string | undefined;
+  data?: { [k: string]: any } | undefined;
+  channels?: Array<SubscriberChannelDto$Outbound> | undefined;
+};
+
+/** @internal */
+export const UpdateSubscriberRequestDto$outboundSchema: z.ZodType<
+  UpdateSubscriberRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateSubscriberRequestDto
+> = z.object({
+  email: z.string().optional(),
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+  phone: z.string().optional(),
+  avatar: z.string().optional(),
+  locale: z.string().optional(),
+  data: z.record(z.any()).optional(),
+  channels: z.array(SubscriberChannelDto$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateSubscriberRequestDto$ {
+  /** @deprecated use `UpdateSubscriberRequestDto$inboundSchema` instead. */
+  export const inboundSchema = UpdateSubscriberRequestDto$inboundSchema;
+  /** @deprecated use `UpdateSubscriberRequestDto$outboundSchema` instead. */
+  export const outboundSchema = UpdateSubscriberRequestDto$outboundSchema;
+  /** @deprecated use `UpdateSubscriberRequestDto$Outbound` instead. */
+  export type Outbound = UpdateSubscriberRequestDto$Outbound;
+}
+
+export function updateSubscriberRequestDtoToJSON(
+  updateSubscriberRequestDto: UpdateSubscriberRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateSubscriberRequestDto$outboundSchema.parse(updateSubscriberRequestDto),
+  );
+}
+
+export function updateSubscriberRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateSubscriberRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateSubscriberRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateSubscriberRequestDto' from JSON`,
+  );
+}

package/src/models/components/workflowinfodto.ts

@@ -20,6 +20,10 @@ export type WorkflowInfoDto = {
    * Display name of the workflow
    */
   name: string;
+  /**
+   * last updated date
+   */
+  updatedAt?: string | undefined;
 };
 
 /** @internal */
@@ -31,6 +35,7 @@ export const WorkflowInfoDto$inboundSchema: z.ZodType<
   slug: z.string(),
   identifier: z.string(),
   name: z.string(),
+  updatedAt: z.string().optional(),
 });
 
 /** @internal */
@@ -38,6 +43,7 @@ export type WorkflowInfoDto$Outbound = {
   slug: string;
   identifier: string;
   name: string;
+  updatedAt?: string | undefined;
 };
 
 /** @internal */
@@ -49,6 +55,7 @@ export const WorkflowInfoDto$outboundSchema: z.ZodType<
   slug: z.string(),
   identifier: z.string(),
   name: z.string(),
+  updatedAt: z.string().optional(),
 });
 
 /**

package/src/models/operations/index.ts

@@ -38,6 +38,7 @@ export * from "./subscribersv1controllermarkactionasseen.js";
 export * from "./subscribersv1controllermarkallunreadasread.js";
 export * from "./subscribersv1controllermarkmessagesas.js";
 export * from "./subscribersv1controllermodifysubscriberchannel.js";
+export * from "./subscribersv1controllerupdatesubscriber.js";
 export * from "./subscribersv1controllerupdatesubscriberchannel.js";
 export * from "./subscribersv1controllerupdatesubscriberonlineflag.js";
 export * from "./topicscontrollerassign.js";

package/src/models/operations/subscriberscontrollersearchsubscribers.ts

@@ -10,10 +10,16 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Direction of sorting
+ */
 export const OrderDirection = {
   Asc: "ASC",
   Desc: "DESC",
 } as const;
+/**
+ * Direction of sorting
+ */
 export type OrderDirection = ClosedEnum<typeof OrderDirection>;
 
 export type SubscribersControllerSearchSubscribersRequest = {
@@ -25,6 +31,22 @@ export type SubscribersControllerSearchSubscribersRequest = {
    * Cursor for pagination indicating the ending point before which to fetch results.
    */
   before?: string | undefined;
+  /**
+   * Limit the number of items to return
+   */
+  limit?: number | undefined;
+  /**
+   * Direction of sorting
+   */
+  orderDirection?: OrderDirection | undefined;
+  /**
+   * Field to order by
+   */
+  orderBy?: string | undefined;
+  /**
+   * Include cursor item in response
+   */
+  includeCursor?: boolean | undefined;
   /**
    * Email address of the subscriber to filter results.
    */
@@ -41,9 +63,6 @@ export type SubscribersControllerSearchSubscribersRequest = {
    * Unique identifier of the subscriber to filter results.
    */
   subscriberId?: string | undefined;
-  limit?: number | undefined;
-  orderDirection?: OrderDirection | undefined;
-  orderBy?: any | undefined;
   /**
    * A header for idempotency purposes
    */
@@ -85,13 +104,14 @@ export const SubscribersControllerSearchSubscribersRequest$inboundSchema:
   > = z.object({
     after: z.string().optional(),
     before: z.string().optional(),
+    limit: z.number().optional(),
+    orderDirection: OrderDirection$inboundSchema.optional(),
+    orderBy: z.string().optional(),
+    includeCursor: z.boolean().optional(),
     email: z.string().optional(),
     name: z.string().optional(),
     phone: z.string().optional(),
     subscriberId: z.string().optional(),
-    limit: z.number().optional(),
-    orderDirection: OrderDirection$inboundSchema.optional(),
-    orderBy: z.any().optional(),
     "idempotency-key": z.string().optional(),
   }).transform((v) => {
     return remap$(v, {
@@ -103,13 +123,14 @@ export const SubscribersControllerSearchSubscribersRequest$inboundSchema:
 export type SubscribersControllerSearchSubscribersRequest$Outbound = {
   after?: string | undefined;
   before?: string | undefined;
+  limit?: number | undefined;
+  orderDirection?: string | undefined;
+  orderBy?: string | undefined;
+  includeCursor?: boolean | undefined;
   email?: string | undefined;
   name?: string | undefined;
   phone?: string | undefined;
   subscriberId?: string | undefined;
-  limit?: number | undefined;
-  orderDirection?: string | undefined;
-  orderBy?: any | undefined;
   "idempotency-key"?: string | undefined;
 };
 
@@ -122,13 +143,14 @@ export const SubscribersControllerSearchSubscribersRequest$outboundSchema:
   > = z.object({
     after: z.string().optional(),
     before: z.string().optional(),
+    limit: z.number().optional(),
+    orderDirection: OrderDirection$outboundSchema.optional(),
+    orderBy: z.string().optional(),
+    includeCursor: z.boolean().optional(),
     email: z.string().optional(),
     name: z.string().optional(),
     phone: z.string().optional(),
     subscriberId: z.string().optional(),
-    limit: z.number().optional(),
-    orderDirection: OrderDirection$outboundSchema.optional(),
-    orderBy: z.any().optional(),
     idempotencyKey: z.string().optional(),
   }).transform((v) => {
     return remap$(v, {