@novu/api 0.0.1-alpha.11 → 0.0.1-alpha.114

package/src/models/components/emailblock.ts

@@ -3,7 +3,10 @@
  */
 
 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";
 import {
   EmailBlockStyles,
   EmailBlockStyles$inboundSchema,
@@ -18,10 +21,10 @@ export const EmailBlockType = {
 export type EmailBlockType = ClosedEnum<typeof EmailBlockType>;
 
 export type EmailBlock = {
-  content: string;
-  styles?: EmailBlockStyles | undefined;
   type: EmailBlockType;
+  content: string;
   url?: string | undefined;
+  styles?: EmailBlockStyles | undefined;
 };
 
 /** @internal */
@@ -51,18 +54,18 @@ export const EmailBlock$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  content: z.string(),
-  styles: EmailBlockStyles$inboundSchema.optional(),
   type: EmailBlockType$inboundSchema,
+  content: z.string(),
   url: z.string().optional(),
+  styles: EmailBlockStyles$inboundSchema.optional(),
 });
 
 /** @internal */
 export type EmailBlock$Outbound = {
-  content: string;
-  styles?: EmailBlockStyles$Outbound | undefined;
   type: string;
+  content: string;
   url?: string | undefined;
+  styles?: EmailBlockStyles$Outbound | undefined;
 };
 
 /** @internal */
@@ -71,10 +74,10 @@ export const EmailBlock$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EmailBlock
 > = z.object({
-  content: z.string(),
-  styles: EmailBlockStyles$outboundSchema.optional(),
   type: EmailBlockType$outboundSchema,
+  content: z.string(),
   url: z.string().optional(),
+  styles: EmailBlockStyles$outboundSchema.optional(),
 });
 
 /**
@@ -89,3 +92,17 @@ export namespace EmailBlock$ {
   /** @deprecated use `EmailBlock$Outbound` instead. */
   export type Outbound = EmailBlock$Outbound;
 }
+
+export function emailBlockToJSON(emailBlock: EmailBlock): string {
+  return JSON.stringify(EmailBlock$outboundSchema.parse(emailBlock));
+}
+
+export function emailBlockFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailBlock, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailBlock$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailBlock' from JSON`,
+  );
+}

package/src/models/components/emailblockstyles.ts

@@ -3,7 +3,10 @@
  */
 
 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";
 
 export const TextAlign = {
   Center: "center",
@@ -70,3 +73,21 @@ export namespace EmailBlockStyles$ {
   /** @deprecated use `EmailBlockStyles$Outbound` instead. */
   export type Outbound = EmailBlockStyles$Outbound;
 }
+
+export function emailBlockStylesToJSON(
+  emailBlockStyles: EmailBlockStyles,
+): string {
+  return JSON.stringify(
+    EmailBlockStyles$outboundSchema.parse(emailBlockStyles),
+  );
+}
+
+export function emailBlockStylesFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailBlockStyles, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailBlockStyles$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailBlockStyles' from JSON`,
+  );
+}

