@novu/api 1.3.0 → 1.4.0

package/src/models/components/preferencesrequestdto.ts

@@ -0,0 +1,367 @@
+/*
+ * 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";
+import {
+  ChannelPreferenceDto,
+  ChannelPreferenceDto$inboundSchema,
+  ChannelPreferenceDto$Outbound,
+  ChannelPreferenceDto$outboundSchema,
+} from "./channelpreferencedto.js";
+import {
+  WorkflowPreferenceDto,
+  WorkflowPreferenceDto$inboundSchema,
+  WorkflowPreferenceDto$Outbound,
+  WorkflowPreferenceDto$outboundSchema,
+} from "./workflowpreferencedto.js";
+
+/**
+ * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
+ */
+export type UserAll = WorkflowPreferenceDto;
+
+export type UserWorkflowPreferencesDto = {
+  /**
+   * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
+   */
+  all: WorkflowPreferenceDto;
+  /**
+   * Preferences for different communication channels
+   */
+  channels: { [k: string]: ChannelPreferenceDto };
+};
+
+/**
+ * User workflow preferences
+ */
+export type User = UserWorkflowPreferencesDto;
+
+/**
+ * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
+ */
+export type PreferencesRequestDtoAll = WorkflowPreferenceDto;
+
+/**
+ * Workflow-specific preferences
+ */
+export type Workflow = {
+  /**
+   * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
+   */
+  all: WorkflowPreferenceDto;
+  /**
+   * Preferences for different communication channels
+   */
+  channels: { [k: string]: ChannelPreferenceDto };
+};
+
+export type PreferencesRequestDto = {
+  /**
+   * User workflow preferences
+   */
+  user?: UserWorkflowPreferencesDto | null | undefined;
+  /**
+   * Workflow-specific preferences
+   */
+  workflow?: Workflow | null | undefined;
+};
+
+/** @internal */
+export const UserAll$inboundSchema: z.ZodType<UserAll, z.ZodTypeDef, unknown> =
+  WorkflowPreferenceDto$inboundSchema;
+
+/** @internal */
+export type UserAll$Outbound = WorkflowPreferenceDto$Outbound;
+
+/** @internal */
+export const UserAll$outboundSchema: z.ZodType<
+  UserAll$Outbound,
+  z.ZodTypeDef,
+  UserAll
+> = WorkflowPreferenceDto$outboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserAll$ {
+  /** @deprecated use `UserAll$inboundSchema` instead. */
+  export const inboundSchema = UserAll$inboundSchema;
+  /** @deprecated use `UserAll$outboundSchema` instead. */
+  export const outboundSchema = UserAll$outboundSchema;
+  /** @deprecated use `UserAll$Outbound` instead. */
+  export type Outbound = UserAll$Outbound;
+}
+
+export function userAllToJSON(userAll: UserAll): string {
+  return JSON.stringify(UserAll$outboundSchema.parse(userAll));
+}
+
+export function userAllFromJSON(
+  jsonString: string,
+): SafeParseResult<UserAll, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserAll$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserAll' from JSON`,
+  );
+}
+
+/** @internal */
+export const UserWorkflowPreferencesDto$inboundSchema: z.ZodType<
+  UserWorkflowPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  all: WorkflowPreferenceDto$inboundSchema,
+  channels: z.record(ChannelPreferenceDto$inboundSchema),
+});
+
+/** @internal */
+export type UserWorkflowPreferencesDto$Outbound = {
+  all: WorkflowPreferenceDto$Outbound;
+  channels: { [k: string]: ChannelPreferenceDto$Outbound };
+};
+
+/** @internal */
+export const UserWorkflowPreferencesDto$outboundSchema: z.ZodType<
+  UserWorkflowPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  UserWorkflowPreferencesDto
+> = z.object({
+  all: WorkflowPreferenceDto$outboundSchema,
+  channels: z.record(ChannelPreferenceDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UserWorkflowPreferencesDto$ {
+  /** @deprecated use `UserWorkflowPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = UserWorkflowPreferencesDto$inboundSchema;
+  /** @deprecated use `UserWorkflowPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema = UserWorkflowPreferencesDto$outboundSchema;
+  /** @deprecated use `UserWorkflowPreferencesDto$Outbound` instead. */
+  export type Outbound = UserWorkflowPreferencesDto$Outbound;
+}
+
+export function userWorkflowPreferencesDtoToJSON(
+  userWorkflowPreferencesDto: UserWorkflowPreferencesDto,
+): string {
+  return JSON.stringify(
+    UserWorkflowPreferencesDto$outboundSchema.parse(userWorkflowPreferencesDto),
+  );
+}
+
+export function userWorkflowPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UserWorkflowPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserWorkflowPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserWorkflowPreferencesDto' from JSON`,
+  );
+}
+
+/** @internal */
+export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
+  .lazy(() => UserWorkflowPreferencesDto$inboundSchema);
+
+/** @internal */
+export type User$Outbound = UserWorkflowPreferencesDto$Outbound;
+
+/** @internal */
+export const User$outboundSchema: z.ZodType<User$Outbound, z.ZodTypeDef, User> =
+  z.lazy(() => UserWorkflowPreferencesDto$outboundSchema);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace User$ {
+  /** @deprecated use `User$inboundSchema` instead. */
+  export const inboundSchema = User$inboundSchema;
+  /** @deprecated use `User$outboundSchema` instead. */
+  export const outboundSchema = User$outboundSchema;
+  /** @deprecated use `User$Outbound` instead. */
+  export type Outbound = User$Outbound;
+}
+
+export function userToJSON(user: User): string {
+  return JSON.stringify(User$outboundSchema.parse(user));
+}
+
+export function userFromJSON(
+  jsonString: string,
+): SafeParseResult<User, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => User$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'User' from JSON`,
+  );
+}
+
+/** @internal */
+export const PreferencesRequestDtoAll$inboundSchema: z.ZodType<
+  PreferencesRequestDtoAll,
+  z.ZodTypeDef,
+  unknown
+> = WorkflowPreferenceDto$inboundSchema;
+
+/** @internal */
+export type PreferencesRequestDtoAll$Outbound = WorkflowPreferenceDto$Outbound;
+
+/** @internal */
+export const PreferencesRequestDtoAll$outboundSchema: z.ZodType<
+  PreferencesRequestDtoAll$Outbound,
+  z.ZodTypeDef,
+  PreferencesRequestDtoAll
+> = WorkflowPreferenceDto$outboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreferencesRequestDtoAll$ {
+  /** @deprecated use `PreferencesRequestDtoAll$inboundSchema` instead. */
+  export const inboundSchema = PreferencesRequestDtoAll$inboundSchema;
+  /** @deprecated use `PreferencesRequestDtoAll$outboundSchema` instead. */
+  export const outboundSchema = PreferencesRequestDtoAll$outboundSchema;
+  /** @deprecated use `PreferencesRequestDtoAll$Outbound` instead. */
+  export type Outbound = PreferencesRequestDtoAll$Outbound;
+}
+
+export function preferencesRequestDtoAllToJSON(
+  preferencesRequestDtoAll: PreferencesRequestDtoAll,
+): string {
+  return JSON.stringify(
+    PreferencesRequestDtoAll$outboundSchema.parse(preferencesRequestDtoAll),
+  );
+}
+
+export function preferencesRequestDtoAllFromJSON(
+  jsonString: string,
+): SafeParseResult<PreferencesRequestDtoAll, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreferencesRequestDtoAll$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreferencesRequestDtoAll' from JSON`,
+  );
+}
+
+/** @internal */
+export const Workflow$inboundSchema: z.ZodType<
+  Workflow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  all: WorkflowPreferenceDto$inboundSchema,
+  channels: z.record(ChannelPreferenceDto$inboundSchema),
+});
+
+/** @internal */
+export type Workflow$Outbound = {
+  all: WorkflowPreferenceDto$Outbound;
+  channels: { [k: string]: ChannelPreferenceDto$Outbound };
+};
+
+/** @internal */
+export const Workflow$outboundSchema: z.ZodType<
+  Workflow$Outbound,
+  z.ZodTypeDef,
+  Workflow
+> = z.object({
+  all: WorkflowPreferenceDto$outboundSchema,
+  channels: z.record(ChannelPreferenceDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Workflow$ {
+  /** @deprecated use `Workflow$inboundSchema` instead. */
+  export const inboundSchema = Workflow$inboundSchema;
+  /** @deprecated use `Workflow$outboundSchema` instead. */
+  export const outboundSchema = Workflow$outboundSchema;
+  /** @deprecated use `Workflow$Outbound` instead. */
+  export type Outbound = Workflow$Outbound;
+}
+
+export function workflowToJSON(workflow: Workflow): string {
+  return JSON.stringify(Workflow$outboundSchema.parse(workflow));
+}
+
+export function workflowFromJSON(
+  jsonString: string,
+): SafeParseResult<Workflow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Workflow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Workflow' from JSON`,
+  );
+}
+
+/** @internal */
+export const PreferencesRequestDto$inboundSchema: z.ZodType<
+  PreferencesRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  user: z.nullable(z.lazy(() => UserWorkflowPreferencesDto$inboundSchema))
+    .optional(),
+  workflow: z.nullable(z.lazy(() => Workflow$inboundSchema)).optional(),
+});
+
+/** @internal */
+export type PreferencesRequestDto$Outbound = {
+  user?: UserWorkflowPreferencesDto$Outbound | null | undefined;
+  workflow?: Workflow$Outbound | null | undefined;
+};
+
+/** @internal */
+export const PreferencesRequestDto$outboundSchema: z.ZodType<
+  PreferencesRequestDto$Outbound,
+  z.ZodTypeDef,
+  PreferencesRequestDto
+> = z.object({
+  user: z.nullable(z.lazy(() => UserWorkflowPreferencesDto$outboundSchema))
+    .optional(),
+  workflow: z.nullable(z.lazy(() => Workflow$outboundSchema)).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreferencesRequestDto$ {
+  /** @deprecated use `PreferencesRequestDto$inboundSchema` instead. */
+  export const inboundSchema = PreferencesRequestDto$inboundSchema;
+  /** @deprecated use `PreferencesRequestDto$outboundSchema` instead. */
+  export const outboundSchema = PreferencesRequestDto$outboundSchema;
+  /** @deprecated use `PreferencesRequestDto$Outbound` instead. */
+  export type Outbound = PreferencesRequestDto$Outbound;
+}
+
+export function preferencesRequestDtoToJSON(
+  preferencesRequestDto: PreferencesRequestDto,
+): string {
+  return JSON.stringify(
+    PreferencesRequestDto$outboundSchema.parse(preferencesRequestDto),
+  );
+}
+
+export function preferencesRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PreferencesRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreferencesRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreferencesRequestDto' from JSON`,
+  );
+}

