@novu/api 3.12.0-rc.0 → 3.13.0

package/src/funcs/channelConnectionsCreate.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create channel connection for a resource and integration
+ * Create a channel connection
  *
  * @remarks
  * Create a new channel connection for a resource for given integration. Only one channel connection is allowed per resource and integration.

package/src/funcs/channelConnectionsDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete channel connection
+ * Delete a channel connection
  *
  * @remarks
  * Delete a specific channel connection by its unique identifier.

package/src/funcs/channelConnectionsList.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List channel connections
+ * List all channel connections
  *
  * @remarks
- * Retrieve all channel connections for a resource.
+ * List all channel connections for a resource.
  */
 export function channelConnectionsList(
   client: NovuCore,

package/src/funcs/channelConnectionsRetrieve.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve channel connection by identifier
+ * Retrieve a channel connection
  *
  * @remarks
  * Retrieve a specific channel connection by its unique identifier.

package/src/funcs/channelConnectionsUpdate.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update channel connection
+ * Update a channel connection
  *
  * @remarks
  * Update an existing channel connection by its unique identifier.

package/src/funcs/channelEndpointsCreate.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create channel endpoint for a resource
+ * Create a channel endpoint
  *
  * @remarks
  * Create a new channel endpoint for a resource.

package/src/funcs/channelEndpointsDelete.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Delete channel endpoint by identifier
+ * Delete a channel endpoint
  *
  * @remarks
  * Delete a specific channel endpoint by its unique identifier.

package/src/funcs/channelEndpointsList.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List channel endpoints
+ * List all channel endpoints
  *
  * @remarks
- * Retrieve all channel endpoints for a resource based on query filters.
+ * List all channel endpoints for a resource based on query filters.
  */
 export function channelEndpointsList(
   client: NovuCore,

package/src/funcs/channelEndpointsRetrieve.ts

@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Retrieve channel endpoint by identifier
+ * Retrieve a channel endpoint
  *
  * @remarks
  * Retrieve a specific channel endpoint by its unique identifier.

package/src/funcs/channelEndpointsUpdate.ts

@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Update channel endpoint
+ * Update a channel endpoint
  *
  * @remarks
  * Update an existing channel endpoint by its unique identifier.

package/src/funcs/notificationsList.ts

@@ -108,6 +108,7 @@ async function $do(
     "search": payload.search,
     "severity": payload.severity,
     "subscriberIds": payload.subscriberIds,
+    "subscriptionId": payload.subscriptionId,
     "templates": payload.templates,
     "topicKey": payload.topicKey,
     "transactionId": payload.transactionId,

package/src/funcs/subscribersPreferencesList.ts

@@ -34,9 +34,7 @@ import { Result } from "../types/fp.js";
  */
 export function subscribersPreferencesList(
   client: NovuCore,
-  subscriberId: string,
-  criticality?: operations.Criticality | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -55,18 +53,14 @@ export function subscribersPreferencesList(
 > {
   return new APIPromise($do(
     client,
-    subscriberId,
-    criticality,
-    idempotencyKey,
+    request,
     options,
   ));
 }
 
 async function $do(
   client: NovuCore,
-  subscriberId: string,
-  criticality?: operations.Criticality | undefined,
-  idempotencyKey?: string | undefined,
+  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -86,15 +80,8 @@ async function $do(
     APICall,
   ]
 > {
-  const input: operations.SubscribersControllerGetSubscriberPreferencesRequest =
-    {
-      subscriberId: subscriberId,
-      criticality: criticality,
-      idempotencyKey: idempotencyKey,
-    };
-
   const parsed = safeParse(
-    input,
+    request,
     (value) =>
       operations
         .SubscribersControllerGetSubscriberPreferencesRequest$outboundSchema
@@ -119,6 +106,7 @@ async function $do(
   );
 
   const query = encodeFormQuery({
+    "contextKeys": payload.contextKeys,
     "criticality": payload.criticality,
   });
 

package/src/funcs/subscribersTopicsList.ts

@@ -107,6 +107,7 @@ async function $do(
   const query = encodeFormQuery({
     "after": payload.after,
     "before": payload.before,
+    "contextKeys": payload.contextKeys,
     "includeCursor": payload.includeCursor,
     "key": payload.key,
     "limit": payload.limit,

package/src/funcs/topicsSubscriptionsGetSubscription.ts

@@ -0,0 +1,242 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { NovuCore } from "../core.js";
+import { 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 { NovuError } from "../models/errors/novuerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.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";
+
+/**
+ * Get a topic subscription
+ *
+ * @remarks
+ * Get a subscription by its unique identifier for a topic.
+ */
+export function topicsSubscriptionsGetSubscription(
+  client: NovuCore,
+  topicKey: string,
+  identifier: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.TopicsControllerGetTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    topicKey,
+    identifier,
+    idempotencyKey,
+    options,
+  ));
+}
+
+async function $do(
+  client: NovuCore,
+  topicKey: string,
+  identifier: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.TopicsControllerGetTopicSubscriptionResponse,
+      | errors.ErrorDto
+      | errors.ValidationErrorDto
+      | NovuError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.TopicsControllerGetTopicSubscriptionRequest = {
+    topicKey: topicKey,
+    identifier: identifier,
+    idempotencyKey: idempotencyKey,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.TopicsControllerGetTopicSubscriptionRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    identifier: encodeSimple("identifier", payload.identifier, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    topicKey: encodeSimple("topicKey", payload.topicKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v2/topics/{topicKey}/subscriptions/{identifier}")(
+    pathParams,
+  );
+
+  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 = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "TopicsController_getTopicSubscription",
+    oAuth2Scopes: null,
+
+    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,
+    body: body,
+    userAgent: client._options.userAgent,
+    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.TopicsControllerGetTopicSubscriptionResponse,
+    | errors.ErrorDto
+    | errors.ValidationErrorDto
+    | NovuError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.TopicsControllerGetTopicSubscriptionResponse$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, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/topicsSubscriptionsList.ts

@@ -105,6 +105,7 @@ async function $do(
   const query = encodeFormQuery({
     "after": payload.after,
     "before": payload.before,
+    "contextKeys": payload.contextKeys,
     "includeCursor": payload.includeCursor,
     "limit": payload.limit,
     "orderBy": payload.orderBy,

package/src/funcs/topicsSubscriptionsUpdate.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Update a topic subscription
  *
  * @remarks
- * Update a subscription by its unique identifier **subscriptionIdOrIdentifier** for a topic. You can update the preferences and name associated with the subscription.
+ * Update a subscription by its unique identifier for a topic. You can update the preferences and name associated with the subscription.
  */
 export function topicsSubscriptionsUpdate(
   client: NovuCore,
@@ -95,20 +95,19 @@ async function $do(
   });
 
   const pathParams = {
-    subscriptionIdOrIdentifier: encodeSimple(
-      "subscriptionIdOrIdentifier",
-      payload.subscriptionIdOrIdentifier,
-      { explode: false, charEncoding: "percent" },
-    ),
+    identifier: encodeSimple("identifier", payload.identifier, {
+      explode: false,
+      charEncoding: "percent",
+    }),
     topicKey: encodeSimple("topicKey", payload.topicKey, {
       explode: false,
       charEncoding: "percent",
     }),
   };
 
-  const path = pathToFunc(
-    "/v2/topics/{topicKey}/subscriptions/{subscriptionIdOrIdentifier}",
-  )(pathParams);
+  const path = pathToFunc("/v2/topics/{topicKey}/subscriptions/{identifier}")(
+    pathParams,
+  );
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",

package/src/funcs/trigger.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  *
- *     Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Additional information can be passed according the body interface below.
+ *     Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.
  *     To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.
  */
 export function trigger(

package/src/lib/config.ts

@@ -58,8 +58,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "3.11.0",
-  sdkVersion: "3.12.0-rc.0",
-  genVersion: "2.781.2",
-  userAgent: "speakeasy-sdk/typescript 3.12.0-rc.0 2.781.2 3.11.0 @novu/api",
+  openapiDocVersion: "3.12.0",
+  sdkVersion: "3.13.0",
+  genVersion: "2.801.2",
+  userAgent: "speakeasy-sdk/typescript 3.13.0 2.801.2 3.12.0 @novu/api",
 } as const;

package/src/lib/sdks.ts

@@ -304,9 +304,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -50,7 +50,7 @@ export type ActivityNotificationJobResponseDtoType = ClosedEnum<
 /**
  * Optional payload for the job
  */
-export type ActivityNotificationJobResponseDtoPayload = {};
+export type Payload = {};
 
 export type ActivityNotificationJobResponseDto = {
   /**
@@ -80,7 +80,7 @@ export type ActivityNotificationJobResponseDto = {
   /**
    * Optional payload for the job
    */
-  payload?: ActivityNotificationJobResponseDtoPayload | undefined;
+  payload?: Payload | undefined;
   /**
    * Provider ID of the job
    */
@@ -106,25 +106,16 @@ export const ActivityNotificationJobResponseDtoType$inboundSchema:
   );
 
 /** @internal */
-export const ActivityNotificationJobResponseDtoPayload$inboundSchema: z.ZodType<
-  ActivityNotificationJobResponseDtoPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
+  z.object({});
 
-export function activityNotificationJobResponseDtoPayloadFromJSON(
+export function payloadFromJSON(
   jsonString: string,
-): SafeParseResult<
-  ActivityNotificationJobResponseDtoPayload,
-  SDKValidationError
-> {
+): SafeParseResult<Payload, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      ActivityNotificationJobResponseDtoPayload$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'ActivityNotificationJobResponseDtoPayload' from JSON`,
+    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payload' from JSON`,
   );
 }
 
@@ -142,8 +133,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
   ),
   step: ActivityNotificationStepResponseDto$inboundSchema,
   overrides: z.record(z.any()).optional(),
-  payload: z.lazy(() => ActivityNotificationJobResponseDtoPayload$inboundSchema)
-    .optional(),
+  payload: z.lazy(() => Payload$inboundSchema).optional(),
   providerId: ProvidersIdEnum$inboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),

package/src/models/components/bulkupdatesubscriberpreferencesdto.ts

@@ -9,16 +9,75 @@ import {
   BulkUpdateSubscriberPreferenceItemDto$outboundSchema,
 } from "./bulkupdatesubscriberpreferenceitemdto.js";
 
+/**
+ * Rich context object with id and optional data
+ */
+export type Context2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type BulkUpdateSubscriberPreferencesDtoContext = Context2 | string;
+
 export type BulkUpdateSubscriberPreferencesDto = {
   /**
    * Array of workflow preferences to update (maximum 100 items)
    */
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto>;
+  context?: { [k: string]: Context2 | string } | undefined;
 };
 
+/** @internal */
+export type Context2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const Context2$outboundSchema: z.ZodType<
+  Context2$Outbound,
+  z.ZodTypeDef,
+  Context2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function context2ToJSON(context2: Context2): string {
+  return JSON.stringify(Context2$outboundSchema.parse(context2));
+}
+
+/** @internal */
+export type BulkUpdateSubscriberPreferencesDtoContext$Outbound =
+  | Context2$Outbound
+  | string;
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDtoContext$outboundSchema:
+  z.ZodType<
+    BulkUpdateSubscriberPreferencesDtoContext$Outbound,
+    z.ZodTypeDef,
+    BulkUpdateSubscriberPreferencesDtoContext
+  > = z.union([z.lazy(() => Context2$outboundSchema), z.string()]);
+
+export function bulkUpdateSubscriberPreferencesDtoContextToJSON(
+  bulkUpdateSubscriberPreferencesDtoContext:
+    BulkUpdateSubscriberPreferencesDtoContext,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferencesDtoContext$outboundSchema.parse(
+      bulkUpdateSubscriberPreferencesDtoContext,
+    ),
+  );
+}
+
 /** @internal */
 export type BulkUpdateSubscriberPreferencesDto$Outbound = {
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto$Outbound>;
+  context?: { [k: string]: Context2$Outbound | string } | undefined;
 };
 
 /** @internal */
@@ -28,6 +87,9 @@ export const BulkUpdateSubscriberPreferencesDto$outboundSchema: z.ZodType<
   BulkUpdateSubscriberPreferencesDto
 > = z.object({
   preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$outboundSchema),
+  context: z.record(
+    z.union([z.lazy(() => Context2$outboundSchema), z.string()]),
+  ).optional(),
 });
 
 export function bulkUpdateSubscriberPreferencesDtoToJSON(