package/src/models/components/failedassignmentsdto.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 FailedAssignmentsDto = {
+  /**
+   * List of subscriber IDs that were not found
+   */
+  notFound?: Array<string> | undefined;
+};
+
+/** @internal */
+export const FailedAssignmentsDto$inboundSchema: z.ZodType<
+  FailedAssignmentsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  notFound: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type FailedAssignmentsDto$Outbound = {
+  notFound?: Array<string> | undefined;
+};
+
+/** @internal */
+export const FailedAssignmentsDto$outboundSchema: z.ZodType<
+  FailedAssignmentsDto$Outbound,
+  z.ZodTypeDef,
+  FailedAssignmentsDto
+> = z.object({
+  notFound: z.array(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 FailedAssignmentsDto$ {
+  /** @deprecated use `FailedAssignmentsDto$inboundSchema` instead. */
+  export const inboundSchema = FailedAssignmentsDto$inboundSchema;
+  /** @deprecated use `FailedAssignmentsDto$outboundSchema` instead. */
+  export const outboundSchema = FailedAssignmentsDto$outboundSchema;
+  /** @deprecated use `FailedAssignmentsDto$Outbound` instead. */
+  export type Outbound = FailedAssignmentsDto$Outbound;
+}
+
+export function failedAssignmentsDtoToJSON(
+  failedAssignmentsDto: FailedAssignmentsDto,
+): string {
+  return JSON.stringify(
+    FailedAssignmentsDto$outboundSchema.parse(failedAssignmentsDto),
+  );
+}
+
+export function failedAssignmentsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FailedAssignmentsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FailedAssignmentsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FailedAssignmentsDto' from JSON`,
+  );
+}

package/src/models/components/feedresponsedto.ts

@@ -3,13 +3,37 @@
  */
 
 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 {
+  NotificationFeedItemDto,
+  NotificationFeedItemDto$inboundSchema,
+  NotificationFeedItemDto$Outbound,
+  NotificationFeedItemDto$outboundSchema,
+} from "./notificationfeeditemdto.js";
 
 export type FeedResponseDto = {
-  data: Array<string>;
+  /**
+   * Total number of notifications available.
+   */
+  totalCount?: number | undefined;
+  /**
+   * Indicates if there are more notifications to load.
+   */
   hasMore: boolean;
-  page: number;
+  /**
+   * Array of notifications returned in the response.
+   */
+  data: Array<NotificationFeedItemDto>;
+  /**
+   * The number of notifications returned in this response.
+   */
   pageSize: number;
-  totalCount?: number | undefined;
+  /**
+   * The current page number of the notifications.
+   */
+  page: number;
 };
 
 /** @internal */
@@ -18,20 +42,20 @@ export const FeedResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(z.string()),
+  totalCount: z.number().optional(),
   hasMore: z.boolean(),
-  page: z.number(),
+  data: z.array(NotificationFeedItemDto$inboundSchema),
   pageSize: z.number(),
-  totalCount: z.number().optional(),
+  page: z.number(),
 });
 
 /** @internal */
 export type FeedResponseDto$Outbound = {
-  data: Array<string>;
+  totalCount?: number | undefined;
   hasMore: boolean;
-  page: number;
+  data: Array<NotificationFeedItemDto$Outbound>;
   pageSize: number;
-  totalCount?: number | undefined;
+  page: number;
 };
 
 /** @internal */
@@ -40,11 +64,11 @@ export const FeedResponseDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FeedResponseDto
 > = z.object({
-  data: z.array(z.string()),
+  totalCount: z.number().optional(),
   hasMore: z.boolean(),
-  page: z.number(),
+  data: z.array(NotificationFeedItemDto$outboundSchema),
   pageSize: z.number(),
-  totalCount: z.number().optional(),
+  page: z.number(),
 });
 
 /**
@@ -59,3 +83,19 @@ export namespace FeedResponseDto$ {
   /** @deprecated use `FeedResponseDto$Outbound` instead. */
   export type Outbound = FeedResponseDto$Outbound;
 }
+
+export function feedResponseDtoToJSON(
+  feedResponseDto: FeedResponseDto,
+): string {
+  return JSON.stringify(FeedResponseDto$outboundSchema.parse(feedResponseDto));
+}
+
+export function feedResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FeedResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FeedResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FeedResponseDto' from JSON`,
+  );
+}

package/src/models/components/filtertopicsresponsedto.ts

@@ -3,6 +3,9 @@
  */
 
 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 {
   TopicDto,
   TopicDto$inboundSchema,
@@ -61,3 +64,21 @@ export namespace FilterTopicsResponseDto$ {
   /** @deprecated use `FilterTopicsResponseDto$Outbound` instead. */
   export type Outbound = FilterTopicsResponseDto$Outbound;
 }
+
+export function filterTopicsResponseDtoToJSON(
+  filterTopicsResponseDto: FilterTopicsResponseDto,
+): string {
+  return JSON.stringify(
+    FilterTopicsResponseDto$outboundSchema.parse(filterTopicsResponseDto),
+  );
+}
+
+export function filterTopicsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FilterTopicsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilterTopicsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilterTopicsResponseDto' from JSON`,
+  );
+}

package/src/models/components/getsubscriberpreferencesresponsedto.ts

@@ -3,6 +3,9 @@
  */
 
 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 {
   Preference,
   Preference$inboundSchema,
@@ -17,14 +20,14 @@ import {
 } from "./templateresponse.js";
 
 export type GetSubscriberPreferencesResponseDto = {
-  /**
-   * The preferences of the subscriber regarding the related workflow
-   */
-  preference: Preference;
   /**
    * The workflow information and if it is critical or not
    */
   template?: TemplateResponse | undefined;
+  /**
+   * The preferences of the subscriber regarding the related workflow
+   */
+  preference: Preference;
 };
 
 /** @internal */
@@ -33,14 +36,14 @@ export const GetSubscriberPreferencesResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  preference: Preference$inboundSchema,
   template: TemplateResponse$inboundSchema.optional(),
+  preference: Preference$inboundSchema,
 });
 
 /** @internal */
 export type GetSubscriberPreferencesResponseDto$Outbound = {
-  preference: Preference$Outbound;
   template?: TemplateResponse$Outbound | undefined;
+  preference: Preference$Outbound;
 };
 
 /** @internal */
