@novu/api 3.14.1 → 3.14.2-rc.1

package/src/models/components/httprequestcontroldto.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  HttpMethodEnum,
+  HttpMethodEnum$inboundSchema,
+  HttpMethodEnum$outboundSchema,
+} from "./httpmethodenum.js";
+import {
+  HttpRequestKeyValuePairDto,
+  HttpRequestKeyValuePairDto$inboundSchema,
+  HttpRequestKeyValuePairDto$Outbound,
+  HttpRequestKeyValuePairDto$outboundSchema,
+} from "./httprequestkeyvaluepairdto.js";
+
+export type HttpRequestControlDto = {
+  /**
+   * HTTP method
+   */
+  method: HttpMethodEnum;
+  /**
+   * Target URL for the HTTP request
+   */
+  url: string;
+  /**
+   * Request headers as key-value pairs
+   */
+  headers?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * Request body as key-value pairs
+   */
+  body?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * JSON schema to validate response body against
+   */
+  responseBodySchema?: { [k: string]: any } | undefined;
+  /**
+   * Whether to enforce response body schema validation
+   */
+  enforceSchemaValidation?: boolean | undefined;
+  /**
+   * Whether to continue workflow execution on failure
+   */
+  continueOnFailure?: boolean | undefined;
+};
+
+/** @internal */
+export const HttpRequestControlDto$inboundSchema: z.ZodType<
+  HttpRequestControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  method: HttpMethodEnum$inboundSchema,
+  url: z.string(),
+  headers: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+  body: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+  responseBodySchema: z.record(z.any()).optional(),
+  enforceSchemaValidation: z.boolean().optional(),
+  continueOnFailure: z.boolean().optional(),
+});
+/** @internal */
+export type HttpRequestControlDto$Outbound = {
+  method: string;
+  url: string;
+  headers?: Array<HttpRequestKeyValuePairDto$Outbound> | undefined;
+  body?: Array<HttpRequestKeyValuePairDto$Outbound> | undefined;
+  responseBodySchema?: { [k: string]: any } | undefined;
+  enforceSchemaValidation?: boolean | undefined;
+  continueOnFailure?: boolean | undefined;
+};
+
+/** @internal */
+export const HttpRequestControlDto$outboundSchema: z.ZodType<
+  HttpRequestControlDto$Outbound,
+  z.ZodTypeDef,
+  HttpRequestControlDto
+> = z.object({
+  method: HttpMethodEnum$outboundSchema,
+  url: z.string(),
+  headers: z.array(HttpRequestKeyValuePairDto$outboundSchema).optional(),
+  body: z.array(HttpRequestKeyValuePairDto$outboundSchema).optional(),
+  responseBodySchema: z.record(z.any()).optional(),
+  enforceSchemaValidation: z.boolean().optional(),
+  continueOnFailure: z.boolean().optional(),
+});
+
+export function httpRequestControlDtoToJSON(
+  httpRequestControlDto: HttpRequestControlDto,
+): string {
+  return JSON.stringify(
+    HttpRequestControlDto$outboundSchema.parse(httpRequestControlDto),
+  );
+}
+export function httpRequestControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpRequestControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestControlDto' from JSON`,
+  );
+}

package/src/models/components/httprequestcontrolsmetadataresponsedto.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  HttpRequestControlDto,
+  HttpRequestControlDto$inboundSchema,
+} from "./httprequestcontroldto.js";
+import { UiSchema, UiSchema$inboundSchema } from "./uischema.js";
+
+export type HttpRequestControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to HTTP Request step
+   */
+  values: HttpRequestControlDto;
+};
+
+/** @internal */
+export const HttpRequestControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  HttpRequestControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: HttpRequestControlDto$inboundSchema,
+});
+
+export function httpRequestControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HttpRequestControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestControlsMetadataResponseDto' from JSON`,
+  );
+}

package/src/models/components/httprequestkeyvaluepairdto.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type HttpRequestKeyValuePairDto = {
+  /**
+   * Key of the key-value pair
+   */
+  key: string;
+  /**
+   * Value of the key-value pair
+   */
+  value: string;
+};
+
+/** @internal */
+export const HttpRequestKeyValuePairDto$inboundSchema: z.ZodType<
+  HttpRequestKeyValuePairDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type HttpRequestKeyValuePairDto$Outbound = {
+  key: string;
+  value: string;
+};
+
+/** @internal */
+export const HttpRequestKeyValuePairDto$outboundSchema: z.ZodType<
+  HttpRequestKeyValuePairDto$Outbound,
+  z.ZodTypeDef,
+  HttpRequestKeyValuePairDto
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+
+export function httpRequestKeyValuePairDtoToJSON(
+  httpRequestKeyValuePairDto: HttpRequestKeyValuePairDto,
+): string {
+  return JSON.stringify(
+    HttpRequestKeyValuePairDto$outboundSchema.parse(httpRequestKeyValuePairDto),
+  );
+}
+export function httpRequestKeyValuePairDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestKeyValuePairDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpRequestKeyValuePairDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestKeyValuePairDto' from JSON`,
+  );
+}

