@novu/api 3.14.0 → 3.14.2-rc.1

package/src/sdk/environments.ts

@@ -4,8 +4,10 @@
 
 import { environmentsCreate } from "../funcs/environmentsCreate.js";
 import { environmentsDelete } from "../funcs/environmentsDelete.js";
+import { environmentsDiff } from "../funcs/environmentsDiff.js";
 import { environmentsGetTags } from "../funcs/environmentsGetTags.js";
 import { environmentsList } from "../funcs/environmentsList.js";
+import { environmentsPublish } from "../funcs/environmentsPublish.js";
 import { environmentsUpdate } from "../funcs/environmentsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -32,6 +34,48 @@ export class Environments extends ClientSDK {
     ));
   }
 
+  /**
+   * Compare resources between environments
+   *
+   * @remarks
+   * Compares workflows and other resources between the source and target environments, returning detailed diff information including additions, modifications, and deletions.
+   */
+  async diff(
+    diffEnvironmentRequestDto: components.DiffEnvironmentRequestDto,
+    targetEnvironmentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.EnvironmentsControllerDiffEnvironmentResponse> {
+    return unwrapAsync(environmentsDiff(
+      this,
+      diffEnvironmentRequestDto,
+      targetEnvironmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Publish resources to target environment
+   *
+   * @remarks
+   * Publishes all workflows and resources from the source environment to the target environment. Optionally specify specific resources to publish or use dryRun mode to preview changes.
+   */
+  async publish(
+    publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto,
+    targetEnvironmentId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.EnvironmentsControllerPublishEnvironmentResponse> {
+    return unwrapAsync(environmentsPublish(
+      this,
+      publishEnvironmentRequestDto,
+      targetEnvironmentId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Create an environment
    *

package/src/sdk/environmentvariables.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { environmentVariablesCreate } from "../funcs/environmentVariablesCreate.js";
+import { environmentVariablesDelete } from "../funcs/environmentVariablesDelete.js";
+import { environmentVariablesList } from "../funcs/environmentVariablesList.js";
+import { environmentVariablesRetrieve } from "../funcs/environmentVariablesRetrieve.js";
+import { environmentVariablesUpdate } from "../funcs/environmentVariablesUpdate.js";
+import { environmentVariablesUsage } from "../funcs/environmentVariablesUsage.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";
+
+export class EnvironmentVariables extends ClientSDK {
+  /**
+   * List environment variables
+   *
+   * @remarks
+   * Returns all environment variables for the current organization. Secret values are masked.
+   */
+  async list(
+    search?: string | undefined,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerListEnvironmentVariablesResponse
+  > {
+    return unwrapAsync(environmentVariablesList(
+      this,
+      search,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Create environment variable
+   *
+   * @remarks
+   * Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
+   */
+  async create(
+    createEnvironmentVariableRequestDto:
+      components.CreateEnvironmentVariableRequestDto,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerCreateEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesCreate(
+      this,
+      createEnvironmentVariableRequestDto,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Get environment variable
+   *
+   * @remarks
+   * Returns a single environment variable by id. Secret values are masked.
+   */
+  async retrieve(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerGetEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesRetrieve(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Update environment variable
+   *
+   * @remarks
+   * Updates an existing environment variable. Providing values replaces all existing per-environment values.
+   */
+  async update(
+    updateEnvironmentVariableRequestDto:
+      components.UpdateEnvironmentVariableRequestDto,
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerUpdateEnvironmentVariableResponse
+  > {
+    return unwrapAsync(environmentVariablesUpdate(
+      this,
+      updateEnvironmentVariableRequestDto,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete environment variable
+   *
+   * @remarks
+   * Deletes an environment variable by id.
+   */
+  async delete(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.EnvironmentVariablesControllerDeleteEnvironmentVariableResponse
+    | undefined
+  > {
+    return unwrapAsync(environmentVariablesDelete(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Get environment variable usage
+   *
+   * @remarks
+   * Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls.
+   */
+  async usage(
+    variableId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.EnvironmentVariablesControllerGetEnvironmentVariableUsageResponse
+  > {
+    return unwrapAsync(environmentVariablesUsage(
+      this,
+      variableId,
+      idempotencyKey,
+      options,
+    ));
+  }
+}

package/src/sdk/novunotifications.ts

@@ -2,13 +2,353 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { subscribersNotificationsArchive } from "../funcs/subscribersNotificationsArchive.js";
+import { subscribersNotificationsArchiveAll } from "../funcs/subscribersNotificationsArchiveAll.js";
+import { subscribersNotificationsArchiveAllRead } from "../funcs/subscribersNotificationsArchiveAllRead.js";
+import { subscribersNotificationsCompleteAction } from "../funcs/subscribersNotificationsCompleteAction.js";
+import { subscribersNotificationsCount } from "../funcs/subscribersNotificationsCount.js";
+import { subscribersNotificationsDelete } from "../funcs/subscribersNotificationsDelete.js";
+import { subscribersNotificationsDeleteAll } from "../funcs/subscribersNotificationsDeleteAll.js";
 import { subscribersNotificationsFeed } from "../funcs/subscribersNotificationsFeed.js";
+import { subscribersNotificationsList } from "../funcs/subscribersNotificationsList.js";
+import { subscribersNotificationsMarkAllAsRead } from "../funcs/subscribersNotificationsMarkAllAsRead.js";
+import { subscribersNotificationsMarkAsRead } from "../funcs/subscribersNotificationsMarkAsRead.js";
+import { subscribersNotificationsMarkAsSeen } from "../funcs/subscribersNotificationsMarkAsSeen.js";
+import { subscribersNotificationsMarkAsUnread } from "../funcs/subscribersNotificationsMarkAsUnread.js";
+import { subscribersNotificationsRevertAction } from "../funcs/subscribersNotificationsRevertAction.js";
+import { subscribersNotificationsSnooze } from "../funcs/subscribersNotificationsSnooze.js";
+import { subscribersNotificationsUnarchive } from "../funcs/subscribersNotificationsUnarchive.js";
 import { subscribersNotificationsUnseenCount } from "../funcs/subscribersNotificationsUnseenCount.js";
+import { subscribersNotificationsUnsnooze } from "../funcs/subscribersNotificationsUnsnooze.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";
 
 export class NovuNotifications extends ClientSDK {
+  /**
+   * Retrieve subscriber notifications
+   *
+   * @remarks
+   * Retrieve in-app notifications for a subscriber by its unique key identifier **subscriberId**.
+   *     Supports filtering by tags, read/archived/snoozed/seen state, data attributes, severity, date range, and context keys.
+   */
+  async list(
+    request: operations.SubscribersControllerGetSubscriberNotificationsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerGetSubscriberNotificationsResponse
+  > {
+    return unwrapAsync(subscribersNotificationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete notification
+   *
+   * @remarks
+   * Delete a specific notification by its unique identifier **notificationId**.
+   */
+  async delete(
+    request: operations.SubscribersControllerDeleteNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerDeleteNotificationResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Complete notification action
+   *
+   * @remarks
+   * Mark a notification action (primary or secondary) as completed by its unique identifier **notificationId** and action type.
+   */
+  async completeAction(
+    request: operations.SubscribersControllerCompleteNotificationActionRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerCompleteNotificationActionResponse
+  > {
+    return unwrapAsync(subscribersNotificationsCompleteAction(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Revert notification action
+   *
+   * @remarks
+   * Revert a notification action (primary or secondary) to pending state by its unique identifier **notificationId** and action type.
+   */
+  async revertAction(
+    request: operations.SubscribersControllerRevertNotificationActionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerRevertNotificationActionResponse> {
+    return unwrapAsync(subscribersNotificationsRevertAction(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Archive notification
+   *
+   * @remarks
+   * Archive a specific notification by its unique identifier **notificationId**.
+   */
+  async archive(
+    request: operations.SubscribersControllerArchiveNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerArchiveNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsArchive(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notification as read
+   *
+   * @remarks
+   * Mark a specific notification as read by its unique identifier **notificationId**.
+   */
+  async markAsRead(
+    request: operations.SubscribersControllerMarkNotificationAsReadRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerMarkNotificationAsReadResponse> {
+    return unwrapAsync(subscribersNotificationsMarkAsRead(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Snooze notification
+   *
+   * @remarks
+   * Snooze a specific notification by its unique identifier **notificationId** until a specified time.
+   */
+  async snooze(
+    request: operations.SubscribersControllerSnoozeNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerSnoozeNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsSnooze(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Unarchive notification
+   *
+   * @remarks
+   * Unarchive a specific notification by its unique identifier **notificationId**.
+   */
+  async unarchive(
+    request: operations.SubscribersControllerUnarchiveNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerUnarchiveNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsUnarchive(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notification as unread
+   *
+   * @remarks
+   * Mark a specific notification as unread by its unique identifier **notificationId**.
+   */
+  async markAsUnread(
+    request: operations.SubscribersControllerMarkNotificationAsUnreadRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerMarkNotificationAsUnreadResponse> {
+    return unwrapAsync(subscribersNotificationsMarkAsUnread(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Unsnooze notification
+   *
+   * @remarks
+   * Unsnooze a specific notification by its unique identifier **notificationId**.
+   */
+  async unsnooze(
+    request: operations.SubscribersControllerUnsnoozeNotificationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.SubscribersControllerUnsnoozeNotificationResponse> {
+    return unwrapAsync(subscribersNotificationsUnsnooze(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Archive all notifications
+   *
+   * @remarks
+   * Archive all notifications matching the specified filters. Supports context-based filtering.
+   */
+  async archiveAll(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerArchiveAllNotificationsResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsArchiveAll(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve subscriber notifications count
+   *
+   * @remarks
+   * Retrieve count of notifications for a subscriber by its unique key identifier **subscriberId**.
+   *     Supports multiple filters to count notifications by different criteria, including context keys.
+   */
+  async count(
+    subscriberId: string,
+    filters: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerGetSubscriberNotificationsCountResponse
+  > {
+    return unwrapAsync(subscribersNotificationsCount(
+      this,
+      subscriberId,
+      filters,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Delete all notifications
+   *
+   * @remarks
+   * Delete all notifications matching the specified filters. Supports context-based filtering.
+   */
+  async deleteAll(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerDeleteAllNotificationsResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsDeleteAll(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Mark all notifications as read
+   *
+   * @remarks
+   * Mark all notifications matching the specified filters as read. Supports context-based filtering.
+   */
+  async markAllAsRead(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.SubscribersControllerMarkAllNotificationsAsReadResponse
+    | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsMarkAllAsRead(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Archive all read notifications
+   *
+   * @remarks
+   * Archive all read notifications matching the specified filters. Supports context-based filtering.
+   */
+  async archiveAllRead(
+    updateAllSubscriberNotificationsDto:
+      components.UpdateAllSubscriberNotificationsDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    | operations.SubscribersControllerArchiveAllReadNotificationsResponse
+    | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsArchiveAllRead(
+      this,
+      updateAllSubscriberNotificationsDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
+  /**
+   * Mark notifications as seen
+   *
+   * @remarks
+   * Mark specific notifications or notifications matching filters as seen. Supports context-based filtering.
+   */
+  async markAsSeen(
+    markSubscriberNotificationsAsSeenDto:
+      components.MarkSubscriberNotificationsAsSeenDto,
+    subscriberId: string,
+    idempotencyKey?: string | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    operations.SubscribersControllerMarkNotificationsAsSeenResponse | undefined
+  > {
+    return unwrapAsync(subscribersNotificationsMarkAsSeen(
+      this,
+      markSubscriberNotificationsAsSeenDto,
+      subscriberId,
+      idempotencyKey,
+      options,
+    ));
+  }
+
   /**
    * Retrieve subscriber notifications
    *

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { ChannelConnections } from "./channelconnections.js";
 import { ChannelEndpoints } from "./channelendpoints.js";
 import { Contexts } from "./contexts.js";
 import { Environments } from "./environments.js";
+import { EnvironmentVariables } from "./environmentvariables.js";
 import { Integrations } from "./integrations.js";
 import { Layouts } from "./layouts.js";
 import { Messages } from "./messages.js";
@@ -75,6 +76,13 @@ export class Novu extends ClientSDK {
     return (this._channelEndpoints ??= new ChannelEndpoints(this._options));
   }
 
+  private _environmentVariables?: EnvironmentVariables;
+  get environmentVariables(): EnvironmentVariables {
+    return (this._environmentVariables ??= new EnvironmentVariables(
+      this._options,
+    ));
+  }
+
   private _integrations?: Integrations;
   get integrations(): Integrations {
     return (this._integrations ??= new Integrations(this._options));

package/src/sdk/steps.ts

@@ -2,12 +2,30 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { workflowsStepsGeneratePreview } from "../funcs/workflowsStepsGeneratePreview.js";
 import { workflowsStepsRetrieve } from "../funcs/workflowsStepsRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Steps extends ClientSDK {
+  /**
+   * Generate step preview
+   *
+   * @remarks
+   * Generates a preview for a specific workflow step by its unique identifier **stepId**
+   */
+  async generatePreview(
+    request: operations.WorkflowControllerGeneratePreviewRequest,
+    options?: RequestOptions,
+  ): Promise<operations.WorkflowControllerGeneratePreviewResponse> {
+    return unwrapAsync(workflowsStepsGeneratePreview(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Retrieve workflow step
    *

package/src/sdk/subscribers.ts

@@ -20,6 +20,11 @@ import { Preferences } from "./preferences.js";
 import { Properties } from "./properties.js";
 
 export class Subscribers extends ClientSDK {
+  private _notifications?: NovuNotifications;
+  get notifications(): NovuNotifications {
+    return (this._notifications ??= new NovuNotifications(this._options));
+  }
+
   private _preferences?: Preferences;
   get preferences(): Preferences {
     return (this._preferences ??= new Preferences(this._options));
@@ -40,11 +45,6 @@ export class Subscribers extends ClientSDK {
     return (this._messages ??= new NovuMessages(this._options));
   }
 
-  private _notifications?: NovuNotifications;
-  get notifications(): NovuNotifications {
-    return (this._notifications ??= new NovuNotifications(this._options));
-  }
-
   private _properties?: Properties;
   get properties(): Properties {
     return (this._properties ??= new Properties(this._options));

package/_speakeasy/.github/action-inputs-config.json

@@ -1,53 +0,0 @@
-[
-  {
-    "name": "mode",
-    "validation_regex": "/^(direct|pr)$/.source",
-    "validation_message": "Must be `direct` or `pr`"
-  },
-  {
-    "name": "speakeasy_version",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "openapi_doc_location",
-    "validation_regex": "/^((https?):\\/\\/([\\w\\-]+\\.)+\\w+(\\/.*)?|[\\w.\\-\\/]+)$/i.source",
-    "validation_message": "Must be a valid server URL or file path containing letters, numbers, or .-_/ only"
-  },
-  {
-    "name": "openapi_doc_auth_header",
-    "validation_regex": "/^[A-Za-z\\-]+$/.source",
-    "validation_message": "Letters or - only"
-  },
-  {
-    "name": "create_release"
-  },
-  {
-    "name": "publish_python",
-    "language": "python"
-  },
-  {
-    "name": "publish_typescript",
-    "language": "typescript"
-  },
-  {
-    "name": "publish_java",
-    "language": "java"
-  },
-  {
-    "name": "publish_php",
-    "language": "php"
-  },
-  {
-    "name": "publish_ruby",
-    "language": "ruby"
-  },
-  {
-    "name": "publish_csharp",
-    "language": "csharp"
-  },
-  {
-    "name": "publish_terraform",
-    "language": "terraform"
-  }
-]