@novu/api 3.11.0 → 3.11.2

package/src/models/components/createphoneendpointdto.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  PhoneEndpointDto,
+  PhoneEndpointDto$Outbound,
+  PhoneEndpointDto$outboundSchema,
+} from "./phoneendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreatePhoneEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreatePhoneEndpointDtoContext =
+  | CreatePhoneEndpointDtoContext2
+  | string;
+
+export type CreatePhoneEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreatePhoneEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "phone";
+  /**
+   * Phone endpoint data
+   */
+  endpoint: PhoneEndpointDto;
+};
+
+/** @internal */
+export type CreatePhoneEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreatePhoneEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreatePhoneEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreatePhoneEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createPhoneEndpointDtoContext2ToJSON(
+  createPhoneEndpointDtoContext2: CreatePhoneEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreatePhoneEndpointDtoContext2$outboundSchema.parse(
+      createPhoneEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreatePhoneEndpointDtoContext$Outbound =
+  | CreatePhoneEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreatePhoneEndpointDtoContext$outboundSchema: z.ZodType<
+  CreatePhoneEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreatePhoneEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreatePhoneEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createPhoneEndpointDtoContextToJSON(
+  createPhoneEndpointDtoContext: CreatePhoneEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreatePhoneEndpointDtoContext$outboundSchema.parse(
+      createPhoneEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreatePhoneEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreatePhoneEndpointDtoContext2$Outbound | string }
+    | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "phone";
+  endpoint: PhoneEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreatePhoneEndpointDto$outboundSchema: z.ZodType<
+  CreatePhoneEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreatePhoneEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreatePhoneEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("phone"),
+  endpoint: PhoneEndpointDto$outboundSchema,
+});
+
+export function createPhoneEndpointDtoToJSON(
+  createPhoneEndpointDto: CreatePhoneEndpointDto,
+): string {
+  return JSON.stringify(
+    CreatePhoneEndpointDto$outboundSchema.parse(createPhoneEndpointDto),
+  );
+}

package/src/models/components/createslackchannelendpointdto.ts

@@ -0,0 +1,131 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  SlackChannelEndpointDto,
+  SlackChannelEndpointDto$Outbound,
+  SlackChannelEndpointDto$outboundSchema,
+} from "./slackchannelendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type Context2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateSlackChannelEndpointDtoContext = Context2 | string;
+
+export type CreateSlackChannelEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?: { [k: string]: Context2 | string } | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "slack_channel";
+  /**
+   * Slack channel endpoint data
+   */
+  endpoint: SlackChannelEndpointDto;
+};
+
+/** @internal */
+export type Context2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const Context2$outboundSchema: z.ZodType<
+  Context2$Outbound,
+  z.ZodTypeDef,
+  Context2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function context2ToJSON(context2: Context2): string {
+  return JSON.stringify(Context2$outboundSchema.parse(context2));
+}
+
+/** @internal */
+export type CreateSlackChannelEndpointDtoContext$Outbound =
+  | Context2$Outbound
+  | string;
+
+/** @internal */
+export const CreateSlackChannelEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateSlackChannelEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateSlackChannelEndpointDtoContext
+> = z.union([z.lazy(() => Context2$outboundSchema), z.string()]);
+
+export function createSlackChannelEndpointDtoContextToJSON(
+  createSlackChannelEndpointDtoContext: CreateSlackChannelEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateSlackChannelEndpointDtoContext$outboundSchema.parse(
+      createSlackChannelEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateSlackChannelEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: { [k: string]: Context2$Outbound | string } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "slack_channel";
+  endpoint: SlackChannelEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateSlackChannelEndpointDto$outboundSchema: z.ZodType<
+  CreateSlackChannelEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateSlackChannelEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([z.lazy(() => Context2$outboundSchema), z.string()]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("slack_channel"),
+  endpoint: SlackChannelEndpointDto$outboundSchema,
+});
+
+export function createSlackChannelEndpointDtoToJSON(
+  createSlackChannelEndpointDto: CreateSlackChannelEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateSlackChannelEndpointDto$outboundSchema.parse(
+      createSlackChannelEndpointDto,
+    ),
+  );
+}