package/src/models/components/httprequeststepresponsedto.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  HttpMethodEnum,
+  HttpMethodEnum$inboundSchema,
+} from "./httpmethodenum.js";
+import {
+  HttpRequestControlsMetadataResponseDto,
+  HttpRequestControlsMetadataResponseDto$inboundSchema,
+} from "./httprequestcontrolsmetadataresponsedto.js";
+import {
+  HttpRequestKeyValuePairDto,
+  HttpRequestKeyValuePairDto$inboundSchema,
+} from "./httprequestkeyvaluepairdto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+} from "./resourceoriginenum.js";
+import { StepIssuesDto, StepIssuesDto$inboundSchema } from "./stepissuesdto.js";
+
+/**
+ * Control values for the HTTP request step
+ */
+export type HttpRequestStepResponseDtoControlValues = {
+  /**
+   * HTTP method
+   */
+  method: HttpMethodEnum;
+  /**
+   * Target URL for the HTTP request
+   */
+  url: string;
+  /**
+   * Request headers as key-value pairs
+   */
+  headers?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * Request body as key-value pairs
+   */
+  body?: Array<HttpRequestKeyValuePairDto> | undefined;
+  /**
+   * JSON schema to validate response body against
+   */
+  responseBodySchema?: { [k: string]: any } | undefined;
+  /**
+   * Whether to enforce response body schema validation
+   */
+  enforceSchemaValidation?: boolean | undefined;
+  /**
+   * Whether to continue workflow execution on failure
+   */
+  continueOnFailure?: boolean | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+export type HttpRequestStepResponseDto = {
+  /**
+   * Controls metadata for the HTTP request step
+   */
+  controls: HttpRequestControlsMetadataResponseDto;
+  /**
+   * Control values for the HTTP request step
+   */
+  controlValues?: HttpRequestStepResponseDtoControlValues | undefined;
+  /**
+   * JSON Schema for variables, follows the JSON Schema standard
+   */
+  variables: { [k: string]: any };
+  /**
+   * Unique identifier of the step
+   */
+  stepId: string;
+  /**
+   * Database identifier of the step
+   */
+  id: string;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Slug of the step
+   */
+  slug: string;
+  /**
+   * Type of the step
+   */
+  type: "http_request";
+  /**
+   * Origin of the layout
+   */
+  origin: ResourceOriginEnum;
+  /**
+   * Workflow identifier
+   */
+  workflowId: string;
+  /**
+   * Workflow database identifier
+   */
+  workflowDatabaseId: string;
+  /**
+   * Issues associated with the step
+   */
+  issues?: StepIssuesDto | undefined;
+  /**
+   * Hash identifying the deployed Cloudflare Worker for this step
+   */
+  stepResolverHash?: string | undefined;
+};
+
+/** @internal */
+export const HttpRequestStepResponseDtoControlValues$inboundSchema: z.ZodType<
+  HttpRequestStepResponseDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    method: HttpMethodEnum$inboundSchema,
+    url: z.string(),
+    headers: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+    body: z.array(HttpRequestKeyValuePairDto$inboundSchema).optional(),
+    responseBodySchema: z.record(z.any()).optional(),
+    enforceSchemaValidation: z.boolean().optional(),
+    continueOnFailure: z.boolean().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+);
+
+export function httpRequestStepResponseDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  HttpRequestStepResponseDtoControlValues,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HttpRequestStepResponseDtoControlValues$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'HttpRequestStepResponseDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const HttpRequestStepResponseDto$inboundSchema: z.ZodType<
+  HttpRequestStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controls: HttpRequestControlsMetadataResponseDto$inboundSchema,
+  controlValues: z.lazy(() =>
+    HttpRequestStepResponseDtoControlValues$inboundSchema
+  ).optional(),
+  variables: z.record(z.any()),
+  stepId: z.string(),
+  _id: z.string(),
+  name: z.string(),
+  slug: z.string(),
+  type: z.literal("http_request"),
+  origin: ResourceOriginEnum$inboundSchema,
+  workflowId: z.string(),
+  workflowDatabaseId: z.string(),
+  issues: StepIssuesDto$inboundSchema.optional(),
+  stepResolverHash: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+export function httpRequestStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<HttpRequestStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HttpRequestStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HttpRequestStepResponseDto' from JSON`,
+  );
+}