package/src/models/components/pushcontroldto.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 PushControlDto = {
+  /**
+   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
+   */
+  skip?: { [k: string]: any } | undefined;
+  /**
+   * Subject/title of the push notification.
+   */
+  subject?: string | undefined;
+  /**
+   * Body content of the push notification.
+   */
+  body?: string | undefined;
+};
+
+/** @internal */
+export const PushControlDto$inboundSchema: z.ZodType<
+  PushControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  subject: z.string().optional(),
+  body: z.string().optional(),
+});
+
+/** @internal */
+export type PushControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  subject?: string | undefined;
+  body?: string | undefined;
+};
+
+/** @internal */
+export const PushControlDto$outboundSchema: z.ZodType<
+  PushControlDto$Outbound,
+  z.ZodTypeDef,
+  PushControlDto
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  subject: z.string().optional(),
+  body: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PushControlDto$ {
+  /** @deprecated use `PushControlDto$inboundSchema` instead. */
+  export const inboundSchema = PushControlDto$inboundSchema;
+  /** @deprecated use `PushControlDto$outboundSchema` instead. */
+  export const outboundSchema = PushControlDto$outboundSchema;
+  /** @deprecated use `PushControlDto$Outbound` instead. */
+  export type Outbound = PushControlDto$Outbound;
+}
+
+export function pushControlDtoToJSON(pushControlDto: PushControlDto): string {
+  return JSON.stringify(PushControlDto$outboundSchema.parse(pushControlDto));
+}
+
+export function pushControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PushControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushControlDto' from JSON`,
+  );
+}

