@novu/api 3.14.0 → 3.14.2

package/src/models/components/workflowresponsedto.ts

@@ -27,6 +27,10 @@ import {
   EmailStepResponseDto,
   EmailStepResponseDto$inboundSchema,
 } from "./emailstepresponsedto.js";
+import {
+  HttpRequestStepResponseDto,
+  HttpRequestStepResponseDto$inboundSchema,
+} from "./httprequeststepresponsedto.js";
 import {
   InAppStepResponseDto,
   InAppStepResponseDto$inboundSchema,
@@ -117,7 +121,8 @@ export type WorkflowResponseDtoSteps =
   | DelayStepResponseDto
   | DigestStepResponseDto
   | CustomStepResponseDto
-  | ThrottleStepResponseDto;
+  | ThrottleStepResponseDto
+  | HttpRequestStepResponseDto;
 
 export type WorkflowResponseDto = {
   /**
@@ -193,6 +198,7 @@ export type WorkflowResponseDto = {
     | DigestStepResponseDto
     | CustomStepResponseDto
     | ThrottleStepResponseDto
+    | HttpRequestStepResponseDto
   >;
   /**
    * Origin of the layout
@@ -291,6 +297,7 @@ export const WorkflowResponseDtoSteps$inboundSchema: z.ZodType<
   DigestStepResponseDto$inboundSchema,
   CustomStepResponseDto$inboundSchema,
   ThrottleStepResponseDto$inboundSchema,
+  HttpRequestStepResponseDto$inboundSchema,
 ]);
 
 export function workflowResponseDtoStepsFromJSON(
@@ -338,6 +345,7 @@ export const WorkflowResponseDto$inboundSchema: z.ZodType<
       DigestStepResponseDto$inboundSchema,
       CustomStepResponseDto$inboundSchema,
       ThrottleStepResponseDto$inboundSchema,
+      HttpRequestStepResponseDto$inboundSchema,
     ]),
   ),
   origin: ResourceOriginEnum$inboundSchema,

package/src/models/errors/subscriberresponsedto.ts

@@ -15,11 +15,11 @@ export type SubscriberResponseDtoData = {
   /**
    * The first name of the subscriber.
    */
-  firstName?: string | null | undefined;
+  firstName: string | null;
   /**
    * The last name of the subscriber.
    */
-  lastName?: string | null | undefined;
+  lastName: string | null;
   /**
    * The email address of the subscriber.
    */
@@ -49,11 +49,11 @@ export type SubscriberResponseDtoData = {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline?: boolean | null | undefined;
+  isOnline: boolean | null;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt?: string | null | undefined;
+  lastOnlineAt: string | null;
   /**
    * The version of the subscriber document.
    */
@@ -100,11 +100,11 @@ export class SubscriberResponseDto extends NovuError {
   /**
    * The first name of the subscriber.
    */
-  firstName?: string | null | undefined;
+  firstName: string | null;
   /**
    * The last name of the subscriber.
    */
-  lastName?: string | null | undefined;
+  lastName: string | null;
   /**
    * The email address of the subscriber.
    */
@@ -134,11 +134,11 @@ export class SubscriberResponseDto extends NovuError {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline?: boolean | null | undefined;
+  isOnline: boolean | null;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt?: string | null | undefined;
+  lastOnlineAt: string | null;
   /**
    * The version of the subscriber document.
    */
@@ -189,16 +189,16 @@ export class SubscriberResponseDto extends NovuError {
     super(message, httpMeta);
     this.data$ = err;
     if (err.id != null) this.id = err.id;
-    if (err.firstName != null) this.firstName = err.firstName;
-    if (err.lastName != null) this.lastName = err.lastName;
+    this.firstName = err.firstName;
+    this.lastName = err.lastName;
     if (err.email != null) this.email = err.email;
     if (err.phone != null) this.phone = err.phone;
     if (err.avatar != null) this.avatar = err.avatar;
     if (err.locale != null) this.locale = err.locale;
     if (err.channels != null) this.channels = err.channels;
     if (err.topics != null) this.topics = err.topics;
-    if (err.isOnline != null) this.isOnline = err.isOnline;
-    if (err.lastOnlineAt != null) this.lastOnlineAt = err.lastOnlineAt;
+    this.isOnline = err.isOnline;
+    this.lastOnlineAt = err.lastOnlineAt;
     if (err.v != null) this.v = err.v;
     if (err.data != null) this.data = err.data;
     if (err.timezone != null) this.timezone = err.timezone;
@@ -220,16 +220,16 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  firstName: z.nullable(z.string()).optional(),
-  lastName: z.nullable(z.string()).optional(),
+  firstName: z.nullable(z.string()),
+  lastName: z.nullable(z.string()),
   email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   locale: z.nullable(z.string()).optional(),
   channels: z.array(components.ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.nullable(z.boolean()).optional(),
-  lastOnlineAt: z.nullable(z.string()).optional(),
+  isOnline: z.nullable(z.boolean()),
+  lastOnlineAt: z.nullable(z.string()),
   __v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
   timezone: z.nullable(z.string()).optional(),

package/src/models/operations/environmentscontrollerdiffenvironment.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerDiffEnvironmentRequest = {
+  /**
+   * Target environment ID (MongoDB ObjectId) to compare against
+   */
+  targetEnvironmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Diff request configuration
+   */
+  diffEnvironmentRequestDto: components.DiffEnvironmentRequestDto;
+};
+
+export type EnvironmentsControllerDiffEnvironmentResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.DiffEnvironmentResponseDto;
+};
+
+/** @internal */
+export type EnvironmentsControllerDiffEnvironmentRequest$Outbound = {
+  targetEnvironmentId: string;
+  "idempotency-key"?: string | undefined;
+  DiffEnvironmentRequestDto: components.DiffEnvironmentRequestDto$Outbound;
+};
+
+/** @internal */
+export const EnvironmentsControllerDiffEnvironmentRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerDiffEnvironmentRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerDiffEnvironmentRequest
+  > = z.object({
+    targetEnvironmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+    diffEnvironmentRequestDto:
+      components.DiffEnvironmentRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      diffEnvironmentRequestDto: "DiffEnvironmentRequestDto",
+    });
+  });
+
+export function environmentsControllerDiffEnvironmentRequestToJSON(
+  environmentsControllerDiffEnvironmentRequest:
+    EnvironmentsControllerDiffEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerDiffEnvironmentRequest$outboundSchema.parse(
+      environmentsControllerDiffEnvironmentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerDiffEnvironmentResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerDiffEnvironmentResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.DiffEnvironmentResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerDiffEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerDiffEnvironmentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerDiffEnvironmentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerDiffEnvironmentResponse' from JSON`,
+  );
+}

package/src/models/operations/environmentscontrollerpublishenvironment.ts

@@ -0,0 +1,99 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EnvironmentsControllerPublishEnvironmentRequest = {
+  /**
+   * Target environment ID (MongoDB ObjectId) to publish resources to
+   */
+  targetEnvironmentId: string;
+  /**
+   * A header for idempotency purposes
+   */
+  idempotencyKey?: string | undefined;
+  /**
+   * Publish request configuration
+   */
+  publishEnvironmentRequestDto: components.PublishEnvironmentRequestDto;
+};
+
+export type EnvironmentsControllerPublishEnvironmentResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.PublishEnvironmentResponseDto;
+};
+
+/** @internal */
+export type EnvironmentsControllerPublishEnvironmentRequest$Outbound = {
+  targetEnvironmentId: string;
+  "idempotency-key"?: string | undefined;
+  PublishEnvironmentRequestDto:
+    components.PublishEnvironmentRequestDto$Outbound;
+};
+
+/** @internal */
+export const EnvironmentsControllerPublishEnvironmentRequest$outboundSchema:
+  z.ZodType<
+    EnvironmentsControllerPublishEnvironmentRequest$Outbound,
+    z.ZodTypeDef,
+    EnvironmentsControllerPublishEnvironmentRequest
+  > = z.object({
+    targetEnvironmentId: z.string(),
+    idempotencyKey: z.string().optional(),
+    publishEnvironmentRequestDto:
+      components.PublishEnvironmentRequestDto$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      idempotencyKey: "idempotency-key",
+      publishEnvironmentRequestDto: "PublishEnvironmentRequestDto",
+    });
+  });
+
+export function environmentsControllerPublishEnvironmentRequestToJSON(
+  environmentsControllerPublishEnvironmentRequest:
+    EnvironmentsControllerPublishEnvironmentRequest,
+): string {
+  return JSON.stringify(
+    EnvironmentsControllerPublishEnvironmentRequest$outboundSchema.parse(
+      environmentsControllerPublishEnvironmentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const EnvironmentsControllerPublishEnvironmentResponse$inboundSchema:
+  z.ZodType<
+    EnvironmentsControllerPublishEnvironmentResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: components.PublishEnvironmentResponseDto$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function environmentsControllerPublishEnvironmentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EnvironmentsControllerPublishEnvironmentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentsControllerPublishEnvironmentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EnvironmentsControllerPublishEnvironmentResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -17,7 +17,9 @@ export * from "./contextscontrollerdeletecontext.js";
 export * from "./contextscontrollergetcontext.js";
 export * from "./contextscontrollerlistcontexts.js";
 export * from "./contextscontrollerupdatecontext.js";
+export * from "./environmentscontrollerdiffenvironment.js";
 export * from "./environmentscontrollergetenvironmenttags.js";
+export * from "./environmentscontrollerpublishenvironment.js";
 export * from "./environmentscontrollerv1createenvironment.js";
 export * from "./environmentscontrollerv1deleteenvironment.js";
 export * from "./environmentscontrollerv1listmyenvironments.js";

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/_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"
-  }
-]

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

@@ -1,88 +0,0 @@
-[
-  {
-    "name": "pypi_token",
-    "secret_name": "PYPI_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "python"
-  },
-  {
-    "name": "npm_token",
-    "secret_name": "NPM_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "typescript"
-  },
-  {
-    "name": "packagist_username",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "packagist_token",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "php"
-  },
-  {
-    "name": "openapi_doc_auth_token",
-    "secret_name": "SPEC_TOKEN",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "speakeasy_api_key",
-    "secret_name": "SPEAKEASY_API_KEY",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only"
-  },
-  {
-    "name": "ossrh_username",
-    "secret_name": "MAVEN_USERNAME",
-    "validation_regex": "/^[\\w.\\-]+$/.source",
-    "validation_message": "Letters, numbers, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "ossrh_password",
-    "secret_name": "MAVEN_PASSWORD",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_secret_key",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "java"
-  },
-  {
-    "name": "java_gpg_passphrase",
-    "language": "java"
-  },
-  {
-    "name": "terraform_gpg_secret_key",
-    "secret_name": "TERRAFORM_GPG_SECRET_KEY",
-    "validation_regex": "/^[\\w.\\-\\t \\r\\n]+$/.source",
-    "validation_message": "Letters, numbers, tabs, spaces, newlines, or .-_ only",
-    "language": "terraform"
-  },
-  {
-    "name": "terraform_gpg_passphrase",
-    "secret_name": "TERRAFORM_GPG_PASSPHRASE",
-    "language": "terraform"
-  },
-  {
-    "name": "rubygems_auth_token",
-    "secret_name": "RUBYGEMS_AUTH_TOKEN",
-    "language": "ruby"
-  },
-  {
-    "name": "nuget_api_key",
-    "secret_name": "NUGET_API_KEY",
-    "language": "csharp"
-  },
-  {
-    "name": "slack_webhook_url",
-    "secret_name": "SLACK_WEBHOOK_URL"
-  }
-]