package/src/models/components/httprequeststepupsertdto.ts

@@ -0,0 +1,103 @@
+/*
+ * 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 {
+  HttpRequestControlDto,
+  HttpRequestControlDto$Outbound,
+  HttpRequestControlDto$outboundSchema,
+} from "./httprequestcontroldto.js";
+
+/**
+ * Control values for the HTTP Request step.
+ */
+export type HttpRequestStepUpsertDtoControlValues = HttpRequestControlDto | {
+  [k: string]: any;
+};
+
+export type HttpRequestStepUpsertDto = {
+  /**
+   * Database identifier of the step. Used for updating the step.
+   */
+  id?: string | undefined;
+  /**
+   * Unique identifier for the step
+   */
+  stepId?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: "http_request";
+  /**
+   * Control values for the HTTP Request step.
+   */
+  controlValues?: HttpRequestControlDto | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export type HttpRequestStepUpsertDtoControlValues$Outbound =
+  | HttpRequestControlDto$Outbound
+  | { [k: string]: any };
+
+/** @internal */
+export const HttpRequestStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  HttpRequestStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  HttpRequestStepUpsertDtoControlValues
+> = z.union([HttpRequestControlDto$outboundSchema, z.record(z.any())]);
+
+export function httpRequestStepUpsertDtoControlValuesToJSON(
+  httpRequestStepUpsertDtoControlValues: HttpRequestStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    HttpRequestStepUpsertDtoControlValues$outboundSchema.parse(
+      httpRequestStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+/** @internal */
+export type HttpRequestStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  stepId?: string | undefined;
+  name: string;
+  type: "http_request";
+  controlValues?:
+    | HttpRequestControlDto$Outbound
+    | { [k: string]: any }
+    | undefined;
+};
+
+/** @internal */
+export const HttpRequestStepUpsertDto$outboundSchema: z.ZodType<
+  HttpRequestStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  HttpRequestStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  stepId: z.string().optional(),
+  name: z.string(),
+  type: z.literal("http_request"),
+  controlValues: z.union([
+    HttpRequestControlDto$outboundSchema,
+    z.record(z.any()),
+  ]).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+export function httpRequestStepUpsertDtoToJSON(
+  httpRequestStepUpsertDto: HttpRequestStepUpsertDto,
+): string {
+  return JSON.stringify(
+    HttpRequestStepUpsertDto$outboundSchema.parse(httpRequestStepUpsertDto),
+  );
+}

package/src/models/components/inapprenderoutput.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ActionDto, ActionDto$inboundSchema } from "./actiondto.js";
+import { RedirectDto, RedirectDto$inboundSchema } from "./redirectdto.js";
+
+export type InAppRenderOutput = {
+  /**
+   * Subject of the in-app notification
+   */
+  subject?: string | undefined;
+  /**
+   * Body of the in-app notification
+   */
+  body: string;
+  /**
+   * Avatar for the in-app notification
+   */
+  avatar?: string | undefined;
+  /**
+   * Primary action details
+   */
+  primaryAction?: ActionDto | undefined;
+  /**
+   * Secondary action details
+   */
+  secondaryAction?: ActionDto | undefined;
+  /**
+   * Additional data
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * Redirect details
+   */
+  redirect?: RedirectDto | undefined;
+};
+
+/** @internal */
+export const InAppRenderOutput$inboundSchema: z.ZodType<
+  InAppRenderOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subject: z.string().optional(),
+  body: z.string(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$inboundSchema.optional(),
+  secondaryAction: ActionDto$inboundSchema.optional(),
+  data: z.record(z.any()).optional(),
+  redirect: RedirectDto$inboundSchema.optional(),
+});
+
+export function inAppRenderOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppRenderOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppRenderOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppRenderOutput' from JSON`,
+  );
+}

package/src/models/components/inboxactiondto.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { RedirectDto, RedirectDto$inboundSchema } from "./redirectdto.js";
+
+export type InboxActionDto = {
+  /**
+   * Label of the action button
+   */
+  label: string;
+  /**
+   * Whether the action has been completed
+   */
+  isCompleted: boolean;
+  /**
+   * Redirect configuration for the action
+   */
+  redirect?: RedirectDto | undefined;
+};
+
+/** @internal */
+export const InboxActionDto$inboundSchema: z.ZodType<
+  InboxActionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  label: z.string(),
+  isCompleted: z.boolean(),
+  redirect: RedirectDto$inboundSchema.optional(),
+});
+
+export function inboxActionDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InboxActionDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InboxActionDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InboxActionDto' from JSON`,
+  );
+}