package/src/models/components/pushcontrolsmetadataresponsedto.ts

@@ -0,0 +1,97 @@
+/*
+ * 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";
+import {
+  PushControlDto,
+  PushControlDto$inboundSchema,
+  PushControlDto$Outbound,
+  PushControlDto$outboundSchema,
+} from "./pushcontroldto.js";
+import {
+  UiSchema,
+  UiSchema$inboundSchema,
+  UiSchema$Outbound,
+  UiSchema$outboundSchema,
+} from "./uischema.js";
+
+export type PushControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to Push
+   */
+  values: PushControlDto;
+};
+
+/** @internal */
+export const PushControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  PushControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: PushControlDto$inboundSchema,
+});
+
+/** @internal */
+export type PushControlsMetadataResponseDto$Outbound = {
+  dataSchema?: { [k: string]: any } | undefined;
+  uiSchema?: UiSchema$Outbound | undefined;
+  values: PushControlDto$Outbound;
+};
+
+/** @internal */
+export const PushControlsMetadataResponseDto$outboundSchema: z.ZodType<
+  PushControlsMetadataResponseDto$Outbound,
+  z.ZodTypeDef,
+  PushControlsMetadataResponseDto
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$outboundSchema.optional(),
+  values: PushControlDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PushControlsMetadataResponseDto$ {
+  /** @deprecated use `PushControlsMetadataResponseDto$inboundSchema` instead. */
+  export const inboundSchema = PushControlsMetadataResponseDto$inboundSchema;
+  /** @deprecated use `PushControlsMetadataResponseDto$outboundSchema` instead. */
+  export const outboundSchema = PushControlsMetadataResponseDto$outboundSchema;
+  /** @deprecated use `PushControlsMetadataResponseDto$Outbound` instead. */
+  export type Outbound = PushControlsMetadataResponseDto$Outbound;
+}
+
+export function pushControlsMetadataResponseDtoToJSON(
+  pushControlsMetadataResponseDto: PushControlsMetadataResponseDto,
+): string {
+  return JSON.stringify(
+    PushControlsMetadataResponseDto$outboundSchema.parse(
+      pushControlsMetadataResponseDto,
+    ),
+  );
+}
+
+export function pushControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PushControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushControlsMetadataResponseDto' from JSON`,
+  );
+}