@novu/api 1.6.0 → 1.7.0

package/src/models/components/throttlestepupsertdto.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+import {
+  ThrottleControlDto,
+  ThrottleControlDto$inboundSchema,
+  ThrottleControlDto$Outbound,
+  ThrottleControlDto$outboundSchema,
+} from "./throttlecontroldto.js";
+
+/**
+ * Control values for the Throttle step.
+ */
+export type ThrottleStepUpsertDtoControlValues = ThrottleControlDto | {
+  [k: string]: any;
+};
+
+export type ThrottleStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the Throttle step.
+   */
+  controlValues?: ThrottleControlDto | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const ThrottleStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  ThrottleStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.union([ThrottleControlDto$inboundSchema, z.record(z.any())]);
+
+/** @internal */
+export type ThrottleStepUpsertDtoControlValues$Outbound =
+  | ThrottleControlDto$Outbound
+  | { [k: string]: any };
+
+/** @internal */
+export const ThrottleStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  ThrottleStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  ThrottleStepUpsertDtoControlValues
+> = z.union([ThrottleControlDto$outboundSchema, z.record(z.any())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ThrottleStepUpsertDtoControlValues$ {
+  /** @deprecated use `ThrottleStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = ThrottleStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `ThrottleStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema =
+    ThrottleStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `ThrottleStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = ThrottleStepUpsertDtoControlValues$Outbound;
+}
+
+export function throttleStepUpsertDtoControlValuesToJSON(
+  throttleStepUpsertDtoControlValues: ThrottleStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    ThrottleStepUpsertDtoControlValues$outboundSchema.parse(
+      throttleStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function throttleStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<ThrottleStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ThrottleStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ThrottleStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const ThrottleStepUpsertDto$inboundSchema: z.ZodType<
+  ThrottleStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.union([ThrottleControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type ThrottleStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?:
+    | ThrottleControlDto$Outbound
+    | { [k: string]: any }
+    | undefined;
+};
+
+/** @internal */
+export const ThrottleStepUpsertDto$outboundSchema: z.ZodType<
+  ThrottleStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  ThrottleStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.union([ThrottleControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ThrottleStepUpsertDto$ {
+  /** @deprecated use `ThrottleStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = ThrottleStepUpsertDto$inboundSchema;
+  /** @deprecated use `ThrottleStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = ThrottleStepUpsertDto$outboundSchema;
+  /** @deprecated use `ThrottleStepUpsertDto$Outbound` instead. */
+  export type Outbound = ThrottleStepUpsertDto$Outbound;
+}
+
+export function throttleStepUpsertDtoToJSON(
+  throttleStepUpsertDto: ThrottleStepUpsertDto,
+): string {
+  return JSON.stringify(
+    ThrottleStepUpsertDto$outboundSchema.parse(throttleStepUpsertDto),
+  );
+}
+
+export function throttleStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ThrottleStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ThrottleStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ThrottleStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/timerangedto.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type TimeRangeDto = {
+  /**
+   * Start time
+   */
+  start: string;
+  /**
+   * End time
+   */
+  end: string;
+};
+
+/** @internal */
+export const TimeRangeDto$inboundSchema: z.ZodType<
+  TimeRangeDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  start: z.string(),
+  end: z.string(),
+});
+
+/** @internal */
+export type TimeRangeDto$Outbound = {
+  start: string;
+  end: string;
+};
+
+/** @internal */
+export const TimeRangeDto$outboundSchema: z.ZodType<
+  TimeRangeDto$Outbound,
+  z.ZodTypeDef,
+  TimeRangeDto
+> = z.object({
+  start: z.string(),
+  end: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TimeRangeDto$ {
+  /** @deprecated use `TimeRangeDto$inboundSchema` instead. */
+  export const inboundSchema = TimeRangeDto$inboundSchema;
+  /** @deprecated use `TimeRangeDto$outboundSchema` instead. */
+  export const outboundSchema = TimeRangeDto$outboundSchema;
+  /** @deprecated use `TimeRangeDto$Outbound` instead. */
+  export type Outbound = TimeRangeDto$Outbound;
+}
+
+export function timeRangeDtoToJSON(timeRangeDto: TimeRangeDto): string {
+  return JSON.stringify(TimeRangeDto$outboundSchema.parse(timeRangeDto));
+}
+
+export function timeRangeDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TimeRangeDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TimeRangeDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TimeRangeDto' from JSON`,
+  );
+}

package/src/models/components/translationgroupdto.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Resource type
+ */
+export const TranslationGroupDtoResourceType = {
+  Workflow: "workflow",
+} as const;
+/**
+ * Resource type
+ */
+export type TranslationGroupDtoResourceType = ClosedEnum<
+  typeof TranslationGroupDtoResourceType
+>;
+
+export type TranslationGroupDto = {
+  /**
+   * Resource identifier (slugified ID)
+   */
+  resourceId: string;
+  /**
+   * Resource type
+   */
+  resourceType: TranslationGroupDtoResourceType;
+  /**
+   * Resource name (e.g., workflow name)
+   */
+  resourceName: string;
+  /**
+   * Array of available locales for this resource
+   */
+  locales: Array<string>;
+  /**
+   * Locales that are outdated compared to the default locale (only present when there are outdated locales)
+   */
+  outdatedLocales?: Array<string> | undefined;
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const TranslationGroupDtoResourceType$inboundSchema: z.ZodNativeEnum<
+  typeof TranslationGroupDtoResourceType
+> = z.nativeEnum(TranslationGroupDtoResourceType);
+
+/** @internal */
+export const TranslationGroupDtoResourceType$outboundSchema: z.ZodNativeEnum<
+  typeof TranslationGroupDtoResourceType
+> = TranslationGroupDtoResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TranslationGroupDtoResourceType$ {
+  /** @deprecated use `TranslationGroupDtoResourceType$inboundSchema` instead. */
+  export const inboundSchema = TranslationGroupDtoResourceType$inboundSchema;
+  /** @deprecated use `TranslationGroupDtoResourceType$outboundSchema` instead. */
+  export const outboundSchema = TranslationGroupDtoResourceType$outboundSchema;
+}
+
+/** @internal */
+export const TranslationGroupDto$inboundSchema: z.ZodType<
+  TranslationGroupDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceId: z.string(),
+  resourceType: TranslationGroupDtoResourceType$inboundSchema,
+  resourceName: z.string(),
+  locales: z.array(z.string()),
+  outdatedLocales: z.array(z.string()).optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/** @internal */
+export type TranslationGroupDto$Outbound = {
+  resourceId: string;
+  resourceType: string;
+  resourceName: string;
+  locales: Array<string>;
+  outdatedLocales?: Array<string> | undefined;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const TranslationGroupDto$outboundSchema: z.ZodType<
+  TranslationGroupDto$Outbound,
+  z.ZodTypeDef,
+  TranslationGroupDto
+> = z.object({
+  resourceId: z.string(),
+  resourceType: TranslationGroupDtoResourceType$outboundSchema,
+  resourceName: z.string(),
+  locales: z.array(z.string()),
+  outdatedLocales: z.array(z.string()).optional(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TranslationGroupDto$ {
+  /** @deprecated use `TranslationGroupDto$inboundSchema` instead. */
+  export const inboundSchema = TranslationGroupDto$inboundSchema;
+  /** @deprecated use `TranslationGroupDto$outboundSchema` instead. */
+  export const outboundSchema = TranslationGroupDto$outboundSchema;
+  /** @deprecated use `TranslationGroupDto$Outbound` instead. */
+  export type Outbound = TranslationGroupDto$Outbound;
+}
+
+export function translationGroupDtoToJSON(
+  translationGroupDto: TranslationGroupDto,
+): string {
+  return JSON.stringify(
+    TranslationGroupDto$outboundSchema.parse(translationGroupDto),
+  );
+}
+
+export function translationGroupDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TranslationGroupDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TranslationGroupDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TranslationGroupDto' from JSON`,
+  );
+}

package/src/models/components/translationresponsedto.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Resource type
+ */
+export const TranslationResponseDtoResourceType = {
+  Workflow: "workflow",
+} as const;
+/**
+ * Resource type
+ */
+export type TranslationResponseDtoResourceType = ClosedEnum<
+  typeof TranslationResponseDtoResourceType
+>;
+
+/**
+ * Translation content as JSON object
+ */
+export type TranslationResponseDtoContent = {};
+
+export type TranslationResponseDto = {
+  /**
+   * Resource identifier
+   */
+  resourceId: string;
+  /**
+   * Resource type
+   */
+  resourceType: TranslationResponseDtoResourceType;
+  /**
+   * Locale code
+   */
+  locale: string;
+  /**
+   * Translation content as JSON object
+   */
+  content: TranslationResponseDtoContent;
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+};
+
+/** @internal */
+export const TranslationResponseDtoResourceType$inboundSchema: z.ZodNativeEnum<
+  typeof TranslationResponseDtoResourceType
+> = z.nativeEnum(TranslationResponseDtoResourceType);
+
+/** @internal */
+export const TranslationResponseDtoResourceType$outboundSchema: z.ZodNativeEnum<
+  typeof TranslationResponseDtoResourceType
+> = TranslationResponseDtoResourceType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TranslationResponseDtoResourceType$ {
+  /** @deprecated use `TranslationResponseDtoResourceType$inboundSchema` instead. */
+  export const inboundSchema = TranslationResponseDtoResourceType$inboundSchema;
+  /** @deprecated use `TranslationResponseDtoResourceType$outboundSchema` instead. */
+  export const outboundSchema =
+    TranslationResponseDtoResourceType$outboundSchema;
+}
+
+/** @internal */
+export const TranslationResponseDtoContent$inboundSchema: z.ZodType<
+  TranslationResponseDtoContent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type TranslationResponseDtoContent$Outbound = {};
+
+/** @internal */
+export const TranslationResponseDtoContent$outboundSchema: z.ZodType<
+  TranslationResponseDtoContent$Outbound,
+  z.ZodTypeDef,
+  TranslationResponseDtoContent
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TranslationResponseDtoContent$ {
+  /** @deprecated use `TranslationResponseDtoContent$inboundSchema` instead. */
+  export const inboundSchema = TranslationResponseDtoContent$inboundSchema;
+  /** @deprecated use `TranslationResponseDtoContent$outboundSchema` instead. */
+  export const outboundSchema = TranslationResponseDtoContent$outboundSchema;
+  /** @deprecated use `TranslationResponseDtoContent$Outbound` instead. */
+  export type Outbound = TranslationResponseDtoContent$Outbound;
+}
+
+export function translationResponseDtoContentToJSON(
+  translationResponseDtoContent: TranslationResponseDtoContent,
+): string {
+  return JSON.stringify(
+    TranslationResponseDtoContent$outboundSchema.parse(
+      translationResponseDtoContent,
+    ),
+  );
+}
+
+export function translationResponseDtoContentFromJSON(
+  jsonString: string,
+): SafeParseResult<TranslationResponseDtoContent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TranslationResponseDtoContent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TranslationResponseDtoContent' from JSON`,
+  );
+}
+
+/** @internal */
+export const TranslationResponseDto$inboundSchema: z.ZodType<
+  TranslationResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceId: z.string(),
+  resourceType: TranslationResponseDtoResourceType$inboundSchema,
+  locale: z.string(),
+  content: z.lazy(() => TranslationResponseDtoContent$inboundSchema),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/** @internal */
+export type TranslationResponseDto$Outbound = {
+  resourceId: string;
+  resourceType: string;
+  locale: string;
+  content: TranslationResponseDtoContent$Outbound;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const TranslationResponseDto$outboundSchema: z.ZodType<
+  TranslationResponseDto$Outbound,
+  z.ZodTypeDef,
+  TranslationResponseDto
+> = z.object({
+  resourceId: z.string(),
+  resourceType: TranslationResponseDtoResourceType$outboundSchema,
+  locale: z.string(),
+  content: z.lazy(() => TranslationResponseDtoContent$outboundSchema),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TranslationResponseDto$ {
+  /** @deprecated use `TranslationResponseDto$inboundSchema` instead. */
+  export const inboundSchema = TranslationResponseDto$inboundSchema;
+  /** @deprecated use `TranslationResponseDto$outboundSchema` instead. */
+  export const outboundSchema = TranslationResponseDto$outboundSchema;
+  /** @deprecated use `TranslationResponseDto$Outbound` instead. */
+  export type Outbound = TranslationResponseDto$Outbound;
+}
+
+export function translationResponseDtoToJSON(
+  translationResponseDto: TranslationResponseDto,
+): string {
+  return JSON.stringify(
+    TranslationResponseDto$outboundSchema.parse(translationResponseDto),
+  );
+}
+
+export function translationResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<TranslationResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TranslationResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TranslationResponseDto' from JSON`,
+  );
+}