@novu/api 3.12.0-rc.0 → 3.12.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/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/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

@@ -59,7 +59,7 @@ 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",
+  sdkVersion: "3.12.0",
+  genVersion: "2.792.0",
+  userAgent: "speakeasy-sdk/typescript 3.12.0 2.792.0 3.11.0 @novu/api",
 } as const;

package/src/models/components/delaystepresponsedto.ts

@@ -64,7 +64,7 @@ export type DelayStepResponseDtoControlValues = {
   /**
    * Type of the delay. Currently only 'regular' is supported by the schema.
    */
-  type?: DelayStepResponseDtoType | undefined;
+  type: DelayStepResponseDtoType;
   /**
    * Amount of time to delay.
    */

package/src/models/components/emailstepresponsedto.ts

@@ -50,15 +50,15 @@ export type EmailStepResponseDtoControlValues = {
   /**
    * Body content of the email, either a valid Maily JSON object, or html string.
    */
-  body?: string | undefined;
+  body: string;
   /**
    * Type of editor to use for the body.
    */
-  editorType?: EmailStepResponseDtoEditorType | undefined;
+  editorType: EmailStepResponseDtoEditorType;
   /**
    * Disable sanitization of the output.
    */
-  disableOutputSanitization?: boolean | undefined;
+  disableOutputSanitization: boolean;
   /**
    * Layout ID to use for the email. Null means no layout, undefined means default layout.
    */

package/src/models/components/generatechatoauthurlrequestdto.ts

@@ -29,7 +29,7 @@ export type GenerateChatOauthUrlRequestDto = {
    */
   integrationIdentifier: string;
   /**
-   * Identifier of the channel connection that will be created
+   * Identifier of the channel connection that will be created. It is generated automatically if not provided.
    */
   connectionIdentifier?: string | undefined;
   context?:

package/src/models/components/inappcontroldto.ts

@@ -33,7 +33,7 @@ export type InAppControlDto = {
    */
   subject?: string | undefined;
   /**
-   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
    */
   avatar?: string | undefined;
   /**

package/src/models/components/inappstepresponsedto.ts

@@ -39,7 +39,7 @@ export type InAppStepResponseDtoControlValues = {
    */
   subject?: string | undefined;
   /**
-   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   * URL for an avatar image. Must be a valid URL or start with / or {{ variable }}.
    */
   avatar?: string | undefined;
   /**
@@ -57,7 +57,7 @@ export type InAppStepResponseDtoControlValues = {
   /**
    * Disable sanitization of the output.
    */
-  disableOutputSanitization?: boolean | undefined;
+  disableOutputSanitization: boolean;
   /**
    * Additional data payload for the step.
    */

package/src/models/components/notificationfeeditemdto.ts

@@ -122,6 +122,10 @@ export type NotificationFeedItemDto = {
    * Indicates whether the notification has been seen by the subscriber.
    */
   seen: boolean;
+  /**
+   * Indicates whether the notification has been archived by the subscriber.
+   */
+  archived: boolean;
   /**
    * Device tokens for push notifications, if applicable.
    */
@@ -188,6 +192,7 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
   channel: ChannelTypeEnum$inboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
+  archived: z.boolean(),
   deviceTokens: z.nullable(z.array(z.string())).optional(),
   cta: MessageCTA$inboundSchema,
   status: NotificationFeedItemDtoStatus$inboundSchema,

package/src/models/components/redirectdto.ts

@@ -25,7 +25,7 @@ export type Target = ClosedEnum<typeof Target>;
 
 export type RedirectDto = {
   /**
-   * URL for redirection. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   * URL for redirection. Must be a valid URL or start with / or {{ variable }}.
    */
   url?: string | undefined;
   /**

package/src/models/components/throttlestepresponsedto.ts

@@ -61,7 +61,7 @@ export type ThrottleStepResponseDtoControlValues = {
   /**
    * The type of throttle window.
    */
-  type?: ThrottleStepResponseDtoType | undefined;
+  type: ThrottleStepResponseDtoType;
   /**
    * The amount of time for the throttle window (required for fixed type).
    */
@@ -77,7 +77,7 @@ export type ThrottleStepResponseDtoControlValues = {
   /**
    * The maximum number of executions allowed within the window. Defaults to 1.
    */
-  threshold?: number | undefined;
+  threshold: number;
   /**
    * Optional key for grouping throttle rules. If not provided, defaults to workflow and subscriber combination.
    */

package/src/models/components/topicsubscriptionresponsedto.ts

@@ -18,6 +18,10 @@ export type TopicSubscriptionResponseDto = {
    * The identifier of the subscription
    */
   id: string;
+  /**
+   * The identifier of the subscription
+   */
+  identifier: string;
   /**
    * The date and time the subscription was created
    */
@@ -39,6 +43,7 @@ export const TopicSubscriptionResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string(),
+  identifier: z.string(),
   createdAt: z.string(),
   topic: TopicResponseDto$inboundSchema,
   subscriber: SubscriberDto$inboundSchema,

package/src/models/components/triggereventrequestdto.ts

@@ -99,7 +99,7 @@ export type Overrides = {
 export type To1 = TopicPayloadDto | SubscriberPayloadDto | string;
 
 /**
- * The recipients list of people who will receive the notification.
+ * The recipients list of people who will receive the notification. Maximum number of recipients can be 100.
  */
 export type To =
   | TopicPayloadDto
@@ -156,7 +156,7 @@ export type TriggerEventRequestDto = {
    */
   overrides?: Overrides | undefined;
   /**
-   * The recipients list of people who will receive the notification.
+   * The recipients list of people who will receive the notification. Maximum number of recipients can be 100.
    */
   to:
     | TopicPayloadDto

package/src/models/components/workflowresponsedto.ts

@@ -135,7 +135,7 @@ export type WorkflowResponseDto = {
   /**
    * Whether the workflow is active
    */
-  active?: boolean | undefined;
+  active: boolean;
   /**
    * Enable or disable payload schema validation
    */
@@ -147,7 +147,7 @@ export type WorkflowResponseDto = {
   /**
    * Enable or disable translations for this workflow
    */
-  isTranslationEnabled?: boolean | undefined;
+  isTranslationEnabled: boolean;
   /**
    * Database identifier of the workflow
    */

package/src/models/operations/index.ts

@@ -71,6 +71,7 @@ export * from "./topicscontrollercreatetopicsubscriptions.js";
 export * from "./topicscontrollerdeletetopic.js";
 export * from "./topicscontrollerdeletetopicsubscriptions.js";
 export * from "./topicscontrollergettopic.js";
+export * from "./topicscontrollergettopicsubscription.js";
 export * from "./topicscontrollerlisttopics.js";
 export * from "./topicscontrollerlisttopicsubscriptions.js";
 export * from "./topicscontrollerupdatetopic.js";

package/src/models/operations/notificationscontrollerlistnotifications.ts

@@ -52,6 +52,10 @@ export type NotificationsControllerListNotificationsRequest = {
    * Topic Key for filtering notifications by topic
    */
   topicKey?: string | undefined;
+  /**
+   * Subscription ID for filtering notifications by subscription
+   */
+  subscriptionId?: string | undefined;
   /**
    * Filter by exact context keys, order insensitive (format: "type:id")
    */
@@ -87,6 +91,7 @@ export type NotificationsControllerListNotificationsRequest$Outbound = {
   limit: number;
   transactionId?: string | undefined;
   topicKey?: string | undefined;
+  subscriptionId?: string | undefined;
   contextKeys?: Array<string> | undefined;
   after?: string | undefined;
   before?: string | undefined;
@@ -110,6 +115,7 @@ export const NotificationsControllerListNotificationsRequest$outboundSchema:
     limit: z.number().default(10),
     transactionId: z.string().optional(),
     topicKey: z.string().optional(),
+    subscriptionId: z.string().optional(),
     contextKeys: z.array(z.string()).optional(),
     after: z.string().optional(),
     before: z.string().optional(),