package/src/models/components/createslackuserendpointdto.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  SlackUserEndpointDto,
+  SlackUserEndpointDto$Outbound,
+  SlackUserEndpointDto$outboundSchema,
+} from "./slackuserendpointdto.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateSlackUserEndpointDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateSlackUserEndpointDtoContext =
+  | CreateSlackUserEndpointDtoContext2
+  | string;
+
+export type CreateSlackUserEndpointDto = {
+  /**
+   * The unique identifier for the channel endpoint. If not provided, one will be generated automatically.
+   */
+  identifier?: string | undefined;
+  /**
+   * The subscriber ID to which the channel endpoint is linked
+   */
+  subscriberId: string;
+  context?:
+    | { [k: string]: CreateSlackUserEndpointDtoContext2 | string }
+    | undefined;
+  /**
+   * The identifier of the integration to use for this channel endpoint.
+   */
+  integrationIdentifier: string;
+  /**
+   * The identifier of the channel connection to use for this channel endpoint.
+   */
+  connectionIdentifier?: string | undefined;
+  /**
+   * Type of channel endpoint
+   */
+  type: "slack_user";
+  /**
+   * Slack user endpoint data
+   */
+  endpoint: SlackUserEndpointDto;
+};
+
+/** @internal */
+export type CreateSlackUserEndpointDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateSlackUserEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateSlackUserEndpointDtoContext2$Outbound,
+  z.ZodTypeDef,
+  CreateSlackUserEndpointDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function createSlackUserEndpointDtoContext2ToJSON(
+  createSlackUserEndpointDtoContext2: CreateSlackUserEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateSlackUserEndpointDtoContext2$outboundSchema.parse(
+      createSlackUserEndpointDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateSlackUserEndpointDtoContext$Outbound =
+  | CreateSlackUserEndpointDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateSlackUserEndpointDtoContext$outboundSchema: z.ZodType<
+  CreateSlackUserEndpointDtoContext$Outbound,
+  z.ZodTypeDef,
+  CreateSlackUserEndpointDtoContext
+> = z.union([
+  z.lazy(() => CreateSlackUserEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function createSlackUserEndpointDtoContextToJSON(
+  createSlackUserEndpointDtoContext: CreateSlackUserEndpointDtoContext,
+): string {
+  return JSON.stringify(
+    CreateSlackUserEndpointDtoContext$outboundSchema.parse(
+      createSlackUserEndpointDtoContext,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateSlackUserEndpointDto$Outbound = {
+  identifier?: string | undefined;
+  subscriberId: string;
+  context?: {
+    [k: string]: CreateSlackUserEndpointDtoContext2$Outbound | string;
+  } | undefined;
+  integrationIdentifier: string;
+  connectionIdentifier?: string | undefined;
+  type: "slack_user";
+  endpoint: SlackUserEndpointDto$Outbound;
+};
+
+/** @internal */
+export const CreateSlackUserEndpointDto$outboundSchema: z.ZodType<
+  CreateSlackUserEndpointDto$Outbound,
+  z.ZodTypeDef,
+  CreateSlackUserEndpointDto
+> = z.object({
+  identifier: z.string().optional(),
+  subscriberId: z.string(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateSlackUserEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  integrationIdentifier: z.string(),
+  connectionIdentifier: z.string().optional(),
+  type: z.literal("slack_user"),
+  endpoint: SlackUserEndpointDto$outboundSchema,
+});
+
+export function createSlackUserEndpointDtoToJSON(
+  createSlackUserEndpointDto: CreateSlackUserEndpointDto,
+): string {
+  return JSON.stringify(
+    CreateSlackUserEndpointDto$outboundSchema.parse(createSlackUserEndpointDto),
+  );
+}

package/src/models/components/createsubscriptionsresponsedto.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 { MetaDto, MetaDto$inboundSchema } from "./metadto.js";
+import {
+  SubscriptionErrorDto,
+  SubscriptionErrorDto$inboundSchema,
+} from "./subscriptionerrordto.js";
+import {
+  SubscriptionResponseDto,
+  SubscriptionResponseDto$inboundSchema,
+} from "./subscriptionresponsedto.js";
+
+export type CreateSubscriptionsResponseDto = {
+  /**
+   * The list of successfully created subscriptions
+   */
+  data: Array<SubscriptionResponseDto>;
+  /**
+   * Metadata about the operation
+   */
+  meta: MetaDto;
+  /**
+   * The list of errors for failed subscription attempts
+   */
+  errors?: Array<SubscriptionErrorDto> | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionsResponseDto$inboundSchema: z.ZodType<
+  CreateSubscriptionsResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(SubscriptionResponseDto$inboundSchema),
+  meta: MetaDto$inboundSchema,
+  errors: z.array(SubscriptionErrorDto$inboundSchema).optional(),
+});
+
+export function createSubscriptionsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateSubscriptionsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateSubscriptionsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateSubscriptionsResponseDto' from JSON`,
+  );
+}

package/src/models/components/createtopicsubscriptionsrequestdto.ts

@@ -3,17 +3,103 @@
  */
 
 import * as z from "zod/v3";
+import {
+  GroupPreferenceFilterDto,
+  GroupPreferenceFilterDto$Outbound,
+  GroupPreferenceFilterDto$outboundSchema,
+} from "./grouppreferencefilterdto.js";
+import {
+  TopicSubscriberIdentifierDto,
+  TopicSubscriberIdentifierDto$Outbound,
+  TopicSubscriberIdentifierDto$outboundSchema,
+} from "./topicsubscriberidentifierdto.js";
+import {
+  WorkflowPreferenceRequestDto,
+  WorkflowPreferenceRequestDto$Outbound,
+  WorkflowPreferenceRequestDto$outboundSchema,
+} from "./workflowpreferencerequestdto.js";
+
+export type Subscriptions = TopicSubscriberIdentifierDto | string;
+
+export type Preferences =
+  | WorkflowPreferenceRequestDto
+  | GroupPreferenceFilterDto
+  | string;
 
 export type CreateTopicSubscriptionsRequestDto = {
   /**
-   * List of subscriber identifiers to subscribe to the topic (max: 100)
+   * List of subscriber IDs to subscribe to the topic (max: 100). @deprecated Use the "subscriptions" property instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  subscriberIds?: Array<string> | undefined;
+  /**
+   * List of subscriptions to subscribe to the topic (max: 100). Can be either a string array of subscriber IDs or an array of objects with identifier and subscriberId
+   */
+  subscriptions?: Array<TopicSubscriberIdentifierDto | string> | undefined;
+  /**
+   * The name of the topic
    */
-  subscriberIds: Array<string>;
+  name?: string | undefined;
+  /**
+   * The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object
+   */
+  preferences?:
+    | Array<WorkflowPreferenceRequestDto | GroupPreferenceFilterDto | string>
+    | undefined;
 };
 
+/** @internal */
+export type Subscriptions$Outbound =
+  | TopicSubscriberIdentifierDto$Outbound
+  | string;
+
+/** @internal */
+export const Subscriptions$outboundSchema: z.ZodType<
+  Subscriptions$Outbound,
+  z.ZodTypeDef,
+  Subscriptions
+> = z.union([TopicSubscriberIdentifierDto$outboundSchema, z.string()]);
+
+export function subscriptionsToJSON(subscriptions: Subscriptions): string {
+  return JSON.stringify(Subscriptions$outboundSchema.parse(subscriptions));
+}
+
+/** @internal */
+export type Preferences$Outbound =
+  | WorkflowPreferenceRequestDto$Outbound
+  | GroupPreferenceFilterDto$Outbound
+  | string;
+
+/** @internal */
+export const Preferences$outboundSchema: z.ZodType<
+  Preferences$Outbound,
+  z.ZodTypeDef,
+  Preferences
+> = z.union([
+  WorkflowPreferenceRequestDto$outboundSchema,
+  GroupPreferenceFilterDto$outboundSchema,
+  z.string(),
+]);
+
+export function preferencesToJSON(preferences: Preferences): string {
+  return JSON.stringify(Preferences$outboundSchema.parse(preferences));
+}
+
 /** @internal */
 export type CreateTopicSubscriptionsRequestDto$Outbound = {
-  subscriberIds: Array<string>;
+  subscriberIds?: Array<string> | undefined;
+  subscriptions?:
+    | Array<TopicSubscriberIdentifierDto$Outbound | string>
+    | undefined;
+  name?: string | undefined;
+  preferences?:
+    | Array<
+      | WorkflowPreferenceRequestDto$Outbound
+      | GroupPreferenceFilterDto$Outbound
+      | string
+    >
+    | undefined;
 };
 
 /** @internal */
@@ -22,7 +108,18 @@ export const CreateTopicSubscriptionsRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreateTopicSubscriptionsRequestDto
 > = z.object({
-  subscriberIds: z.array(z.string()),
+  subscriberIds: z.array(z.string()).optional(),
+  subscriptions: z.array(
+    z.union([TopicSubscriberIdentifierDto$outboundSchema, z.string()]),
+  ).optional(),
+  name: z.string().optional(),
+  preferences: z.array(
+    z.union([
+      WorkflowPreferenceRequestDto$outboundSchema,
+      GroupPreferenceFilterDto$outboundSchema,
+      z.string(),
+    ]),
+  ).optional(),
 });
 
 export function createTopicSubscriptionsRequestDtoToJSON(

package/src/models/components/createtranslationrequestdto.ts

@@ -17,11 +17,6 @@ export const ResourceType = {
  */
 export type ResourceType = ClosedEnum<typeof ResourceType>;
 
-/**
- * Translation content as JSON object
- */
-export type Content = {};
-
 export type CreateTranslationRequestDto = {
   /**
    * The resource ID to associate translation with. Accepts identifier or slug format
@@ -38,33 +33,19 @@ export type CreateTranslationRequestDto = {
   /**
    * Translation content as JSON object
    */
-  content: Content;
+  content: { [k: string]: any };
 };
 
 /** @internal */
 export const ResourceType$outboundSchema: z.ZodNativeEnum<typeof ResourceType> =
   z.nativeEnum(ResourceType);
 
-/** @internal */
-export type Content$Outbound = {};
-
-/** @internal */
-export const Content$outboundSchema: z.ZodType<
-  Content$Outbound,
-  z.ZodTypeDef,
-  Content
-> = z.object({});
-
-export function contentToJSON(content: Content): string {
-  return JSON.stringify(Content$outboundSchema.parse(content));
-}
-
 /** @internal */
 export type CreateTranslationRequestDto$Outbound = {
   resourceId: string;
   resourceType: string;
   locale: string;
-  content: Content$Outbound;
+  content: { [k: string]: any };
 };
 
 /** @internal */
@@ -76,7 +57,7 @@ export const CreateTranslationRequestDto$outboundSchema: z.ZodType<
   resourceId: z.string(),
   resourceType: ResourceType$outboundSchema,
   locale: z.string(),
-  content: z.lazy(() => Content$outboundSchema),
+  content: z.record(z.any()),
 });
 
 export function createTranslationRequestDtoToJSON(