@@ -49,8 +52,8 @@ export const GetSubscriberPreferencesResponseDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetSubscriberPreferencesResponseDto
 > = z.object({
-  preference: Preference$outboundSchema,
   template: TemplateResponse$outboundSchema.optional(),
+  preference: Preference$outboundSchema,
 });
 
 /**
@@ -67,3 +70,24 @@ export namespace GetSubscriberPreferencesResponseDto$ {
   /** @deprecated use `GetSubscriberPreferencesResponseDto$Outbound` instead. */
   export type Outbound = GetSubscriberPreferencesResponseDto$Outbound;
 }
+
+export function getSubscriberPreferencesResponseDtoToJSON(
+  getSubscriberPreferencesResponseDto: GetSubscriberPreferencesResponseDto,
+): string {
+  return JSON.stringify(
+    GetSubscriberPreferencesResponseDto$outboundSchema.parse(
+      getSubscriberPreferencesResponseDto,
+    ),
+  );
+}
+
+export function getSubscriberPreferencesResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubscriberPreferencesResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubscriberPreferencesResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubscriberPreferencesResponseDto' from JSON`,
+  );
+}

package/src/models/components/gettopicresponsedto.ts

@@ -4,11 +4,14 @@
 
 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";
 
 export type GetTopicResponseDto = {
-  environmentId: string;
   id?: string | undefined;
   organizationId: string;
+  environmentId: string;
   key: string;
   name: string;
   subscribers: Array<string>;
@@ -20,25 +23,25 @@ export const GetTopicResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _environmentId: z.string(),
   _id: z.string().optional(),
   _organizationId: z.string(),
+  _environmentId: z.string(),
   key: z.string(),
   name: z.string(),
   subscribers: z.array(z.string()),
 }).transform((v) => {
   return remap$(v, {
-    "_environmentId": "environmentId",
     "_id": "id",
     "_organizationId": "organizationId",
+    "_environmentId": "environmentId",
   });
 });
 
 /** @internal */
 export type GetTopicResponseDto$Outbound = {
-  _environmentId: string;
   _id?: string | undefined;
   _organizationId: string;
+  _environmentId: string;
   key: string;
   name: string;
   subscribers: Array<string>;
@@ -50,17 +53,17 @@ export const GetTopicResponseDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetTopicResponseDto
 > = z.object({
-  environmentId: z.string(),
   id: z.string().optional(),
   organizationId: z.string(),
+  environmentId: z.string(),
   key: z.string(),
   name: z.string(),
   subscribers: z.array(z.string()),
 }).transform((v) => {
   return remap$(v, {
-    environmentId: "_environmentId",
     id: "_id",
     organizationId: "_organizationId",
+    environmentId: "_environmentId",
   });
 });
 
@@ -76,3 +79,21 @@ export namespace GetTopicResponseDto$ {
   /** @deprecated use `GetTopicResponseDto$Outbound` instead. */
   export type Outbound = GetTopicResponseDto$Outbound;
 }
+
+export function getTopicResponseDtoToJSON(
+  getTopicResponseDto: GetTopicResponseDto,
+): string {
+  return JSON.stringify(
+    GetTopicResponseDto$outboundSchema.parse(getTopicResponseDto),
+  );
+}
+
+export function getTopicResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTopicResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTopicResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTopicResponseDto' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -4,51 +4,42 @@
 
 export * from "./activitiesresponsedto.js";
 export * from "./activitygraphstatesresponse.js";
+export * from "./activitynotificationexecutiondetailresponsedto.js";
+export * from "./activitynotificationjobresponsedto.js";
 export * from "./activitynotificationresponsedto.js";
+export * from "./activitynotificationstepresponsedto.js";
 export * from "./activitynotificationsubscriberresponsedto.js";
 export * from "./activitynotificationtemplateresponsedto.js";
 export * from "./activitystatsresponsedto.js";
+export * from "./actorfeeditemdto.js";
+export * from "./actortypeenum.js";
 export * from "./addsubscribersrequestdto.js";
-export * from "./apikey.js";
-export * from "./bulkapplychangedto.js";
+export * from "./assignsubscribertotopicdto.js";
 export * from "./bulksubscribercreatedto.js";
 export * from "./bulktriggereventdto.js";
-export * from "./changeresponsedto.js";
-export * from "./changesresponsedto.js";
-export * from "./changeworkflowstatusrequestdto.js";
 export * from "./channelcredentials.js";
+export * from "./channelcredentialsdto.js";
 export * from "./channelpreference.js";
 export * from "./channelsettings.js";
-export * from "./createfeedrequestdto.js";
+export * from "./channeltypeenum.js";
 export * from "./createintegrationrequestdto.js";
-export * from "./createlayoutresponsedto.js";
-export * from "./createnotificationgrouprequestdto.js";
 export * from "./createsubscriberrequestdto.js";
-export * from "./createtenantrequestdto.js";
-export * from "./createtenantresponsedto.js";
 export * from "./createtopicrequestdto.js";
 export * from "./createtopicresponsedto.js";
-export * from "./createworkflowrequestdto.js";
 export * from "./credentialsdto.js";
 export * from "./databooleandto.js";
-export * from "./datanumberdto.js";
 export * from "./delayregularmetadata.js";
 export * from "./delayscheduledmetadata.js";
 export * from "./deletemessageresponsedto.js";
-export * from "./deletenotificationgroupresponsedto.js";
 export * from "./deletesubscriberresponsedto.js";
 export * from "./digestregularmetadata.js";
 export * from "./digesttimedmetadata.js";
 export * from "./emailblock.js";
 export * from "./emailblockstyles.js";
-export * from "./environmentresponsedto.js";
-export * from "./executiondetailsresponsedto.js";
+export * from "./failedassignmentsdto.js";
 export * from "./feedresponsedto.js";
-export * from "./fieldfilterpart.js";
 export * from "./filtertopicsresponsedto.js";
-export * from "./getlayoutresponsedto.js";
 export * from "./getsubscriberpreferencesresponsedto.js";
-export * from "./gettenantresponsedto.js";
 export * from "./gettopicresponsedto.js";
 export * from "./integrationresponsedto.js";
 export * from "./markallmessageasrequestdto.js";
@@ -62,22 +53,22 @@ export * from "./messageentity.js";
 export * from "./messagemarkasrequestdto.js";
 export * from "./messageresponsedto.js";
 export * from "./messagetemplate.js";
+export * from "./messagetemplatedto.js";
+export * from "./notificationfeeditemdto.js";
 export * from "./notificationgroup.js";
-export * from "./notificationgroupresponsedto.js";
 export * from "./notificationstep.js";
 export * from "./notificationstepvariant.js";
 export * from "./notificationtrigger.js";
 export * from "./notificationtriggervariable.js";
-export * from "./organizationbrandingresponsedto.js";
-export * from "./organizationresponsedto.js";
 export * from "./preference.js";
 export * from "./preferencechannels.js";
 export * from "./removesubscribersrequestdto.js";
-export * from "./renameorganizationdto.js";
 export * from "./renametopicrequestdto.js";
 export * from "./renametopicresponsedto.js";
 export * from "./security.js";
 export * from "./stepfilter.js";
+export * from "./subscriberchanneldto.js";
+export * from "./subscriberfeedresponsedto.js";
 export * from "./subscriberpayloaddto.js";
 export * from "./subscriberresponsedto.js";
 export * from "./templateresponse.js";
@@ -89,20 +80,14 @@ export * from "./topicsubscriberdto.js";
 export * from "./triggereventrequestdto.js";
 export * from "./triggereventresponsedto.js";
 export * from "./triggereventtoallrequestdto.js";
+export * from "./triggerrecipientstypeenum.js";
 export * from "./unseencountresponse.js";
-export * from "./updatebrandingdetailsdto.js";
 export * from "./updateintegrationrequestdto.js";
-export * from "./updatelayoutrequestdto.js";
-export * from "./updatelayoutresponsedto.js";
 export * from "./updatesubscriberchannelrequestdto.js";
 export * from "./updatesubscriberglobalpreferencesrequestdto.js";
 export * from "./updatesubscriberonlineflagrequestdto.js";
 export * from "./updatesubscriberpreferencerequestdto.js";
 export * from "./updatesubscriberpreferenceresponsedto.js";
 export * from "./updatesubscriberrequestdto.js";
-export * from "./updatetenantrequestdto.js";
-export * from "./updatetenantresponsedto.js";
-export * from "./updateworkflowrequestdto.js";
-export * from "./variablesresponsedto.js";
 export * from "./workflowresponse.js";
-export * from "./workflowsresponsedto.js";
+export * from "./workflowtostepcontrolvaluesdto.js";